From 882edf5e0fbff85a998f720acedc2a2133173720 Mon Sep 17 00:00:00 2001 From: Matthew Date: Mon, 19 Feb 2024 21:18:18 -0500 Subject: [PATCH 1/2] Merge pull request #8997 from TBlazeWarriorT/patch-1 [Documentation>Runtime file loading and saving] Removed a single space that shouldn't be there --- tutorials/io/runtime_file_loading_and_saving.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/io/runtime_file_loading_and_saving.rst b/tutorials/io/runtime_file_loading_and_saving.rst index 84df8200559..2d431ab146e 100644 --- a/tutorials/io/runtime_file_loading_and_saving.rst +++ b/tutorials/io/runtime_file_loading_and_saving.rst @@ -47,7 +47,7 @@ filesystem for reading and writing: :: - func save_file(content): + func save_file(content): var file = FileAccess.open("/path/to/file.txt", FileAccess.WRITE) file.store_string(content) From 77f27dca08ff402c1f774cef35f2bae52cb7255b Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Sat, 24 Feb 2024 03:22:18 +0000 Subject: [PATCH 2/2] classref: Sync with current master branch (2e7fc81) --- classes/class_@gdscript.rst | 153 +- classes/class_@globalscope.rst | 711 ++-- classes/class_aabb.rst | 193 +- classes/class_acceptdialog.rst | 65 +- classes/class_aescontext.rst | 27 +- classes/class_animatablebody2d.rst | 5 +- classes/class_animatablebody3d.rst | 5 +- classes/class_animatedsprite2d.rst | 97 +- classes/class_animatedsprite3d.rst | 79 +- classes/class_animatedtexture.rst | 49 +- classes/class_animation.rst | 419 +-- classes/class_animationlibrary.rst | 47 +- classes/class_animationmixer.rst | 270 +- classes/class_animationnode.rst | 139 +- classes/class_animationnodeadd2.rst | 1 + classes/class_animationnodeadd3.rst | 1 + classes/class_animationnodeanimation.rst | 9 +- classes/class_animationnodeblend2.rst | 1 + classes/class_animationnodeblend3.rst | 1 + classes/class_animationnodeblendspace1d.rst | 69 +- classes/class_animationnodeblendspace2d.rst | 103 +- classes/class_animationnodeblendtree.rst | 63 +- classes/class_animationnodeoneshot.rst | 33 +- classes/class_animationnodeoutput.rst | 1 + classes/class_animationnodestatemachine.rst | 129 +- ...lass_animationnodestatemachineplayback.rst | 63 +- ...ss_animationnodestatemachinetransition.rst | 35 +- classes/class_animationnodesub2.rst | 1 + classes/class_animationnodesync.rst | 5 +- classes/class_animationnodetimescale.rst | 1 + classes/class_animationnodetimeseek.rst | 1 + classes/class_animationnodetransition.rst | 43 +- classes/class_animationplayer.rst | 205 +- classes/class_animationrootnode.rst | 1 + classes/class_animationtree.rst | 69 +- classes/class_area2d.rst | 115 +- classes/class_area3d.rst | 143 +- classes/class_array.rst | 403 +-- classes/class_arraymesh.rst | 129 +- classes/class_arrayoccluder3d.rst | 17 +- classes/class_aspectratiocontainer.rst | 17 +- classes/class_astar2d.rst | 153 +- classes/class_astar3d.rst | 153 +- classes/class_astargrid2d.rst | 135 +- classes/class_atlastexture.rst | 17 +- classes/class_audiobuslayout.rst | 1 + classes/class_audioeffect.rst | 9 +- classes/class_audioeffectamplify.rst | 5 +- classes/class_audioeffectbandlimitfilter.rst | 1 + classes/class_audioeffectbandpassfilter.rst | 1 + classes/class_audioeffectcapture.rst | 55 +- classes/class_audioeffectchorus.rst | 183 +- classes/class_audioeffectcompressor.rst | 29 +- classes/class_audioeffectdelay.rst | 53 +- classes/class_audioeffectdistortion.rst | 21 +- classes/class_audioeffecteq.rst | 21 +- classes/class_audioeffecteq10.rst | 1 + classes/class_audioeffecteq21.rst | 1 + classes/class_audioeffecteq6.rst | 1 + classes/class_audioeffectfilter.rst | 17 +- classes/class_audioeffecthighpassfilter.rst | 1 + classes/class_audioeffecthighshelffilter.rst | 1 + classes/class_audioeffectinstance.rst | 15 +- classes/class_audioeffectlimiter.rst | 17 +- classes/class_audioeffectlowpassfilter.rst | 1 + classes/class_audioeffectlowshelffilter.rst | 1 + classes/class_audioeffectnotchfilter.rst | 1 + classes/class_audioeffectpanner.rst | 5 +- classes/class_audioeffectphaser.rst | 21 +- classes/class_audioeffectpitchshift.rst | 13 +- classes/class_audioeffectrecord.rst | 25 +- classes/class_audioeffectreverb.rst | 33 +- classes/class_audioeffectspectrumanalyzer.rst | 13 +- ...ss_audioeffectspectrumanalyzerinstance.rst | 9 +- classes/class_audioeffectstereoenhance.rst | 13 +- classes/class_audiolistener2d.rst | 24 +- classes/class_audiolistener3d.rst | 30 +- classes/class_audioserver.rst | 257 +- classes/class_audiostream.rst | 65 +- classes/class_audiostreamgenerator.rst | 9 +- .../class_audiostreamgeneratorplayback.rst | 39 +- classes/class_audiostreammicrophone.rst | 1 + classes/class_audiostreammp3.rst | 25 +- classes/class_audiostreamoggvorbis.rst | 39 +- classes/class_audiostreamplayback.rst | 63 +- .../class_audiostreamplaybackoggvorbis.rst | 1 + .../class_audiostreamplaybackpolyphonic.rst | 33 +- .../class_audiostreamplaybackresampled.rst | 21 +- classes/class_audiostreamplayer.rst | 78 +- classes/class_audiostreamplayer2d.rst | 90 +- classes/class_audiostreamplayer3d.rst | 122 +- classes/class_audiostreampolyphonic.rst | 5 +- classes/class_audiostreamrandomizer.rst | 61 +- classes/class_audiostreamwav.rst | 37 +- classes/class_backbuffercopy.rst | 9 +- classes/class_basebutton.rst | 85 +- classes/class_basematerial3d.rst | 507 +-- classes/class_basis.rst | 205 +- classes/class_bitmap.rst | 81 +- classes/class_bone2d.rst | 61 +- classes/class_boneattachment3d.rst | 48 +- classes/class_bonemap.rst | 29 +- classes/class_bool.rst | 53 +- classes/class_boxcontainer.rst | 17 +- classes/class_boxmesh.rst | 17 +- classes/class_boxoccluder3d.rst | 5 +- classes/class_boxshape3d.rst | 5 +- classes/class_button.rst | 64 +- classes/class_buttongroup.rst | 21 +- classes/class_callable.rst | 145 +- classes/class_callbacktweener.rst | 9 +- classes/class_camera2d.rst | 177 +- classes/class_camera3d.rst | 192 +- classes/class_cameraattributes.rst | 21 +- classes/class_cameraattributesphysical.rst | 41 +- classes/class_cameraattributespractical.rst | 37 +- classes/class_camerafeed.rst | 35 +- classes/class_cameraserver.rst | 37 +- classes/class_cameratexture.rst | 13 +- classes/class_canvasgroup.rst | 13 +- classes/class_canvasitem.rst | 429 +-- classes/class_canvasitemmaterial.rst | 25 +- classes/class_canvaslayer.rst | 65 +- classes/class_canvasmodulate.rst | 8 +- classes/class_canvastexture.rst | 29 +- classes/class_capsulemesh.rst | 17 +- classes/class_capsuleshape2d.rst | 9 +- classes/class_capsuleshape3d.rst | 9 +- classes/class_centercontainer.rst | 5 +- classes/class_characterbody2d.rst | 171 +- classes/class_characterbody3d.rst | 177 +- classes/class_charfxtransform.rst | 53 +- classes/class_checkbox.rst | 1 + classes/class_checkbutton.rst | 1 + classes/class_circleshape2d.rst | 5 +- classes/class_classdb.rst | 141 +- classes/class_codeedit.rst | 593 ++-- classes/class_codehighlighter.rst | 115 +- classes/class_collisionobject2d.rst | 207 +- classes/class_collisionobject3d.rst | 171 +- classes/class_collisionpolygon2d.rst | 21 +- classes/class_collisionpolygon3d.rst | 17 +- classes/class_collisionshape2d.rst | 21 +- classes/class_collisionshape3d.rst | 23 +- classes/class_color.rst | 277 +- classes/class_colorpicker.rst | 89 +- classes/class_colorpickerbutton.rst | 29 +- classes/class_colorrect.rst | 5 +- classes/class_compositor.rst | 67 + classes/class_compositoreffect.rst | 301 ++ classes/class_compressedcubemap.rst | 1 + classes/class_compressedcubemaparray.rst | 1 + classes/class_compressedtexture2d.rst | 13 +- classes/class_compressedtexture2darray.rst | 1 + classes/class_compressedtexture3d.rst | 13 +- classes/class_compressedtexturelayered.rst | 13 +- classes/class_concavepolygonshape2d.rst | 5 +- classes/class_concavepolygonshape3d.rst | 19 +- classes/class_conetwistjoint3d.rst | 35 +- classes/class_configfile.rst | 105 +- classes/class_confirmationdialog.rst | 13 +- classes/class_container.rst | 31 +- classes/class_control.rst | 695 ++-- classes/class_convexpolygonshape2d.rst | 13 +- classes/class_convexpolygonshape3d.rst | 5 +- classes/class_cpuparticles2d.rst | 325 +- classes/class_cpuparticles3d.rst | 661 ++-- classes/class_crypto.rst | 57 +- classes/class_cryptokey.rst | 33 +- classes/class_csgbox3d.rst | 9 +- classes/class_csgcombiner3d.rst | 1 + classes/class_csgcylinder3d.rst | 25 +- classes/class_csgmesh3d.rst | 9 +- classes/class_csgpolygon3d.rst | 65 +- classes/class_csgprimitive3d.rst | 5 +- classes/class_csgshape3d.rst | 67 +- classes/class_csgsphere3d.rst | 21 +- classes/class_csgtorus3d.rst | 25 +- classes/class_csharpscript.rst | 9 +- classes/class_cubemap.rst | 9 +- classes/class_cubemaparray.rst | 9 +- classes/class_curve.rst | 129 +- classes/class_curve2d.rst | 125 +- classes/class_curve3d.rst | 159 +- classes/class_curvetexture.rst | 13 +- classes/class_curvexyztexture.rst | 17 +- classes/class_cylindermesh.rst | 29 +- classes/class_cylindershape3d.rst | 9 +- classes/class_dampedspringjoint2d.rst | 17 +- classes/class_decal.rst | 78 +- classes/class_dictionary.rst | 133 +- classes/class_diraccess.rst | 191 +- classes/class_directionallight2d.rst | 12 +- classes/class_directionallight3d.rst | 40 +- classes/class_displayserver.rst | 1071 +++--- classes/class_dtlsserver.rst | 15 +- classes/class_editorcommandpalette.rst | 15 +- classes/class_editordebuggerplugin.rst | 33 +- classes/class_editordebuggersession.rst | 53 +- classes/class_editorexportplatform.rst | 9 +- classes/class_editorexportplatformandroid.rst | 27 +- classes/class_editorexportplatformios.rst | 1 + .../class_editorexportplatformlinuxbsd.rst | 1 + classes/class_editorexportplatformmacos.rst | 1 + classes/class_editorexportplatformpc.rst | 1 + classes/class_editorexportplatformweb.rst | 5 +- classes/class_editorexportplatformwindows.rst | 1 + classes/class_editorexportplugin.rst | 213 +- classes/class_editorfeatureprofile.rst | 69 +- classes/class_editorfiledialog.rst | 81 +- classes/class_editorfilesystem.rst | 67 +- classes/class_editorfilesystemdirectory.rst | 87 +- ...itorfilesystemimportformatsupportquery.rst | 21 +- classes/class_editorimportplugin.rst | 87 +- classes/class_editorinspector.rst | 33 +- classes/class_editorinspectorplugin.rst | 57 +- classes/class_editorinterface.rst | 317 +- classes/class_editornode3dgizmo.rst | 153 +- classes/class_editornode3dgizmoplugin.rst | 141 +- classes/class_editorpaths.rst | 39 +- classes/class_editorplugin.rst | 423 +-- classes/class_editorproperty.rst | 150 +- .../class_editorresourceconversionplugin.rst | 21 +- classes/class_editorresourcepicker.rst | 47 +- classes/class_editorresourcepreview.rst | 35 +- .../class_editorresourcepreviewgenerator.rst | 33 +- classes/class_editorresourcetooltipplugin.rst | 21 +- classes/class_editorsceneformatimporter.rst | 35 +- .../class_editorsceneformatimporterblend.rst | 1 + ...ass_editorsceneformatimporterfbx2gltf.rst} | 13 +- .../class_editorsceneformatimportergltf.rst | 1 + .../class_editorsceneformatimporterufbx.rst | 33 + classes/class_editorscenepostimport.rst | 15 +- classes/class_editorscenepostimportplugin.rst | 69 +- classes/class_editorscript.rst | 27 +- classes/class_editorscriptpicker.rst | 5 +- classes/class_editorselection.rst | 35 +- classes/class_editorsettings.rst | 1707 +++++---- classes/class_editorspinslider.rst | 31 +- classes/class_editorsyntaxhighlighter.rst | 15 +- .../class_editortranslationparserplugin.rst | 15 +- classes/class_editorundoredomanager.rst | 73 +- classes/class_editorvcsinterface.rst | 189 +- classes/class_encodedobjectasid.rst | 5 +- classes/class_enetconnection.rst | 111 +- classes/class_enetmultiplayerpeer.rst | 41 +- classes/class_enetpacketpeer.rst | 93 +- classes/class_engine.rst | 177 +- classes/class_enginedebugger.rst | 69 +- classes/class_engineprofiler.rst | 21 +- classes/class_environment.rst | 499 +-- classes/class_expression.rst | 27 +- classes/class_fastnoiselite.rst | 85 +- classes/class_fbxdocument.rst | 35 + classes/class_fbxstate.rst | 65 + classes/class_fileaccess.rst | 331 +- classes/class_filedialog.rst | 137 +- classes/class_filesystemdock.rst | 37 +- classes/class_float.rst | 227 +- classes/class_flowcontainer.rst | 21 +- classes/class_fogmaterial.rst | 25 +- classes/class_fogvolume.rst | 13 +- classes/class_font.rst | 209 +- classes/class_fontfile.rst | 485 +-- classes/class_fontvariation.rst | 53 +- classes/class_framebuffercacherd.rst | 60 + classes/class_gdextension.rst | 15 +- classes/class_gdextensionmanager.rst | 41 +- classes/class_gdscript.rst | 9 +- classes/class_generic6dofjoint3d.rst | 411 +-- classes/class_geometry2d.rst | 141 +- classes/class_geometry3d.rst | 93 +- classes/class_geometryinstance3d.rst | 75 +- classes/class_gltfaccessor.rst | 57 +- classes/class_gltfanimation.rst | 77 +- classes/class_gltfbufferview.rst | 29 +- classes/class_gltfcamera.rst | 47 +- classes/class_gltfdocument.rst | 65 +- classes/class_gltfdocumentextension.rst | 117 +- ...tfdocumentextensionconvertimportermesh.rst | 1 + classes/class_gltflight.rst | 83 +- classes/class_gltfmesh.rst | 114 +- classes/class_gltfnode.rst | 132 +- classes/class_gltfphysicsbody.rst | 59 +- classes/class_gltfphysicsshape.rst | 55 +- classes/class_gltfskeleton.rst | 53 +- classes/class_gltfskin.rst | 67 +- classes/class_gltfspecgloss.rst | 21 +- classes/class_gltfstate.rst | 345 +- classes/class_gltftexture.rst | 13 +- classes/class_gltftexturesampler.rst | 17 +- classes/class_godotsharp.rst | 9 +- classes/class_gpuparticles2d.rst | 125 +- classes/class_gpuparticles3d.rst | 153 +- classes/class_gpuparticlesattractor3d.rst | 17 +- classes/class_gpuparticlesattractorbox3d.rst | 5 +- .../class_gpuparticlesattractorsphere3d.rst | 5 +- ...ass_gpuparticlesattractorvectorfield3d.rst | 9 +- classes/class_gpuparticlescollision3d.rst | 5 +- classes/class_gpuparticlescollisionbox3d.rst | 5 +- ...ass_gpuparticlescollisionheightfield3d.rst | 17 +- classes/class_gpuparticlescollisionsdf3d.rst | 35 +- .../class_gpuparticlescollisionsphere3d.rst | 5 +- classes/class_gradient.rst | 73 +- classes/class_gradienttexture1d.rst | 13 +- classes/class_gradienttexture2d.rst | 33 +- classes/class_graphedit.rst | 271 +- classes/class_graphelement.rst | 35 +- classes/class_graphnode.rst | 207 +- classes/class_gridcontainer.rst | 5 +- classes/class_gridmap.rst | 196 +- classes/class_groovejoint2d.rst | 9 +- classes/class_hashingcontext.rst | 21 +- classes/class_hboxcontainer.rst | 1 + classes/class_heightmapshape3d.rst | 27 +- classes/class_hflowcontainer.rst | 1 + classes/class_hingejoint3d.rst | 67 +- classes/class_hmaccontext.rst | 21 +- classes/class_hscrollbar.rst | 1 + classes/class_hseparator.rst | 1 + classes/class_hslider.rst | 1 + classes/class_hsplitcontainer.rst | 1 + classes/class_httpclient.rst | 115 +- classes/class_httprequest.rst | 87 +- classes/class_image.rst | 417 +-- classes/class_imageformatloader.rst | 1 + classes/class_imageformatloaderextension.rst | 27 +- classes/class_imagetexture.rst | 33 +- classes/class_imagetexture3d.rst | 15 +- classes/class_imagetexturelayered.rst | 15 +- classes/class_immediatemesh.rst | 63 +- classes/class_importermesh.rst | 141 +- classes/class_importermeshinstance3d.rst | 41 +- classes/class_input.rst | 299 +- classes/class_inputevent.rst | 85 +- classes/class_inputeventaction.rst | 13 +- classes/class_inputeventfromwindow.rst | 5 +- classes/class_inputeventgesture.rst | 5 +- classes/class_inputeventjoypadbutton.rst | 20 +- classes/class_inputeventjoypadmotion.rst | 12 +- classes/class_inputeventkey.rst | 73 +- classes/class_inputeventmagnifygesture.rst | 5 +- classes/class_inputeventmidi.rst | 33 +- classes/class_inputeventmouse.rst | 17 +- classes/class_inputeventmousebutton.rst | 21 +- classes/class_inputeventmousemotion.rst | 29 +- classes/class_inputeventpangesture.rst | 5 +- classes/class_inputeventscreendrag.rst | 37 +- classes/class_inputeventscreentouch.rst | 21 +- classes/class_inputeventshortcut.rst | 5 +- classes/class_inputeventwithmodifiers.rst | 35 +- classes/class_inputmap.rst | 81 +- classes/class_instanceplaceholder.rst | 21 +- classes/class_int.rst | 269 +- classes/class_intervaltweener.rst | 1 + classes/class_ip.rst | 66 +- classes/class_itemlist.rst | 339 +- classes/class_javaclass.rst | 1 + classes/class_javaclasswrapper.rst | 9 +- classes/class_javascriptbridge.rst | 53 +- classes/class_javascriptobject.rst | 1 + classes/class_jnisingleton.rst | 1 + classes/class_joint2d.rst | 25 +- classes/class_joint3d.rst | 25 +- classes/class_json.rst | 43 +- classes/class_jsonrpc.rst | 45 +- classes/class_kinematiccollision2d.rst | 81 +- classes/class_kinematiccollision3d.rst | 87 +- classes/class_label.rst | 122 +- classes/class_label3d.rst | 156 +- classes/class_labelsettings.rst | 37 +- classes/class_light2d.rst | 75 +- classes/class_light3d.rst | 125 +- classes/class_lightmapgi.rst | 73 +- classes/class_lightmapgidata.rst | 61 +- classes/class_lightmapper.rst | 1 + classes/class_lightmapperrd.rst | 1 + classes/class_lightmapprobe.rst | 1 + classes/class_lightoccluder2d.rst | 13 +- classes/class_line2d.rst | 95 +- classes/class_lineedit.rst | 222 +- classes/class_linkbutton.rst | 29 +- classes/class_mainloop.rst | 30 +- classes/class_margincontainer.rst | 4 + classes/class_marker2d.rst | 5 +- classes/class_marker3d.rst | 5 +- classes/class_marshalls.rst | 39 +- classes/class_material.rst | 47 +- classes/class_menubar.rst | 99 +- classes/class_menubutton.rst | 31 +- classes/class_mesh.rst | 163 +- .../class_meshconvexdecompositionsettings.rst | 53 +- classes/class_meshdatatool.rst | 231 +- classes/class_meshinstance2d.rst | 11 +- classes/class_meshinstance3d.rst | 87 +- classes/class_meshlibrary.rst | 135 +- classes/class_meshtexture.rst | 13 +- classes/class_methodtweener.rst | 21 +- classes/class_missingnode.rst | 13 +- classes/class_missingresource.rst | 9 +- classes/class_mobilevrinterface.rst | 29 +- classes/class_moviewriter.rst | 45 +- classes/class_multimesh.rst | 114 +- classes/class_multimeshinstance2d.rst | 14 +- classes/class_multimeshinstance3d.rst | 8 +- classes/class_multiplayerapi.rst | 92 +- classes/class_multiplayerapiextension.rst | 60 +- classes/class_multiplayerpeer.rst | 88 +- classes/class_multiplayerpeerextension.rst | 144 +- classes/class_multiplayerspawner.rst | 52 +- classes/class_multiplayersynchronizer.rst | 66 +- classes/class_mutex.rst | 21 +- classes/class_navigationagent2d.rst | 229 +- classes/class_navigationagent3d.rst | 241 +- classes/class_navigationlink2d.rst | 73 +- classes/class_navigationlink3d.rst | 73 +- classes/class_navigationmesh.rst | 159 +- classes/class_navigationmeshgenerator.rst | 31 +- ...ass_navigationmeshsourcegeometrydata2d.rst | 51 +- ...ass_navigationmeshsourcegeometrydata3d.rst | 57 +- classes/class_navigationobstacle2d.rst | 53 +- classes/class_navigationobstacle3d.rst | 61 +- .../class_navigationpathqueryparameters2d.rst | 33 +- .../class_navigationpathqueryparameters3d.rst | 33 +- classes/class_navigationpathqueryresult2d.rst | 29 +- classes/class_navigationpathqueryresult3d.rst | 29 +- classes/class_navigationpolygon.rst | 147 +- classes/class_navigationregion2d.rst | 103 +- classes/class_navigationregion3d.rst | 79 +- classes/class_navigationserver2d.rst | 749 ++-- classes/class_navigationserver3d.rst | 869 ++--- classes/class_ninepatchrect.rst | 53 +- classes/class_node.rst | 744 ++-- classes/class_node2d.rst | 117 +- classes/class_node3d.rst | 291 +- classes/class_node3dgizmo.rst | 1 + classes/class_nodepath.rst | 97 +- classes/class_noise.rst | 57 +- classes/class_noisetexture2d.rst | 49 +- classes/class_noisetexture3d.rst | 37 +- classes/class_object.rst | 337 +- classes/class_occluder3d.rst | 15 +- classes/class_occluderinstance3d.rst | 27 +- classes/class_occluderpolygon2d.rst | 13 +- classes/class_offlinemultiplayerpeer.rst | 1 + classes/class_oggpacketsequence.rst | 37 +- classes/class_oggpacketsequenceplayback.rst | 1 + classes/class_omnilight3d.rst | 16 +- classes/class_openxraction.rst | 13 +- classes/class_openxractionmap.rst | 77 +- classes/class_openxractionset.rst | 33 +- classes/class_openxrapiextension.rst | 125 +- .../class_openxrextensionwrapperextension.rst | 165 +- classes/class_openxrhand.rst | 23 +- classes/class_openxrinteractionprofile.rst | 23 +- ...class_openxrinteractionprofilemetadata.rst | 27 +- classes/class_openxrinterface.rst | 139 +- classes/class_openxripbinding.rst | 35 +- classes/class_optimizedtranslation.rst | 9 +- classes/class_optionbutton.rst | 186 +- classes/class_ormmaterial3d.rst | 1 + classes/class_os.rst | 399 +-- classes/class_packedbytearray.rst | 403 +-- classes/class_packedcolorarray.rst | 175 +- classes/class_packeddatacontainer.rst | 15 +- classes/class_packeddatacontainerref.rst | 9 +- classes/class_packedfloat32array.rst | 175 +- classes/class_packedfloat64array.rst | 175 +- classes/class_packedint32array.rst | 175 +- classes/class_packedint64array.rst | 175 +- classes/class_packedscene.rst | 27 +- classes/class_packedstringarray.rst | 175 +- classes/class_packedvector2array.rst | 181 +- classes/class_packedvector3array.rst | 181 +- classes/class_packetpeer.rst | 43 +- classes/class_packetpeerdtls.rst | 27 +- classes/class_packetpeerextension.rst | 27 +- classes/class_packetpeerstream.rst | 13 +- classes/class_packetpeerudp.rst | 81 +- classes/class_panel.rst | 1 + classes/class_panelcontainer.rst | 1 + classes/class_panoramaskymaterial.rst | 13 +- classes/class_parallaxbackground.rst | 25 +- classes/class_parallaxlayer.rst | 13 +- classes/class_particleprocessmaterial.rst | 441 +-- classes/class_path2d.rst | 5 +- classes/class_path3d.rst | 7 +- classes/class_pathfollow2d.rst | 29 +- classes/class_pathfollow3d.rst | 45 +- classes/class_pckpacker.rst | 21 +- classes/class_performance.rst | 45 +- classes/class_physicalbone2d.rst | 35 +- classes/class_physicalbone3d.rst | 89 +- classes/class_physicalskymaterial.rst | 45 +- classes/class_physicsbody2d.rst | 39 +- classes/class_physicsbody3d.rst | 75 +- classes/class_physicsdirectbodystate2d.rst | 203 +- ...lass_physicsdirectbodystate2dextension.rst | 267 +- classes/class_physicsdirectbodystate3d.rst | 207 +- ...lass_physicsdirectbodystate3dextension.rst | 279 +- classes/class_physicsdirectspacestate2d.rst | 39 +- ...ass_physicsdirectspacestate2dextension.rst | 45 +- classes/class_physicsdirectspacestate3d.rst | 39 +- ...ass_physicsdirectspacestate3dextension.rst | 51 +- classes/class_physicsmaterial.rst | 17 +- .../class_physicspointqueryparameters2d.rst | 53 +- .../class_physicspointqueryparameters3d.rst | 45 +- classes/class_physicsrayqueryparameters2d.rst | 69 +- classes/class_physicsrayqueryparameters3d.rst | 77 +- classes/class_physicsserver2d.rst | 711 ++-- classes/class_physicsserver2dextension.rst | 843 ++--- classes/class_physicsserver2dmanager.rst | 15 +- classes/class_physicsserver3d.rst | 999 +++--- classes/class_physicsserver3dextension.rst | 1143 +++--- classes/class_physicsserver3dmanager.rst | 15 +- ..._physicsserver3drenderingserverhandler.rst | 39 +- .../class_physicsshapequeryparameters2d.rst | 77 +- .../class_physicsshapequeryparameters3d.rst | 77 +- .../class_physicstestmotionparameters2d.rst | 63 +- .../class_physicstestmotionparameters3d.rst | 71 +- classes/class_physicstestmotionresult2d.rst | 81 +- classes/class_physicstestmotionresult3d.rst | 87 +- classes/class_pinjoint2d.rst | 25 +- classes/class_pinjoint3d.rst | 27 +- classes/class_placeholdercubemap.rst | 1 + classes/class_placeholdercubemaparray.rst | 1 + classes/class_placeholdermaterial.rst | 1 + classes/class_placeholdermesh.rst | 5 +- classes/class_placeholdertexture2d.rst | 5 +- classes/class_placeholdertexture2darray.rst | 1 + classes/class_placeholdertexture3d.rst | 5 +- classes/class_placeholdertexturelayered.rst | 9 +- classes/class_plane.rst | 145 +- classes/class_planemesh.rst | 21 +- classes/class_pointlight2d.rst | 20 +- classes/class_pointmesh.rst | 1 + classes/class_polygon2d.rst | 111 +- classes/class_polygonoccluder3d.rst | 5 +- classes/class_polygonpathfinder.rst | 51 +- classes/class_popup.rst | 3 +- classes/class_popupmenu.rst | 493 +-- classes/class_popuppanel.rst | 1 + classes/class_portablecompressedtexture2d.rst | 41 +- classes/class_primitivemesh.rst | 35 +- classes/class_prismmesh.rst | 21 +- classes/class_proceduralskymaterial.rst | 57 +- classes/class_progressbar.rst | 17 +- classes/class_projection.rst | 217 +- classes/class_projectsettings.rst | 147 +- classes/class_propertytweener.rst | 45 +- classes/class_quadmesh.rst | 1 + classes/class_quadoccluder3d.rst | 5 +- classes/class_quaternion.rst | 235 +- classes/class_randomnumbergenerator.rst | 47 +- classes/class_range.rst | 73 +- classes/class_raycast2d.rst | 115 +- classes/class_raycast3d.rst | 133 +- classes/class_rdattachmentformat.rst | 13 +- classes/class_rdframebufferpass.rst | 21 +- classes/class_rdpipelinecolorblendstate.rst | 37 +- ...ss_rdpipelinecolorblendstateattachment.rst | 53 +- classes/class_rdpipelinedepthstencilstate.rst | 85 +- classes/class_rdpipelinemultisamplestate.rst | 29 +- .../class_rdpipelinerasterizationstate.rst | 45 +- ...class_rdpipelinespecializationconstant.rst | 9 +- classes/class_rdsamplerstate.rst | 61 +- classes/class_rdshaderfile.rst | 25 +- classes/class_rdshadersource.rst | 39 +- classes/class_rdshaderspirv.rst | 67 +- classes/class_rdtextureformat.rst | 55 +- classes/class_rdtextureview.rst | 21 +- classes/class_rduniform.rst | 29 +- classes/class_rdvertexattribute.rst | 21 +- classes/class_rect2.rst | 145 +- classes/class_rect2i.rst | 127 +- classes/class_rectangleshape2d.rst | 5 +- classes/class_refcounted.rst | 29 +- classes/class_referencerect.rst | 13 +- classes/class_reflectionprobe.rst | 60 +- classes/class_regex.rst | 63 +- classes/class_regexmatch.rst | 33 +- classes/class_remotetransform2d.rst | 29 +- classes/class_remotetransform3d.rst | 29 +- classes/class_renderdata.rst | 106 + classes/class_renderdataextension.rst | 104 + classes/class_renderdatard.rst | 35 + classes/class_renderingdevice.rst | 685 ++-- classes/class_renderingserver.rst | 3109 +++++++++-------- classes/class_renderscenebuffers.rst | 11 +- .../class_renderscenebuffersconfiguration.rst | 37 +- classes/class_renderscenebuffersextension.rst | 27 +- classes/class_renderscenebuffersrd.rst | 151 +- classes/class_renderscenedata.rst | 140 + classes/class_renderscenedataextension.rst | 130 + classes/class_renderscenedatard.rst | 33 + classes/class_resource.rst | 71 +- classes/class_resourceformatloader.rst | 69 +- classes/class_resourceformatsaver.rst | 33 +- classes/class_resourceimporter.rst | 1 + classes/class_resourceimporterbitmap.rst | 1 + classes/class_resourceimporterbmfont.rst | 1 + .../class_resourceimportercsvtranslation.rst | 1 + classes/class_resourceimporterdynamicfont.rst | 1 + classes/class_resourceimporterimage.rst | 1 + classes/class_resourceimporterimagefont.rst | 1 + .../class_resourceimporterlayeredtexture.rst | 1 + classes/class_resourceimportermp3.rst | 1 + classes/class_resourceimporterobj.rst | 1 + classes/class_resourceimporteroggvorbis.rst | 15 +- classes/class_resourceimporterscene.rst | 1 + classes/class_resourceimportershaderfile.rst | 1 + classes/class_resourceimportertexture.rst | 1 + .../class_resourceimportertextureatlas.rst | 1 + classes/class_resourceimporterwav.rst | 1 + classes/class_resourceloader.rst | 75 +- classes/class_resourcepreloader.rst | 39 +- classes/class_resourcesaver.rst | 27 +- classes/class_resourceuid.rst | 51 +- classes/class_ribbontrailmesh.rst | 25 +- classes/class_richtexteffect.rst | 9 +- classes/class_richtextlabel.rst | 515 +-- classes/class_rid.rst | 67 +- classes/class_rigidbody2d.rst | 183 +- classes/class_rigidbody3d.rst | 189 +- classes/class_rootmotionview.rst | 21 +- classes/class_scenemultiplayer.rst | 77 +- classes/class_scenereplicationconfig.rst | 89 +- classes/class_scenestate.rst | 129 +- classes/class_scenetree.rst | 195 +- classes/class_scenetreetimer.rst | 7 +- classes/class_script.rst | 97 +- classes/class_scriptcreatedialog.rst | 11 +- classes/class_scripteditor.rst | 55 +- classes/class_scripteditorbase.rst | 33 +- classes/class_scriptextension.rst | 213 +- classes/class_scriptlanguage.rst | 1 + classes/class_scriptlanguageextension.rst | 349 +- classes/class_scrollbar.rst | 7 +- classes/class_scrollcontainer.rst | 57 +- classes/class_segmentshape2d.rst | 9 +- classes/class_semaphore.rst | 21 +- classes/class_separationrayshape2d.rst | 9 +- classes/class_separationrayshape3d.rst | 9 +- classes/class_separator.rst | 1 + classes/class_shader.rst | 31 +- classes/class_shaderglobalsoverride.rst | 1 + classes/class_shaderinclude.rst | 5 +- classes/class_shadermaterial.rst | 19 +- classes/class_shape2d.rst | 43 +- classes/class_shape3d.rst | 17 +- classes/class_shapecast2d.rst | 141 +- classes/class_shapecast3d.rst | 151 +- classes/class_shortcut.rst | 25 +- classes/class_signal.rst | 91 +- classes/class_skeleton2d.rst | 53 +- classes/class_skeleton3d.rst | 265 +- classes/class_skeletonik3d.rst | 67 +- classes/class_skeletonmodification2d.rst | 65 +- classes/class_skeletonmodification2dccdik.rst | 99 +- .../class_skeletonmodification2dfabrik.rst | 59 +- .../class_skeletonmodification2djiggle.rst | 151 +- .../class_skeletonmodification2dlookat.rst | 75 +- ...ss_skeletonmodification2dphysicalbones.rst | 41 +- ...lass_skeletonmodification2dstackholder.rst | 15 +- .../class_skeletonmodification2dtwoboneik.rst | 67 +- classes/class_skeletonmodificationstack2d.rst | 69 +- classes/class_skeletonprofile.rst | 135 +- classes/class_skeletonprofilehumanoid.rst | 1 + classes/class_skin.rst | 69 +- classes/class_skinreference.rst | 15 +- classes/class_sky.rst | 13 +- classes/class_slider.rst | 21 +- classes/class_sliderjoint3d.rst | 103 +- classes/class_softbody3d.rst | 113 +- classes/class_spheremesh.rst | 21 +- classes/class_sphereoccluder3d.rst | 5 +- classes/class_sphereshape3d.rst | 5 +- classes/class_spinbox.rst | 48 +- classes/class_splitcontainer.rst | 27 +- classes/class_spotlight3d.rst | 17 +- classes/class_springarm3d.rst | 43 +- classes/class_sprite2d.rst | 71 +- classes/class_sprite3d.rst | 33 +- classes/class_spritebase3d.rst | 107 +- classes/class_spriteframes.rst | 105 +- classes/class_standardmaterial3d.rst | 1 + classes/class_staticbody2d.rst | 13 +- classes/class_staticbody3d.rst | 13 +- classes/class_statusindicator.rst | 18 +- classes/class_streampeer.rst | 193 +- classes/class_streampeerbuffer.rst | 43 +- classes/class_streampeerextension.rst | 33 +- classes/class_streampeergzip.rst | 27 +- classes/class_streampeertcp.rst | 57 +- classes/class_streampeertls.rst | 39 +- classes/class_string.rst | 727 ++-- classes/class_stringname.rst | 679 ++-- classes/class_stylebox.rst | 97 +- classes/class_styleboxempty.rst | 1 + classes/class_styleboxflat.rst | 155 +- classes/class_styleboxline.rst | 21 +- classes/class_styleboxtexture.rst | 95 +- classes/class_subviewport.rst | 21 +- classes/class_subviewportcontainer.rst | 17 +- classes/class_surfacetool.rst | 197 +- classes/class_syntaxhighlighter.rst | 45 +- classes/class_systemfont.rst | 57 +- classes/class_tabbar.rst | 247 +- classes/class_tabcontainer.rst | 199 +- classes/class_tcpserver.rst | 39 +- classes/class_textedit.rst | 1014 +++--- classes/class_textline.rst | 151 +- classes/class_textmesh.rst | 77 +- classes/class_textparagraph.rst | 251 +- classes/class_textserver.rst | 1253 +++---- classes/class_textserveradvanced.rst | 1 + classes/class_textserverdummy.rst | 1 + classes/class_textserverextension.rst | 1263 +++---- classes/class_textserverfallback.rst | 1 + classes/class_textservermanager.rst | 55 +- classes/class_texture.rst | 1 + classes/class_texture2d.rst | 99 +- classes/class_texture2darray.rst | 9 +- classes/class_texture2darrayrd.rst | 1 + classes/class_texture2drd.rst | 5 +- classes/class_texture3d.rst | 83 +- classes/class_texture3drd.rst | 5 +- classes/class_texturebutton.rst | 41 +- classes/class_texturecubemaparrayrd.rst | 1 + classes/class_texturecubemaprd.rst | 1 + classes/class_texturelayered.rst | 87 +- classes/class_texturelayeredrd.rst | 5 +- classes/class_textureprogressbar.rst | 81 +- classes/class_texturerect.rst | 25 +- classes/class_theme.rst | 387 +- classes/class_themedb.rst | 37 +- classes/class_thread.rst | 39 +- classes/class_tiledata.rst | 193 +- classes/class_tilemap.rst | 340 +- classes/class_tilemaplayergroup.rst | 5 +- classes/class_tilemappattern.rst | 63 +- classes/class_tileset.rst | 479 +-- classes/class_tilesetatlassource.rst | 209 +- .../class_tilesetscenescollectionsource.rst | 69 +- classes/class_tilesetsource.rst | 39 +- classes/class_time.rst | 129 +- classes/class_timer.rst | 45 +- classes/class_tlsoptions.rst | 21 +- classes/class_torusmesh.rst | 17 +- classes/class_touchscreenbutton.rst | 49 +- classes/class_transform2d.rst | 229 +- classes/class_transform3d.rst | 181 +- classes/class_translation.rst | 67 +- classes/class_translationserver.rst | 133 +- classes/class_tree.rst | 303 +- classes/class_treeitem.rst | 635 ++-- classes/class_trianglemesh.rst | 1 + classes/class_tubetrailmesh.rst | 33 +- classes/class_tween.rst | 161 +- classes/class_tweener.rst | 3 +- classes/class_udpserver.rst | 49 +- classes/class_undoredo.rst | 135 +- classes/class_uniformsetcacherd.rst | 60 + classes/class_upnp.rst | 81 +- classes/class_upnpdevice.rst | 51 +- classes/class_variant.rst | 1 + classes/class_vboxcontainer.rst | 1 + classes/class_vector2.rst | 391 +-- classes/class_vector2i.rst | 211 +- classes/class_vector3.rst | 403 +-- classes/class_vector3i.rst | 205 +- classes/class_vector4.rst | 295 +- classes/class_vector4i.rst | 205 +- classes/class_vehiclebody3d.rst | 13 +- classes/class_vehiclewheel3d.rst | 83 +- classes/class_vflowcontainer.rst | 1 + classes/class_videostream.rst | 13 +- classes/class_videostreamplayback.rst | 87 +- classes/class_videostreamplayer.rst | 85 +- classes/class_videostreamtheora.rst | 1 + classes/class_viewport.rst | 365 +- classes/class_viewporttexture.rst | 5 +- classes/class_visibleonscreenenabler2d.rst | 9 +- classes/class_visibleonscreenenabler3d.rst | 9 +- classes/class_visibleonscreennotifier2d.rst | 17 +- classes/class_visibleonscreennotifier3d.rst | 17 +- classes/class_visualinstance3d.rst | 57 +- classes/class_visualshader.rst | 115 +- classes/class_visualshadernode.rst | 49 +- classes/class_visualshadernodebillboard.rst | 9 +- .../class_visualshadernodebooleanconstant.rst | 5 +- ...class_visualshadernodebooleanparameter.rst | 9 +- classes/class_visualshadernodeclamp.rst | 5 +- .../class_visualshadernodecolorconstant.rst | 5 +- classes/class_visualshadernodecolorfunc.rst | 5 +- classes/class_visualshadernodecolorop.rst | 5 +- .../class_visualshadernodecolorparameter.rst | 9 +- classes/class_visualshadernodecomment.rst | 9 +- classes/class_visualshadernodecompare.rst | 13 +- classes/class_visualshadernodeconstant.rst | 1 + classes/class_visualshadernodecubemap.rst | 15 +- ...class_visualshadernodecubemapparameter.rst | 1 + .../class_visualshadernodecurvetexture.rst | 5 +- .../class_visualshadernodecurvexyztexture.rst | 5 +- classes/class_visualshadernodecustom.rst | 135 +- .../class_visualshadernodederivativefunc.rst | 13 +- classes/class_visualshadernodedeterminant.rst | 1 + .../class_visualshadernodedistancefade.rst | 1 + classes/class_visualshadernodedotproduct.rst | 1 + classes/class_visualshadernodeexpression.rst | 5 +- classes/class_visualshadernodefaceforward.rst | 1 + .../class_visualshadernodefloatconstant.rst | 5 +- classes/class_visualshadernodefloatfunc.rst | 5 +- classes/class_visualshadernodefloatop.rst | 5 +- .../class_visualshadernodefloatparameter.rst | 25 +- classes/class_visualshadernodefresnel.rst | 1 + ...class_visualshadernodeglobalexpression.rst | 1 + classes/class_visualshadernodegroupbase.rst | 129 +- classes/class_visualshadernodeif.rst | 1 + classes/class_visualshadernodeinput.rst | 15 +- classes/class_visualshadernodeintconstant.rst | 5 +- classes/class_visualshadernodeintfunc.rst | 5 +- classes/class_visualshadernodeintop.rst | 5 +- .../class_visualshadernodeintparameter.rst | 25 +- classes/class_visualshadernodeis.rst | 5 +- ...class_visualshadernodelinearscenedepth.rst | 1 + classes/class_visualshadernodemix.rst | 5 +- classes/class_visualshadernodemultiplyadd.rst | 5 +- .../class_visualshadernodeouterproduct.rst | 1 + classes/class_visualshadernodeoutput.rst | 1 + classes/class_visualshadernodeparameter.rst | 9 +- .../class_visualshadernodeparameterref.rst | 5 +- ...ss_visualshadernodeparticleaccelerator.rst | 5 +- ...ass_visualshadernodeparticleboxemitter.rst | 1 + ...s_visualshadernodeparticleconevelocity.rst | 1 + .../class_visualshadernodeparticleemit.rst | 5 +- .../class_visualshadernodeparticleemitter.rst | 5 +- ...ss_visualshadernodeparticlemeshemitter.rst | 13 +- ...lshadernodeparticlemultiplybyaxisangle.rst | 5 +- .../class_visualshadernodeparticleoutput.rst | 1 + ...ass_visualshadernodeparticlerandomness.rst | 5 +- ...ss_visualshadernodeparticleringemitter.rst | 1 + ..._visualshadernodeparticlesphereemitter.rst | 1 + .../class_visualshadernodeproximityfade.rst | 1 + classes/class_visualshadernoderandomrange.rst | 1 + classes/class_visualshadernoderemap.rst | 1 + .../class_visualshadernoderesizablebase.rst | 5 +- .../class_visualshadernoderotationbyaxis.rst | 1 + classes/class_visualshadernodesample3d.rst | 5 +- ...visualshadernodescreennormalworldspace.rst | 1 + .../class_visualshadernodescreenuvtosdf.rst | 1 + classes/class_visualshadernodesdfraymarch.rst | 1 + .../class_visualshadernodesdftoscreenuv.rst | 1 + classes/class_visualshadernodesmoothstep.rst | 5 +- classes/class_visualshadernodestep.rst | 5 +- classes/class_visualshadernodeswitch.rst | 5 +- classes/class_visualshadernodetexture.rst | 15 +- .../class_visualshadernodetexture2darray.rst | 5 +- ...isualshadernodetexture2darrayparameter.rst | 1 + ...ass_visualshadernodetexture2dparameter.rst | 1 + classes/class_visualshadernodetexture3d.rst | 5 +- ...ass_visualshadernodetexture3dparameter.rst | 1 + ...class_visualshadernodetextureparameter.rst | 21 +- ...ualshadernodetextureparametertriplanar.rst | 1 + classes/class_visualshadernodetexturesdf.rst | 1 + ...class_visualshadernodetexturesdfnormal.rst | 1 + ...class_visualshadernodetransformcompose.rst | 1 + ...lass_visualshadernodetransformconstant.rst | 5 +- ...ass_visualshadernodetransformdecompose.rst | 1 + .../class_visualshadernodetransformfunc.rst | 5 +- classes/class_visualshadernodetransformop.rst | 5 +- ...ass_visualshadernodetransformparameter.rst | 9 +- ...class_visualshadernodetransformvecmult.rst | 5 +- .../class_visualshadernodeuintconstant.rst | 5 +- classes/class_visualshadernodeuintfunc.rst | 5 +- classes/class_visualshadernodeuintop.rst | 5 +- .../class_visualshadernodeuintparameter.rst | 9 +- classes/class_visualshadernodeuvfunc.rst | 5 +- .../class_visualshadernodeuvpolarcoord.rst | 1 + classes/class_visualshadernodevarying.rst | 9 +- .../class_visualshadernodevaryinggetter.rst | 1 + .../class_visualshadernodevaryingsetter.rst | 1 + .../class_visualshadernodevec2constant.rst | 5 +- .../class_visualshadernodevec2parameter.rst | 9 +- .../class_visualshadernodevec3constant.rst | 5 +- .../class_visualshadernodevec3parameter.rst | 9 +- .../class_visualshadernodevec4constant.rst | 5 +- .../class_visualshadernodevec4parameter.rst | 9 +- classes/class_visualshadernodevectorbase.rst | 5 +- .../class_visualshadernodevectorcompose.rst | 1 + .../class_visualshadernodevectordecompose.rst | 1 + .../class_visualshadernodevectordistance.rst | 1 + classes/class_visualshadernodevectorfunc.rst | 5 +- classes/class_visualshadernodevectorlen.rst | 1 + classes/class_visualshadernodevectorop.rst | 5 +- .../class_visualshadernodevectorrefract.rst | 1 + ...visualshadernodeworldpositionfromdepth.rst | 1 + classes/class_voxelgi.rst | 31 +- classes/class_voxelgidata.rst | 73 +- classes/class_vscrollbar.rst | 5 +- classes/class_vseparator.rst | 1 + classes/class_vslider.rst | 5 +- classes/class_vsplitcontainer.rst | 1 + classes/class_weakref.rst | 9 +- classes/class_webrtcdatachannel.rst | 79 +- classes/class_webrtcdatachannelextension.rst | 111 +- classes/class_webrtcmultiplayerpeer.rst | 51 +- classes/class_webrtcpeerconnection.rst | 81 +- .../class_webrtcpeerconnectionextension.rst | 69 +- classes/class_websocketmultiplayerpeer.rst | 57 +- classes/class_websocketpeer.rst | 119 +- classes/class_webxrinterface.rst | 111 +- classes/class_window.rst | 589 ++-- classes/class_workerthreadpool.rst | 45 +- classes/class_world2d.rst | 9 +- classes/class_world3d.rst | 21 +- classes/class_worldboundaryshape2d.rst | 9 +- classes/class_worldboundaryshape3d.rst | 5 +- classes/class_worldenvironment.rst | 31 +- classes/class_x509certificate.rst | 27 +- classes/class_xmlparser.rst | 105 +- classes/class_xranchor3d.rst | 15 +- classes/class_xrcamera3d.rst | 1 + classes/class_xrcontroller3d.rst | 41 +- classes/class_xrfacemodifier3d.rst | 95 + classes/class_xrfacetracker.rst | 1284 +++++++ classes/class_xrhandmodifier3d.rst | 149 + classes/class_xrhandtracker.rst | 632 ++++ classes/class_xrinterface.rst | 159 +- classes/class_xrinterfaceextension.rst | 219 +- classes/class_xrnode3d.rst | 37 +- classes/class_xrorigin3d.rst | 9 +- classes/class_xrpose.rst | 33 +- classes/class_xrpositionaltracker.rst | 73 +- classes/class_xrserver.rst | 293 +- classes/class_zippacker.rst | 33 +- classes/class_zipreader.rst | 33 +- classes/index.rst | 22 +- 938 files changed, 42729 insertions(+), 36889 deletions(-) create mode 100644 classes/class_compositor.rst create mode 100644 classes/class_compositoreffect.rst rename classes/{class_editorsceneformatimporterfbx.rst => class_editorsceneformatimporterfbx2gltf.rst} (73%) create mode 100644 classes/class_editorsceneformatimporterufbx.rst create mode 100644 classes/class_fbxdocument.rst create mode 100644 classes/class_fbxstate.rst create mode 100644 classes/class_framebuffercacherd.rst create mode 100644 classes/class_renderdata.rst create mode 100644 classes/class_renderdataextension.rst create mode 100644 classes/class_renderdatard.rst create mode 100644 classes/class_renderscenedata.rst create mode 100644 classes/class_renderscenedataextension.rst create mode 100644 classes/class_renderscenedatard.rst create mode 100644 classes/class_uniformsetcacherd.rst create mode 100644 classes/class_xrfacemodifier3d.rst create mode 100644 classes/class_xrfacetracker.rst create mode 100644 classes/class_xrhandmodifier3d.rst create mode 100644 classes/class_xrhandtracker.rst diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 787e68d96bb..688fb4cb7d3 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -36,37 +36,37 @@ Methods .. table:: :widths: auto - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`Color8` **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8=255 **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`assert` **(** :ref:`bool` condition, :ref:`String` message="" **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`char` **(** :ref:`int` char **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`convert` **(** :ref:`Variant` what, :ref:`int` type **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`dict_to_inst` **(** :ref:`Dictionary` dictionary **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_stack` **(** **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`inst_to_dict` **(** :ref:`Object` instance **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_instance_of` **(** :ref:`Variant` value, :ref:`Variant` type **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`len` **(** :ref:`Variant` var **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`load` **(** :ref:`String` path **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`preload` **(** :ref:`String` path **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`print_debug` **(** ... **)** |vararg| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`print_stack` **(** **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`range` **(** ... **)** |vararg| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`type_exists` **(** :ref:`StringName` type **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`Color8`\ (\ r8\: :ref:`int`, g8\: :ref:`int`, b8\: :ref:`int`, a8\: :ref:`int` = 255\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`assert`\ (\ condition\: :ref:`bool`, message\: :ref:`String` = ""\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`char`\ (\ char\: :ref:`int`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`convert`\ (\ what\: :ref:`Variant`, type\: :ref:`int`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`dict_to_inst`\ (\ dictionary\: :ref:`Dictionary`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_stack`\ (\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`inst_to_dict`\ (\ instance\: :ref:`Object`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_instance_of`\ (\ value\: :ref:`Variant`, type\: :ref:`Variant`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`len`\ (\ var\: :ref:`Variant`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`load`\ (\ path\: :ref:`String`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`preload`\ (\ path\: :ref:`String`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`print_debug`\ (\ ...\ ) |vararg| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`print_stack`\ (\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`range`\ (\ ...\ ) |vararg| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`type_exists`\ (\ type\: :ref:`StringName`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -124,7 +124,7 @@ Annotations .. rst-class:: classref-annotation -**@export** **(** **)** +**@export**\ (\ ) Mark the following property as exported (editable in the Inspector dock and saved to disk). To control the type of the exported property, use the type hint notation. @@ -170,7 +170,7 @@ Mark the following property as exported (editable in the Inspector dock and save .. rst-class:: classref-annotation -**@export_category** **(** :ref:`String` name **)** +**@export_category**\ (\ name\: :ref:`String`\ ) Define a new category for the following exported properties. This helps to organize properties in the Inspector dock. @@ -192,7 +192,7 @@ See also :ref:`@GlobalScope.PROPERTY_USAGE_CATEGORY` property without allowing its transparency (:ref:`Color.a`) to be edited. @@ -210,7 +210,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_COLOR_NO_ALPHA` property as a path to a directory. The path will be limited to the project folder and its subfolders. See :ref:`@export_global_dir` to allow picking from the entire filesystem. @@ -228,7 +228,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_DIR` names, ... **)** |vararg| +**@export_enum**\ (\ names\: :ref:`String`, ...\ ) |vararg| Export an :ref:`int` or :ref:`String` property as an enumerated list of options. If the property is an :ref:`int`, then the index of the value is stored, in the same order the values are provided. You can add explicit values using a colon. If the property is a :ref:`String`, then the value is stored. @@ -261,7 +261,7 @@ If you want to use named GDScript enums, then use :ref:`@export` hints="", ... **)** |vararg| +**@export_exp_easing**\ (\ hints\: :ref:`String` = "", ...\ ) |vararg| Export a floating-point property with an easing editor widget. Additional hints can be provided to adjust the behavior of the widget. ``"attenuation"`` flips the curve, which makes it more intuitive for editing attenuation properties. ``"positive_only"`` limits values to only be greater than or equal to zero. @@ -281,7 +281,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_EXP_EASING` filter="", ... **)** |vararg| +**@export_file**\ (\ filter\: :ref:`String` = "", ...\ ) |vararg| Export a :ref:`String` property as a path to a file. The path will be limited to the project folder and its subfolders. See :ref:`@export_global_file` to allow picking from the entire filesystem. @@ -302,7 +302,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_FILE` names, ... **)** |vararg| +**@export_flags**\ (\ names\: :ref:`String`, ...\ ) |vararg| Export an integer property as a bit flag field. This allows to store several "checked" or ``true`` values with one property, and comfortably select them from the Inspector dock. @@ -341,7 +341,7 @@ You can also combine several flags: .. rst-class:: classref-annotation -**@export_flags_2d_navigation** **(** **)** +**@export_flags_2d_navigation**\ (\ ) Export an integer property as a bit flag field for 2D navigation layers. The widget in the Inspector dock will use the layer names defined in :ref:`ProjectSettings.layer_names/2d_navigation/layer_1`. @@ -359,7 +359,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_LAYERS_2D_NAVIGATION`. @@ -377,7 +377,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_LAYERS_2D_PHYSICS`. @@ -395,7 +395,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_LAYERS_2D_RENDER`. @@ -413,7 +413,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_LAYERS_3D_NAVIGATION`. @@ -431,7 +431,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_LAYERS_3D_PHYSICS`. @@ -449,7 +449,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_LAYERS_3D_RENDER`. @@ -467,7 +467,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_LAYERS_AVOIDANCE` property as an absolute path to a directory. The path can be picked from the entire filesystem. See :ref:`@export_dir` to limit it to the project folder and its subfolders. @@ -485,7 +485,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_GLOBAL_DIR` filter="", ... **)** |vararg| +**@export_global_file**\ (\ filter\: :ref:`String` = "", ...\ ) |vararg| Export a :ref:`String` property as an absolute path to a file. The path can be picked from the entire filesystem. See :ref:`@export_file` to limit it to the project folder and its subfolders. @@ -506,7 +506,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_GLOBAL_FILE` name, :ref:`String` prefix="" **)** +**@export_group**\ (\ name\: :ref:`String`, prefix\: :ref:`String` = ""\ ) Define a new group for the following exported properties. This helps to organize properties in the Inspector dock. Groups can be added with an optional ``prefix``, which would make group to only consider properties that have this prefix. The grouping will break on the first property that doesn't have a prefix. The prefix is also removed from the property's name in the Inspector dock. @@ -537,7 +537,7 @@ See also :ref:`@GlobalScope.PROPERTY_USAGE_GROUP` property with a large :ref:`TextEdit` widget instead of a :ref:`LineEdit`. This adds support for multiline content and makes it easier to edit large amount of text stored in the property. @@ -555,7 +555,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_MULTILINE_TEXT` type="", ... **)** |vararg| +**@export_node_path**\ (\ type\: :ref:`String` = "", ...\ ) |vararg| Export a :ref:`NodePath` property with a filter for allowed node types. @@ -575,7 +575,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_NODE_PATH_VALID_TYPES` placeholder **)** +**@export_placeholder**\ (\ placeholder\: :ref:`String`\ ) Export a :ref:`String` property with a placeholder text displayed in the editor widget when no value is present. @@ -593,9 +593,9 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_PLACEHOLDER_TEXT` min, :ref:`float` max, :ref:`float` step=1.0, :ref:`String` extra_hints="", ... **)** |vararg| +**@export_range**\ (\ min\: :ref:`float`, max\: :ref:`float`, step\: :ref:`float` = 1.0, extra_hints\: :ref:`String` = "", ...\ ) |vararg| -Export an :ref:`int` or :ref:`float` property as a range value. The range must be defined by ``min`` and ``max``, as well as an optional ``step`` and a variety of extra hints. The ``step`` defaults to ``1`` for integer properties. For floating-point numbers this value depends on your ``EditorSettings.interface/inspector/default_float_step`` setting. +Export an :ref:`int` or :ref:`float` property as a range value. The range must be defined by ``min`` and ``max``, as well as an optional ``step`` and a variety of extra hints. The ``step`` defaults to ``1`` for integer properties. For floating-point numbers this value depends on your :ref:`EditorSettings.interface/inspector/default_float_step` setting. If hints ``"or_greater"`` and ``"or_less"`` are provided, the editor widget will not cap the value at range boundaries. The ``"exp"`` hint will make the edited values on range to change exponentially. The ``"hide_slider"`` hint will hide the slider element of the editor widget. @@ -624,7 +624,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_RANGE` name, :ref:`String` prefix="" **)** +**@export_subgroup**\ (\ name\: :ref:`String`, prefix\: :ref:`String` = ""\ ) Define a new subgroup for the following exported properties. This helps to organize properties in the Inspector dock. Subgroups work exactly like groups, except they need a parent group to exist. See :ref:`@export_group`. @@ -650,7 +650,7 @@ See also :ref:`@GlobalScope.PROPERTY_USAGE_SUBGROUP` icon_path **)** +**@icon**\ (\ icon_path\: :ref:`String`\ ) Add a custom icon to the current script. The icon specified at ``icon_path`` is displayed in the Scene dock for every node of that class, as well as in various editor dialogs. @@ -672,7 +672,7 @@ Add a custom icon to the current script. The icon specified at ``icon_path`` is .. rst-class:: classref-annotation -**@onready** **(** **)** +**@onready**\ (\ ) Mark the following property as assigned when the :ref:`Node` is ready. Values for these properties are not assigned immediately when the node is initialized (:ref:`Object._init`), and instead are computed and stored right before :ref:`Node._ready`. @@ -688,7 +688,7 @@ Mark the following property as assigned when the :ref:`Node` is read .. rst-class:: classref-annotation -**@rpc** **(** :ref:`String` mode="authority", :ref:`String` sync="call_remote", :ref:`String` transfer_mode="unreliable", :ref:`int` transfer_channel=0 **)** +**@rpc**\ (\ mode\: :ref:`String` = "authority", sync\: :ref:`String` = "call_remote", transfer_mode\: :ref:`String` = "unreliable", transfer_channel\: :ref:`int` = 0\ ) Mark the following method for remote procedure calls. See :doc:`High-level multiplayer <../tutorials/networking/high_level_multiplayer>`. @@ -721,7 +721,7 @@ The order of ``mode``, ``sync`` and ``transfer_mode`` does not matter, but value .. rst-class:: classref-annotation -**@static_unload** **(** **)** +**@static_unload**\ (\ ) 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. @@ -733,7 +733,7 @@ Make a script with static variables to not persist after all references are lost .. rst-class:: classref-annotation -**@tool** **(** **)** +**@tool**\ (\ ) Mark the current script as a tool script, allowing it to be loaded and executed by the editor. See :doc:`Running code in the editor <../tutorials/plugins/running_code_in_the_editor>`. @@ -752,7 +752,7 @@ Mark the current script as a tool script, allowing it to be loaded and executed .. rst-class:: classref-annotation -**@warning_ignore** **(** :ref:`String` warning, ... **)** |vararg| +**@warning_ignore**\ (\ warning\: :ref:`String`, ...\ ) |vararg| Mark the following statement to ignore the specified ``warning``. See :doc:`GDScript warning system <../tutorials/scripting/gdscript/warning_system>`. @@ -777,7 +777,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Color` **Color8** **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8=255 **)** +:ref:`Color` **Color8**\ (\ r8\: :ref:`int`, g8\: :ref:`int`, b8\: :ref:`int`, a8\: :ref:`int` = 255\ ) Returns a :ref:`Color` constructed from red (``r8``), green (``g8``), blue (``b8``), and optionally alpha (``a8``) integer channels, each divided by ``255.0`` for their final value. Using :ref:`Color8` instead of the standard :ref:`Color` constructor is useful when you need to match exact color values in an :ref:`Image`. @@ -797,7 +797,7 @@ Returns a :ref:`Color` constructed from red (``r8``), green (``g8`` .. rst-class:: classref-method -void **assert** **(** :ref:`bool` condition, :ref:`String` message="" **)** +|void| **assert**\ (\ condition\: :ref:`bool`, message\: :ref:`String` = ""\ ) Asserts that the ``condition`` is ``true``. If the ``condition`` is ``false``, an error is generated. When running from the editor, the running project will also be paused until you resume it. This can be used as a stronger form of :ref:`@GlobalScope.push_error` for reporting errors to project developers or add-on users. @@ -822,7 +822,7 @@ An optional ``message`` can be shown in addition to the generic "Assertion faile .. rst-class:: classref-method -:ref:`String` **char** **(** :ref:`int` char **)** +:ref:`String` **char**\ (\ char\: :ref:`int`\ ) Returns a single character (as a :ref:`String`) of the given Unicode code point (which is compatible with ASCII code). @@ -840,7 +840,7 @@ Returns a single character (as a :ref:`String`) of the given Unico .. rst-class:: classref-method -:ref:`Variant` **convert** **(** :ref:`Variant` what, :ref:`int` type **)** +:ref:`Variant` **convert**\ (\ what\: :ref:`Variant`, type\: :ref:`int`\ ) **Deprecated:** Use :ref:`@GlobalScope.type_convert` instead. @@ -863,7 +863,7 @@ Converts ``what`` to ``type`` in the best way possible. The ``type`` uses the :r .. rst-class:: classref-method -:ref:`Object` **dict_to_inst** **(** :ref:`Dictionary` dictionary **)** +:ref:`Object` **dict_to_inst**\ (\ dictionary\: :ref:`Dictionary`\ ) Converts a ``dictionary`` (created with :ref:`inst_to_dict`) back to an Object instance. Can be useful for deserializing. @@ -875,7 +875,7 @@ Converts a ``dictionary`` (created with :ref:`inst_to_dict` **get_stack** **(** **)** +:ref:`Array` **get_stack**\ (\ ) Returns an array of dictionaries representing the current call stack. See also :ref:`print_stack`. @@ -908,7 +908,7 @@ Starting from ``_ready()``, ``bar()`` would print: .. rst-class:: classref-method -:ref:`Dictionary` **inst_to_dict** **(** :ref:`Object` instance **)** +:ref:`Dictionary` **inst_to_dict**\ (\ instance\: :ref:`Object`\ ) Returns the passed ``instance`` converted to a Dictionary. Can be useful for serializing. @@ -937,7 +937,7 @@ Prints out: .. rst-class:: classref-method -:ref:`bool` **is_instance_of** **(** :ref:`Variant` value, :ref:`Variant` type **)** +:ref:`bool` **is_instance_of**\ (\ value\: :ref:`Variant`, type\: :ref:`Variant`\ ) Returns ``true`` if ``value`` is an instance of ``type``. The ``type`` value must be one of the following: @@ -970,7 +970,7 @@ See also :ref:`@GlobalScope.typeof`, :ref:`typ .. rst-class:: classref-method -:ref:`int` **len** **(** :ref:`Variant` var **)** +:ref:`int` **len**\ (\ var\: :ref:`Variant`\ ) Returns the length of the given Variant ``var``. The length can be the character count of a :ref:`String` or :ref:`StringName`, the element count of any array type, or the size of a :ref:`Dictionary`. For every other Variant type, a run-time error is generated and execution is stopped. @@ -990,7 +990,7 @@ Returns the length of the given Variant ``var``. The length can be the character .. rst-class:: classref-method -:ref:`Resource` **load** **(** :ref:`String` path **)** +:ref:`Resource` **load**\ (\ path\: :ref:`String`\ ) Returns a :ref:`Resource` from the filesystem located at the absolute ``path``. Unless it's already referenced elsewhere (such as in another script or in the scene), the resource is loaded from disk on function call, which might cause a slight delay, especially when loading large scenes. To avoid unnecessary delays when loading something multiple times, either store the resource in a variable or use :ref:`preload`. This method is equivalent of using :ref:`ResourceLoader.load` with :ref:`ResourceLoader.CACHE_MODE_REUSE`. @@ -1017,7 +1017,7 @@ This function is a simplified version of :ref:`ResourceLoader.load` **preload** **(** :ref:`String` path **)** +:ref:`Resource` **preload**\ (\ path\: :ref:`String`\ ) Returns a :ref:`Resource` from the filesystem located at ``path``. During run-time, the resource is loaded when the script is being parsed. This function effectively acts as a reference to that resource. Note that this function requires ``path`` to be a constant :ref:`String`. If you want to load a resource from a dynamic/variable path, use :ref:`load`. @@ -1036,7 +1036,7 @@ Returns a :ref:`Resource` from the filesystem located at ``path` .. rst-class:: classref-method -void **print_debug** **(** ... **)** |vararg| +|void| **print_debug**\ (\ ...\ ) |vararg| Like :ref:`@GlobalScope.print`, but includes the current stack frame when running with the debugger turned on. @@ -1057,7 +1057,7 @@ The output in the console may look like the following: .. rst-class:: classref-method -void **print_stack** **(** **)** +|void| **print_stack**\ (\ ) Prints a stack trace at the current code location. See also :ref:`get_stack`. @@ -1079,7 +1079,7 @@ The output in the console may look like the following: .. rst-class:: classref-method -:ref:`Array` **range** **(** ... **)** |vararg| +:ref:`Array` **range**\ (\ ...\ ) |vararg| Returns an array with the given range. :ref:`range` can be called in three ways: @@ -1141,7 +1141,7 @@ Output: .. rst-class:: classref-method -:ref:`bool` **type_exists** **(** :ref:`StringName` type **)** +:ref:`bool` **type_exists**\ (\ type\: :ref:`StringName`\ ) Returns ``true`` if the given :ref:`Object`-derived class exists in :ref:`ClassDB`. Note that :ref:`Variant` data types are not registered in :ref:`ClassDB`. @@ -1157,3 +1157,4 @@ Returns ``true`` if the given :ref:`Object`-derived class exists i .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 772db97b118..953b8fb432d 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -126,235 +126,235 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`abs` **(** :ref:`Variant` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`absf` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`absi` **(** :ref:`int` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`acos` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`acosh` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`angle_difference` **(** :ref:`float` from, :ref:`float` to **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`asin` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`asinh` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`atan` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`atan2` **(** :ref:`float` y, :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`atanh` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`bezier_derivative` **(** :ref:`float` start, :ref:`float` control_1, :ref:`float` control_2, :ref:`float` end, :ref:`float` t **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`bezier_interpolate` **(** :ref:`float` start, :ref:`float` control_1, :ref:`float` control_2, :ref:`float` end, :ref:`float` t **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`bytes_to_var` **(** :ref:`PackedByteArray` bytes **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`bytes_to_var_with_objects` **(** :ref:`PackedByteArray` bytes **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`ceil` **(** :ref:`Variant` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`ceilf` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`ceili` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`clamp` **(** :ref:`Variant` value, :ref:`Variant` min, :ref:`Variant` max **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`clampf` **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`clampi` **(** :ref:`int` value, :ref:`int` min, :ref:`int` max **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`cos` **(** :ref:`float` angle_rad **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`cosh` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`cubic_interpolate` **(** :ref:`float` from, :ref:`float` to, :ref:`float` pre, :ref:`float` post, :ref:`float` weight **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`cubic_interpolate_angle` **(** :ref:`float` from, :ref:`float` to, :ref:`float` pre, :ref:`float` post, :ref:`float` weight **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`cubic_interpolate_angle_in_time` **(** :ref:`float` from, :ref:`float` to, :ref:`float` pre, :ref:`float` post, :ref:`float` weight, :ref:`float` to_t, :ref:`float` pre_t, :ref:`float` post_t **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`cubic_interpolate_in_time` **(** :ref:`float` from, :ref:`float` to, :ref:`float` pre, :ref:`float` post, :ref:`float` weight, :ref:`float` to_t, :ref:`float` pre_t, :ref:`float` post_t **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`db_to_linear` **(** :ref:`float` db **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`deg_to_rad` **(** :ref:`float` deg **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`ease` **(** :ref:`float` x, :ref:`float` curve **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`error_string` **(** :ref:`int` error **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`exp` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`floor` **(** :ref:`Variant` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`floorf` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`floori` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`fmod` **(** :ref:`float` x, :ref:`float` y **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`fposmod` **(** :ref:`float` x, :ref:`float` y **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`hash` **(** :ref:`Variant` variable **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`instance_from_id` **(** :ref:`int` instance_id **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`inverse_lerp` **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`float` a, :ref:`float` b **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_finite` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_inf` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_instance_id_valid` **(** :ref:`int` id **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_instance_valid` **(** :ref:`Variant` instance **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_nan` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_same` **(** :ref:`Variant` a, :ref:`Variant` b **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_zero_approx` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`lerp` **(** :ref:`Variant` from, :ref:`Variant` to, :ref:`Variant` weight **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`lerp_angle` **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`lerpf` **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`linear_to_db` **(** :ref:`float` lin **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`log` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`max` **(** ... **)** |vararg| | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`maxf` **(** :ref:`float` a, :ref:`float` b **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`maxi` **(** :ref:`int` a, :ref:`int` b **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`min` **(** ... **)** |vararg| | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`minf` **(** :ref:`float` a, :ref:`float` b **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`mini` **(** :ref:`int` a, :ref:`int` b **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`move_toward` **(** :ref:`float` from, :ref:`float` to, :ref:`float` delta **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`nearest_po2` **(** :ref:`int` value **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`pingpong` **(** :ref:`float` value, :ref:`float` length **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`posmod` **(** :ref:`int` x, :ref:`int` y **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`pow` **(** :ref:`float` base, :ref:`float` exp **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`print` **(** ... **)** |vararg| | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`print_rich` **(** ... **)** |vararg| | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`print_verbose` **(** ... **)** |vararg| | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`printerr` **(** ... **)** |vararg| | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`printraw` **(** ... **)** |vararg| | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`prints` **(** ... **)** |vararg| | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`printt` **(** ... **)** |vararg| | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_error` **(** ... **)** |vararg| | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_warning` **(** ... **)** |vararg| | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`rad_to_deg` **(** :ref:`float` rad **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`rand_from_seed` **(** :ref:`int` seed **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`randf` **(** **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`randf_range` **(** :ref:`float` from, :ref:`float` to **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`randfn` **(** :ref:`float` mean, :ref:`float` deviation **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`randi` **(** **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`randi_range` **(** :ref:`int` from, :ref:`int` to **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`randomize` **(** **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`remap` **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rid_allocate_id` **(** **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`rid_from_int64` **(** :ref:`int` base **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`rotate_toward` **(** :ref:`float` from, :ref:`float` to, :ref:`float` delta **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`round` **(** :ref:`Variant` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`roundf` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`roundi` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`seed` **(** :ref:`int` base **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`sign` **(** :ref:`Variant` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`signf` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`signi` **(** :ref:`int` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`sin` **(** :ref:`float` angle_rad **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`sinh` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`smoothstep` **(** :ref:`float` from, :ref:`float` to, :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`snapped` **(** :ref:`Variant` x, :ref:`Variant` step **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`snappedf` **(** :ref:`float` x, :ref:`float` step **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`snappedi` **(** :ref:`float` x, :ref:`int` step **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`sqrt` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`step_decimals` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`str` **(** ... **)** |vararg| | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`str_to_var` **(** :ref:`String` string **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`tan` **(** :ref:`float` angle_rad **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`tanh` **(** :ref:`float` x **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`type_convert` **(** :ref:`Variant` variant, :ref:`int` type **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`type_string` **(** :ref:`int` type **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`typeof` **(** :ref:`Variant` variable **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`var_to_bytes` **(** :ref:`Variant` variable **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`var_to_bytes_with_objects` **(** :ref:`Variant` variable **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`var_to_str` **(** :ref:`Variant` variable **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`weakref` **(** :ref:`Variant` obj **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`wrap` **(** :ref:`Variant` value, :ref:`Variant` min, :ref:`Variant` max **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`wrapf` **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`wrapi` **(** :ref:`int` value, :ref:`int` min, :ref:`int` max **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`abs`\ (\ x\: :ref:`Variant`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`absf`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`absi`\ (\ x\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`acos`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`acosh`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`angle_difference`\ (\ from\: :ref:`float`, to\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`asin`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`asinh`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`atan`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`atan2`\ (\ y\: :ref:`float`, x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`atanh`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`bezier_derivative`\ (\ start\: :ref:`float`, control_1\: :ref:`float`, control_2\: :ref:`float`, end\: :ref:`float`, t\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`bezier_interpolate`\ (\ start\: :ref:`float`, control_1\: :ref:`float`, control_2\: :ref:`float`, end\: :ref:`float`, t\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`bytes_to_var`\ (\ bytes\: :ref:`PackedByteArray`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`bytes_to_var_with_objects`\ (\ bytes\: :ref:`PackedByteArray`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`ceil`\ (\ x\: :ref:`Variant`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`ceilf`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`ceili`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`clamp`\ (\ value\: :ref:`Variant`, min\: :ref:`Variant`, max\: :ref:`Variant`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`clampf`\ (\ value\: :ref:`float`, min\: :ref:`float`, max\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`clampi`\ (\ value\: :ref:`int`, min\: :ref:`int`, max\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`cos`\ (\ angle_rad\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`cosh`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`cubic_interpolate`\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`cubic_interpolate_angle`\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`cubic_interpolate_angle_in_time`\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`, to_t\: :ref:`float`, pre_t\: :ref:`float`, post_t\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`cubic_interpolate_in_time`\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`, to_t\: :ref:`float`, pre_t\: :ref:`float`, post_t\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`db_to_linear`\ (\ db\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`deg_to_rad`\ (\ deg\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`ease`\ (\ x\: :ref:`float`, curve\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`error_string`\ (\ error\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`exp`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`floor`\ (\ x\: :ref:`Variant`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`floorf`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`floori`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`fmod`\ (\ x\: :ref:`float`, y\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`fposmod`\ (\ x\: :ref:`float`, y\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`hash`\ (\ variable\: :ref:`Variant`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`instance_from_id`\ (\ instance_id\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`inverse_lerp`\ (\ from\: :ref:`float`, to\: :ref:`float`, weight\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equal_approx`\ (\ a\: :ref:`float`, b\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_finite`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_inf`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_instance_id_valid`\ (\ id\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_instance_valid`\ (\ instance\: :ref:`Variant`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_nan`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_same`\ (\ a\: :ref:`Variant`, b\: :ref:`Variant`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_zero_approx`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`lerp`\ (\ from\: :ref:`Variant`, to\: :ref:`Variant`, weight\: :ref:`Variant`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`lerp_angle`\ (\ from\: :ref:`float`, to\: :ref:`float`, weight\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`lerpf`\ (\ from\: :ref:`float`, to\: :ref:`float`, weight\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`linear_to_db`\ (\ lin\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`log`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`max`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`maxf`\ (\ a\: :ref:`float`, b\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`maxi`\ (\ a\: :ref:`int`, b\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`min`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`minf`\ (\ a\: :ref:`float`, b\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`mini`\ (\ a\: :ref:`int`, b\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`move_toward`\ (\ from\: :ref:`float`, to\: :ref:`float`, delta\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`nearest_po2`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`pingpong`\ (\ value\: :ref:`float`, length\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`posmod`\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`pow`\ (\ base\: :ref:`float`, exp\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`print`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`print_rich`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`print_verbose`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`printerr`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`printraw`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`prints`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`printt`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_error`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_warning`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`rad_to_deg`\ (\ rad\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`rand_from_seed`\ (\ seed\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`randf`\ (\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`randf_range`\ (\ from\: :ref:`float`, to\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`randfn`\ (\ mean\: :ref:`float`, deviation\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`randi`\ (\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`randi_range`\ (\ from\: :ref:`int`, to\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`randomize`\ (\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`remap`\ (\ value\: :ref:`float`, istart\: :ref:`float`, istop\: :ref:`float`, ostart\: :ref:`float`, ostop\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rid_allocate_id`\ (\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`rid_from_int64`\ (\ base\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`rotate_toward`\ (\ from\: :ref:`float`, to\: :ref:`float`, delta\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`round`\ (\ x\: :ref:`Variant`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`roundf`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`roundi`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`seed`\ (\ base\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`sign`\ (\ x\: :ref:`Variant`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`signf`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`signi`\ (\ x\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`sin`\ (\ angle_rad\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`sinh`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`smoothstep`\ (\ from\: :ref:`float`, to\: :ref:`float`, x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`snapped`\ (\ x\: :ref:`Variant`, step\: :ref:`Variant`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`snappedf`\ (\ x\: :ref:`float`, step\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`snappedi`\ (\ x\: :ref:`float`, step\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`sqrt`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`step_decimals`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`str`\ (\ ...\ ) |vararg| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`str_to_var`\ (\ string\: :ref:`String`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`tan`\ (\ angle_rad\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`tanh`\ (\ x\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`type_convert`\ (\ variant\: :ref:`Variant`, type\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`type_string`\ (\ type\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`typeof`\ (\ variable\: :ref:`Variant`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`var_to_bytes`\ (\ variable\: :ref:`Variant`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`var_to_bytes_with_objects`\ (\ variable\: :ref:`Variant`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`var_to_str`\ (\ variable\: :ref:`Variant`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`weakref`\ (\ obj\: :ref:`Variant`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`wrap`\ (\ value\: :ref:`Variant`, min\: :ref:`Variant`, max\: :ref:`Variant`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`wrapf`\ (\ value\: :ref:`float`, min\: :ref:`float`, max\: :ref:`float`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`wrapi`\ (\ value\: :ref:`int`, min\: :ref:`int`, max\: :ref:`int`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -3744,11 +3744,7 @@ Examples: :ref:`PropertyHint` **PROPERTY_HINT_NODE_PATH_TO_EDITED_NODE** = ``24`` -**Deprecated:** This hint is not used anywhere and will be removed in the future. - -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! +**Deprecated:** This hint is not used by the engine. @@ -3790,11 +3786,7 @@ Hints that a :ref:`String` property is a path to a file. Editing i :ref:`PropertyHint` **PROPERTY_HINT_INT_IS_OBJECTID** = ``29`` -**Deprecated:** This hint is not used anywhere and will be removed in the future. - -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! +**Deprecated:** This hint is not used by the engine. @@ -3998,11 +3990,7 @@ If this property is modified, all inspector fields will be refreshed. :ref:`PropertyUsageFlags` **PROPERTY_USAGE_SCRIPT_DEFAULT_VALUE** = ``32768`` -**Deprecated:** This hint is not used anywhere and will be removed in the future. - -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! +**Deprecated:** This flag is not used by the engine. @@ -4084,11 +4072,7 @@ Inserting an animation key frame of this property will automatically increment t :ref:`PropertyUsageFlags` **PROPERTY_USAGE_DEFERRED_SET_RESOURCE** = ``33554432`` -**Deprecated:** This hint is not used anywhere and will be removed in the future. - -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! +**Deprecated:** This flag is not used by the engine. @@ -5222,7 +5206,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **abs** **(** :ref:`Variant` x **)** +:ref:`Variant` **abs**\ (\ x\: :ref:`Variant`\ ) Returns the absolute value of a :ref:`Variant` parameter ``x`` (i.e. non-negative value). Supported types: :ref:`int`, :ref:`float`, :ref:`Vector2`, :ref:`Vector2i`, :ref:`Vector3`, :ref:`Vector3i`, :ref:`Vector4`, :ref:`Vector4i`. @@ -5256,7 +5240,7 @@ Returns the absolute value of a :ref:`Variant` parameter ``x`` (i .. rst-class:: classref-method -:ref:`float` **absf** **(** :ref:`float` x **)** +:ref:`float` **absf**\ (\ x\: :ref:`float`\ ) Returns the absolute value of float parameter ``x`` (i.e. positive value). @@ -5273,7 +5257,7 @@ Returns the absolute value of float parameter ``x`` (i.e. positive value). .. rst-class:: classref-method -:ref:`int` **absi** **(** :ref:`int` x **)** +:ref:`int` **absi**\ (\ x\: :ref:`int`\ ) Returns the absolute value of int parameter ``x`` (i.e. positive value). @@ -5290,7 +5274,7 @@ Returns the absolute value of int parameter ``x`` (i.e. positive value). .. rst-class:: classref-method -:ref:`float` **acos** **(** :ref:`float` x **)** +:ref:`float` **acos**\ (\ x\: :ref:`float`\ ) Returns the arc cosine of ``x`` in radians. Use to get the angle of cosine ``x``. ``x`` will be clamped between ``-1.0`` and ``1.0`` (inclusive), in order to prevent :ref:`acos` from returning :ref:`@GDScript.NAN`. @@ -5307,7 +5291,7 @@ Returns the arc cosine of ``x`` in radians. Use to get the angle of cosine ``x`` .. rst-class:: classref-method -:ref:`float` **acosh** **(** :ref:`float` x **)** +:ref:`float` **acosh**\ (\ x\: :ref:`float`\ ) Returns the hyperbolic arc (also called inverse) cosine of ``x``, returning a value in radians. Use it to get the angle from an angle's cosine in hyperbolic space if ``x`` is larger or equal to 1. For values of ``x`` lower than 1, it will return 0, in order to prevent :ref:`acosh` from returning :ref:`@GDScript.NAN`. @@ -5326,7 +5310,7 @@ Returns the hyperbolic arc (also called inverse) cosine of ``x``, returning a va .. rst-class:: classref-method -:ref:`float` **angle_difference** **(** :ref:`float` from, :ref:`float` to **)** +:ref:`float` **angle_difference**\ (\ from\: :ref:`float`, to\: :ref:`float`\ ) Returns the difference between the two angles, in the range of ``[-PI, +PI]``. When ``from`` and ``to`` are opposite, returns ``-PI`` if ``from`` is smaller than ``to``, or ``PI`` otherwise. @@ -5338,7 +5322,7 @@ Returns the difference between the two angles, in the range of ``[-PI, +PI]``. W .. rst-class:: classref-method -:ref:`float` **asin** **(** :ref:`float` x **)** +:ref:`float` **asin**\ (\ x\: :ref:`float`\ ) Returns the arc sine of ``x`` in radians. Use to get the angle of sine ``x``. ``x`` will be clamped between ``-1.0`` and ``1.0`` (inclusive), in order to prevent :ref:`asin` from returning :ref:`@GDScript.NAN`. @@ -5355,7 +5339,7 @@ Returns the arc sine of ``x`` in radians. Use to get the angle of sine ``x``. `` .. rst-class:: classref-method -:ref:`float` **asinh** **(** :ref:`float` x **)** +:ref:`float` **asinh**\ (\ x\: :ref:`float`\ ) Returns the hyperbolic arc (also called inverse) sine of ``x``, returning a value in radians. Use it to get the angle from an angle's sine in hyperbolic space. @@ -5372,7 +5356,7 @@ Returns the hyperbolic arc (also called inverse) sine of ``x``, returning a valu .. rst-class:: classref-method -:ref:`float` **atan** **(** :ref:`float` x **)** +:ref:`float` **atan**\ (\ x\: :ref:`float`\ ) Returns the arc tangent of ``x`` in radians. Use it to get the angle from an angle's tangent in trigonometry. @@ -5392,7 +5376,7 @@ If ``x`` is between ``-PI / 2`` and ``PI / 2`` (inclusive), ``atan(tan(x))`` is .. rst-class:: classref-method -:ref:`float` **atan2** **(** :ref:`float` y, :ref:`float` x **)** +:ref:`float` **atan2**\ (\ y\: :ref:`float`, x\: :ref:`float`\ ) Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent ``y/x``. To compute the value, the method takes into account the sign of both arguments in order to determine the quadrant. @@ -5410,7 +5394,7 @@ Important note: The Y coordinate comes first, by convention. .. rst-class:: classref-method -:ref:`float` **atanh** **(** :ref:`float` x **)** +:ref:`float` **atanh**\ (\ x\: :ref:`float`\ ) Returns the hyperbolic arc (also called inverse) tangent of ``x``, returning a value in radians. Use it to get the angle from an angle's tangent in hyperbolic space if ``x`` is between -1 and 1 (non-inclusive). @@ -5432,7 +5416,7 @@ In mathematics, the inverse hyperbolic tangent is only defined for -1 < ``x`` < .. rst-class:: classref-method -:ref:`float` **bezier_derivative** **(** :ref:`float` start, :ref:`float` control_1, :ref:`float` control_2, :ref:`float` end, :ref:`float` t **)** +:ref:`float` **bezier_derivative**\ (\ start\: :ref:`float`, control_1\: :ref:`float`, control_2\: :ref:`float`, end\: :ref:`float`, t\: :ref:`float`\ ) Returns the derivative at the given ``t`` on a one-dimensional `Bézier curve `__ defined by the given ``control_1``, ``control_2``, and ``end`` points. @@ -5444,7 +5428,7 @@ Returns the derivative at the given ``t`` on a one-dimensional `Bézier curve ` **bezier_interpolate** **(** :ref:`float` start, :ref:`float` control_1, :ref:`float` control_2, :ref:`float` end, :ref:`float` t **)** +:ref:`float` **bezier_interpolate**\ (\ start\: :ref:`float`, control_1\: :ref:`float`, control_2\: :ref:`float`, end\: :ref:`float`, t\: :ref:`float`\ ) Returns the point at the given ``t`` on a one-dimensional `Bézier curve `__ defined by the given ``control_1``, ``control_2``, and ``end`` points. @@ -5456,7 +5440,7 @@ Returns the point at the given ``t`` on a one-dimensional `Bézier curve ` **bytes_to_var** **(** :ref:`PackedByteArray` bytes **)** +:ref:`Variant` **bytes_to_var**\ (\ bytes\: :ref:`PackedByteArray`\ ) Decodes a byte array back to a :ref:`Variant` value, without decoding objects. @@ -5470,7 +5454,7 @@ Decodes a byte array back to a :ref:`Variant` value, without deco .. rst-class:: classref-method -:ref:`Variant` **bytes_to_var_with_objects** **(** :ref:`PackedByteArray` bytes **)** +:ref:`Variant` **bytes_to_var_with_objects**\ (\ bytes\: :ref:`PackedByteArray`\ ) Decodes a byte array back to a :ref:`Variant` value. Decoding objects is allowed. @@ -5484,7 +5468,7 @@ Decodes a byte array back to a :ref:`Variant` value. Decoding obj .. rst-class:: classref-method -:ref:`Variant` **ceil** **(** :ref:`Variant` x **)** +:ref:`Variant` **ceil**\ (\ x\: :ref:`Variant`\ ) Rounds ``x`` upward (towards positive infinity), returning the smallest whole number that is not less than ``x``. Supported types: :ref:`int`, :ref:`float`, :ref:`Vector2`, :ref:`Vector2i`, :ref:`Vector3`, :ref:`Vector3i`, :ref:`Vector4`, :ref:`Vector4i`. @@ -5505,7 +5489,7 @@ See also :ref:`floor`, :ref:`round` **ceilf** **(** :ref:`float` x **)** +:ref:`float` **ceilf**\ (\ x\: :ref:`float`\ ) Rounds ``x`` upward (towards positive infinity), returning the smallest whole number that is not less than ``x``. @@ -5519,7 +5503,7 @@ A type-safe version of :ref:`ceil`, returning a .. rst-class:: classref-method -:ref:`int` **ceili** **(** :ref:`float` x **)** +:ref:`int` **ceili**\ (\ x\: :ref:`float`\ ) Rounds ``x`` upward (towards positive infinity), returning the smallest whole number that is not less than ``x``. @@ -5533,7 +5517,7 @@ A type-safe version of :ref:`ceil`, returning an .. rst-class:: classref-method -:ref:`Variant` **clamp** **(** :ref:`Variant` value, :ref:`Variant` min, :ref:`Variant` max **)** +:ref:`Variant` **clamp**\ (\ value\: :ref:`Variant`, min\: :ref:`Variant`, max\: :ref:`Variant`\ ) Clamps the ``value``, returning a :ref:`Variant` not less than ``min`` and not more than ``max``. Any values that can be compared with the less than and greater than operators will work. @@ -5557,7 +5541,7 @@ Clamps the ``value``, returning a :ref:`Variant` not less than `` .. rst-class:: classref-method -:ref:`float` **clampf** **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** +:ref:`float` **clampf**\ (\ value\: :ref:`float`, min\: :ref:`float`, max\: :ref:`float`\ ) Clamps the ``value``, returning a :ref:`float` not less than ``min`` and not more than ``max``. @@ -5577,7 +5561,7 @@ Clamps the ``value``, returning a :ref:`float` not less than ``min` .. rst-class:: classref-method -:ref:`int` **clampi** **(** :ref:`int` value, :ref:`int` min, :ref:`int` max **)** +:ref:`int` **clampi**\ (\ value\: :ref:`int`, min\: :ref:`int`, max\: :ref:`int`\ ) Clamps the ``value``, returning an :ref:`int` not less than ``min`` and not more than ``max``. @@ -5597,7 +5581,7 @@ Clamps the ``value``, returning an :ref:`int` not less than ``min`` a .. rst-class:: classref-method -:ref:`float` **cos** **(** :ref:`float` angle_rad **)** +:ref:`float` **cos**\ (\ angle_rad\: :ref:`float`\ ) Returns the cosine of angle ``angle_rad`` in radians. @@ -5615,7 +5599,7 @@ Returns the cosine of angle ``angle_rad`` in radians. .. rst-class:: classref-method -:ref:`float` **cosh** **(** :ref:`float` x **)** +:ref:`float` **cosh**\ (\ x\: :ref:`float`\ ) Returns the hyperbolic cosine of ``x`` in radians. @@ -5631,7 +5615,7 @@ Returns the hyperbolic cosine of ``x`` in radians. .. rst-class:: classref-method -:ref:`float` **cubic_interpolate** **(** :ref:`float` from, :ref:`float` to, :ref:`float` pre, :ref:`float` post, :ref:`float` weight **)** +:ref:`float` **cubic_interpolate**\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`\ ) Cubic interpolates between two values by the factor defined in ``weight`` with ``pre`` and ``post`` values. @@ -5643,7 +5627,7 @@ Cubic interpolates between two values by the factor defined in ``weight`` with ` .. rst-class:: classref-method -:ref:`float` **cubic_interpolate_angle** **(** :ref:`float` from, :ref:`float` to, :ref:`float` pre, :ref:`float` post, :ref:`float` weight **)** +:ref:`float` **cubic_interpolate_angle**\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`\ ) Cubic interpolates between two rotation values with shortest path by the factor defined in ``weight`` with ``pre`` and ``post`` values. See also :ref:`lerp_angle`. @@ -5655,7 +5639,7 @@ Cubic interpolates between two rotation values with shortest path by the factor .. rst-class:: classref-method -:ref:`float` **cubic_interpolate_angle_in_time** **(** :ref:`float` from, :ref:`float` to, :ref:`float` pre, :ref:`float` post, :ref:`float` weight, :ref:`float` to_t, :ref:`float` pre_t, :ref:`float` post_t **)** +:ref:`float` **cubic_interpolate_angle_in_time**\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`, to_t\: :ref:`float`, pre_t\: :ref:`float`, post_t\: :ref:`float`\ ) Cubic interpolates between two rotation values with shortest path by the factor defined in ``weight`` with ``pre`` and ``post`` values. See also :ref:`lerp_angle`. @@ -5669,7 +5653,7 @@ It can perform smoother interpolation than :ref:`cubic_interpolate` **cubic_interpolate_in_time** **(** :ref:`float` from, :ref:`float` to, :ref:`float` pre, :ref:`float` post, :ref:`float` weight, :ref:`float` to_t, :ref:`float` pre_t, :ref:`float` post_t **)** +:ref:`float` **cubic_interpolate_in_time**\ (\ from\: :ref:`float`, to\: :ref:`float`, pre\: :ref:`float`, post\: :ref:`float`, weight\: :ref:`float`, to_t\: :ref:`float`, pre_t\: :ref:`float`, post_t\: :ref:`float`\ ) Cubic interpolates between two values by the factor defined in ``weight`` with ``pre`` and ``post`` values. @@ -5683,7 +5667,7 @@ It can perform smoother interpolation than :ref:`cubic_interpolate` **db_to_linear** **(** :ref:`float` db **)** +:ref:`float` **db_to_linear**\ (\ db\: :ref:`float`\ ) Converts from decibels to linear energy (audio). @@ -5695,7 +5679,7 @@ Converts from decibels to linear energy (audio). .. rst-class:: classref-method -:ref:`float` **deg_to_rad** **(** :ref:`float` deg **)** +:ref:`float` **deg_to_rad**\ (\ deg\: :ref:`float`\ ) Converts an angle expressed in degrees to radians. @@ -5711,7 +5695,7 @@ Converts an angle expressed in degrees to radians. .. rst-class:: classref-method -:ref:`float` **ease** **(** :ref:`float` x, :ref:`float` curve **)** +:ref:`float` **ease**\ (\ x\: :ref:`float`, curve\: :ref:`float`\ ) Returns an "eased" value of ``x`` based on an easing function defined with ``curve``. This easing function is based on an exponent. The ``curve`` can be any floating-point number, with specific values leading to the following behaviors: @@ -5737,7 +5721,7 @@ See also :ref:`smoothstep`. If you need to .. rst-class:: classref-method -:ref:`String` **error_string** **(** :ref:`int` error **)** +:ref:`String` **error_string**\ (\ error\: :ref:`int`\ ) Returns a human-readable name for the given :ref:`Error` code. @@ -5756,7 +5740,7 @@ Returns a human-readable name for the given :ref:`Error .. rst-class:: classref-method -:ref:`float` **exp** **(** :ref:`float` x **)** +:ref:`float` **exp**\ (\ x\: :ref:`float`\ ) The natural exponential function. It raises the mathematical constant *e* to the power of ``x`` and returns it. @@ -5776,7 +5760,7 @@ For exponents to other bases use the method :ref:`pow` **floor** **(** :ref:`Variant` x **)** +:ref:`Variant` **floor**\ (\ x\: :ref:`Variant`\ ) Rounds ``x`` downward (towards negative infinity), returning the largest whole number that is not more than ``x``. Supported types: :ref:`int`, :ref:`float`, :ref:`Vector2`, :ref:`Vector2i`, :ref:`Vector3`, :ref:`Vector3i`, :ref:`Vector4`, :ref:`Vector4i`. @@ -5797,7 +5781,7 @@ See also :ref:`ceil`, :ref:`round` **floorf** **(** :ref:`float` x **)** +:ref:`float` **floorf**\ (\ x\: :ref:`float`\ ) Rounds ``x`` downward (towards negative infinity), returning the largest whole number that is not more than ``x``. @@ -5811,7 +5795,7 @@ A type-safe version of :ref:`floor`, returning .. rst-class:: classref-method -:ref:`int` **floori** **(** :ref:`float` x **)** +:ref:`int` **floori**\ (\ x\: :ref:`float`\ ) Rounds ``x`` downward (towards negative infinity), returning the largest whole number that is not more than ``x``. @@ -5827,7 +5811,7 @@ A type-safe version of :ref:`floor`, returning .. rst-class:: classref-method -:ref:`float` **fmod** **(** :ref:`float` x, :ref:`float` y **)** +:ref:`float` **fmod**\ (\ x\: :ref:`float`, y\: :ref:`float`\ ) Returns the floating-point remainder of ``x`` divided by ``y``, keeping the sign of ``x``. @@ -5845,7 +5829,7 @@ For the integer remainder operation, use the ``%`` operator. .. rst-class:: classref-method -:ref:`float` **fposmod** **(** :ref:`float` x, :ref:`float` y **)** +:ref:`float` **fposmod**\ (\ x\: :ref:`float`, y\: :ref:`float`\ ) Returns the floating-point modulus of ``x`` divided by ``y``, wrapping equally in positive and negative. @@ -5877,7 +5861,7 @@ Produces: .. rst-class:: classref-method -:ref:`int` **hash** **(** :ref:`Variant` variable **)** +:ref:`int` **hash**\ (\ variable\: :ref:`Variant`\ ) Returns the integer hash of the passed ``variable``. @@ -5902,7 +5886,7 @@ Returns the integer hash of the passed ``variable``. .. rst-class:: classref-method -:ref:`Object` **instance_from_id** **(** :ref:`int` instance_id **)** +:ref:`Object` **instance_from_id**\ (\ instance_id\: :ref:`int`\ ) Returns the :ref:`Object` that corresponds to ``instance_id``. All Objects have a unique instance ID. See also :ref:`Object.get_instance_id`. @@ -5942,7 +5926,7 @@ Returns the :ref:`Object` that corresponds to ``instance_id``. All .. rst-class:: classref-method -:ref:`float` **inverse_lerp** **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** +:ref:`float` **inverse_lerp**\ (\ from\: :ref:`float`, to\: :ref:`float`, weight\: :ref:`float`\ ) Returns an interpolation or extrapolation factor considering the range specified in ``from`` and ``to``, and the interpolated value specified in ``weight``. The returned value will be between ``0.0`` and ``1.0`` if ``weight`` is between ``from`` and ``to`` (inclusive). If ``weight`` is located outside this range, then an extrapolation factor will be returned (return value lower than ``0.0`` or greater than ``1.0``). Use :ref:`clamp` on the result of :ref:`inverse_lerp` if this is not desired. @@ -5966,7 +5950,7 @@ See also :ref:`lerp`, which performs the reverse .. rst-class:: classref-method -:ref:`bool` **is_equal_approx** **(** :ref:`float` a, :ref:`float` b **)** +:ref:`bool` **is_equal_approx**\ (\ a\: :ref:`float`, b\: :ref:`float`\ ) Returns ``true`` if ``a`` and ``b`` are approximately equal to each other. @@ -5982,7 +5966,7 @@ Infinity values of the same sign are considered equal. .. rst-class:: classref-method -:ref:`bool` **is_finite** **(** :ref:`float` x **)** +:ref:`bool` **is_finite**\ (\ x\: :ref:`float`\ ) Returns whether ``x`` is a finite value, i.e. it is not :ref:`@GDScript.NAN`, positive infinity, or negative infinity. @@ -5994,7 +5978,7 @@ Returns whether ``x`` is a finite value, i.e. it is not :ref:`@GDScript.NAN` **is_inf** **(** :ref:`float` x **)** +:ref:`bool` **is_inf**\ (\ x\: :ref:`float`\ ) Returns ``true`` if ``x`` is either positive infinity or negative infinity. @@ -6006,7 +5990,7 @@ Returns ``true`` if ``x`` is either positive infinity or negative infinity. .. rst-class:: classref-method -:ref:`bool` **is_instance_id_valid** **(** :ref:`int` id **)** +:ref:`bool` **is_instance_id_valid**\ (\ id\: :ref:`int`\ ) Returns ``true`` if the Object that corresponds to ``id`` is a valid object (e.g. has not been deleted from memory). All Objects have a unique instance ID. @@ -6018,7 +6002,7 @@ Returns ``true`` if the Object that corresponds to ``id`` is a valid object (e.g .. rst-class:: classref-method -:ref:`bool` **is_instance_valid** **(** :ref:`Variant` instance **)** +:ref:`bool` **is_instance_valid**\ (\ instance\: :ref:`Variant`\ ) Returns ``true`` if ``instance`` is a valid Object (e.g. has not been deleted from memory). @@ -6030,7 +6014,7 @@ Returns ``true`` if ``instance`` is a valid Object (e.g. has not been deleted fr .. rst-class:: classref-method -:ref:`bool` **is_nan** **(** :ref:`float` x **)** +:ref:`bool` **is_nan**\ (\ x\: :ref:`float`\ ) Returns ``true`` if ``x`` is a NaN ("Not a Number" or invalid) value. @@ -6042,7 +6026,7 @@ Returns ``true`` if ``x`` is a NaN ("Not a Number" or invalid) value. .. rst-class:: classref-method -:ref:`bool` **is_same** **(** :ref:`Variant` a, :ref:`Variant` b **)** +:ref:`bool` **is_same**\ (\ a\: :ref:`Variant`, b\: :ref:`Variant`\ ) Returns ``true``, for value types, if ``a`` and ``b`` share the same value. Returns ``true``, for reference types, if the references of ``a`` and ``b`` are the same. @@ -6074,7 +6058,7 @@ These are :ref:`Variant` reference types: :ref:`Object` **is_zero_approx** **(** :ref:`float` x **)** +:ref:`bool` **is_zero_approx**\ (\ x\: :ref:`float`\ ) Returns ``true`` if ``x`` is zero or almost zero. The comparison is done using a tolerance calculation with a small internal epsilon. @@ -6088,7 +6072,7 @@ This function is faster than using :ref:`is_equal_approx` **lerp** **(** :ref:`Variant` from, :ref:`Variant` to, :ref:`Variant` weight **)** +:ref:`Variant` **lerp**\ (\ from\: :ref:`Variant`, to\: :ref:`Variant`, weight\: :ref:`Variant`\ ) Linearly interpolates between two values by the factor defined in ``weight``. To perform interpolation, ``weight`` should be between ``0.0`` and ``1.0`` (inclusive). However, values outside this range are allowed and can be used to perform *extrapolation*. If this is not desired, use :ref:`clamp` on the result of this function. @@ -6110,7 +6094,7 @@ See also :ref:`inverse_lerp` which perfo .. rst-class:: classref-method -:ref:`float` **lerp_angle** **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** +:ref:`float` **lerp_angle**\ (\ from\: :ref:`float`, to\: :ref:`float`, weight\: :ref:`float`\ ) Linearly interpolates between two angles (in radians) by a ``weight`` value between 0.0 and 1.0. @@ -6136,7 +6120,7 @@ Similar to :ref:`lerp`, but interpolates correct .. rst-class:: classref-method -:ref:`float` **lerpf** **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** +:ref:`float` **lerpf**\ (\ from\: :ref:`float`, to\: :ref:`float`, weight\: :ref:`float`\ ) Linearly interpolates between two values by the factor defined in ``weight``. To perform interpolation, ``weight`` should be between ``0.0`` and ``1.0`` (inclusive). However, values outside this range are allowed and can be used to perform *extrapolation*. If this is not desired, use :ref:`clampf` on the result of this function. @@ -6154,7 +6138,7 @@ See also :ref:`inverse_lerp` which perfo .. rst-class:: classref-method -:ref:`float` **linear_to_db** **(** :ref:`float` lin **)** +:ref:`float` **linear_to_db**\ (\ lin\: :ref:`float`\ ) Converts from linear energy to decibels (audio). This can be used to implement volume sliders that behave as expected (since volume isn't linear). @@ -6175,7 +6159,7 @@ Converts from linear energy to decibels (audio). This can be used to implement v .. rst-class:: classref-method -:ref:`float` **log** **(** :ref:`float` x **)** +:ref:`float` **log**\ (\ x\: :ref:`float`\ ) Returns the `natural logarithm `__ of ``x`` (base `[i]e[/i] `__, with *e* being approximately 2.71828). This is the amount of time needed to reach a certain level of continuous growth. @@ -6195,7 +6179,7 @@ Returns the `natural logarithm .. rst-class:: classref-method -:ref:`Variant` **max** **(** ... **)** |vararg| +:ref:`Variant` **max**\ (\ ...\ ) |vararg| Returns the maximum of the given numeric values. This function can take any number of arguments. @@ -6211,7 +6195,7 @@ Returns the maximum of the given numeric values. This function can take any numb .. rst-class:: classref-method -:ref:`float` **maxf** **(** :ref:`float` a, :ref:`float` b **)** +:ref:`float` **maxf**\ (\ a\: :ref:`float`, b\: :ref:`float`\ ) Returns the maximum of two :ref:`float` values. @@ -6228,7 +6212,7 @@ Returns the maximum of two :ref:`float` values. .. rst-class:: classref-method -:ref:`int` **maxi** **(** :ref:`int` a, :ref:`int` b **)** +:ref:`int` **maxi**\ (\ a\: :ref:`int`, b\: :ref:`int`\ ) Returns the maximum of two :ref:`int` values. @@ -6245,7 +6229,7 @@ Returns the maximum of two :ref:`int` values. .. rst-class:: classref-method -:ref:`Variant` **min** **(** ... **)** |vararg| +:ref:`Variant` **min**\ (\ ...\ ) |vararg| Returns the minimum of the given numeric values. This function can take any number of arguments. @@ -6261,7 +6245,7 @@ Returns the minimum of the given numeric values. This function can take any numb .. rst-class:: classref-method -:ref:`float` **minf** **(** :ref:`float` a, :ref:`float` b **)** +:ref:`float` **minf**\ (\ a\: :ref:`float`, b\: :ref:`float`\ ) Returns the minimum of two :ref:`float` values. @@ -6278,7 +6262,7 @@ Returns the minimum of two :ref:`float` values. .. rst-class:: classref-method -:ref:`int` **mini** **(** :ref:`int` a, :ref:`int` b **)** +:ref:`int` **mini**\ (\ a\: :ref:`int`, b\: :ref:`int`\ ) Returns the minimum of two :ref:`int` values. @@ -6295,7 +6279,7 @@ Returns the minimum of two :ref:`int` values. .. rst-class:: classref-method -:ref:`float` **move_toward** **(** :ref:`float` from, :ref:`float` to, :ref:`float` delta **)** +:ref:`float` **move_toward**\ (\ from\: :ref:`float`, to\: :ref:`float`, delta\: :ref:`float`\ ) Moves ``from`` toward ``to`` by the ``delta`` amount. Will not go past ``to``. @@ -6316,7 +6300,7 @@ Use a negative ``delta`` value to move away. .. rst-class:: classref-method -:ref:`int` **nearest_po2** **(** :ref:`int` value **)** +:ref:`int` **nearest_po2**\ (\ value\: :ref:`int`\ ) Returns the smallest integer power of 2 that is greater than or equal to ``value``. @@ -6339,7 +6323,7 @@ Returns the smallest integer power of 2 that is greater than or equal to ``value .. rst-class:: classref-method -:ref:`float` **pingpong** **(** :ref:`float` value, :ref:`float` length **)** +:ref:`float` **pingpong**\ (\ value\: :ref:`float`, length\: :ref:`float`\ ) Wraps ``value`` between ``0`` and the ``length``. If the limit is reached, the next value the function returns is decreased to the ``0`` side or increased to the ``length`` side (like a triangle wave). If ``length`` is less than zero, it becomes positive. @@ -6364,7 +6348,7 @@ Wraps ``value`` between ``0`` and the ``length``. If the limit is reached, the n .. rst-class:: classref-method -:ref:`int` **posmod** **(** :ref:`int` x, :ref:`int` y **)** +:ref:`int` **posmod**\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) Returns the integer modulus of ``x`` divided by ``y`` that wraps equally in positive and negative. @@ -6395,7 +6379,7 @@ Produces: .. rst-class:: classref-method -:ref:`float` **pow** **(** :ref:`float` base, :ref:`float` exp **)** +:ref:`float` **pow**\ (\ base\: :ref:`float`, exp\: :ref:`float`\ ) Returns the result of ``base`` raised to the power of ``exp``. @@ -6414,7 +6398,7 @@ In GDScript, this is the equivalent of the ``**`` operator. .. rst-class:: classref-method -void **print** **(** ... **)** |vararg| +|void| **print**\ (\ ...\ ) |vararg| Converts one or more arguments of any type to string in the best way possible and prints them to the console. @@ -6443,7 +6427,7 @@ Converts one or more arguments of any type to string in the best way possible an .. rst-class:: classref-method -void **print_rich** **(** ... **)** |vararg| +|void| **print_rich**\ (\ ...\ ) |vararg| Converts one or more arguments of any type to string in the best way possible and prints them to the console. @@ -6482,7 +6466,7 @@ When printing to standard output, the supported subset of BBCode is converted to .. rst-class:: classref-method -void **print_verbose** **(** ... **)** |vararg| +|void| **print_verbose**\ (\ ...\ ) |vararg| If verbose mode is enabled (:ref:`OS.is_stdout_verbose` returning ``true``), converts one or more arguments of any type to string in the best way possible and prints them to the console. @@ -6494,7 +6478,7 @@ If verbose mode is enabled (:ref:`OS.is_stdout_verbose`, no newline is automatically added at the end. @@ -6550,7 +6534,7 @@ Prints one or more arguments to strings in the best way possible to the OS termi .. rst-class:: classref-method -void **prints** **(** ... **)** |vararg| +|void| **prints**\ (\ ...\ ) |vararg| Prints one or more arguments to the console with a space between each argument. @@ -6575,7 +6559,7 @@ Prints one or more arguments to the console with a space between each argument. .. rst-class:: classref-method -void **printt** **(** ... **)** |vararg| +|void| **printt**\ (\ ...\ ) |vararg| Prints one or more arguments to the console with a tab between each argument. @@ -6600,7 +6584,7 @@ Prints one or more arguments to the console with a tab between each argument. .. rst-class:: classref-method -void **push_error** **(** ... **)** |vararg| +|void| **push_error**\ (\ ...\ ) |vararg| Pushes an error message to Godot's built-in debugger and to the OS terminal. @@ -6627,7 +6611,7 @@ Pushes an error message to Godot's built-in debugger and to the OS terminal. .. rst-class:: classref-method -void **push_warning** **(** ... **)** |vararg| +|void| **push_warning**\ (\ ...\ ) |vararg| Pushes a warning message to Godot's built-in debugger and to the OS terminal. @@ -6652,7 +6636,7 @@ Pushes a warning message to Godot's built-in debugger and to the OS terminal. .. rst-class:: classref-method -:ref:`float` **rad_to_deg** **(** :ref:`float` rad **)** +:ref:`float` **rad_to_deg**\ (\ rad\: :ref:`float`\ ) Converts an angle expressed in radians to degrees. @@ -6670,7 +6654,7 @@ Converts an angle expressed in radians to degrees. .. rst-class:: classref-method -:ref:`PackedInt64Array` **rand_from_seed** **(** :ref:`int` seed **)** +:ref:`PackedInt64Array` **rand_from_seed**\ (\ seed\: :ref:`int`\ ) Given a ``seed``, returns a :ref:`PackedInt64Array` of size ``2``, where its first element is the randomized :ref:`int` value, and the second element is the same as ``seed``. Passing the same ``seed`` consistently returns the same array. @@ -6691,7 +6675,7 @@ Given a ``seed``, returns a :ref:`PackedInt64Array` of s .. rst-class:: classref-method -:ref:`float` **randf** **(** **)** +:ref:`float` **randf**\ (\ ) Returns a random floating point value between ``0.0`` and ``1.0`` (inclusive). @@ -6716,7 +6700,7 @@ Returns a random floating point value between ``0.0`` and ``1.0`` (inclusive). .. rst-class:: classref-method -:ref:`float` **randf_range** **(** :ref:`float` from, :ref:`float` to **)** +:ref:`float` **randf_range**\ (\ from\: :ref:`float`, to\: :ref:`float`\ ) Returns a random floating point value between ``from`` and ``to`` (inclusive). @@ -6743,7 +6727,7 @@ Returns a random floating point value between ``from`` and ``to`` (inclusive). .. rst-class:: classref-method -:ref:`float` **randfn** **(** :ref:`float` mean, :ref:`float` deviation **)** +:ref:`float` **randfn**\ (\ mean\: :ref:`float`, deviation\: :ref:`float`\ ) Returns a normally-distributed pseudo-random floating point value using Box-Muller transform with the specified ``mean`` and a standard ``deviation``. This is also called Gaussian distribution. @@ -6755,7 +6739,7 @@ Returns a normally-distributed pseudo-random floating point value using Box-Mull .. rst-class:: classref-method -:ref:`int` **randi** **(** **)** +:ref:`int` **randi**\ (\ ) Returns a random unsigned 32-bit integer. Use remainder to obtain a random value in the interval ``[0, N - 1]`` (where N is smaller than 2^32). @@ -6786,7 +6770,7 @@ Returns a random unsigned 32-bit integer. Use remainder to obtain a random value .. rst-class:: classref-method -:ref:`int` **randi_range** **(** :ref:`int` from, :ref:`int` to **)** +:ref:`int` **randi_range**\ (\ from\: :ref:`int`, to\: :ref:`int`\ ) Returns a random signed 32-bit integer between ``from`` and ``to`` (inclusive). If ``to`` is lesser than ``from``, they are swapped. @@ -6813,7 +6797,7 @@ Returns a random signed 32-bit integer between ``from`` and ``to`` (inclusive). .. rst-class:: classref-method -void **randomize** **(** **)** +|void| **randomize**\ (\ ) Randomizes the seed (or the internal state) of the random number generator. The current implementation uses a number based on the device's time. @@ -6827,7 +6811,7 @@ Randomizes the seed (or the internal state) of the random number generator. The .. rst-class:: classref-method -:ref:`float` **remap** **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** +:ref:`float` **remap**\ (\ value\: :ref:`float`, istart\: :ref:`float`, istop\: :ref:`float`, ostart\: :ref:`float`, ostop\: :ref:`float`\ ) Maps a ``value`` from range ``[istart, istop]`` to ``[ostart, ostop]``. See also :ref:`lerp` and :ref:`inverse_lerp`. If ``value`` is outside ``[istart, istop]``, then the resulting value will also be outside ``[ostart, ostop]``. If this is not desired, use :ref:`clamp` on the result of this function. @@ -6845,7 +6829,7 @@ For complex use cases where multiple ranges are needed, consider using :ref:`Cur .. rst-class:: classref-method -:ref:`int` **rid_allocate_id** **(** **)** +:ref:`int` **rid_allocate_id**\ (\ ) Allocates a unique ID which can be used by the implementation to construct a RID. This is used mainly from native extensions to implement servers. @@ -6857,7 +6841,7 @@ Allocates a unique ID which can be used by the implementation to construct a RID .. rst-class:: classref-method -:ref:`RID` **rid_from_int64** **(** :ref:`int` base **)** +:ref:`RID` **rid_from_int64**\ (\ base\: :ref:`int`\ ) Creates a RID from a ``base``. This is used mainly from native extensions to build servers. @@ -6869,7 +6853,7 @@ Creates a RID from a ``base``. This is used mainly from native extensions to bui .. rst-class:: classref-method -:ref:`float` **rotate_toward** **(** :ref:`float` from, :ref:`float` to, :ref:`float` delta **)** +:ref:`float` **rotate_toward**\ (\ from\: :ref:`float`, to\: :ref:`float`, delta\: :ref:`float`\ ) Rotates ``from`` toward ``to`` by the ``delta`` amount. Will not go past ``to``. @@ -6885,7 +6869,7 @@ If ``delta`` is negative, this function will rotate away from ``to``, toward the .. rst-class:: classref-method -:ref:`Variant` **round** **(** :ref:`Variant` x **)** +:ref:`Variant` **round**\ (\ x\: :ref:`Variant`\ ) Rounds ``x`` to the nearest whole number, with halfway cases rounded away from 0. Supported types: :ref:`int`, :ref:`float`, :ref:`Vector2`, :ref:`Vector2i`, :ref:`Vector3`, :ref:`Vector3i`, :ref:`Vector4`, :ref:`Vector4i`. @@ -6907,7 +6891,7 @@ See also :ref:`floor`, :ref:`ceil` **roundf** **(** :ref:`float` x **)** +:ref:`float` **roundf**\ (\ x\: :ref:`float`\ ) Rounds ``x`` to the nearest whole number, with halfway cases rounded away from 0. @@ -6921,7 +6905,7 @@ A type-safe version of :ref:`round`, returning .. rst-class:: classref-method -:ref:`int` **roundi** **(** :ref:`float` x **)** +:ref:`int` **roundi**\ (\ x\: :ref:`float`\ ) Rounds ``x`` to the nearest whole number, with halfway cases rounded away from 0. @@ -6935,7 +6919,7 @@ A type-safe version of :ref:`round`, returning .. rst-class:: classref-method -void **seed** **(** :ref:`int` base **)** +|void| **seed**\ (\ base\: :ref:`int`\ ) Sets the seed for the random number generator to ``base``. Setting the seed manually can ensure consistent, repeatable results for most random functions. @@ -6970,7 +6954,7 @@ Sets the seed for the random number generator to ``base``. Setting the seed manu .. rst-class:: classref-method -:ref:`Variant` **sign** **(** :ref:`Variant` x **)** +:ref:`Variant` **sign**\ (\ x\: :ref:`Variant`\ ) Returns the same type of :ref:`Variant` as ``x``, with ``-1`` for negative values, ``1`` for positive values, and ``0`` for zeros. For ``nan`` values it returns 0. @@ -6995,7 +6979,7 @@ Supported types: :ref:`int`, :ref:`float`, :ref:`Vector2 .. rst-class:: classref-method -:ref:`float` **signf** **(** :ref:`float` x **)** +:ref:`float` **signf**\ (\ x\: :ref:`float`\ ) Returns ``-1.0`` if ``x`` is negative, ``1.0`` if ``x`` is positive, and ``0.0`` if ``x`` is zero. For ``nan`` values of ``x`` it returns 0.0. @@ -7014,7 +6998,7 @@ Returns ``-1.0`` if ``x`` is negative, ``1.0`` if ``x`` is positive, and ``0.0`` .. rst-class:: classref-method -:ref:`int` **signi** **(** :ref:`int` x **)** +:ref:`int` **signi**\ (\ x\: :ref:`int`\ ) Returns ``-1`` if ``x`` is negative, ``1`` if ``x`` is positive, and ``0`` if if ``x`` is zero. @@ -7032,7 +7016,7 @@ Returns ``-1`` if ``x`` is negative, ``1`` if ``x`` is positive, and ``0`` if if .. rst-class:: classref-method -:ref:`float` **sin** **(** :ref:`float` angle_rad **)** +:ref:`float` **sin**\ (\ angle_rad\: :ref:`float`\ ) Returns the sine of angle ``angle_rad`` in radians. @@ -7049,7 +7033,7 @@ Returns the sine of angle ``angle_rad`` in radians. .. rst-class:: classref-method -:ref:`float` **sinh** **(** :ref:`float` x **)** +:ref:`float` **sinh**\ (\ x\: :ref:`float`\ ) Returns the hyperbolic sine of ``x``. @@ -7066,7 +7050,7 @@ Returns the hyperbolic sine of ``x``. .. rst-class:: classref-method -:ref:`float` **smoothstep** **(** :ref:`float` from, :ref:`float` to, :ref:`float` x **)** +:ref:`float` **smoothstep**\ (\ from\: :ref:`float`, to\: :ref:`float`, x\: :ref:`float`\ ) Returns the result of smoothly interpolating the value of ``x`` between ``0`` and ``1``, based on the where ``x`` lies with respect to the edges ``from`` and ``to``. @@ -7093,7 +7077,7 @@ Compared to :ref:`ease` with a curve value of `` .. rst-class:: classref-method -:ref:`Variant` **snapped** **(** :ref:`Variant` x, :ref:`Variant` step **)** +:ref:`Variant` **snapped**\ (\ x\: :ref:`Variant`, step\: :ref:`Variant`\ ) Returns the multiple of ``step`` that is the closest to ``x``. This can also be used to round a floating point number to an arbitrary number of decimals. @@ -7118,7 +7102,7 @@ See also :ref:`ceil`, :ref:`floor` **snappedf** **(** :ref:`float` x, :ref:`float` step **)** +:ref:`float` **snappedf**\ (\ x\: :ref:`float`, step\: :ref:`float`\ ) Returns the multiple of ``step`` that is the closest to ``x``. This can also be used to round a floating point number to an arbitrary number of decimals. @@ -7137,7 +7121,7 @@ A type-safe version of :ref:`snapped`, return .. rst-class:: classref-method -:ref:`int` **snappedi** **(** :ref:`float` x, :ref:`int` step **)** +:ref:`int` **snappedi**\ (\ x\: :ref:`float`, step\: :ref:`int`\ ) Returns the multiple of ``step`` that is the closest to ``x``. @@ -7156,7 +7140,7 @@ A type-safe version of :ref:`snapped`, return .. rst-class:: classref-method -:ref:`float` **sqrt** **(** :ref:`float` x **)** +:ref:`float` **sqrt**\ (\ x\: :ref:`float`\ ) Returns the square root of ``x``, where ``x`` is a non-negative number. @@ -7176,7 +7160,7 @@ Returns the square root of ``x``, where ``x`` is a non-negative number. .. rst-class:: classref-method -:ref:`int` **step_decimals** **(** :ref:`float` x **)** +:ref:`int` **step_decimals**\ (\ x\: :ref:`float`\ ) Returns the position of the first non-zero digit, after the decimal point. Note that the maximum return value is 10, which is a design decision in the implementation. @@ -7194,7 +7178,7 @@ Returns the position of the first non-zero digit, after the decimal point. Note .. rst-class:: classref-method -:ref:`String` **str** **(** ... **)** |vararg| +:ref:`String` **str**\ (\ ...\ ) |vararg| Converts one or more arguments of any :ref:`Variant` type to a :ref:`String` in the best way possible. @@ -7213,7 +7197,7 @@ Converts one or more arguments of any :ref:`Variant` type to a :r .. rst-class:: classref-method -:ref:`Variant` **str_to_var** **(** :ref:`String` string **)** +:ref:`Variant` **str_to_var**\ (\ string\: :ref:`String`\ ) Converts a formatted ``string`` that was returned by :ref:`var_to_str` to the original :ref:`Variant`. @@ -7242,7 +7226,7 @@ Converts a formatted ``string`` that was returned by :ref:`var_to_str` **tan** **(** :ref:`float` angle_rad **)** +:ref:`float` **tan**\ (\ angle_rad\: :ref:`float`\ ) Returns the tangent of angle ``angle_rad`` in radians. @@ -7258,7 +7242,7 @@ Returns the tangent of angle ``angle_rad`` in radians. .. rst-class:: classref-method -:ref:`float` **tanh** **(** :ref:`float` x **)** +:ref:`float` **tanh**\ (\ x\: :ref:`float`\ ) Returns the hyperbolic tangent of ``x``. @@ -7275,7 +7259,7 @@ Returns the hyperbolic tangent of ``x``. .. rst-class:: classref-method -:ref:`Variant` **type_convert** **(** :ref:`Variant` variant, :ref:`int` type **)** +:ref:`Variant` **type_convert**\ (\ variant\: :ref:`Variant`, type\: :ref:`int`\ ) Converts the given ``variant`` to the given ``type``, using the :ref:`Variant.Type` values. This method is generous with how it handles types, it can automatically convert between array types, convert numeric :ref:`String`\ s to :ref:`int`, and converting most things to :ref:`String`. @@ -7299,7 +7283,7 @@ The returned value is a :ref:`Variant`, but the data inside and i .. rst-class:: classref-method -:ref:`String` **type_string** **(** :ref:`int` type **)** +:ref:`String` **type_string**\ (\ type\: :ref:`int`\ ) Returns a human-readable name of the given ``type``, using the :ref:`Variant.Type` values. @@ -7319,7 +7303,7 @@ See also :ref:`typeof`. .. rst-class:: classref-method -:ref:`int` **typeof** **(** :ref:`Variant` variable **)** +:ref:`int` **typeof**\ (\ variable\: :ref:`Variant`\ ) Returns the internal type of the given ``variable``, using the :ref:`Variant.Type` values. @@ -7343,7 +7327,7 @@ See also :ref:`type_string`. .. rst-class:: classref-method -:ref:`PackedByteArray` **var_to_bytes** **(** :ref:`Variant` variable **)** +:ref:`PackedByteArray` **var_to_bytes**\ (\ variable\: :ref:`Variant`\ ) Encodes a :ref:`Variant` value to a byte array, without encoding objects. Deserialization can be done with :ref:`bytes_to_var`. @@ -7359,7 +7343,7 @@ Encodes a :ref:`Variant` value to a byte array, without encoding .. rst-class:: classref-method -:ref:`PackedByteArray` **var_to_bytes_with_objects** **(** :ref:`Variant` variable **)** +:ref:`PackedByteArray` **var_to_bytes_with_objects**\ (\ variable\: :ref:`Variant`\ ) 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`. @@ -7373,7 +7357,7 @@ Encodes a :ref:`Variant` value to a byte array. Encoding objects .. rst-class:: classref-method -:ref:`String` **var_to_str** **(** :ref:`Variant` variable **)** +:ref:`String` **var_to_str**\ (\ variable\: :ref:`Variant`\ ) Converts a :ref:`Variant` ``variable`` to a formatted :ref:`String` that can then be parsed using :ref:`str_to_var`. @@ -7411,7 +7395,7 @@ Prints: .. rst-class:: classref-method -:ref:`Variant` **weakref** **(** :ref:`Variant` obj **)** +:ref:`Variant` **weakref**\ (\ obj\: :ref:`Variant`\ ) Returns a :ref:`WeakRef` instance holding a weak reference to ``obj``. Returns an empty :ref:`WeakRef` instance if ``obj`` is ``null``. Prints an error and returns ``null`` if ``obj`` is neither :ref:`Object`-derived nor ``null``. @@ -7425,7 +7409,7 @@ A weak reference to an object is not enough to keep the object alive: when the o .. rst-class:: classref-method -:ref:`Variant` **wrap** **(** :ref:`Variant` value, :ref:`Variant` min, :ref:`Variant` max **)** +:ref:`Variant` **wrap**\ (\ value\: :ref:`Variant`, min\: :ref:`Variant`, max\: :ref:`Variant`\ ) Wraps the :ref:`Variant` ``value`` between ``min`` and ``max``. Can be used for creating loop-alike behavior or infinite surfaces. @@ -7450,7 +7434,7 @@ Variant types :ref:`int` and :ref:`float` are supported. .. rst-class:: classref-method -:ref:`float` **wrapf** **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** +:ref:`float` **wrapf**\ (\ value\: :ref:`float`, min\: :ref:`float`, max\: :ref:`float`\ ) Wraps the float ``value`` between ``min`` and ``max``. Can be used for creating loop-alike behavior or infinite surfaces. @@ -7481,7 +7465,7 @@ Wraps the float ``value`` between ``min`` and ``max``. Can be used for creating .. rst-class:: classref-method -:ref:`int` **wrapi** **(** :ref:`int` value, :ref:`int` min, :ref:`int` max **)** +:ref:`int` **wrapi**\ (\ value\: :ref:`int`, min\: :ref:`int`, max\: :ref:`int`\ ) Wraps the integer ``value`` between ``min`` and ``max``. Can be used for creating loop-alike behavior or infinite surfaces. @@ -7502,3 +7486,4 @@ Wraps the integer ``value`` between ``min`` and ``max``. Can be used for creatin .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index cdca47511ea..804c80004c8 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -64,13 +64,13 @@ Constructors .. table:: :widths: auto - +-------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`AABB` **(** **)** | - +-------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`AABB` **(** :ref:`AABB` from **)** | - +-------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`AABB` **(** :ref:`Vector3` position, :ref:`Vector3` size **)** | - +-------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`AABB`\ (\ ) | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`AABB`\ (\ from\: :ref:`AABB`\ ) | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`AABB`\ (\ position\: :ref:`Vector3`, size\: :ref:`Vector3`\ ) | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -80,57 +80,57 @@ Methods .. table:: :widths: auto - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`abs` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`encloses` **(** :ref:`AABB` with **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`expand` **(** :ref:`Vector3` to_point **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_center` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_endpoint` **(** :ref:`int` idx **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_longest_axis` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_longest_axis_index` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_longest_axis_size` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_shortest_axis` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_shortest_axis_index` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_shortest_axis_size` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_support` **(** :ref:`Vector3` dir **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_volume` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`grow` **(** :ref:`float` by **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_surface` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_volume` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`intersection` **(** :ref:`AABB` with **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`intersects` **(** :ref:`AABB` with **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`intersects_plane` **(** :ref:`Plane` plane **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`intersects_ray` **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`intersects_segment` **(** :ref:`Vector3` from, :ref:`Vector3` to **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`AABB` aabb **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_finite` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`merge` **(** :ref:`AABB` with **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`abs`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`encloses`\ (\ with\: :ref:`AABB`\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`expand`\ (\ to_point\: :ref:`Vector3`\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_center`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_endpoint`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_longest_axis`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_longest_axis_index`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_longest_axis_size`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_shortest_axis`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_shortest_axis_index`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_shortest_axis_size`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_support`\ (\ dir\: :ref:`Vector3`\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_volume`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`grow`\ (\ by\: :ref:`float`\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_point`\ (\ point\: :ref:`Vector3`\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_surface`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_volume`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`intersection`\ (\ with\: :ref:`AABB`\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`intersects`\ (\ with\: :ref:`AABB`\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`intersects_plane`\ (\ plane\: :ref:`Plane`\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`intersects_ray`\ (\ from\: :ref:`Vector3`, dir\: :ref:`Vector3`\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`intersects_segment`\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equal_approx`\ (\ aabb\: :ref:`AABB`\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`merge`\ (\ with\: :ref:`AABB`\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -140,13 +140,13 @@ Operators .. table:: :widths: auto - +-------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`AABB` right **)** | - +-------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`operator *` **(** :ref:`Transform3D` right **)** | - +-------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`AABB` right **)** | - +-------------------------+----------------------------------------------------------------------------------------------------------------+ + +-------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`AABB`\ ) | + +-------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`operator *`\ (\ right\: :ref:`Transform3D`\ ) | + +-------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`AABB`\ ) | + +-------------------------+-------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -204,7 +204,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`AABB` **AABB** **(** **)** +:ref:`AABB` **AABB**\ (\ ) Constructs an **AABB** with its :ref:`position` and :ref:`size` set to :ref:`Vector3.ZERO`. @@ -214,7 +214,7 @@ Constructs an **AABB** with its :ref:`position` an .. rst-class:: classref-constructor -:ref:`AABB` **AABB** **(** :ref:`AABB` from **)** +:ref:`AABB` **AABB**\ (\ from\: :ref:`AABB`\ ) Constructs an **AABB** as a copy of the given **AABB**. @@ -224,7 +224,7 @@ Constructs an **AABB** as a copy of the given **AABB**. .. rst-class:: classref-constructor -:ref:`AABB` **AABB** **(** :ref:`Vector3` position, :ref:`Vector3` size **)** +:ref:`AABB` **AABB**\ (\ position\: :ref:`Vector3`, size\: :ref:`Vector3`\ ) Constructs an **AABB** by ``position`` and ``size``. @@ -241,7 +241,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AABB` **abs** **(** **)** |const| +:ref:`AABB` **abs**\ (\ ) |const| Returns an **AABB** equivalent to this bounding box, with its width, height, and depth modified to be non-negative values. @@ -274,7 +274,7 @@ Returns an **AABB** equivalent to this bounding box, with its width, height, and .. rst-class:: classref-method -:ref:`bool` **encloses** **(** :ref:`AABB` with **)** |const| +:ref:`bool` **encloses**\ (\ with\: :ref:`AABB`\ ) |const| Returns ``true`` if this bounding box *completely* encloses the ``with`` box. The edges of both boxes are included. @@ -311,7 +311,7 @@ Returns ``true`` if this bounding box *completely* encloses the ``with`` box. Th .. rst-class:: classref-method -:ref:`AABB` **expand** **(** :ref:`Vector3` to_point **)** |const| +:ref:`AABB` **expand**\ (\ to_point\: :ref:`Vector3`\ ) |const| Returns a copy of this bounding box expanded to align the edges with the given ``to_point``, if necessary. @@ -352,7 +352,7 @@ Returns a copy of this bounding box expanded to align the edges with the given ` .. rst-class:: classref-method -:ref:`Vector3` **get_center** **(** **)** |const| +:ref:`Vector3` **get_center**\ (\ ) |const| Returns the center point of the bounding box. This is the same as ``position + (size / 2.0)``. @@ -364,7 +364,7 @@ Returns the center point of the bounding box. This is the same as ``position + ( .. rst-class:: classref-method -:ref:`Vector3` **get_endpoint** **(** :ref:`int` idx **)** |const| +:ref:`Vector3` **get_endpoint**\ (\ idx\: :ref:`int`\ ) |const| 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`. @@ -376,7 +376,7 @@ Returns the position of one of the 8 vertices that compose this bounding box. Wi .. rst-class:: classref-method -:ref:`Vector3` **get_longest_axis** **(** **)** |const| +:ref:`Vector3` **get_longest_axis**\ (\ ) |const| 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`). @@ -411,7 +411,7 @@ See also :ref:`get_longest_axis_index` .. rst-class:: classref-method -:ref:`int` **get_longest_axis_index** **(** **)** |const| +:ref:`int` **get_longest_axis_index**\ (\ ) |const| 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`). @@ -425,7 +425,7 @@ For an example, see :ref:`get_longest_axis`. .. rst-class:: classref-method -:ref:`float` **get_longest_axis_size** **(** **)** |const| +:ref:`float` **get_longest_axis_size**\ (\ ) |const| Returns the longest dimension of this bounding box's :ref:`size`. @@ -439,7 +439,7 @@ For an example, see :ref:`get_longest_axis`. .. rst-class:: classref-method -:ref:`Vector3` **get_shortest_axis** **(** **)** |const| +:ref:`Vector3` **get_shortest_axis**\ (\ ) |const| 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`). @@ -474,7 +474,7 @@ See also :ref:`get_shortest_axis_index` **get_shortest_axis_index** **(** **)** |const| +:ref:`int` **get_shortest_axis_index**\ (\ ) |const| 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`). @@ -488,7 +488,7 @@ For an example, see :ref:`get_shortest_axis .. rst-class:: classref-method -:ref:`float` **get_shortest_axis_size** **(** **)** |const| +:ref:`float` **get_shortest_axis_size**\ (\ ) |const| Returns the shortest dimension of this bounding box's :ref:`size`. @@ -502,7 +502,7 @@ For an example, see :ref:`get_shortest_axis .. rst-class:: classref-method -:ref:`Vector3` **get_support** **(** :ref:`Vector3` dir **)** |const| +:ref:`Vector3` **get_support**\ (\ dir\: :ref:`Vector3`\ ) |const| 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. @@ -514,7 +514,7 @@ Returns the vertex's position of this bounding box that's the farthest in the gi .. rst-class:: classref-method -:ref:`float` **get_volume** **(** **)** |const| +:ref:`float` **get_volume**\ (\ ) |const| Returns the bounding box's volume. This is equivalent to ``size.x * size.y * size.z``. See also :ref:`has_volume`. @@ -526,7 +526,7 @@ Returns the bounding box's volume. This is equivalent to ``size.x * size.y * siz .. rst-class:: classref-method -:ref:`AABB` **grow** **(** :ref:`float` by **)** |const| +:ref:`AABB` **grow**\ (\ by\: :ref:`float`\ ) |const| Returns a copy of this bounding box extended on all sides by the given amount ``by``. A negative amount shrinks the box instead. @@ -563,7 +563,7 @@ Returns a copy of this bounding box extended on all sides by the given amount `` .. rst-class:: classref-method -:ref:`bool` **has_point** **(** :ref:`Vector3` point **)** |const| +:ref:`bool` **has_point**\ (\ point\: :ref:`Vector3`\ ) |const| Returns ``true`` if the bounding box contains the given ``point``. By convention, points exactly on the right, top, and front sides are **not** included. @@ -577,7 +577,7 @@ Returns ``true`` if the bounding box contains the given ``point``. By convention .. rst-class:: classref-method -:ref:`bool` **has_surface** **(** **)** |const| +:ref:`bool` **has_surface**\ (\ ) |const| 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``. @@ -589,7 +589,7 @@ Returns ``true`` if this bounding box has a surface or a length, that is, at lea .. rst-class:: classref-method -:ref:`bool` **has_volume** **(** **)** |const| +:ref:`bool` **has_volume**\ (\ ) |const| Returns ``true`` if this bounding box's width, height, and depth are all positive. See also :ref:`get_volume`. @@ -601,7 +601,7 @@ Returns ``true`` if this bounding box's width, height, and depth are all positiv .. rst-class:: classref-method -:ref:`AABB` **intersection** **(** :ref:`AABB` with **)** |const| +:ref:`AABB` **intersection**\ (\ with\: :ref:`AABB`\ ) |const| 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`). @@ -638,7 +638,7 @@ Returns the intersection between this bounding box and ``with``. If the boxes do .. rst-class:: classref-method -:ref:`bool` **intersects** **(** :ref:`AABB` with **)** |const| +:ref:`bool` **intersects**\ (\ with\: :ref:`AABB`\ ) |const| Returns ``true`` if this bounding box overlaps with the box ``with``. The edges of both boxes are *always* excluded. @@ -650,7 +650,7 @@ Returns ``true`` if this bounding box overlaps with the box ``with``. The edges .. rst-class:: classref-method -:ref:`bool` **intersects_plane** **(** :ref:`Plane` plane **)** |const| +:ref:`bool` **intersects_plane**\ (\ plane\: :ref:`Plane`\ ) |const| Returns ``true`` if this bounding box is on both sides of the given ``plane``. @@ -662,7 +662,7 @@ Returns ``true`` if this bounding box is on both sides of the given ``plane``. .. rst-class:: classref-method -:ref:`Variant` **intersects_ray** **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** |const| +:ref:`Variant` **intersects_ray**\ (\ from\: :ref:`Vector3`, dir\: :ref:`Vector3`\ ) |const| Returns the first point where this bounding box and the given ray intersect, as a :ref:`Vector3`. If no intersection occurs, returns ``null``. @@ -676,7 +676,7 @@ The ray begin at ``from``, faces ``dir`` and extends towards infinity. .. rst-class:: classref-method -:ref:`Variant` **intersects_segment** **(** :ref:`Vector3` from, :ref:`Vector3` to **)** |const| +:ref:`Variant` **intersects_segment**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`\ ) |const| Returns the first point where this bounding box and the given segment intersect, as a :ref:`Vector3`. If no intersection occurs, returns ``null``. @@ -690,7 +690,7 @@ The segment begins at ``from`` and ends at ``to``. .. rst-class:: classref-method -:ref:`bool` **is_equal_approx** **(** :ref:`AABB` aabb **)** |const| +:ref:`bool` **is_equal_approx**\ (\ aabb\: :ref:`AABB`\ ) |const| 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`. @@ -702,7 +702,7 @@ Returns ``true`` if this bounding box and ``aabb`` are approximately equal, by c .. rst-class:: classref-method -:ref:`bool` **is_finite** **(** **)** |const| +:ref:`bool` **is_finite**\ (\ ) |const| Returns ``true`` if this bounding box's values are finite, by calling :ref:`Vector2.is_finite` on the :ref:`position` and the :ref:`size`. @@ -714,7 +714,7 @@ Returns ``true`` if this bounding box's values are finite, by calling :ref:`Vect .. rst-class:: classref-method -:ref:`AABB` **merge** **(** :ref:`AABB` with **)** |const| +:ref:`AABB` **merge**\ (\ with\: :ref:`AABB`\ ) |const| Returns an **AABB** that encloses both this bounding box and ``with`` around the edges. See also :ref:`encloses`. @@ -731,7 +731,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`AABB` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`AABB`\ ) Returns ``true`` if the :ref:`position` or :ref:`size` of both bounding boxes are not equal. @@ -745,7 +745,7 @@ Returns ``true`` if the :ref:`position` or :ref:`s .. rst-class:: classref-operator -:ref:`AABB` **operator *** **(** :ref:`Transform3D` right **)** +:ref:`AABB` **operator ***\ (\ right\: :ref:`Transform3D`\ ) Inversely transforms (multiplies) the **AABB** by the given :ref:`Transform3D` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). @@ -761,7 +761,7 @@ For transforming by inverse of an affine transformation (e.g. with scaling) ``tr .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`AABB` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`AABB`\ ) Returns ``true`` if both :ref:`position` and :ref:`size` of the bounding boxes are exactly equal, respectively. @@ -774,3 +774,4 @@ Returns ``true`` if both :ref:`position` and :ref: .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 66ff89f9613..a3c3bf190af 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -63,19 +63,19 @@ Methods .. table:: :widths: auto - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Button` | :ref:`add_button` **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Button` | :ref:`add_cancel_button` **(** :ref:`String` name **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Label` | :ref:`get_label` **(** **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Button` | :ref:`get_ok_button` **(** **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`register_text_enter` **(** :ref:`Control` line_edit **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_button` **(** :ref:`Control` button **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Button` | :ref:`add_button`\ (\ text\: :ref:`String`, right\: :ref:`bool` = false, action\: :ref:`String` = ""\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Button` | :ref:`add_cancel_button`\ (\ name\: :ref:`String`\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Label` | :ref:`get_label`\ (\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Button` | :ref:`get_ok_button`\ (\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_text_enter`\ (\ line_edit\: :ref:`Control`\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_button`\ (\ button\: :ref:`Control`\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -104,7 +104,7 @@ Signals .. rst-class:: classref-signal -**canceled** **(** **)** +**canceled**\ (\ ) Emitted when the dialog is closed or the button created with :ref:`add_cancel_button` is pressed. @@ -116,7 +116,7 @@ Emitted when the dialog is closed or the button created with :ref:`add_cancel_bu .. rst-class:: classref-signal -**confirmed** **(** **)** +**confirmed**\ (\ ) Emitted when the dialog is accepted, i.e. the OK button is pressed. @@ -128,7 +128,7 @@ Emitted when the dialog is accepted, i.e. the OK button is pressed. .. rst-class:: classref-signal -**custom_action** **(** :ref:`StringName` action **)** +**custom_action**\ (\ action\: :ref:`StringName`\ ) Emitted when a custom button is pressed. See :ref:`add_button`. @@ -149,8 +149,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_autowrap** **(** :ref:`bool` value **)** -- :ref:`bool` **has_autowrap** **(** **)** +- |void| **set_autowrap**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **has_autowrap**\ (\ ) Sets autowrapping for the text in the dialog. @@ -166,8 +166,8 @@ Sets autowrapping for the text in the dialog. .. rst-class:: classref-property-setget -- void **set_close_on_escape** **(** :ref:`bool` value **)** -- :ref:`bool` **get_close_on_escape** **(** **)** +- |void| **set_close_on_escape**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_close_on_escape**\ (\ ) If ``true``, the dialog will be hidden when the escape key (:ref:`@GlobalScope.KEY_ESCAPE`) is pressed. @@ -183,8 +183,8 @@ If ``true``, the dialog will be hidden when the escape key (:ref:`@GlobalScope.K .. rst-class:: classref-property-setget -- void **set_hide_on_ok** **(** :ref:`bool` value **)** -- :ref:`bool` **get_hide_on_ok** **(** **)** +- |void| **set_hide_on_ok**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_hide_on_ok**\ (\ ) If ``true``, the dialog is hidden when the OK button is pressed. You can set it to ``false`` if you want to do e.g. input validation when receiving the :ref:`confirmed` signal, and handle hiding the dialog in your own logic. @@ -202,8 +202,8 @@ If ``true``, the dialog is hidden when the OK button is pressed. You can set it .. rst-class:: classref-property-setget -- void **set_text** **(** :ref:`String` value **)** -- :ref:`String` **get_text** **(** **)** +- |void| **set_text**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_text**\ (\ ) The text displayed by the dialog. @@ -219,8 +219,8 @@ The text displayed by the dialog. .. rst-class:: classref-property-setget -- void **set_ok_button_text** **(** :ref:`String` value **)** -- :ref:`String` **get_ok_button_text** **(** **)** +- |void| **set_ok_button_text**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_ok_button_text**\ (\ ) The text displayed by the OK button (see :ref:`get_ok_button`). @@ -237,7 +237,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Button` **add_button** **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** +:ref:`Button` **add_button**\ (\ text\: :ref:`String`, right\: :ref:`bool` = false, action\: :ref:`String` = ""\ ) Adds a button with label ``text`` and a custom ``action`` to the dialog and returns the created button. ``action`` will be passed to the :ref:`custom_action` signal when pressed. @@ -253,7 +253,7 @@ You can use :ref:`remove_button` method .. rst-class:: classref-method -:ref:`Button` **add_cancel_button** **(** :ref:`String` name **)** +:ref:`Button` **add_cancel_button**\ (\ name\: :ref:`String`\ ) Adds a button with label ``name`` and a cancel action to the dialog and returns the created button. @@ -267,7 +267,7 @@ You can use :ref:`remove_button` method .. rst-class:: classref-method -:ref:`Label` **get_label** **(** **)** +:ref:`Label` **get_label**\ (\ ) Returns the label used for built-in text. @@ -281,7 +281,7 @@ Returns the label used for built-in text. .. rst-class:: classref-method -:ref:`Button` **get_ok_button** **(** **)** +:ref:`Button` **get_ok_button**\ (\ ) Returns the OK :ref:`Button` instance. @@ -295,7 +295,7 @@ Returns the OK :ref:`Button` instance. .. rst-class:: classref-method -void **register_text_enter** **(** :ref:`Control` line_edit **)** +|void| **register_text_enter**\ (\ line_edit\: :ref:`Control`\ ) Registers a :ref:`LineEdit` in the dialog. When the enter key is pressed, the dialog will be accepted. @@ -307,7 +307,7 @@ Registers a :ref:`LineEdit` in the dialog. When the enter key is .. rst-class:: classref-method -void **remove_button** **(** :ref:`Control` button **)** +|void| **remove_button**\ (\ button\: :ref:`Control`\ ) Removes the ``button`` from the dialog. Does NOT free the ``button``. The ``button`` must be a :ref:`Button` added with :ref:`add_button` or :ref:`add_cancel_button` method. After removal, pressing the ``button`` will no longer emit this dialog's :ref:`custom_action` or :ref:`canceled` signals. @@ -347,3 +347,4 @@ The panel that fills the background of the window. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_aescontext.rst b/classes/class_aescontext.rst index b28ed7eddae..d5c0a64d5ee 100644 --- a/classes/class_aescontext.rst +++ b/classes/class_aescontext.rst @@ -104,15 +104,15 @@ Methods .. table:: :widths: auto - +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`finish` **(** **)** | - +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`get_iv_state` **(** **)** | - +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`start` **(** :ref:`Mode` mode, :ref:`PackedByteArray` key, :ref:`PackedByteArray` iv=PackedByteArray() **)** | - +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`update` **(** :ref:`PackedByteArray` src **)** | - +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`finish`\ (\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`get_iv_state`\ (\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`start`\ (\ mode\: :ref:`Mode`, key\: :ref:`PackedByteArray`, iv\: :ref:`PackedByteArray` = PackedByteArray()\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`update`\ (\ src\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -182,7 +182,7 @@ Method Descriptions .. rst-class:: classref-method -void **finish** **(** **)** +|void| **finish**\ (\ ) Close this AES context so it can be started again. See :ref:`start`. @@ -194,7 +194,7 @@ Close this AES context so it can be started again. See :ref:`start` **get_iv_state** **(** **)** +:ref:`PackedByteArray` **get_iv_state**\ (\ ) Get the current IV state for this context (IV gets updated when calling :ref:`update`). You normally don't need this function. @@ -208,7 +208,7 @@ Get the current IV state for this context (IV gets updated when calling :ref:`up .. rst-class:: classref-method -:ref:`Error` **start** **(** :ref:`Mode` mode, :ref:`PackedByteArray` key, :ref:`PackedByteArray` iv=PackedByteArray() **)** +:ref:`Error` **start**\ (\ mode\: :ref:`Mode`, key\: :ref:`PackedByteArray`, iv\: :ref:`PackedByteArray` = PackedByteArray()\ ) Start the AES context in the given ``mode``. A ``key`` of either 16 or 32 bytes must always be provided, while an ``iv`` (initialization vector) of exactly 16 bytes, is only needed when ``mode`` is either :ref:`MODE_CBC_ENCRYPT` or :ref:`MODE_CBC_DECRYPT`. @@ -220,7 +220,7 @@ Start the AES context in the given ``mode``. A ``key`` of either 16 or 32 bytes .. rst-class:: classref-method -:ref:`PackedByteArray` **update** **(** :ref:`PackedByteArray` src **)** +:ref:`PackedByteArray` **update**\ (\ src\: :ref:`PackedByteArray`\ ) Run the desired operation for this AES context. Will return a :ref:`PackedByteArray` containing the result of encrypting (or decrypting) the given ``src``. See :ref:`start` for mode of operation. @@ -233,3 +233,4 @@ Run the desired operation for this AES context. Will return a :ref:`PackedByteAr .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animatablebody2d.rst b/classes/class_animatablebody2d.rst index 4faf8ddb257..91ff2f98c28 100644 --- a/classes/class_animatablebody2d.rst +++ b/classes/class_animatablebody2d.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_sync_to_physics** **(** :ref:`bool` value **)** -- :ref:`bool` **is_sync_to_physics_enabled** **(** **)** +- |void| **set_sync_to_physics**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_sync_to_physics_enabled**\ (\ ) If ``true``, the body's movement will be synchronized to the physics frame. This is useful when animating movement via :ref:`AnimationPlayer`, for example on moving platforms. Do **not** use together with :ref:`PhysicsBody2D.move_and_collide`. @@ -64,3 +64,4 @@ If ``true``, the body's movement will be synchronized to the physics frame. This .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animatablebody3d.rst b/classes/class_animatablebody3d.rst index df94c3369bc..de772ac6151 100644 --- a/classes/class_animatablebody3d.rst +++ b/classes/class_animatablebody3d.rst @@ -63,8 +63,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_sync_to_physics** **(** :ref:`bool` value **)** -- :ref:`bool` **is_sync_to_physics_enabled** **(** **)** +- |void| **set_sync_to_physics**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_sync_to_physics_enabled**\ (\ ) If ``true``, the body's movement will be synchronized to the physics frame. This is useful when animating movement via :ref:`AnimationPlayer`, for example on moving platforms. Do **not** use together with :ref:`PhysicsBody3D.move_and_collide`. @@ -75,3 +75,4 @@ If ``true``, the body's movement will be synchronized to the physics frame. This .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animatedsprite2d.rst b/classes/class_animatedsprite2d.rst index 6c98c61599f..fa2086b23dd 100644 --- a/classes/class_animatedsprite2d.rst +++ b/classes/class_animatedsprite2d.rst @@ -68,21 +68,21 @@ Methods .. table:: :widths: auto - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_playing_speed` **(** **)** |const| | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_playing` **(** **)** |const| | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`pause` **(** **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`play` **(** :ref:`StringName` name=&"", :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`play_backwards` **(** :ref:`StringName` name=&"" **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_frame_and_progress` **(** :ref:`int` frame, :ref:`float` progress **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`stop` **(** **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_playing_speed`\ (\ ) |const| | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_playing`\ (\ ) |const| | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`pause`\ (\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play`\ (\ name\: :ref:`StringName` = &"", custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play_backwards`\ (\ name\: :ref:`StringName` = &""\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_frame_and_progress`\ (\ frame\: :ref:`int`, progress\: :ref:`float`\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop`\ (\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -97,7 +97,7 @@ Signals .. rst-class:: classref-signal -**animation_changed** **(** **)** +**animation_changed**\ (\ ) Emitted when :ref:`animation` changes. @@ -109,7 +109,7 @@ Emitted when :ref:`animation` changes .. rst-class:: classref-signal -**animation_finished** **(** **)** +**animation_finished**\ (\ ) Emitted when the animation reaches the end, or the start if it is played in reverse. When the animation finishes, it pauses the playback. @@ -123,7 +123,7 @@ Emitted when the animation reaches the end, or the start if it is played in reve .. rst-class:: classref-signal -**animation_looped** **(** **)** +**animation_looped**\ (\ ) Emitted when the animation loops. @@ -135,7 +135,7 @@ Emitted when the animation loops. .. rst-class:: classref-signal -**frame_changed** **(** **)** +**frame_changed**\ (\ ) Emitted when :ref:`frame` changes. @@ -147,7 +147,7 @@ Emitted when :ref:`frame` changes. .. rst-class:: classref-signal -**sprite_frames_changed** **(** **)** +**sprite_frames_changed**\ (\ ) Emitted when :ref:`sprite_frames` changes. @@ -168,8 +168,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_animation** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_animation** **(** **)** +- |void| **set_animation**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_animation**\ (\ ) The current animation from the :ref:`sprite_frames` resource. If this value is changed, the :ref:`frame` counter and the :ref:`frame_progress` are reset. @@ -185,8 +185,8 @@ The current animation from the :ref:`sprite_frames` value **)** -- :ref:`String` **get_autoplay** **(** **)** +- |void| **set_autoplay**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_autoplay**\ (\ ) The key of the animation to play when the scene loads. @@ -202,11 +202,13 @@ The key of the animation to play when the scene loads. .. rst-class:: classref-property-setget -- void **set_centered** **(** :ref:`bool` value **)** -- :ref:`bool` **is_centered** **(** **)** +- |void| **set_centered**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_centered**\ (\ ) If ``true``, texture will be centered. +\ **Note:** For games with a pixel art aesthetic, textures may appear deformed when centered. This is caused by their position being between pixels. To prevent this, set this property to ``false``, or consider enabling :ref:`ProjectSettings.rendering/2d/snap/snap_2d_vertices_to_pixel` and :ref:`ProjectSettings.rendering/2d/snap/snap_2d_transforms_to_pixel`. + .. rst-class:: classref-item-separator ---- @@ -219,8 +221,8 @@ If ``true``, texture will be centered. .. rst-class:: classref-property-setget -- void **set_flip_h** **(** :ref:`bool` value **)** -- :ref:`bool` **is_flipped_h** **(** **)** +- |void| **set_flip_h**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_flipped_h**\ (\ ) If ``true``, texture is flipped horizontally. @@ -236,8 +238,8 @@ If ``true``, texture is flipped horizontally. .. rst-class:: classref-property-setget -- void **set_flip_v** **(** :ref:`bool` value **)** -- :ref:`bool` **is_flipped_v** **(** **)** +- |void| **set_flip_v**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_flipped_v**\ (\ ) If ``true``, texture is flipped vertically. @@ -253,8 +255,8 @@ If ``true``, texture is flipped vertically. .. rst-class:: classref-property-setget -- void **set_frame** **(** :ref:`int` value **)** -- :ref:`int` **get_frame** **(** **)** +- |void| **set_frame**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_frame**\ (\ ) The displayed animation frame's index. Setting this property also resets :ref:`frame_progress`. If this is not desired, use :ref:`set_frame_and_progress`. @@ -270,8 +272,8 @@ The displayed animation frame's index. Setting this property also resets :ref:`f .. rst-class:: classref-property-setget -- void **set_frame_progress** **(** :ref:`float` value **)** -- :ref:`float` **get_frame_progress** **(** **)** +- |void| **set_frame_progress**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_frame_progress**\ (\ ) The progress value between ``0.0`` and ``1.0`` until the current frame transitions to the next frame. If the animation is playing backwards, the value transitions from ``1.0`` to ``0.0``. @@ -287,8 +289,8 @@ The progress value between ``0.0`` and ``1.0`` until the current frame transitio .. rst-class:: classref-property-setget -- void **set_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_offset** **(** **)** +- |void| **set_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_offset**\ (\ ) The texture's drawing offset. @@ -304,8 +306,8 @@ The texture's drawing offset. .. rst-class:: classref-property-setget -- void **set_speed_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_speed_scale** **(** **)** +- |void| **set_speed_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_speed_scale**\ (\ ) The speed scaling ratio. For example, if this value is ``1``, then the animation plays at normal speed. If it's ``0.5``, then it plays at half speed. If it's ``2``, then it plays at double speed. @@ -323,8 +325,8 @@ If set to a negative value, the animation is played in reverse. If set to ``0``, .. rst-class:: classref-property-setget -- void **set_sprite_frames** **(** :ref:`SpriteFrames` value **)** -- :ref:`SpriteFrames` **get_sprite_frames** **(** **)** +- |void| **set_sprite_frames**\ (\ value\: :ref:`SpriteFrames`\ ) +- :ref:`SpriteFrames` **get_sprite_frames**\ (\ ) The :ref:`SpriteFrames` resource containing the animation(s). Allows you the option to load, edit, clear, make unique and save the states of the :ref:`SpriteFrames` resource. @@ -341,7 +343,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_playing_speed** **(** **)** |const| +:ref:`float` **get_playing_speed**\ (\ ) |const| Returns the actual playing speed of current animation or ``0`` if not playing. This speed is the :ref:`speed_scale` property multiplied by ``custom_speed`` argument specified when calling the :ref:`play` method. @@ -355,7 +357,7 @@ Returns a negative value if the current animation is playing backwards. .. rst-class:: classref-method -:ref:`bool` **is_playing** **(** **)** |const| +:ref:`bool` **is_playing**\ (\ ) |const| Returns ``true`` if an animation is currently playing (even if :ref:`speed_scale` and/or ``custom_speed`` are ``0``). @@ -367,7 +369,7 @@ Returns ``true`` if an animation is currently playing (even if :ref:`speed_scale .. rst-class:: classref-method -void **pause** **(** **)** +|void| **pause**\ (\ ) Pauses the currently playing animation. The :ref:`frame` and :ref:`frame_progress` will be kept and calling :ref:`play` or :ref:`play_backwards` without arguments will resume the animation from the current playback position. @@ -381,7 +383,7 @@ See also :ref:`stop`. .. rst-class:: classref-method -void **play** **(** :ref:`StringName` name=&"", :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** +|void| **play**\ (\ name\: :ref:`StringName` = &"", custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false\ ) Plays the animation with key ``name``. If ``custom_speed`` is negative and ``from_end`` is ``true``, the animation will play backwards (which is equivalent to calling :ref:`play_backwards`). @@ -395,7 +397,7 @@ If this method is called with that same animation ``name``, or with no ``name`` .. rst-class:: classref-method -void **play_backwards** **(** :ref:`StringName` name=&"" **)** +|void| **play_backwards**\ (\ name\: :ref:`StringName` = &""\ ) Plays the animation with key ``name`` in reverse. @@ -409,7 +411,7 @@ This method is a shorthand for :ref:`play` w .. rst-class:: classref-method -void **set_frame_and_progress** **(** :ref:`int` frame, :ref:`float` progress **)** +|void| **set_frame_and_progress**\ (\ frame\: :ref:`int`, progress\: :ref:`float`\ ) The setter of :ref:`frame` resets the :ref:`frame_progress` to ``0.0`` implicitly, but this method avoids that. @@ -438,7 +440,7 @@ This is useful when you want to carry over the current :ref:`frame_progress`. @@ -449,3 +451,4 @@ Stops the currently playing animation. The animation position is reset to ``0`` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index d2c3b682b7a..2611ed6cf24 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -58,21 +58,21 @@ Methods .. table:: :widths: auto - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_playing_speed` **(** **)** |const| | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_playing` **(** **)** |const| | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`pause` **(** **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`play` **(** :ref:`StringName` name=&"", :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`play_backwards` **(** :ref:`StringName` name=&"" **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_frame_and_progress` **(** :ref:`int` frame, :ref:`float` progress **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`stop` **(** **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_playing_speed`\ (\ ) |const| | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_playing`\ (\ ) |const| | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`pause`\ (\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play`\ (\ name\: :ref:`StringName` = &"", custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play_backwards`\ (\ name\: :ref:`StringName` = &""\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_frame_and_progress`\ (\ frame\: :ref:`int`, progress\: :ref:`float`\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop`\ (\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -87,7 +87,7 @@ Signals .. rst-class:: classref-signal -**animation_changed** **(** **)** +**animation_changed**\ (\ ) Emitted when :ref:`animation` changes. @@ -99,7 +99,7 @@ Emitted when :ref:`animation` changes .. rst-class:: classref-signal -**animation_finished** **(** **)** +**animation_finished**\ (\ ) Emitted when the animation reaches the end, or the start if it is played in reverse. When the animation finishes, it pauses the playback. @@ -113,7 +113,7 @@ Emitted when the animation reaches the end, or the start if it is played in reve .. rst-class:: classref-signal -**animation_looped** **(** **)** +**animation_looped**\ (\ ) Emitted when the animation loops. @@ -125,7 +125,7 @@ Emitted when the animation loops. .. rst-class:: classref-signal -**frame_changed** **(** **)** +**frame_changed**\ (\ ) Emitted when :ref:`frame` changes. @@ -137,7 +137,7 @@ Emitted when :ref:`frame` changes. .. rst-class:: classref-signal -**sprite_frames_changed** **(** **)** +**sprite_frames_changed**\ (\ ) Emitted when :ref:`sprite_frames` changes. @@ -158,8 +158,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_animation** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_animation** **(** **)** +- |void| **set_animation**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_animation**\ (\ ) The current animation from the :ref:`sprite_frames` resource. If this value is changed, the :ref:`frame` counter and the :ref:`frame_progress` are reset. @@ -175,8 +175,8 @@ The current animation from the :ref:`sprite_frames` value **)** -- :ref:`String` **get_autoplay** **(** **)** +- |void| **set_autoplay**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_autoplay**\ (\ ) The key of the animation to play when the scene loads. @@ -192,8 +192,8 @@ The key of the animation to play when the scene loads. .. rst-class:: classref-property-setget -- void **set_frame** **(** :ref:`int` value **)** -- :ref:`int` **get_frame** **(** **)** +- |void| **set_frame**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_frame**\ (\ ) The displayed animation frame's index. Setting this property also resets :ref:`frame_progress`. If this is not desired, use :ref:`set_frame_and_progress`. @@ -209,8 +209,8 @@ The displayed animation frame's index. Setting this property also resets :ref:`f .. rst-class:: classref-property-setget -- void **set_frame_progress** **(** :ref:`float` value **)** -- :ref:`float` **get_frame_progress** **(** **)** +- |void| **set_frame_progress**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_frame_progress**\ (\ ) The progress value between ``0.0`` and ``1.0`` until the current frame transitions to the next frame. If the animation is playing backwards, the value transitions from ``1.0`` to ``0.0``. @@ -226,8 +226,8 @@ The progress value between ``0.0`` and ``1.0`` until the current frame transitio .. rst-class:: classref-property-setget -- void **set_speed_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_speed_scale** **(** **)** +- |void| **set_speed_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_speed_scale**\ (\ ) The speed scaling ratio. For example, if this value is ``1``, then the animation plays at normal speed. If it's ``0.5``, then it plays at half speed. If it's ``2``, then it plays at double speed. @@ -245,8 +245,8 @@ If set to a negative value, the animation is played in reverse. If set to ``0``, .. rst-class:: classref-property-setget -- void **set_sprite_frames** **(** :ref:`SpriteFrames` value **)** -- :ref:`SpriteFrames` **get_sprite_frames** **(** **)** +- |void| **set_sprite_frames**\ (\ value\: :ref:`SpriteFrames`\ ) +- :ref:`SpriteFrames` **get_sprite_frames**\ (\ ) The :ref:`SpriteFrames` resource containing the animation(s). Allows you the option to load, edit, clear, make unique and save the states of the :ref:`SpriteFrames` resource. @@ -263,7 +263,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_playing_speed** **(** **)** |const| +:ref:`float` **get_playing_speed**\ (\ ) |const| Returns the actual playing speed of current animation or ``0`` if not playing. This speed is the :ref:`speed_scale` property multiplied by ``custom_speed`` argument specified when calling the :ref:`play` method. @@ -277,7 +277,7 @@ Returns a negative value if the current animation is playing backwards. .. rst-class:: classref-method -:ref:`bool` **is_playing** **(** **)** |const| +:ref:`bool` **is_playing**\ (\ ) |const| Returns ``true`` if an animation is currently playing (even if :ref:`speed_scale` and/or ``custom_speed`` are ``0``). @@ -289,7 +289,7 @@ Returns ``true`` if an animation is currently playing (even if :ref:`speed_scale .. rst-class:: classref-method -void **pause** **(** **)** +|void| **pause**\ (\ ) Pauses the currently playing animation. The :ref:`frame` and :ref:`frame_progress` will be kept and calling :ref:`play` or :ref:`play_backwards` without arguments will resume the animation from the current playback position. @@ -303,7 +303,7 @@ See also :ref:`stop`. .. rst-class:: classref-method -void **play** **(** :ref:`StringName` name=&"", :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** +|void| **play**\ (\ name\: :ref:`StringName` = &"", custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false\ ) Plays the animation with key ``name``. If ``custom_speed`` is negative and ``from_end`` is ``true``, the animation will play backwards (which is equivalent to calling :ref:`play_backwards`). @@ -317,7 +317,7 @@ If this method is called with that same animation ``name``, or with no ``name`` .. rst-class:: classref-method -void **play_backwards** **(** :ref:`StringName` name=&"" **)** +|void| **play_backwards**\ (\ name\: :ref:`StringName` = &""\ ) Plays the animation with key ``name`` in reverse. @@ -331,7 +331,7 @@ This method is a shorthand for :ref:`play` w .. rst-class:: classref-method -void **set_frame_and_progress** **(** :ref:`int` frame, :ref:`float` progress **)** +|void| **set_frame_and_progress**\ (\ frame\: :ref:`int`, progress\: :ref:`float`\ ) The setter of :ref:`frame` resets the :ref:`frame_progress` to ``0.0`` implicitly, but this method avoids that. @@ -360,7 +360,7 @@ This is useful when you want to carry over the current :ref:`frame_progress`. @@ -371,3 +371,4 @@ Stops the currently playing animation. The animation position is reset to ``0`` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animatedtexture.rst b/classes/class_animatedtexture.rst index 58dafe79c3d..61d15057e2f 100644 --- a/classes/class_animatedtexture.rst +++ b/classes/class_animatedtexture.rst @@ -10,7 +10,7 @@ AnimatedTexture =============== -**Deprecated:** This class may be changed or removed in future versions. +**Deprecated:** This class does not work properly in current versions and may be removed in the future. There is currently no equivalent workaround. **Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` @@ -61,15 +61,15 @@ Methods .. table:: :widths: auto - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_frame_duration` **(** :ref:`int` frame **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_frame_texture` **(** :ref:`int` frame **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_frame_duration` **(** :ref:`int` frame, :ref:`float` duration **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_frame_texture` **(** :ref:`int` frame, :ref:`Texture2D` texture **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_frame_duration`\ (\ frame\: :ref:`int`\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_frame_texture`\ (\ frame\: :ref:`int`\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_frame_duration`\ (\ frame\: :ref:`int`, duration\: :ref:`float`\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_frame_texture`\ (\ frame\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -105,8 +105,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_current_frame** **(** :ref:`int` value **)** -- :ref:`int` **get_current_frame** **(** **)** +- |void| **set_current_frame**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_current_frame**\ (\ ) Sets the currently visible frame of the texture. Setting this frame while playing resets the current frame time, so the newly selected frame plays for its whole configured frame duration. @@ -122,8 +122,8 @@ Sets the currently visible frame of the texture. Setting this frame while playin .. rst-class:: classref-property-setget -- void **set_frames** **(** :ref:`int` value **)** -- :ref:`int` **get_frames** **(** **)** +- |void| **set_frames**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_frames**\ (\ ) Number of frames to use in the animation. While you can create the frames independently with :ref:`set_frame_texture`, you need to set this value for the animation to take new frames into account. The maximum number of frames is :ref:`MAX_FRAMES`. @@ -139,8 +139,8 @@ Number of frames to use in the animation. While you can create the frames indepe .. rst-class:: classref-property-setget -- void **set_one_shot** **(** :ref:`bool` value **)** -- :ref:`bool` **get_one_shot** **(** **)** +- |void| **set_one_shot**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_one_shot**\ (\ ) If ``true``, the animation will only play once and will not loop back to the first frame after reaching the end. Note that reaching the end will not set :ref:`pause` to ``true``. @@ -156,8 +156,8 @@ If ``true``, the animation will only play once and will not loop back to the fir .. rst-class:: classref-property-setget -- void **set_pause** **(** :ref:`bool` value **)** -- :ref:`bool` **get_pause** **(** **)** +- |void| **set_pause**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_pause**\ (\ ) If ``true``, the animation will pause where it currently is (i.e. at :ref:`current_frame`). The animation will continue from where it was paused when changing this property to ``false``. @@ -173,8 +173,8 @@ If ``true``, the animation will pause where it currently is (i.e. at :ref:`curre .. rst-class:: classref-property-setget -- void **set_speed_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_speed_scale** **(** **)** +- |void| **set_speed_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_speed_scale**\ (\ ) The animation speed is multiplied by this value. If set to a negative value, the animation is played in reverse. @@ -191,7 +191,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_frame_duration** **(** :ref:`int` frame **)** |const| +:ref:`float` **get_frame_duration**\ (\ frame\: :ref:`int`\ ) |const| Returns the given ``frame``'s duration, in seconds. @@ -203,7 +203,7 @@ Returns the given ``frame``'s duration, in seconds. .. rst-class:: classref-method -:ref:`Texture2D` **get_frame_texture** **(** :ref:`int` frame **)** |const| +:ref:`Texture2D` **get_frame_texture**\ (\ frame\: :ref:`int`\ ) |const| Returns the given frame's :ref:`Texture2D`. @@ -215,7 +215,7 @@ Returns the given frame's :ref:`Texture2D`. .. rst-class:: classref-method -void **set_frame_duration** **(** :ref:`int` frame, :ref:`float` duration **)** +|void| **set_frame_duration**\ (\ frame\: :ref:`int`, duration\: :ref:`float`\ ) Sets the duration of any given ``frame``. The final duration is affected by the :ref:`speed_scale`. If set to ``0``, the frame is skipped during playback. @@ -227,7 +227,7 @@ Sets the duration of any given ``frame``. The final duration is affected by the .. rst-class:: classref-method -void **set_frame_texture** **(** :ref:`int` frame, :ref:`Texture2D` texture **)** +|void| **set_frame_texture**\ (\ frame\: :ref:`int`, texture\: :ref:`Texture2D`\ ) Assigns a :ref:`Texture2D` to the given frame. Frame IDs start at 0, so the first frame has ID 0, and the last frame of the animation has ID :ref:`frames` - 1. @@ -240,3 +240,4 @@ You can define any number of textures up to :ref:`MAX_FRAMES` | :ref:`add_track` **(** :ref:`TrackType` type, :ref:`int` at_position=-1 **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`animation_track_get_key_animation` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`animation_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`StringName` animation **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`animation_track_set_key_animation` **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`StringName` animation **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`audio_track_get_key_end_offset` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`audio_track_get_key_start_offset` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`audio_track_get_key_stream` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`audio_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Resource` stream, :ref:`float` start_offset=0, :ref:`float` end_offset=0 **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`audio_track_is_use_blend` **(** :ref:`int` track_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`audio_track_set_key_end_offset` **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`float` offset **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`audio_track_set_key_start_offset` **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`float` offset **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`audio_track_set_key_stream` **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`Resource` stream **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`audio_track_set_use_blend` **(** :ref:`int` track_idx, :ref:`bool` enable **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`bezier_track_get_key_in_handle` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`bezier_track_get_key_out_handle` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`bezier_track_get_key_value` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bezier_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`float` value, :ref:`Vector2` in_handle=Vector2(0, 0), :ref:`Vector2` out_handle=Vector2(0, 0) **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`bezier_track_interpolate` **(** :ref:`int` track_idx, :ref:`float` time **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`bezier_track_set_key_in_handle` **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`Vector2` in_handle, :ref:`float` balanced_value_time_ratio=1.0 **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`bezier_track_set_key_out_handle` **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`Vector2` out_handle, :ref:`float` balanced_value_time_ratio=1.0 **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`bezier_track_set_key_value` **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`float` value **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`blend_shape_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`float` amount **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`blend_shape_track_interpolate` **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`compress` **(** :ref:`int` page_size=8192, :ref:`int` fps=120, :ref:`float` split_tolerance=4.0 **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`copy_track` **(** :ref:`int` track_idx, :ref:`Animation` to_animation **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find_track` **(** :ref:`NodePath` path, :ref:`TrackType` type **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_track_count` **(** **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`method_track_get_name` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`method_track_get_params` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`position_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Vector3` position **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`position_track_interpolate` **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_track` **(** :ref:`int` track_idx **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rotation_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Quaternion` rotation **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`rotation_track_interpolate` **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`scale_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Vector3` scale **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`scale_track_interpolate` **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`track_find_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`FindMode` find_mode=0 **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`track_get_interpolation_loop_wrap` **(** :ref:`int` track_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`InterpolationType` | :ref:`track_get_interpolation_type` **(** :ref:`int` track_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`track_get_key_count` **(** :ref:`int` track_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`track_get_key_time` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`track_get_key_transition` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`track_get_key_value` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`track_get_path` **(** :ref:`int` track_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TrackType` | :ref:`track_get_type` **(** :ref:`int` track_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`track_is_compressed` **(** :ref:`int` track_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`track_is_enabled` **(** :ref:`int` track_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`track_is_imported` **(** :ref:`int` track_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`track_move_down` **(** :ref:`int` track_idx **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`track_move_to` **(** :ref:`int` track_idx, :ref:`int` to_idx **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`track_move_up` **(** :ref:`int` track_idx **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`track_remove_key` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`track_remove_key_at_time` **(** :ref:`int` track_idx, :ref:`float` time **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`track_set_enabled` **(** :ref:`int` track_idx, :ref:`bool` enabled **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`track_set_imported` **(** :ref:`int` track_idx, :ref:`bool` imported **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`track_set_interpolation_loop_wrap` **(** :ref:`int` track_idx, :ref:`bool` interpolation **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`track_set_interpolation_type` **(** :ref:`int` track_idx, :ref:`InterpolationType` interpolation **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`track_set_key_time` **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`float` time **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`track_set_key_transition` **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`float` transition **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`track_set_key_value` **(** :ref:`int` track_idx, :ref:`int` key, :ref:`Variant` value **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`track_set_path` **(** :ref:`int` track_idx, :ref:`NodePath` path **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`track_swap` **(** :ref:`int` track_idx, :ref:`int` with_idx **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`UpdateMode` | :ref:`value_track_get_update_mode` **(** :ref:`int` track_idx **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`value_track_interpolate` **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`value_track_set_update_mode` **(** :ref:`int` track_idx, :ref:`UpdateMode` mode **)** | - +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`add_track`\ (\ type\: :ref:`TrackType`, at_position\: :ref:`int` = -1\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`animation_track_get_key_animation`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`animation_track_insert_key`\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, animation\: :ref:`StringName`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`animation_track_set_key_animation`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, animation\: :ref:`StringName`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`audio_track_get_key_end_offset`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`audio_track_get_key_start_offset`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`audio_track_get_key_stream`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`audio_track_insert_key`\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, stream\: :ref:`Resource`, start_offset\: :ref:`float` = 0, end_offset\: :ref:`float` = 0\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`audio_track_is_use_blend`\ (\ track_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`audio_track_set_key_end_offset`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, offset\: :ref:`float`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`audio_track_set_key_start_offset`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, offset\: :ref:`float`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`audio_track_set_key_stream`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, stream\: :ref:`Resource`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`audio_track_set_use_blend`\ (\ track_idx\: :ref:`int`, enable\: :ref:`bool`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`bezier_track_get_key_in_handle`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`bezier_track_get_key_out_handle`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`bezier_track_get_key_value`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bezier_track_insert_key`\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, value\: :ref:`float`, in_handle\: :ref:`Vector2` = Vector2(0, 0), out_handle\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`bezier_track_interpolate`\ (\ track_idx\: :ref:`int`, time\: :ref:`float`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bezier_track_set_key_in_handle`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, in_handle\: :ref:`Vector2`, balanced_value_time_ratio\: :ref:`float` = 1.0\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bezier_track_set_key_out_handle`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, out_handle\: :ref:`Vector2`, balanced_value_time_ratio\: :ref:`float` = 1.0\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bezier_track_set_key_value`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, value\: :ref:`float`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`blend_shape_track_insert_key`\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, amount\: :ref:`float`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`blend_shape_track_interpolate`\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`compress`\ (\ page_size\: :ref:`int` = 8192, fps\: :ref:`int` = 120, split_tolerance\: :ref:`float` = 4.0\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`copy_track`\ (\ track_idx\: :ref:`int`, to_animation\: :ref:`Animation`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find_track`\ (\ path\: :ref:`NodePath`, type\: :ref:`TrackType`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_track_count`\ (\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`method_track_get_name`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`method_track_get_params`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`position_track_insert_key`\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, position\: :ref:`Vector3`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`position_track_interpolate`\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_track`\ (\ track_idx\: :ref:`int`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rotation_track_insert_key`\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, rotation\: :ref:`Quaternion`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`rotation_track_interpolate`\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`scale_track_insert_key`\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, scale\: :ref:`Vector3`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`scale_track_interpolate`\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`track_find_key`\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, find_mode\: :ref:`FindMode` = 0, limit\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`track_get_interpolation_loop_wrap`\ (\ track_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`InterpolationType` | :ref:`track_get_interpolation_type`\ (\ track_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`track_get_key_count`\ (\ track_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`track_get_key_time`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`track_get_key_transition`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`track_get_key_value`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`track_get_path`\ (\ track_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TrackType` | :ref:`track_get_type`\ (\ track_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`track_insert_key`\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, key\: :ref:`Variant`, transition\: :ref:`float` = 1\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`track_is_compressed`\ (\ track_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`track_is_enabled`\ (\ track_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`track_is_imported`\ (\ track_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`track_move_down`\ (\ track_idx\: :ref:`int`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`track_move_to`\ (\ track_idx\: :ref:`int`, to_idx\: :ref:`int`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`track_move_up`\ (\ track_idx\: :ref:`int`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`track_remove_key`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`track_remove_key_at_time`\ (\ track_idx\: :ref:`int`, time\: :ref:`float`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`track_set_enabled`\ (\ track_idx\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`track_set_imported`\ (\ track_idx\: :ref:`int`, imported\: :ref:`bool`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`track_set_interpolation_loop_wrap`\ (\ track_idx\: :ref:`int`, interpolation\: :ref:`bool`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`track_set_interpolation_type`\ (\ track_idx\: :ref:`int`, interpolation\: :ref:`InterpolationType`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`track_set_key_time`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, time\: :ref:`float`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`track_set_key_transition`\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, transition\: :ref:`float`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`track_set_key_value`\ (\ track_idx\: :ref:`int`, key\: :ref:`int`, value\: :ref:`Variant`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`track_set_path`\ (\ track_idx\: :ref:`int`, path\: :ref:`NodePath`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`track_swap`\ (\ track_idx\: :ref:`int`, with_idx\: :ref:`int`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`UpdateMode` | :ref:`value_track_get_update_mode`\ (\ track_idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`value_track_interpolate`\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`value_track_set_update_mode`\ (\ track_idx\: :ref:`int`, mode\: :ref:`UpdateMode`\ ) | + +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -513,8 +513,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_length** **(** :ref:`float` value **)** -- :ref:`float` **get_length** **(** **)** +- |void| **set_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_length**\ (\ ) The total length of the animation (in seconds). @@ -532,8 +532,8 @@ The total length of the animation (in seconds). .. rst-class:: classref-property-setget -- void **set_loop_mode** **(** :ref:`LoopMode` value **)** -- :ref:`LoopMode` **get_loop_mode** **(** **)** +- |void| **set_loop_mode**\ (\ value\: :ref:`LoopMode`\ ) +- :ref:`LoopMode` **get_loop_mode**\ (\ ) Determines the behavior of both ends of the animation timeline during animation playback. This is used for correct interpolation of animation cycles, and for hinting the player that it must restart the animation. @@ -549,8 +549,8 @@ Determines the behavior of both ends of the animation timeline during animation .. rst-class:: classref-property-setget -- void **set_step** **(** :ref:`float` value **)** -- :ref:`float` **get_step** **(** **)** +- |void| **set_step**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_step**\ (\ ) The animation step value. @@ -567,7 +567,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **add_track** **(** :ref:`TrackType` type, :ref:`int` at_position=-1 **)** +:ref:`int` **add_track**\ (\ type\: :ref:`TrackType`, at_position\: :ref:`int` = -1\ ) Adds a track to the Animation. @@ -579,7 +579,7 @@ Adds a track to the Animation. .. rst-class:: classref-method -:ref:`StringName` **animation_track_get_key_animation** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| +:ref:`StringName` **animation_track_get_key_animation**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| Returns the animation name at the key identified by ``key_idx``. The ``track_idx`` must be the index of an Animation Track. @@ -591,7 +591,7 @@ Returns the animation name at the key identified by ``key_idx``. The ``track_idx .. rst-class:: classref-method -:ref:`int` **animation_track_insert_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`StringName` animation **)** +:ref:`int` **animation_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, animation\: :ref:`StringName`\ ) Inserts a key with value ``animation`` at the given ``time`` (in seconds). The ``track_idx`` must be the index of an Animation Track. @@ -603,7 +603,7 @@ Inserts a key with value ``animation`` at the given ``time`` (in seconds). The ` .. rst-class:: classref-method -void **animation_track_set_key_animation** **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`StringName` animation **)** +|void| **animation_track_set_key_animation**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, animation\: :ref:`StringName`\ ) Sets the key identified by ``key_idx`` to value ``animation``. The ``track_idx`` must be the index of an Animation Track. @@ -615,7 +615,7 @@ Sets the key identified by ``key_idx`` to value ``animation``. The ``track_idx`` .. rst-class:: classref-method -:ref:`float` **audio_track_get_key_end_offset** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| +:ref:`float` **audio_track_get_key_end_offset**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| Returns the end offset of the key identified by ``key_idx``. The ``track_idx`` must be the index of an Audio Track. @@ -629,7 +629,7 @@ End offset is the number of seconds cut off at the ending of the audio stream. .. rst-class:: classref-method -:ref:`float` **audio_track_get_key_start_offset** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| +:ref:`float` **audio_track_get_key_start_offset**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| Returns the start offset of the key identified by ``key_idx``. The ``track_idx`` must be the index of an Audio Track. @@ -643,7 +643,7 @@ Start offset is the number of seconds cut off at the beginning of the audio stre .. rst-class:: classref-method -:ref:`Resource` **audio_track_get_key_stream** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| +:ref:`Resource` **audio_track_get_key_stream**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| Returns the audio stream of the key identified by ``key_idx``. The ``track_idx`` must be the index of an Audio Track. @@ -655,7 +655,7 @@ Returns the audio stream of the key identified by ``key_idx``. The ``track_idx`` .. rst-class:: classref-method -:ref:`int` **audio_track_insert_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Resource` stream, :ref:`float` start_offset=0, :ref:`float` end_offset=0 **)** +:ref:`int` **audio_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, stream\: :ref:`Resource`, start_offset\: :ref:`float` = 0, end_offset\: :ref:`float` = 0\ ) Inserts an Audio Track key at the given ``time`` in seconds. The ``track_idx`` must be the index of an Audio Track. @@ -669,7 +669,7 @@ Inserts an Audio Track key at the given ``time`` in seconds. The ``track_idx`` m .. rst-class:: classref-method -:ref:`bool` **audio_track_is_use_blend** **(** :ref:`int` track_idx **)** |const| +:ref:`bool` **audio_track_is_use_blend**\ (\ track_idx\: :ref:`int`\ ) |const| Returns ``true`` if the track at ``track_idx`` will be blended with other animations. @@ -681,7 +681,7 @@ Returns ``true`` if the track at ``track_idx`` will be blended with other animat .. rst-class:: classref-method -void **audio_track_set_key_end_offset** **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`float` offset **)** +|void| **audio_track_set_key_end_offset**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, offset\: :ref:`float`\ ) Sets the end offset of the key identified by ``key_idx`` to value ``offset``. The ``track_idx`` must be the index of an Audio Track. @@ -693,7 +693,7 @@ Sets the end offset of the key identified by ``key_idx`` to value ``offset``. Th .. rst-class:: classref-method -void **audio_track_set_key_start_offset** **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`float` offset **)** +|void| **audio_track_set_key_start_offset**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, offset\: :ref:`float`\ ) Sets the start offset of the key identified by ``key_idx`` to value ``offset``. The ``track_idx`` must be the index of an Audio Track. @@ -705,7 +705,7 @@ Sets the start offset of the key identified by ``key_idx`` to value ``offset``. .. rst-class:: classref-method -void **audio_track_set_key_stream** **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`Resource` stream **)** +|void| **audio_track_set_key_stream**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, stream\: :ref:`Resource`\ ) Sets the stream of the key identified by ``key_idx`` to value ``stream``. The ``track_idx`` must be the index of an Audio Track. @@ -717,7 +717,7 @@ Sets the stream of the key identified by ``key_idx`` to value ``stream``. The `` .. rst-class:: classref-method -void **audio_track_set_use_blend** **(** :ref:`int` track_idx, :ref:`bool` enable **)** +|void| **audio_track_set_use_blend**\ (\ track_idx\: :ref:`int`, enable\: :ref:`bool`\ ) Sets whether the track will be blended with other animations. If ``true``, the audio playback volume changes depending on the blend value. @@ -729,7 +729,7 @@ Sets whether the track will be blended with other animations. If ``true``, the a .. rst-class:: classref-method -:ref:`Vector2` **bezier_track_get_key_in_handle** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| +:ref:`Vector2` **bezier_track_get_key_in_handle**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| Returns the in handle of the key identified by ``key_idx``. The ``track_idx`` must be the index of a Bezier Track. @@ -741,7 +741,7 @@ Returns the in handle of the key identified by ``key_idx``. The ``track_idx`` mu .. rst-class:: classref-method -:ref:`Vector2` **bezier_track_get_key_out_handle** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| +:ref:`Vector2` **bezier_track_get_key_out_handle**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| Returns the out handle of the key identified by ``key_idx``. The ``track_idx`` must be the index of a Bezier Track. @@ -753,7 +753,7 @@ Returns the out handle of the key identified by ``key_idx``. The ``track_idx`` m .. rst-class:: classref-method -:ref:`float` **bezier_track_get_key_value** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| +:ref:`float` **bezier_track_get_key_value**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| Returns the value of the key identified by ``key_idx``. The ``track_idx`` must be the index of a Bezier Track. @@ -765,7 +765,7 @@ Returns the value of the key identified by ``key_idx``. The ``track_idx`` must b .. rst-class:: classref-method -:ref:`int` **bezier_track_insert_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`float` value, :ref:`Vector2` in_handle=Vector2(0, 0), :ref:`Vector2` out_handle=Vector2(0, 0) **)** +:ref:`int` **bezier_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, value\: :ref:`float`, in_handle\: :ref:`Vector2` = Vector2(0, 0), out_handle\: :ref:`Vector2` = Vector2(0, 0)\ ) Inserts a Bezier Track key at the given ``time`` in seconds. The ``track_idx`` must be the index of a Bezier Track. @@ -779,7 +779,7 @@ Inserts a Bezier Track key at the given ``time`` in seconds. The ``track_idx`` m .. rst-class:: classref-method -:ref:`float` **bezier_track_interpolate** **(** :ref:`int` track_idx, :ref:`float` time **)** |const| +:ref:`float` **bezier_track_interpolate**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`\ ) |const| Returns the interpolated value at the given ``time`` (in seconds). The ``track_idx`` must be the index of a Bezier Track. @@ -791,7 +791,7 @@ Returns the interpolated value at the given ``time`` (in seconds). The ``track_i .. rst-class:: classref-method -void **bezier_track_set_key_in_handle** **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`Vector2` in_handle, :ref:`float` balanced_value_time_ratio=1.0 **)** +|void| **bezier_track_set_key_in_handle**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, in_handle\: :ref:`Vector2`, balanced_value_time_ratio\: :ref:`float` = 1.0\ ) Sets the in handle of the key identified by ``key_idx`` to value ``in_handle``. The ``track_idx`` must be the index of a Bezier Track. @@ -803,7 +803,7 @@ Sets the in handle of the key identified by ``key_idx`` to value ``in_handle``. .. rst-class:: classref-method -void **bezier_track_set_key_out_handle** **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`Vector2` out_handle, :ref:`float` balanced_value_time_ratio=1.0 **)** +|void| **bezier_track_set_key_out_handle**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, out_handle\: :ref:`Vector2`, balanced_value_time_ratio\: :ref:`float` = 1.0\ ) Sets the out handle of the key identified by ``key_idx`` to value ``out_handle``. The ``track_idx`` must be the index of a Bezier Track. @@ -815,7 +815,7 @@ Sets the out handle of the key identified by ``key_idx`` to value ``out_handle`` .. rst-class:: classref-method -void **bezier_track_set_key_value** **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`float` value **)** +|void| **bezier_track_set_key_value**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, value\: :ref:`float`\ ) Sets the value of the key identified by ``key_idx`` to the given value. The ``track_idx`` must be the index of a Bezier Track. @@ -827,7 +827,7 @@ Sets the value of the key identified by ``key_idx`` to the given value. The ``tr .. rst-class:: classref-method -:ref:`int` **blend_shape_track_insert_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`float` amount **)** +:ref:`int` **blend_shape_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, amount\: :ref:`float`\ ) Inserts a key in a given blend shape track. Returns the key index. @@ -839,7 +839,7 @@ Inserts a key in a given blend shape track. Returns the key index. .. rst-class:: classref-method -:ref:`float` **blend_shape_track_interpolate** **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| +:ref:`float` **blend_shape_track_interpolate**\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| Returns the interpolated blend shape value at the given time (in seconds). The ``track_idx`` must be the index of a blend shape track. @@ -851,7 +851,7 @@ Returns the interpolated blend shape value at the given time (in seconds). The ` .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clear the animation (clear all tracks and reset all). @@ -863,7 +863,7 @@ Clear the animation (clear all tracks and reset all). .. rst-class:: classref-method -void **compress** **(** :ref:`int` page_size=8192, :ref:`int` fps=120, :ref:`float` split_tolerance=4.0 **)** +|void| **compress**\ (\ page_size\: :ref:`int` = 8192, fps\: :ref:`int` = 120, split_tolerance\: :ref:`float` = 4.0\ ) Compress the animation and all its tracks in-place. This will make :ref:`track_is_compressed` return ``true`` once called on this **Animation**. Compressed tracks require less memory to be played, and are designed to be used for complex 3D animations (such as cutscenes) imported from external 3D software. Compression is lossy, but the difference is usually not noticeable in real world conditions. @@ -877,7 +877,7 @@ Compress the animation and all its tracks in-place. This will make :ref:`track_i .. rst-class:: classref-method -void **copy_track** **(** :ref:`int` track_idx, :ref:`Animation` to_animation **)** +|void| **copy_track**\ (\ track_idx\: :ref:`int`, to_animation\: :ref:`Animation`\ ) Adds a new track to ``to_animation`` that is a copy of the given track from this animation. @@ -889,7 +889,7 @@ Adds a new track to ``to_animation`` that is a copy of the given track from this .. rst-class:: classref-method -:ref:`int` **find_track** **(** :ref:`NodePath` path, :ref:`TrackType` type **)** |const| +:ref:`int` **find_track**\ (\ path\: :ref:`NodePath`, type\: :ref:`TrackType`\ ) |const| Returns the index of the specified track. If the track is not found, return -1. @@ -901,7 +901,7 @@ Returns the index of the specified track. If the track is not found, return -1. .. rst-class:: classref-method -:ref:`int` **get_track_count** **(** **)** |const| +:ref:`int` **get_track_count**\ (\ ) |const| Returns the amount of tracks in the animation. @@ -913,7 +913,7 @@ Returns the amount of tracks in the animation. .. rst-class:: classref-method -:ref:`StringName` **method_track_get_name** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| +:ref:`StringName` **method_track_get_name**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| Returns the method name of a method track. @@ -925,7 +925,7 @@ Returns the method name of a method track. .. rst-class:: classref-method -:ref:`Array` **method_track_get_params** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| +:ref:`Array` **method_track_get_params**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| Returns the arguments values to be called on a method track for a given key in a given track. @@ -937,7 +937,7 @@ Returns the arguments values to be called on a method track for a given key in a .. rst-class:: classref-method -:ref:`int` **position_track_insert_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Vector3` position **)** +:ref:`int` **position_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, position\: :ref:`Vector3`\ ) Inserts a key in a given 3D position track. Returns the key index. @@ -949,7 +949,7 @@ Inserts a key in a given 3D position track. Returns the key index. .. rst-class:: classref-method -:ref:`Vector3` **position_track_interpolate** **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| +:ref:`Vector3` **position_track_interpolate**\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| Returns the interpolated position value at the given time (in seconds). The ``track_idx`` must be the index of a 3D position track. @@ -961,7 +961,7 @@ Returns the interpolated position value at the given time (in seconds). The ``tr .. rst-class:: classref-method -void **remove_track** **(** :ref:`int` track_idx **)** +|void| **remove_track**\ (\ track_idx\: :ref:`int`\ ) Removes a track by specifying the track index. @@ -973,7 +973,7 @@ Removes a track by specifying the track index. .. rst-class:: classref-method -:ref:`int` **rotation_track_insert_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Quaternion` rotation **)** +:ref:`int` **rotation_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, rotation\: :ref:`Quaternion`\ ) Inserts a key in a given 3D rotation track. Returns the key index. @@ -985,7 +985,7 @@ Inserts a key in a given 3D rotation track. Returns the key index. .. rst-class:: classref-method -:ref:`Quaternion` **rotation_track_interpolate** **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| +:ref:`Quaternion` **rotation_track_interpolate**\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| Returns the interpolated rotation value at the given time (in seconds). The ``track_idx`` must be the index of a 3D rotation track. @@ -997,7 +997,7 @@ Returns the interpolated rotation value at the given time (in seconds). The ``tr .. rst-class:: classref-method -:ref:`int` **scale_track_insert_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Vector3` scale **)** +:ref:`int` **scale_track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, scale\: :ref:`Vector3`\ ) Inserts a key in a given 3D scale track. Returns the key index. @@ -1009,7 +1009,7 @@ Inserts a key in a given 3D scale track. Returns the key index. .. rst-class:: classref-method -:ref:`Vector3` **scale_track_interpolate** **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| +:ref:`Vector3` **scale_track_interpolate**\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| Returns the interpolated scale value at the given time (in seconds). The ``track_idx`` must be the index of a 3D scale track. @@ -1021,10 +1021,12 @@ Returns the interpolated scale value at the given time (in seconds). The ``track .. rst-class:: classref-method -:ref:`int` **track_find_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`FindMode` find_mode=0 **)** |const| +:ref:`int` **track_find_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, find_mode\: :ref:`FindMode` = 0, limit\: :ref:`bool` = false\ ) |const| Finds the key index by time in a given track. Optionally, only find it if the approx/exact time is given. +If ``limit`` is ``true``, it does not return keys outside the animation range. + .. rst-class:: classref-item-separator ---- @@ -1033,7 +1035,7 @@ Finds the key index by time in a given track. Optionally, only find it if the ap .. rst-class:: classref-method -:ref:`bool` **track_get_interpolation_loop_wrap** **(** :ref:`int` track_idx **)** |const| +:ref:`bool` **track_get_interpolation_loop_wrap**\ (\ track_idx\: :ref:`int`\ ) |const| Returns ``true`` if the track at ``track_idx`` wraps the interpolation loop. New tracks wrap the interpolation loop by default. @@ -1045,7 +1047,7 @@ Returns ``true`` if the track at ``track_idx`` wraps the interpolation loop. New .. rst-class:: classref-method -:ref:`InterpolationType` **track_get_interpolation_type** **(** :ref:`int` track_idx **)** |const| +:ref:`InterpolationType` **track_get_interpolation_type**\ (\ track_idx\: :ref:`int`\ ) |const| Returns the interpolation type of a given track. @@ -1057,7 +1059,7 @@ Returns the interpolation type of a given track. .. rst-class:: classref-method -:ref:`int` **track_get_key_count** **(** :ref:`int` track_idx **)** |const| +:ref:`int` **track_get_key_count**\ (\ track_idx\: :ref:`int`\ ) |const| Returns the number of keys in a given track. @@ -1069,7 +1071,7 @@ Returns the number of keys in a given track. .. rst-class:: classref-method -:ref:`float` **track_get_key_time** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| +:ref:`float` **track_get_key_time**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| Returns the time at which the key is located. @@ -1081,7 +1083,7 @@ Returns the time at which the key is located. .. rst-class:: classref-method -:ref:`float` **track_get_key_transition** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| +:ref:`float` **track_get_key_transition**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| Returns the transition curve (easing) for a specific key (see the built-in math function :ref:`@GlobalScope.ease`). @@ -1093,7 +1095,7 @@ Returns the transition curve (easing) for a specific key (see the built-in math .. rst-class:: classref-method -:ref:`Variant` **track_get_key_value** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| +:ref:`Variant` **track_get_key_value**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) |const| Returns the value of a given key in a given track. @@ -1105,7 +1107,7 @@ Returns the value of a given key in a given track. .. rst-class:: classref-method -:ref:`NodePath` **track_get_path** **(** :ref:`int` track_idx **)** |const| +:ref:`NodePath` **track_get_path**\ (\ track_idx\: :ref:`int`\ ) |const| Gets the path of a track. For more information on the path format, see :ref:`track_set_path`. @@ -1117,7 +1119,7 @@ Gets the path of a track. For more information on the path format, see :ref:`tra .. rst-class:: classref-method -:ref:`TrackType` **track_get_type** **(** :ref:`int` track_idx **)** |const| +:ref:`TrackType` **track_get_type**\ (\ track_idx\: :ref:`int`\ ) |const| Gets the type of a track. @@ -1129,7 +1131,7 @@ Gets the type of a track. .. rst-class:: classref-method -:ref:`int` **track_insert_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** +:ref:`int` **track_insert_key**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`, key\: :ref:`Variant`, transition\: :ref:`float` = 1\ ) Inserts a generic key in a given track. Returns the key index. @@ -1141,7 +1143,7 @@ Inserts a generic key in a given track. Returns the key index. .. rst-class:: classref-method -:ref:`bool` **track_is_compressed** **(** :ref:`int` track_idx **)** |const| +:ref:`bool` **track_is_compressed**\ (\ track_idx\: :ref:`int`\ ) |const| Returns ``true`` if the track is compressed, ``false`` otherwise. See also :ref:`compress`. @@ -1153,7 +1155,7 @@ Returns ``true`` if the track is compressed, ``false`` otherwise. See also :ref: .. rst-class:: classref-method -:ref:`bool` **track_is_enabled** **(** :ref:`int` track_idx **)** |const| +:ref:`bool` **track_is_enabled**\ (\ track_idx\: :ref:`int`\ ) |const| Returns ``true`` if the track at index ``track_idx`` is enabled. @@ -1165,7 +1167,7 @@ Returns ``true`` if the track at index ``track_idx`` is enabled. .. rst-class:: classref-method -:ref:`bool` **track_is_imported** **(** :ref:`int` track_idx **)** |const| +:ref:`bool` **track_is_imported**\ (\ track_idx\: :ref:`int`\ ) |const| Returns ``true`` if the given track is imported. Else, return ``false``. @@ -1177,7 +1179,7 @@ Returns ``true`` if the given track is imported. Else, return ``false``. .. rst-class:: classref-method -void **track_move_down** **(** :ref:`int` track_idx **)** +|void| **track_move_down**\ (\ track_idx\: :ref:`int`\ ) Moves a track down. @@ -1189,7 +1191,7 @@ Moves a track down. .. rst-class:: classref-method -void **track_move_to** **(** :ref:`int` track_idx, :ref:`int` to_idx **)** +|void| **track_move_to**\ (\ track_idx\: :ref:`int`, to_idx\: :ref:`int`\ ) Changes the index position of track ``track_idx`` to the one defined in ``to_idx``. @@ -1201,7 +1203,7 @@ Changes the index position of track ``track_idx`` to the one defined in ``to_idx .. rst-class:: classref-method -void **track_move_up** **(** :ref:`int` track_idx **)** +|void| **track_move_up**\ (\ track_idx\: :ref:`int`\ ) Moves a track up. @@ -1213,7 +1215,7 @@ Moves a track up. .. rst-class:: classref-method -void **track_remove_key** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** +|void| **track_remove_key**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`\ ) Removes a key by index in a given track. @@ -1225,7 +1227,7 @@ Removes a key by index in a given track. .. rst-class:: classref-method -void **track_remove_key_at_time** **(** :ref:`int` track_idx, :ref:`float` time **)** +|void| **track_remove_key_at_time**\ (\ track_idx\: :ref:`int`, time\: :ref:`float`\ ) Removes a key at ``time`` in a given track. @@ -1237,7 +1239,7 @@ Removes a key at ``time`` in a given track. .. rst-class:: classref-method -void **track_set_enabled** **(** :ref:`int` track_idx, :ref:`bool` enabled **)** +|void| **track_set_enabled**\ (\ track_idx\: :ref:`int`, enabled\: :ref:`bool`\ ) Enables/disables the given track. Tracks are enabled by default. @@ -1249,7 +1251,7 @@ Enables/disables the given track. Tracks are enabled by default. .. rst-class:: classref-method -void **track_set_imported** **(** :ref:`int` track_idx, :ref:`bool` imported **)** +|void| **track_set_imported**\ (\ track_idx\: :ref:`int`, imported\: :ref:`bool`\ ) Sets the given track as imported or not. @@ -1261,7 +1263,7 @@ Sets the given track as imported or not. .. rst-class:: classref-method -void **track_set_interpolation_loop_wrap** **(** :ref:`int` track_idx, :ref:`bool` interpolation **)** +|void| **track_set_interpolation_loop_wrap**\ (\ track_idx\: :ref:`int`, interpolation\: :ref:`bool`\ ) If ``true``, the track at ``track_idx`` wraps the interpolation loop. @@ -1273,7 +1275,7 @@ If ``true``, the track at ``track_idx`` wraps the interpolation loop. .. rst-class:: classref-method -void **track_set_interpolation_type** **(** :ref:`int` track_idx, :ref:`InterpolationType` interpolation **)** +|void| **track_set_interpolation_type**\ (\ track_idx\: :ref:`int`, interpolation\: :ref:`InterpolationType`\ ) Sets the interpolation type of a given track. @@ -1285,7 +1287,7 @@ Sets the interpolation type of a given track. .. rst-class:: classref-method -void **track_set_key_time** **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`float` time **)** +|void| **track_set_key_time**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, time\: :ref:`float`\ ) Sets the time of an existing key. @@ -1297,7 +1299,7 @@ Sets the time of an existing key. .. rst-class:: classref-method -void **track_set_key_transition** **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`float` transition **)** +|void| **track_set_key_transition**\ (\ track_idx\: :ref:`int`, key_idx\: :ref:`int`, transition\: :ref:`float`\ ) Sets the transition curve (easing) for a specific key (see the built-in math function :ref:`@GlobalScope.ease`). @@ -1309,7 +1311,7 @@ Sets the transition curve (easing) for a specific key (see the built-in math fun .. rst-class:: classref-method -void **track_set_key_value** **(** :ref:`int` track_idx, :ref:`int` key, :ref:`Variant` value **)** +|void| **track_set_key_value**\ (\ track_idx\: :ref:`int`, key\: :ref:`int`, value\: :ref:`Variant`\ ) Sets the value of an existing key. @@ -1321,7 +1323,7 @@ Sets the value of an existing key. .. rst-class:: classref-method -void **track_set_path** **(** :ref:`int` track_idx, :ref:`NodePath` path **)** +|void| **track_set_path**\ (\ track_idx\: :ref:`int`, path\: :ref:`NodePath`\ ) Sets the path of a track. Paths must be valid scene-tree paths to a node and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ``":"``. @@ -1335,7 +1337,7 @@ For example, ``"character/skeleton:ankle"`` or ``"character/mesh:transform/local .. rst-class:: classref-method -void **track_swap** **(** :ref:`int` track_idx, :ref:`int` with_idx **)** +|void| **track_swap**\ (\ track_idx\: :ref:`int`, with_idx\: :ref:`int`\ ) Swaps the track ``track_idx``'s index position with the track ``with_idx``. @@ -1347,7 +1349,7 @@ Swaps the track ``track_idx``'s index position with the track ``with_idx``. .. rst-class:: classref-method -:ref:`UpdateMode` **value_track_get_update_mode** **(** :ref:`int` track_idx **)** |const| +:ref:`UpdateMode` **value_track_get_update_mode**\ (\ track_idx\: :ref:`int`\ ) |const| Returns the update mode of a value track. @@ -1359,7 +1361,7 @@ Returns the update mode of a value track. .. rst-class:: classref-method -:ref:`Variant` **value_track_interpolate** **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| +:ref:`Variant` **value_track_interpolate**\ (\ track_idx\: :ref:`int`, time_sec\: :ref:`float`, backward\: :ref:`bool` = false\ ) |const| Returns the interpolated value at the given time (in seconds). The ``track_idx`` must be the index of a value track. @@ -1371,7 +1373,7 @@ Returns the interpolated value at the given time (in seconds). The ``track_idx`` .. rst-class:: classref-method -void **value_track_set_update_mode** **(** :ref:`int` track_idx, :ref:`UpdateMode` mode **)** +|void| **value_track_set_update_mode**\ (\ track_idx\: :ref:`int`, mode\: :ref:`UpdateMode`\ ) Sets the update mode (see :ref:`UpdateMode`) of a value track. @@ -1382,3 +1384,4 @@ Sets the update mode (see :ref:`UpdateMode`) of a val .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationlibrary.rst b/classes/class_animationlibrary.rst index 3352195f83c..6a2d6d212ba 100644 --- a/classes/class_animationlibrary.rst +++ b/classes/class_animationlibrary.rst @@ -36,19 +36,19 @@ Methods .. table:: :widths: auto - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`add_animation` **(** :ref:`StringName` name, :ref:`Animation` animation **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Animation` | :ref:`get_animation` **(** :ref:`StringName` name **)** |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName[]` | :ref:`get_animation_list` **(** **)** |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_animation` **(** :ref:`StringName` name **)** |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_animation` **(** :ref:`StringName` name **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rename_animation` **(** :ref:`StringName` name, :ref:`StringName` newname **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`add_animation`\ (\ name\: :ref:`StringName`, animation\: :ref:`Animation`\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Animation` | :ref:`get_animation`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`StringName`\] | :ref:`get_animation_list`\ (\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_animation`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_animation`\ (\ name\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rename_animation`\ (\ name\: :ref:`StringName`, newname\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -63,7 +63,7 @@ Signals .. rst-class:: classref-signal -**animation_added** **(** :ref:`StringName` name **)** +**animation_added**\ (\ name\: :ref:`StringName`\ ) Emitted when an :ref:`Animation` is added, under the key ``name``. @@ -75,7 +75,7 @@ Emitted when an :ref:`Animation` is added, under the key ``name .. rst-class:: classref-signal -**animation_changed** **(** :ref:`StringName` name **)** +**animation_changed**\ (\ name\: :ref:`StringName`\ ) Emitted when there's a change in one of the animations, e.g. tracks are added, moved or have changed paths. ``name`` is the key of the animation that was changed. @@ -89,7 +89,7 @@ See also :ref:`Resource.changed`, which this acts .. rst-class:: classref-signal -**animation_removed** **(** :ref:`StringName` name **)** +**animation_removed**\ (\ name\: :ref:`StringName`\ ) Emitted when an :ref:`Animation` stored with the key ``name`` is removed. @@ -101,7 +101,7 @@ Emitted when an :ref:`Animation` stored with the key ``name`` i .. rst-class:: classref-signal -**animation_renamed** **(** :ref:`StringName` name, :ref:`StringName` to_name **)** +**animation_renamed**\ (\ name\: :ref:`StringName`, to_name\: :ref:`StringName`\ ) Emitted when the key for an :ref:`Animation` is changed, from ``name`` to ``to_name``. @@ -118,7 +118,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **add_animation** **(** :ref:`StringName` name, :ref:`Animation` animation **)** +:ref:`Error` **add_animation**\ (\ name\: :ref:`StringName`, animation\: :ref:`Animation`\ ) Adds the ``animation`` to the library, accessible by the key ``name``. @@ -130,7 +130,7 @@ Adds the ``animation`` to the library, accessible by the key ``name``. .. rst-class:: classref-method -:ref:`Animation` **get_animation** **(** :ref:`StringName` name **)** |const| +:ref:`Animation` **get_animation**\ (\ name\: :ref:`StringName`\ ) |const| Returns the :ref:`Animation` with the key ``name``. If the animation does not exist, ``null`` is returned and an error is logged. @@ -142,7 +142,7 @@ Returns the :ref:`Animation` with the key ``name``. If the anim .. rst-class:: classref-method -:ref:`StringName[]` **get_animation_list** **(** **)** |const| +:ref:`Array`\[:ref:`StringName`\] **get_animation_list**\ (\ ) |const| Returns the keys for the :ref:`Animation`\ s stored in the library. @@ -154,7 +154,7 @@ Returns the keys for the :ref:`Animation`\ s stored in the libr .. rst-class:: classref-method -:ref:`bool` **has_animation** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_animation**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if the library stores an :ref:`Animation` with ``name`` as the key. @@ -166,7 +166,7 @@ Returns ``true`` if the library stores an :ref:`Animation` with .. rst-class:: classref-method -void **remove_animation** **(** :ref:`StringName` name **)** +|void| **remove_animation**\ (\ name\: :ref:`StringName`\ ) Removes the :ref:`Animation` with the key ``name``. @@ -178,7 +178,7 @@ Removes the :ref:`Animation` with the key ``name``. .. rst-class:: classref-method -void **rename_animation** **(** :ref:`StringName` name, :ref:`StringName` newname **)** +|void| **rename_animation**\ (\ name\: :ref:`StringName`, newname\: :ref:`StringName`\ ) Changes the key of the :ref:`Animation` associated with the key ``name`` to ``newname``. @@ -189,3 +189,4 @@ Changes the key of the :ref:`Animation` associated with the key .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationmixer.rst b/classes/class_animationmixer.rst index 8f2d3bde243..11bd9505e9a 100644 --- a/classes/class_animationmixer.rst +++ b/classes/class_animationmixer.rst @@ -33,23 +33,25 @@ Properties .. table:: :widths: auto - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------+ - | :ref:`bool` | :ref:`active` | ``true`` | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------+ - | :ref:`int` | :ref:`audio_max_polyphony` | ``32`` | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------+ - | :ref:`AnimationCallbackModeMethod` | :ref:`callback_mode_method` | ``0`` | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------+ - | :ref:`AnimationCallbackModeProcess` | :ref:`callback_mode_process` | ``1`` | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------+ - | :ref:`bool` | :ref:`deterministic` | ``false`` | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------+ - | :ref:`bool` | :ref:`reset_on_save` | ``true`` | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------+ - | :ref:`NodePath` | :ref:`root_motion_track` | ``NodePath("")`` | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------+ - | :ref:`NodePath` | :ref:`root_node` | ``NodePath("..")`` | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------+ + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+ + | :ref:`bool` | :ref:`active` | ``true`` | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+ + | :ref:`int` | :ref:`audio_max_polyphony` | ``32`` | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+ + | :ref:`AnimationCallbackModeDiscrete` | :ref:`callback_mode_discrete` | ``0`` | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+ + | :ref:`AnimationCallbackModeMethod` | :ref:`callback_mode_method` | ``0`` | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+ + | :ref:`AnimationCallbackModeProcess` | :ref:`callback_mode_process` | ``1`` | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+ + | :ref:`bool` | :ref:`deterministic` | ``false`` | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+ + | :ref:`bool` | :ref:`reset_on_save` | ``true`` | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+ + | :ref:`NodePath` | :ref:`root_motion_track` | ``NodePath("")`` | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+ + | :ref:`NodePath` | :ref:`root_node` | ``NodePath("..")`` | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+ .. rst-class:: classref-reftable-group @@ -59,49 +61,49 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_post_process_key_value` **(** :ref:`Animation` animation, :ref:`int` track, :ref:`Variant` value, :ref:`int` object_id, :ref:`int` object_sub_idx **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`add_animation_library` **(** :ref:`StringName` name, :ref:`AnimationLibrary` library **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`advance` **(** :ref:`float` delta **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`capture` **(** :ref:`StringName` name, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=0 **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_caches` **(** **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`find_animation` **(** :ref:`Animation` animation **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`find_animation_library` **(** :ref:`Animation` animation **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Animation` | :ref:`get_animation` **(** :ref:`StringName` name **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AnimationLibrary` | :ref:`get_animation_library` **(** :ref:`StringName` name **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName[]` | :ref:`get_animation_library_list` **(** **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_animation_list` **(** **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_root_motion_position` **(** **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_root_motion_position_accumulator` **(** **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`get_root_motion_rotation` **(** **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`get_root_motion_rotation_accumulator` **(** **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_root_motion_scale` **(** **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_root_motion_scale_accumulator` **(** **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_animation` **(** :ref:`StringName` name **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_animation_library` **(** :ref:`StringName` name **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_animation_library` **(** :ref:`StringName` name **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rename_animation_library` **(** :ref:`StringName` name, :ref:`StringName` newname **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_post_process_key_value`\ (\ animation\: :ref:`Animation`, track\: :ref:`int`, value\: :ref:`Variant`, object_id\: :ref:`int`, object_sub_idx\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`add_animation_library`\ (\ name\: :ref:`StringName`, library\: :ref:`AnimationLibrary`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`advance`\ (\ delta\: :ref:`float`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`capture`\ (\ name\: :ref:`StringName`, duration\: :ref:`float`, trans_type\: :ref:`TransitionType` = 0, ease_type\: :ref:`EaseType` = 0\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_caches`\ (\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`find_animation`\ (\ animation\: :ref:`Animation`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`find_animation_library`\ (\ animation\: :ref:`Animation`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Animation` | :ref:`get_animation`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AnimationLibrary` | :ref:`get_animation_library`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`StringName`\] | :ref:`get_animation_library_list`\ (\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_animation_list`\ (\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_root_motion_position`\ (\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_root_motion_position_accumulator`\ (\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`get_root_motion_rotation`\ (\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`get_root_motion_rotation_accumulator`\ (\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_root_motion_scale`\ (\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_root_motion_scale_accumulator`\ (\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_animation`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_animation_library`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_animation_library`\ (\ name\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rename_animation_library`\ (\ name\: :ref:`StringName`, newname\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -116,7 +118,7 @@ Signals .. rst-class:: classref-signal -**animation_finished** **(** :ref:`StringName` anim_name **)** +**animation_finished**\ (\ anim_name\: :ref:`StringName`\ ) Notifies when an animation finished playing. @@ -130,7 +132,7 @@ Notifies when an animation finished playing. .. rst-class:: classref-signal -**animation_libraries_updated** **(** **)** +**animation_libraries_updated**\ (\ ) Notifies when the animation libraries have changed. @@ -142,7 +144,7 @@ Notifies when the animation libraries have changed. .. rst-class:: classref-signal -**animation_list_changed** **(** **)** +**animation_list_changed**\ (\ ) Notifies when an animation list is changed. @@ -154,7 +156,7 @@ Notifies when an animation list is changed. .. rst-class:: classref-signal -**animation_started** **(** :ref:`StringName` anim_name **)** +**animation_started**\ (\ anim_name\: :ref:`StringName`\ ) Notifies when an animation starts playing. @@ -166,7 +168,7 @@ Notifies when an animation starts playing. .. rst-class:: classref-signal -**caches_cleared** **(** **)** +**caches_cleared**\ (\ ) Notifies when the caches have been cleared, either automatically, or manually via :ref:`clear_caches`. @@ -178,7 +180,7 @@ Notifies when the caches have been cleared, either automatically, or manually vi .. rst-class:: classref-signal -**mixer_updated** **(** **)** +**mixer_updated**\ (\ ) Editor only. Notifies when the property have been updated to update dummy :ref:`AnimationPlayer` in animation player editor. @@ -247,6 +249,42 @@ Batch method calls during the animation process, then do the calls after events Make method calls immediately when reached in the animation. +.. rst-class:: classref-item-separator + +---- + +.. _enum_AnimationMixer_AnimationCallbackModeDiscrete: + +.. rst-class:: classref-enumeration + +enum **AnimationCallbackModeDiscrete**: + +.. _class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_DISCRETE_DOMINANT: + +.. rst-class:: classref-enumeration-constant + +:ref:`AnimationCallbackModeDiscrete` **ANIMATION_CALLBACK_MODE_DISCRETE_DOMINANT** = ``0`` + +An :ref:`Animation.UPDATE_DISCRETE` track value takes precedence when blending :ref:`Animation.UPDATE_CONTINUOUS` or :ref:`Animation.UPDATE_CAPTURE` track values and :ref:`Animation.UPDATE_DISCRETE` track values. This is the default behavior for :ref:`AnimationPlayer`. + +\ **Note:** If a value track has non-numeric type key values, it is internally converted to use :ref:`ANIMATION_CALLBACK_MODE_DISCRETE_DOMINANT` with :ref:`Animation.UPDATE_DISCRETE`. + +.. _class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_DISCRETE_RECESSIVE: + +.. rst-class:: classref-enumeration-constant + +:ref:`AnimationCallbackModeDiscrete` **ANIMATION_CALLBACK_MODE_DISCRETE_RECESSIVE** = ``1`` + +An :ref:`Animation.UPDATE_CONTINUOUS` or :ref:`Animation.UPDATE_CAPTURE` track value takes precedence when blending the :ref:`Animation.UPDATE_CONTINUOUS` or :ref:`Animation.UPDATE_CAPTURE` track values and the :ref:`Animation.UPDATE_DISCRETE` track values. + +.. _class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_DISCRETE_FORCE_CONTINUOUS: + +.. rst-class:: classref-enumeration-constant + +:ref:`AnimationCallbackModeDiscrete` **ANIMATION_CALLBACK_MODE_DISCRETE_FORCE_CONTINUOUS** = ``2`` + +Always treat the :ref:`Animation.UPDATE_DISCRETE` track value as :ref:`Animation.UPDATE_CONTINUOUS` with :ref:`Animation.INTERPOLATION_NEAREST`. This is the default behavior for :ref:`AnimationTree`. + .. rst-class:: classref-section-separator ---- @@ -264,8 +302,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_active** **(** :ref:`bool` value **)** -- :ref:`bool` **is_active** **(** **)** +- |void| **set_active**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_active**\ (\ ) If ``true``, the **AnimationMixer** will be processing. @@ -281,8 +319,8 @@ If ``true``, the **AnimationMixer** will be processing. .. rst-class:: classref-property-setget -- void **set_audio_max_polyphony** **(** :ref:`int` value **)** -- :ref:`int` **get_audio_max_polyphony** **(** **)** +- |void| **set_audio_max_polyphony**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_audio_max_polyphony**\ (\ ) The number of possible simultaneous sounds for each of the assigned AudioStreamPlayers. @@ -292,6 +330,27 @@ For example, if this value is ``32`` and the animation has two audio tracks, the ---- +.. _class_AnimationMixer_property_callback_mode_discrete: + +.. rst-class:: classref-property + +:ref:`AnimationCallbackModeDiscrete` **callback_mode_discrete** = ``0`` + +.. rst-class:: classref-property-setget + +- |void| **set_callback_mode_discrete**\ (\ value\: :ref:`AnimationCallbackModeDiscrete`\ ) +- :ref:`AnimationCallbackModeDiscrete` **get_callback_mode_discrete**\ (\ ) + +Ordinarily, tracks can be set to :ref:`Animation.UPDATE_DISCRETE` to update infrequently, usually when using nearest interpolation. + +However, when blending with :ref:`Animation.UPDATE_CONTINUOUS` several results are considered. The :ref:`callback_mode_discrete` specify it explicitly. See also :ref:`AnimationCallbackModeDiscrete`. + +To make the blended results look good, it is recommended to set this to :ref:`ANIMATION_CALLBACK_MODE_DISCRETE_FORCE_CONTINUOUS` to update every frame during blending. Other values exist for compatibility and they are fine if there is no blending, but not so, may produce artifacts. + +.. rst-class:: classref-item-separator + +---- + .. _class_AnimationMixer_property_callback_mode_method: .. rst-class:: classref-property @@ -300,10 +359,10 @@ For example, if this value is ``32`` and the animation has two audio tracks, the .. rst-class:: classref-property-setget -- void **set_callback_mode_method** **(** :ref:`AnimationCallbackModeMethod` value **)** -- :ref:`AnimationCallbackModeMethod` **get_callback_mode_method** **(** **)** +- |void| **set_callback_mode_method**\ (\ value\: :ref:`AnimationCallbackModeMethod`\ ) +- :ref:`AnimationCallbackModeMethod` **get_callback_mode_method**\ (\ ) -The call mode to use for Call Method tracks. +The call mode used for "Call Method" tracks. .. rst-class:: classref-item-separator @@ -317,8 +376,8 @@ The call mode to use for Call Method tracks. .. rst-class:: classref-property-setget -- void **set_callback_mode_process** **(** :ref:`AnimationCallbackModeProcess` value **)** -- :ref:`AnimationCallbackModeProcess` **get_callback_mode_process** **(** **)** +- |void| **set_callback_mode_process**\ (\ value\: :ref:`AnimationCallbackModeProcess`\ ) +- :ref:`AnimationCallbackModeProcess` **get_callback_mode_process**\ (\ ) The process notification in which to update animations. @@ -334,8 +393,8 @@ The process notification in which to update animations. .. rst-class:: classref-property-setget -- void **set_deterministic** **(** :ref:`bool` value **)** -- :ref:`bool` **is_deterministic** **(** **)** +- |void| **set_deterministic**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_deterministic**\ (\ ) If ``true``, the blending uses the deterministic algorithm. The total weight is not normalized and the result is accumulated with an initial value (``0`` or a ``"RESET"`` animation if present). @@ -361,8 +420,8 @@ For example, if :ref:`AnimationNodeAdd2` blends two nod .. rst-class:: classref-property-setget -- void **set_reset_on_save_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_reset_on_save_enabled** **(** **)** +- |void| **set_reset_on_save_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_reset_on_save_enabled**\ (\ ) This is used by the editor. If set to ``true``, the scene will be saved with the effects of the reset animation (the animation with the key ``"RESET"``) applied as if it had been seeked to time 0, with the editor keeping the values that the scene had before saving. @@ -380,8 +439,8 @@ This makes it more convenient to preview and edit animations in the editor, as c .. rst-class:: classref-property-setget -- void **set_root_motion_track** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_root_motion_track** **(** **)** +- |void| **set_root_motion_track**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_root_motion_track**\ (\ ) The path to the Animation track used for root motion. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. To specify a track that controls properties or bones, append its name after the path, separated by ``":"``. For example, ``"character/skeleton:ankle"`` or ``"character/mesh:transform/local"``. @@ -399,10 +458,10 @@ If the track has type :ref:`Animation.TYPE_POSITION_3D` value **)** -- :ref:`NodePath` **get_root_node** **(** **)** +- |void| **set_root_node**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_root_node**\ (\ ) -The node from which node path references will travel. +The node which node path references will travel from. .. rst-class:: classref-section-separator @@ -417,7 +476,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **_post_process_key_value** **(** :ref:`Animation` animation, :ref:`int` track, :ref:`Variant` value, :ref:`int` object_id, :ref:`int` object_sub_idx **)** |virtual| |const| +:ref:`Variant` **_post_process_key_value**\ (\ animation\: :ref:`Animation`, track\: :ref:`int`, value\: :ref:`Variant`, object_id\: :ref:`int`, object_sub_idx\: :ref:`int`\ ) |virtual| |const| A virtual function for processing after getting a key during playback. @@ -429,7 +488,7 @@ A virtual function for processing after getting a key during playback. .. rst-class:: classref-method -:ref:`Error` **add_animation_library** **(** :ref:`StringName` name, :ref:`AnimationLibrary` library **)** +:ref:`Error` **add_animation_library**\ (\ name\: :ref:`StringName`, library\: :ref:`AnimationLibrary`\ ) Adds ``library`` to the animation player, under the key ``name``. @@ -441,7 +500,7 @@ Adds ``library`` to the animation player, under the key ``name``. .. rst-class:: classref-method -void **advance** **(** :ref:`float` delta **)** +|void| **advance**\ (\ delta\: :ref:`float`\ ) Manually advance the animations by the specified time (in seconds). @@ -453,7 +512,7 @@ Manually advance the animations by the specified time (in seconds). .. rst-class:: classref-method -void **capture** **(** :ref:`StringName` name, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=0 **)** +|void| **capture**\ (\ name\: :ref:`StringName`, duration\: :ref:`float`, trans_type\: :ref:`TransitionType` = 0, ease_type\: :ref:`EaseType` = 0\ ) If the animation track specified by ``name`` has an option :ref:`Animation.UPDATE_CAPTURE`, stores current values of the objects indicated by the track path as a cache. If there is already a captured cache, the old cache is discarded. @@ -469,7 +528,7 @@ You can specify ``trans_type`` as the curve for the interpolation. For better re .. rst-class:: classref-method -void **clear_caches** **(** **)** +|void| **clear_caches**\ (\ ) **AnimationMixer** caches animated nodes. It may not notice if a node disappears; :ref:`clear_caches` forces it to update the cache again. @@ -481,7 +540,7 @@ void **clear_caches** **(** **)** .. rst-class:: classref-method -:ref:`StringName` **find_animation** **(** :ref:`Animation` animation **)** |const| +:ref:`StringName` **find_animation**\ (\ animation\: :ref:`Animation`\ ) |const| Returns the key of ``animation`` or an empty :ref:`StringName` if not found. @@ -493,7 +552,7 @@ Returns the key of ``animation`` or an empty :ref:`StringName` .. rst-class:: classref-method -:ref:`StringName` **find_animation_library** **(** :ref:`Animation` animation **)** |const| +:ref:`StringName` **find_animation_library**\ (\ animation\: :ref:`Animation`\ ) |const| Returns the key for the :ref:`AnimationLibrary` that contains ``animation`` or an empty :ref:`StringName` if not found. @@ -505,7 +564,7 @@ Returns the key for the :ref:`AnimationLibrary` that con .. rst-class:: classref-method -:ref:`Animation` **get_animation** **(** :ref:`StringName` name **)** |const| +:ref:`Animation` **get_animation**\ (\ name\: :ref:`StringName`\ ) |const| Returns the :ref:`Animation` with the key ``name``. If the animation does not exist, ``null`` is returned and an error is logged. @@ -517,7 +576,7 @@ Returns the :ref:`Animation` with the key ``name``. If the anim .. rst-class:: classref-method -:ref:`AnimationLibrary` **get_animation_library** **(** :ref:`StringName` name **)** |const| +:ref:`AnimationLibrary` **get_animation_library**\ (\ name\: :ref:`StringName`\ ) |const| Returns the first :ref:`AnimationLibrary` with key ``name`` or ``null`` if not found. @@ -531,7 +590,7 @@ To get the :ref:`AnimationPlayer`'s global animation libr .. rst-class:: classref-method -:ref:`StringName[]` **get_animation_library_list** **(** **)** |const| +:ref:`Array`\[:ref:`StringName`\] **get_animation_library_list**\ (\ ) |const| Returns the list of stored library keys. @@ -543,7 +602,7 @@ Returns the list of stored library keys. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_animation_list** **(** **)** |const| +:ref:`PackedStringArray` **get_animation_list**\ (\ ) |const| Returns the list of stored animation keys. @@ -555,7 +614,7 @@ Returns the list of stored animation keys. .. rst-class:: classref-method -:ref:`Vector3` **get_root_motion_position** **(** **)** |const| +:ref:`Vector3` **get_root_motion_position**\ (\ ) |const| Retrieve the motion delta of position with the :ref:`root_motion_track` as a :ref:`Vector3` that can be used elsewhere. @@ -607,7 +666,7 @@ By using this in combination with :ref:`get_root_motion_position_accumulator` **get_root_motion_position_accumulator** **(** **)** |const| +:ref:`Vector3` **get_root_motion_position_accumulator**\ (\ ) |const| Retrieve the blended value of the position tracks with the :ref:`root_motion_track` as a :ref:`Vector3` that can be used elsewhere. @@ -642,7 +701,7 @@ However, if the animation loops, an unintended discrete change may occur, so thi .. rst-class:: classref-method -:ref:`Quaternion` **get_root_motion_rotation** **(** **)** |const| +:ref:`Quaternion` **get_root_motion_rotation**\ (\ ) |const| Retrieve the motion delta of rotation with the :ref:`root_motion_track` as a :ref:`Quaternion` that can be used elsewhere. @@ -672,7 +731,7 @@ The most basic example is applying rotation to :ref:`CharacterBody3D` **get_root_motion_rotation_accumulator** **(** **)** |const| +:ref:`Quaternion` **get_root_motion_rotation_accumulator**\ (\ ) |const| Retrieve the blended value of the rotation tracks with the :ref:`root_motion_track` as a :ref:`Quaternion` that can be used elsewhere. @@ -709,7 +768,7 @@ However, if the animation loops, an unintended discrete change may occur, so thi .. rst-class:: classref-method -:ref:`Vector3` **get_root_motion_scale** **(** **)** |const| +:ref:`Vector3` **get_root_motion_scale**\ (\ ) |const| Retrieve the motion delta of scale with the :ref:`root_motion_track` as a :ref:`Vector3` that can be used elsewhere. @@ -745,7 +804,7 @@ The most basic example is applying scale to :ref:`CharacterBody3D` **get_root_motion_scale_accumulator** **(** **)** |const| +:ref:`Vector3` **get_root_motion_scale_accumulator**\ (\ ) |const| Retrieve the blended value of the scale tracks with the :ref:`root_motion_track` as a :ref:`Vector3` that can be used elsewhere. @@ -778,7 +837,7 @@ However, if the animation loops, an unintended discrete change may occur, so thi .. rst-class:: classref-method -:ref:`bool` **has_animation** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_animation**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if the :ref:`AnimationPlayer` stores an :ref:`Animation` with key ``name``. @@ -790,7 +849,7 @@ Returns ``true`` if the :ref:`AnimationPlayer` stores an .. rst-class:: classref-method -:ref:`bool` **has_animation_library** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_animation_library**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if the :ref:`AnimationPlayer` stores an :ref:`AnimationLibrary` with key ``name``. @@ -802,7 +861,7 @@ Returns ``true`` if the :ref:`AnimationPlayer` stores an .. rst-class:: classref-method -void **remove_animation_library** **(** :ref:`StringName` name **)** +|void| **remove_animation_library**\ (\ name\: :ref:`StringName`\ ) Removes the :ref:`AnimationLibrary` associated with the key ``name``. @@ -814,7 +873,7 @@ Removes the :ref:`AnimationLibrary` associated with the .. rst-class:: classref-method -void **rename_animation_library** **(** :ref:`StringName` name, :ref:`StringName` newname **)** +|void| **rename_animation_library**\ (\ name\: :ref:`StringName`, newname\: :ref:`StringName`\ ) Moves the :ref:`AnimationLibrary` associated with the key ``name`` to the key ``newname``. @@ -825,3 +884,4 @@ Moves the :ref:`AnimationLibrary` associated with the ke .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index 0ff11fb79b9..14476d307b9 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -52,49 +52,49 @@ Methods .. table:: :widths: auto - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_caption` **(** **)** |virtual| |const| | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AnimationNode` | :ref:`_get_child_by_name` **(** :ref:`StringName` name **)** |virtual| |const| | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_child_nodes` **(** **)** |virtual| |const| | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_parameter_default_value` **(** :ref:`StringName` parameter **)** |virtual| |const| | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`_get_parameter_list` **(** **)** |virtual| |const| | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_filter` **(** **)** |virtual| |const| | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_parameter_read_only` **(** :ref:`StringName` parameter **)** |virtual| |const| | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_process` **(** :ref:`float` time, :ref:`bool` seek, :ref:`bool` is_external_seeking, :ref:`bool` test_only **)** |virtual| |const| | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`add_input` **(** :ref:`String` name **)** | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`blend_animation` **(** :ref:`StringName` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`bool` is_external_seeking, :ref:`float` blend, :ref:`LoopedFlag` looped_flag=0 **)** | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`blend_input` **(** :ref:`int` input_index, :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 **)** | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`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 **)** | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find_input` **(** :ref:`String` name **)** |const| | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_input_count` **(** **)** |const| | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_input_name` **(** :ref:`int` input **)** |const| | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_parameter` **(** :ref:`StringName` name **)** |const| | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_path_filtered` **(** :ref:`NodePath` path **)** |const| | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_input` **(** :ref:`int` index **)** | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_filter_path` **(** :ref:`NodePath` path, :ref:`bool` enable **)** | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`set_input_name` **(** :ref:`int` input, :ref:`String` name **)** | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_parameter` **(** :ref:`StringName` name, :ref:`Variant` value **)** | - +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_caption`\ (\ ) |virtual| |const| | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AnimationNode` | :ref:`_get_child_by_name`\ (\ name\: :ref:`StringName`\ ) |virtual| |const| | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_child_nodes`\ (\ ) |virtual| |const| | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_parameter_default_value`\ (\ parameter\: :ref:`StringName`\ ) |virtual| |const| | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`_get_parameter_list`\ (\ ) |virtual| |const| | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_filter`\ (\ ) |virtual| |const| | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_parameter_read_only`\ (\ parameter\: :ref:`StringName`\ ) |virtual| |const| | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_process`\ (\ time\: :ref:`float`, seek\: :ref:`bool`, is_external_seeking\: :ref:`bool`, test_only\: :ref:`bool`\ ) |virtual| |const| | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`add_input`\ (\ name\: :ref:`String`\ ) | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`blend_animation`\ (\ animation\: :ref:`StringName`, time\: :ref:`float`, delta\: :ref:`float`, seeked\: :ref:`bool`, is_external_seeking\: :ref:`bool`, blend\: :ref:`float`, looped_flag\: :ref:`LoopedFlag` = 0\ ) | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`blend_input`\ (\ input_index\: :ref:`int`, time\: :ref:`float`, seek\: :ref:`bool`, is_external_seeking\: :ref:`bool`, blend\: :ref:`float`, filter\: :ref:`FilterAction` = 0, sync\: :ref:`bool` = true, test_only\: :ref:`bool` = false\ ) | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`blend_node`\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`, time\: :ref:`float`, seek\: :ref:`bool`, is_external_seeking\: :ref:`bool`, blend\: :ref:`float`, filter\: :ref:`FilterAction` = 0, sync\: :ref:`bool` = true, test_only\: :ref:`bool` = false\ ) | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find_input`\ (\ name\: :ref:`String`\ ) |const| | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_input_count`\ (\ ) |const| | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_input_name`\ (\ input\: :ref:`int`\ ) |const| | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_parameter`\ (\ name\: :ref:`StringName`\ ) |const| | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_path_filtered`\ (\ path\: :ref:`NodePath`\ ) |const| | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_input`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_filter_path`\ (\ path\: :ref:`NodePath`, enable\: :ref:`bool`\ ) | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`set_input_name`\ (\ input\: :ref:`int`, name\: :ref:`String`\ ) | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_parameter`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -109,7 +109,7 @@ Signals .. rst-class:: classref-signal -**animation_node_removed** **(** :ref:`int` object_id, :ref:`String` name **)** +**animation_node_removed**\ (\ object_id\: :ref:`int`, name\: :ref:`String`\ ) Emitted by nodes that inherit from this class and that have an internal tree when one of their animation nodes removes. The animation nodes that emit this signal are :ref:`AnimationNodeBlendSpace1D`, :ref:`AnimationNodeBlendSpace2D`, :ref:`AnimationNodeStateMachine`, and :ref:`AnimationNodeBlendTree`. @@ -121,7 +121,7 @@ Emitted by nodes that inherit from this class and that have an internal tree whe .. rst-class:: classref-signal -**animation_node_renamed** **(** :ref:`int` object_id, :ref:`String` old_name, :ref:`String` new_name **)** +**animation_node_renamed**\ (\ object_id\: :ref:`int`, old_name\: :ref:`String`, new_name\: :ref:`String`\ ) Emitted by nodes that inherit from this class and that have an internal tree when one of their animation node names changes. The animation nodes that emit this signal are :ref:`AnimationNodeBlendSpace1D`, :ref:`AnimationNodeBlendSpace2D`, :ref:`AnimationNodeStateMachine`, and :ref:`AnimationNodeBlendTree`. @@ -133,7 +133,7 @@ Emitted by nodes that inherit from this class and that have an internal tree whe .. rst-class:: classref-signal -**tree_changed** **(** **)** +**tree_changed**\ (\ ) Emitted by nodes that inherit from this class and that have an internal tree when one of their animation nodes changes. The animation nodes that emit this signal are :ref:`AnimationNodeBlendSpace1D`, :ref:`AnimationNodeBlendSpace2D`, :ref:`AnimationNodeStateMachine`, :ref:`AnimationNodeBlendTree` and :ref:`AnimationNodeTransition`. @@ -201,8 +201,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_filter_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_filter_enabled** **(** **)** +- |void| **set_filter_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_filter_enabled**\ (\ ) If ``true``, filtering is enabled. @@ -219,7 +219,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **_get_caption** **(** **)** |virtual| |const| +:ref:`String` **_get_caption**\ (\ ) |virtual| |const| When inheriting from :ref:`AnimationRootNode`, implement this virtual method to override the text caption for this animation node. @@ -231,7 +231,7 @@ When inheriting from :ref:`AnimationRootNode`, implemen .. rst-class:: classref-method -:ref:`AnimationNode` **_get_child_by_name** **(** :ref:`StringName` name **)** |virtual| |const| +:ref:`AnimationNode` **_get_child_by_name**\ (\ name\: :ref:`StringName`\ ) |virtual| |const| When inheriting from :ref:`AnimationRootNode`, implement this virtual method to return a child animation node by its ``name``. @@ -243,7 +243,7 @@ When inheriting from :ref:`AnimationRootNode`, implemen .. rst-class:: classref-method -:ref:`Dictionary` **_get_child_nodes** **(** **)** |virtual| |const| +: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. @@ -255,7 +255,7 @@ When inheriting from :ref:`AnimationRootNode`, implemen .. rst-class:: classref-method -:ref:`Variant` **_get_parameter_default_value** **(** :ref:`StringName` parameter **)** |virtual| |const| +:ref:`Variant` **_get_parameter_default_value**\ (\ parameter\: :ref:`StringName`\ ) |virtual| |const| When inheriting from :ref:`AnimationRootNode`, implement this virtual method to return the default value of a ``parameter``. Parameters are custom local memory used for your animation nodes, given a resource can be reused in multiple trees. @@ -267,7 +267,7 @@ When inheriting from :ref:`AnimationRootNode`, implemen .. rst-class:: classref-method -:ref:`Array` **_get_parameter_list** **(** **)** |virtual| |const| +:ref:`Array` **_get_parameter_list**\ (\ ) |virtual| |const| When inheriting from :ref:`AnimationRootNode`, implement this virtual method to return a list of the properties on this animation node. Parameters are custom local memory used for your animation nodes, given a resource can be reused in multiple trees. Format is similar to :ref:`Object.get_property_list`. @@ -279,7 +279,7 @@ When inheriting from :ref:`AnimationRootNode`, implemen .. rst-class:: classref-method -:ref:`bool` **_has_filter** **(** **)** |virtual| |const| +:ref:`bool` **_has_filter**\ (\ ) |virtual| |const| When inheriting from :ref:`AnimationRootNode`, implement this virtual method to return whether the blend tree editor should display filter editing on this animation node. @@ -291,7 +291,7 @@ When inheriting from :ref:`AnimationRootNode`, implemen .. rst-class:: classref-method -:ref:`bool` **_is_parameter_read_only** **(** :ref:`StringName` parameter **)** |virtual| |const| +:ref:`bool` **_is_parameter_read_only**\ (\ parameter\: :ref:`StringName`\ ) |virtual| |const| When inheriting from :ref:`AnimationRootNode`, implement this virtual method to return whether the ``parameter`` is read-only. Parameters are custom local memory used for your animation nodes, given a resource can be reused in multiple trees. @@ -303,7 +303,7 @@ When inheriting from :ref:`AnimationRootNode`, implemen .. rst-class:: classref-method -:ref:`float` **_process** **(** :ref:`float` time, :ref:`bool` seek, :ref:`bool` is_external_seeking, :ref:`bool` test_only **)** |virtual| |const| +:ref:`float` **_process**\ (\ time\: :ref:`float`, seek\: :ref:`bool`, is_external_seeking\: :ref:`bool`, test_only\: :ref:`bool`\ ) |virtual| |const| When inheriting from :ref:`AnimationRootNode`, implement this virtual method to run some code when this animation node is processed. The ``time`` parameter is a relative delta, unless ``seek`` is ``true``, in which case it is absolute. @@ -319,7 +319,7 @@ This function should return the time left for the current animation to finish (i .. rst-class:: classref-method -:ref:`bool` **add_input** **(** :ref:`String` name **)** +:ref:`bool` **add_input**\ (\ name\: :ref:`String`\ ) Adds an input to the animation node. This is only useful for animation nodes created for use in an :ref:`AnimationNodeBlendTree`. If the addition fails, returns ``false``. @@ -331,7 +331,7 @@ Adds an input to the animation node. This is only useful for animation nodes cre .. rst-class:: classref-method -void **blend_animation** **(** :ref:`StringName` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`bool` is_external_seeking, :ref:`float` blend, :ref:`LoopedFlag` looped_flag=0 **)** +|void| **blend_animation**\ (\ animation\: :ref:`StringName`, time\: :ref:`float`, delta\: :ref:`float`, seeked\: :ref:`bool`, is_external_seeking\: :ref:`bool`, blend\: :ref:`float`, looped_flag\: :ref:`LoopedFlag` = 0\ ) Blend an animation by ``blend`` amount (name must be valid in the linked :ref:`AnimationPlayer`). A ``time`` and ``delta`` may be passed, as well as whether ``seeked`` happened. @@ -345,7 +345,7 @@ A ``looped_flag`` is used by internal processing immediately after the loop. See .. rst-class:: classref-method -:ref:`float` **blend_input** **(** :ref:`int` input_index, :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 **)** +:ref:`float` **blend_input**\ (\ input_index\: :ref:`int`, time\: :ref:`float`, seek\: :ref:`bool`, is_external_seeking\: :ref:`bool`, blend\: :ref:`float`, filter\: :ref:`FilterAction` = 0, sync\: :ref:`bool` = true, test_only\: :ref:`bool` = false\ ) Blend an input. This is only useful for animation nodes created for an :ref:`AnimationNodeBlendTree`. The ``time`` parameter is a relative delta, unless ``seek`` is ``true``, in which case it is absolute. A filter mode may be optionally passed (see :ref:`FilterAction` for options). @@ -357,7 +357,7 @@ Blend an input. This is only useful for animation nodes created for an :ref:`Ani .. rst-class:: classref-method -: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 **)** +:ref:`float` **blend_node**\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`, time\: :ref:`float`, seek\: :ref:`bool`, is_external_seeking\: :ref:`bool`, blend\: :ref:`float`, filter\: :ref:`FilterAction` = 0, sync\: :ref:`bool` = true, test_only\: :ref:`bool` = 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. @@ -369,7 +369,7 @@ Blend another animation node (in case this animation node contains children anim .. rst-class:: classref-method -:ref:`int` **find_input** **(** :ref:`String` name **)** |const| +:ref:`int` **find_input**\ (\ name\: :ref:`String`\ ) |const| Returns the input index which corresponds to ``name``. If not found, returns ``-1``. @@ -381,7 +381,7 @@ Returns the input index which corresponds to ``name``. If not found, returns ``- .. rst-class:: classref-method -:ref:`int` **get_input_count** **(** **)** |const| +:ref:`int` **get_input_count**\ (\ ) |const| Amount of inputs in this animation node, only useful for animation nodes that go into :ref:`AnimationNodeBlendTree`. @@ -393,7 +393,7 @@ Amount of inputs in this animation node, only useful for animation nodes that go .. rst-class:: classref-method -:ref:`String` **get_input_name** **(** :ref:`int` input **)** |const| +:ref:`String` **get_input_name**\ (\ input\: :ref:`int`\ ) |const| Gets the name of an input by index. @@ -405,7 +405,7 @@ Gets the name of an input by index. .. rst-class:: classref-method -:ref:`Variant` **get_parameter** **(** :ref:`StringName` name **)** |const| +:ref:`Variant` **get_parameter**\ (\ name\: :ref:`StringName`\ ) |const| Gets the value of a parameter. Parameters are custom local memory used for your animation nodes, given a resource can be reused in multiple trees. @@ -417,7 +417,7 @@ Gets the value of a parameter. Parameters are custom local memory used for your .. rst-class:: classref-method -:ref:`bool` **is_path_filtered** **(** :ref:`NodePath` path **)** |const| +:ref:`bool` **is_path_filtered**\ (\ path\: :ref:`NodePath`\ ) |const| Returns whether the given path is filtered. @@ -429,7 +429,7 @@ Returns whether the given path is filtered. .. rst-class:: classref-method -void **remove_input** **(** :ref:`int` index **)** +|void| **remove_input**\ (\ index\: :ref:`int`\ ) Removes an input, call this only when inactive. @@ -441,7 +441,7 @@ Removes an input, call this only when inactive. .. rst-class:: classref-method -void **set_filter_path** **(** :ref:`NodePath` path, :ref:`bool` enable **)** +|void| **set_filter_path**\ (\ path\: :ref:`NodePath`, enable\: :ref:`bool`\ ) Adds or removes a path for the filter. @@ -453,7 +453,7 @@ Adds or removes a path for the filter. .. rst-class:: classref-method -:ref:`bool` **set_input_name** **(** :ref:`int` input, :ref:`String` name **)** +:ref:`bool` **set_input_name**\ (\ input\: :ref:`int`, name\: :ref:`String`\ ) Sets the name of the input at the given ``input`` index. If the setting fails, returns ``false``. @@ -465,7 +465,7 @@ Sets the name of the input at the given ``input`` index. If the setting fails, r .. rst-class:: classref-method -void **set_parameter** **(** :ref:`StringName` name, :ref:`Variant` value **)** +|void| **set_parameter**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) Sets a custom parameter. These are used as local memory, because resources can be reused across the tree or scenes. @@ -476,3 +476,4 @@ Sets a custom parameter. These are used as local memory, because resources can b .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnodeadd2.rst b/classes/class_animationnodeadd2.rst index 64a130851eb..c23b86a53bb 100644 --- a/classes/class_animationnodeadd2.rst +++ b/classes/class_animationnodeadd2.rst @@ -39,3 +39,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnodeadd3.rst b/classes/class_animationnodeadd3.rst index 47d014cfbeb..313bd91232c 100644 --- a/classes/class_animationnodeadd3.rst +++ b/classes/class_animationnodeadd3.rst @@ -47,3 +47,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnodeanimation.rst b/classes/class_animationnodeanimation.rst index 0402128cad7..46cee9bf212 100644 --- a/classes/class_animationnodeanimation.rst +++ b/classes/class_animationnodeanimation.rst @@ -94,8 +94,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_animation** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_animation** **(** **)** +- |void| **set_animation**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_animation**\ (\ ) Animation to use as an output. It is one of the animations provided by :ref:`AnimationTree.anim_player`. @@ -111,8 +111,8 @@ Animation to use as an output. It is one of the animations provided by :ref:`Ani .. rst-class:: classref-property-setget -- void **set_play_mode** **(** :ref:`PlayMode` value **)** -- :ref:`PlayMode` **get_play_mode** **(** **)** +- |void| **set_play_mode**\ (\ value\: :ref:`PlayMode`\ ) +- :ref:`PlayMode` **get_play_mode**\ (\ ) Determines the playback direction of the animation. @@ -123,3 +123,4 @@ Determines the playback direction of the animation. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnodeblend2.rst b/classes/class_animationnodeblend2.rst index f9cee33de6b..ca333217cc3 100644 --- a/classes/class_animationnodeblend2.rst +++ b/classes/class_animationnodeblend2.rst @@ -41,3 +41,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnodeblend3.rst b/classes/class_animationnodeblend3.rst index 67782a4afed..4b7837d7e5a 100644 --- a/classes/class_animationnodeblend3.rst +++ b/classes/class_animationnodeblend3.rst @@ -45,3 +45,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnodeblendspace1d.rst b/classes/class_animationnodeblendspace1d.rst index 6401bd1796b..186eb60bd6c 100644 --- a/classes/class_animationnodeblendspace1d.rst +++ b/classes/class_animationnodeblendspace1d.rst @@ -62,21 +62,21 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_blend_point` **(** :ref:`AnimationRootNode` node, :ref:`float` pos, :ref:`int` at_index=-1 **)** | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_blend_point_count` **(** **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AnimationRootNode` | :ref:`get_blend_point_node` **(** :ref:`int` point **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_blend_point_position` **(** :ref:`int` point **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_blend_point` **(** :ref:`int` point **)** | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_blend_point_node` **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_blend_point_position` **(** :ref:`int` point, :ref:`float` pos **)** | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_blend_point`\ (\ node\: :ref:`AnimationRootNode`, pos\: :ref:`float`, at_index\: :ref:`int` = -1\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_blend_point_count`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AnimationRootNode` | :ref:`get_blend_point_node`\ (\ point\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_blend_point_position`\ (\ point\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_blend_point`\ (\ point\: :ref:`int`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_blend_point_node`\ (\ point\: :ref:`int`, node\: :ref:`AnimationRootNode`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_blend_point_position`\ (\ point\: :ref:`int`, pos\: :ref:`float`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -134,8 +134,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_blend_mode** **(** :ref:`BlendMode` value **)** -- :ref:`BlendMode` **get_blend_mode** **(** **)** +- |void| **set_blend_mode**\ (\ value\: :ref:`BlendMode`\ ) +- :ref:`BlendMode` **get_blend_mode**\ (\ ) Controls the interpolation between animations. See :ref:`BlendMode` constants. @@ -151,8 +151,8 @@ Controls the interpolation between animations. See :ref:`BlendMode` value **)** -- :ref:`float` **get_max_space** **(** **)** +- |void| **set_max_space**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_max_space**\ (\ ) The blend space's axis's upper limit for the points' position. See :ref:`add_blend_point`. @@ -168,8 +168,8 @@ The blend space's axis's upper limit for the points' position. See :ref:`add_ble .. rst-class:: classref-property-setget -- void **set_min_space** **(** :ref:`float` value **)** -- :ref:`float` **get_min_space** **(** **)** +- |void| **set_min_space**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_min_space**\ (\ ) The blend space's axis's lower limit for the points' position. See :ref:`add_blend_point`. @@ -185,8 +185,8 @@ The blend space's axis's lower limit for the points' position. See :ref:`add_ble .. rst-class:: classref-property-setget -- void **set_snap** **(** :ref:`float` value **)** -- :ref:`float` **get_snap** **(** **)** +- |void| **set_snap**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_snap**\ (\ ) Position increment to snap to when moving a point on the axis. @@ -202,8 +202,8 @@ Position increment to snap to when moving a point on the axis. .. rst-class:: classref-property-setget -- void **set_use_sync** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_sync** **(** **)** +- |void| **set_use_sync**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_sync**\ (\ ) If ``false``, the blended animations' frame are stopped when the blend value is ``0``. @@ -221,8 +221,8 @@ If ``true``, forcing the blended animations to advance frame. .. rst-class:: classref-property-setget -- void **set_value_label** **(** :ref:`String` value **)** -- :ref:`String` **get_value_label** **(** **)** +- |void| **set_value_label**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_value_label**\ (\ ) Label of the virtual axis of the blend space. @@ -239,7 +239,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_blend_point** **(** :ref:`AnimationRootNode` node, :ref:`float` pos, :ref:`int` at_index=-1 **)** +|void| **add_blend_point**\ (\ node\: :ref:`AnimationRootNode`, pos\: :ref:`float`, at_index\: :ref:`int` = -1\ ) Adds a new point that represents a ``node`` on the virtual axis at a given position set by ``pos``. You can insert it at a specific index using the ``at_index`` argument. If you use the default value for ``at_index``, the point is inserted at the end of the blend points array. @@ -251,7 +251,7 @@ Adds a new point that represents a ``node`` on the virtual axis at a given posit .. rst-class:: classref-method -:ref:`int` **get_blend_point_count** **(** **)** |const| +:ref:`int` **get_blend_point_count**\ (\ ) |const| Returns the number of points on the blend axis. @@ -263,7 +263,7 @@ Returns the number of points on the blend axis. .. rst-class:: classref-method -:ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** |const| +:ref:`AnimationRootNode` **get_blend_point_node**\ (\ point\: :ref:`int`\ ) |const| Returns the :ref:`AnimationNode` referenced by the point at index ``point``. @@ -275,7 +275,7 @@ Returns the :ref:`AnimationNode` referenced by the point at .. rst-class:: classref-method -:ref:`float` **get_blend_point_position** **(** :ref:`int` point **)** |const| +:ref:`float` **get_blend_point_position**\ (\ point\: :ref:`int`\ ) |const| Returns the position of the point at index ``point``. @@ -287,7 +287,7 @@ Returns the position of the point at index ``point``. .. rst-class:: classref-method -void **remove_blend_point** **(** :ref:`int` point **)** +|void| **remove_blend_point**\ (\ point\: :ref:`int`\ ) Removes the point at index ``point`` from the blend axis. @@ -299,7 +299,7 @@ Removes the point at index ``point`` from the blend axis. .. rst-class:: classref-method -void **set_blend_point_node** **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** +|void| **set_blend_point_node**\ (\ point\: :ref:`int`, node\: :ref:`AnimationRootNode`\ ) Changes the :ref:`AnimationNode` referenced by the point at index ``point``. @@ -311,7 +311,7 @@ Changes the :ref:`AnimationNode` referenced by the point at .. rst-class:: classref-method -void **set_blend_point_position** **(** :ref:`int` point, :ref:`float` pos **)** +|void| **set_blend_point_position**\ (\ point\: :ref:`int`, pos\: :ref:`float`\ ) Updates the position of the point at index ``point`` on the blend axis. @@ -322,3 +322,4 @@ Updates the position of the point at index ``point`` on the blend axis. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnodeblendspace2d.rst b/classes/class_animationnodeblendspace2d.rst index 3c18fb7f6db..285ec23541d 100644 --- a/classes/class_animationnodeblendspace2d.rst +++ b/classes/class_animationnodeblendspace2d.rst @@ -68,29 +68,29 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_blend_point` **(** :ref:`AnimationRootNode` node, :ref:`Vector2` pos, :ref:`int` at_index=-1 **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_triangle` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` at_index=-1 **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_blend_point_count` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AnimationRootNode` | :ref:`get_blend_point_node` **(** :ref:`int` point **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_blend_point_position` **(** :ref:`int` point **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_triangle_count` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_triangle_point` **(** :ref:`int` triangle, :ref:`int` point **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_blend_point` **(** :ref:`int` point **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_triangle` **(** :ref:`int` triangle **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_blend_point_node` **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_blend_point_position` **(** :ref:`int` point, :ref:`Vector2` pos **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_blend_point`\ (\ node\: :ref:`AnimationRootNode`, pos\: :ref:`Vector2`, at_index\: :ref:`int` = -1\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_triangle`\ (\ x\: :ref:`int`, y\: :ref:`int`, z\: :ref:`int`, at_index\: :ref:`int` = -1\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_blend_point_count`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AnimationRootNode` | :ref:`get_blend_point_node`\ (\ point\: :ref:`int`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_blend_point_position`\ (\ point\: :ref:`int`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_triangle_count`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_triangle_point`\ (\ triangle\: :ref:`int`, point\: :ref:`int`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_blend_point`\ (\ point\: :ref:`int`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_triangle`\ (\ triangle\: :ref:`int`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_blend_point_node`\ (\ point\: :ref:`int`, node\: :ref:`AnimationRootNode`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_blend_point_position`\ (\ point\: :ref:`int`, pos\: :ref:`Vector2`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -105,7 +105,7 @@ Signals .. rst-class:: classref-signal -**triangles_updated** **(** **)** +**triangles_updated**\ (\ ) Emitted every time the blend space's triangles are created, removed, or when one of their vertices changes position. @@ -165,8 +165,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_auto_triangles** **(** :ref:`bool` value **)** -- :ref:`bool` **get_auto_triangles** **(** **)** +- |void| **set_auto_triangles**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_auto_triangles**\ (\ ) If ``true``, the blend space is triangulated automatically. The mesh updates every time you add or remove points with :ref:`add_blend_point` and :ref:`remove_blend_point`. @@ -182,8 +182,8 @@ If ``true``, the blend space is triangulated automatically. The mesh updates eve .. rst-class:: classref-property-setget -- void **set_blend_mode** **(** :ref:`BlendMode` value **)** -- :ref:`BlendMode` **get_blend_mode** **(** **)** +- |void| **set_blend_mode**\ (\ value\: :ref:`BlendMode`\ ) +- :ref:`BlendMode` **get_blend_mode**\ (\ ) Controls the interpolation between animations. See :ref:`BlendMode` constants. @@ -199,8 +199,8 @@ Controls the interpolation between animations. See :ref:`BlendMode` value **)** -- :ref:`Vector2` **get_max_space** **(** **)** +- |void| **set_max_space**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_max_space**\ (\ ) The blend space's X and Y axes' upper limit for the points' position. See :ref:`add_blend_point`. @@ -216,8 +216,8 @@ The blend space's X and Y axes' upper limit for the points' position. See :ref:` .. rst-class:: classref-property-setget -- void **set_min_space** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_min_space** **(** **)** +- |void| **set_min_space**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_min_space**\ (\ ) The blend space's X and Y axes' lower limit for the points' position. See :ref:`add_blend_point`. @@ -233,8 +233,8 @@ The blend space's X and Y axes' lower limit for the points' position. See :ref:` .. rst-class:: classref-property-setget -- void **set_snap** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_snap** **(** **)** +- |void| **set_snap**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_snap**\ (\ ) Position increment to snap to when moving a point. @@ -250,8 +250,8 @@ Position increment to snap to when moving a point. .. rst-class:: classref-property-setget -- void **set_use_sync** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_sync** **(** **)** +- |void| **set_use_sync**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_sync**\ (\ ) If ``false``, the blended animations' frame are stopped when the blend value is ``0``. @@ -269,8 +269,8 @@ If ``true``, forcing the blended animations to advance frame. .. rst-class:: classref-property-setget -- void **set_x_label** **(** :ref:`String` value **)** -- :ref:`String` **get_x_label** **(** **)** +- |void| **set_x_label**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_x_label**\ (\ ) Name of the blend space's X axis. @@ -286,8 +286,8 @@ Name of the blend space's X axis. .. rst-class:: classref-property-setget -- void **set_y_label** **(** :ref:`String` value **)** -- :ref:`String` **get_y_label** **(** **)** +- |void| **set_y_label**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_y_label**\ (\ ) Name of the blend space's Y axis. @@ -304,7 +304,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_blend_point** **(** :ref:`AnimationRootNode` node, :ref:`Vector2` pos, :ref:`int` at_index=-1 **)** +|void| **add_blend_point**\ (\ node\: :ref:`AnimationRootNode`, pos\: :ref:`Vector2`, at_index\: :ref:`int` = -1\ ) Adds a new point that represents a ``node`` at the position set by ``pos``. You can insert it at a specific index using the ``at_index`` argument. If you use the default value for ``at_index``, the point is inserted at the end of the blend points array. @@ -316,7 +316,7 @@ Adds a new point that represents a ``node`` at the position set by ``pos``. You .. rst-class:: classref-method -void **add_triangle** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` at_index=-1 **)** +|void| **add_triangle**\ (\ x\: :ref:`int`, y\: :ref:`int`, z\: :ref:`int`, at_index\: :ref:`int` = -1\ ) Creates a new triangle using three points ``x``, ``y``, and ``z``. Triangles can overlap. You can insert the triangle at a specific index using the ``at_index`` argument. If you use the default value for ``at_index``, the point is inserted at the end of the blend points array. @@ -328,7 +328,7 @@ Creates a new triangle using three points ``x``, ``y``, and ``z``. Triangles can .. rst-class:: classref-method -:ref:`int` **get_blend_point_count** **(** **)** |const| +:ref:`int` **get_blend_point_count**\ (\ ) |const| Returns the number of points in the blend space. @@ -340,7 +340,7 @@ Returns the number of points in the blend space. .. rst-class:: classref-method -:ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** |const| +:ref:`AnimationRootNode` **get_blend_point_node**\ (\ point\: :ref:`int`\ ) |const| Returns the :ref:`AnimationRootNode` referenced by the point at index ``point``. @@ -352,7 +352,7 @@ Returns the :ref:`AnimationRootNode` referenced by the .. rst-class:: classref-method -:ref:`Vector2` **get_blend_point_position** **(** :ref:`int` point **)** |const| +:ref:`Vector2` **get_blend_point_position**\ (\ point\: :ref:`int`\ ) |const| Returns the position of the point at index ``point``. @@ -364,7 +364,7 @@ Returns the position of the point at index ``point``. .. rst-class:: classref-method -:ref:`int` **get_triangle_count** **(** **)** |const| +:ref:`int` **get_triangle_count**\ (\ ) |const| Returns the number of triangles in the blend space. @@ -376,7 +376,7 @@ Returns the number of triangles in the blend space. .. rst-class:: classref-method -:ref:`int` **get_triangle_point** **(** :ref:`int` triangle, :ref:`int` point **)** +:ref:`int` **get_triangle_point**\ (\ triangle\: :ref:`int`, point\: :ref:`int`\ ) Returns the position of the point at index ``point`` in the triangle of index ``triangle``. @@ -388,7 +388,7 @@ Returns the position of the point at index ``point`` in the triangle of index `` .. rst-class:: classref-method -void **remove_blend_point** **(** :ref:`int` point **)** +|void| **remove_blend_point**\ (\ point\: :ref:`int`\ ) Removes the point at index ``point`` from the blend space. @@ -400,7 +400,7 @@ Removes the point at index ``point`` from the blend space. .. rst-class:: classref-method -void **remove_triangle** **(** :ref:`int` triangle **)** +|void| **remove_triangle**\ (\ triangle\: :ref:`int`\ ) Removes the triangle at index ``triangle`` from the blend space. @@ -412,7 +412,7 @@ Removes the triangle at index ``triangle`` from the blend space. .. rst-class:: classref-method -void **set_blend_point_node** **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** +|void| **set_blend_point_node**\ (\ point\: :ref:`int`, node\: :ref:`AnimationRootNode`\ ) Changes the :ref:`AnimationNode` referenced by the point at index ``point``. @@ -424,7 +424,7 @@ Changes the :ref:`AnimationNode` referenced by the point at .. rst-class:: classref-method -void **set_blend_point_position** **(** :ref:`int` point, :ref:`Vector2` pos **)** +|void| **set_blend_point_position**\ (\ point\: :ref:`int`, pos\: :ref:`Vector2`\ ) Updates the position of the point at index ``point`` on the blend axis. @@ -435,3 +435,4 @@ Updates the position of the point at index ``point`` on the blend axis. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnodeblendtree.rst b/classes/class_animationnodeblendtree.rst index 3f2678462c8..da7c6ca52b6 100644 --- a/classes/class_animationnodeblendtree.rst +++ b/classes/class_animationnodeblendtree.rst @@ -50,25 +50,25 @@ Methods .. table:: :widths: auto - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_node` **(** :ref:`StringName` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2(0, 0) **)** | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`connect_node` **(** :ref:`StringName` input_node, :ref:`int` input_index, :ref:`StringName` output_node **)** | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`disconnect_node` **(** :ref:`StringName` input_node, :ref:`int` input_index **)** | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`StringName` name **)** |const| | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`StringName` name **)** |const| | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_node` **(** :ref:`StringName` name **)** |const| | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_node` **(** :ref:`StringName` name **)** | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rename_node` **(** :ref:`StringName` name, :ref:`StringName` new_name **)** | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_node_position` **(** :ref:`StringName` name, :ref:`Vector2` position **)** | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_node`\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`connect_node`\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`, output_node\: :ref:`StringName`\ ) | + +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`disconnect_node`\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`\ ) | + +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AnimationNode` | :ref:`get_node`\ (\ name\: :ref:`StringName`\ ) |const| | + +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_node_position`\ (\ name\: :ref:`StringName`\ ) |const| | + +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_node`\ (\ name\: :ref:`StringName`\ ) |const| | + +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_node`\ (\ name\: :ref:`StringName`\ ) | + +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rename_node`\ (\ name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) | + +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_node_position`\ (\ name\: :ref:`StringName`, position\: :ref:`Vector2`\ ) | + +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -83,7 +83,7 @@ Signals .. rst-class:: classref-signal -**node_changed** **(** :ref:`StringName` node_name **)** +**node_changed**\ (\ node_name\: :ref:`StringName`\ ) Emitted when the input port information is changed. @@ -161,8 +161,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_graph_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_graph_offset** **(** **)** +- |void| **set_graph_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_graph_offset**\ (\ ) The global offset of all sub animation nodes. @@ -179,7 +179,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_node** **(** :ref:`StringName` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2(0, 0) **)** +|void| **add_node**\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) Adds an :ref:`AnimationNode` at the given ``position``. The ``name`` is used to identify the created sub animation node later. @@ -191,7 +191,7 @@ Adds an :ref:`AnimationNode` at the given ``position``. The .. rst-class:: classref-method -void **connect_node** **(** :ref:`StringName` input_node, :ref:`int` input_index, :ref:`StringName` output_node **)** +|void| **connect_node**\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`, output_node\: :ref:`StringName`\ ) Connects the output of an :ref:`AnimationNode` as input for another :ref:`AnimationNode`, at the input port specified by ``input_index``. @@ -203,7 +203,7 @@ Connects the output of an :ref:`AnimationNode` as input for .. rst-class:: classref-method -void **disconnect_node** **(** :ref:`StringName` input_node, :ref:`int` input_index **)** +|void| **disconnect_node**\ (\ input_node\: :ref:`StringName`, input_index\: :ref:`int`\ ) Disconnects the animation node connected to the specified input. @@ -215,7 +215,7 @@ Disconnects the animation node connected to the specified input. .. rst-class:: classref-method -:ref:`AnimationNode` **get_node** **(** :ref:`StringName` name **)** |const| +:ref:`AnimationNode` **get_node**\ (\ name\: :ref:`StringName`\ ) |const| Returns the sub animation node with the specified ``name``. @@ -227,7 +227,7 @@ Returns the sub animation node with the specified ``name``. .. rst-class:: classref-method -:ref:`Vector2` **get_node_position** **(** :ref:`StringName` name **)** |const| +:ref:`Vector2` **get_node_position**\ (\ name\: :ref:`StringName`\ ) |const| Returns the position of the sub animation node with the specified ``name``. @@ -239,7 +239,7 @@ Returns the position of the sub animation node with the specified ``name``. .. rst-class:: classref-method -:ref:`bool` **has_node** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_node**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if a sub animation node with specified ``name`` exists. @@ -251,7 +251,7 @@ Returns ``true`` if a sub animation node with specified ``name`` exists. .. rst-class:: classref-method -void **remove_node** **(** :ref:`StringName` name **)** +|void| **remove_node**\ (\ name\: :ref:`StringName`\ ) Removes a sub animation node. @@ -263,7 +263,7 @@ Removes a sub animation node. .. rst-class:: classref-method -void **rename_node** **(** :ref:`StringName` name, :ref:`StringName` new_name **)** +|void| **rename_node**\ (\ name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) Changes the name of a sub animation node. @@ -275,7 +275,7 @@ Changes the name of a sub animation node. .. rst-class:: classref-method -void **set_node_position** **(** :ref:`StringName` name, :ref:`Vector2` position **)** +|void| **set_node_position**\ (\ name\: :ref:`StringName`, position\: :ref:`Vector2`\ ) Modifies the position of a sub animation node. @@ -286,3 +286,4 @@ Modifies the position of a sub animation node. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnodeoneshot.rst b/classes/class_animationnodeoneshot.rst index 8ce199e9188..92f8ab6f450 100644 --- a/classes/class_animationnodeoneshot.rst +++ b/classes/class_animationnodeoneshot.rst @@ -197,8 +197,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_autorestart** **(** :ref:`bool` value **)** -- :ref:`bool` **has_autorestart** **(** **)** +- |void| **set_autorestart**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **has_autorestart**\ (\ ) If ``true``, the sub-animation will restart automatically after finishing. @@ -216,8 +216,8 @@ In other words, to start auto restarting, the animation must be played once with .. rst-class:: classref-property-setget -- void **set_autorestart_delay** **(** :ref:`float` value **)** -- :ref:`float` **get_autorestart_delay** **(** **)** +- |void| **set_autorestart_delay**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_autorestart_delay**\ (\ ) The delay after which the automatic restart is triggered, in seconds. @@ -233,8 +233,8 @@ The delay after which the automatic restart is triggered, in seconds. .. rst-class:: classref-property-setget -- void **set_autorestart_random_delay** **(** :ref:`float` value **)** -- :ref:`float` **get_autorestart_random_delay** **(** **)** +- |void| **set_autorestart_random_delay**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_autorestart_random_delay**\ (\ ) If :ref:`autorestart` is ``true``, a random additional delay (in seconds) between 0 and this value will be added to :ref:`autorestart_delay`. @@ -250,8 +250,8 @@ If :ref:`autorestart` is ``true .. rst-class:: classref-property-setget -- void **set_fadein_curve** **(** :ref:`Curve` value **)** -- :ref:`Curve` **get_fadein_curve** **(** **)** +- |void| **set_fadein_curve**\ (\ value\: :ref:`Curve`\ ) +- :ref:`Curve` **get_fadein_curve**\ (\ ) Determines how cross-fading between animations is eased. If empty, the transition will be linear. @@ -267,8 +267,8 @@ Determines how cross-fading between animations is eased. If empty, the transitio .. rst-class:: classref-property-setget -- void **set_fadein_time** **(** :ref:`float` value **)** -- :ref:`float` **get_fadein_time** **(** **)** +- |void| **set_fadein_time**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fadein_time**\ (\ ) The fade-in duration. For example, setting this to ``1.0`` for a 5 second length animation will produce a cross-fade that starts at 0 second and ends at 1 second during the animation. @@ -284,8 +284,8 @@ The fade-in duration. For example, setting this to ``1.0`` for a 5 second length .. rst-class:: classref-property-setget -- void **set_fadeout_curve** **(** :ref:`Curve` value **)** -- :ref:`Curve` **get_fadeout_curve** **(** **)** +- |void| **set_fadeout_curve**\ (\ value\: :ref:`Curve`\ ) +- :ref:`Curve` **get_fadeout_curve**\ (\ ) Determines how cross-fading between animations is eased. If empty, the transition will be linear. @@ -301,8 +301,8 @@ Determines how cross-fading between animations is eased. If empty, the transitio .. rst-class:: classref-property-setget -- void **set_fadeout_time** **(** :ref:`float` value **)** -- :ref:`float` **get_fadeout_time** **(** **)** +- |void| **set_fadeout_time**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fadeout_time**\ (\ ) The fade-out duration. For example, setting this to ``1.0`` for a 5 second length animation will produce a cross-fade that starts at 4 second and ends at 5 second during the animation. @@ -318,8 +318,8 @@ The fade-out duration. For example, setting this to ``1.0`` for a 5 second lengt .. rst-class:: classref-property-setget -- void **set_mix_mode** **(** :ref:`MixMode` value **)** -- :ref:`MixMode` **get_mix_mode** **(** **)** +- |void| **set_mix_mode**\ (\ value\: :ref:`MixMode`\ ) +- :ref:`MixMode` **get_mix_mode**\ (\ ) The blend type. @@ -330,3 +330,4 @@ The blend type. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnodeoutput.rst b/classes/class_animationnodeoutput.rst index e2a42ed16b8..2965cafaf80 100644 --- a/classes/class_animationnodeoutput.rst +++ b/classes/class_animationnodeoutput.rst @@ -39,3 +39,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst index db0a8ed66b4..aa73899bbee 100644 --- a/classes/class_animationnodestatemachine.rst +++ b/classes/class_animationnodestatemachine.rst @@ -69,45 +69,45 @@ Methods .. table:: :widths: auto - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_node` **(** :ref:`StringName` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2(0, 0) **)** | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_transition` **(** :ref:`StringName` from, :ref:`StringName` to, :ref:`AnimationNodeStateMachineTransition` transition **)** | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_graph_offset` **(** **)** |const| | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`StringName` name **)** |const| | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_node_name` **(** :ref:`AnimationNode` node **)** |const| | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`StringName` name **)** |const| | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AnimationNodeStateMachineTransition` | :ref:`get_transition` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_transition_count` **(** **)** |const| | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_transition_from` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_transition_to` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_node` **(** :ref:`StringName` name **)** |const| | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_transition` **(** :ref:`StringName` from, :ref:`StringName` to **)** |const| | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_node` **(** :ref:`StringName` name **)** | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_transition` **(** :ref:`StringName` from, :ref:`StringName` to **)** | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_transition_by_index` **(** :ref:`int` idx **)** | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rename_node` **(** :ref:`StringName` name, :ref:`StringName` new_name **)** | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`replace_node` **(** :ref:`StringName` name, :ref:`AnimationNode` node **)** | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_graph_offset` **(** :ref:`Vector2` offset **)** | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_node_position` **(** :ref:`StringName` name, :ref:`Vector2` position **)** | - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_node`\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_transition`\ (\ from\: :ref:`StringName`, to\: :ref:`StringName`, transition\: :ref:`AnimationNodeStateMachineTransition`\ ) | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_graph_offset`\ (\ ) |const| | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AnimationNode` | :ref:`get_node`\ (\ name\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_node_name`\ (\ node\: :ref:`AnimationNode`\ ) |const| | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_node_position`\ (\ name\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AnimationNodeStateMachineTransition` | :ref:`get_transition`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_transition_count`\ (\ ) |const| | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_transition_from`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_transition_to`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_node`\ (\ name\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_transition`\ (\ from\: :ref:`StringName`, to\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_node`\ (\ name\: :ref:`StringName`\ ) | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_transition`\ (\ from\: :ref:`StringName`, to\: :ref:`StringName`\ ) | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_transition_by_index`\ (\ idx\: :ref:`int`\ ) | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rename_node`\ (\ name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`replace_node`\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`\ ) | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_graph_offset`\ (\ offset\: :ref:`Vector2`\ ) | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_node_position`\ (\ name\: :ref:`StringName`, position\: :ref:`Vector2`\ ) | + +---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -165,8 +165,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_allow_transition_to_self** **(** :ref:`bool` value **)** -- :ref:`bool` **is_allow_transition_to_self** **(** **)** +- |void| **set_allow_transition_to_self**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_allow_transition_to_self**\ (\ ) If ``true``, allows teleport to the self state with :ref:`AnimationNodeStateMachinePlayback.travel`. When the reset option is enabled in :ref:`AnimationNodeStateMachinePlayback.travel`, the animation is restarted. If ``false``, nothing happens on the teleportation to the self state. @@ -182,8 +182,8 @@ If ``true``, allows teleport to the self state with :ref:`AnimationNodeStateMach .. rst-class:: classref-property-setget -- void **set_reset_ends** **(** :ref:`bool` value **)** -- :ref:`bool` **are_ends_reset** **(** **)** +- |void| **set_reset_ends**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **are_ends_reset**\ (\ ) If ``true``, treat the cross-fade to the start and end nodes as a blend with the RESET animation. @@ -201,8 +201,8 @@ In most cases, when additional cross-fades are performed in the parent :ref:`Ani .. rst-class:: classref-property-setget -- void **set_state_machine_type** **(** :ref:`StateMachineType` value **)** -- :ref:`StateMachineType` **get_state_machine_type** **(** **)** +- |void| **set_state_machine_type**\ (\ value\: :ref:`StateMachineType`\ ) +- :ref:`StateMachineType` **get_state_machine_type**\ (\ ) This property can define the process of transitions for different use cases. See also :ref:`StateMachineType`. @@ -219,7 +219,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_node** **(** :ref:`StringName` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2(0, 0) **)** +|void| **add_node**\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) Adds a new animation node to the graph. The ``position`` is used for display in the editor. @@ -231,7 +231,7 @@ Adds a new animation node to the graph. The ``position`` is used for display in .. rst-class:: classref-method -void **add_transition** **(** :ref:`StringName` from, :ref:`StringName` to, :ref:`AnimationNodeStateMachineTransition` transition **)** +|void| **add_transition**\ (\ from\: :ref:`StringName`, to\: :ref:`StringName`, transition\: :ref:`AnimationNodeStateMachineTransition`\ ) Adds a transition between the given animation nodes. @@ -243,7 +243,7 @@ Adds a transition between the given animation nodes. .. rst-class:: classref-method -:ref:`Vector2` **get_graph_offset** **(** **)** |const| +:ref:`Vector2` **get_graph_offset**\ (\ ) |const| Returns the draw offset of the graph. Used for display in the editor. @@ -255,7 +255,7 @@ Returns the draw offset of the graph. Used for display in the editor. .. rst-class:: classref-method -:ref:`AnimationNode` **get_node** **(** :ref:`StringName` name **)** |const| +:ref:`AnimationNode` **get_node**\ (\ name\: :ref:`StringName`\ ) |const| Returns the animation node with the given name. @@ -267,7 +267,7 @@ Returns the animation node with the given name. .. rst-class:: classref-method -:ref:`StringName` **get_node_name** **(** :ref:`AnimationNode` node **)** |const| +:ref:`StringName` **get_node_name**\ (\ node\: :ref:`AnimationNode`\ ) |const| Returns the given animation node's name. @@ -279,7 +279,7 @@ Returns the given animation node's name. .. rst-class:: classref-method -:ref:`Vector2` **get_node_position** **(** :ref:`StringName` name **)** |const| +:ref:`Vector2` **get_node_position**\ (\ name\: :ref:`StringName`\ ) |const| Returns the given animation node's coordinates. Used for display in the editor. @@ -291,7 +291,7 @@ Returns the given animation node's coordinates. Used for display in the editor. .. rst-class:: classref-method -:ref:`AnimationNodeStateMachineTransition` **get_transition** **(** :ref:`int` idx **)** |const| +:ref:`AnimationNodeStateMachineTransition` **get_transition**\ (\ idx\: :ref:`int`\ ) |const| Returns the given transition. @@ -303,7 +303,7 @@ Returns the given transition. .. rst-class:: classref-method -:ref:`int` **get_transition_count** **(** **)** |const| +:ref:`int` **get_transition_count**\ (\ ) |const| Returns the number of connections in the graph. @@ -315,7 +315,7 @@ Returns the number of connections in the graph. .. rst-class:: classref-method -:ref:`StringName` **get_transition_from** **(** :ref:`int` idx **)** |const| +:ref:`StringName` **get_transition_from**\ (\ idx\: :ref:`int`\ ) |const| Returns the given transition's start node. @@ -327,7 +327,7 @@ Returns the given transition's start node. .. rst-class:: classref-method -:ref:`StringName` **get_transition_to** **(** :ref:`int` idx **)** |const| +:ref:`StringName` **get_transition_to**\ (\ idx\: :ref:`int`\ ) |const| Returns the given transition's end node. @@ -339,7 +339,7 @@ Returns the given transition's end node. .. rst-class:: classref-method -:ref:`bool` **has_node** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_node**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if the graph contains the given animation node. @@ -351,7 +351,7 @@ Returns ``true`` if the graph contains the given animation node. .. rst-class:: classref-method -:ref:`bool` **has_transition** **(** :ref:`StringName` from, :ref:`StringName` to **)** |const| +:ref:`bool` **has_transition**\ (\ from\: :ref:`StringName`, to\: :ref:`StringName`\ ) |const| Returns ``true`` if there is a transition between the given animation nodes. @@ -363,7 +363,7 @@ Returns ``true`` if there is a transition between the given animation nodes. .. rst-class:: classref-method -void **remove_node** **(** :ref:`StringName` name **)** +|void| **remove_node**\ (\ name\: :ref:`StringName`\ ) Deletes the given animation node from the graph. @@ -375,7 +375,7 @@ Deletes the given animation node from the graph. .. rst-class:: classref-method -void **remove_transition** **(** :ref:`StringName` from, :ref:`StringName` to **)** +|void| **remove_transition**\ (\ from\: :ref:`StringName`, to\: :ref:`StringName`\ ) Deletes the transition between the two specified animation nodes. @@ -387,7 +387,7 @@ Deletes the transition between the two specified animation nodes. .. rst-class:: classref-method -void **remove_transition_by_index** **(** :ref:`int` idx **)** +|void| **remove_transition_by_index**\ (\ idx\: :ref:`int`\ ) Deletes the given transition by index. @@ -399,7 +399,7 @@ Deletes the given transition by index. .. rst-class:: classref-method -void **rename_node** **(** :ref:`StringName` name, :ref:`StringName` new_name **)** +|void| **rename_node**\ (\ name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) Renames the given animation node. @@ -411,7 +411,7 @@ Renames the given animation node. .. rst-class:: classref-method -void **replace_node** **(** :ref:`StringName` name, :ref:`AnimationNode` node **)** +|void| **replace_node**\ (\ name\: :ref:`StringName`, node\: :ref:`AnimationNode`\ ) Replaces the given animation node with a new animation node. @@ -423,7 +423,7 @@ Replaces the given animation node with a new animation node. .. rst-class:: classref-method -void **set_graph_offset** **(** :ref:`Vector2` offset **)** +|void| **set_graph_offset**\ (\ offset\: :ref:`Vector2`\ ) Sets the draw offset of the graph. Used for display in the editor. @@ -435,7 +435,7 @@ Sets the draw offset of the graph. Used for display in the editor. .. rst-class:: classref-method -void **set_node_position** **(** :ref:`StringName` name, :ref:`Vector2` position **)** +|void| **set_node_position**\ (\ name\: :ref:`StringName`, position\: :ref:`Vector2`\ ) Sets the animation node's coordinates. Used for display in the editor. @@ -446,3 +446,4 @@ Sets the animation node's coordinates. Used for display in the editor. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnodestatemachineplayback.rst b/classes/class_animationnodestatemachineplayback.rst index 95f1f16cb12..52fb2f528ad 100644 --- a/classes/class_animationnodestatemachineplayback.rst +++ b/classes/class_animationnodestatemachineplayback.rst @@ -65,27 +65,27 @@ Methods .. table:: :widths: auto - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_current_length` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_current_node` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_current_play_position` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_fading_from_node` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName[]` | :ref:`get_travel_path` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_playing` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`next` **(** **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`start` **(** :ref:`StringName` node, :ref:`bool` reset=true **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`stop` **(** **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`travel` **(** :ref:`StringName` to_node, :ref:`bool` reset_on_teleport=true **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_current_length`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_current_node`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_current_play_position`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_fading_from_node`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`StringName`\] | :ref:`get_travel_path`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_playing`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`next`\ (\ ) | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`start`\ (\ node\: :ref:`StringName`, reset\: :ref:`bool` = true\ ) | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop`\ (\ ) | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`travel`\ (\ to_node\: :ref:`StringName`, reset_on_teleport\: :ref:`bool` = true\ ) | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -100,7 +100,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_current_length** **(** **)** |const| +:ref:`float` **get_current_length**\ (\ ) |const| Returns the current state length. @@ -114,7 +114,7 @@ Returns the current state length. .. rst-class:: classref-method -:ref:`StringName` **get_current_node** **(** **)** |const| +:ref:`StringName` **get_current_node**\ (\ ) |const| Returns the currently playing animation state. @@ -128,7 +128,7 @@ Returns the currently playing animation state. .. rst-class:: classref-method -:ref:`float` **get_current_play_position** **(** **)** |const| +:ref:`float` **get_current_play_position**\ (\ ) |const| Returns the playback position within the current animation state. @@ -140,7 +140,7 @@ Returns the playback position within the current animation state. .. rst-class:: classref-method -:ref:`StringName` **get_fading_from_node** **(** **)** |const| +:ref:`StringName` **get_fading_from_node**\ (\ ) |const| Returns the starting state of currently fading animation. @@ -152,7 +152,7 @@ Returns the starting state of currently fading animation. .. rst-class:: classref-method -:ref:`StringName[]` **get_travel_path** **(** **)** |const| +:ref:`Array`\[:ref:`StringName`\] **get_travel_path**\ (\ ) |const| Returns the current travel path as computed internally by the A\* algorithm. @@ -164,7 +164,7 @@ Returns the current travel path as computed internally by the A\* algorithm. .. rst-class:: classref-method -:ref:`bool` **is_playing** **(** **)** |const| +:ref:`bool` **is_playing**\ (\ ) |const| Returns ``true`` if an animation is playing. @@ -176,7 +176,7 @@ Returns ``true`` if an animation is playing. .. rst-class:: classref-method -void **next** **(** **)** +|void| **next**\ (\ ) If there is a next path by travel or auto advance, immediately transitions from the current state to the next state. @@ -188,7 +188,7 @@ If there is a next path by travel or auto advance, immediately transitions from .. rst-class:: classref-method -void **start** **(** :ref:`StringName` node, :ref:`bool` reset=true **)** +|void| **start**\ (\ node\: :ref:`StringName`, reset\: :ref:`bool` = true\ ) Starts playing the given animation. @@ -202,7 +202,7 @@ If ``reset`` is ``true``, the animation is played from the beginning. .. rst-class:: classref-method -void **stop** **(** **)** +|void| **stop**\ (\ ) Stops the currently playing animation. @@ -214,7 +214,7 @@ Stops the currently playing animation. .. rst-class:: classref-method -void **travel** **(** :ref:`StringName` to_node, :ref:`bool` reset_on_teleport=true **)** +|void| **travel**\ (\ to_node\: :ref:`StringName`, reset_on_teleport\: :ref:`bool` = true\ ) Transitions from the current state to another one, following the shortest path. @@ -229,3 +229,4 @@ If ``reset_on_teleport`` is ``true``, the animation is played from the beginning .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnodestatemachinetransition.rst b/classes/class_animationnodestatemachinetransition.rst index 97ab5127bee..5adcfccae85 100644 --- a/classes/class_animationnodestatemachinetransition.rst +++ b/classes/class_animationnodestatemachinetransition.rst @@ -69,7 +69,7 @@ Signals .. rst-class:: classref-signal -**advance_condition_changed** **(** **)** +**advance_condition_changed**\ (\ ) Emitted when :ref:`advance_condition` is changed. @@ -163,8 +163,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_advance_condition** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_advance_condition** **(** **)** +- |void| **set_advance_condition**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_advance_condition**\ (\ ) Turn on auto advance when this condition is set. The provided name will become a boolean parameter on the :ref:`AnimationTree` that can be controlled from code (see `Using AnimationTree <../tutorials/animation/animation_tree.html#controlling-from-code>`__). For example, if :ref:`AnimationTree.tree_root` is an :ref:`AnimationNodeStateMachine` and :ref:`advance_condition` is set to ``"idle"``: @@ -193,8 +193,8 @@ Turn on auto advance when this condition is set. The provided name will become a .. rst-class:: classref-property-setget -- void **set_advance_expression** **(** :ref:`String` value **)** -- :ref:`String` **get_advance_expression** **(** **)** +- |void| **set_advance_expression**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_advance_expression**\ (\ ) Use an expression as a condition for state machine transitions. It is possible to create complex animation advance conditions for switching between states and gives much greater flexibility for creating complex state machines by directly interfacing with the script code. @@ -210,8 +210,8 @@ Use an expression as a condition for state machine transitions. It is possible t .. rst-class:: classref-property-setget -- void **set_advance_mode** **(** :ref:`AdvanceMode` value **)** -- :ref:`AdvanceMode` **get_advance_mode** **(** **)** +- |void| **set_advance_mode**\ (\ value\: :ref:`AdvanceMode`\ ) +- :ref:`AdvanceMode` **get_advance_mode**\ (\ ) Determines whether the transition should disabled, enabled when using :ref:`AnimationNodeStateMachinePlayback.travel`, or traversed automatically if the :ref:`advance_condition` and :ref:`advance_expression` checks are true (if assigned). @@ -227,8 +227,8 @@ Determines whether the transition should disabled, enabled when using :ref:`Anim .. rst-class:: classref-property-setget -- void **set_priority** **(** :ref:`int` value **)** -- :ref:`int` **get_priority** **(** **)** +- |void| **set_priority**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_priority**\ (\ ) Lower priority transitions are preferred when travelling through the tree via :ref:`AnimationNodeStateMachinePlayback.travel` or :ref:`advance_mode` is set to :ref:`ADVANCE_MODE_AUTO`. @@ -244,8 +244,8 @@ Lower priority transitions are preferred when travelling through the tree via :r .. rst-class:: classref-property-setget -- void **set_reset** **(** :ref:`bool` value **)** -- :ref:`bool` **is_reset** **(** **)** +- |void| **set_reset**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_reset**\ (\ ) If ``true``, the destination animation is played back from the beginning when switched. @@ -261,8 +261,8 @@ If ``true``, the destination animation is played back from the beginning when sw .. rst-class:: classref-property-setget -- void **set_switch_mode** **(** :ref:`SwitchMode` value **)** -- :ref:`SwitchMode` **get_switch_mode** **(** **)** +- |void| **set_switch_mode**\ (\ value\: :ref:`SwitchMode`\ ) +- :ref:`SwitchMode` **get_switch_mode**\ (\ ) The transition type. @@ -278,8 +278,8 @@ The transition type. .. rst-class:: classref-property-setget -- void **set_xfade_curve** **(** :ref:`Curve` value **)** -- :ref:`Curve` **get_xfade_curve** **(** **)** +- |void| **set_xfade_curve**\ (\ value\: :ref:`Curve`\ ) +- :ref:`Curve` **get_xfade_curve**\ (\ ) Ease curve for better control over cross-fade between this state and the next. @@ -295,8 +295,8 @@ Ease curve for better control over cross-fade between this state and the next. .. rst-class:: classref-property-setget -- void **set_xfade_time** **(** :ref:`float` value **)** -- :ref:`float` **get_xfade_time** **(** **)** +- |void| **set_xfade_time**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_xfade_time**\ (\ ) The time to cross-fade between this state and the next. @@ -307,3 +307,4 @@ The time to cross-fade between this state and the next. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnodesub2.rst b/classes/class_animationnodesub2.rst index d5c78a34894..8a62e6d4417 100644 --- a/classes/class_animationnodesub2.rst +++ b/classes/class_animationnodesub2.rst @@ -41,3 +41,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnodesync.rst b/classes/class_animationnodesync.rst index 61f12ed8e1b..ad45b322813 100644 --- a/classes/class_animationnodesync.rst +++ b/classes/class_animationnodesync.rst @@ -59,8 +59,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_use_sync** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_sync** **(** **)** +- |void| **set_use_sync**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_sync**\ (\ ) If ``false``, the blended animations' frame are stopped when the blend value is ``0``. @@ -73,3 +73,4 @@ If ``true``, forcing the blended animations to advance frame. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnodetimescale.rst b/classes/class_animationnodetimescale.rst index ae36d63988f..81513683bfc 100644 --- a/classes/class_animationnodetimescale.rst +++ b/classes/class_animationnodetimescale.rst @@ -37,3 +37,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnodetimeseek.rst b/classes/class_animationnodetimeseek.rst index dff81716df6..c9ec75ffdcd 100644 --- a/classes/class_animationnodetimeseek.rst +++ b/classes/class_animationnodetimeseek.rst @@ -62,3 +62,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationnodetransition.rst b/classes/class_animationnodetransition.rst index f4b40e2dd5b..b837d98823e 100644 --- a/classes/class_animationnodetransition.rst +++ b/classes/class_animationnodetransition.rst @@ -95,15 +95,15 @@ Methods .. table:: :widths: auto - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_input_reset` **(** :ref:`int` input **)** |const| | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_input_set_as_auto_advance` **(** :ref:`int` input **)** |const| | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_input_as_auto_advance` **(** :ref:`int` input, :ref:`bool` enable **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_input_reset` **(** :ref:`int` input, :ref:`bool` enable **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_input_reset`\ (\ input\: :ref:`int`\ ) |const| | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_input_set_as_auto_advance`\ (\ input\: :ref:`int`\ ) |const| | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_input_as_auto_advance`\ (\ input\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_input_reset`\ (\ input\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -122,8 +122,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_allow_transition_to_self** **(** :ref:`bool` value **)** -- :ref:`bool` **is_allow_transition_to_self** **(** **)** +- |void| **set_allow_transition_to_self**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_allow_transition_to_self**\ (\ ) If ``true``, allows transition to the self state. When the reset option is enabled in input, the animation is restarted. If ``false``, nothing happens on the transition to the self state. @@ -139,8 +139,8 @@ If ``true``, allows transition to the self state. When the reset option is enabl .. rst-class:: classref-property-setget -- void **set_input_count** **(** :ref:`int` value **)** -- :ref:`int` **get_input_count** **(** **)** +- |void| **set_input_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_input_count**\ (\ ) The number of enabled input ports for this animation node. @@ -156,8 +156,8 @@ The number of enabled input ports for this animation node. .. rst-class:: classref-property-setget -- void **set_xfade_curve** **(** :ref:`Curve` value **)** -- :ref:`Curve` **get_xfade_curve** **(** **)** +- |void| **set_xfade_curve**\ (\ value\: :ref:`Curve`\ ) +- :ref:`Curve` **get_xfade_curve**\ (\ ) Determines how cross-fading between animations is eased. If empty, the transition will be linear. @@ -173,8 +173,8 @@ Determines how cross-fading between animations is eased. If empty, the transitio .. rst-class:: classref-property-setget -- void **set_xfade_time** **(** :ref:`float` value **)** -- :ref:`float` **get_xfade_time** **(** **)** +- |void| **set_xfade_time**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_xfade_time**\ (\ ) Cross-fading time (in seconds) between each animation connected to the inputs. @@ -191,7 +191,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_input_reset** **(** :ref:`int` input **)** |const| +:ref:`bool` **is_input_reset**\ (\ input\: :ref:`int`\ ) |const| Returns whether the animation restarts when the animation transitions from the other animation. @@ -203,7 +203,7 @@ Returns whether the animation restarts when the animation transitions from the o .. rst-class:: classref-method -:ref:`bool` **is_input_set_as_auto_advance** **(** :ref:`int` input **)** |const| +:ref:`bool` **is_input_set_as_auto_advance**\ (\ input\: :ref:`int`\ ) |const| Returns ``true`` if auto-advance is enabled for the given ``input`` index. @@ -215,7 +215,7 @@ Returns ``true`` if auto-advance is enabled for the given ``input`` index. .. rst-class:: classref-method -void **set_input_as_auto_advance** **(** :ref:`int` input, :ref:`bool` enable **)** +|void| **set_input_as_auto_advance**\ (\ input\: :ref:`int`, enable\: :ref:`bool`\ ) Enables or disables auto-advance for the given ``input`` index. If enabled, state changes to the next input after playing the animation once. If enabled for the last input state, it loops to the first. @@ -227,7 +227,7 @@ Enables or disables auto-advance for the given ``input`` index. If enabled, stat .. rst-class:: classref-method -void **set_input_reset** **(** :ref:`int` input, :ref:`bool` enable **)** +|void| **set_input_reset**\ (\ input\: :ref:`int`, enable\: :ref:`bool`\ ) If ``true``, the destination animation is restarted when the animation transitions. @@ -238,3 +238,4 @@ If ``true``, the destination animation is restarted when the animation transitio .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 7a5c0808300..5a1ce078373 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -72,49 +72,49 @@ Methods .. table:: :widths: auto - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`animation_get_next` **(** :ref:`StringName` animation_from **)** |const| | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`animation_set_next` **(** :ref:`StringName` animation_from, :ref:`StringName` animation_to **)** | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_queue` **(** **)** | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_blend_time` **(** :ref:`StringName` animation_from, :ref:`StringName` animation_to **)** |const| | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AnimationMethodCallMode` | :ref:`get_method_call_mode` **(** **)** |const| | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_playing_speed` **(** **)** |const| | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AnimationProcessCallback` | :ref:`get_process_callback` **(** **)** |const| | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_queue` **(** **)** | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_root` **(** **)** |const| | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_playing` **(** **)** |const| | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`pause` **(** **)** | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`play` **(** :ref:`StringName` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`play_backwards` **(** :ref:`StringName` name="", :ref:`float` custom_blend=-1 **)** | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`play_with_capture` **(** :ref:`StringName` name, :ref:`float` duration=-1.0, :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=0 **)** | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`queue` **(** :ref:`StringName` name **)** | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`seek` **(** :ref:`float` seconds, :ref:`bool` update=false, :ref:`bool` update_only=false **)** | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_blend_time` **(** :ref:`StringName` animation_from, :ref:`StringName` animation_to, :ref:`float` sec **)** | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_method_call_mode` **(** :ref:`AnimationMethodCallMode` mode **)** | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_process_callback` **(** :ref:`AnimationProcessCallback` mode **)** | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_root` **(** :ref:`NodePath` path **)** | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`stop` **(** :ref:`bool` keep_state=false **)** | - +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`animation_get_next`\ (\ animation_from\: :ref:`StringName`\ ) |const| | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`animation_set_next`\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_queue`\ (\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_blend_time`\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`\ ) |const| | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AnimationMethodCallMode` | :ref:`get_method_call_mode`\ (\ ) |const| | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_playing_speed`\ (\ ) |const| | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AnimationProcessCallback` | :ref:`get_process_callback`\ (\ ) |const| | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_queue`\ (\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_root`\ (\ ) |const| | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_playing`\ (\ ) |const| | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`pause`\ (\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play`\ (\ name\: :ref:`StringName` = &"", custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play_backwards`\ (\ name\: :ref:`StringName` = &"", custom_blend\: :ref:`float` = -1\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play_with_capture`\ (\ name\: :ref:`StringName`, duration\: :ref:`float` = -1.0, custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false, trans_type\: :ref:`TransitionType` = 0, ease_type\: :ref:`EaseType` = 0\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`queue`\ (\ name\: :ref:`StringName`\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`seek`\ (\ seconds\: :ref:`float`, update\: :ref:`bool` = false, update_only\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_blend_time`\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`, sec\: :ref:`float`\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_method_call_mode`\ (\ mode\: :ref:`AnimationMethodCallMode`\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_process_callback`\ (\ mode\: :ref:`AnimationProcessCallback`\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_root`\ (\ path\: :ref:`NodePath`\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop`\ (\ keep_state\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -129,7 +129,7 @@ Signals .. rst-class:: classref-signal -**animation_changed** **(** :ref:`StringName` old_name, :ref:`StringName` new_name **)** +**animation_changed**\ (\ old_name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) Emitted when a queued animation plays after the previous animation finished. See also :ref:`queue`. @@ -143,7 +143,7 @@ Emitted when a queued animation plays after the previous animation finished. See .. rst-class:: classref-signal -**current_animation_changed** **(** :ref:`String` name **)** +**current_animation_changed**\ (\ name\: :ref:`String`\ ) Emitted when :ref:`current_animation` changes. @@ -170,10 +170,6 @@ enum **AnimationProcessCallback**: **Deprecated:** See :ref:`AnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_PHYSICS`. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_AnimationPlayer_constant_ANIMATION_PROCESS_IDLE: @@ -184,10 +180,6 @@ enum **AnimationProcessCallback**: **Deprecated:** See :ref:`AnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_IDLE`. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_AnimationPlayer_constant_ANIMATION_PROCESS_MANUAL: @@ -198,10 +190,6 @@ enum **AnimationProcessCallback**: **Deprecated:** See :ref:`AnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_MANUAL`. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. rst-class:: classref-item-separator @@ -222,10 +210,6 @@ enum **AnimationMethodCallMode**: **Deprecated:** See :ref:`AnimationMixer.ANIMATION_CALLBACK_MODE_METHOD_DEFERRED`. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_AnimationPlayer_constant_ANIMATION_METHOD_CALL_IMMEDIATE: @@ -236,10 +220,6 @@ enum **AnimationMethodCallMode**: **Deprecated:** See :ref:`AnimationMixer.ANIMATION_CALLBACK_MODE_METHOD_IMMEDIATE`. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. rst-class:: classref-section-separator @@ -259,8 +239,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_assigned_animation** **(** :ref:`String` value **)** -- :ref:`String` **get_assigned_animation** **(** **)** +- |void| **set_assigned_animation**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_assigned_animation**\ (\ ) If playing, the current animation's key, otherwise, the animation last played. When set, this changes the animation, but will not play it unless already playing. See also :ref:`current_animation`. @@ -276,8 +256,8 @@ If playing, the current animation's key, otherwise, the animation last played. W .. rst-class:: classref-property-setget -- void **set_autoplay** **(** :ref:`String` value **)** -- :ref:`String` **get_autoplay** **(** **)** +- |void| **set_autoplay**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_autoplay**\ (\ ) The key of the animation to play when the scene loads. @@ -293,8 +273,8 @@ The key of the animation to play when the scene loads. .. rst-class:: classref-property-setget -- void **set_current_animation** **(** :ref:`String` value **)** -- :ref:`String` **get_current_animation** **(** **)** +- |void| **set_current_animation**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_current_animation**\ (\ ) The key of the currently playing animation. If no animation is playing, the property's value is an empty string. Changing this value does not restart the animation. See :ref:`play` for more information on playing animations. @@ -312,7 +292,7 @@ The key of the currently playing animation. If no animation is playing, the prop .. rst-class:: classref-property-setget -- :ref:`float` **get_current_animation_length** **(** **)** +- :ref:`float` **get_current_animation_length**\ (\ ) The length (in seconds) of the currently playing animation. @@ -328,7 +308,7 @@ The length (in seconds) of the currently playing animation. .. rst-class:: classref-property-setget -- :ref:`float` **get_current_animation_position** **(** **)** +- :ref:`float` **get_current_animation_position**\ (\ ) The position (in seconds) of the currently playing animation. @@ -344,8 +324,8 @@ The position (in seconds) of the currently playing animation. .. rst-class:: classref-property-setget -- void **set_movie_quit_on_finish_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_movie_quit_on_finish_enabled** **(** **)** +- |void| **set_movie_quit_on_finish_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_movie_quit_on_finish_enabled**\ (\ ) If ``true`` and the engine is running in Movie Maker mode (see :ref:`MovieWriter`), exits the engine with :ref:`SceneTree.quit` as soon as an animation is done playing in this **AnimationPlayer**. A message is printed when the engine quits for this reason. @@ -363,8 +343,8 @@ If ``true`` and the engine is running in Movie Maker mode (see :ref:`MovieWriter .. rst-class:: classref-property-setget -- void **set_default_blend_time** **(** :ref:`float` value **)** -- :ref:`float` **get_default_blend_time** **(** **)** +- |void| **set_default_blend_time**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_default_blend_time**\ (\ ) The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. @@ -380,8 +360,8 @@ The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 p .. rst-class:: classref-property-setget -- void **set_speed_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_speed_scale** **(** **)** +- |void| **set_speed_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_speed_scale**\ (\ ) The speed scaling ratio. For example, if this value is ``1``, then the animation plays at normal speed. If it's ``0.5``, then it plays at half speed. If it's ``2``, then it plays at double speed. @@ -400,7 +380,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`StringName` **animation_get_next** **(** :ref:`StringName` animation_from **)** |const| +:ref:`StringName` **animation_get_next**\ (\ animation_from\: :ref:`StringName`\ ) |const| Returns the key of the animation which is queued to play after the ``animation_from`` animation. @@ -412,7 +392,7 @@ Returns the key of the animation which is queued to play after the ``animation_f .. rst-class:: classref-method -void **animation_set_next** **(** :ref:`StringName` animation_from, :ref:`StringName` animation_to **)** +|void| **animation_set_next**\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`\ ) Triggers the ``animation_to`` animation when the ``animation_from`` animation completes. @@ -424,7 +404,7 @@ Triggers the ``animation_to`` animation when the ``animation_from`` animation co .. rst-class:: classref-method -void **clear_queue** **(** **)** +|void| **clear_queue**\ (\ ) Clears all queued, unplayed animations. @@ -436,7 +416,7 @@ Clears all queued, unplayed animations. .. rst-class:: classref-method -:ref:`float` **get_blend_time** **(** :ref:`StringName` animation_from, :ref:`StringName` animation_to **)** |const| +:ref:`float` **get_blend_time**\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`\ ) |const| Returns the blend time (in seconds) between two animations, referenced by their keys. @@ -448,13 +428,11 @@ Returns the blend time (in seconds) between two animations, referenced by their .. rst-class:: classref-method -:ref:`AnimationMethodCallMode` **get_method_call_mode** **(** **)** |const| +:ref:`AnimationMethodCallMode` **get_method_call_mode**\ (\ ) |const| **Deprecated:** Use :ref:`AnimationMixer.callback_mode_method` instead. -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the call mode used for "Call Method" tracks. .. rst-class:: classref-item-separator @@ -464,7 +442,7 @@ Returns the blend time (in seconds) between two animations, referenced by their .. rst-class:: classref-method -:ref:`float` **get_playing_speed** **(** **)** |const| +:ref:`float` **get_playing_speed**\ (\ ) |const| Returns the actual playing speed of current animation or ``0`` if not playing. This speed is the :ref:`speed_scale` property multiplied by ``custom_speed`` argument specified when calling the :ref:`play` method. @@ -478,13 +456,11 @@ Returns a negative value if the current animation is playing backwards. .. rst-class:: classref-method -:ref:`AnimationProcessCallback` **get_process_callback** **(** **)** |const| +:ref:`AnimationProcessCallback` **get_process_callback**\ (\ ) |const| **Deprecated:** Use :ref:`AnimationMixer.callback_mode_process` instead. -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the process notification in which to update animations. .. rst-class:: classref-item-separator @@ -494,7 +470,7 @@ Returns a negative value if the current animation is playing backwards. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_queue** **(** **)** +:ref:`PackedStringArray` **get_queue**\ (\ ) Returns a list of the animation keys that are currently queued to play. @@ -506,13 +482,11 @@ Returns a list of the animation keys that are currently queued to play. .. rst-class:: classref-method -:ref:`NodePath` **get_root** **(** **)** |const| +:ref:`NodePath` **get_root**\ (\ ) |const| **Deprecated:** Use :ref:`AnimationMixer.root_node` instead. -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the node which node path references will travel from. .. rst-class:: classref-item-separator @@ -522,7 +496,7 @@ Returns a list of the animation keys that are currently queued to play. .. rst-class:: classref-method -:ref:`bool` **is_playing** **(** **)** |const| +:ref:`bool` **is_playing**\ (\ ) |const| Returns ``true`` if an animation is currently playing (even if :ref:`speed_scale` and/or ``custom_speed`` are ``0``). @@ -534,7 +508,7 @@ Returns ``true`` if an animation is currently playing (even if :ref:`speed_scale .. rst-class:: classref-method -void **pause** **(** **)** +|void| **pause**\ (\ ) Pauses the currently playing animation. The :ref:`current_animation_position` will be kept and calling :ref:`play` or :ref:`play_backwards` without arguments or with the same animation name as :ref:`assigned_animation` will resume the animation. @@ -548,7 +522,7 @@ See also :ref:`stop`. .. rst-class:: classref-method -void **play** **(** :ref:`StringName` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** +|void| **play**\ (\ name\: :ref:`StringName` = &"", custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false\ ) Plays the animation with key ``name``. Custom blend times and speed can be set. @@ -566,7 +540,7 @@ The **AnimationPlayer** keeps track of its current or last played animation with .. rst-class:: classref-method -void **play_backwards** **(** :ref:`StringName` name="", :ref:`float` custom_blend=-1 **)** +|void| **play_backwards**\ (\ name\: :ref:`StringName` = &"", custom_blend\: :ref:`float` = -1\ ) Plays the animation with key ``name`` in reverse. @@ -580,7 +554,7 @@ This method is a shorthand for :ref:`play` wi .. rst-class:: classref-method -void **play_with_capture** **(** :ref:`StringName` name, :ref:`float` duration=-1.0, :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=0 **)** +|void| **play_with_capture**\ (\ name\: :ref:`StringName`, duration\: :ref:`float` = -1.0, custom_blend\: :ref:`float` = -1, custom_speed\: :ref:`float` = 1.0, from_end\: :ref:`bool` = false, trans_type\: :ref:`TransitionType` = 0, ease_type\: :ref:`EaseType` = 0\ ) See :ref:`AnimationMixer.capture`. It is almost the same as the following: @@ -603,7 +577,7 @@ If ``duration`` is a negative value, the duration is set to the interval between .. rst-class:: classref-method -void **queue** **(** :ref:`StringName` name **)** +|void| **queue**\ (\ name\: :ref:`StringName`\ ) Queues an animation for playback once the current one is done. @@ -617,7 +591,7 @@ Queues an animation for playback once the current one is done. .. rst-class:: classref-method -void **seek** **(** :ref:`float` seconds, :ref:`bool` update=false, :ref:`bool` update_only=false **)** +|void| **seek**\ (\ seconds\: :ref:`float`, update\: :ref:`bool` = false, update_only\: :ref:`bool` = false\ ) Seeks the animation to the ``seconds`` point in time (in seconds). If ``update`` is ``true``, the animation updates too, otherwise it updates at process time. Events between the current frame and ``seconds`` are skipped. @@ -633,7 +607,7 @@ If ``update_only`` is ``true``, the method / audio / animation playback tracks w .. rst-class:: classref-method -void **set_blend_time** **(** :ref:`StringName` animation_from, :ref:`StringName` animation_to, :ref:`float` sec **)** +|void| **set_blend_time**\ (\ animation_from\: :ref:`StringName`, animation_to\: :ref:`StringName`, sec\: :ref:`float`\ ) Specifies a blend time (in seconds) between two animations, referenced by their keys. @@ -645,13 +619,11 @@ Specifies a blend time (in seconds) between two animations, referenced by their .. rst-class:: classref-method -void **set_method_call_mode** **(** :ref:`AnimationMethodCallMode` mode **)** +|void| **set_method_call_mode**\ (\ mode\: :ref:`AnimationMethodCallMode`\ ) **Deprecated:** Use :ref:`AnimationMixer.callback_mode_method` instead. -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the call mode used for "Call Method" tracks. .. rst-class:: classref-item-separator @@ -661,13 +633,11 @@ void **set_method_call_mode** **(** :ref:`AnimationMethodCallMode` mode **)** +|void| **set_process_callback**\ (\ mode\: :ref:`AnimationProcessCallback`\ ) **Deprecated:** Use :ref:`AnimationMixer.callback_mode_process` instead. -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the process notification in which to update animations. .. rst-class:: classref-item-separator @@ -677,13 +647,11 @@ void **set_process_callback** **(** :ref:`AnimationProcessCallback` path **)** +|void| **set_root**\ (\ path\: :ref:`NodePath`\ ) **Deprecated:** Use :ref:`AnimationMixer.root_node` instead. -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the node which node path references will travel from. .. rst-class:: classref-item-separator @@ -693,7 +661,7 @@ void **set_root** **(** :ref:`NodePath` path **)** .. rst-class:: classref-method -void **stop** **(** :ref:`bool` keep_state=false **)** +|void| **stop**\ (\ keep_state\: :ref:`bool` = false\ ) Stops the currently playing animation. The animation position is reset to ``0`` and the ``custom_speed`` is reset to ``1.0``. See also :ref:`pause`. @@ -708,3 +676,4 @@ If ``keep_state`` is ``true``, the animation state is not updated visually. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationrootnode.rst b/classes/class_animationrootnode.rst index 92d035caf13..8281adc15c3 100644 --- a/classes/class_animationrootnode.rst +++ b/classes/class_animationrootnode.rst @@ -39,3 +39,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_animationtree.rst b/classes/class_animationtree.rst index b65120f575e..63cbe82ca50 100644 --- a/classes/class_animationtree.rst +++ b/classes/class_animationtree.rst @@ -40,15 +40,17 @@ Properties .. table:: :widths: auto - +---------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`advance_expression_base_node` | ``NodePath(".")`` | - +---------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`anim_player` | ``NodePath("")`` | - +---------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ - | :ref:`bool` | deterministic | ``true`` (overrides :ref:`AnimationMixer`) | - +---------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ - | :ref:`AnimationRootNode` | :ref:`tree_root` | | - +---------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ + +-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`advance_expression_base_node` | ``NodePath(".")`` | + +-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`anim_player` | ``NodePath("")`` | + +-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`AnimationCallbackModeDiscrete` | callback_mode_discrete | ``2`` (overrides :ref:`AnimationMixer`) | + +-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`bool` | deterministic | ``true`` (overrides :ref:`AnimationMixer`) | + +-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`AnimationRootNode` | :ref:`tree_root` | | + +-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -58,11 +60,11 @@ Methods .. table:: :widths: auto - +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AnimationProcessCallback` | :ref:`get_process_callback` **(** **)** |const| | - +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_process_callback` **(** :ref:`AnimationProcessCallback` mode **)** | - +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AnimationProcessCallback` | :ref:`get_process_callback`\ (\ ) |const| | + +------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_process_callback`\ (\ mode\: :ref:`AnimationProcessCallback`\ ) | + +------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -77,7 +79,7 @@ Signals .. rst-class:: classref-signal -**animation_player_changed** **(** **)** +**animation_player_changed**\ (\ ) Emitted when the :ref:`anim_player` is changed. @@ -104,10 +106,6 @@ enum **AnimationProcessCallback**: **Deprecated:** See :ref:`AnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_PHYSICS`. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_AnimationTree_constant_ANIMATION_PROCESS_IDLE: @@ -118,10 +116,6 @@ enum **AnimationProcessCallback**: **Deprecated:** See :ref:`AnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_IDLE`. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_AnimationTree_constant_ANIMATION_PROCESS_MANUAL: @@ -132,10 +126,6 @@ enum **AnimationProcessCallback**: **Deprecated:** See :ref:`AnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_MANUAL`. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. rst-class:: classref-section-separator @@ -155,8 +145,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_advance_expression_base_node** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_advance_expression_base_node** **(** **)** +- |void| **set_advance_expression_base_node**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_advance_expression_base_node**\ (\ ) The path to the :ref:`Node` used to evaluate the :ref:`AnimationNode` :ref:`Expression` if one is not explicitly specified internally. @@ -172,8 +162,8 @@ The path to the :ref:`Node` used to evaluate the :ref:`AnimationNode .. rst-class:: classref-property-setget -- void **set_animation_player** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_animation_player** **(** **)** +- |void| **set_animation_player**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_animation_player**\ (\ ) The path to the :ref:`AnimationPlayer` used for animating. @@ -189,8 +179,8 @@ The path to the :ref:`AnimationPlayer` used for animating .. rst-class:: classref-property-setget -- void **set_tree_root** **(** :ref:`AnimationRootNode` value **)** -- :ref:`AnimationRootNode` **get_tree_root** **(** **)** +- |void| **set_tree_root**\ (\ value\: :ref:`AnimationRootNode`\ ) +- :ref:`AnimationRootNode` **get_tree_root**\ (\ ) The root animation node of this **AnimationTree**. See :ref:`AnimationRootNode`. @@ -207,13 +197,11 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AnimationProcessCallback` **get_process_callback** **(** **)** |const| +:ref:`AnimationProcessCallback` **get_process_callback**\ (\ ) |const| **Deprecated:** Use :ref:`AnimationMixer.callback_mode_process` instead. -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the process notification in which to update animations. .. rst-class:: classref-item-separator @@ -223,13 +211,11 @@ Method Descriptions .. rst-class:: classref-method -void **set_process_callback** **(** :ref:`AnimationProcessCallback` mode **)** +|void| **set_process_callback**\ (\ mode\: :ref:`AnimationProcessCallback`\ ) **Deprecated:** Use :ref:`AnimationMixer.callback_mode_process` instead. -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the process notification in which to update animations. .. |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.)` @@ -238,3 +224,4 @@ void **set_process_callback** **(** :ref:`AnimationProcessCallback` | :ref:`get_overlapping_areas` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------+ - | :ref:`Node2D[]` | :ref:`get_overlapping_bodies` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_overlapping_areas` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_overlapping_bodies` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Area2D`\] | :ref:`get_overlapping_areas`\ (\ ) |const| | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Node2D`\] | :ref:`get_overlapping_bodies`\ (\ ) |const| | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_overlapping_areas`\ (\ ) |const| | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_overlapping_bodies`\ (\ ) |const| | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`overlaps_area`\ (\ area\: :ref:`Node`\ ) |const| | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`overlaps_body`\ (\ body\: :ref:`Node`\ ) |const| | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -116,7 +116,7 @@ Signals .. rst-class:: classref-signal -**area_entered** **(** :ref:`Area2D` area **)** +**area_entered**\ (\ area\: :ref:`Area2D`\ ) Emitted when the received ``area`` enters this area. Requires :ref:`monitoring` to be set to ``true``. @@ -128,7 +128,7 @@ Emitted when the received ``area`` enters this area. Requires :ref:`monitoring` area **)** +**area_exited**\ (\ area\: :ref:`Area2D`\ ) Emitted when the received ``area`` exits this area. Requires :ref:`monitoring` to be set to ``true``. @@ -140,7 +140,7 @@ Emitted when the received ``area`` exits this area. Requires :ref:`monitoring` area_rid, :ref:`Area2D` area, :ref:`int` area_shape_index, :ref:`int` local_shape_index **)** +**area_shape_entered**\ (\ area_rid\: :ref:`RID`, area\: :ref:`Area2D`, area_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) Emitted when a :ref:`Shape2D` of the received ``area`` enters a shape of this area. Requires :ref:`monitoring` to be set to ``true``. @@ -169,7 +169,7 @@ Emitted when a :ref:`Shape2D` of the received ``area`` enters a s .. rst-class:: classref-signal -**area_shape_exited** **(** :ref:`RID` area_rid, :ref:`Area2D` area, :ref:`int` area_shape_index, :ref:`int` local_shape_index **)** +**area_shape_exited**\ (\ area_rid\: :ref:`RID`, area\: :ref:`Area2D`, area_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) Emitted when a :ref:`Shape2D` of the received ``area`` exits a shape of this area. Requires :ref:`monitoring` to be set to ``true``. @@ -183,7 +183,7 @@ See also :ref:`area_shape_entered`. .. rst-class:: classref-signal -**body_entered** **(** :ref:`Node2D` body **)** +**body_entered**\ (\ body\: :ref:`Node2D`\ ) Emitted when the received ``body`` enters this area. ``body`` can be a :ref:`PhysicsBody2D` or a :ref:`TileMap`. :ref:`TileMap`\ s are detected if their :ref:`TileSet` has collision shapes configured. Requires :ref:`monitoring` to be set to ``true``. @@ -195,7 +195,7 @@ Emitted when the received ``body`` enters this area. ``body`` can be a :ref:`Phy .. rst-class:: classref-signal -**body_exited** **(** :ref:`Node2D` body **)** +**body_exited**\ (\ body\: :ref:`Node2D`\ ) Emitted when the received ``body`` exits this area. ``body`` can be a :ref:`PhysicsBody2D` or a :ref:`TileMap`. :ref:`TileMap`\ s are detected if their :ref:`TileSet` has collision shapes configured. Requires :ref:`monitoring` to be set to ``true``. @@ -207,7 +207,7 @@ Emitted when the received ``body`` exits this area. ``body`` can be a :ref:`Phys .. rst-class:: classref-signal -**body_shape_entered** **(** :ref:`RID` body_rid, :ref:`Node2D` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** +**body_shape_entered**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node2D`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) Emitted when a :ref:`Shape2D` of the received ``body`` enters a shape of this area. ``body`` can be a :ref:`PhysicsBody2D` or a :ref:`TileMap`. :ref:`TileMap`\ s are detected if their :ref:`TileSet` has collision shapes configured. Requires :ref:`monitoring` to be set to ``true``. @@ -236,7 +236,7 @@ Emitted when a :ref:`Shape2D` of the received ``body`` enters a s .. rst-class:: classref-signal -**body_shape_exited** **(** :ref:`RID` body_rid, :ref:`Node2D` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** +**body_shape_exited**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node2D`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) Emitted when a :ref:`Shape2D` of the received ``body`` exits a shape of this area. ``body`` can be a :ref:`PhysicsBody2D` or a :ref:`TileMap`. :ref:`TileMap`\ s are detected if their :ref:`TileSet` has collision shapes configured. Requires :ref:`monitoring` to be set to ``true``. @@ -314,8 +314,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_angular_damp** **(** :ref:`float` value **)** -- :ref:`float` **get_angular_damp** **(** **)** +- |void| **set_angular_damp**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_angular_damp**\ (\ ) The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. @@ -333,8 +333,8 @@ See :ref:`ProjectSettings.physics/2d/default_angular_damp` value **)** -- :ref:`SpaceOverride` **get_angular_damp_space_override_mode** **(** **)** +- |void| **set_angular_damp_space_override_mode**\ (\ value\: :ref:`SpaceOverride`\ ) +- :ref:`SpaceOverride` **get_angular_damp_space_override_mode**\ (\ ) Override mode for angular damping calculations within this area. See :ref:`SpaceOverride` for possible values. @@ -350,8 +350,8 @@ Override mode for angular damping calculations within this area. See :ref:`Space .. rst-class:: classref-property-setget -- void **set_audio_bus_name** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_audio_bus_name** **(** **)** +- |void| **set_audio_bus_name**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_audio_bus_name**\ (\ ) The name of the area's audio bus. @@ -367,8 +367,8 @@ The name of the area's audio bus. .. rst-class:: classref-property-setget -- void **set_audio_bus_override** **(** :ref:`bool` value **)** -- :ref:`bool` **is_overriding_audio_bus** **(** **)** +- |void| **set_audio_bus_override**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_overriding_audio_bus**\ (\ ) If ``true``, the area's audio bus overrides the default audio bus. @@ -384,8 +384,8 @@ If ``true``, the area's audio bus overrides the default audio bus. .. rst-class:: classref-property-setget -- void **set_gravity** **(** :ref:`float` value **)** -- :ref:`float` **get_gravity** **(** **)** +- |void| **set_gravity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_gravity**\ (\ ) The area's gravity intensity (in pixels per second squared). This value multiplies the gravity direction. This is useful to alter the force of gravity without altering its direction. @@ -401,8 +401,8 @@ The area's gravity intensity (in pixels per second squared). This value multipli .. rst-class:: classref-property-setget -- void **set_gravity_direction** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_gravity_direction** **(** **)** +- |void| **set_gravity_direction**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_gravity_direction**\ (\ ) The area's gravity vector (not normalized). @@ -418,8 +418,8 @@ The area's gravity vector (not normalized). .. rst-class:: classref-property-setget -- void **set_gravity_is_point** **(** :ref:`bool` value **)** -- :ref:`bool` **is_gravity_a_point** **(** **)** +- |void| **set_gravity_is_point**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_gravity_a_point**\ (\ ) If ``true``, gravity is calculated from a point (set via :ref:`gravity_point_center`). See also :ref:`gravity_space_override`. @@ -435,8 +435,8 @@ If ``true``, gravity is calculated from a point (set via :ref:`gravity_point_cen .. rst-class:: classref-property-setget -- void **set_gravity_point_center** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_gravity_point_center** **(** **)** +- |void| **set_gravity_point_center**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_gravity_point_center**\ (\ ) If gravity is a point (see :ref:`gravity_point`), this will be the point of attraction. @@ -452,8 +452,8 @@ If gravity is a point (see :ref:`gravity_point` value **)** -- :ref:`float` **get_gravity_point_unit_distance** **(** **)** +- |void| **set_gravity_point_unit_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_gravity_point_unit_distance**\ (\ ) The distance at which the gravity strength is equal to :ref:`gravity`. For example, on a planet 100 pixels in radius with a surface gravity of 4.0 px/s², set the :ref:`gravity` to 4.0 and the unit distance to 100.0. The gravity will have falloff according to the inverse square law, so in the example, at 200 pixels from the center the gravity will be 1.0 px/s² (twice the distance, 1/4th the gravity), at 50 pixels it will be 16.0 px/s² (half the distance, 4x the gravity), and so on. @@ -471,8 +471,8 @@ The above is true only when the unit distance is a positive number. When this is .. rst-class:: classref-property-setget -- void **set_gravity_space_override_mode** **(** :ref:`SpaceOverride` value **)** -- :ref:`SpaceOverride` **get_gravity_space_override_mode** **(** **)** +- |void| **set_gravity_space_override_mode**\ (\ value\: :ref:`SpaceOverride`\ ) +- :ref:`SpaceOverride` **get_gravity_space_override_mode**\ (\ ) Override mode for gravity calculations within this area. See :ref:`SpaceOverride` for possible values. @@ -488,8 +488,8 @@ Override mode for gravity calculations within this area. See :ref:`SpaceOverride .. rst-class:: classref-property-setget -- void **set_linear_damp** **(** :ref:`float` value **)** -- :ref:`float` **get_linear_damp** **(** **)** +- |void| **set_linear_damp**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_linear_damp**\ (\ ) The rate at which objects stop moving in this area. Represents the linear velocity lost per second. @@ -507,8 +507,8 @@ See :ref:`ProjectSettings.physics/2d/default_linear_damp` value **)** -- :ref:`SpaceOverride` **get_linear_damp_space_override_mode** **(** **)** +- |void| **set_linear_damp_space_override_mode**\ (\ value\: :ref:`SpaceOverride`\ ) +- :ref:`SpaceOverride` **get_linear_damp_space_override_mode**\ (\ ) Override mode for linear damping calculations within this area. See :ref:`SpaceOverride` for possible values. @@ -524,8 +524,8 @@ Override mode for linear damping calculations within this area. See :ref:`SpaceO .. rst-class:: classref-property-setget -- void **set_monitorable** **(** :ref:`bool` value **)** -- :ref:`bool` **is_monitorable** **(** **)** +- |void| **set_monitorable**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_monitorable**\ (\ ) If ``true``, other monitoring areas can detect this area. @@ -541,8 +541,8 @@ If ``true``, other monitoring areas can detect this area. .. rst-class:: classref-property-setget -- void **set_monitoring** **(** :ref:`bool` value **)** -- :ref:`bool` **is_monitoring** **(** **)** +- |void| **set_monitoring**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_monitoring**\ (\ ) If ``true``, the area detects bodies or areas entering and exiting it. @@ -558,8 +558,8 @@ If ``true``, the area detects bodies or areas entering and exiting it. .. rst-class:: classref-property-setget -- void **set_priority** **(** :ref:`int` value **)** -- :ref:`int` **get_priority** **(** **)** +- |void| **set_priority**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_priority**\ (\ ) The area's priority. Higher priority areas are processed first. The :ref:`World2D`'s physics is always processed last, after all areas. @@ -576,7 +576,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Area2D[]` **get_overlapping_areas** **(** **)** |const| +:ref:`Array`\[:ref:`Area2D`\] **get_overlapping_areas**\ (\ ) |const| Returns a list of intersecting **Area2D**\ s. The overlapping area's :ref:`CollisionObject2D.collision_layer` must be part of this area's :ref:`CollisionObject2D.collision_mask` in order to be detected. @@ -590,7 +590,7 @@ For performance reasons (collisions are all processed at the same time) this lis .. rst-class:: classref-method -:ref:`Node2D[]` **get_overlapping_bodies** **(** **)** |const| +:ref:`Array`\[:ref:`Node2D`\] **get_overlapping_bodies**\ (\ ) |const| Returns a list of intersecting :ref:`PhysicsBody2D`\ s and :ref:`TileMap`\ s. The overlapping body's :ref:`CollisionObject2D.collision_layer` must be part of this area's :ref:`CollisionObject2D.collision_mask` in order to be detected. @@ -604,7 +604,7 @@ For performance reasons (collisions are all processed at the same time) this lis .. rst-class:: classref-method -:ref:`bool` **has_overlapping_areas** **(** **)** |const| +:ref:`bool` **has_overlapping_areas**\ (\ ) |const| Returns ``true`` if intersecting any **Area2D**\ s, otherwise returns ``false``. The overlapping area's :ref:`CollisionObject2D.collision_layer` must be part of this area's :ref:`CollisionObject2D.collision_mask` in order to be detected. @@ -618,7 +618,7 @@ For performance reasons (collisions are all processed at the same time) the list .. rst-class:: classref-method -:ref:`bool` **has_overlapping_bodies** **(** **)** |const| +:ref:`bool` **has_overlapping_bodies**\ (\ ) |const| Returns ``true`` if intersecting any :ref:`PhysicsBody2D`\ s or :ref:`TileMap`\ s, otherwise returns ``false``. The overlapping body's :ref:`CollisionObject2D.collision_layer` must be part of this area's :ref:`CollisionObject2D.collision_mask` in order to be detected. @@ -632,7 +632,7 @@ For performance reasons (collisions are all processed at the same time) the list .. rst-class:: classref-method -:ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** |const| +:ref:`bool` **overlaps_area**\ (\ area\: :ref:`Node`\ ) |const| Returns ``true`` if the given **Area2D** intersects or overlaps this **Area2D**, ``false`` otherwise. @@ -646,7 +646,7 @@ Returns ``true`` if the given **Area2D** intersects or overlaps this **Area2D**, .. rst-class:: classref-method -:ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** |const| +:ref:`bool` **overlaps_body**\ (\ body\: :ref:`Node`\ ) |const| Returns ``true`` if the given physics body intersects or overlaps this **Area2D**, ``false`` otherwise. @@ -661,3 +661,4 @@ The ``body`` argument can either be a :ref:`PhysicsBody2D` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_area3d.rst b/classes/class_area3d.rst index c987350dd8f..fdce53bdcb9 100644 --- a/classes/class_area3d.rst +++ b/classes/class_area3d.rst @@ -103,19 +103,19 @@ Methods .. table:: :widths: auto - +-------------------------------+----------------------------------------------------------------------------------------------------------+ - | :ref:`Area3D[]` | :ref:`get_overlapping_areas` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------+ - | :ref:`Node3D[]` | :ref:`get_overlapping_bodies` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_overlapping_areas` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_overlapping_bodies` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Area3D`\] | :ref:`get_overlapping_areas`\ (\ ) |const| | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Node3D`\] | :ref:`get_overlapping_bodies`\ (\ ) |const| | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_overlapping_areas`\ (\ ) |const| | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_overlapping_bodies`\ (\ ) |const| | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`overlaps_area`\ (\ area\: :ref:`Node`\ ) |const| | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`overlaps_body`\ (\ body\: :ref:`Node`\ ) |const| | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -130,7 +130,7 @@ Signals .. rst-class:: classref-signal -**area_entered** **(** :ref:`Area3D` area **)** +**area_entered**\ (\ area\: :ref:`Area3D`\ ) Emitted when the received ``area`` enters this area. Requires :ref:`monitoring` to be set to ``true``. @@ -142,7 +142,7 @@ Emitted when the received ``area`` enters this area. Requires :ref:`monitoring` area **)** +**area_exited**\ (\ area\: :ref:`Area3D`\ ) Emitted when the received ``area`` exits this area. Requires :ref:`monitoring` to be set to ``true``. @@ -154,7 +154,7 @@ Emitted when the received ``area`` exits this area. Requires :ref:`monitoring` area_rid, :ref:`Area3D` area, :ref:`int` area_shape_index, :ref:`int` local_shape_index **)** +**area_shape_entered**\ (\ area_rid\: :ref:`RID`, area\: :ref:`Area3D`, area_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) Emitted when a :ref:`Shape3D` of the received ``area`` enters a shape of this area. Requires :ref:`monitoring` to be set to ``true``. @@ -183,7 +183,7 @@ Emitted when a :ref:`Shape3D` of the received ``area`` enters a s .. rst-class:: classref-signal -**area_shape_exited** **(** :ref:`RID` area_rid, :ref:`Area3D` area, :ref:`int` area_shape_index, :ref:`int` local_shape_index **)** +**area_shape_exited**\ (\ area_rid\: :ref:`RID`, area\: :ref:`Area3D`, area_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) Emitted when a :ref:`Shape3D` of the received ``area`` exits a shape of this area. Requires :ref:`monitoring` to be set to ``true``. @@ -197,7 +197,7 @@ See also :ref:`area_shape_entered`. .. rst-class:: classref-signal -**body_entered** **(** :ref:`Node3D` body **)** +**body_entered**\ (\ body\: :ref:`Node3D`\ ) Emitted when the received ``body`` enters this area. ``body`` can be a :ref:`PhysicsBody3D` or a :ref:`GridMap`. :ref:`GridMap`\ s are detected if their :ref:`MeshLibrary` has collision shapes configured. Requires :ref:`monitoring` to be set to ``true``. @@ -209,7 +209,7 @@ Emitted when the received ``body`` enters this area. ``body`` can be a :ref:`Phy .. rst-class:: classref-signal -**body_exited** **(** :ref:`Node3D` body **)** +**body_exited**\ (\ body\: :ref:`Node3D`\ ) Emitted when the received ``body`` exits this area. ``body`` can be a :ref:`PhysicsBody3D` or a :ref:`GridMap`. :ref:`GridMap`\ s are detected if their :ref:`MeshLibrary` has collision shapes configured. Requires :ref:`monitoring` to be set to ``true``. @@ -221,7 +221,7 @@ Emitted when the received ``body`` exits this area. ``body`` can be a :ref:`Phys .. rst-class:: classref-signal -**body_shape_entered** **(** :ref:`RID` body_rid, :ref:`Node3D` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** +**body_shape_entered**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node3D`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) Emitted when a :ref:`Shape3D` of the received ``body`` enters a shape of this area. ``body`` can be a :ref:`PhysicsBody3D` or a :ref:`GridMap`. :ref:`GridMap`\ s are detected if their :ref:`MeshLibrary` has collision shapes configured. Requires :ref:`monitoring` to be set to ``true``. @@ -250,7 +250,7 @@ Emitted when a :ref:`Shape3D` of the received ``body`` enters a s .. rst-class:: classref-signal -**body_shape_exited** **(** :ref:`RID` body_rid, :ref:`Node3D` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** +**body_shape_exited**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node3D`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) Emitted when a :ref:`Shape3D` of the received ``body`` exits a shape of this area. ``body`` can be a :ref:`PhysicsBody3D` or a :ref:`GridMap`. :ref:`GridMap`\ s are detected if their :ref:`MeshLibrary` has collision shapes configured. Requires :ref:`monitoring` to be set to ``true``. @@ -328,8 +328,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_angular_damp** **(** :ref:`float` value **)** -- :ref:`float` **get_angular_damp** **(** **)** +- |void| **set_angular_damp**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_angular_damp**\ (\ ) The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. @@ -347,8 +347,8 @@ See :ref:`ProjectSettings.physics/3d/default_angular_damp` value **)** -- :ref:`SpaceOverride` **get_angular_damp_space_override_mode** **(** **)** +- |void| **set_angular_damp_space_override_mode**\ (\ value\: :ref:`SpaceOverride`\ ) +- :ref:`SpaceOverride` **get_angular_damp_space_override_mode**\ (\ ) Override mode for angular damping calculations within this area. See :ref:`SpaceOverride` for possible values. @@ -364,8 +364,8 @@ Override mode for angular damping calculations within this area. See :ref:`Space .. rst-class:: classref-property-setget -- void **set_audio_bus_name** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_audio_bus_name** **(** **)** +- |void| **set_audio_bus_name**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_audio_bus_name**\ (\ ) The name of the area's audio bus. @@ -381,8 +381,8 @@ The name of the area's audio bus. .. rst-class:: classref-property-setget -- void **set_audio_bus_override** **(** :ref:`bool` value **)** -- :ref:`bool` **is_overriding_audio_bus** **(** **)** +- |void| **set_audio_bus_override**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_overriding_audio_bus**\ (\ ) If ``true``, the area's audio bus overrides the default audio bus. @@ -398,8 +398,8 @@ If ``true``, the area's audio bus overrides the default audio bus. .. rst-class:: classref-property-setget -- void **set_gravity** **(** :ref:`float` value **)** -- :ref:`float` **get_gravity** **(** **)** +- |void| **set_gravity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_gravity**\ (\ ) The area's gravity intensity (in meters per second squared). This value multiplies the gravity direction. This is useful to alter the force of gravity without altering its direction. @@ -415,8 +415,8 @@ The area's gravity intensity (in meters per second squared). This value multipli .. rst-class:: classref-property-setget -- void **set_gravity_direction** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_gravity_direction** **(** **)** +- |void| **set_gravity_direction**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_gravity_direction**\ (\ ) The area's gravity vector (not normalized). @@ -432,8 +432,8 @@ The area's gravity vector (not normalized). .. rst-class:: classref-property-setget -- void **set_gravity_is_point** **(** :ref:`bool` value **)** -- :ref:`bool` **is_gravity_a_point** **(** **)** +- |void| **set_gravity_is_point**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_gravity_a_point**\ (\ ) If ``true``, gravity is calculated from a point (set via :ref:`gravity_point_center`). See also :ref:`gravity_space_override`. @@ -449,8 +449,8 @@ If ``true``, gravity is calculated from a point (set via :ref:`gravity_point_cen .. rst-class:: classref-property-setget -- void **set_gravity_point_center** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_gravity_point_center** **(** **)** +- |void| **set_gravity_point_center**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_gravity_point_center**\ (\ ) If gravity is a point (see :ref:`gravity_point`), this will be the point of attraction. @@ -466,8 +466,8 @@ If gravity is a point (see :ref:`gravity_point` value **)** -- :ref:`float` **get_gravity_point_unit_distance** **(** **)** +- |void| **set_gravity_point_unit_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_gravity_point_unit_distance**\ (\ ) The distance at which the gravity strength is equal to :ref:`gravity`. For example, on a planet 100 meters in radius with a surface gravity of 4.0 m/s², set the :ref:`gravity` to 4.0 and the unit distance to 100.0. The gravity will have falloff according to the inverse square law, so in the example, at 200 meters from the center the gravity will be 1.0 m/s² (twice the distance, 1/4th the gravity), at 50 meters it will be 16.0 m/s² (half the distance, 4x the gravity), and so on. @@ -485,8 +485,8 @@ The above is true only when the unit distance is a positive number. When this is .. rst-class:: classref-property-setget -- void **set_gravity_space_override_mode** **(** :ref:`SpaceOverride` value **)** -- :ref:`SpaceOverride` **get_gravity_space_override_mode** **(** **)** +- |void| **set_gravity_space_override_mode**\ (\ value\: :ref:`SpaceOverride`\ ) +- :ref:`SpaceOverride` **get_gravity_space_override_mode**\ (\ ) Override mode for gravity calculations within this area. See :ref:`SpaceOverride` for possible values. @@ -502,8 +502,8 @@ Override mode for gravity calculations within this area. See :ref:`SpaceOverride .. rst-class:: classref-property-setget -- void **set_linear_damp** **(** :ref:`float` value **)** -- :ref:`float` **get_linear_damp** **(** **)** +- |void| **set_linear_damp**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_linear_damp**\ (\ ) The rate at which objects stop moving in this area. Represents the linear velocity lost per second. @@ -521,8 +521,8 @@ See :ref:`ProjectSettings.physics/3d/default_linear_damp` value **)** -- :ref:`SpaceOverride` **get_linear_damp_space_override_mode** **(** **)** +- |void| **set_linear_damp_space_override_mode**\ (\ value\: :ref:`SpaceOverride`\ ) +- :ref:`SpaceOverride` **get_linear_damp_space_override_mode**\ (\ ) Override mode for linear damping calculations within this area. See :ref:`SpaceOverride` for possible values. @@ -538,8 +538,8 @@ Override mode for linear damping calculations within this area. See :ref:`SpaceO .. rst-class:: classref-property-setget -- void **set_monitorable** **(** :ref:`bool` value **)** -- :ref:`bool` **is_monitorable** **(** **)** +- |void| **set_monitorable**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_monitorable**\ (\ ) If ``true``, other monitoring areas can detect this area. @@ -555,8 +555,8 @@ If ``true``, other monitoring areas can detect this area. .. rst-class:: classref-property-setget -- void **set_monitoring** **(** :ref:`bool` value **)** -- :ref:`bool` **is_monitoring** **(** **)** +- |void| **set_monitoring**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_monitoring**\ (\ ) If ``true``, the area detects bodies or areas entering and exiting it. @@ -572,8 +572,8 @@ If ``true``, the area detects bodies or areas entering and exiting it. .. rst-class:: classref-property-setget -- void **set_priority** **(** :ref:`int` value **)** -- :ref:`int` **get_priority** **(** **)** +- |void| **set_priority**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_priority**\ (\ ) The area's priority. Higher priority areas are processed first. The :ref:`World3D`'s physics is always processed last, after all areas. @@ -589,8 +589,8 @@ The area's priority. Higher priority areas are processed first. The :ref:`World3 .. rst-class:: classref-property-setget -- void **set_reverb_amount** **(** :ref:`float` value **)** -- :ref:`float` **get_reverb_amount** **(** **)** +- |void| **set_reverb_amount**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_reverb_amount**\ (\ ) The degree to which this area applies reverb to its associated audio. Ranges from ``0`` to ``1`` with ``0.1`` precision. @@ -606,8 +606,8 @@ The degree to which this area applies reverb to its associated audio. Ranges fro .. rst-class:: classref-property-setget -- void **set_use_reverb_bus** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_reverb_bus** **(** **)** +- |void| **set_use_reverb_bus**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_reverb_bus**\ (\ ) If ``true``, the area applies reverb to its associated audio. @@ -623,8 +623,8 @@ If ``true``, the area applies reverb to its associated audio. .. rst-class:: classref-property-setget -- void **set_reverb_bus_name** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_reverb_bus_name** **(** **)** +- |void| **set_reverb_bus_name**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_reverb_bus_name**\ (\ ) The name of the reverb bus to use for this area's associated audio. @@ -640,8 +640,8 @@ The name of the reverb bus to use for this area's associated audio. .. rst-class:: classref-property-setget -- void **set_reverb_uniformity** **(** :ref:`float` value **)** -- :ref:`float` **get_reverb_uniformity** **(** **)** +- |void| **set_reverb_uniformity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_reverb_uniformity**\ (\ ) The degree to which this area's reverb is a uniform effect. Ranges from ``0`` to ``1`` with ``0.1`` precision. @@ -657,8 +657,8 @@ The degree to which this area's reverb is a uniform effect. Ranges from ``0`` to .. rst-class:: classref-property-setget -- void **set_wind_attenuation_factor** **(** :ref:`float` value **)** -- :ref:`float` **get_wind_attenuation_factor** **(** **)** +- |void| **set_wind_attenuation_factor**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_wind_attenuation_factor**\ (\ ) The exponential rate at which wind force decreases with distance from its origin. @@ -674,8 +674,8 @@ The exponential rate at which wind force decreases with distance from its origin .. rst-class:: classref-property-setget -- void **set_wind_force_magnitude** **(** :ref:`float` value **)** -- :ref:`float` **get_wind_force_magnitude** **(** **)** +- |void| **set_wind_force_magnitude**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_wind_force_magnitude**\ (\ ) The magnitude of area-specific wind force. @@ -691,8 +691,8 @@ The magnitude of area-specific wind force. .. rst-class:: classref-property-setget -- void **set_wind_source_path** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_wind_source_path** **(** **)** +- |void| **set_wind_source_path**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_wind_source_path**\ (\ ) The :ref:`Node3D` which is used to specify the direction and origin of an area-specific wind force. The direction is opposite to the z-axis of the :ref:`Node3D`'s local transform, and its origin is the origin of the :ref:`Node3D`'s local transform. @@ -709,7 +709,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Area3D[]` **get_overlapping_areas** **(** **)** |const| +:ref:`Array`\[:ref:`Area3D`\] **get_overlapping_areas**\ (\ ) |const| Returns a list of intersecting **Area3D**\ s. The overlapping area's :ref:`CollisionObject3D.collision_layer` must be part of this area's :ref:`CollisionObject3D.collision_mask` in order to be detected. @@ -723,7 +723,7 @@ For performance reasons (collisions are all processed at the same time) this lis .. rst-class:: classref-method -:ref:`Node3D[]` **get_overlapping_bodies** **(** **)** |const| +:ref:`Array`\[:ref:`Node3D`\] **get_overlapping_bodies**\ (\ ) |const| Returns a list of intersecting :ref:`PhysicsBody3D`\ s and :ref:`GridMap`\ s. The overlapping body's :ref:`CollisionObject3D.collision_layer` must be part of this area's :ref:`CollisionObject3D.collision_mask` in order to be detected. @@ -737,7 +737,7 @@ For performance reasons (collisions are all processed at the same time) this lis .. rst-class:: classref-method -:ref:`bool` **has_overlapping_areas** **(** **)** |const| +:ref:`bool` **has_overlapping_areas**\ (\ ) |const| Returns ``true`` if intersecting any **Area3D**\ s, otherwise returns ``false``. The overlapping area's :ref:`CollisionObject3D.collision_layer` must be part of this area's :ref:`CollisionObject3D.collision_mask` in order to be detected. @@ -751,7 +751,7 @@ For performance reasons (collisions are all processed at the same time) the list .. rst-class:: classref-method -:ref:`bool` **has_overlapping_bodies** **(** **)** |const| +:ref:`bool` **has_overlapping_bodies**\ (\ ) |const| Returns ``true`` if intersecting any :ref:`PhysicsBody3D`\ s or :ref:`GridMap`\ s, otherwise returns ``false``. The overlapping body's :ref:`CollisionObject3D.collision_layer` must be part of this area's :ref:`CollisionObject3D.collision_mask` in order to be detected. @@ -765,7 +765,7 @@ For performance reasons (collisions are all processed at the same time) the list .. rst-class:: classref-method -:ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** |const| +:ref:`bool` **overlaps_area**\ (\ area\: :ref:`Node`\ ) |const| Returns ``true`` if the given **Area3D** intersects or overlaps this **Area3D**, ``false`` otherwise. @@ -779,7 +779,7 @@ Returns ``true`` if the given **Area3D** intersects or overlaps this **Area3D**, .. rst-class:: classref-method -:ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** |const| +:ref:`bool` **overlaps_body**\ (\ body\: :ref:`Node`\ ) |const| Returns ``true`` if the given physics body intersects or overlaps this **Area3D**, ``false`` otherwise. @@ -794,3 +794,4 @@ The ``body`` argument can either be a :ref:`PhysicsBody3D` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_array.rst b/classes/class_array.rst index 1664ee4a829..842fc9eec20 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -80,31 +80,31 @@ Constructors .. table:: :widths: auto - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`Array` **(** **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`Array` **(** :ref:`Array` base, :ref:`int` type, :ref:`StringName` class_name, :ref:`Variant` script **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`Array` **(** :ref:`Array` from **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`Array` **(** :ref:`PackedByteArray` from **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`Array` **(** :ref:`PackedColorArray` from **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`Array` **(** :ref:`PackedFloat32Array` from **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`Array` **(** :ref:`PackedFloat64Array` from **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`Array` **(** :ref:`PackedInt32Array` from **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`Array` **(** :ref:`PackedInt64Array` from **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`Array` **(** :ref:`PackedStringArray` from **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`Array` **(** :ref:`PackedVector2Array` from **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`Array` **(** :ref:`PackedVector3Array` from **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`Array`\ (\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`Array`\ (\ base\: :ref:`Array`, type\: :ref:`int`, class_name\: :ref:`StringName`, script\: :ref:`Variant`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`Array`\ (\ from\: :ref:`Array`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`Array`\ (\ from\: :ref:`PackedByteArray`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`Array`\ (\ from\: :ref:`PackedColorArray`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`Array`\ (\ from\: :ref:`PackedFloat32Array`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`Array`\ (\ from\: :ref:`PackedFloat64Array`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`Array`\ (\ from\: :ref:`PackedInt32Array`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`Array`\ (\ from\: :ref:`PackedInt64Array`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`Array`\ (\ from\: :ref:`PackedStringArray`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`Array`\ (\ from\: :ref:`PackedVector2Array`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`Array`\ (\ from\: :ref:`PackedVector3Array`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -114,99 +114,99 @@ Methods .. table:: :widths: auto - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`all` **(** :ref:`Callable` method **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`any` **(** :ref:`Callable` method **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`append` **(** :ref:`Variant` value **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`append_array` **(** :ref:`Array` array **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`assign` **(** :ref:`Array` array **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`back` **(** **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch` **(** :ref:`Variant` value, :ref:`bool` before=true **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch_custom` **(** :ref:`Variant` value, :ref:`Callable` func, :ref:`bool` before=true **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count` **(** :ref:`Variant` value **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`duplicate` **(** :ref:`bool` deep=false **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`erase` **(** :ref:`Variant` value **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fill` **(** :ref:`Variant` value **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`filter` **(** :ref:`Callable` method **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find` **(** :ref:`Variant` what, :ref:`int` from=0 **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`front` **(** **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_typed_builtin` **(** **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_typed_class_name` **(** **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_typed_script` **(** **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has` **(** :ref:`Variant` value **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`hash` **(** **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`insert` **(** :ref:`int` position, :ref:`Variant` value **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty` **(** **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_read_only` **(** **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_same_typed` **(** :ref:`Array` array **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_typed` **(** **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`make_read_only` **(** **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`map` **(** :ref:`Callable` method **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`max` **(** **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`min` **(** **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`pick_random` **(** **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`pop_at` **(** :ref:`int` position **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`pop_back` **(** **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`pop_front` **(** **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_back` **(** :ref:`Variant` value **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_front` **(** :ref:`Variant` value **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`reduce` **(** :ref:`Callable` method, :ref:`Variant` accum=null **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_at` **(** :ref:`int` position **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resize` **(** :ref:`int` size **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reverse` **(** **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind` **(** :ref:`Variant` what, :ref:`int` from=-1 **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shuffle` **(** **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size` **(** **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`slice` **(** :ref:`int` begin, :ref:`int` end=2147483647, :ref:`int` step=1, :ref:`bool` deep=false **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`sort` **(** **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`sort_custom` **(** :ref:`Callable` func **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`all`\ (\ method\: :ref:`Callable`\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`any`\ (\ method\: :ref:`Callable`\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append`\ (\ value\: :ref:`Variant`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`Array`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`assign`\ (\ array\: :ref:`Array`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`back`\ (\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`Variant`, before\: :ref:`bool` = true\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch_custom`\ (\ value\: :ref:`Variant`, func\: :ref:`Callable`, before\: :ref:`bool` = true\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`Variant`\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`duplicate`\ (\ deep\: :ref:`bool` = false\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`erase`\ (\ value\: :ref:`Variant`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`Variant`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`filter`\ (\ method\: :ref:`Callable`\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ what\: :ref:`Variant`, from\: :ref:`int` = 0\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`front`\ (\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_typed_builtin`\ (\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_typed_class_name`\ (\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_typed_script`\ (\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`Variant`\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`hash`\ (\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ position\: :ref:`int`, value\: :ref:`Variant`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_read_only`\ (\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_same_typed`\ (\ array\: :ref:`Array`\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_typed`\ (\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`make_read_only`\ (\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`map`\ (\ method\: :ref:`Callable`\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`max`\ (\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`min`\ (\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`pick_random`\ (\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`pop_at`\ (\ position\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`pop_back`\ (\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`pop_front`\ (\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_back`\ (\ value\: :ref:`Variant`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_front`\ (\ value\: :ref:`Variant`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`reduce`\ (\ method\: :ref:`Callable`, accum\: :ref:`Variant` = null\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ position\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ size\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ what\: :ref:`Variant`, from\: :ref:`int` = -1\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shuffle`\ (\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647, step\: :ref:`int` = 1, deep\: :ref:`bool` = false\ ) |const| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sort`\ (\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sort_custom`\ (\ func\: :ref:`Callable`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -216,23 +216,23 @@ Operators .. table:: :widths: auto - +-------------------------------+-------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Array` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`operator +` **(** :ref:`Array` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<` **(** :ref:`Array` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<=` **(** :ref:`Array` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Array` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >` **(** :ref:`Array` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >=` **(** :ref:`Array` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`operator []` **(** :ref:`int` index **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------+ + +-------------------------------+----------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Array`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`operator +`\ (\ right\: :ref:`Array`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<`\ (\ right\: :ref:`Array`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<=`\ (\ right\: :ref:`Array`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Array`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >`\ (\ right\: :ref:`Array`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >=`\ (\ right\: :ref:`Array`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -247,7 +247,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Array` **Array** **(** **)** +:ref:`Array` **Array**\ (\ ) Constructs an empty **Array**. @@ -257,7 +257,7 @@ Constructs an empty **Array**. .. rst-class:: classref-constructor -:ref:`Array` **Array** **(** :ref:`Array` base, :ref:`int` type, :ref:`StringName` class_name, :ref:`Variant` script **)** +:ref:`Array` **Array**\ (\ base\: :ref:`Array`, type\: :ref:`int`, class_name\: :ref:`StringName`, script\: :ref:`Variant`\ ) Creates a typed array from the ``base`` array. @@ -267,7 +267,7 @@ Creates a typed array from the ``base`` array. .. rst-class:: classref-constructor -:ref:`Array` **Array** **(** :ref:`Array` from **)** +:ref:`Array` **Array**\ (\ from\: :ref:`Array`\ ) Returns the same array as ``from``. If you need a copy of the array, use :ref:`duplicate`. @@ -277,7 +277,7 @@ Returns the same array as ``from``. If you need a copy of the array, use :ref:`d .. rst-class:: classref-constructor -:ref:`Array` **Array** **(** :ref:`PackedByteArray` from **)** +:ref:`Array` **Array**\ (\ from\: :ref:`PackedByteArray`\ ) Constructs an array from a :ref:`PackedByteArray`. @@ -287,7 +287,7 @@ Constructs an array from a :ref:`PackedByteArray`. .. rst-class:: classref-constructor -:ref:`Array` **Array** **(** :ref:`PackedColorArray` from **)** +:ref:`Array` **Array**\ (\ from\: :ref:`PackedColorArray`\ ) Constructs an array from a :ref:`PackedColorArray`. @@ -297,7 +297,7 @@ Constructs an array from a :ref:`PackedColorArray`. .. rst-class:: classref-constructor -:ref:`Array` **Array** **(** :ref:`PackedFloat32Array` from **)** +:ref:`Array` **Array**\ (\ from\: :ref:`PackedFloat32Array`\ ) Constructs an array from a :ref:`PackedFloat32Array`. @@ -307,7 +307,7 @@ Constructs an array from a :ref:`PackedFloat32Array`. .. rst-class:: classref-constructor -:ref:`Array` **Array** **(** :ref:`PackedFloat64Array` from **)** +:ref:`Array` **Array**\ (\ from\: :ref:`PackedFloat64Array`\ ) Constructs an array from a :ref:`PackedFloat64Array`. @@ -317,7 +317,7 @@ Constructs an array from a :ref:`PackedFloat64Array`. .. rst-class:: classref-constructor -:ref:`Array` **Array** **(** :ref:`PackedInt32Array` from **)** +:ref:`Array` **Array**\ (\ from\: :ref:`PackedInt32Array`\ ) Constructs an array from a :ref:`PackedInt32Array`. @@ -327,7 +327,7 @@ Constructs an array from a :ref:`PackedInt32Array`. .. rst-class:: classref-constructor -:ref:`Array` **Array** **(** :ref:`PackedInt64Array` from **)** +:ref:`Array` **Array**\ (\ from\: :ref:`PackedInt64Array`\ ) Constructs an array from a :ref:`PackedInt64Array`. @@ -337,7 +337,7 @@ Constructs an array from a :ref:`PackedInt64Array`. .. rst-class:: classref-constructor -:ref:`Array` **Array** **(** :ref:`PackedStringArray` from **)** +:ref:`Array` **Array**\ (\ from\: :ref:`PackedStringArray`\ ) Constructs an array from a :ref:`PackedStringArray`. @@ -347,7 +347,7 @@ Constructs an array from a :ref:`PackedStringArray`. .. rst-class:: classref-constructor -:ref:`Array` **Array** **(** :ref:`PackedVector2Array` from **)** +:ref:`Array` **Array**\ (\ from\: :ref:`PackedVector2Array`\ ) Constructs an array from a :ref:`PackedVector2Array`. @@ -357,7 +357,7 @@ Constructs an array from a :ref:`PackedVector2Array`. .. rst-class:: classref-constructor -:ref:`Array` **Array** **(** :ref:`PackedVector3Array` from **)** +:ref:`Array` **Array**\ (\ from\: :ref:`PackedVector3Array`\ ) Constructs an array from a :ref:`PackedVector3Array`. @@ -374,7 +374,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **all** **(** :ref:`Callable` method **)** |const| +:ref:`bool` **all**\ (\ method\: :ref:`Callable`\ ) |const| Calls the provided :ref:`Callable` on each element in the array and returns ``true`` if the :ref:`Callable` returns ``true`` for *all* elements in the array. If the :ref:`Callable` returns ``false`` for one array element or more, this method returns ``false``. @@ -407,7 +407,7 @@ See also :ref:`any`, :ref:`filter` **any** **(** :ref:`Callable` method **)** |const| +:ref:`bool` **any**\ (\ method\: :ref:`Callable`\ ) |const| Calls the provided :ref:`Callable` on each element in the array and returns ``true`` if the :ref:`Callable` returns ``true`` for *one or more* elements in the array. If the :ref:`Callable` returns ``false`` for all elements in the array, this method returns ``false``. @@ -440,7 +440,7 @@ See also :ref:`all`, :ref:`filter` value **)** +|void| **append**\ (\ value\: :ref:`Variant`\ ) Appends an element at the end of the array (alias of :ref:`push_back`). @@ -452,7 +452,7 @@ Appends an element at the end of the array (alias of :ref:`push_back` array **)** +|void| **append_array**\ (\ array\: :ref:`Array`\ ) Appends another array at the end of this array. @@ -471,7 +471,7 @@ Appends another array at the end of this array. .. rst-class:: classref-method -void **assign** **(** :ref:`Array` array **)** +|void| **assign**\ (\ array\: :ref:`Array`\ ) Assigns elements of another ``array`` into the array. Resizes the array to match ``array``. Performs type conversions if the array is typed. @@ -483,7 +483,7 @@ Assigns elements of another ``array`` into the array. Resizes the array to match .. rst-class:: classref-method -:ref:`Variant` **back** **(** **)** |const| +:ref:`Variant` **back**\ (\ ) |const| Returns the last element of the array. Prints an error and returns ``null`` if the array is empty. @@ -497,7 +497,7 @@ Returns the last element of the array. Prints an error and returns ``null`` if t .. rst-class:: classref-method -:ref:`int` **bsearch** **(** :ref:`Variant` value, :ref:`bool` before=true **)** |const| +:ref:`int` **bsearch**\ (\ value\: :ref:`Variant`, before\: :ref:`bool` = true\ ) |const| 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. @@ -511,7 +511,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -:ref:`int` **bsearch_custom** **(** :ref:`Variant` value, :ref:`Callable` func, :ref:`bool` before=true **)** |const| +:ref:`int` **bsearch_custom**\ (\ value\: :ref:`Variant`, func\: :ref:`Callable`, before\: :ref:`bool` = true\ ) |const| 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. @@ -525,7 +525,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -537,7 +537,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count** **(** :ref:`Variant` value **)** |const| +:ref:`int` **count**\ (\ value\: :ref:`Variant`\ ) |const| Returns the number of times an element is in the array. @@ -549,7 +549,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`Array` **duplicate** **(** :ref:`bool` deep=false **)** |const| +:ref:`Array` **duplicate**\ (\ deep\: :ref:`bool` = false\ ) |const| Returns a copy of the array. @@ -563,7 +563,7 @@ If ``deep`` is ``true``, a deep copy is performed: all nested arrays and diction .. rst-class:: classref-method -void **erase** **(** :ref:`Variant` value **)** +|void| **erase**\ (\ value\: :ref:`Variant`\ ) Removes the first occurrence of a value from the array. If the value does not exist in the array, nothing happens. To remove an element by index, use :ref:`remove_at` instead. @@ -581,7 +581,7 @@ Removes the first occurrence of a value from the array. If the value does not ex .. rst-class:: classref-method -void **fill** **(** :ref:`Variant` value **)** +|void| **fill**\ (\ value\: :ref:`Variant`\ ) Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements: @@ -612,7 +612,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`Array` **filter** **(** :ref:`Callable` method **)** |const| +:ref:`Array` **filter**\ (\ method\: :ref:`Callable`\ ) |const| Calls the provided :ref:`Callable` on each element in the array and returns a new array with the elements for which the method returned ``true``. @@ -637,7 +637,7 @@ See also :ref:`any`, :ref:`all`, .. rst-class:: classref-method -:ref:`int` **find** **(** :ref:`Variant` what, :ref:`int` from=0 **)** |const| +:ref:`int` **find**\ (\ what\: :ref:`Variant`, from\: :ref:`int` = 0\ ) |const| Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -649,7 +649,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`Variant` **front** **(** **)** |const| +:ref:`Variant` **front**\ (\ ) |const| Returns the first element of the array. Prints an error and returns ``null`` if the array is empty. @@ -663,7 +663,7 @@ Returns the first element of the array. Prints an error and returns ``null`` if .. rst-class:: classref-method -:ref:`int` **get_typed_builtin** **(** **)** |const| +: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`. @@ -675,7 +675,7 @@ Returns the :ref:`Variant.Type` constant for a t .. rst-class:: classref-method -:ref:`StringName` **get_typed_class_name** **(** **)** |const| +:ref:`StringName` **get_typed_class_name**\ (\ ) |const| Returns a class name of a typed **Array** of type :ref:`@GlobalScope.TYPE_OBJECT`. @@ -687,7 +687,7 @@ Returns a class name of a typed **Array** of type :ref:`@GlobalScope.TYPE_OBJECT .. rst-class:: classref-method -:ref:`Variant` **get_typed_script** **(** **)** |const| +:ref:`Variant` **get_typed_script**\ (\ ) |const| Returns the script associated with a typed array tied to a class name. @@ -699,7 +699,7 @@ Returns the script associated with a typed array tied to a class name. .. rst-class:: classref-method -:ref:`bool` **has** **(** :ref:`Variant` value **)** |const| +:ref:`bool` **has**\ (\ value\: :ref:`Variant`\ ) |const| Returns ``true`` if the array contains the given value. @@ -754,7 +754,7 @@ Returns ``true`` if the array contains the given value. .. rst-class:: classref-method -:ref:`int` **hash** **(** **)** |const| +:ref:`int` **hash**\ (\ ) |const| Returns a hashed 32-bit integer value representing the array and its contents. @@ -768,7 +768,7 @@ Returns a hashed 32-bit integer value representing the array and its contents. .. rst-class:: classref-method -:ref:`int` **insert** **(** :ref:`int` position, :ref:`Variant` value **)** +:ref:`int` **insert**\ (\ position\: :ref:`int`, value\: :ref:`Variant`\ ) Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``pos == size()``). Returns :ref:`@GlobalScope.OK` on success, or one of the other :ref:`Error` values if the operation failed. @@ -784,7 +784,7 @@ Inserts a new element at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty** **(** **)** |const| +:ref:`bool` **is_empty**\ (\ ) |const| Returns ``true`` if the array is empty. @@ -796,7 +796,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **is_read_only** **(** **)** |const| +:ref:`bool` **is_read_only**\ (\ ) |const| Returns ``true`` if the array is read-only. See :ref:`make_read_only`. Arrays are automatically read-only if declared with ``const`` keyword. @@ -808,7 +808,7 @@ Returns ``true`` if the array is read-only. See :ref:`make_read_only` **is_same_typed** **(** :ref:`Array` array **)** |const| +:ref:`bool` **is_same_typed**\ (\ array\: :ref:`Array`\ ) |const| Returns ``true`` if the array is typed the same as ``array``. @@ -820,7 +820,7 @@ Returns ``true`` if the array is typed the same as ``array``. .. rst-class:: classref-method -:ref:`bool` **is_typed** **(** **)** |const| +:ref:`bool` **is_typed**\ (\ ) |const| Returns ``true`` if the array is typed. Typed arrays can only store elements of their associated type and provide type safety for the ``[]`` operator. Methods of typed array still return :ref:`Variant`. @@ -832,7 +832,7 @@ Returns ``true`` if the array is typed. Typed arrays can only store elements of .. rst-class:: classref-method -void **make_read_only** **(** **)** +|void| **make_read_only**\ (\ ) Makes the array read-only, i.e. disabled modifying of the array's elements. Does not apply to nested content, e.g. content of nested arrays. @@ -844,7 +844,7 @@ Makes the array read-only, i.e. disabled modifying of the array's elements. Does .. rst-class:: classref-method -:ref:`Array` **map** **(** :ref:`Callable` method **)** |const| +:ref:`Array` **map**\ (\ method\: :ref:`Callable`\ ) |const| Calls the provided :ref:`Callable` for each element in the array and returns a new array filled with values returned by the method. @@ -869,7 +869,7 @@ See also :ref:`filter`, :ref:`reduce` **max** **(** **)** |const| +:ref:`Variant` **max**\ (\ ) |const| Returns the maximum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned. @@ -893,7 +893,7 @@ To find the maximum value using a custom comparator, you can use :ref:`reduce` **min** **(** **)** |const| +:ref:`Variant` **min**\ (\ ) |const| Returns the minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned. @@ -907,7 +907,7 @@ See also :ref:`max` for an example of using a custom com .. rst-class:: classref-method -:ref:`Variant` **pick_random** **(** **)** |const| +:ref:`Variant` **pick_random**\ (\ ) |const| Returns a random value from the target array. Prints an error and returns ``null`` if the array is empty. @@ -934,7 +934,7 @@ Returns a random value from the target array. Prints an error and returns ``null .. rst-class:: classref-method -:ref:`Variant` **pop_at** **(** :ref:`int` position **)** +:ref:`Variant` **pop_at**\ (\ position\: :ref:`int`\ ) 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. @@ -948,7 +948,7 @@ Removes and returns the element of the array at index ``position``. If negative, .. rst-class:: classref-method -:ref:`Variant` **pop_back** **(** **)** +:ref:`Variant` **pop_back**\ (\ ) Removes and returns the last element of the array. Returns ``null`` if the array is empty, without printing an error message. See also :ref:`pop_front`. @@ -960,7 +960,7 @@ Removes and returns the last element of the array. Returns ``null`` if the array .. rst-class:: classref-method -:ref:`Variant` **pop_front** **(** **)** +:ref:`Variant` **pop_front**\ (\ ) Removes and returns the first element of the array. Returns ``null`` if the array is empty, without printing an error message. See also :ref:`pop_back`. @@ -974,7 +974,7 @@ Removes and returns the first element of the array. Returns ``null`` if the arra .. rst-class:: classref-method -void **push_back** **(** :ref:`Variant` value **)** +|void| **push_back**\ (\ value\: :ref:`Variant`\ ) Appends an element at the end of the array. See also :ref:`push_front`. @@ -986,7 +986,7 @@ Appends an element at the end of the array. See also :ref:`push_front` value **)** +|void| **push_front**\ (\ value\: :ref:`Variant`\ ) Adds an element at the beginning of the array. See also :ref:`push_back`. @@ -1000,7 +1000,7 @@ Adds an element at the beginning of the array. See also :ref:`push_back` **reduce** **(** :ref:`Callable` method, :ref:`Variant` accum=null **)** |const| +:ref:`Variant` **reduce**\ (\ method\: :ref:`Callable`, accum\: :ref:`Variant` = null\ ) |const| Calls the provided :ref:`Callable` for each element in array and accumulates the result in ``accum``. @@ -1025,7 +1025,7 @@ See also :ref:`map`, :ref:`filter` position **)** +|void| **remove_at**\ (\ position\: :ref:`int`\ ) Removes an element from the array by index. If the index does not exist in the array, nothing happens. To remove an element by searching for its value, use :ref:`erase` instead. @@ -1043,7 +1043,7 @@ Removes an element from the array by index. If the index does not exist in the a .. rst-class:: classref-method -:ref:`int` **resize** **(** :ref:`int` size **)** +:ref:`int` **resize**\ (\ size\: :ref:`int`\ ) 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. @@ -1059,7 +1059,7 @@ Calling :ref:`resize` once and assigning the new valu .. rst-class:: classref-method -void **reverse** **(** **)** +|void| **reverse**\ (\ ) Reverses the order of the elements in the array. @@ -1071,7 +1071,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind** **(** :ref:`Variant` what, :ref:`int` from=-1 **)** |const| +:ref:`int` **rfind**\ (\ what\: :ref:`Variant`, from\: :ref:`int` = -1\ ) |const| Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -1083,7 +1083,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -void **shuffle** **(** **)** +|void| **shuffle**\ (\ ) Shuffles the array such that the items will have a random order. This method uses the global random number generator common to methods such as :ref:`@GlobalScope.randi`. Call :ref:`@GlobalScope.randomize` to ensure that a new seed will be used each time if you want non-reproducible shuffling. @@ -1095,7 +1095,7 @@ Shuffles the array such that the items will have a random order. This method use .. rst-class:: classref-method -:ref:`int` **size** **(** **)** |const| +:ref:`int` **size**\ (\ ) |const| Returns the number of elements in the array. @@ -1107,7 +1107,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`Array` **slice** **(** :ref:`int` begin, :ref:`int` end=2147483647, :ref:`int` step=1, :ref:`bool` deep=false **)** |const| +:ref:`Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647, step\: :ref:`int` = 1, deep\: :ref:`bool` = false\ ) |const| Returns the slice of the **Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **Array**. @@ -1129,7 +1129,7 @@ If ``deep`` is true, each element will be copied by value rather than by referen .. rst-class:: classref-method -void **sort** **(** **)** +|void| **sort**\ (\ ) Sorts the array. @@ -1170,7 +1170,7 @@ To perform natural order sorting, you can use :ref:`sort_custom` func **)** +|void| **sort_custom**\ (\ func\: :ref:`Callable`\ ) Sorts the array using a custom method. The custom method receives two arguments (a pair of elements from the array) and must return either ``true`` or ``false``. For two elements ``a`` and ``b``, if the given method returns ``true``, element ``b`` will be after element ``a`` in the array. @@ -1216,7 +1216,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Array` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Array`\ ) Compares the left operand **Array** against the ``right`` **Array**. Returns ``true`` if the sizes or contents of the arrays are *not* equal, ``false`` otherwise. @@ -1228,7 +1228,7 @@ Compares the left operand **Array** against the ``right`` **Array**. Returns ``t .. rst-class:: classref-operator -:ref:`Array` **operator +** **(** :ref:`Array` right **)** +:ref:`Array` **operator +**\ (\ right\: :ref:`Array`\ ) Concatenates two **Array**\ s together, with the ``right`` **Array** being added to the end of the **Array** specified in the left operand. For example, ``[1, 2] + [3, 4]`` results in ``[1, 2, 3, 4]``. @@ -1240,7 +1240,7 @@ Concatenates two **Array**\ s together, with the ``right`` **Array** being added .. rst-class:: classref-operator -:ref:`bool` **operator <** **(** :ref:`Array` right **)** +:ref:`bool` **operator <**\ (\ right\: :ref:`Array`\ ) Performs a comparison for each index between the left operand **Array** and the ``right`` **Array**, considering the highest common index of both arrays for this comparison: Returns ``true`` on the first occurrence of an element that is less, or ``false`` if the element is greater. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns ``false`` if the left operand **Array** has fewer elements, otherwise it returns ``true``. @@ -1252,7 +1252,7 @@ Performs a comparison for each index between the left operand **Array** and the .. rst-class:: classref-operator -:ref:`bool` **operator <=** **(** :ref:`Array` right **)** +:ref:`bool` **operator <=**\ (\ right\: :ref:`Array`\ ) Performs a comparison for each index between the left operand **Array** and the ``right`` **Array**, considering the highest common index of both arrays for this comparison: Returns ``true`` on the first occurrence of an element that is less, or ``false`` if the element is greater. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns ``true`` if the left operand **Array** has the same number of elements or fewer, otherwise it returns ``false``. @@ -1264,7 +1264,7 @@ Performs a comparison for each index between the left operand **Array** and the .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`Array` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Array`\ ) Compares the left operand **Array** against the ``right`` **Array**. Returns ``true`` if the sizes and contents of the arrays are equal, ``false`` otherwise. @@ -1276,7 +1276,7 @@ Compares the left operand **Array** against the ``right`` **Array**. Returns ``t .. rst-class:: classref-operator -:ref:`bool` **operator >** **(** :ref:`Array` right **)** +:ref:`bool` **operator >**\ (\ right\: :ref:`Array`\ ) Performs a comparison for each index between the left operand **Array** and the ``right`` **Array**, considering the highest common index of both arrays for this comparison: Returns ``true`` on the first occurrence of an element that is greater, or ``false`` if the element is less. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns ``true`` if the ``right`` **Array** has more elements, otherwise it returns ``false``. @@ -1288,7 +1288,7 @@ Performs a comparison for each index between the left operand **Array** and the .. rst-class:: classref-operator -:ref:`bool` **operator >=** **(** :ref:`Array` right **)** +:ref:`bool` **operator >=**\ (\ right\: :ref:`Array`\ ) Performs a comparison for each index between the left operand **Array** and the ``right`` **Array**, considering the highest common index of both arrays for this comparison: Returns ``true`` on the first occurrence of an element that is greater, or ``false`` if the element is less. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns ``true`` if the ``right`` **Array** has more or the same number of elements, otherwise it returns ``false``. @@ -1300,7 +1300,7 @@ Performs a comparison for each index between the left operand **Array** and the .. rst-class:: classref-operator -:ref:`Variant` **operator []** **(** :ref:`int` index **)** +:ref:`Variant` **operator []**\ (\ index\: :ref:`int`\ ) Returns a reference to the element of type :ref:`Variant` at the specified location. Arrays start at index 0. ``index`` can be a zero or positive value to start from the beginning, or a negative value to start from the end. Out-of-bounds array access causes a run-time error, which will result in an error being printed and the project execution pausing if run from the editor. @@ -1311,3 +1311,4 @@ Returns a reference to the element of type :ref:`Variant` at the .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index 00e6b5d6e8a..e79c0a38efc 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -103,45 +103,45 @@ Methods .. table:: :widths: auto - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_blend_shape` **(** :ref:`StringName` name **)** | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_surface_from_arrays` **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array[]` blend_shapes=[], :ref:`Dictionary` lods={}, |bitfield|\<:ref:`ArrayFormat`\> flags=0 **)** | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_blend_shapes` **(** **)** | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_surfaces` **(** **)** | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_blend_shape_count` **(** **)** |const| | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** |const| | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`lightmap_unwrap` **(** :ref:`Transform3D` transform, :ref:`float` texel_size **)** | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`regen_normal_maps` **(** **)** | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_blend_shape_name` **(** :ref:`int` index, :ref:`StringName` name **)** | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`surface_find_by_name` **(** :ref:`String` name **)** |const| | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** |const| | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** |const| | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`ArrayFormat`\> | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** |const| | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** |const| | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PrimitiveType` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** |const| | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`surface_update_attribute_region` **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PackedByteArray` data **)** | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`surface_update_skin_region` **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PackedByteArray` data **)** | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`surface_update_vertex_region` **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PackedByteArray` data **)** | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_blend_shape`\ (\ name\: :ref:`StringName`\ ) | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_surface_from_arrays`\ (\ primitive\: :ref:`PrimitiveType`, arrays\: :ref:`Array`, blend_shapes\: :ref:`Array`\[:ref:`Array`\] = [], lods\: :ref:`Dictionary` = {}, flags\: |bitfield|\[:ref:`ArrayFormat`\] = 0\ ) | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_blend_shapes`\ (\ ) | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_surfaces`\ (\ ) | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_blend_shape_count`\ (\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_blend_shape_name`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`lightmap_unwrap`\ (\ transform\: :ref:`Transform3D`, texel_size\: :ref:`float`\ ) | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`regen_normal_maps`\ (\ ) | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_blend_shape_name`\ (\ index\: :ref:`int`, name\: :ref:`StringName`\ ) | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`surface_find_by_name`\ (\ name\: :ref:`String`\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`surface_get_array_index_len`\ (\ surf_idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`surface_get_array_len`\ (\ surf_idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`ArrayFormat`\] | :ref:`surface_get_format`\ (\ surf_idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`surface_get_name`\ (\ surf_idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PrimitiveType` | :ref:`surface_get_primitive_type`\ (\ surf_idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`surface_set_name`\ (\ surf_idx\: :ref:`int`, name\: :ref:`String`\ ) | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`surface_update_attribute_region`\ (\ surf_idx\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`surface_update_skin_region`\ (\ surf_idx\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`surface_update_vertex_region`\ (\ surf_idx\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -160,8 +160,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_blend_shape_mode** **(** :ref:`BlendShapeMode` value **)** -- :ref:`BlendShapeMode` **get_blend_shape_mode** **(** **)** +- |void| **set_blend_shape_mode**\ (\ value\: :ref:`BlendShapeMode`\ ) +- :ref:`BlendShapeMode` **get_blend_shape_mode**\ (\ ) Sets the blend shape mode to one of :ref:`BlendShapeMode`. @@ -177,8 +177,8 @@ Sets the blend shape mode to one of :ref:`BlendShapeMode` value **)** -- :ref:`AABB` **get_custom_aabb** **(** **)** +- |void| **set_custom_aabb**\ (\ value\: :ref:`AABB`\ ) +- :ref:`AABB` **get_custom_aabb**\ (\ ) Overrides the :ref:`AABB` with one defined by user for use with frustum culling. Especially useful to avoid unexpected culling when using a shader to offset vertices. @@ -194,8 +194,8 @@ Overrides the :ref:`AABB` with one defined by user for use with frus .. rst-class:: classref-property-setget -- void **set_shadow_mesh** **(** :ref:`ArrayMesh` value **)** -- :ref:`ArrayMesh` **get_shadow_mesh** **(** **)** +- |void| **set_shadow_mesh**\ (\ value\: :ref:`ArrayMesh`\ ) +- :ref:`ArrayMesh` **get_shadow_mesh**\ (\ ) An optional mesh which is used for rendering shadows and can be used for the depth prepass. Can be used to increase performance of shadow rendering by using a mesh that only contains vertex position data (without normals, UVs, colors, etc.). @@ -212,7 +212,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_blend_shape** **(** :ref:`StringName` name **)** +|void| **add_blend_shape**\ (\ name\: :ref:`StringName`\ ) Adds name for a blend shape that will be added with :ref:`add_surface_from_arrays`. Must be called before surface is added. @@ -224,7 +224,7 @@ Adds name for a blend shape that will be added with :ref:`add_surface_from_array .. rst-class:: classref-method -void **add_surface_from_arrays** **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array[]` blend_shapes=[], :ref:`Dictionary` lods={}, |bitfield|\<:ref:`ArrayFormat`\> flags=0 **)** +|void| **add_surface_from_arrays**\ (\ primitive\: :ref:`PrimitiveType`, arrays\: :ref:`Array`, blend_shapes\: :ref:`Array`\[:ref:`Array`\] = [], lods\: :ref:`Dictionary` = {}, flags\: |bitfield|\[:ref:`ArrayFormat`\] = 0\ ) Creates a new surface. :ref:`Mesh.get_surface_count` will become the ``surf_idx`` for this new surface. @@ -248,7 +248,7 @@ The ``flags`` argument is the bitwise or of, as required: One value of :ref:`Arr .. rst-class:: classref-method -void **clear_blend_shapes** **(** **)** +|void| **clear_blend_shapes**\ (\ ) Removes all blend shapes from this **ArrayMesh**. @@ -260,7 +260,7 @@ Removes all blend shapes from this **ArrayMesh**. .. rst-class:: classref-method -void **clear_surfaces** **(** **)** +|void| **clear_surfaces**\ (\ ) Removes all surfaces from this **ArrayMesh**. @@ -272,7 +272,7 @@ Removes all surfaces from this **ArrayMesh**. .. rst-class:: classref-method -:ref:`int` **get_blend_shape_count** **(** **)** |const| +:ref:`int` **get_blend_shape_count**\ (\ ) |const| Returns the number of blend shapes that the **ArrayMesh** holds. @@ -284,7 +284,7 @@ Returns the number of blend shapes that the **ArrayMesh** holds. .. rst-class:: classref-method -:ref:`StringName` **get_blend_shape_name** **(** :ref:`int` index **)** |const| +:ref:`StringName` **get_blend_shape_name**\ (\ index\: :ref:`int`\ ) |const| Returns the name of the blend shape at this index. @@ -296,7 +296,7 @@ Returns the name of the blend shape at this index. .. rst-class:: classref-method -:ref:`Error` **lightmap_unwrap** **(** :ref:`Transform3D` transform, :ref:`float` texel_size **)** +:ref:`Error` **lightmap_unwrap**\ (\ transform\: :ref:`Transform3D`, texel_size\: :ref:`float`\ ) Performs a UV unwrap on the **ArrayMesh** to prepare the mesh for lightmapping. @@ -308,7 +308,7 @@ Performs a UV unwrap on the **ArrayMesh** to prepare the mesh for lightmapping. .. rst-class:: classref-method -void **regen_normal_maps** **(** **)** +|void| **regen_normal_maps**\ (\ ) Regenerates tangents for each of the **ArrayMesh**'s surfaces. @@ -320,7 +320,7 @@ Regenerates tangents for each of the **ArrayMesh**'s surfaces. .. rst-class:: classref-method -void **set_blend_shape_name** **(** :ref:`int` index, :ref:`StringName` name **)** +|void| **set_blend_shape_name**\ (\ index\: :ref:`int`, name\: :ref:`StringName`\ ) Sets the name of the blend shape at this index. @@ -332,7 +332,7 @@ Sets the name of the blend shape at this index. .. rst-class:: classref-method -:ref:`int` **surface_find_by_name** **(** :ref:`String` name **)** |const| +:ref:`int` **surface_find_by_name**\ (\ name\: :ref:`String`\ ) |const| Returns the index of the first surface with this name held within this **ArrayMesh**. If none are found, -1 is returned. @@ -344,7 +344,7 @@ Returns the index of the first surface with this name held within this **ArrayMe .. rst-class:: classref-method -:ref:`int` **surface_get_array_index_len** **(** :ref:`int` surf_idx **)** |const| +:ref:`int` **surface_get_array_index_len**\ (\ surf_idx\: :ref:`int`\ ) |const| Returns the length in indices of the index array in the requested surface (see :ref:`add_surface_from_arrays`). @@ -356,7 +356,7 @@ Returns the length in indices of the index array in the requested surface (see : .. rst-class:: classref-method -:ref:`int` **surface_get_array_len** **(** :ref:`int` surf_idx **)** |const| +:ref:`int` **surface_get_array_len**\ (\ surf_idx\: :ref:`int`\ ) |const| Returns the length in vertices of the vertex array in the requested surface (see :ref:`add_surface_from_arrays`). @@ -368,7 +368,7 @@ Returns the length in vertices of the vertex array in the requested surface (see .. rst-class:: classref-method -|bitfield|\<:ref:`ArrayFormat`\> **surface_get_format** **(** :ref:`int` surf_idx **)** |const| +|bitfield|\[:ref:`ArrayFormat`\] **surface_get_format**\ (\ surf_idx\: :ref:`int`\ ) |const| Returns the format mask of the requested surface (see :ref:`add_surface_from_arrays`). @@ -380,7 +380,7 @@ Returns the format mask of the requested surface (see :ref:`add_surface_from_arr .. rst-class:: classref-method -:ref:`String` **surface_get_name** **(** :ref:`int` surf_idx **)** |const| +:ref:`String` **surface_get_name**\ (\ surf_idx\: :ref:`int`\ ) |const| Gets the name assigned to this surface. @@ -392,7 +392,7 @@ Gets the name assigned to this surface. .. rst-class:: classref-method -:ref:`PrimitiveType` **surface_get_primitive_type** **(** :ref:`int` surf_idx **)** |const| +:ref:`PrimitiveType` **surface_get_primitive_type**\ (\ surf_idx\: :ref:`int`\ ) |const| Returns the primitive type of the requested surface (see :ref:`add_surface_from_arrays`). @@ -404,7 +404,7 @@ Returns the primitive type of the requested surface (see :ref:`add_surface_from_ .. rst-class:: classref-method -void **surface_set_name** **(** :ref:`int` surf_idx, :ref:`String` name **)** +|void| **surface_set_name**\ (\ surf_idx\: :ref:`int`, name\: :ref:`String`\ ) Sets a name for a given surface. @@ -416,7 +416,7 @@ Sets a name for a given surface. .. rst-class:: classref-method -void **surface_update_attribute_region** **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PackedByteArray` data **)** +|void| **surface_update_attribute_region**\ (\ surf_idx\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) .. container:: contribute @@ -430,7 +430,7 @@ void **surface_update_attribute_region** **(** :ref:`int` surf_idx, : .. rst-class:: classref-method -void **surface_update_skin_region** **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PackedByteArray` data **)** +|void| **surface_update_skin_region**\ (\ surf_idx\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) .. container:: contribute @@ -444,7 +444,7 @@ void **surface_update_skin_region** **(** :ref:`int` surf_idx, :ref:` .. rst-class:: classref-method -void **surface_update_vertex_region** **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PackedByteArray` data **)** +|void| **surface_update_vertex_region**\ (\ surf_idx\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) .. container:: contribute @@ -457,3 +457,4 @@ void **surface_update_vertex_region** **(** :ref:`int` surf_idx, :ref .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_arrayoccluder3d.rst b/classes/class_arrayoccluder3d.rst index c9dbec81f69..c9c3c4cf625 100644 --- a/classes/class_arrayoccluder3d.rst +++ b/classes/class_arrayoccluder3d.rst @@ -52,9 +52,9 @@ Methods .. table:: :widths: auto - +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_arrays` **(** :ref:`PackedVector3Array` vertices, :ref:`PackedInt32Array` indices **)** | - +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_arrays`\ (\ vertices\: :ref:`PackedVector3Array`, indices\: :ref:`PackedInt32Array`\ ) | + +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -73,8 +73,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_indices** **(** :ref:`PackedInt32Array` value **)** -- :ref:`PackedInt32Array` **get_indices** **(** **)** +- |void| **set_indices**\ (\ value\: :ref:`PackedInt32Array`\ ) +- :ref:`PackedInt32Array` **get_indices**\ (\ ) The occluder's index position. Indices determine which points from the :ref:`vertices` array should be drawn, and in which order. @@ -92,8 +92,8 @@ The occluder's index position. Indices determine which points from the :ref:`ver .. rst-class:: classref-property-setget -- void **set_vertices** **(** :ref:`PackedVector3Array` value **)** -- :ref:`PackedVector3Array` **get_vertices** **(** **)** +- |void| **set_vertices**\ (\ value\: :ref:`PackedVector3Array`\ ) +- :ref:`PackedVector3Array` **get_vertices**\ (\ ) The occluder's vertex positions in local 3D coordinates. @@ -112,7 +112,7 @@ Method Descriptions .. rst-class:: classref-method -void **set_arrays** **(** :ref:`PackedVector3Array` vertices, :ref:`PackedInt32Array` indices **)** +|void| **set_arrays**\ (\ vertices\: :ref:`PackedVector3Array`, indices\: :ref:`PackedInt32Array`\ ) Sets :ref:`indices` and :ref:`vertices`, while updating the final occluder only once after both values are set. @@ -123,3 +123,4 @@ Sets :ref:`indices` and :ref:`vertices` value **)** -- :ref:`AlignmentMode` **get_alignment_horizontal** **(** **)** +- |void| **set_alignment_horizontal**\ (\ value\: :ref:`AlignmentMode`\ ) +- :ref:`AlignmentMode` **get_alignment_horizontal**\ (\ ) Specifies the horizontal relative position of child controls. @@ -163,8 +163,8 @@ Specifies the horizontal relative position of child controls. .. rst-class:: classref-property-setget -- void **set_alignment_vertical** **(** :ref:`AlignmentMode` value **)** -- :ref:`AlignmentMode` **get_alignment_vertical** **(** **)** +- |void| **set_alignment_vertical**\ (\ value\: :ref:`AlignmentMode`\ ) +- :ref:`AlignmentMode` **get_alignment_vertical**\ (\ ) Specifies the vertical relative position of child controls. @@ -180,8 +180,8 @@ Specifies the vertical relative position of child controls. .. rst-class:: classref-property-setget -- void **set_ratio** **(** :ref:`float` value **)** -- :ref:`float` **get_ratio** **(** **)** +- |void| **set_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ratio**\ (\ ) The aspect ratio to enforce on child controls. This is the width divided by the height. The ratio depends on the :ref:`stretch_mode`. @@ -197,8 +197,8 @@ The aspect ratio to enforce on child controls. This is the width divided by the .. rst-class:: classref-property-setget -- void **set_stretch_mode** **(** :ref:`StretchMode` value **)** -- :ref:`StretchMode` **get_stretch_mode** **(** **)** +- |void| **set_stretch_mode**\ (\ value\: :ref:`StretchMode`\ ) +- :ref:`StretchMode` **get_stretch_mode**\ (\ ) The stretch mode used to align child controls. @@ -209,3 +209,4 @@ The stretch mode used to align child controls. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_astar2d.rst b/classes/class_astar2d.rst index 64e7de112cf..0692f720d0d 100644 --- a/classes/class_astar2d.rst +++ b/classes/class_astar2d.rst @@ -31,57 +31,57 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector2` position, :ref:`float` weight_scale=1.0 **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_available_point_id` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector2` to_position, :ref:`bool` include_disabled=false **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_closest_position_in_segment` **(** :ref:`Vector2` to_position **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_point_capacity` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`get_point_connections` **(** :ref:`int` id **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_point_count` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`get_point_ids` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` id **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_point_disabled` **(** :ref:`int` id **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_point` **(** :ref:`int` id **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reserve_space` **(** :ref:`int` num_nodes **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_disabled` **(** :ref:`int` id, :ref:`bool` disabled=true **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_position` **(** :ref:`int` id, :ref:`Vector2` position **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_weight_scale` **(** :ref:`int` id, :ref:`float` weight_scale **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_compute_cost`\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_estimate_cost`\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_point`\ (\ id\: :ref:`int`, position\: :ref:`Vector2`, weight_scale\: :ref:`float` = 1.0\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`are_points_connected`\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`connect_points`\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`disconnect_points`\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_available_point_id`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_closest_point`\ (\ to_position\: :ref:`Vector2`, include_disabled\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_closest_position_in_segment`\ (\ to_position\: :ref:`Vector2`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`get_id_path`\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_point_capacity`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`get_point_connections`\ (\ id\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_point_count`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`get_point_ids`\ (\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`get_point_path`\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_point_position`\ (\ id\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_point_weight_scale`\ (\ id\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_point`\ (\ id\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_point_disabled`\ (\ id\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_point`\ (\ id\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reserve_space`\ (\ num_nodes\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_disabled`\ (\ id\: :ref:`int`, disabled\: :ref:`bool` = true\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_position`\ (\ id\: :ref:`int`, position\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_weight_scale`\ (\ id\: :ref:`int`, weight_scale\: :ref:`float`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -96,7 +96,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_compute_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| |const| +:ref:`float` **_compute_cost**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) |virtual| |const| Called when computing the cost between two connected points. @@ -110,7 +110,7 @@ Note that this function is hidden in the default **AStar2D** class. .. rst-class:: classref-method -:ref:`float` **_estimate_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| |const| +:ref:`float` **_estimate_cost**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) |virtual| |const| Called when estimating the cost between a point and the path's ending point. @@ -124,7 +124,7 @@ Note that this function is hidden in the default **AStar2D** class. .. rst-class:: classref-method -void **add_point** **(** :ref:`int` id, :ref:`Vector2` position, :ref:`float` weight_scale=1.0 **)** +|void| **add_point**\ (\ id\: :ref:`int`, position\: :ref:`Vector2`, weight_scale\: :ref:`float` = 1.0\ ) Adds a new point at the given position with the given identifier. The ``id`` must be 0 or larger, and the ``weight_scale`` must be 0.0 or greater. @@ -155,7 +155,7 @@ If there already exists a point for the given ``id``, its position and weight sc .. rst-class:: classref-method -:ref:`bool` **are_points_connected** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** |const| +:ref:`bool` **are_points_connected**\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) |const| Returns whether there is a connection/segment between the given points. If ``bidirectional`` is ``false``, returns whether movement from ``id`` to ``to_id`` is possible through this segment. @@ -167,7 +167,7 @@ Returns whether there is a connection/segment between the given points. If ``bid .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears all the points and segments. @@ -179,7 +179,7 @@ Clears all the points and segments. .. rst-class:: classref-method -void **connect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** +|void| **connect_points**\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) Creates a segment between the given points. If ``bidirectional`` is ``false``, only movement from ``id`` to ``to_id`` is allowed, not the reverse direction. @@ -210,7 +210,7 @@ Creates a segment between the given points. If ``bidirectional`` is ``false``, o .. rst-class:: classref-method -void **disconnect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** +|void| **disconnect_points**\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) Deletes the segment between the given points. If ``bidirectional`` is ``false``, only movement from ``id`` to ``to_id`` is prevented, and a unidirectional segment possibly remains. @@ -222,7 +222,7 @@ Deletes the segment between the given points. If ``bidirectional`` is ``false``, .. rst-class:: classref-method -:ref:`int` **get_available_point_id** **(** **)** |const| +:ref:`int` **get_available_point_id**\ (\ ) |const| Returns the next available point ID with no point associated to it. @@ -234,7 +234,7 @@ Returns the next available point ID with no point associated to it. .. rst-class:: classref-method -:ref:`int` **get_closest_point** **(** :ref:`Vector2` to_position, :ref:`bool` include_disabled=false **)** |const| +:ref:`int` **get_closest_point**\ (\ to_position\: :ref:`Vector2`, include_disabled\: :ref:`bool` = false\ ) |const| Returns the ID of the closest point to ``to_position``, optionally taking disabled points into account. Returns ``-1`` if there are no points in the points pool. @@ -248,7 +248,7 @@ Returns the ID of the closest point to ``to_position``, optionally taking disabl .. rst-class:: classref-method -:ref:`Vector2` **get_closest_position_in_segment** **(** :ref:`Vector2` to_position **)** |const| +:ref:`Vector2` **get_closest_position_in_segment**\ (\ to_position\: :ref:`Vector2`\ ) |const| Returns the closest position to ``to_position`` that resides inside a segment between two connected points. @@ -283,7 +283,7 @@ The result is in the segment that goes from ``y = 0`` to ``y = 5``. It's the clo .. rst-class:: classref-method -:ref:`PackedInt64Array` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** +:ref:`PackedInt64Array` **get_id_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. @@ -331,7 +331,7 @@ If you change the 2nd point's weight to 3, then the result will be ``[1, 4, 3]`` .. rst-class:: classref-method -:ref:`int` **get_point_capacity** **(** **)** |const| +:ref:`int` **get_point_capacity**\ (\ ) |const| Returns the capacity of the structure backing the points, useful in conjunction with :ref:`reserve_space`. @@ -343,7 +343,7 @@ Returns the capacity of the structure backing the points, useful in conjunction .. rst-class:: classref-method -:ref:`PackedInt64Array` **get_point_connections** **(** :ref:`int` id **)** +:ref:`PackedInt64Array` **get_point_connections**\ (\ id\: :ref:`int`\ ) Returns an array with the IDs of the points that form the connection with the given point. @@ -386,7 +386,7 @@ Returns an array with the IDs of the points that form the connection with the gi .. rst-class:: classref-method -:ref:`int` **get_point_count** **(** **)** |const| +:ref:`int` **get_point_count**\ (\ ) |const| Returns the number of points currently in the points pool. @@ -398,7 +398,7 @@ Returns the number of points currently in the points pool. .. rst-class:: classref-method -:ref:`PackedInt64Array` **get_point_ids** **(** **)** +:ref:`PackedInt64Array` **get_point_ids**\ (\ ) Returns an array of all point IDs. @@ -410,7 +410,7 @@ Returns an array of all point IDs. .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_point_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** +:ref:`PackedVector2Array` **get_point_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) Returns an array with the points that are in the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. @@ -424,7 +424,7 @@ Returns an array with the points that are in the path found by AStar2D between t .. rst-class:: classref-method -:ref:`Vector2` **get_point_position** **(** :ref:`int` id **)** |const| +:ref:`Vector2` **get_point_position**\ (\ id\: :ref:`int`\ ) |const| Returns the position of the point associated with the given ``id``. @@ -436,7 +436,7 @@ Returns the position of the point associated with the given ``id``. .. rst-class:: classref-method -:ref:`float` **get_point_weight_scale** **(** :ref:`int` id **)** |const| +:ref:`float` **get_point_weight_scale**\ (\ id\: :ref:`int`\ ) |const| Returns the weight scale of the point associated with the given ``id``. @@ -448,7 +448,7 @@ Returns the weight scale of the point associated with the given ``id``. .. rst-class:: classref-method -:ref:`bool` **has_point** **(** :ref:`int` id **)** |const| +:ref:`bool` **has_point**\ (\ id\: :ref:`int`\ ) |const| Returns whether a point associated with the given ``id`` exists. @@ -460,7 +460,7 @@ Returns whether a point associated with the given ``id`` exists. .. rst-class:: classref-method -:ref:`bool` **is_point_disabled** **(** :ref:`int` id **)** |const| +:ref:`bool` **is_point_disabled**\ (\ id\: :ref:`int`\ ) |const| Returns whether a point is disabled or not for pathfinding. By default, all points are enabled. @@ -472,7 +472,7 @@ Returns whether a point is disabled or not for pathfinding. By default, all poin .. rst-class:: classref-method -void **remove_point** **(** :ref:`int` id **)** +|void| **remove_point**\ (\ id\: :ref:`int`\ ) Removes the point associated with the given ``id`` from the points pool. @@ -484,7 +484,7 @@ Removes the point associated with the given ``id`` from the points pool. .. rst-class:: classref-method -void **reserve_space** **(** :ref:`int` num_nodes **)** +|void| **reserve_space**\ (\ num_nodes\: :ref:`int`\ ) Reserves space internally for ``num_nodes`` points, useful if you're adding a known large number of points at once, such as points on a grid. New capacity must be greater or equals to old capacity. @@ -496,7 +496,7 @@ Reserves space internally for ``num_nodes`` points, useful if you're adding a kn .. rst-class:: classref-method -void **set_point_disabled** **(** :ref:`int` id, :ref:`bool` disabled=true **)** +|void| **set_point_disabled**\ (\ id\: :ref:`int`, disabled\: :ref:`bool` = true\ ) Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle. @@ -508,7 +508,7 @@ Disables or enables the specified point for pathfinding. Useful for making a tem .. rst-class:: classref-method -void **set_point_position** **(** :ref:`int` id, :ref:`Vector2` position **)** +|void| **set_point_position**\ (\ id\: :ref:`int`, position\: :ref:`Vector2`\ ) Sets the ``position`` for the point with the given ``id``. @@ -520,7 +520,7 @@ Sets the ``position`` for the point with the given ``id``. .. rst-class:: classref-method -void **set_point_weight_scale** **(** :ref:`int` id, :ref:`float` weight_scale **)** +|void| **set_point_weight_scale**\ (\ id\: :ref:`int`, weight_scale\: :ref:`float`\ ) Sets the ``weight_scale`` for the point with the given ``id``. The ``weight_scale`` is multiplied by the result of :ref:`_compute_cost` when determining the overall cost of traveling across a segment from a neighboring point to this point. @@ -531,3 +531,4 @@ Sets the ``weight_scale`` for the point with the given ``id``. The ``weight_scal .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_astar3d.rst b/classes/class_astar3d.rst index 89f805f764a..8dbfca02472 100644 --- a/classes/class_astar3d.rst +++ b/classes/class_astar3d.rst @@ -68,57 +68,57 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_available_point_id` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector3` to_position, :ref:`bool` include_disabled=false **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_closest_position_in_segment` **(** :ref:`Vector3` to_position **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_point_capacity` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`get_point_connections` **(** :ref:`int` id **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_point_count` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`get_point_ids` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` id **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_point_disabled` **(** :ref:`int` id **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_point` **(** :ref:`int` id **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reserve_space` **(** :ref:`int` num_nodes **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_disabled` **(** :ref:`int` id, :ref:`bool` disabled=true **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_position` **(** :ref:`int` id, :ref:`Vector3` position **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_weight_scale` **(** :ref:`int` id, :ref:`float` weight_scale **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_compute_cost`\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_estimate_cost`\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_point`\ (\ id\: :ref:`int`, position\: :ref:`Vector3`, weight_scale\: :ref:`float` = 1.0\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`are_points_connected`\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`connect_points`\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`disconnect_points`\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_available_point_id`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_closest_point`\ (\ to_position\: :ref:`Vector3`, include_disabled\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_closest_position_in_segment`\ (\ to_position\: :ref:`Vector3`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`get_id_path`\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_point_capacity`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`get_point_connections`\ (\ id\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_point_count`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`get_point_ids`\ (\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`get_point_path`\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_point_position`\ (\ id\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_point_weight_scale`\ (\ id\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_point`\ (\ id\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_point_disabled`\ (\ id\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_point`\ (\ id\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reserve_space`\ (\ num_nodes\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_disabled`\ (\ id\: :ref:`int`, disabled\: :ref:`bool` = true\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_position`\ (\ id\: :ref:`int`, position\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_weight_scale`\ (\ id\: :ref:`int`, weight_scale\: :ref:`float`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -133,7 +133,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_compute_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| |const| +:ref:`float` **_compute_cost**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) |virtual| |const| Called when computing the cost between two connected points. @@ -147,7 +147,7 @@ Note that this function is hidden in the default **AStar3D** class. .. rst-class:: classref-method -:ref:`float` **_estimate_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| |const| +:ref:`float` **_estimate_cost**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) |virtual| |const| Called when estimating the cost between a point and the path's ending point. @@ -161,7 +161,7 @@ Note that this function is hidden in the default **AStar3D** class. .. rst-class:: classref-method -void **add_point** **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** +|void| **add_point**\ (\ id\: :ref:`int`, position\: :ref:`Vector3`, weight_scale\: :ref:`float` = 1.0\ ) Adds a new point at the given position with the given identifier. The ``id`` must be 0 or larger, and the ``weight_scale`` must be 0.0 or greater. @@ -192,7 +192,7 @@ If there already exists a point for the given ``id``, its position and weight sc .. rst-class:: classref-method -:ref:`bool` **are_points_connected** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** |const| +:ref:`bool` **are_points_connected**\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) |const| Returns whether the two given points are directly connected by a segment. If ``bidirectional`` is ``false``, returns whether movement from ``id`` to ``to_id`` is possible through this segment. @@ -204,7 +204,7 @@ Returns whether the two given points are directly connected by a segment. If ``b .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears all the points and segments. @@ -216,7 +216,7 @@ Clears all the points and segments. .. rst-class:: classref-method -void **connect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** +|void| **connect_points**\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) Creates a segment between the given points. If ``bidirectional`` is ``false``, only movement from ``id`` to ``to_id`` is allowed, not the reverse direction. @@ -247,7 +247,7 @@ Creates a segment between the given points. If ``bidirectional`` is ``false``, o .. rst-class:: classref-method -void **disconnect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** +|void| **disconnect_points**\ (\ id\: :ref:`int`, to_id\: :ref:`int`, bidirectional\: :ref:`bool` = true\ ) Deletes the segment between the given points. If ``bidirectional`` is ``false``, only movement from ``id`` to ``to_id`` is prevented, and a unidirectional segment possibly remains. @@ -259,7 +259,7 @@ Deletes the segment between the given points. If ``bidirectional`` is ``false``, .. rst-class:: classref-method -:ref:`int` **get_available_point_id** **(** **)** |const| +:ref:`int` **get_available_point_id**\ (\ ) |const| Returns the next available point ID with no point associated to it. @@ -271,7 +271,7 @@ Returns the next available point ID with no point associated to it. .. rst-class:: classref-method -:ref:`int` **get_closest_point** **(** :ref:`Vector3` to_position, :ref:`bool` include_disabled=false **)** |const| +:ref:`int` **get_closest_point**\ (\ to_position\: :ref:`Vector3`, include_disabled\: :ref:`bool` = false\ ) |const| Returns the ID of the closest point to ``to_position``, optionally taking disabled points into account. Returns ``-1`` if there are no points in the points pool. @@ -285,7 +285,7 @@ Returns the ID of the closest point to ``to_position``, optionally taking disabl .. rst-class:: classref-method -:ref:`Vector3` **get_closest_position_in_segment** **(** :ref:`Vector3` to_position **)** |const| +:ref:`Vector3` **get_closest_position_in_segment**\ (\ to_position\: :ref:`Vector3`\ ) |const| Returns the closest position to ``to_position`` that resides inside a segment between two connected points. @@ -320,7 +320,7 @@ The result is in the segment that goes from ``y = 0`` to ``y = 5``. It's the clo .. rst-class:: classref-method -:ref:`PackedInt64Array` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** +:ref:`PackedInt64Array` **get_id_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) Returns an array with the IDs of the points that form the path found by AStar3D between the given points. The array is ordered from the starting point to the ending point of the path. @@ -367,7 +367,7 @@ If you change the 2nd point's weight to 3, then the result will be ``[1, 4, 3]`` .. rst-class:: classref-method -:ref:`int` **get_point_capacity** **(** **)** |const| +:ref:`int` **get_point_capacity**\ (\ ) |const| Returns the capacity of the structure backing the points, useful in conjunction with :ref:`reserve_space`. @@ -379,7 +379,7 @@ Returns the capacity of the structure backing the points, useful in conjunction .. rst-class:: classref-method -:ref:`PackedInt64Array` **get_point_connections** **(** :ref:`int` id **)** +:ref:`PackedInt64Array` **get_point_connections**\ (\ id\: :ref:`int`\ ) Returns an array with the IDs of the points that form the connection with the given point. @@ -421,7 +421,7 @@ Returns an array with the IDs of the points that form the connection with the gi .. rst-class:: classref-method -:ref:`int` **get_point_count** **(** **)** |const| +:ref:`int` **get_point_count**\ (\ ) |const| Returns the number of points currently in the points pool. @@ -433,7 +433,7 @@ Returns the number of points currently in the points pool. .. rst-class:: classref-method -:ref:`PackedInt64Array` **get_point_ids** **(** **)** +:ref:`PackedInt64Array` **get_point_ids**\ (\ ) Returns an array of all point IDs. @@ -445,7 +445,7 @@ Returns an array of all point IDs. .. rst-class:: classref-method -:ref:`PackedVector3Array` **get_point_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** +:ref:`PackedVector3Array` **get_point_path**\ (\ from_id\: :ref:`int`, to_id\: :ref:`int`\ ) Returns an array with the points that are in the path found by AStar3D between the given points. The array is ordered from the starting point to the ending point of the path. @@ -459,7 +459,7 @@ Returns an array with the points that are in the path found by AStar3D between t .. rst-class:: classref-method -:ref:`Vector3` **get_point_position** **(** :ref:`int` id **)** |const| +:ref:`Vector3` **get_point_position**\ (\ id\: :ref:`int`\ ) |const| Returns the position of the point associated with the given ``id``. @@ -471,7 +471,7 @@ Returns the position of the point associated with the given ``id``. .. rst-class:: classref-method -:ref:`float` **get_point_weight_scale** **(** :ref:`int` id **)** |const| +:ref:`float` **get_point_weight_scale**\ (\ id\: :ref:`int`\ ) |const| Returns the weight scale of the point associated with the given ``id``. @@ -483,7 +483,7 @@ Returns the weight scale of the point associated with the given ``id``. .. rst-class:: classref-method -:ref:`bool` **has_point** **(** :ref:`int` id **)** |const| +:ref:`bool` **has_point**\ (\ id\: :ref:`int`\ ) |const| Returns whether a point associated with the given ``id`` exists. @@ -495,7 +495,7 @@ Returns whether a point associated with the given ``id`` exists. .. rst-class:: classref-method -:ref:`bool` **is_point_disabled** **(** :ref:`int` id **)** |const| +:ref:`bool` **is_point_disabled**\ (\ id\: :ref:`int`\ ) |const| Returns whether a point is disabled or not for pathfinding. By default, all points are enabled. @@ -507,7 +507,7 @@ Returns whether a point is disabled or not for pathfinding. By default, all poin .. rst-class:: classref-method -void **remove_point** **(** :ref:`int` id **)** +|void| **remove_point**\ (\ id\: :ref:`int`\ ) Removes the point associated with the given ``id`` from the points pool. @@ -519,7 +519,7 @@ Removes the point associated with the given ``id`` from the points pool. .. rst-class:: classref-method -void **reserve_space** **(** :ref:`int` num_nodes **)** +|void| **reserve_space**\ (\ num_nodes\: :ref:`int`\ ) Reserves space internally for ``num_nodes`` points. Useful if you're adding a known large number of points at once, such as points on a grid. New capacity must be greater or equals to old capacity. @@ -531,7 +531,7 @@ Reserves space internally for ``num_nodes`` points. Useful if you're adding a kn .. rst-class:: classref-method -void **set_point_disabled** **(** :ref:`int` id, :ref:`bool` disabled=true **)** +|void| **set_point_disabled**\ (\ id\: :ref:`int`, disabled\: :ref:`bool` = true\ ) Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle. @@ -543,7 +543,7 @@ Disables or enables the specified point for pathfinding. Useful for making a tem .. rst-class:: classref-method -void **set_point_position** **(** :ref:`int` id, :ref:`Vector3` position **)** +|void| **set_point_position**\ (\ id\: :ref:`int`, position\: :ref:`Vector3`\ ) Sets the ``position`` for the point with the given ``id``. @@ -555,7 +555,7 @@ Sets the ``position`` for the point with the given ``id``. .. rst-class:: classref-method -void **set_point_weight_scale** **(** :ref:`int` id, :ref:`float` weight_scale **)** +|void| **set_point_weight_scale**\ (\ id\: :ref:`int`, weight_scale\: :ref:`float`\ ) Sets the ``weight_scale`` for the point with the given ``id``. The ``weight_scale`` is multiplied by the result of :ref:`_compute_cost` when determining the overall cost of traveling across a segment from a neighboring point to this point. @@ -566,3 +566,4 @@ Sets the ``weight_scale`` for the point with the given ``id``. The ``weight_scal .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_astargrid2d.rst b/classes/class_astargrid2d.rst index 17b6a16072e..5b9a394fbd6 100644 --- a/classes/class_astargrid2d.rst +++ b/classes/class_astargrid2d.rst @@ -84,39 +84,39 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_compute_cost` **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id **)** |virtual| |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_estimate_cost` **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id **)** |virtual| |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fill_solid_region` **(** :ref:`Rect2i` region, :ref:`bool` solid=true **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fill_weight_scale_region` **(** :ref:`Rect2i` region, :ref:`float` weight_scale **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i[]` | :ref:`get_id_path` **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`get_point_path` **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`Vector2i` id **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`Vector2i` id **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_dirty` **(** **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_in_bounds` **(** :ref:`int` x, :ref:`int` y **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_in_boundsv` **(** :ref:`Vector2i` id **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_point_solid` **(** :ref:`Vector2i` id **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_solid` **(** :ref:`Vector2i` id, :ref:`bool` solid=true **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_weight_scale` **(** :ref:`Vector2i` id, :ref:`float` weight_scale **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`update` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_compute_cost`\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) |virtual| |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_estimate_cost`\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) |virtual| |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill_solid_region`\ (\ region\: :ref:`Rect2i`, solid\: :ref:`bool` = true\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill_weight_scale_region`\ (\ region\: :ref:`Rect2i`, weight_scale\: :ref:`float`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`get_id_path`\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`get_point_path`\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_point_position`\ (\ id\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_point_weight_scale`\ (\ id\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_dirty`\ (\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_in_bounds`\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_in_boundsv`\ (\ id\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_point_solid`\ (\ id\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_solid`\ (\ id\: :ref:`Vector2i`, solid\: :ref:`bool` = true\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_weight_scale`\ (\ id\: :ref:`Vector2i`, weight_scale\: :ref:`float`\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update`\ (\ ) | + +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -311,8 +311,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_cell_shape** **(** :ref:`CellShape` value **)** -- :ref:`CellShape` **get_cell_shape** **(** **)** +- |void| **set_cell_shape**\ (\ value\: :ref:`CellShape`\ ) +- :ref:`CellShape` **get_cell_shape**\ (\ ) The cell shape. Affects how the positions are placed in the grid. If changed, :ref:`update` needs to be called before finding the next path. @@ -328,8 +328,8 @@ The cell shape. Affects how the positions are placed in the grid. If changed, :r .. rst-class:: classref-property-setget -- void **set_cell_size** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_cell_size** **(** **)** +- |void| **set_cell_size**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_cell_size**\ (\ ) The size of the point cell which will be applied to calculate the resulting point position returned by :ref:`get_point_path`. If changed, :ref:`update` needs to be called before finding the next path. @@ -345,8 +345,8 @@ The size of the point cell which will be applied to calculate the resulting poin .. rst-class:: classref-property-setget -- void **set_default_compute_heuristic** **(** :ref:`Heuristic` value **)** -- :ref:`Heuristic` **get_default_compute_heuristic** **(** **)** +- |void| **set_default_compute_heuristic**\ (\ value\: :ref:`Heuristic`\ ) +- :ref:`Heuristic` **get_default_compute_heuristic**\ (\ ) The default :ref:`Heuristic` which will be used to calculate the cost between two points if :ref:`_compute_cost` was not overridden. @@ -362,8 +362,8 @@ The default :ref:`Heuristic` which will be used to c .. rst-class:: classref-property-setget -- void **set_default_estimate_heuristic** **(** :ref:`Heuristic` value **)** -- :ref:`Heuristic` **get_default_estimate_heuristic** **(** **)** +- |void| **set_default_estimate_heuristic**\ (\ value\: :ref:`Heuristic`\ ) +- :ref:`Heuristic` **get_default_estimate_heuristic**\ (\ ) The default :ref:`Heuristic` which will be used to calculate the cost between the point and the end point if :ref:`_estimate_cost` was not overridden. @@ -379,8 +379,8 @@ The default :ref:`Heuristic` which will be used to c .. rst-class:: classref-property-setget -- void **set_diagonal_mode** **(** :ref:`DiagonalMode` value **)** -- :ref:`DiagonalMode` **get_diagonal_mode** **(** **)** +- |void| **set_diagonal_mode**\ (\ value\: :ref:`DiagonalMode`\ ) +- :ref:`DiagonalMode` **get_diagonal_mode**\ (\ ) A specific :ref:`DiagonalMode` mode which will force the path to avoid or accept the specified diagonals. @@ -396,8 +396,8 @@ A specific :ref:`DiagonalMode` mode which will fo .. rst-class:: classref-property-setget -- void **set_jumping_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_jumping_enabled** **(** **)** +- |void| **set_jumping_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_jumping_enabled**\ (\ ) Enables or disables jumping to skip up the intermediate points and speeds up the searching algorithm. @@ -415,8 +415,8 @@ Enables or disables jumping to skip up the intermediate points and speeds up the .. rst-class:: classref-property-setget -- void **set_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_offset** **(** **)** +- |void| **set_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_offset**\ (\ ) The offset of the grid which will be applied to calculate the resulting point position returned by :ref:`get_point_path`. If changed, :ref:`update` needs to be called before finding the next path. @@ -432,8 +432,8 @@ The offset of the grid which will be applied to calculate the resulting point po .. rst-class:: classref-property-setget -- void **set_region** **(** :ref:`Rect2i` value **)** -- :ref:`Rect2i` **get_region** **(** **)** +- |void| **set_region**\ (\ value\: :ref:`Rect2i`\ ) +- :ref:`Rect2i` **get_region**\ (\ ) The region of grid cells available for pathfinding. If changed, :ref:`update` needs to be called before finding the next path. @@ -449,8 +449,8 @@ The region of grid cells available for pathfinding. If changed, :ref:`update` value **)** -- :ref:`Vector2i` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_size**\ (\ ) **Deprecated:** Use :ref:`region` instead. @@ -469,7 +469,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_compute_cost** **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id **)** |virtual| |const| +:ref:`float` **_compute_cost**\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) |virtual| |const| Called when computing the cost between two connected points. @@ -483,7 +483,7 @@ Note that this function is hidden in the default **AStarGrid2D** class. .. rst-class:: classref-method -:ref:`float` **_estimate_cost** **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id **)** |virtual| |const| +:ref:`float` **_estimate_cost**\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) |virtual| |const| Called when estimating the cost between a point and the path's ending point. @@ -497,7 +497,7 @@ Note that this function is hidden in the default **AStarGrid2D** class. .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the grid and sets the :ref:`region` to ``Rect2i(0, 0, 0, 0)``. @@ -509,7 +509,7 @@ Clears the grid and sets the :ref:`region` to .. rst-class:: classref-method -void **fill_solid_region** **(** :ref:`Rect2i` region, :ref:`bool` solid=true **)** +|void| **fill_solid_region**\ (\ region\: :ref:`Rect2i`, solid\: :ref:`bool` = true\ ) Fills the given ``region`` on the grid with the specified value for the solid flag. @@ -523,7 +523,7 @@ Fills the given ``region`` on the grid with the specified value for the solid fl .. rst-class:: classref-method -void **fill_weight_scale_region** **(** :ref:`Rect2i` region, :ref:`float` weight_scale **)** +|void| **fill_weight_scale_region**\ (\ region\: :ref:`Rect2i`, weight_scale\: :ref:`float`\ ) Fills the given ``region`` on the grid with the specified value for the weight scale. @@ -537,7 +537,7 @@ Fills the given ``region`` on the grid with the specified value for the weight s .. rst-class:: classref-method -:ref:`Vector2i[]` **get_id_path** **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id **)** +:ref:`Array`\[:ref:`Vector2i`\] **get_id_path**\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. @@ -549,7 +549,7 @@ Returns an array with the IDs of the points that form the path found by AStar2D .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_point_path** **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id **)** +:ref:`PackedVector2Array` **get_point_path**\ (\ from_id\: :ref:`Vector2i`, to_id\: :ref:`Vector2i`\ ) 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. @@ -563,7 +563,7 @@ Returns an array with the points that are in the path found by **AStarGrid2D** b .. rst-class:: classref-method -:ref:`Vector2` **get_point_position** **(** :ref:`Vector2i` id **)** |const| +:ref:`Vector2` **get_point_position**\ (\ id\: :ref:`Vector2i`\ ) |const| Returns the position of the point associated with the given ``id``. @@ -575,7 +575,7 @@ Returns the position of the point associated with the given ``id``. .. rst-class:: classref-method -:ref:`float` **get_point_weight_scale** **(** :ref:`Vector2i` id **)** |const| +:ref:`float` **get_point_weight_scale**\ (\ id\: :ref:`Vector2i`\ ) |const| Returns the weight scale of the point associated with the given ``id``. @@ -587,7 +587,7 @@ Returns the weight scale of the point associated with the given ``id``. .. rst-class:: classref-method -:ref:`bool` **is_dirty** **(** **)** |const| +:ref:`bool` **is_dirty**\ (\ ) |const| Indicates that the grid parameters were changed and :ref:`update` needs to be called. @@ -599,7 +599,7 @@ Indicates that the grid parameters were changed and :ref:`update` **is_in_bounds** **(** :ref:`int` x, :ref:`int` y **)** |const| +:ref:`bool` **is_in_bounds**\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) |const| Returns ``true`` if the ``x`` and ``y`` is a valid grid coordinate (id), i.e. if it is inside :ref:`region`. Equivalent to ``region.has_point(Vector2i(x, y))``. @@ -611,7 +611,7 @@ Returns ``true`` if the ``x`` and ``y`` is a valid grid coordinate (id), i.e. if .. rst-class:: classref-method -:ref:`bool` **is_in_boundsv** **(** :ref:`Vector2i` id **)** |const| +:ref:`bool` **is_in_boundsv**\ (\ id\: :ref:`Vector2i`\ ) |const| Returns ``true`` if the ``id`` vector is a valid grid coordinate, i.e. if it is inside :ref:`region`. Equivalent to ``region.has_point(id)``. @@ -623,7 +623,7 @@ Returns ``true`` if the ``id`` vector is a valid grid coordinate, i.e. if it is .. rst-class:: classref-method -:ref:`bool` **is_point_solid** **(** :ref:`Vector2i` id **)** |const| +:ref:`bool` **is_point_solid**\ (\ id\: :ref:`Vector2i`\ ) |const| Returns ``true`` if a point is disabled for pathfinding. By default, all points are enabled. @@ -635,7 +635,7 @@ Returns ``true`` if a point is disabled for pathfinding. By default, all points .. rst-class:: classref-method -void **set_point_solid** **(** :ref:`Vector2i` id, :ref:`bool` solid=true **)** +|void| **set_point_solid**\ (\ id\: :ref:`Vector2i`, solid\: :ref:`bool` = true\ ) Disables or enables the specified point for pathfinding. Useful for making an obstacle. By default, all points are enabled. @@ -649,7 +649,7 @@ Disables or enables the specified point for pathfinding. Useful for making an ob .. rst-class:: classref-method -void **set_point_weight_scale** **(** :ref:`Vector2i` id, :ref:`float` weight_scale **)** +|void| **set_point_weight_scale**\ (\ id\: :ref:`Vector2i`, weight_scale\: :ref:`float`\ ) Sets the ``weight_scale`` for the point with the given ``id``. The ``weight_scale`` is multiplied by the result of :ref:`_compute_cost` when determining the overall cost of traveling across a segment from a neighboring point to this point. @@ -663,7 +663,7 @@ Sets the ``weight_scale`` for the point with the given ``id``. The ``weight_scal .. rst-class:: classref-method -void **update** **(** **)** +|void| **update**\ (\ ) Updates the internal state of the grid according to the parameters to prepare it to search the path. Needs to be called if parameters like :ref:`region`, :ref:`cell_size` or :ref:`offset` are changed. :ref:`is_dirty` will return ``true`` if this is the case and this needs to be called. @@ -676,3 +676,4 @@ Updates the internal state of the grid according to the parameters to prepare it .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index e030f88a7d2..dfa08025df5 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -62,8 +62,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_atlas** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_atlas** **(** **)** +- |void| **set_atlas**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_atlas**\ (\ ) The texture that contains the atlas. Can be any type inheriting from :ref:`Texture2D`, including another **AtlasTexture**. @@ -79,8 +79,8 @@ The texture that contains the atlas. Can be any type inheriting from :ref:`Textu .. rst-class:: classref-property-setget -- void **set_filter_clip** **(** :ref:`bool` value **)** -- :ref:`bool` **has_filter_clip** **(** **)** +- |void| **set_filter_clip**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **has_filter_clip**\ (\ ) If ``true``, the area outside of the :ref:`region` is clipped to avoid bleeding of the surrounding texture pixels. @@ -96,8 +96,8 @@ If ``true``, the area outside of the :ref:`region` value **)** -- :ref:`Rect2` **get_margin** **(** **)** +- |void| **set_margin**\ (\ value\: :ref:`Rect2`\ ) +- :ref:`Rect2` **get_margin**\ (\ ) The margin around the :ref:`region`. Useful for small adjustments. If the :ref:`Rect2.size` of this property ("w" and "h" in the editor) is set, the drawn texture is resized to fit within the margin. @@ -113,8 +113,8 @@ The margin around the :ref:`region`. Useful .. rst-class:: classref-property-setget -- void **set_region** **(** :ref:`Rect2` value **)** -- :ref:`Rect2` **get_region** **(** **)** +- |void| **set_region**\ (\ value\: :ref:`Rect2`\ ) +- :ref:`Rect2` **get_region**\ (\ ) The region used to draw the :ref:`atlas`. @@ -125,3 +125,4 @@ The region used to draw the :ref:`atlas`. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiobuslayout.rst b/classes/class_audiobuslayout.rst index 3ef224170c8..80fe120f299 100644 --- a/classes/class_audiobuslayout.rst +++ b/classes/class_audiobuslayout.rst @@ -28,3 +28,4 @@ Stores position, muting, solo, bypass, effects, effect position, volume, and the .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffect.rst b/classes/class_audioeffect.rst index 4d092c7d33f..5644677a810 100644 --- a/classes/class_audioeffect.rst +++ b/classes/class_audioeffect.rst @@ -42,9 +42,9 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------+------------------------------------------------------------------------------------------+ - | :ref:`AudioEffectInstance` | :ref:`_instantiate` **(** **)** |virtual| | - +-------------------------------------------------------+------------------------------------------------------------------------------------------+ + +-------------------------------------------------------+------------------------------------------------------------------------------------+ + | :ref:`AudioEffectInstance` | :ref:`_instantiate`\ (\ ) |virtual| | + +-------------------------------------------------------+------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -59,7 +59,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AudioEffectInstance` **_instantiate** **(** **)** |virtual| +:ref:`AudioEffectInstance` **_instantiate**\ (\ ) |virtual| Override this method to customize the :ref:`AudioEffectInstance` created when this effect is applied on a bus in the editor's Audio panel, or through :ref:`AudioServer.add_bus_effect`. @@ -84,3 +84,4 @@ Override this method to customize the :ref:`AudioEffectInstance` value **)** -- :ref:`float` **get_volume_db** **(** **)** +- |void| **set_volume_db**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_volume_db**\ (\ ) Amount of amplification in decibels. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24. @@ -69,3 +69,4 @@ Amount of amplification in decibels. Positive values make the sound louder, nega .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectbandlimitfilter.rst b/classes/class_audioeffectbandlimitfilter.rst index eecb2230fce..031ef97508c 100644 --- a/classes/class_audioeffectbandlimitfilter.rst +++ b/classes/class_audioeffectbandlimitfilter.rst @@ -35,3 +35,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectbandpassfilter.rst b/classes/class_audioeffectbandpassfilter.rst index b82d4b4eb32..186024ed7ae 100644 --- a/classes/class_audioeffectbandpassfilter.rst +++ b/classes/class_audioeffectbandpassfilter.rst @@ -35,3 +35,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectcapture.rst b/classes/class_audioeffectcapture.rst index 94349815bf3..75d76d9f05b 100644 --- a/classes/class_audioeffectcapture.rst +++ b/classes/class_audioeffectcapture.rst @@ -21,7 +21,7 @@ Description AudioEffectCapture is an AudioEffect which copies all audio frames from the attached audio effect bus into its internal ring buffer. -Application code should consume these audio frames from this ring buffer using :ref:`get_buffer` and process it as needed, for example to capture data from an :ref:`AudioStreamMicrophone`, implement application-defined effects, or to transmit audio over the network. When capturing audio data from a microphone, the format of the samples will be stereo 32-bit floating point PCM. +Application code should consume these audio frames from this ring buffer using :ref:`get_buffer` and process it as needed, for example to capture data from an :ref:`AudioStreamMicrophone`, implement application-defined effects, or to transmit audio over the network. When capturing audio data from a microphone, the format of the samples will be stereo 32-bit floating-point PCM. Unlike :ref:`AudioEffectRecord`, this effect only returns the raw audio samples instead of encoding them into an :ref:`AudioStream`. @@ -52,21 +52,21 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`can_get_buffer` **(** :ref:`int` frames **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_buffer` **(** **)** | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`get_buffer` **(** :ref:`int` frames **)** | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_buffer_length_frames` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_discarded_frames` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_frames_available` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_pushed_frames` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`can_get_buffer`\ (\ frames\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_buffer`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`get_buffer`\ (\ frames\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_buffer_length_frames`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_discarded_frames`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_frames_available`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_pushed_frames`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -85,8 +85,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_buffer_length** **(** :ref:`float` value **)** -- :ref:`float` **get_buffer_length** **(** **)** +- |void| **set_buffer_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_buffer_length**\ (\ ) Length of the internal ring buffer, in seconds. Setting the buffer length will have no effect if already initialized. @@ -103,7 +103,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **can_get_buffer** **(** :ref:`int` frames **)** |const| +:ref:`bool` **can_get_buffer**\ (\ frames\: :ref:`int`\ ) |const| Returns ``true`` if at least ``frames`` audio frames are available to read in the internal ring buffer. @@ -115,10 +115,12 @@ Returns ``true`` if at least ``frames`` audio frames are available to read in th .. rst-class:: classref-method -void **clear_buffer** **(** **)** +|void| **clear_buffer**\ (\ ) Clears the internal ring buffer. +\ **Note:** Calling this during a capture can cause the loss of samples which causes popping in the playback. + .. rst-class:: classref-item-separator ---- @@ -127,12 +129,14 @@ Clears the internal ring buffer. .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_buffer** **(** :ref:`int` frames **)** +:ref:`PackedVector2Array` **get_buffer**\ (\ frames\: :ref:`int`\ ) Gets the next ``frames`` audio samples from the internal ring buffer. Returns a :ref:`PackedVector2Array` containing exactly ``frames`` audio samples if available, or an empty :ref:`PackedVector2Array` if insufficient data was available. +The samples are signed floating-point PCM between ``-1`` and ``1``. You will have to scale them if you want to use them as 8 or 16-bit integer samples. (``v = 0x7fff * samples[0].x``) + .. rst-class:: classref-item-separator ---- @@ -141,7 +145,7 @@ Returns a :ref:`PackedVector2Array` containing exactly .. rst-class:: classref-method -:ref:`int` **get_buffer_length_frames** **(** **)** |const| +:ref:`int` **get_buffer_length_frames**\ (\ ) |const| Returns the total size of the internal ring buffer in frames. @@ -153,7 +157,7 @@ Returns the total size of the internal ring buffer in frames. .. rst-class:: classref-method -:ref:`int` **get_discarded_frames** **(** **)** |const| +:ref:`int` **get_discarded_frames**\ (\ ) |const| Returns the number of audio frames discarded from the audio bus due to full buffer. @@ -165,7 +169,7 @@ Returns the number of audio frames discarded from the audio bus due to full buff .. rst-class:: classref-method -:ref:`int` **get_frames_available** **(** **)** |const| +:ref:`int` **get_frames_available**\ (\ ) |const| Returns the number of frames available to read using :ref:`get_buffer`. @@ -177,7 +181,7 @@ Returns the number of frames available to read using :ref:`get_buffer` **get_pushed_frames** **(** **)** |const| +:ref:`int` **get_pushed_frames**\ (\ ) |const| Returns the number of audio frames inserted from the audio bus. @@ -188,3 +192,4 @@ Returns the number of audio frames inserted from the audio bus. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index c54e8ad0013..02efed89f78 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -100,31 +100,31 @@ Methods .. table:: :widths: auto - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_voice_cutoff_hz` **(** :ref:`int` voice_idx **)** |const| | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_voice_delay_ms` **(** :ref:`int` voice_idx **)** |const| | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_voice_depth_ms` **(** :ref:`int` voice_idx **)** |const| | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_voice_level_db` **(** :ref:`int` voice_idx **)** |const| | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_voice_pan` **(** :ref:`int` voice_idx **)** |const| | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_voice_rate_hz` **(** :ref:`int` voice_idx **)** |const| | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_voice_cutoff_hz` **(** :ref:`int` voice_idx, :ref:`float` cutoff_hz **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_voice_delay_ms` **(** :ref:`int` voice_idx, :ref:`float` delay_ms **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_voice_depth_ms` **(** :ref:`int` voice_idx, :ref:`float` depth_ms **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_voice_level_db` **(** :ref:`int` voice_idx, :ref:`float` level_db **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_voice_pan` **(** :ref:`int` voice_idx, :ref:`float` pan **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_voice_rate_hz` **(** :ref:`int` voice_idx, :ref:`float` rate_hz **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_voice_cutoff_hz`\ (\ voice_idx\: :ref:`int`\ ) |const| | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_voice_delay_ms`\ (\ voice_idx\: :ref:`int`\ ) |const| | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_voice_depth_ms`\ (\ voice_idx\: :ref:`int`\ ) |const| | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_voice_level_db`\ (\ voice_idx\: :ref:`int`\ ) |const| | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_voice_pan`\ (\ voice_idx\: :ref:`int`\ ) |const| | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_voice_rate_hz`\ (\ voice_idx\: :ref:`int`\ ) |const| | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_voice_cutoff_hz`\ (\ voice_idx\: :ref:`int`, cutoff_hz\: :ref:`float`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_voice_delay_ms`\ (\ voice_idx\: :ref:`int`, delay_ms\: :ref:`float`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_voice_depth_ms`\ (\ voice_idx\: :ref:`int`, depth_ms\: :ref:`float`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_voice_level_db`\ (\ voice_idx\: :ref:`int`, level_db\: :ref:`float`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_voice_pan`\ (\ voice_idx\: :ref:`int`, pan\: :ref:`float`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_voice_rate_hz`\ (\ voice_idx\: :ref:`int`, rate_hz\: :ref:`float`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -143,8 +143,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_dry** **(** :ref:`float` value **)** -- :ref:`float` **get_dry** **(** **)** +- |void| **set_dry**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_dry**\ (\ ) The effect's raw signal. @@ -160,8 +160,8 @@ The effect's raw signal. .. rst-class:: classref-property-setget -- void **set_voice_cutoff_hz** **(** :ref:`int` voice_idx, :ref:`float` cutoff_hz **)** -- :ref:`float` **get_voice_cutoff_hz** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_cutoff_hz**\ (\ voice_idx\: :ref:`int`, cutoff_hz\: :ref:`float`\ ) +- :ref:`float` **get_voice_cutoff_hz**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's cutoff frequency. @@ -177,8 +177,8 @@ The voice's cutoff frequency. .. rst-class:: classref-property-setget -- void **set_voice_delay_ms** **(** :ref:`int` voice_idx, :ref:`float` delay_ms **)** -- :ref:`float` **get_voice_delay_ms** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_delay_ms**\ (\ voice_idx\: :ref:`int`, delay_ms\: :ref:`float`\ ) +- :ref:`float` **get_voice_delay_ms**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's signal delay. @@ -194,8 +194,8 @@ The voice's signal delay. .. rst-class:: classref-property-setget -- void **set_voice_depth_ms** **(** :ref:`int` voice_idx, :ref:`float` depth_ms **)** -- :ref:`float` **get_voice_depth_ms** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_depth_ms**\ (\ voice_idx\: :ref:`int`, depth_ms\: :ref:`float`\ ) +- :ref:`float` **get_voice_depth_ms**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice filter's depth. @@ -211,8 +211,8 @@ The voice filter's depth. .. rst-class:: classref-property-setget -- void **set_voice_level_db** **(** :ref:`int` voice_idx, :ref:`float` level_db **)** -- :ref:`float` **get_voice_level_db** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_level_db**\ (\ voice_idx\: :ref:`int`, level_db\: :ref:`float`\ ) +- :ref:`float` **get_voice_level_db**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's volume. @@ -228,8 +228,8 @@ The voice's volume. .. rst-class:: classref-property-setget -- void **set_voice_pan** **(** :ref:`int` voice_idx, :ref:`float` pan **)** -- :ref:`float` **get_voice_pan** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_pan**\ (\ voice_idx\: :ref:`int`, pan\: :ref:`float`\ ) +- :ref:`float` **get_voice_pan**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's pan level. @@ -245,8 +245,8 @@ The voice's pan level. .. rst-class:: classref-property-setget -- void **set_voice_rate_hz** **(** :ref:`int` voice_idx, :ref:`float` rate_hz **)** -- :ref:`float` **get_voice_rate_hz** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_rate_hz**\ (\ voice_idx\: :ref:`int`, rate_hz\: :ref:`float`\ ) +- :ref:`float` **get_voice_rate_hz**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's filter rate. @@ -262,8 +262,8 @@ The voice's filter rate. .. rst-class:: classref-property-setget -- void **set_voice_cutoff_hz** **(** :ref:`int` voice_idx, :ref:`float` cutoff_hz **)** -- :ref:`float` **get_voice_cutoff_hz** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_cutoff_hz**\ (\ voice_idx\: :ref:`int`, cutoff_hz\: :ref:`float`\ ) +- :ref:`float` **get_voice_cutoff_hz**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's cutoff frequency. @@ -279,8 +279,8 @@ The voice's cutoff frequency. .. rst-class:: classref-property-setget -- void **set_voice_delay_ms** **(** :ref:`int` voice_idx, :ref:`float` delay_ms **)** -- :ref:`float` **get_voice_delay_ms** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_delay_ms**\ (\ voice_idx\: :ref:`int`, delay_ms\: :ref:`float`\ ) +- :ref:`float` **get_voice_delay_ms**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's signal delay. @@ -296,8 +296,8 @@ The voice's signal delay. .. rst-class:: classref-property-setget -- void **set_voice_depth_ms** **(** :ref:`int` voice_idx, :ref:`float` depth_ms **)** -- :ref:`float` **get_voice_depth_ms** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_depth_ms**\ (\ voice_idx\: :ref:`int`, depth_ms\: :ref:`float`\ ) +- :ref:`float` **get_voice_depth_ms**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice filter's depth. @@ -313,8 +313,8 @@ The voice filter's depth. .. rst-class:: classref-property-setget -- void **set_voice_level_db** **(** :ref:`int` voice_idx, :ref:`float` level_db **)** -- :ref:`float` **get_voice_level_db** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_level_db**\ (\ voice_idx\: :ref:`int`, level_db\: :ref:`float`\ ) +- :ref:`float` **get_voice_level_db**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's volume. @@ -330,8 +330,8 @@ The voice's volume. .. rst-class:: classref-property-setget -- void **set_voice_pan** **(** :ref:`int` voice_idx, :ref:`float` pan **)** -- :ref:`float` **get_voice_pan** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_pan**\ (\ voice_idx\: :ref:`int`, pan\: :ref:`float`\ ) +- :ref:`float` **get_voice_pan**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's pan level. @@ -347,8 +347,8 @@ The voice's pan level. .. rst-class:: classref-property-setget -- void **set_voice_rate_hz** **(** :ref:`int` voice_idx, :ref:`float` rate_hz **)** -- :ref:`float` **get_voice_rate_hz** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_rate_hz**\ (\ voice_idx\: :ref:`int`, rate_hz\: :ref:`float`\ ) +- :ref:`float` **get_voice_rate_hz**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's filter rate. @@ -364,8 +364,8 @@ The voice's filter rate. .. rst-class:: classref-property-setget -- void **set_voice_cutoff_hz** **(** :ref:`int` voice_idx, :ref:`float` cutoff_hz **)** -- :ref:`float` **get_voice_cutoff_hz** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_cutoff_hz**\ (\ voice_idx\: :ref:`int`, cutoff_hz\: :ref:`float`\ ) +- :ref:`float` **get_voice_cutoff_hz**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's cutoff frequency. @@ -381,8 +381,8 @@ The voice's cutoff frequency. .. rst-class:: classref-property-setget -- void **set_voice_delay_ms** **(** :ref:`int` voice_idx, :ref:`float` delay_ms **)** -- :ref:`float` **get_voice_delay_ms** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_delay_ms**\ (\ voice_idx\: :ref:`int`, delay_ms\: :ref:`float`\ ) +- :ref:`float` **get_voice_delay_ms**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's signal delay. @@ -398,8 +398,8 @@ The voice's signal delay. .. rst-class:: classref-property-setget -- void **set_voice_depth_ms** **(** :ref:`int` voice_idx, :ref:`float` depth_ms **)** -- :ref:`float` **get_voice_depth_ms** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_depth_ms**\ (\ voice_idx\: :ref:`int`, depth_ms\: :ref:`float`\ ) +- :ref:`float` **get_voice_depth_ms**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice filter's depth. @@ -415,8 +415,8 @@ The voice filter's depth. .. rst-class:: classref-property-setget -- void **set_voice_level_db** **(** :ref:`int` voice_idx, :ref:`float` level_db **)** -- :ref:`float` **get_voice_level_db** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_level_db**\ (\ voice_idx\: :ref:`int`, level_db\: :ref:`float`\ ) +- :ref:`float` **get_voice_level_db**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's volume. @@ -432,8 +432,8 @@ The voice's volume. .. rst-class:: classref-property-setget -- void **set_voice_pan** **(** :ref:`int` voice_idx, :ref:`float` pan **)** -- :ref:`float` **get_voice_pan** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_pan**\ (\ voice_idx\: :ref:`int`, pan\: :ref:`float`\ ) +- :ref:`float` **get_voice_pan**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's pan level. @@ -449,8 +449,8 @@ The voice's pan level. .. rst-class:: classref-property-setget -- void **set_voice_rate_hz** **(** :ref:`int` voice_idx, :ref:`float` rate_hz **)** -- :ref:`float` **get_voice_rate_hz** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_rate_hz**\ (\ voice_idx\: :ref:`int`, rate_hz\: :ref:`float`\ ) +- :ref:`float` **get_voice_rate_hz**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's filter rate. @@ -466,8 +466,8 @@ The voice's filter rate. .. rst-class:: classref-property-setget -- void **set_voice_cutoff_hz** **(** :ref:`int` voice_idx, :ref:`float` cutoff_hz **)** -- :ref:`float` **get_voice_cutoff_hz** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_cutoff_hz**\ (\ voice_idx\: :ref:`int`, cutoff_hz\: :ref:`float`\ ) +- :ref:`float` **get_voice_cutoff_hz**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's cutoff frequency. @@ -483,8 +483,8 @@ The voice's cutoff frequency. .. rst-class:: classref-property-setget -- void **set_voice_delay_ms** **(** :ref:`int` voice_idx, :ref:`float` delay_ms **)** -- :ref:`float` **get_voice_delay_ms** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_delay_ms**\ (\ voice_idx\: :ref:`int`, delay_ms\: :ref:`float`\ ) +- :ref:`float` **get_voice_delay_ms**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's signal delay. @@ -500,8 +500,8 @@ The voice's signal delay. .. rst-class:: classref-property-setget -- void **set_voice_depth_ms** **(** :ref:`int` voice_idx, :ref:`float` depth_ms **)** -- :ref:`float` **get_voice_depth_ms** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_depth_ms**\ (\ voice_idx\: :ref:`int`, depth_ms\: :ref:`float`\ ) +- :ref:`float` **get_voice_depth_ms**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice filter's depth. @@ -517,8 +517,8 @@ The voice filter's depth. .. rst-class:: classref-property-setget -- void **set_voice_level_db** **(** :ref:`int` voice_idx, :ref:`float` level_db **)** -- :ref:`float` **get_voice_level_db** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_level_db**\ (\ voice_idx\: :ref:`int`, level_db\: :ref:`float`\ ) +- :ref:`float` **get_voice_level_db**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's volume. @@ -534,8 +534,8 @@ The voice's volume. .. rst-class:: classref-property-setget -- void **set_voice_pan** **(** :ref:`int` voice_idx, :ref:`float` pan **)** -- :ref:`float` **get_voice_pan** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_pan**\ (\ voice_idx\: :ref:`int`, pan\: :ref:`float`\ ) +- :ref:`float` **get_voice_pan**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's pan level. @@ -551,8 +551,8 @@ The voice's pan level. .. rst-class:: classref-property-setget -- void **set_voice_rate_hz** **(** :ref:`int` voice_idx, :ref:`float` rate_hz **)** -- :ref:`float` **get_voice_rate_hz** **(** :ref:`int` voice_idx **)** |const| +- |void| **set_voice_rate_hz**\ (\ voice_idx\: :ref:`int`, rate_hz\: :ref:`float`\ ) +- :ref:`float` **get_voice_rate_hz**\ (\ voice_idx\: :ref:`int`\ ) |const| The voice's filter rate. @@ -568,8 +568,8 @@ The voice's filter rate. .. rst-class:: classref-property-setget -- void **set_voice_count** **(** :ref:`int` value **)** -- :ref:`int` **get_voice_count** **(** **)** +- |void| **set_voice_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_voice_count**\ (\ ) The number of voices in the effect. @@ -585,8 +585,8 @@ The number of voices in the effect. .. rst-class:: classref-property-setget -- void **set_wet** **(** :ref:`float` value **)** -- :ref:`float` **get_wet** **(** **)** +- |void| **set_wet**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_wet**\ (\ ) The effect's processed signal. @@ -603,7 +603,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_voice_cutoff_hz** **(** :ref:`int` voice_idx **)** |const| +:ref:`float` **get_voice_cutoff_hz**\ (\ voice_idx\: :ref:`int`\ ) |const| .. container:: contribute @@ -617,7 +617,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_voice_delay_ms** **(** :ref:`int` voice_idx **)** |const| +:ref:`float` **get_voice_delay_ms**\ (\ voice_idx\: :ref:`int`\ ) |const| .. container:: contribute @@ -631,7 +631,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_voice_depth_ms** **(** :ref:`int` voice_idx **)** |const| +:ref:`float` **get_voice_depth_ms**\ (\ voice_idx\: :ref:`int`\ ) |const| .. container:: contribute @@ -645,7 +645,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_voice_level_db** **(** :ref:`int` voice_idx **)** |const| +:ref:`float` **get_voice_level_db**\ (\ voice_idx\: :ref:`int`\ ) |const| .. container:: contribute @@ -659,7 +659,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_voice_pan** **(** :ref:`int` voice_idx **)** |const| +:ref:`float` **get_voice_pan**\ (\ voice_idx\: :ref:`int`\ ) |const| .. container:: contribute @@ -673,7 +673,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_voice_rate_hz** **(** :ref:`int` voice_idx **)** |const| +:ref:`float` **get_voice_rate_hz**\ (\ voice_idx\: :ref:`int`\ ) |const| .. container:: contribute @@ -687,7 +687,7 @@ Method Descriptions .. rst-class:: classref-method -void **set_voice_cutoff_hz** **(** :ref:`int` voice_idx, :ref:`float` cutoff_hz **)** +|void| **set_voice_cutoff_hz**\ (\ voice_idx\: :ref:`int`, cutoff_hz\: :ref:`float`\ ) .. container:: contribute @@ -701,7 +701,7 @@ void **set_voice_cutoff_hz** **(** :ref:`int` voice_idx, :ref:`float< .. rst-class:: classref-method -void **set_voice_delay_ms** **(** :ref:`int` voice_idx, :ref:`float` delay_ms **)** +|void| **set_voice_delay_ms**\ (\ voice_idx\: :ref:`int`, delay_ms\: :ref:`float`\ ) .. container:: contribute @@ -715,7 +715,7 @@ void **set_voice_delay_ms** **(** :ref:`int` voice_idx, :ref:`float` voice_idx, :ref:`float` depth_ms **)** +|void| **set_voice_depth_ms**\ (\ voice_idx\: :ref:`int`, depth_ms\: :ref:`float`\ ) .. container:: contribute @@ -729,7 +729,7 @@ void **set_voice_depth_ms** **(** :ref:`int` voice_idx, :ref:`float` voice_idx, :ref:`float` level_db **)** +|void| **set_voice_level_db**\ (\ voice_idx\: :ref:`int`, level_db\: :ref:`float`\ ) .. container:: contribute @@ -743,7 +743,7 @@ void **set_voice_level_db** **(** :ref:`int` voice_idx, :ref:`float` voice_idx, :ref:`float` pan **)** +|void| **set_voice_pan**\ (\ voice_idx\: :ref:`int`, pan\: :ref:`float`\ ) .. container:: contribute @@ -757,7 +757,7 @@ void **set_voice_pan** **(** :ref:`int` voice_idx, :ref:`float` voice_idx, :ref:`float` rate_hz **)** +|void| **set_voice_rate_hz**\ (\ voice_idx\: :ref:`int`, rate_hz\: :ref:`float`\ ) .. container:: contribute @@ -770,3 +770,4 @@ void **set_voice_rate_hz** **(** :ref:`int` voice_idx, :ref:`float` value **)** -- :ref:`float` **get_attack_us** **(** **)** +- |void| **set_attack_us**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_attack_us**\ (\ ) Compressor's reaction time when the signal exceeds the threshold, in microseconds. Value can range from 20 to 2000. @@ -98,8 +98,8 @@ Compressor's reaction time when the signal exceeds the threshold, in microsecond .. rst-class:: classref-property-setget -- void **set_gain** **(** :ref:`float` value **)** -- :ref:`float` **get_gain** **(** **)** +- |void| **set_gain**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_gain**\ (\ ) Gain applied to the output signal. @@ -115,8 +115,8 @@ Gain applied to the output signal. .. rst-class:: classref-property-setget -- void **set_mix** **(** :ref:`float` value **)** -- :ref:`float` **get_mix** **(** **)** +- |void| **set_mix**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_mix**\ (\ ) Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). @@ -132,8 +132,8 @@ Balance between original signal and effect signal. Value can range from 0 (total .. rst-class:: classref-property-setget -- void **set_ratio** **(** :ref:`float` value **)** -- :ref:`float` **get_ratio** **(** **)** +- |void| **set_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ratio**\ (\ ) Amount of compression applied to the audio once it passes the threshold level. The higher the ratio, the more the loud parts of the audio will be compressed. Value can range from 1 to 48. @@ -149,8 +149,8 @@ Amount of compression applied to the audio once it passes the threshold level. T .. rst-class:: classref-property-setget -- void **set_release_ms** **(** :ref:`float` value **)** -- :ref:`float` **get_release_ms** **(** **)** +- |void| **set_release_ms**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_release_ms**\ (\ ) Compressor's delay time to stop reducing the signal after the signal level falls below the threshold, in milliseconds. Value can range from 20 to 2000. @@ -166,8 +166,8 @@ Compressor's delay time to stop reducing the signal after the signal level falls .. rst-class:: classref-property-setget -- void **set_sidechain** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_sidechain** **(** **)** +- |void| **set_sidechain**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_sidechain**\ (\ ) Reduce the sound level using another audio bus for threshold detection. @@ -183,8 +183,8 @@ Reduce the sound level using another audio bus for threshold detection. .. rst-class:: classref-property-setget -- void **set_threshold** **(** :ref:`float` value **)** -- :ref:`float` **get_threshold** **(** **)** +- |void| **set_threshold**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_threshold**\ (\ ) The level above which compression is applied to the audio. Value can range from -60 to 0. @@ -195,3 +195,4 @@ The level above which compression is applied to the audio. Value can range from .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst index fe302226711..0d1d8cbfcdc 100644 --- a/classes/class_audioeffectdelay.rst +++ b/classes/class_audioeffectdelay.rst @@ -83,8 +83,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_dry** **(** :ref:`float` value **)** -- :ref:`float` **get_dry** **(** **)** +- |void| **set_dry**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_dry**\ (\ ) Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1. @@ -100,8 +100,8 @@ Output percent of original sound. At 0, only delayed sounds are output. Value ca .. rst-class:: classref-property-setget -- void **set_feedback_active** **(** :ref:`bool` value **)** -- :ref:`bool` **is_feedback_active** **(** **)** +- |void| **set_feedback_active**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_feedback_active**\ (\ ) If ``true``, feedback is enabled. @@ -117,8 +117,8 @@ If ``true``, feedback is enabled. .. rst-class:: classref-property-setget -- void **set_feedback_delay_ms** **(** :ref:`float` value **)** -- :ref:`float` **get_feedback_delay_ms** **(** **)** +- |void| **set_feedback_delay_ms**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_feedback_delay_ms**\ (\ ) Feedback delay time in milliseconds. @@ -134,8 +134,8 @@ Feedback delay time in milliseconds. .. rst-class:: classref-property-setget -- void **set_feedback_level_db** **(** :ref:`float` value **)** -- :ref:`float` **get_feedback_level_db** **(** **)** +- |void| **set_feedback_level_db**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_feedback_level_db**\ (\ ) Sound level for feedback. @@ -151,8 +151,8 @@ Sound level for feedback. .. rst-class:: classref-property-setget -- void **set_feedback_lowpass** **(** :ref:`float` value **)** -- :ref:`float` **get_feedback_lowpass** **(** **)** +- |void| **set_feedback_lowpass**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_feedback_lowpass**\ (\ ) Low-pass filter for feedback, in Hz. Frequencies below this value are filtered out of the source signal. @@ -168,8 +168,8 @@ Low-pass filter for feedback, in Hz. Frequencies below this value are filtered o .. rst-class:: classref-property-setget -- void **set_tap1_active** **(** :ref:`bool` value **)** -- :ref:`bool` **is_tap1_active** **(** **)** +- |void| **set_tap1_active**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_tap1_active**\ (\ ) If ``true``, the first tap will be enabled. @@ -185,8 +185,8 @@ If ``true``, the first tap will be enabled. .. rst-class:: classref-property-setget -- void **set_tap1_delay_ms** **(** :ref:`float` value **)** -- :ref:`float` **get_tap1_delay_ms** **(** **)** +- |void| **set_tap1_delay_ms**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_tap1_delay_ms**\ (\ ) First tap delay time in milliseconds. @@ -202,8 +202,8 @@ First tap delay time in milliseconds. .. rst-class:: classref-property-setget -- void **set_tap1_level_db** **(** :ref:`float` value **)** -- :ref:`float` **get_tap1_level_db** **(** **)** +- |void| **set_tap1_level_db**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_tap1_level_db**\ (\ ) Sound level for the first tap. @@ -219,8 +219,8 @@ Sound level for the first tap. .. rst-class:: classref-property-setget -- void **set_tap1_pan** **(** :ref:`float` value **)** -- :ref:`float` **get_tap1_pan** **(** **)** +- |void| **set_tap1_pan**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_tap1_pan**\ (\ ) Pan position for the first tap. Value can range from -1 (fully left) to 1 (fully right). @@ -236,8 +236,8 @@ Pan position for the first tap. Value can range from -1 (fully left) to 1 (fully .. rst-class:: classref-property-setget -- void **set_tap2_active** **(** :ref:`bool` value **)** -- :ref:`bool` **is_tap2_active** **(** **)** +- |void| **set_tap2_active**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_tap2_active**\ (\ ) If ``true``, the second tap will be enabled. @@ -253,8 +253,8 @@ If ``true``, the second tap will be enabled. .. rst-class:: classref-property-setget -- void **set_tap2_delay_ms** **(** :ref:`float` value **)** -- :ref:`float` **get_tap2_delay_ms** **(** **)** +- |void| **set_tap2_delay_ms**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_tap2_delay_ms**\ (\ ) Second tap delay time in milliseconds. @@ -270,8 +270,8 @@ Second tap delay time in milliseconds. .. rst-class:: classref-property-setget -- void **set_tap2_level_db** **(** :ref:`float` value **)** -- :ref:`float` **get_tap2_level_db** **(** **)** +- |void| **set_tap2_level_db**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_tap2_level_db**\ (\ ) Sound level for the second tap. @@ -287,8 +287,8 @@ Sound level for the second tap. .. rst-class:: classref-property-setget -- void **set_tap2_pan** **(** :ref:`float` value **)** -- :ref:`float` **get_tap2_pan** **(** **)** +- |void| **set_tap2_pan**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_tap2_pan**\ (\ ) Pan position for the second tap. Value can range from -1 (fully left) to 1 (fully right). @@ -299,3 +299,4 @@ Pan position for the second tap. Value can range from -1 (fully left) to 1 (full .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index 9357e44a668..df9d138c7ec 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -128,8 +128,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_drive** **(** :ref:`float` value **)** -- :ref:`float` **get_drive** **(** **)** +- |void| **set_drive**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_drive**\ (\ ) Distortion power. Value can range from 0 to 1. @@ -145,8 +145,8 @@ Distortion power. Value can range from 0 to 1. .. rst-class:: classref-property-setget -- void **set_keep_hf_hz** **(** :ref:`float` value **)** -- :ref:`float` **get_keep_hf_hz** **(** **)** +- |void| **set_keep_hf_hz**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_keep_hf_hz**\ (\ ) High-pass filter, in Hz. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000. @@ -162,8 +162,8 @@ High-pass filter, in Hz. Frequencies higher than this value will not be affected .. rst-class:: classref-property-setget -- void **set_mode** **(** :ref:`Mode` value **)** -- :ref:`Mode` **get_mode** **(** **)** +- |void| **set_mode**\ (\ value\: :ref:`Mode`\ ) +- :ref:`Mode` **get_mode**\ (\ ) Distortion type. @@ -179,8 +179,8 @@ Distortion type. .. rst-class:: classref-property-setget -- void **set_post_gain** **(** :ref:`float` value **)** -- :ref:`float` **get_post_gain** **(** **)** +- |void| **set_post_gain**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_post_gain**\ (\ ) Increases or decreases the volume after the effect, in decibels. Value can range from -80 to 24. @@ -196,8 +196,8 @@ Increases or decreases the volume after the effect, in decibels. Value can range .. rst-class:: classref-property-setget -- void **set_pre_gain** **(** :ref:`float` value **)** -- :ref:`float` **get_pre_gain** **(** **)** +- |void| **set_pre_gain**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pre_gain**\ (\ ) Increases or decreases the volume before the effect, in decibels. Value can range from -60 to 60. @@ -208,3 +208,4 @@ Increases or decreases the volume before the effect, in decibels. Value can rang .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffecteq.rst b/classes/class_audioeffecteq.rst index c132fb0eb03..6115db78170 100644 --- a/classes/class_audioeffecteq.rst +++ b/classes/class_audioeffecteq.rst @@ -40,13 +40,13 @@ Methods .. table:: :widths: auto - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_band_count` **(** **)** |const| | - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_band_gain_db` **(** :ref:`int` band_idx **)** |const| | - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_band_gain_db` **(** :ref:`int` band_idx, :ref:`float` volume_db **)** | - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_band_count`\ (\ ) |const| | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_band_gain_db`\ (\ band_idx\: :ref:`int`\ ) |const| | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_band_gain_db`\ (\ band_idx\: :ref:`int`, volume_db\: :ref:`float`\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -61,7 +61,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_band_count** **(** **)** |const| +:ref:`int` **get_band_count**\ (\ ) |const| Returns the number of bands of the equalizer. @@ -73,7 +73,7 @@ Returns the number of bands of the equalizer. .. rst-class:: classref-method -:ref:`float` **get_band_gain_db** **(** :ref:`int` band_idx **)** |const| +:ref:`float` **get_band_gain_db**\ (\ band_idx\: :ref:`int`\ ) |const| Returns the band's gain at the specified index, in dB. @@ -85,7 +85,7 @@ Returns the band's gain at the specified index, in dB. .. rst-class:: classref-method -void **set_band_gain_db** **(** :ref:`int` band_idx, :ref:`float` volume_db **)** +|void| **set_band_gain_db**\ (\ band_idx\: :ref:`int`, volume_db\: :ref:`float`\ ) Sets band's gain at the specified index, in dB. @@ -96,3 +96,4 @@ Sets band's gain at the specified index, in dB. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffecteq10.rst b/classes/class_audioeffecteq10.rst index d1dc42c3276..fe6ec7273cd 100644 --- a/classes/class_audioeffecteq10.rst +++ b/classes/class_audioeffecteq10.rst @@ -59,3 +59,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffecteq21.rst b/classes/class_audioeffecteq21.rst index b753bc6dd78..d7dcd58ee04 100644 --- a/classes/class_audioeffecteq21.rst +++ b/classes/class_audioeffecteq21.rst @@ -81,3 +81,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffecteq6.rst b/classes/class_audioeffecteq6.rst index 098fd3a3fa7..139c4c25cf2 100644 --- a/classes/class_audioeffecteq6.rst +++ b/classes/class_audioeffecteq6.rst @@ -51,3 +51,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index 5dc6147180a..a102ead0e2c 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -128,8 +128,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_cutoff** **(** :ref:`float` value **)** -- :ref:`float` **get_cutoff** **(** **)** +- |void| **set_cutoff**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_cutoff**\ (\ ) Threshold frequency for the filter, in Hz. @@ -145,8 +145,8 @@ Threshold frequency for the filter, in Hz. .. rst-class:: classref-property-setget -- void **set_db** **(** :ref:`FilterDB` value **)** -- :ref:`FilterDB` **get_db** **(** **)** +- |void| **set_db**\ (\ value\: :ref:`FilterDB`\ ) +- :ref:`FilterDB` **get_db**\ (\ ) .. container:: contribute @@ -164,8 +164,8 @@ Threshold frequency for the filter, in Hz. .. rst-class:: classref-property-setget -- void **set_gain** **(** :ref:`float` value **)** -- :ref:`float` **get_gain** **(** **)** +- |void| **set_gain**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_gain**\ (\ ) Gain amount of the frequencies after the filter. @@ -181,8 +181,8 @@ Gain amount of the frequencies after the filter. .. rst-class:: classref-property-setget -- void **set_resonance** **(** :ref:`float` value **)** -- :ref:`float` **get_resonance** **(** **)** +- |void| **set_resonance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_resonance**\ (\ ) Amount of boost in the frequency range near the cutoff frequency. @@ -193,3 +193,4 @@ Amount of boost in the frequency range near the cutoff frequency. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffecthighpassfilter.rst b/classes/class_audioeffecthighpassfilter.rst index 94ec635c03b..3d5763b3d17 100644 --- a/classes/class_audioeffecthighpassfilter.rst +++ b/classes/class_audioeffecthighpassfilter.rst @@ -35,3 +35,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffecthighshelffilter.rst b/classes/class_audioeffecthighshelffilter.rst index 5b3073dba2d..11dc4176862 100644 --- a/classes/class_audioeffecthighshelffilter.rst +++ b/classes/class_audioeffecthighshelffilter.rst @@ -35,3 +35,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectinstance.rst b/classes/class_audioeffectinstance.rst index bf872a656f4..199ca3f9dc5 100644 --- a/classes/class_audioeffectinstance.rst +++ b/classes/class_audioeffectinstance.rst @@ -38,11 +38,11 @@ Methods .. table:: :widths: auto - +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_process` **(** const void* src_buffer, AudioFrame* dst_buffer, :ref:`int` frame_count **)** |virtual| | - +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_process_silence` **(** **)** |virtual| |const| | - +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_process`\ (\ src_buffer\: ``const void*``, dst_buffer\: ``AudioFrame*``, frame_count\: :ref:`int`\ ) |virtual| | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_process_silence`\ (\ ) |virtual| |const| | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -57,7 +57,7 @@ Method Descriptions .. rst-class:: classref-method -void **_process** **(** const void* src_buffer, AudioFrame* dst_buffer, :ref:`int` frame_count **)** |virtual| +|void| **_process**\ (\ src_buffer\: ``const void*``, dst_buffer\: ``AudioFrame*``, frame_count\: :ref:`int`\ ) |virtual| Called by the :ref:`AudioServer` to process this effect. When :ref:`_process_silence` is not overridden or it returns ``false``, this method is called only when the bus is active. @@ -71,7 +71,7 @@ Called by the :ref:`AudioServer` to process this effect. When .. rst-class:: classref-method -:ref:`bool` **_process_silence** **(** **)** |virtual| |const| +:ref:`bool` **_process_silence**\ (\ ) |virtual| |const| Override this method to customize the processing behavior of this effect instance. @@ -84,3 +84,4 @@ Should return ``true`` to force the :ref:`AudioServer` to alw .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index 67a2866af20..2b60bae0664 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -65,8 +65,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_ceiling_db** **(** :ref:`float` value **)** -- :ref:`float` **get_ceiling_db** **(** **)** +- |void| **set_ceiling_db**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ceiling_db**\ (\ ) The waveform's maximum allowed value, in decibels. Value can range from -20 to -0.1. @@ -82,8 +82,8 @@ The waveform's maximum allowed value, in decibels. Value can range from -20 to - .. rst-class:: classref-property-setget -- void **set_soft_clip_db** **(** :ref:`float` value **)** -- :ref:`float` **get_soft_clip_db** **(** **)** +- |void| **set_soft_clip_db**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_soft_clip_db**\ (\ ) Applies a gain to the limited waves, in decibels. Value can range from 0 to 6. @@ -99,8 +99,8 @@ Applies a gain to the limited waves, in decibels. Value can range from 0 to 6. .. rst-class:: classref-property-setget -- void **set_soft_clip_ratio** **(** :ref:`float` value **)** -- :ref:`float` **get_soft_clip_ratio** **(** **)** +- |void| **set_soft_clip_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_soft_clip_ratio**\ (\ ) .. container:: contribute @@ -118,8 +118,8 @@ Applies a gain to the limited waves, in decibels. Value can range from 0 to 6. .. rst-class:: classref-property-setget -- void **set_threshold_db** **(** :ref:`float` value **)** -- :ref:`float` **get_threshold_db** **(** **)** +- |void| **set_threshold_db**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_threshold_db**\ (\ ) Threshold from which the limiter begins to be active, in decibels. Value can range from -30 to 0. @@ -130,3 +130,4 @@ Threshold from which the limiter begins to be active, in decibels. Value can ran .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectlowpassfilter.rst b/classes/class_audioeffectlowpassfilter.rst index 17d4ec73d4f..bcf0160b80c 100644 --- a/classes/class_audioeffectlowpassfilter.rst +++ b/classes/class_audioeffectlowpassfilter.rst @@ -35,3 +35,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectlowshelffilter.rst b/classes/class_audioeffectlowshelffilter.rst index 595fc3e938e..f42fcbdf468 100644 --- a/classes/class_audioeffectlowshelffilter.rst +++ b/classes/class_audioeffectlowshelffilter.rst @@ -35,3 +35,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectnotchfilter.rst b/classes/class_audioeffectnotchfilter.rst index 1a117207306..d7d6847e519 100644 --- a/classes/class_audioeffectnotchfilter.rst +++ b/classes/class_audioeffectnotchfilter.rst @@ -35,3 +35,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectpanner.rst b/classes/class_audioeffectpanner.rst index cbfcd3d958d..1352091dc22 100644 --- a/classes/class_audioeffectpanner.rst +++ b/classes/class_audioeffectpanner.rst @@ -57,8 +57,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_pan** **(** :ref:`float` value **)** -- :ref:`float` **get_pan** **(** **)** +- |void| **set_pan**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pan**\ (\ ) Pan position. Value can range from -1 (fully left) to 1 (fully right). @@ -69,3 +69,4 @@ Pan position. Value can range from -1 (fully left) to 1 (fully right). .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst index 1d77b88c898..4d16c17beee 100644 --- a/classes/class_audioeffectphaser.rst +++ b/classes/class_audioeffectphaser.rst @@ -67,8 +67,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_depth** **(** :ref:`float` value **)** -- :ref:`float` **get_depth** **(** **)** +- |void| **set_depth**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_depth**\ (\ ) Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4. @@ -84,8 +84,8 @@ Governs how high the filter frequencies sweep. Low value will primarily affect b .. rst-class:: classref-property-setget -- void **set_feedback** **(** :ref:`float` value **)** -- :ref:`float` **get_feedback** **(** **)** +- |void| **set_feedback**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_feedback**\ (\ ) Output percent of modified sound. Value can range from 0.1 to 0.9. @@ -101,8 +101,8 @@ Output percent of modified sound. Value can range from 0.1 to 0.9. .. rst-class:: classref-property-setget -- void **set_range_max_hz** **(** :ref:`float` value **)** -- :ref:`float` **get_range_max_hz** **(** **)** +- |void| **set_range_max_hz**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_range_max_hz**\ (\ ) Determines the maximum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000. @@ -118,8 +118,8 @@ Determines the maximum frequency affected by the LFO modulations, in Hz. Value c .. rst-class:: classref-property-setget -- void **set_range_min_hz** **(** :ref:`float` value **)** -- :ref:`float` **get_range_min_hz** **(** **)** +- |void| **set_range_min_hz**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_range_min_hz**\ (\ ) Determines the minimum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000. @@ -135,8 +135,8 @@ Determines the minimum frequency affected by the LFO modulations, in Hz. Value c .. rst-class:: classref-property-setget -- void **set_rate_hz** **(** :ref:`float` value **)** -- :ref:`float` **get_rate_hz** **(** **)** +- |void| **set_rate_hz**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_rate_hz**\ (\ ) Adjusts the rate in Hz at which the effect sweeps up and down across the frequency range. @@ -147,3 +147,4 @@ Adjusts the rate in Hz at which the effect sweeps up and down across the frequen .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectpitchshift.rst b/classes/class_audioeffectpitchshift.rst index 9f19f180cf7..ca17f0d2099 100644 --- a/classes/class_audioeffectpitchshift.rst +++ b/classes/class_audioeffectpitchshift.rst @@ -126,8 +126,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_fft_size** **(** :ref:`FFTSize` value **)** -- :ref:`FFTSize` **get_fft_size** **(** **)** +- |void| **set_fft_size**\ (\ value\: :ref:`FFTSize`\ ) +- :ref:`FFTSize` **get_fft_size**\ (\ ) The size of the `Fast Fourier transform `__ buffer. Higher values smooth out the effect over time, but have greater latency. The effects of this higher latency are especially noticeable on sounds that have sudden amplitude changes. @@ -143,8 +143,8 @@ The size of the `Fast Fourier transform ` value **)** -- :ref:`int` **get_oversampling** **(** **)** +- |void| **set_oversampling**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_oversampling**\ (\ ) The oversampling factor to use. Higher values result in better quality, but are more demanding on the CPU and may cause audio cracking if the CPU can't keep up. @@ -160,8 +160,8 @@ The oversampling factor to use. Higher values result in better quality, but are .. rst-class:: classref-property-setget -- void **set_pitch_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_pitch_scale** **(** **)** +- |void| **set_pitch_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pitch_scale**\ (\ ) 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). @@ -172,3 +172,4 @@ The pitch scale to use. ``1.0`` is the default pitch and plays sounds unaffected .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectrecord.rst b/classes/class_audioeffectrecord.rst index b8dfb528920..c344f946e32 100644 --- a/classes/class_audioeffectrecord.rst +++ b/classes/class_audioeffectrecord.rst @@ -56,13 +56,13 @@ Methods .. table:: :widths: auto - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStreamWAV` | :ref:`get_recording` **(** **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_recording_active` **(** **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_recording_active` **(** :ref:`bool` record **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamWAV` | :ref:`get_recording`\ (\ ) |const| | + +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_recording_active`\ (\ ) |const| | + +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_recording_active`\ (\ record\: :ref:`bool`\ ) | + +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -81,8 +81,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_format** **(** :ref:`Format` value **)** -- :ref:`Format` **get_format** **(** **)** +- |void| **set_format**\ (\ value\: :ref:`Format`\ ) +- :ref:`Format` **get_format**\ (\ ) Specifies the format in which the sample will be recorded. See :ref:`Format` for available formats. @@ -99,7 +99,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AudioStreamWAV` **get_recording** **(** **)** |const| +:ref:`AudioStreamWAV` **get_recording**\ (\ ) |const| Returns the recorded sample. @@ -111,7 +111,7 @@ Returns the recorded sample. .. rst-class:: classref-method -:ref:`bool` **is_recording_active** **(** **)** |const| +:ref:`bool` **is_recording_active**\ (\ ) |const| Returns whether the recording is active or not. @@ -123,7 +123,7 @@ Returns whether the recording is active or not. .. rst-class:: classref-method -void **set_recording_active** **(** :ref:`bool` record **)** +|void| **set_recording_active**\ (\ record\: :ref:`bool`\ ) If ``true``, the sound will be recorded. Note that restarting the recording will remove the previously recorded sample. @@ -134,3 +134,4 @@ If ``true``, the sound will be recorded. Note that restarting the recording will .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectreverb.rst b/classes/class_audioeffectreverb.rst index 5b7ca1e55a3..a143ad17c22 100644 --- a/classes/class_audioeffectreverb.rst +++ b/classes/class_audioeffectreverb.rst @@ -73,8 +73,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_damping** **(** :ref:`float` value **)** -- :ref:`float` **get_damping** **(** **)** +- |void| **set_damping**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_damping**\ (\ ) Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. @@ -90,8 +90,8 @@ Defines how reflective the imaginary room's walls are. Value can range from 0 to .. rst-class:: classref-property-setget -- void **set_dry** **(** :ref:`float` value **)** -- :ref:`float` **get_dry** **(** **)** +- |void| **set_dry**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_dry**\ (\ ) Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. @@ -107,8 +107,8 @@ Output percent of original sound. At 0, only modified sound is outputted. Value .. rst-class:: classref-property-setget -- void **set_hpf** **(** :ref:`float` value **)** -- :ref:`float` **get_hpf** **(** **)** +- |void| **set_hpf**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_hpf**\ (\ ) High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1. @@ -124,8 +124,8 @@ High-pass filter passes signals with a frequency higher than a certain cutoff fr .. rst-class:: classref-property-setget -- void **set_predelay_feedback** **(** :ref:`float` value **)** -- :ref:`float` **get_predelay_feedback** **(** **)** +- |void| **set_predelay_feedback**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_predelay_feedback**\ (\ ) Output percent of predelay. Value can range from 0 to 1. @@ -141,8 +141,8 @@ Output percent of predelay. Value can range from 0 to 1. .. rst-class:: classref-property-setget -- void **set_predelay_msec** **(** :ref:`float` value **)** -- :ref:`float` **get_predelay_msec** **(** **)** +- |void| **set_predelay_msec**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_predelay_msec**\ (\ ) Time between the original signal and the early reflections of the reverb signal, in milliseconds. @@ -158,8 +158,8 @@ Time between the original signal and the early reflections of the reverb signal, .. rst-class:: classref-property-setget -- void **set_room_size** **(** :ref:`float` value **)** -- :ref:`float` **get_room_size** **(** **)** +- |void| **set_room_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_room_size**\ (\ ) Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. @@ -175,8 +175,8 @@ Dimensions of simulated room. Bigger means more echoes. Value can range from 0 t .. rst-class:: classref-property-setget -- void **set_spread** **(** :ref:`float` value **)** -- :ref:`float` **get_spread** **(** **)** +- |void| **set_spread**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_spread**\ (\ ) Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1. @@ -192,8 +192,8 @@ Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Val .. rst-class:: classref-property-setget -- void **set_wet** **(** :ref:`float` value **)** -- :ref:`float` **get_wet** **(** **)** +- |void| **set_wet**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_wet**\ (\ ) Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1. @@ -204,3 +204,4 @@ Output percent of modified sound. At 0, only original sound is outputted. Value .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectspectrumanalyzer.rst b/classes/class_audioeffectspectrumanalyzer.rst index 428cd25da1c..8db1a9f7fe9 100644 --- a/classes/class_audioeffectspectrumanalyzer.rst +++ b/classes/class_audioeffectspectrumanalyzer.rst @@ -128,8 +128,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_buffer_length** **(** :ref:`float` value **)** -- :ref:`float` **get_buffer_length** **(** **)** +- |void| **set_buffer_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_buffer_length**\ (\ ) The length of the buffer to keep (in seconds). Higher values keep data around for longer, but require more memory. @@ -145,8 +145,8 @@ The length of the buffer to keep (in seconds). Higher values keep data around fo .. rst-class:: classref-property-setget -- void **set_fft_size** **(** :ref:`FFTSize` value **)** -- :ref:`FFTSize` **get_fft_size** **(** **)** +- |void| **set_fft_size**\ (\ value\: :ref:`FFTSize`\ ) +- :ref:`FFTSize` **get_fft_size**\ (\ ) The size of the `Fast Fourier transform `__ buffer. Higher values smooth out the spectrum analysis over time, but have greater latency. The effects of this higher latency are especially noticeable with sudden amplitude changes. @@ -162,8 +162,8 @@ The size of the `Fast Fourier transform ` value **)** -- :ref:`float` **get_tap_back_pos** **(** **)** +- |void| **set_tap_back_pos**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_tap_back_pos**\ (\ ) .. container:: contribute @@ -176,3 +176,4 @@ The size of the `Fast Fourier transform ` | :ref:`get_magnitude_for_frequency_range` **(** :ref:`float` from_hz, :ref:`float` to_hz, :ref:`MagnitudeMode` mode=1 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_magnitude_for_frequency_range`\ (\ from_hz\: :ref:`float`, to_hz\: :ref:`float`, mode\: :ref:`MagnitudeMode` = 1\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -72,7 +72,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector2` **get_magnitude_for_frequency_range** **(** :ref:`float` from_hz, :ref:`float` to_hz, :ref:`MagnitudeMode` mode=1 **)** |const| +:ref:`Vector2` **get_magnitude_for_frequency_range**\ (\ from_hz\: :ref:`float`, to_hz\: :ref:`float`, mode\: :ref:`MagnitudeMode` = 1\ ) |const| .. container:: contribute @@ -85,3 +85,4 @@ Method Descriptions .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audioeffectstereoenhance.rst b/classes/class_audioeffectstereoenhance.rst index fe4586d53c4..50474394b4e 100644 --- a/classes/class_audioeffectstereoenhance.rst +++ b/classes/class_audioeffectstereoenhance.rst @@ -61,8 +61,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_pan_pullout** **(** :ref:`float` value **)** -- :ref:`float` **get_pan_pullout** **(** **)** +- |void| **set_pan_pullout**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pan_pullout**\ (\ ) Values greater than 1.0 increase intensity of any panning on audio passing through this effect, whereas values less than 1.0 will decrease the panning intensity. A value of 0.0 will downmix audio to mono. @@ -78,8 +78,8 @@ Values greater than 1.0 increase intensity of any panning on audio passing throu .. rst-class:: classref-property-setget -- void **set_surround** **(** :ref:`float` value **)** -- :ref:`float` **get_surround** **(** **)** +- |void| **set_surround**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_surround**\ (\ ) .. container:: contribute @@ -97,8 +97,8 @@ Values greater than 1.0 increase intensity of any panning on audio passing throu .. rst-class:: classref-property-setget -- void **set_time_pullout** **(** :ref:`float` value **)** -- :ref:`float` **get_time_pullout** **(** **)** +- |void| **set_time_pullout**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_time_pullout**\ (\ ) .. container:: contribute @@ -111,3 +111,4 @@ Values greater than 1.0 increase intensity of any panning on audio passing throu .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiolistener2d.rst b/classes/class_audiolistener2d.rst index c6f29cc15fa..da5bbfd1de2 100644 --- a/classes/class_audiolistener2d.rst +++ b/classes/class_audiolistener2d.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: sound + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -31,13 +34,13 @@ Methods .. table:: :widths: auto - +-------------------------+--------------------------------------------------------------------------------+ - | void | :ref:`clear_current` **(** **)** | - +-------------------------+--------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_current` **(** **)** |const| | - +-------------------------+--------------------------------------------------------------------------------+ - | void | :ref:`make_current` **(** **)** | - +-------------------------+--------------------------------------------------------------------------------+ + +-------------------------+--------------------------------------------------------------------------+ + | |void| | :ref:`clear_current`\ (\ ) | + +-------------------------+--------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_current`\ (\ ) |const| | + +-------------------------+--------------------------------------------------------------------------+ + | |void| | :ref:`make_current`\ (\ ) | + +-------------------------+--------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -52,7 +55,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear_current** **(** **)** +|void| **clear_current**\ (\ ) Disables the **AudioListener2D**. If it's not set as current, this method will have no effect. @@ -64,7 +67,7 @@ Disables the **AudioListener2D**. If it's not set as current, this method will h .. rst-class:: classref-method -:ref:`bool` **is_current** **(** **)** |const| +:ref:`bool` **is_current**\ (\ ) |const| Returns ``true`` if this **AudioListener2D** is currently active. @@ -76,7 +79,7 @@ Returns ``true`` if this **AudioListener2D** is currently active. .. rst-class:: classref-method -void **make_current** **(** **)** +|void| **make_current**\ (\ ) Makes the **AudioListener2D** active, setting it as the hearing point for the sounds. If there is already another active **AudioListener2D**, it will be disabled. @@ -89,3 +92,4 @@ This method will have no effect if the **AudioListener2D** is not added to :ref: .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiolistener3d.rst b/classes/class_audiolistener3d.rst index 4e744d48974..2138839f322 100644 --- a/classes/class_audiolistener3d.rst +++ b/classes/class_audiolistener3d.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: sound + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -29,15 +32,15 @@ Methods .. table:: :widths: auto - +---------------------------------------+--------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_current` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`get_listener_transform` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_current` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------+ - | void | :ref:`make_current` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------+ + +---------------------------------------+--------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_current`\ (\ ) | + +---------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`get_listener_transform`\ (\ ) |const| | + +---------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_current`\ (\ ) |const| | + +---------------------------------------+--------------------------------------------------------------------------------------------------+ + | |void| | :ref:`make_current`\ (\ ) | + +---------------------------------------+--------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -52,7 +55,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear_current** **(** **)** +|void| **clear_current**\ (\ ) Disables the listener to use the current camera's listener instead. @@ -64,7 +67,7 @@ Disables the listener to use the current camera's listener instead. .. rst-class:: classref-method -:ref:`Transform3D` **get_listener_transform** **(** **)** |const| +:ref:`Transform3D` **get_listener_transform**\ (\ ) |const| Returns the listener's global orthonormalized :ref:`Transform3D`. @@ -76,7 +79,7 @@ Returns the listener's global orthonormalized :ref:`Transform3D` **is_current** **(** **)** |const| +:ref:`bool` **is_current**\ (\ ) |const| Returns ``true`` if the listener was made current using :ref:`make_current`, ``false`` otherwise. @@ -90,7 +93,7 @@ Returns ``true`` if the listener was made current using :ref:`make_current` **(** :ref:`int` at_position=-1 **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_bus_effect` **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_position=-1 **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioBusLayout` | :ref:`generate_bus_layout` **(** **)** |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_bus_channels` **(** :ref:`int` bus_idx **)** |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioEffect` | :ref:`get_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_bus_effect_count` **(** :ref:`int` bus_idx **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioEffectInstance` | :ref:`get_bus_effect_instance` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` channel=0 **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_bus_index` **(** :ref:`StringName` bus_name **)** |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_bus_name` **(** :ref:`int` bus_idx **)** |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_bus_peak_volume_left_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_bus_peak_volume_right_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_bus_send` **(** :ref:`int` bus_idx **)** |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_bus_volume_db` **(** :ref:`int` bus_idx **)** |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_input_device_list` **(** **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_mix_rate` **(** **)** |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_output_device_list` **(** **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_output_latency` **(** **)** |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SpeakerMode` | :ref:`get_speaker_mode` **(** **)** |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_time_since_last_mix` **(** **)** |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_time_to_next_mix` **(** **)** |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_bus_bypassing_effects` **(** :ref:`int` bus_idx **)** |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_bus_mute` **(** :ref:`int` bus_idx **)** |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_bus_solo` **(** :ref:`int` bus_idx **)** |const| | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`lock` **(** **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_bus` **(** :ref:`int` index, :ref:`int` to_index **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_bus` **(** :ref:`int` index **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bus_bypass_effects` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`bool` enabled **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bus_layout` **(** :ref:`AudioBusLayout` bus_layout **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bus_mute` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bus_name` **(** :ref:`int` bus_idx, :ref:`String` name **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bus_send` **(** :ref:`int` bus_idx, :ref:`StringName` send **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bus_solo` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bus_volume_db` **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_enable_tagging_used_audio_streams` **(** :ref:`bool` enable **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`swap_bus_effects` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`unlock` **(** **)** | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_bus`\ (\ at_position\: :ref:`int` = -1\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_bus_effect`\ (\ bus_idx\: :ref:`int`, effect\: :ref:`AudioEffect`, at_position\: :ref:`int` = -1\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioBusLayout` | :ref:`generate_bus_layout`\ (\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_bus_channels`\ (\ bus_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioEffect` | :ref:`get_bus_effect`\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_bus_effect_count`\ (\ bus_idx\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioEffectInstance` | :ref:`get_bus_effect_instance`\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`, channel\: :ref:`int` = 0\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_bus_index`\ (\ bus_name\: :ref:`StringName`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_bus_name`\ (\ bus_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_bus_peak_volume_left_db`\ (\ bus_idx\: :ref:`int`, channel\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_bus_peak_volume_right_db`\ (\ bus_idx\: :ref:`int`, channel\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_bus_send`\ (\ bus_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_bus_volume_db`\ (\ bus_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_input_device_list`\ (\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_mix_rate`\ (\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_output_device_list`\ (\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_output_latency`\ (\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SpeakerMode` | :ref:`get_speaker_mode`\ (\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_time_since_last_mix`\ (\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_time_to_next_mix`\ (\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_bus_bypassing_effects`\ (\ bus_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_bus_effect_enabled`\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_bus_mute`\ (\ bus_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_bus_solo`\ (\ bus_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`lock`\ (\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_bus`\ (\ index\: :ref:`int`, to_index\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_bus`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_bus_effect`\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bus_bypass_effects`\ (\ bus_idx\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bus_effect_enabled`\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bus_layout`\ (\ bus_layout\: :ref:`AudioBusLayout`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bus_mute`\ (\ bus_idx\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bus_name`\ (\ bus_idx\: :ref:`int`, name\: :ref:`String`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bus_send`\ (\ bus_idx\: :ref:`int`, send\: :ref:`StringName`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bus_solo`\ (\ bus_idx\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bus_volume_db`\ (\ bus_idx\: :ref:`int`, volume_db\: :ref:`float`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_enable_tagging_used_audio_streams`\ (\ enable\: :ref:`bool`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`swap_bus_effects`\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`, by_effect_idx\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unlock`\ (\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -153,7 +153,7 @@ Signals .. rst-class:: classref-signal -**bus_layout_changed** **(** **)** +**bus_layout_changed**\ (\ ) Emitted when an audio bus is added, deleted, or moved. @@ -165,7 +165,7 @@ Emitted when an audio bus is added, deleted, or moved. .. rst-class:: classref-signal -**bus_renamed** **(** :ref:`int` bus_index, :ref:`StringName` old_name, :ref:`StringName` new_name **)** +**bus_renamed**\ (\ bus_index\: :ref:`int`, old_name\: :ref:`StringName`, new_name\: :ref:`StringName`\ ) Emitted when the audio bus at ``bus_index`` is renamed from ``old_name`` to ``new_name``. @@ -233,8 +233,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bus_count** **(** :ref:`int` value **)** -- :ref:`int` **get_bus_count** **(** **)** +- |void| **set_bus_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_bus_count**\ (\ ) Number of available audio buses. @@ -250,8 +250,8 @@ Number of available audio buses. .. rst-class:: classref-property-setget -- void **set_input_device** **(** :ref:`String` value **)** -- :ref:`String` **get_input_device** **(** **)** +- |void| **set_input_device**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_input_device**\ (\ ) Name of the current device for audio input (see :ref:`get_input_device_list`). On systems with multiple audio inputs (such as analog, USB and HDMI audio), this can be used to select the audio input device. The value ``"Default"`` will record audio on the system-wide default audio input. If an invalid device name is set, the value will be reverted back to ``"Default"``. @@ -269,8 +269,8 @@ Name of the current device for audio input (see :ref:`get_input_device_list` value **)** -- :ref:`String` **get_output_device** **(** **)** +- |void| **set_output_device**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_output_device**\ (\ ) Name of the current device for audio output (see :ref:`get_output_device_list`). On systems with multiple audio outputs (such as analog, USB and HDMI audio), this can be used to select the audio output device. The value ``"Default"`` will play audio on the system-wide default audio output. If an invalid device name is set, the value will be reverted back to ``"Default"``. @@ -286,8 +286,8 @@ Name of the current device for audio output (see :ref:`get_output_device_list` value **)** -- :ref:`float` **get_playback_speed_scale** **(** **)** +- |void| **set_playback_speed_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_playback_speed_scale**\ (\ ) Scales the rate at which audio is played (i.e. setting it to ``0.5`` will make the audio be played at half its speed). See also :ref:`Engine.time_scale` to affect the general simulation speed, which is independent from :ref:`playback_speed_scale`. @@ -304,7 +304,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_bus** **(** :ref:`int` at_position=-1 **)** +|void| **add_bus**\ (\ at_position\: :ref:`int` = -1\ ) Adds a bus at ``at_position``. @@ -316,7 +316,7 @@ Adds a bus at ``at_position``. .. rst-class:: classref-method -void **add_bus_effect** **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_position=-1 **)** +|void| **add_bus_effect**\ (\ bus_idx\: :ref:`int`, effect\: :ref:`AudioEffect`, at_position\: :ref:`int` = -1\ ) Adds an :ref:`AudioEffect` effect to the bus ``bus_idx`` at ``at_position``. @@ -328,7 +328,7 @@ Adds an :ref:`AudioEffect` effect to the bus ``bus_idx`` at ` .. rst-class:: classref-method -:ref:`AudioBusLayout` **generate_bus_layout** **(** **)** |const| +:ref:`AudioBusLayout` **generate_bus_layout**\ (\ ) |const| Generates an :ref:`AudioBusLayout` using the available buses and effects. @@ -340,7 +340,7 @@ Generates an :ref:`AudioBusLayout` using the available bus .. rst-class:: classref-method -:ref:`int` **get_bus_channels** **(** :ref:`int` bus_idx **)** |const| +:ref:`int` **get_bus_channels**\ (\ bus_idx\: :ref:`int`\ ) |const| Returns the number of channels of the bus at index ``bus_idx``. @@ -352,7 +352,7 @@ Returns the number of channels of the bus at index ``bus_idx``. .. rst-class:: classref-method -:ref:`AudioEffect` **get_bus_effect** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** +:ref:`AudioEffect` **get_bus_effect**\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`\ ) Returns the :ref:`AudioEffect` at position ``effect_idx`` in bus ``bus_idx``. @@ -364,7 +364,7 @@ Returns the :ref:`AudioEffect` at position ``effect_idx`` in .. rst-class:: classref-method -:ref:`int` **get_bus_effect_count** **(** :ref:`int` bus_idx **)** +:ref:`int` **get_bus_effect_count**\ (\ bus_idx\: :ref:`int`\ ) Returns the number of effects on the bus at ``bus_idx``. @@ -376,7 +376,7 @@ Returns the number of effects on the bus at ``bus_idx``. .. rst-class:: classref-method -:ref:`AudioEffectInstance` **get_bus_effect_instance** **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` channel=0 **)** +:ref:`AudioEffectInstance` **get_bus_effect_instance**\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`, channel\: :ref:`int` = 0\ ) Returns the :ref:`AudioEffectInstance` assigned to the given bus and effect indices (and optionally channel). @@ -388,7 +388,7 @@ Returns the :ref:`AudioEffectInstance` assigned to th .. rst-class:: classref-method -:ref:`int` **get_bus_index** **(** :ref:`StringName` bus_name **)** |const| +:ref:`int` **get_bus_index**\ (\ bus_name\: :ref:`StringName`\ ) |const| Returns the index of the bus with the name ``bus_name``. Returns ``-1`` if no bus with the specified name exist. @@ -400,7 +400,7 @@ Returns the index of the bus with the name ``bus_name``. Returns ``-1`` if no bu .. rst-class:: classref-method -:ref:`String` **get_bus_name** **(** :ref:`int` bus_idx **)** |const| +:ref:`String` **get_bus_name**\ (\ bus_idx\: :ref:`int`\ ) |const| Returns the name of the bus with the index ``bus_idx``. @@ -412,7 +412,7 @@ Returns the name of the bus with the index ``bus_idx``. .. rst-class:: classref-method -:ref:`float` **get_bus_peak_volume_left_db** **(** :ref:`int` bus_idx, :ref:`int` channel **)** |const| +:ref:`float` **get_bus_peak_volume_left_db**\ (\ bus_idx\: :ref:`int`, channel\: :ref:`int`\ ) |const| Returns the peak volume of the left speaker at bus index ``bus_idx`` and channel index ``channel``. @@ -424,7 +424,7 @@ Returns the peak volume of the left speaker at bus index ``bus_idx`` and channel .. rst-class:: classref-method -:ref:`float` **get_bus_peak_volume_right_db** **(** :ref:`int` bus_idx, :ref:`int` channel **)** |const| +:ref:`float` **get_bus_peak_volume_right_db**\ (\ bus_idx\: :ref:`int`, channel\: :ref:`int`\ ) |const| Returns the peak volume of the right speaker at bus index ``bus_idx`` and channel index ``channel``. @@ -436,7 +436,7 @@ Returns the peak volume of the right speaker at bus index ``bus_idx`` and channe .. rst-class:: classref-method -:ref:`StringName` **get_bus_send** **(** :ref:`int` bus_idx **)** |const| +:ref:`StringName` **get_bus_send**\ (\ bus_idx\: :ref:`int`\ ) |const| Returns the name of the bus that the bus at index ``bus_idx`` sends to. @@ -448,7 +448,7 @@ Returns the name of the bus that the bus at index ``bus_idx`` sends to. .. rst-class:: classref-method -:ref:`float` **get_bus_volume_db** **(** :ref:`int` bus_idx **)** |const| +:ref:`float` **get_bus_volume_db**\ (\ bus_idx\: :ref:`int`\ ) |const| Returns the volume of the bus at index ``bus_idx`` in dB. @@ -460,7 +460,7 @@ Returns the volume of the bus at index ``bus_idx`` in dB. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_input_device_list** **(** **)** +:ref:`PackedStringArray` **get_input_device_list**\ (\ ) Returns the names of all audio input devices detected on the system. @@ -474,7 +474,7 @@ Returns the names of all audio input devices detected on the system. .. rst-class:: classref-method -:ref:`float` **get_mix_rate** **(** **)** |const| +:ref:`float` **get_mix_rate**\ (\ ) |const| Returns the sample rate at the output of the **AudioServer**. @@ -486,7 +486,7 @@ Returns the sample rate at the output of the **AudioServer**. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_output_device_list** **(** **)** +:ref:`PackedStringArray` **get_output_device_list**\ (\ ) Returns the names of all audio output devices detected on the system. @@ -498,7 +498,7 @@ Returns the names of all audio output devices detected on the system. .. rst-class:: classref-method -:ref:`float` **get_output_latency** **(** **)** |const| +:ref:`float` **get_output_latency**\ (\ ) |const| Returns the audio driver's effective output latency. This is based on :ref:`ProjectSettings.audio/driver/output_latency`, but the exact returned value will differ depending on the operating system and audio driver. @@ -512,7 +512,7 @@ Returns the audio driver's effective output latency. This is based on :ref:`Proj .. rst-class:: classref-method -:ref:`SpeakerMode` **get_speaker_mode** **(** **)** |const| +:ref:`SpeakerMode` **get_speaker_mode**\ (\ ) |const| Returns the speaker configuration. @@ -524,7 +524,7 @@ Returns the speaker configuration. .. rst-class:: classref-method -:ref:`float` **get_time_since_last_mix** **(** **)** |const| +:ref:`float` **get_time_since_last_mix**\ (\ ) |const| Returns the relative time since the last mix occurred. @@ -536,7 +536,7 @@ Returns the relative time since the last mix occurred. .. rst-class:: classref-method -:ref:`float` **get_time_to_next_mix** **(** **)** |const| +:ref:`float` **get_time_to_next_mix**\ (\ ) |const| Returns the relative time until the next mix occurs. @@ -548,7 +548,7 @@ Returns the relative time until the next mix occurs. .. rst-class:: classref-method -:ref:`bool` **is_bus_bypassing_effects** **(** :ref:`int` bus_idx **)** |const| +:ref:`bool` **is_bus_bypassing_effects**\ (\ bus_idx\: :ref:`int`\ ) |const| If ``true``, the bus at index ``bus_idx`` is bypassing effects. @@ -560,7 +560,7 @@ If ``true``, the bus at index ``bus_idx`` is bypassing effects. .. rst-class:: classref-method -:ref:`bool` **is_bus_effect_enabled** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** |const| +:ref:`bool` **is_bus_effect_enabled**\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`\ ) |const| If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled. @@ -572,7 +572,7 @@ If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` .. rst-class:: classref-method -:ref:`bool` **is_bus_mute** **(** :ref:`int` bus_idx **)** |const| +:ref:`bool` **is_bus_mute**\ (\ bus_idx\: :ref:`int`\ ) |const| If ``true``, the bus at index ``bus_idx`` is muted. @@ -584,7 +584,7 @@ If ``true``, the bus at index ``bus_idx`` is muted. .. rst-class:: classref-method -:ref:`bool` **is_bus_solo** **(** :ref:`int` bus_idx **)** |const| +:ref:`bool` **is_bus_solo**\ (\ bus_idx\: :ref:`int`\ ) |const| If ``true``, the bus at index ``bus_idx`` is in solo mode. @@ -596,7 +596,7 @@ If ``true``, the bus at index ``bus_idx`` is in solo mode. .. rst-class:: classref-method -void **lock** **(** **)** +|void| **lock**\ (\ ) Locks the audio driver's main loop. @@ -610,7 +610,7 @@ Locks the audio driver's main loop. .. rst-class:: classref-method -void **move_bus** **(** :ref:`int` index, :ref:`int` to_index **)** +|void| **move_bus**\ (\ index\: :ref:`int`, to_index\: :ref:`int`\ ) Moves the bus from index ``index`` to index ``to_index``. @@ -622,7 +622,7 @@ Moves the bus from index ``index`` to index ``to_index``. .. rst-class:: classref-method -void **remove_bus** **(** :ref:`int` index **)** +|void| **remove_bus**\ (\ index\: :ref:`int`\ ) Removes the bus at index ``index``. @@ -634,7 +634,7 @@ Removes the bus at index ``index``. .. rst-class:: classref-method -void **remove_bus_effect** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** +|void| **remove_bus_effect**\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`\ ) Removes the effect at index ``effect_idx`` from the bus at index ``bus_idx``. @@ -646,7 +646,7 @@ Removes the effect at index ``effect_idx`` from the bus at index ``bus_idx``. .. rst-class:: classref-method -void **set_bus_bypass_effects** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** +|void| **set_bus_bypass_effects**\ (\ bus_idx\: :ref:`int`, enable\: :ref:`bool`\ ) If ``true``, the bus at index ``bus_idx`` is bypassing effects. @@ -658,7 +658,7 @@ If ``true``, the bus at index ``bus_idx`` is bypassing effects. .. rst-class:: classref-method -void **set_bus_effect_enabled** **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`bool` enabled **)** +|void| **set_bus_effect_enabled**\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`, enabled\: :ref:`bool`\ ) If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled. @@ -670,7 +670,7 @@ If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` .. rst-class:: classref-method -void **set_bus_layout** **(** :ref:`AudioBusLayout` bus_layout **)** +|void| **set_bus_layout**\ (\ bus_layout\: :ref:`AudioBusLayout`\ ) Overwrites the currently used :ref:`AudioBusLayout`. @@ -682,7 +682,7 @@ Overwrites the currently used :ref:`AudioBusLayout`. .. rst-class:: classref-method -void **set_bus_mute** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** +|void| **set_bus_mute**\ (\ bus_idx\: :ref:`int`, enable\: :ref:`bool`\ ) If ``true``, the bus at index ``bus_idx`` is muted. @@ -694,7 +694,7 @@ If ``true``, the bus at index ``bus_idx`` is muted. .. rst-class:: classref-method -void **set_bus_name** **(** :ref:`int` bus_idx, :ref:`String` name **)** +|void| **set_bus_name**\ (\ bus_idx\: :ref:`int`, name\: :ref:`String`\ ) Sets the name of the bus at index ``bus_idx`` to ``name``. @@ -706,7 +706,7 @@ Sets the name of the bus at index ``bus_idx`` to ``name``. .. rst-class:: classref-method -void **set_bus_send** **(** :ref:`int` bus_idx, :ref:`StringName` send **)** +|void| **set_bus_send**\ (\ bus_idx\: :ref:`int`, send\: :ref:`StringName`\ ) Connects the output of the bus at ``bus_idx`` to the bus named ``send``. @@ -718,7 +718,7 @@ Connects the output of the bus at ``bus_idx`` to the bus named ``send``. .. rst-class:: classref-method -void **set_bus_solo** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** +|void| **set_bus_solo**\ (\ bus_idx\: :ref:`int`, enable\: :ref:`bool`\ ) If ``true``, the bus at index ``bus_idx`` is in solo mode. @@ -730,7 +730,7 @@ If ``true``, the bus at index ``bus_idx`` is in solo mode. .. rst-class:: classref-method -void **set_bus_volume_db** **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** +|void| **set_bus_volume_db**\ (\ bus_idx\: :ref:`int`, volume_db\: :ref:`float`\ ) Sets the volume of the bus at index ``bus_idx`` to ``volume_db``. @@ -742,7 +742,7 @@ Sets the volume of the bus at index ``bus_idx`` to ``volume_db``. .. rst-class:: classref-method -void **set_enable_tagging_used_audio_streams** **(** :ref:`bool` enable **)** +|void| **set_enable_tagging_used_audio_streams**\ (\ enable\: :ref:`bool`\ ) If set to ``true``, all instances of :ref:`AudioStreamPlayback` will call :ref:`AudioStreamPlayback._tag_used_streams` every mix step. @@ -756,7 +756,7 @@ If set to ``true``, all instances of :ref:`AudioStreamPlayback` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** +|void| **swap_bus_effects**\ (\ bus_idx\: :ref:`int`, effect_idx\: :ref:`int`, by_effect_idx\: :ref:`int`\ ) Swaps the position of two effects in bus ``bus_idx``. @@ -768,7 +768,7 @@ Swaps the position of two effects in bus ``bus_idx``. .. rst-class:: classref-method -void **unlock** **(** **)** +|void| **unlock**\ (\ ) Unlocks the audio driver's main loop. (After locking it, you should always unlock it.) @@ -779,3 +779,4 @@ Unlocks the audio driver's main loop. (After locking it, you should always unloc .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index dab39e11831..5f2ed4b47c6 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -44,27 +44,27 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_beat_count` **(** **)** |virtual| |const| | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_bpm` **(** **)** |virtual| |const| | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_length` **(** **)** |virtual| |const| | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`_get_parameter_list` **(** **)** |virtual| |const| | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_stream_name` **(** **)** |virtual| |const| | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStreamPlayback` | :ref:`_instantiate_playback` **(** **)** |virtual| |const| | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_monophonic` **(** **)** |virtual| |const| | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_length` **(** **)** |const| | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStreamPlayback` | :ref:`instantiate_playback` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_monophonic` **(** **)** |const| | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_beat_count`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_bpm`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_length`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_parameter_list`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_stream_name`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamPlayback` | :ref:`_instantiate_playback`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_monophonic`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_length`\ (\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamPlayback` | :ref:`instantiate_playback`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_monophonic`\ (\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -79,7 +79,7 @@ Signals .. rst-class:: classref-signal -**parameter_list_changed** **(** **)** +**parameter_list_changed**\ (\ ) Signal to be emitted to notify when the parameter list changed. @@ -96,7 +96,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_beat_count** **(** **)** |virtual| |const| +:ref:`int` **_get_beat_count**\ (\ ) |virtual| |const| Overridable method. Should return the total number of beats of this audio stream. Used by the engine to determine the position of every beat. @@ -110,7 +110,7 @@ Ideally, the returned value should be based off the stream's sample rate (:ref:` .. rst-class:: classref-method -:ref:`float` **_get_bpm** **(** **)** |virtual| |const| +:ref:`float` **_get_bpm**\ (\ ) |virtual| |const| 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. @@ -124,7 +124,7 @@ Ideally, the returned value should be based off the stream's sample rate (:ref:` .. rst-class:: classref-method -:ref:`float` **_get_length** **(** **)** |virtual| |const| +:ref:`float` **_get_length**\ (\ ) |virtual| |const| Override this method to customize the returned value of :ref:`get_length`. Should return the length of this audio stream, in seconds. @@ -136,7 +136,7 @@ Override this method to customize the returned value of :ref:`get_length` **_get_parameter_list** **(** **)** |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_parameter_list**\ (\ ) |virtual| |const| Return the controllable parameters of this stream. This array contains dictionaries with a property info description format (see :ref:`Object.get_property_list`). Additionally, the default value for this parameter must be added tho each dictionary in "default_value" field. @@ -148,7 +148,7 @@ Return the controllable parameters of this stream. This array contains dictionar .. rst-class:: classref-method -:ref:`String` **_get_stream_name** **(** **)** |virtual| |const| +:ref:`String` **_get_stream_name**\ (\ ) |virtual| |const| Override this method to customize the name assigned to this audio stream. Unused by the engine. @@ -160,7 +160,7 @@ Override this method to customize the name assigned to this audio stream. Unused .. rst-class:: classref-method -:ref:`AudioStreamPlayback` **_instantiate_playback** **(** **)** |virtual| |const| +:ref:`AudioStreamPlayback` **_instantiate_playback**\ (\ ) |virtual| |const| 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`).. @@ -172,7 +172,7 @@ Override this method to customize the returned value of :ref:`instantiate_playba .. rst-class:: classref-method -:ref:`bool` **_is_monophonic** **(** **)** |virtual| |const| +:ref:`bool` **_is_monophonic**\ (\ ) |virtual| |const| Override this method to customize the returned value of :ref:`is_monophonic`. Should return ``true`` if this audio stream only supports one channel. @@ -184,7 +184,7 @@ Override this method to customize the returned value of :ref:`is_monophonic` **get_length** **(** **)** |const| +:ref:`float` **get_length**\ (\ ) |const| Returns the length of the audio stream in seconds. @@ -196,7 +196,7 @@ Returns the length of the audio stream in seconds. .. rst-class:: classref-method -:ref:`AudioStreamPlayback` **instantiate_playback** **(** **)** +:ref:`AudioStreamPlayback` **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``. @@ -208,7 +208,7 @@ Returns a newly created :ref:`AudioStreamPlayback` in .. rst-class:: classref-method -:ref:`bool` **is_monophonic** **(** **)** |const| +:ref:`bool` **is_monophonic**\ (\ ) |const| Returns ``true`` if this audio stream only supports one channel (*monophony*), or ``false`` if the audio stream supports two or more channels (*polyphony*). @@ -219,3 +219,4 @@ Returns ``true`` if this audio stream only supports one channel (*monophony*), o .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreamgenerator.rst b/classes/class_audiostreamgenerator.rst index 50fd87c893e..813a9764038 100644 --- a/classes/class_audiostreamgenerator.rst +++ b/classes/class_audiostreamgenerator.rst @@ -124,8 +124,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_buffer_length** **(** :ref:`float` value **)** -- :ref:`float` **get_buffer_length** **(** **)** +- |void| **set_buffer_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_buffer_length**\ (\ ) The length of the buffer to generate (in seconds). Lower values result in less latency, but require the script to generate audio data faster, resulting in increased CPU usage and more risk for audio cracking if the CPU can't keep up. @@ -141,8 +141,8 @@ The length of the buffer to generate (in seconds). Lower values result in less l .. rst-class:: classref-property-setget -- void **set_mix_rate** **(** :ref:`float` value **)** -- :ref:`float` **get_mix_rate** **(** **)** +- |void| **set_mix_rate**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_mix_rate**\ (\ ) The sample rate to use (in Hz). Higher values are more demanding for the CPU to generate, but result in better quality. @@ -157,3 +157,4 @@ According to the `Nyquist-Shannon sampling theorem ` | :ref:`can_push_buffer` **(** :ref:`int` amount **)** |const| | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_buffer` **(** **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_frames_available` **(** **)** |const| | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_skips` **(** **)** |const| | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_buffer` **(** :ref:`PackedVector2Array` frames **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_frame` **(** :ref:`Vector2` frame **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`can_push_buffer`\ (\ amount\: :ref:`int`\ ) |const| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_buffer`\ (\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_frames_available`\ (\ ) |const| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_skips`\ (\ ) |const| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_buffer`\ (\ frames\: :ref:`PackedVector2Array`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_frame`\ (\ frame\: :ref:`Vector2`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -65,7 +65,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **can_push_buffer** **(** :ref:`int` amount **)** |const| +:ref:`bool` **can_push_buffer**\ (\ amount\: :ref:`int`\ ) |const| Returns ``true`` if a buffer of the size ``amount`` can be pushed to the audio sample data buffer without overflowing it, ``false`` otherwise. @@ -77,7 +77,7 @@ Returns ``true`` if a buffer of the size ``amount`` can be pushed to the audio s .. rst-class:: classref-method -void **clear_buffer** **(** **)** +|void| **clear_buffer**\ (\ ) Clears the audio sample data buffer. @@ -89,7 +89,7 @@ Clears the audio sample data buffer. .. rst-class:: classref-method -:ref:`int` **get_frames_available** **(** **)** |const| +:ref:`int` **get_frames_available**\ (\ ) |const| Returns the number of frames that can be pushed to the audio sample data buffer without overflowing it. If the result is ``0``, the buffer is full. @@ -101,7 +101,7 @@ Returns the number of frames that can be pushed to the audio sample data buffer .. rst-class:: classref-method -:ref:`int` **get_skips** **(** **)** |const| +:ref:`int` **get_skips**\ (\ ) |const| Returns the number of times the playback skipped due to a buffer underrun in the audio sample data. This value is reset at the start of the playback. @@ -113,7 +113,7 @@ Returns the number of times the playback skipped due to a buffer underrun in the .. rst-class:: classref-method -:ref:`bool` **push_buffer** **(** :ref:`PackedVector2Array` frames **)** +:ref:`bool` **push_buffer**\ (\ frames\: :ref:`PackedVector2Array`\ ) Pushes several audio data frames to the buffer. This is usually more efficient than :ref:`push_frame` in C# and compiled languages via GDExtension, but :ref:`push_buffer` may be *less* efficient in GDScript. @@ -125,7 +125,7 @@ Pushes several audio data frames to the buffer. This is usually more efficient t .. rst-class:: classref-method -:ref:`bool` **push_frame** **(** :ref:`Vector2` frame **)** +:ref:`bool` **push_frame**\ (\ frame\: :ref:`Vector2`\ ) Pushes a single audio data frame to the buffer. This is usually less efficient than :ref:`push_buffer` in C# and compiled languages via GDExtension, but :ref:`push_frame` may be *more* efficient in GDScript. @@ -136,3 +136,4 @@ Pushes a single audio data frame to the buffer. This is usually less efficient t .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreammicrophone.rst b/classes/class_audiostreammicrophone.rst index 229d43b4db8..c90316ec693 100644 --- a/classes/class_audiostreammicrophone.rst +++ b/classes/class_audiostreammicrophone.rst @@ -39,3 +39,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreammp3.rst b/classes/class_audiostreammp3.rst index a44449ee97b..ee031252d79 100644 --- a/classes/class_audiostreammp3.rst +++ b/classes/class_audiostreammp3.rst @@ -60,8 +60,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bar_beats** **(** :ref:`int` value **)** -- :ref:`int` **get_bar_beats** **(** **)** +- |void| **set_bar_beats**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_bar_beats**\ (\ ) .. container:: contribute @@ -79,8 +79,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_beat_count** **(** :ref:`int` value **)** -- :ref:`int` **get_beat_count** **(** **)** +- |void| **set_beat_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_beat_count**\ (\ ) .. container:: contribute @@ -98,8 +98,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bpm** **(** :ref:`float` value **)** -- :ref:`float` **get_bpm** **(** **)** +- |void| **set_bpm**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_bpm**\ (\ ) .. container:: contribute @@ -117,8 +117,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_data** **(** :ref:`PackedByteArray` value **)** -- :ref:`PackedByteArray` **get_data** **(** **)** +- |void| **set_data**\ (\ value\: :ref:`PackedByteArray`\ ) +- :ref:`PackedByteArray` **get_data**\ (\ ) Contains the audio data in bytes. @@ -159,8 +159,8 @@ You can load a file without having to import it beforehand using the code snippe .. rst-class:: classref-property-setget -- void **set_loop** **(** :ref:`bool` value **)** -- :ref:`bool` **has_loop** **(** **)** +- |void| **set_loop**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **has_loop**\ (\ ) If ``true``, the stream will automatically loop when it reaches the end. @@ -176,8 +176,8 @@ If ``true``, the stream will automatically loop when it reaches the end. .. rst-class:: classref-property-setget -- void **set_loop_offset** **(** :ref:`float` value **)** -- :ref:`float` **get_loop_offset** **(** **)** +- |void| **set_loop_offset**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_loop_offset**\ (\ ) Time in seconds at which the stream starts after being looped. @@ -188,3 +188,4 @@ Time in seconds at which the stream starts after being looped. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index a8ddb0a83fb..08ae8ab23a1 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -58,11 +58,11 @@ Methods .. table:: :widths: auto - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStreamOggVorbis` | :ref:`load_from_buffer` **(** :ref:`PackedByteArray` buffer **)** |static| | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStreamOggVorbis` | :ref:`load_from_file` **(** :ref:`String` path **)** |static| | - +---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamOggVorbis` | :ref:`load_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) |static| | + +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamOggVorbis` | :ref:`load_from_file`\ (\ path\: :ref:`String`\ ) |static| | + +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -81,8 +81,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bar_beats** **(** :ref:`int` value **)** -- :ref:`int` **get_bar_beats** **(** **)** +- |void| **set_bar_beats**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_bar_beats**\ (\ ) .. container:: contribute @@ -100,8 +100,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_beat_count** **(** :ref:`int` value **)** -- :ref:`int` **get_beat_count** **(** **)** +- |void| **set_beat_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_beat_count**\ (\ ) .. container:: contribute @@ -119,8 +119,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bpm** **(** :ref:`float` value **)** -- :ref:`float` **get_bpm** **(** **)** +- |void| **set_bpm**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_bpm**\ (\ ) .. container:: contribute @@ -138,8 +138,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_loop** **(** :ref:`bool` value **)** -- :ref:`bool` **has_loop** **(** **)** +- |void| **set_loop**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **has_loop**\ (\ ) If ``true``, the audio will play again from the specified :ref:`loop_offset` once it is done playing. Useful for ambient sounds and background music. @@ -155,8 +155,8 @@ If ``true``, the audio will play again from the specified :ref:`loop_offset` value **)** -- :ref:`float` **get_loop_offset** **(** **)** +- |void| **set_loop_offset**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_loop_offset**\ (\ ) Time in seconds at which the stream starts after being looped. @@ -172,8 +172,8 @@ Time in seconds at which the stream starts after being looped. .. rst-class:: classref-property-setget -- void **set_packet_sequence** **(** :ref:`OggPacketSequence` value **)** -- :ref:`OggPacketSequence` **get_packet_sequence** **(** **)** +- |void| **set_packet_sequence**\ (\ value\: :ref:`OggPacketSequence`\ ) +- :ref:`OggPacketSequence` **get_packet_sequence**\ (\ ) Contains the raw Ogg data for this stream. @@ -190,7 +190,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AudioStreamOggVorbis` **load_from_buffer** **(** :ref:`PackedByteArray` buffer **)** |static| +:ref:`AudioStreamOggVorbis` **load_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) |static| Creates a new AudioStreamOggVorbis instance from the given buffer. The buffer must contain Ogg Vorbis data. @@ -202,7 +202,7 @@ Creates a new AudioStreamOggVorbis instance from the given buffer. The buffer mu .. rst-class:: classref-method -:ref:`AudioStreamOggVorbis` **load_from_file** **(** :ref:`String` path **)** |static| +:ref:`AudioStreamOggVorbis` **load_from_file**\ (\ path\: :ref:`String`\ ) |static| Creates a new AudioStreamOggVorbis instance from the given file path. The file must be in Ogg Vorbis format. @@ -213,3 +213,4 @@ Creates a new AudioStreamOggVorbis instance from the given file path. The file m .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreamplayback.rst b/classes/class_audiostreamplayback.rst index faf2f31dc59..ebde6a874bd 100644 --- a/classes/class_audiostreamplayback.rst +++ b/classes/class_audiostreamplayback.rst @@ -38,27 +38,27 @@ Methods .. table:: :widths: auto - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_loop_count` **(** **)** |virtual| |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_parameter` **(** :ref:`StringName` name **)** |virtual| |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_playback_position` **(** **)** |virtual| |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_playing` **(** **)** |virtual| |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_mix` **(** AudioFrame* buffer, :ref:`float` rate_scale, :ref:`int` frames **)** |virtual| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_seek` **(** :ref:`float` position **)** |virtual| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_parameter` **(** :ref:`StringName` name, :ref:`Variant` value **)** |virtual| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_start` **(** :ref:`float` from_pos **)** |virtual| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_stop` **(** **)** |virtual| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_tag_used_streams` **(** **)** |virtual| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_loop_count`\ (\ ) |virtual| |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_parameter`\ (\ name\: :ref:`StringName`\ ) |virtual| |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_playback_position`\ (\ ) |virtual| |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_playing`\ (\ ) |virtual| |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_mix`\ (\ buffer\: ``AudioFrame*``, rate_scale\: :ref:`float`, frames\: :ref:`int`\ ) |virtual| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_seek`\ (\ position\: :ref:`float`\ ) |virtual| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_parameter`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_start`\ (\ from_pos\: :ref:`float`\ ) |virtual| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_stop`\ (\ ) |virtual| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_tag_used_streams`\ (\ ) |virtual| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -73,7 +73,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_loop_count** **(** **)** |virtual| |const| +:ref:`int` **_get_loop_count**\ (\ ) |virtual| |const| Overridable method. Should return how many times this audio stream has looped. Most built-in playbacks always return ``0``. @@ -85,7 +85,7 @@ Overridable method. Should return how many times this audio stream has looped. M .. rst-class:: classref-method -:ref:`Variant` **_get_parameter** **(** :ref:`StringName` name **)** |virtual| |const| +:ref:`Variant` **_get_parameter**\ (\ name\: :ref:`StringName`\ ) |virtual| |const| Return the current value of a playback parameter by name (see :ref:`AudioStream._get_parameter_list`). @@ -97,7 +97,7 @@ Return the current value of a playback parameter by name (see :ref:`AudioStream. .. rst-class:: classref-method -:ref:`float` **_get_playback_position** **(** **)** |virtual| |const| +:ref:`float` **_get_playback_position**\ (\ ) |virtual| |const| Overridable method. Should return the current progress along the audio stream, in seconds. @@ -109,7 +109,7 @@ Overridable method. Should return the current progress along the audio stream, i .. rst-class:: classref-method -:ref:`bool` **_is_playing** **(** **)** |virtual| |const| +:ref:`bool` **_is_playing**\ (\ ) |virtual| |const| Overridable method. Should return ``true`` if this playback is active and playing its audio stream. @@ -121,7 +121,7 @@ Overridable method. Should return ``true`` if this playback is active and playin .. rst-class:: classref-method -:ref:`int` **_mix** **(** AudioFrame* buffer, :ref:`float` rate_scale, :ref:`int` frames **)** |virtual| +:ref:`int` **_mix**\ (\ buffer\: ``AudioFrame*``, rate_scale\: :ref:`float`, frames\: :ref:`int`\ ) |virtual| Override this method to customize how the audio stream is mixed. This method is called even if the playback is not active. @@ -135,7 +135,7 @@ Override this method to customize how the audio stream is mixed. This method is .. rst-class:: classref-method -void **_seek** **(** :ref:`float` position **)** |virtual| +|void| **_seek**\ (\ position\: :ref:`float`\ ) |virtual| Override this method to customize what happens when seeking this audio stream at the given ``position``, such as by calling :ref:`AudioStreamPlayer.seek`. @@ -147,7 +147,7 @@ Override this method to customize what happens when seeking this audio stream at .. rst-class:: classref-method -void **_set_parameter** **(** :ref:`StringName` name, :ref:`Variant` value **)** |virtual| +|void| **_set_parameter**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| Set the current value of a playback parameter by name (see :ref:`AudioStream._get_parameter_list`). @@ -159,7 +159,7 @@ Set the current value of a playback parameter by name (see :ref:`AudioStream._ge .. rst-class:: classref-method -void **_start** **(** :ref:`float` from_pos **)** |virtual| +|void| **_start**\ (\ from_pos\: :ref:`float`\ ) |virtual| Override this method to customize what happens when the playback starts at the given position, such as by calling :ref:`AudioStreamPlayer.play`. @@ -171,7 +171,7 @@ Override this method to customize what happens when the playback starts at the g .. rst-class:: classref-method -void **_stop** **(** **)** |virtual| +|void| **_stop**\ (\ ) |virtual| Override this method to customize what happens when the playback is stopped, such as by calling :ref:`AudioStreamPlayer.stop`. @@ -183,7 +183,7 @@ Override this method to customize what happens when the playback is stopped, suc .. rst-class:: classref-method -void **_tag_used_streams** **(** **)** |virtual| +|void| **_tag_used_streams**\ (\ ) |virtual| 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. @@ -194,3 +194,4 @@ Overridable method. Called whenever the audio stream is mixed if the playback is .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreamplaybackoggvorbis.rst b/classes/class_audiostreamplaybackoggvorbis.rst index 173b7775fd7..dc0f2c757a3 100644 --- a/classes/class_audiostreamplaybackoggvorbis.rst +++ b/classes/class_audiostreamplaybackoggvorbis.rst @@ -23,3 +23,4 @@ AudioStreamPlaybackOggVorbis .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreamplaybackpolyphonic.rst b/classes/class_audiostreamplaybackpolyphonic.rst index 9f464c00677..293103460a2 100644 --- a/classes/class_audiostreamplaybackpolyphonic.rst +++ b/classes/class_audiostreamplaybackpolyphonic.rst @@ -29,17 +29,17 @@ Methods .. table:: :widths: auto - +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_stream_playing` **(** :ref:`int` stream **)** |const| | - +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`play_stream` **(** :ref:`AudioStream` stream, :ref:`float` from_offset=0, :ref:`float` volume_db=0, :ref:`float` pitch_scale=1.0 **)** | - +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_stream_pitch_scale` **(** :ref:`int` stream, :ref:`float` pitch_scale **)** | - +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_stream_volume` **(** :ref:`int` stream, :ref:`float` volume_db **)** | - +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`stop_stream` **(** :ref:`int` stream **)** | - +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_stream_playing`\ (\ stream\: :ref:`int`\ ) |const| | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`play_stream`\ (\ stream\: :ref:`AudioStream`, from_offset\: :ref:`float` = 0, volume_db\: :ref:`float` = 0, pitch_scale\: :ref:`float` = 1.0\ ) | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stream_pitch_scale`\ (\ stream\: :ref:`int`, pitch_scale\: :ref:`float`\ ) | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stream_volume`\ (\ stream\: :ref:`int`, volume_db\: :ref:`float`\ ) | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop_stream`\ (\ stream\: :ref:`int`\ ) | + +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -71,7 +71,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_stream_playing** **(** :ref:`int` stream **)** |const| +:ref:`bool` **is_stream_playing**\ (\ stream\: :ref:`int`\ ) |const| Return true whether the stream associated with an integer ID is still playing. Check :ref:`play_stream` for information on when this ID becomes invalid. @@ -83,7 +83,7 @@ Return true whether the stream associated with an integer ID is still playing. C .. rst-class:: classref-method -:ref:`int` **play_stream** **(** :ref:`AudioStream` stream, :ref:`float` from_offset=0, :ref:`float` volume_db=0, :ref:`float` pitch_scale=1.0 **)** +:ref:`int` **play_stream**\ (\ stream\: :ref:`AudioStream`, from_offset\: :ref:`float` = 0, volume_db\: :ref:`float` = 0, pitch_scale\: :ref:`float` = 1.0\ ) Play an :ref:`AudioStream` at a given offset, volume and pitch scale. Playback starts immediately. @@ -101,7 +101,7 @@ This function returns :ref:`INVALID_ID` stream, :ref:`float` pitch_scale **)** +|void| **set_stream_pitch_scale**\ (\ stream\: :ref:`int`, pitch_scale\: :ref:`float`\ ) Change the stream pitch scale. The ``stream`` argument is an integer ID returned by :ref:`play_stream`. @@ -113,7 +113,7 @@ Change the stream pitch scale. The ``stream`` argument is an integer ID returned .. rst-class:: classref-method -void **set_stream_volume** **(** :ref:`int` stream, :ref:`float` volume_db **)** +|void| **set_stream_volume**\ (\ stream\: :ref:`int`, volume_db\: :ref:`float`\ ) Change the stream volume (in db). The ``stream`` argument is an integer ID returned by :ref:`play_stream`. @@ -125,7 +125,7 @@ Change the stream volume (in db). The ``stream`` argument is an integer ID retur .. rst-class:: classref-method -void **stop_stream** **(** :ref:`int` stream **)** +|void| **stop_stream**\ (\ stream\: :ref:`int`\ ) Stop a stream. The ``stream`` argument is an integer ID returned by :ref:`play_stream`, which becomes invalid after calling this function. @@ -136,3 +136,4 @@ Stop a stream. The ``stream`` argument is an integer ID returned by :ref:`play_s .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreamplaybackresampled.rst b/classes/class_audiostreamplaybackresampled.rst index f6c56ec2d4d..82db9bfa954 100644 --- a/classes/class_audiostreamplaybackresampled.rst +++ b/classes/class_audiostreamplaybackresampled.rst @@ -26,13 +26,13 @@ Methods .. table:: :widths: auto - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_stream_sampling_rate` **(** **)** |virtual| |const| | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_mix_resampled` **(** AudioFrame* dst_buffer, :ref:`int` frame_count **)** |virtual| | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`begin_resample` **(** **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_stream_sampling_rate`\ (\ ) |virtual| |const| | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_mix_resampled`\ (\ dst_buffer\: ``AudioFrame*``, frame_count\: :ref:`int`\ ) |virtual| | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`begin_resample`\ (\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -47,7 +47,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **_get_stream_sampling_rate** **(** **)** |virtual| |const| +:ref:`float` **_get_stream_sampling_rate**\ (\ ) |virtual| |const| .. container:: contribute @@ -61,7 +61,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_mix_resampled** **(** AudioFrame* dst_buffer, :ref:`int` frame_count **)** |virtual| +:ref:`int` **_mix_resampled**\ (\ dst_buffer\: ``AudioFrame*``, frame_count\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -75,7 +75,7 @@ Method Descriptions .. rst-class:: classref-method -void **begin_resample** **(** **)** +|void| **begin_resample**\ (\ ) .. container:: contribute @@ -88,3 +88,4 @@ void **begin_resample** **(** **)** .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index 6e42f4b523b..f6c43302ea2 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: sound, music, song + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -76,19 +79,19 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_playback_position` **(** **)** | - +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStreamPlayback` | :ref:`get_stream_playback` **(** **)** | - +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_stream_playback` **(** **)** | - +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ - | void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | - +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ - | void | :ref:`seek` **(** :ref:`float` to_position **)** | - +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ - | void | :ref:`stop` **(** **)** | - +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_playback_position`\ (\ ) | + +-------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamPlayback` | :ref:`get_stream_playback`\ (\ ) | + +-------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_stream_playback`\ (\ ) | + +-------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play`\ (\ from_position\: :ref:`float` = 0.0\ ) | + +-------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`seek`\ (\ to_position\: :ref:`float`\ ) | + +-------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop`\ (\ ) | + +-------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -103,7 +106,7 @@ Signals .. rst-class:: classref-signal -**finished** **(** **)** +**finished**\ (\ ) Emitted when the audio stops playing. @@ -163,8 +166,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_autoplay** **(** :ref:`bool` value **)** -- :ref:`bool` **is_autoplay_enabled** **(** **)** +- |void| **set_autoplay**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_autoplay_enabled**\ (\ ) If ``true``, audio plays when added to scene tree. @@ -180,8 +183,8 @@ If ``true``, audio plays when added to scene tree. .. rst-class:: classref-property-setget -- void **set_bus** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_bus** **(** **)** +- |void| **set_bus**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_bus**\ (\ ) Bus on which this audio is playing. @@ -199,8 +202,8 @@ Bus on which this audio is playing. .. rst-class:: classref-property-setget -- void **set_max_polyphony** **(** :ref:`int` value **)** -- :ref:`int` **get_max_polyphony** **(** **)** +- |void| **set_max_polyphony**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_polyphony**\ (\ ) The maximum number of sounds this node can play at the same time. Playing additional sounds after this value is reached will cut off the oldest sounds. @@ -216,8 +219,8 @@ The maximum number of sounds this node can play at the same time. Playing additi .. rst-class:: classref-property-setget -- void **set_mix_target** **(** :ref:`MixTarget` value **)** -- :ref:`MixTarget` **get_mix_target** **(** **)** +- |void| **set_mix_target**\ (\ value\: :ref:`MixTarget`\ ) +- :ref:`MixTarget` **get_mix_target**\ (\ ) If the audio configuration has more than two speakers, this sets the target channels. See :ref:`MixTarget` constants. @@ -233,8 +236,8 @@ If the audio configuration has more than two speakers, this sets the target chan .. rst-class:: classref-property-setget -- void **set_pitch_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_pitch_scale** **(** **)** +- |void| **set_pitch_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pitch_scale**\ (\ ) The pitch and the tempo of the audio, as a multiplier of the audio sample's sample rate. @@ -250,7 +253,7 @@ The pitch and the tempo of the audio, as a multiplier of the audio sample's samp .. rst-class:: classref-property-setget -- :ref:`bool` **is_playing** **(** **)** +- :ref:`bool` **is_playing**\ (\ ) If ``true``, audio is playing. @@ -266,8 +269,8 @@ If ``true``, audio is playing. .. rst-class:: classref-property-setget -- void **set_stream** **(** :ref:`AudioStream` value **)** -- :ref:`AudioStream` **get_stream** **(** **)** +- |void| **set_stream**\ (\ value\: :ref:`AudioStream`\ ) +- :ref:`AudioStream` **get_stream**\ (\ ) The :ref:`AudioStream` object to be played. @@ -283,8 +286,8 @@ The :ref:`AudioStream` object to be played. .. rst-class:: classref-property-setget -- void **set_stream_paused** **(** :ref:`bool` value **)** -- :ref:`bool` **get_stream_paused** **(** **)** +- |void| **set_stream_paused**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_stream_paused**\ (\ ) If ``true``, the playback is paused. You can resume it by setting :ref:`stream_paused` to ``false``. @@ -300,8 +303,8 @@ If ``true``, the playback is paused. You can resume it by setting :ref:`stream_p .. rst-class:: classref-property-setget -- void **set_volume_db** **(** :ref:`float` value **)** -- :ref:`float` **get_volume_db** **(** **)** +- |void| **set_volume_db**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_volume_db**\ (\ ) Volume of sound, in dB. @@ -318,7 +321,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_playback_position** **(** **)** +:ref:`float` **get_playback_position**\ (\ ) Returns the position in the :ref:`AudioStream` in seconds. @@ -330,7 +333,7 @@ Returns the position in the :ref:`AudioStream` in seconds. .. rst-class:: classref-method -:ref:`AudioStreamPlayback` **get_stream_playback** **(** **)** +:ref:`AudioStreamPlayback` **get_stream_playback**\ (\ ) Returns the :ref:`AudioStreamPlayback` object associated with this **AudioStreamPlayer**. @@ -342,7 +345,7 @@ Returns the :ref:`AudioStreamPlayback` object associa .. rst-class:: classref-method -:ref:`bool` **has_stream_playback** **(** **)** +:ref:`bool` **has_stream_playback**\ (\ ) Returns whether the **AudioStreamPlayer** can return the :ref:`AudioStreamPlayback` object or not. @@ -354,7 +357,7 @@ Returns whether the **AudioStreamPlayer** can return the :ref:`AudioStreamPlayba .. rst-class:: classref-method -void **play** **(** :ref:`float` from_position=0.0 **)** +|void| **play**\ (\ from_position\: :ref:`float` = 0.0\ ) Plays the audio from the given ``from_position``, in seconds. @@ -366,7 +369,7 @@ Plays the audio from the given ``from_position``, in seconds. .. rst-class:: classref-method -void **seek** **(** :ref:`float` to_position **)** +|void| **seek**\ (\ to_position\: :ref:`float`\ ) Sets the position from which audio will be played, in seconds. @@ -378,7 +381,7 @@ Sets the position from which audio will be played, in seconds. .. rst-class:: classref-method -void **stop** **(** **)** +|void| **stop**\ (\ ) Stops the audio. @@ -389,3 +392,4 @@ Stops the audio. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index 3eb1bc99ab2..1a055f6d5f5 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: sound, sfx + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -76,19 +79,19 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_playback_position` **(** **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStreamPlayback` | :ref:`get_stream_playback` **(** **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_stream_playback` **(** **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ - | void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ - | void | :ref:`seek` **(** :ref:`float` to_position **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ - | void | :ref:`stop` **(** **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_playback_position`\ (\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamPlayback` | :ref:`get_stream_playback`\ (\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_stream_playback`\ (\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play`\ (\ from_position\: :ref:`float` = 0.0\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`seek`\ (\ to_position\: :ref:`float`\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop`\ (\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -103,7 +106,7 @@ Signals .. rst-class:: classref-signal -**finished** **(** **)** +**finished**\ (\ ) Emitted when the audio stops playing. @@ -124,8 +127,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_area_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_area_mask** **(** **)** +- |void| **set_area_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_area_mask**\ (\ ) Determines which :ref:`Area2D` layers affect the sound for reverb and audio bus effects. Areas can be used to redirect :ref:`AudioStream`\ s so that they play in a certain audio bus. An example of how you might use this is making a "water" area so that sounds played in the water are redirected through an audio bus to make them sound like they are being played underwater. @@ -141,8 +144,8 @@ Determines which :ref:`Area2D` layers affect the sound for reverb .. rst-class:: classref-property-setget -- void **set_attenuation** **(** :ref:`float` value **)** -- :ref:`float` **get_attenuation** **(** **)** +- |void| **set_attenuation**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_attenuation**\ (\ ) The volume is attenuated over distance with this as an exponent. @@ -158,8 +161,8 @@ The volume is attenuated over distance with this as an exponent. .. rst-class:: classref-property-setget -- void **set_autoplay** **(** :ref:`bool` value **)** -- :ref:`bool` **is_autoplay_enabled** **(** **)** +- |void| **set_autoplay**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_autoplay_enabled**\ (\ ) If ``true``, audio plays when added to scene tree. @@ -175,8 +178,8 @@ If ``true``, audio plays when added to scene tree. .. rst-class:: classref-property-setget -- void **set_bus** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_bus** **(** **)** +- |void| **set_bus**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_bus**\ (\ ) Bus on which this audio is playing. @@ -194,8 +197,8 @@ Bus on which this audio is playing. .. rst-class:: classref-property-setget -- void **set_max_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_max_distance** **(** **)** +- |void| **set_max_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_max_distance**\ (\ ) Maximum distance from which audio is still hearable. @@ -211,8 +214,8 @@ Maximum distance from which audio is still hearable. .. rst-class:: classref-property-setget -- void **set_max_polyphony** **(** :ref:`int` value **)** -- :ref:`int` **get_max_polyphony** **(** **)** +- |void| **set_max_polyphony**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_polyphony**\ (\ ) The maximum number of sounds this node can play at the same time. Playing additional sounds after this value is reached will cut off the oldest sounds. @@ -228,8 +231,8 @@ The maximum number of sounds this node can play at the same time. Playing additi .. rst-class:: classref-property-setget -- void **set_panning_strength** **(** :ref:`float` value **)** -- :ref:`float` **get_panning_strength** **(** **)** +- |void| **set_panning_strength**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_panning_strength**\ (\ ) Scales the panning strength for this node by multiplying the base :ref:`ProjectSettings.audio/general/2d_panning_strength` with this factor. Higher values will pan audio from left to right more dramatically than lower values. @@ -245,8 +248,8 @@ Scales the panning strength for this node by multiplying the base :ref:`ProjectS .. rst-class:: classref-property-setget -- void **set_pitch_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_pitch_scale** **(** **)** +- |void| **set_pitch_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pitch_scale**\ (\ ) The pitch and the tempo of the audio, as a multiplier of the audio sample's sample rate. @@ -262,7 +265,7 @@ The pitch and the tempo of the audio, as a multiplier of the audio sample's samp .. rst-class:: classref-property-setget -- :ref:`bool` **is_playing** **(** **)** +- :ref:`bool` **is_playing**\ (\ ) If ``true``, audio is playing or is queued to be played (see :ref:`play`). @@ -278,8 +281,8 @@ If ``true``, audio is playing or is queued to be played (see :ref:`play` value **)** -- :ref:`AudioStream` **get_stream** **(** **)** +- |void| **set_stream**\ (\ value\: :ref:`AudioStream`\ ) +- :ref:`AudioStream` **get_stream**\ (\ ) The :ref:`AudioStream` object to be played. @@ -295,8 +298,8 @@ The :ref:`AudioStream` object to be played. .. rst-class:: classref-property-setget -- void **set_stream_paused** **(** :ref:`bool` value **)** -- :ref:`bool` **get_stream_paused** **(** **)** +- |void| **set_stream_paused**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_stream_paused**\ (\ ) If ``true``, the playback is paused. You can resume it by setting :ref:`stream_paused` to ``false``. @@ -312,8 +315,8 @@ If ``true``, the playback is paused. You can resume it by setting :ref:`stream_p .. rst-class:: classref-property-setget -- void **set_volume_db** **(** :ref:`float` value **)** -- :ref:`float` **get_volume_db** **(** **)** +- |void| **set_volume_db**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_volume_db**\ (\ ) Base volume before attenuation. @@ -330,7 +333,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_playback_position** **(** **)** +:ref:`float` **get_playback_position**\ (\ ) Returns the position in the :ref:`AudioStream`. @@ -342,7 +345,7 @@ Returns the position in the :ref:`AudioStream`. .. rst-class:: classref-method -:ref:`AudioStreamPlayback` **get_stream_playback** **(** **)** +:ref:`AudioStreamPlayback` **get_stream_playback**\ (\ ) Returns the :ref:`AudioStreamPlayback` object associated with this **AudioStreamPlayer2D**. @@ -354,7 +357,7 @@ Returns the :ref:`AudioStreamPlayback` object associa .. rst-class:: classref-method -:ref:`bool` **has_stream_playback** **(** **)** +:ref:`bool` **has_stream_playback**\ (\ ) Returns whether the :ref:`AudioStreamPlayer` can return the :ref:`AudioStreamPlayback` object or not. @@ -366,7 +369,7 @@ Returns whether the :ref:`AudioStreamPlayer` can return .. rst-class:: classref-method -void **play** **(** :ref:`float` from_position=0.0 **)** +|void| **play**\ (\ from_position\: :ref:`float` = 0.0\ ) Queues the audio to play on the next physics frame, from the given position ``from_position``, in seconds. @@ -378,7 +381,7 @@ Queues the audio to play on the next physics frame, from the given position ``fr .. rst-class:: classref-method -void **seek** **(** :ref:`float` to_position **)** +|void| **seek**\ (\ to_position\: :ref:`float`\ ) Sets the position from which audio will be played, in seconds. @@ -390,7 +393,7 @@ Sets the position from which audio will be played, in seconds. .. rst-class:: classref-method -void **stop** **(** **)** +|void| **stop**\ (\ ) Stops the audio. @@ -401,3 +404,4 @@ Stops the audio. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index 3f886d09e31..be810990ac8 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: sound, sfx + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -92,19 +95,19 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_playback_position` **(** **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStreamPlayback` | :ref:`get_stream_playback` **(** **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_stream_playback` **(** **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ - | void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ - | void | :ref:`seek` **(** :ref:`float` to_position **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ - | void | :ref:`stop` **(** **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_playback_position`\ (\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamPlayback` | :ref:`get_stream_playback`\ (\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_stream_playback`\ (\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play`\ (\ from_position\: :ref:`float` = 0.0\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`seek`\ (\ to_position\: :ref:`float`\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop`\ (\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -119,7 +122,7 @@ Signals .. rst-class:: classref-signal -**finished** **(** **)** +**finished**\ (\ ) Emitted when the audio stops playing. @@ -221,8 +224,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_area_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_area_mask** **(** **)** +- |void| **set_area_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_area_mask**\ (\ ) Determines which :ref:`Area3D` layers affect the sound for reverb and audio bus effects. Areas can be used to redirect :ref:`AudioStream`\ s so that they play in a certain audio bus. An example of how you might use this is making a "water" area so that sounds played in the water are redirected through an audio bus to make them sound like they are being played underwater. @@ -238,8 +241,8 @@ Determines which :ref:`Area3D` layers affect the sound for reverb .. rst-class:: classref-property-setget -- void **set_attenuation_filter_cutoff_hz** **(** :ref:`float` value **)** -- :ref:`float` **get_attenuation_filter_cutoff_hz** **(** **)** +- |void| **set_attenuation_filter_cutoff_hz**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_attenuation_filter_cutoff_hz**\ (\ ) The cutoff frequency of the attenuation low-pass filter, in Hz. A sound above this frequency is attenuated more than a sound below this frequency. To disable this effect, set this to ``20500`` as this frequency is above the human hearing limit. @@ -255,8 +258,8 @@ The cutoff frequency of the attenuation low-pass filter, in Hz. A sound above th .. rst-class:: classref-property-setget -- void **set_attenuation_filter_db** **(** :ref:`float` value **)** -- :ref:`float` **get_attenuation_filter_db** **(** **)** +- |void| **set_attenuation_filter_db**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_attenuation_filter_db**\ (\ ) Amount how much the filter affects the loudness, in decibels. @@ -272,8 +275,8 @@ Amount how much the filter affects the loudness, in decibels. .. rst-class:: classref-property-setget -- void **set_attenuation_model** **(** :ref:`AttenuationModel` value **)** -- :ref:`AttenuationModel` **get_attenuation_model** **(** **)** +- |void| **set_attenuation_model**\ (\ value\: :ref:`AttenuationModel`\ ) +- :ref:`AttenuationModel` **get_attenuation_model**\ (\ ) Decides if audio should get quieter with distance linearly, quadratically, logarithmically, or not be affected by distance, effectively disabling attenuation. @@ -289,8 +292,8 @@ Decides if audio should get quieter with distance linearly, quadratically, logar .. rst-class:: classref-property-setget -- void **set_autoplay** **(** :ref:`bool` value **)** -- :ref:`bool` **is_autoplay_enabled** **(** **)** +- |void| **set_autoplay**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_autoplay_enabled**\ (\ ) If ``true``, audio plays when the AudioStreamPlayer3D node is added to scene tree. @@ -306,8 +309,8 @@ If ``true``, audio plays when the AudioStreamPlayer3D node is added to scene tre .. rst-class:: classref-property-setget -- void **set_bus** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_bus** **(** **)** +- |void| **set_bus**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_bus**\ (\ ) The bus on which this audio is playing. @@ -325,8 +328,8 @@ The bus on which this audio is playing. .. rst-class:: classref-property-setget -- void **set_doppler_tracking** **(** :ref:`DopplerTracking` value **)** -- :ref:`DopplerTracking` **get_doppler_tracking** **(** **)** +- |void| **set_doppler_tracking**\ (\ value\: :ref:`DopplerTracking`\ ) +- :ref:`DopplerTracking` **get_doppler_tracking**\ (\ ) Decides in which step the Doppler effect should be calculated. @@ -342,8 +345,8 @@ Decides in which step the Doppler effect should be calculated. .. rst-class:: classref-property-setget -- void **set_emission_angle** **(** :ref:`float` value **)** -- :ref:`float` **get_emission_angle** **(** **)** +- |void| **set_emission_angle**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_emission_angle**\ (\ ) The angle in which the audio reaches a listener unattenuated. @@ -359,8 +362,8 @@ The angle in which the audio reaches a listener unattenuated. .. rst-class:: classref-property-setget -- void **set_emission_angle_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_emission_angle_enabled** **(** **)** +- |void| **set_emission_angle_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_emission_angle_enabled**\ (\ ) If ``true``, the audio should be attenuated according to the direction of the sound. @@ -376,8 +379,8 @@ If ``true``, the audio should be attenuated according to the direction of the so .. rst-class:: classref-property-setget -- void **set_emission_angle_filter_attenuation_db** **(** :ref:`float` value **)** -- :ref:`float` **get_emission_angle_filter_attenuation_db** **(** **)** +- |void| **set_emission_angle_filter_attenuation_db**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_emission_angle_filter_attenuation_db**\ (\ ) Attenuation factor used if listener is outside of :ref:`emission_angle_degrees` and :ref:`emission_angle_enabled` is set, in decibels. @@ -393,8 +396,8 @@ Attenuation factor used if listener is outside of :ref:`emission_angle_degrees` value **)** -- :ref:`float` **get_max_db** **(** **)** +- |void| **set_max_db**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_max_db**\ (\ ) Sets the absolute maximum of the sound level, in decibels. @@ -410,8 +413,8 @@ Sets the absolute maximum of the sound level, in decibels. .. rst-class:: classref-property-setget -- void **set_max_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_max_distance** **(** **)** +- |void| **set_max_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_max_distance**\ (\ ) The distance past which the sound can no longer be heard at all. Only has an effect if set to a value greater than ``0.0``. :ref:`max_distance` works in tandem with :ref:`unit_size`. However, unlike :ref:`unit_size` whose behavior depends on the :ref:`attenuation_model`, :ref:`max_distance` always works in a linear fashion. This can be used to prevent the **AudioStreamPlayer3D** from requiring audio mixing when the listener is far away, which saves CPU resources. @@ -427,8 +430,8 @@ The distance past which the sound can no longer be heard at all. Only has an eff .. rst-class:: classref-property-setget -- void **set_max_polyphony** **(** :ref:`int` value **)** -- :ref:`int` **get_max_polyphony** **(** **)** +- |void| **set_max_polyphony**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_polyphony**\ (\ ) The maximum number of sounds this node can play at the same time. Playing additional sounds after this value is reached will cut off the oldest sounds. @@ -444,8 +447,8 @@ The maximum number of sounds this node can play at the same time. Playing additi .. rst-class:: classref-property-setget -- void **set_panning_strength** **(** :ref:`float` value **)** -- :ref:`float` **get_panning_strength** **(** **)** +- |void| **set_panning_strength**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_panning_strength**\ (\ ) Scales the panning strength for this node by multiplying the base :ref:`ProjectSettings.audio/general/3d_panning_strength` with this factor. Higher values will pan audio from left to right more dramatically than lower values. @@ -461,8 +464,8 @@ Scales the panning strength for this node by multiplying the base :ref:`ProjectS .. rst-class:: classref-property-setget -- void **set_pitch_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_pitch_scale** **(** **)** +- |void| **set_pitch_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pitch_scale**\ (\ ) The pitch and the tempo of the audio, as a multiplier of the audio sample's sample rate. @@ -478,7 +481,7 @@ The pitch and the tempo of the audio, as a multiplier of the audio sample's samp .. rst-class:: classref-property-setget -- :ref:`bool` **is_playing** **(** **)** +- :ref:`bool` **is_playing**\ (\ ) If ``true``, audio is playing or is queued to be played (see :ref:`play`). @@ -494,8 +497,8 @@ If ``true``, audio is playing or is queued to be played (see :ref:`play` value **)** -- :ref:`AudioStream` **get_stream** **(** **)** +- |void| **set_stream**\ (\ value\: :ref:`AudioStream`\ ) +- :ref:`AudioStream` **get_stream**\ (\ ) The :ref:`AudioStream` resource to be played. @@ -511,8 +514,8 @@ The :ref:`AudioStream` resource to be played. .. rst-class:: classref-property-setget -- void **set_stream_paused** **(** :ref:`bool` value **)** -- :ref:`bool` **get_stream_paused** **(** **)** +- |void| **set_stream_paused**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_stream_paused**\ (\ ) If ``true``, the playback is paused. You can resume it by setting :ref:`stream_paused` to ``false``. @@ -528,8 +531,8 @@ If ``true``, the playback is paused. You can resume it by setting :ref:`stream_p .. rst-class:: classref-property-setget -- void **set_unit_size** **(** :ref:`float` value **)** -- :ref:`float` **get_unit_size** **(** **)** +- |void| **set_unit_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_unit_size**\ (\ ) The factor for the attenuation effect. Higher values make the sound audible over a larger distance. @@ -545,8 +548,8 @@ The factor for the attenuation effect. Higher values make the sound audible over .. rst-class:: classref-property-setget -- void **set_volume_db** **(** :ref:`float` value **)** -- :ref:`float` **get_volume_db** **(** **)** +- |void| **set_volume_db**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_volume_db**\ (\ ) The base sound level before attenuation, in decibels. @@ -563,7 +566,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_playback_position** **(** **)** +:ref:`float` **get_playback_position**\ (\ ) Returns the position in the :ref:`AudioStream`. @@ -575,7 +578,7 @@ Returns the position in the :ref:`AudioStream`. .. rst-class:: classref-method -:ref:`AudioStreamPlayback` **get_stream_playback** **(** **)** +:ref:`AudioStreamPlayback` **get_stream_playback**\ (\ ) Returns the :ref:`AudioStreamPlayback` object associated with this **AudioStreamPlayer3D**. @@ -587,7 +590,7 @@ Returns the :ref:`AudioStreamPlayback` object associa .. rst-class:: classref-method -:ref:`bool` **has_stream_playback** **(** **)** +:ref:`bool` **has_stream_playback**\ (\ ) Returns whether the :ref:`AudioStreamPlayer` can return the :ref:`AudioStreamPlayback` object or not. @@ -599,7 +602,7 @@ Returns whether the :ref:`AudioStreamPlayer` can return .. rst-class:: classref-method -void **play** **(** :ref:`float` from_position=0.0 **)** +|void| **play**\ (\ from_position\: :ref:`float` = 0.0\ ) Queues the audio to play on the next physics frame, from the given position ``from_position``, in seconds. @@ -611,7 +614,7 @@ Queues the audio to play on the next physics frame, from the given position ``fr .. rst-class:: classref-method -void **seek** **(** :ref:`float` to_position **)** +|void| **seek**\ (\ to_position\: :ref:`float`\ ) Sets the position from which audio will be played, in seconds. @@ -623,7 +626,7 @@ Sets the position from which audio will be played, in seconds. .. rst-class:: classref-method -void **stop** **(** **)** +|void| **stop**\ (\ ) Stops the audio. @@ -634,3 +637,4 @@ Stops the audio. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreampolyphonic.rst b/classes/class_audiostreampolyphonic.rst index e69cff15630..2e078fe2781 100644 --- a/classes/class_audiostreampolyphonic.rst +++ b/classes/class_audiostreampolyphonic.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_polyphony** **(** :ref:`int` value **)** -- :ref:`int` **get_polyphony** **(** **)** +- |void| **set_polyphony**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_polyphony**\ (\ ) Maximum amount of simultaneous streams that can be played. @@ -64,3 +64,4 @@ Maximum amount of simultaneous streams that can be played. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreamrandomizer.rst b/classes/class_audiostreamrandomizer.rst index ce7fd5717df..0834a902257 100644 --- a/classes/class_audiostreamrandomizer.rst +++ b/classes/class_audiostreamrandomizer.rst @@ -47,21 +47,21 @@ Methods .. table:: :widths: auto - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_stream` **(** :ref:`int` index, :ref:`AudioStream` stream, :ref:`float` weight=1.0 **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStream` | :ref:`get_stream` **(** :ref:`int` index **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_stream_probability_weight` **(** :ref:`int` index **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_stream` **(** :ref:`int` index_from, :ref:`int` index_to **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_stream` **(** :ref:`int` index **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_stream` **(** :ref:`int` index, :ref:`AudioStream` stream **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_stream_probability_weight` **(** :ref:`int` index, :ref:`float` weight **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_stream`\ (\ index\: :ref:`int`, stream\: :ref:`AudioStream`, weight\: :ref:`float` = 1.0\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStream` | :ref:`get_stream`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_stream_probability_weight`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_stream`\ (\ index_from\: :ref:`int`, index_to\: :ref:`int`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_stream`\ (\ index\: :ref:`int`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stream`\ (\ index\: :ref:`int`, stream\: :ref:`AudioStream`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stream_probability_weight`\ (\ index\: :ref:`int`, weight\: :ref:`float`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -119,8 +119,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_playback_mode** **(** :ref:`PlaybackMode` value **)** -- :ref:`PlaybackMode` **get_playback_mode** **(** **)** +- |void| **set_playback_mode**\ (\ value\: :ref:`PlaybackMode`\ ) +- :ref:`PlaybackMode` **get_playback_mode**\ (\ ) Controls how this AudioStreamRandomizer picks which AudioStream to play next. @@ -136,8 +136,8 @@ Controls how this AudioStreamRandomizer picks which AudioStream to play next. .. rst-class:: classref-property-setget -- void **set_random_pitch** **(** :ref:`float` value **)** -- :ref:`float` **get_random_pitch** **(** **)** +- |void| **set_random_pitch**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_random_pitch**\ (\ ) The intensity of random pitch variation. A value of 1 means no variation. @@ -153,8 +153,8 @@ The intensity of random pitch variation. A value of 1 means no variation. .. rst-class:: classref-property-setget -- void **set_random_volume_offset_db** **(** :ref:`float` value **)** -- :ref:`float` **get_random_volume_offset_db** **(** **)** +- |void| **set_random_volume_offset_db**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_random_volume_offset_db**\ (\ ) The intensity of random volume variation. A value of 0 means no variation. @@ -170,8 +170,8 @@ The intensity of random volume variation. A value of 0 means no variation. .. rst-class:: classref-property-setget -- void **set_streams_count** **(** :ref:`int` value **)** -- :ref:`int` **get_streams_count** **(** **)** +- |void| **set_streams_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_streams_count**\ (\ ) The number of streams in the stream pool. @@ -188,7 +188,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_stream** **(** :ref:`int` index, :ref:`AudioStream` stream, :ref:`float` weight=1.0 **)** +|void| **add_stream**\ (\ index\: :ref:`int`, stream\: :ref:`AudioStream`, weight\: :ref:`float` = 1.0\ ) Insert a stream at the specified index. If the index is less than zero, the insertion occurs at the end of the underlying pool. @@ -200,7 +200,7 @@ Insert a stream at the specified index. If the index is less than zero, the inse .. rst-class:: classref-method -:ref:`AudioStream` **get_stream** **(** :ref:`int` index **)** |const| +:ref:`AudioStream` **get_stream**\ (\ index\: :ref:`int`\ ) |const| Returns the stream at the specified index. @@ -212,7 +212,7 @@ Returns the stream at the specified index. .. rst-class:: classref-method -:ref:`float` **get_stream_probability_weight** **(** :ref:`int` index **)** |const| +:ref:`float` **get_stream_probability_weight**\ (\ index\: :ref:`int`\ ) |const| Returns the probability weight associated with the stream at the given index. @@ -224,7 +224,7 @@ Returns the probability weight associated with the stream at the given index. .. rst-class:: classref-method -void **move_stream** **(** :ref:`int` index_from, :ref:`int` index_to **)** +|void| **move_stream**\ (\ index_from\: :ref:`int`, index_to\: :ref:`int`\ ) Move a stream from one index to another. @@ -236,7 +236,7 @@ Move a stream from one index to another. .. rst-class:: classref-method -void **remove_stream** **(** :ref:`int` index **)** +|void| **remove_stream**\ (\ index\: :ref:`int`\ ) Remove the stream at the specified index. @@ -248,7 +248,7 @@ Remove the stream at the specified index. .. rst-class:: classref-method -void **set_stream** **(** :ref:`int` index, :ref:`AudioStream` stream **)** +|void| **set_stream**\ (\ index\: :ref:`int`, stream\: :ref:`AudioStream`\ ) Set the AudioStream at the specified index. @@ -260,7 +260,7 @@ Set the AudioStream at the specified index. .. rst-class:: classref-method -void **set_stream_probability_weight** **(** :ref:`int` index, :ref:`float` weight **)** +|void| **set_stream_probability_weight**\ (\ index\: :ref:`int`, weight\: :ref:`float`\ ) Set the probability weight of the stream at the specified index. The higher this value, the more likely that the randomizer will choose this stream during random playback modes. @@ -271,3 +271,4 @@ Set the probability weight of the stream at the specified index. The higher this .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_audiostreamwav.rst b/classes/class_audiostreamwav.rst index 1e72eeb5eb8..cc90f565894 100644 --- a/classes/class_audiostreamwav.rst +++ b/classes/class_audiostreamwav.rst @@ -62,9 +62,9 @@ Methods .. table:: :widths: auto - +---------------------------------------+----------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save_to_wav` **(** :ref:`String` path **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------+ + +---------------------------------------+-------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save_to_wav`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -164,8 +164,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_data** **(** :ref:`PackedByteArray` value **)** -- :ref:`PackedByteArray` **get_data** **(** **)** +- |void| **set_data**\ (\ value\: :ref:`PackedByteArray`\ ) +- :ref:`PackedByteArray` **get_data**\ (\ ) Contains the audio data in bytes. @@ -183,8 +183,8 @@ Contains the audio data in bytes. .. rst-class:: classref-property-setget -- void **set_format** **(** :ref:`Format` value **)** -- :ref:`Format` **get_format** **(** **)** +- |void| **set_format**\ (\ value\: :ref:`Format`\ ) +- :ref:`Format` **get_format**\ (\ ) Audio format. See :ref:`Format` constants for values. @@ -200,8 +200,8 @@ Audio format. See :ref:`Format` constants for values .. rst-class:: classref-property-setget -- void **set_loop_begin** **(** :ref:`int` value **)** -- :ref:`int` **get_loop_begin** **(** **)** +- |void| **set_loop_begin**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_loop_begin**\ (\ ) The loop start point (in number of samples, relative to the beginning of the sample). This information will be imported automatically from the WAV file if present. @@ -217,8 +217,8 @@ The loop start point (in number of samples, relative to the beginning of the sam .. rst-class:: classref-property-setget -- void **set_loop_end** **(** :ref:`int` value **)** -- :ref:`int` **get_loop_end** **(** **)** +- |void| **set_loop_end**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_loop_end**\ (\ ) The loop end point (in number of samples, relative to the beginning of the sample). This information will be imported automatically from the WAV file if present. @@ -234,8 +234,8 @@ The loop end point (in number of samples, relative to the beginning of the sampl .. rst-class:: classref-property-setget -- void **set_loop_mode** **(** :ref:`LoopMode` value **)** -- :ref:`LoopMode` **get_loop_mode** **(** **)** +- |void| **set_loop_mode**\ (\ value\: :ref:`LoopMode`\ ) +- :ref:`LoopMode` **get_loop_mode**\ (\ ) The loop mode. This information will be imported automatically from the WAV file if present. See :ref:`LoopMode` constants for values. @@ -251,8 +251,8 @@ The loop mode. This information will be imported automatically from the WAV file .. rst-class:: classref-property-setget -- void **set_mix_rate** **(** :ref:`int` value **)** -- :ref:`int` **get_mix_rate** **(** **)** +- |void| **set_mix_rate**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_mix_rate**\ (\ ) The sample rate for mixing this audio. Higher values require more storage space, but result in better quality. @@ -272,8 +272,8 @@ According to the `Nyquist-Shannon sampling theorem ` value **)** -- :ref:`bool` **is_stereo** **(** **)** +- |void| **set_stereo**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_stereo**\ (\ ) If ``true``, audio is stereo. @@ -290,7 +290,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **save_to_wav** **(** :ref:`String` path **)** +:ref:`Error` **save_to_wav**\ (\ path\: :ref:`String`\ ) Saves the AudioStreamWAV as a WAV file to ``path``. Samples with IMA ADPCM format can't be saved. @@ -303,3 +303,4 @@ Saves the AudioStreamWAV as a WAV file to ``path``. Samples with IMA ADPCM forma .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index f16b2ff9fc8..aa8cbd148b6 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -93,8 +93,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_copy_mode** **(** :ref:`CopyMode` value **)** -- :ref:`CopyMode` **get_copy_mode** **(** **)** +- |void| **set_copy_mode**\ (\ value\: :ref:`CopyMode`\ ) +- :ref:`CopyMode` **get_copy_mode**\ (\ ) Buffer mode. See :ref:`CopyMode` constants. @@ -110,8 +110,8 @@ Buffer mode. See :ref:`CopyMode` constants. .. rst-class:: classref-property-setget -- void **set_rect** **(** :ref:`Rect2` value **)** -- :ref:`Rect2` **get_rect** **(** **)** +- |void| **set_rect**\ (\ value\: :ref:`Rect2`\ ) +- :ref:`Rect2` **get_rect**\ (\ ) The area covered by the **BackBufferCopy**. Only used if :ref:`copy_mode` is :ref:`COPY_MODE_RECT`. @@ -122,3 +122,4 @@ The area covered by the **BackBufferCopy**. Only used if :ref:`copy_mode` | :ref:`button_group` | | +-------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+ - | |bitfield|\<:ref:`MouseButtonMask`\> | :ref:`button_mask` | ``1`` | + | |bitfield|\[:ref:`MouseButtonMask`\] | :ref:`button_mask` | ``1`` | +-------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+ | :ref:`bool` | :ref:`button_pressed` | ``false`` | +-------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+ @@ -63,17 +63,17 @@ Methods .. table:: :widths: auto - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_pressed` **(** **)** |virtual| | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_toggled` **(** :ref:`bool` toggled_on **)** |virtual| | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | :ref:`DrawMode` | :ref:`get_draw_mode` **(** **)** |const| | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_hovered` **(** **)** |const| | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_pressed_no_signal` **(** :ref:`bool` pressed **)** | - +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_pressed`\ (\ ) |virtual| | + +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_toggled`\ (\ toggled_on\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`DrawMode` | :ref:`get_draw_mode`\ (\ ) |const| | + +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_hovered`\ (\ ) |const| | + +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_pressed_no_signal`\ (\ pressed\: :ref:`bool`\ ) | + +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -88,7 +88,7 @@ Signals .. rst-class:: classref-signal -**button_down** **(** **)** +**button_down**\ (\ ) Emitted when the button starts being held down. @@ -100,7 +100,7 @@ Emitted when the button starts being held down. .. rst-class:: classref-signal -**button_up** **(** **)** +**button_up**\ (\ ) Emitted when the button stops being held down. @@ -112,7 +112,7 @@ Emitted when the button stops being held down. .. rst-class:: classref-signal -**pressed** **(** **)** +**pressed**\ (\ ) Emitted when the button is toggled or pressed. This is on :ref:`button_down` if :ref:`action_mode` is :ref:`ACTION_MODE_BUTTON_PRESS` and on :ref:`button_up` otherwise. @@ -126,7 +126,7 @@ If you need to know the button's pressed state (and :ref:`toggle_mode` toggled_on **)** +**toggled**\ (\ toggled_on\: :ref:`bool`\ ) Emitted when the button was just toggled between pressed and normal states (only if :ref:`toggle_mode` is active). The new state is contained in the ``toggled_on`` argument. @@ -228,8 +228,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_action_mode** **(** :ref:`ActionMode` value **)** -- :ref:`ActionMode` **get_action_mode** **(** **)** +- |void| **set_action_mode**\ (\ value\: :ref:`ActionMode`\ ) +- :ref:`ActionMode` **get_action_mode**\ (\ ) Determines when the button is considered clicked, one of the :ref:`ActionMode` constants. @@ -245,8 +245,8 @@ Determines when the button is considered clicked, one of the :ref:`ActionMode` value **)** -- :ref:`ButtonGroup` **get_button_group** **(** **)** +- |void| **set_button_group**\ (\ value\: :ref:`ButtonGroup`\ ) +- :ref:`ButtonGroup` **get_button_group**\ (\ ) The :ref:`ButtonGroup` associated with the button. Not to be confused with node groups. @@ -260,12 +260,12 @@ The :ref:`ButtonGroup` associated with the button. Not to be .. rst-class:: classref-property -|bitfield|\<:ref:`MouseButtonMask`\> **button_mask** = ``1`` +|bitfield|\[:ref:`MouseButtonMask`\] **button_mask** = ``1`` .. rst-class:: classref-property-setget -- void **set_button_mask** **(** |bitfield|\<:ref:`MouseButtonMask`\> value **)** -- |bitfield|\<:ref:`MouseButtonMask`\> **get_button_mask** **(** **)** +- |void| **set_button_mask**\ (\ value\: |bitfield|\[:ref:`MouseButtonMask`\]\ ) +- |bitfield|\[:ref:`MouseButtonMask`\] **get_button_mask**\ (\ ) Binary mask to choose which mouse buttons this button will respond to. @@ -283,8 +283,8 @@ To allow both left-click and right-click, use ``MOUSE_BUTTON_MASK_LEFT | MOUSE_B .. rst-class:: classref-property-setget -- void **set_pressed** **(** :ref:`bool` value **)** -- :ref:`bool` **is_pressed** **(** **)** +- |void| **set_pressed**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_pressed**\ (\ ) If ``true``, the button's state is pressed. Means the button is pressed down or toggled (if :ref:`toggle_mode` is active). Only works if :ref:`toggle_mode` is ``true``. @@ -302,8 +302,8 @@ If ``true``, the button's state is pressed. Means the button is pressed down or .. rst-class:: classref-property-setget -- void **set_disabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_disabled** **(** **)** +- |void| **set_disabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_disabled**\ (\ ) If ``true``, the button is in disabled state and can't be clicked or toggled. @@ -319,8 +319,8 @@ If ``true``, the button is in disabled state and can't be clicked or toggled. .. rst-class:: classref-property-setget -- void **set_keep_pressed_outside** **(** :ref:`bool` value **)** -- :ref:`bool` **is_keep_pressed_outside** **(** **)** +- |void| **set_keep_pressed_outside**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_keep_pressed_outside**\ (\ ) If ``true``, the button stays pressed when moving the cursor outside the button while pressing it. @@ -338,8 +338,8 @@ If ``true``, the button stays pressed when moving the cursor outside the button .. rst-class:: classref-property-setget -- void **set_shortcut** **(** :ref:`Shortcut` value **)** -- :ref:`Shortcut` **get_shortcut** **(** **)** +- |void| **set_shortcut**\ (\ value\: :ref:`Shortcut`\ ) +- :ref:`Shortcut` **get_shortcut**\ (\ ) :ref:`Shortcut` associated to the button. @@ -355,8 +355,8 @@ If ``true``, the button stays pressed when moving the cursor outside the button .. rst-class:: classref-property-setget -- void **set_shortcut_feedback** **(** :ref:`bool` value **)** -- :ref:`bool` **is_shortcut_feedback** **(** **)** +- |void| **set_shortcut_feedback**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_shortcut_feedback**\ (\ ) If ``true``, the button will highlight for a short amount of time when its shortcut is activated. If ``false`` and :ref:`toggle_mode` is ``false``, the shortcut will activate without any visual feedback. @@ -372,8 +372,8 @@ If ``true``, the button will highlight for a short amount of time when its short .. rst-class:: classref-property-setget -- void **set_shortcut_in_tooltip** **(** :ref:`bool` value **)** -- :ref:`bool` **is_shortcut_in_tooltip_enabled** **(** **)** +- |void| **set_shortcut_in_tooltip**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_shortcut_in_tooltip_enabled**\ (\ ) If ``true``, the button will add information about its shortcut in the tooltip. @@ -389,8 +389,8 @@ If ``true``, the button will add information about its shortcut in the tooltip. .. rst-class:: classref-property-setget -- void **set_toggle_mode** **(** :ref:`bool` value **)** -- :ref:`bool` **is_toggle_mode** **(** **)** +- |void| **set_toggle_mode**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_toggle_mode**\ (\ ) If ``true``, the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked. @@ -407,7 +407,7 @@ Method Descriptions .. rst-class:: classref-method -void **_pressed** **(** **)** |virtual| +|void| **_pressed**\ (\ ) |virtual| Called when the button is pressed. If you need to know the button's pressed state (and :ref:`toggle_mode` is active), use :ref:`_toggled` instead. @@ -419,7 +419,7 @@ Called when the button is pressed. If you need to know the button's pressed stat .. rst-class:: classref-method -void **_toggled** **(** :ref:`bool` toggled_on **)** |virtual| +|void| **_toggled**\ (\ toggled_on\: :ref:`bool`\ ) |virtual| Called when the button is toggled (only if :ref:`toggle_mode` is active). @@ -431,7 +431,7 @@ Called when the button is toggled (only if :ref:`toggle_mode` **get_draw_mode** **(** **)** |const| +:ref:`DrawMode` **get_draw_mode**\ (\ ) |const| Returns the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the :ref:`DrawMode` enum. @@ -443,7 +443,7 @@ Returns the visual state used to draw the button. This is useful mainly when imp .. rst-class:: classref-method -:ref:`bool` **is_hovered** **(** **)** |const| +:ref:`bool` **is_hovered**\ (\ ) |const| Returns ``true`` if the mouse has entered the button and has not left it yet. @@ -455,7 +455,7 @@ Returns ``true`` if the mouse has entered the button and has not left it yet. .. rst-class:: classref-method -void **set_pressed_no_signal** **(** :ref:`bool` pressed **)** +|void| **set_pressed_no_signal**\ (\ pressed\: :ref:`bool`\ ) Changes the :ref:`button_pressed` state of the button, without emitting :ref:`toggled`. Use when you just want to change the state of the button without sending the pressed event (e.g. when initializing scene). Only works if :ref:`toggle_mode` is ``true``. @@ -468,3 +468,4 @@ Changes the :ref:`button_pressed` stat .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_basematerial3d.rst b/classes/class_basematerial3d.rst index 54b8fda3582..0d7b202d598 100644 --- a/classes/class_basematerial3d.rst +++ b/classes/class_basematerial3d.rst @@ -282,19 +282,19 @@ Methods .. table:: :widths: auto - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_feature` **(** :ref:`Feature` feature **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_flag` **(** :ref:`Flags` flag **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_texture` **(** :ref:`TextureParam` param **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_feature` **(** :ref:`Feature` feature, :ref:`bool` enable **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_flag` **(** :ref:`Flags` flag, :ref:`bool` enable **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_texture` **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_feature`\ (\ feature\: :ref:`Feature`\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_flag`\ (\ flag\: :ref:`Flags`\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_texture`\ (\ param\: :ref:`TextureParam`\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_feature`\ (\ feature\: :ref:`Feature`, enable\: :ref:`bool`\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_flag`\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_texture`\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -1366,8 +1366,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_albedo** **(** :ref:`Color` value **)** -- :ref:`Color` **get_albedo** **(** **)** +- |void| **set_albedo**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_albedo**\ (\ ) The material's base color. @@ -1385,8 +1385,8 @@ The material's base color. .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| Texture to multiply by :ref:`albedo_color`. Used for basic texturing of objects. @@ -1404,8 +1404,8 @@ If the texture appears unexpectedly too dark or too bright, check :ref:`albedo_t .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, forces a conversion of the :ref:`albedo_texture` from sRGB color space to linear color space. See also :ref:`vertex_color_is_srgb`. @@ -1423,8 +1423,8 @@ This should only be enabled when needed (typically when using a :ref:`ViewportTe .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| Enables multichannel signed distance field rendering shader. Use :ref:`msdf_pixel_range` and :ref:`msdf_outline_size` to configure MSDF parameters. @@ -1440,8 +1440,8 @@ Enables multichannel signed distance field rendering shader. Use :ref:`msdf_pixe .. rst-class:: classref-property-setget -- void **set_alpha_antialiasing_edge** **(** :ref:`float` value **)** -- :ref:`float` **get_alpha_antialiasing_edge** **(** **)** +- |void| **set_alpha_antialiasing_edge**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_alpha_antialiasing_edge**\ (\ ) Threshold at which antialiasing will be applied on the alpha channel. @@ -1457,8 +1457,8 @@ Threshold at which antialiasing will be applied on the alpha channel. .. rst-class:: classref-property-setget -- void **set_alpha_antialiasing** **(** :ref:`AlphaAntiAliasing` value **)** -- :ref:`AlphaAntiAliasing` **get_alpha_antialiasing** **(** **)** +- |void| **set_alpha_antialiasing**\ (\ value\: :ref:`AlphaAntiAliasing`\ ) +- :ref:`AlphaAntiAliasing` **get_alpha_antialiasing**\ (\ ) The type of alpha antialiasing to apply. See :ref:`AlphaAntiAliasing`. @@ -1474,8 +1474,8 @@ The type of alpha antialiasing to apply. See :ref:`AlphaAntiAliasing` value **)** -- :ref:`float` **get_alpha_hash_scale** **(** **)** +- |void| **set_alpha_hash_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_alpha_hash_scale**\ (\ ) The hashing scale for Alpha Hash. Recommended values between ``0`` and ``2``. @@ -1491,8 +1491,8 @@ The hashing scale for Alpha Hash. Recommended values between ``0`` and ``2``. .. rst-class:: classref-property-setget -- void **set_alpha_scissor_threshold** **(** :ref:`float` value **)** -- :ref:`float` **get_alpha_scissor_threshold** **(** **)** +- |void| **set_alpha_scissor_threshold**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_alpha_scissor_threshold**\ (\ ) Threshold at which the alpha scissor will discard values. Higher values will result in more pixels being discarded. If the material becomes too opaque at a distance, try increasing :ref:`alpha_scissor_threshold`. If the material disappears at a distance, try decreasing :ref:`alpha_scissor_threshold`. @@ -1508,8 +1508,8 @@ Threshold at which the alpha scissor will discard values. Higher values will res .. rst-class:: classref-property-setget -- void **set_anisotropy** **(** :ref:`float` value **)** -- :ref:`float` **get_anisotropy** **(** **)** +- |void| **set_anisotropy**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_anisotropy**\ (\ ) The strength of the anisotropy effect. This is multiplied by :ref:`anisotropy_flowmap`'s alpha channel if a texture is defined there and the texture contains an alpha channel. @@ -1525,8 +1525,8 @@ The strength of the anisotropy effect. This is multiplied by :ref:`anisotropy_fl .. rst-class:: classref-property-setget -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| +- |void| **set_feature**\ (\ feature\: :ref:`Feature`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_feature**\ (\ feature\: :ref:`Feature`\ ) |const| If ``true``, anisotropy is enabled. Anisotropy changes the shape of the specular blob and aligns it to tangent space. This is useful for brushed aluminium and hair reflections. @@ -1546,8 +1546,8 @@ If ``true``, anisotropy is enabled. Anisotropy changes the shape of the specular .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| Texture that offsets the tangent map for anisotropy calculations and optionally controls the anisotropy effect (if an alpha channel is present). The flowmap texture is expected to be a derivative map, with the red channel representing distortion on the X axis and green channel representing distortion on the Y axis. Values below 0.5 will result in negative distortion, whereas values above 0.5 will result in positive distortion. @@ -1565,8 +1565,8 @@ If present, the texture's alpha channel will be used to multiply the strength of .. rst-class:: classref-property-setget -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| +- |void| **set_feature**\ (\ feature\: :ref:`Feature`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_feature**\ (\ feature\: :ref:`Feature`\ ) |const| If ``true``, ambient occlusion is enabled. Ambient occlusion darkens areas based on the :ref:`ao_texture`. @@ -1582,8 +1582,8 @@ If ``true``, ambient occlusion is enabled. Ambient occlusion darkens areas based .. rst-class:: classref-property-setget -- void **set_ao_light_affect** **(** :ref:`float` value **)** -- :ref:`float` **get_ao_light_affect** **(** **)** +- |void| **set_ao_light_affect**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ao_light_affect**\ (\ ) Amount that ambient occlusion affects lighting from lights. If ``0``, ambient occlusion only affects ambient light. If ``1``, ambient occlusion affects lights just as much as it affects ambient light. This can be used to impact the strength of the ambient occlusion effect, but typically looks unrealistic. @@ -1599,8 +1599,8 @@ Amount that ambient occlusion affects lighting from lights. If ``0``, ambient oc .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, use ``UV2`` coordinates to look up from the :ref:`ao_texture`. @@ -1616,8 +1616,8 @@ If ``true``, use ``UV2`` coordinates to look up from the :ref:`ao_texture` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| Texture that defines the amount of ambient occlusion for a given point on the object. @@ -1633,8 +1633,8 @@ Texture that defines the amount of ambient occlusion for a given point on the ob .. rst-class:: classref-property-setget -- void **set_ao_texture_channel** **(** :ref:`TextureChannel` value **)** -- :ref:`TextureChannel` **get_ao_texture_channel** **(** **)** +- |void| **set_ao_texture_channel**\ (\ value\: :ref:`TextureChannel`\ ) +- :ref:`TextureChannel` **get_ao_texture_channel**\ (\ ) Specifies the channel of the :ref:`ao_texture` in which the ambient occlusion information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use. @@ -1650,8 +1650,8 @@ Specifies the channel of the :ref:`ao_texture` value **)** -- :ref:`Color` **get_backlight** **(** **)** +- |void| **set_backlight**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_backlight**\ (\ ) The color used by the backlight effect. Represents the light passing through an object. @@ -1667,8 +1667,8 @@ The color used by the backlight effect. Represents the light passing through an .. rst-class:: classref-property-setget -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| +- |void| **set_feature**\ (\ feature\: :ref:`Feature`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_feature**\ (\ feature\: :ref:`Feature`\ ) |const| If ``true``, the backlight effect is enabled. See also :ref:`subsurf_scatter_transmittance_enabled`. @@ -1684,8 +1684,8 @@ If ``true``, the backlight effect is enabled. See also :ref:`subsurf_scatter_tra .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| Texture used to control the backlight effect per-pixel. Added to :ref:`backlight`. @@ -1701,8 +1701,8 @@ Texture used to control the backlight effect per-pixel. Added to :ref:`backlight .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, the shader will keep the scale set for the mesh. Otherwise, the scale is lost when billboarding. Only applies when :ref:`billboard_mode` is not :ref:`BILLBOARD_DISABLED`. @@ -1718,8 +1718,8 @@ If ``true``, the shader will keep the scale set for the mesh. Otherwise, the sca .. rst-class:: classref-property-setget -- void **set_billboard_mode** **(** :ref:`BillboardMode` value **)** -- :ref:`BillboardMode` **get_billboard_mode** **(** **)** +- |void| **set_billboard_mode**\ (\ value\: :ref:`BillboardMode`\ ) +- :ref:`BillboardMode` **get_billboard_mode**\ (\ ) Controls how the object faces the camera. See :ref:`BillboardMode`. @@ -1739,8 +1739,8 @@ Controls how the object faces the camera. See :ref:`BillboardMode` value **)** -- :ref:`BlendMode` **get_blend_mode** **(** **)** +- |void| **set_blend_mode**\ (\ value\: :ref:`BlendMode`\ ) +- :ref:`BlendMode` **get_blend_mode**\ (\ ) The material's blend mode. @@ -1758,8 +1758,8 @@ The material's blend mode. .. rst-class:: classref-property-setget -- void **set_clearcoat** **(** :ref:`float` value **)** -- :ref:`float` **get_clearcoat** **(** **)** +- |void| **set_clearcoat**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_clearcoat**\ (\ ) Sets the strength of the clearcoat effect. Setting to ``0`` looks the same as disabling the clearcoat effect. @@ -1775,8 +1775,8 @@ Sets the strength of the clearcoat effect. Setting to ``0`` looks the same as di .. rst-class:: classref-property-setget -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| +- |void| **set_feature**\ (\ feature\: :ref:`Feature`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_feature**\ (\ feature\: :ref:`Feature`\ ) |const| If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass to the lighting calculation resulting in an added specular blob. This makes materials appear as if they have a clear layer on them that can be either glossy or rough. @@ -1794,8 +1794,8 @@ If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass t .. rst-class:: classref-property-setget -- void **set_clearcoat_roughness** **(** :ref:`float` value **)** -- :ref:`float` **get_clearcoat_roughness** **(** **)** +- |void| **set_clearcoat_roughness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_clearcoat_roughness**\ (\ ) Sets the roughness of the clearcoat pass. A higher value results in a rougher clearcoat while a lower value results in a smoother clearcoat. @@ -1811,8 +1811,8 @@ Sets the roughness of the clearcoat pass. A higher value results in a rougher cl .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| Texture that defines the strength of the clearcoat effect and the glossiness of the clearcoat. Strength is specified in the red channel while glossiness is specified in the green channel. @@ -1828,8 +1828,8 @@ Texture that defines the strength of the clearcoat effect and the glossiness of .. rst-class:: classref-property-setget -- void **set_cull_mode** **(** :ref:`CullMode` value **)** -- :ref:`CullMode` **get_cull_mode** **(** **)** +- |void| **set_cull_mode**\ (\ value\: :ref:`CullMode`\ ) +- :ref:`CullMode` **get_cull_mode**\ (\ ) Determines which side of the triangle to cull depending on whether the triangle faces towards or away from the camera. See :ref:`CullMode`. @@ -1845,8 +1845,8 @@ Determines which side of the triangle to cull depending on whether the triangle .. rst-class:: classref-property-setget -- void **set_depth_draw_mode** **(** :ref:`DepthDrawMode` value **)** -- :ref:`DepthDrawMode` **get_depth_draw_mode** **(** **)** +- |void| **set_depth_draw_mode**\ (\ value\: :ref:`DepthDrawMode`\ ) +- :ref:`DepthDrawMode` **get_depth_draw_mode**\ (\ ) Determines when depth rendering takes place. See :ref:`DepthDrawMode`. See also :ref:`transparency`. @@ -1862,8 +1862,8 @@ Determines when depth rendering takes place. See :ref:`DepthDrawMode` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| Texture that specifies the color of the detail overlay. :ref:`detail_albedo`'s alpha channel is used as a mask, even when the material is opaque. To use a dedicated texture as a mask, see :ref:`detail_mask`. @@ -1881,8 +1881,8 @@ Texture that specifies the color of the detail overlay. :ref:`detail_albedo` value **)** -- :ref:`BlendMode` **get_detail_blend_mode** **(** **)** +- |void| **set_detail_blend_mode**\ (\ value\: :ref:`BlendMode`\ ) +- :ref:`BlendMode` **get_detail_blend_mode**\ (\ ) Specifies how the :ref:`detail_albedo` should blend with the current ``ALBEDO``. See :ref:`BlendMode` for options. @@ -1898,8 +1898,8 @@ Specifies how the :ref:`detail_albedo` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| +- |void| **set_feature**\ (\ feature\: :ref:`Feature`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_feature**\ (\ feature\: :ref:`Feature`\ ) |const| If ``true``, enables the detail overlay. Detail is a second texture that gets mixed over the surface of the object based on :ref:`detail_mask` and :ref:`detail_albedo`'s alpha channel. This can be used to add variation to objects, or to blend between two different albedo/normal textures. @@ -1915,8 +1915,8 @@ If ``true``, enables the detail overlay. Detail is a second texture that gets mi .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| Texture used to specify how the detail textures get blended with the base textures. :ref:`detail_mask` can be used together with :ref:`detail_albedo`'s alpha channel (if any). @@ -1932,8 +1932,8 @@ Texture used to specify how the detail textures get blended with the base textur .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| Texture that specifies the per-pixel normal of the detail overlay. The :ref:`detail_normal` texture only uses the red and green channels; the blue and alpha channels are ignored. The normal read from :ref:`detail_normal` is oriented around the surface normal provided by the :ref:`Mesh`. @@ -1951,8 +1951,8 @@ Texture that specifies the per-pixel normal of the detail overlay. The :ref:`det .. rst-class:: classref-property-setget -- void **set_detail_uv** **(** :ref:`DetailUV` value **)** -- :ref:`DetailUV` **get_detail_uv** **(** **)** +- |void| **set_detail_uv**\ (\ value\: :ref:`DetailUV`\ ) +- :ref:`DetailUV` **get_detail_uv**\ (\ ) Specifies whether to use ``UV`` or ``UV2`` for the detail layer. See :ref:`DetailUV` for options. @@ -1968,8 +1968,8 @@ Specifies whether to use ``UV`` or ``UV2`` for the detail layer. See :ref:`Detai .. rst-class:: classref-property-setget -- void **set_diffuse_mode** **(** :ref:`DiffuseMode` value **)** -- :ref:`DiffuseMode` **get_diffuse_mode** **(** **)** +- |void| **set_diffuse_mode**\ (\ value\: :ref:`DiffuseMode`\ ) +- :ref:`DiffuseMode` **get_diffuse_mode**\ (\ ) The algorithm used for diffuse light scattering. See :ref:`DiffuseMode`. @@ -1985,8 +1985,8 @@ The algorithm used for diffuse light scattering. See :ref:`DiffuseMode` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, the object receives no ambient light. @@ -2002,8 +2002,8 @@ If ``true``, the object receives no ambient light. .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, the object will not be affected by fog (neither volumetric nor depth fog). This is useful for unshaded or transparent materials (e.g. particles), which without this setting will be affected even if fully transparent. @@ -2019,8 +2019,8 @@ If ``true``, the object will not be affected by fog (neither volumetric nor dept .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, the object receives no shadow that would otherwise be cast onto it. @@ -2036,8 +2036,8 @@ If ``true``, the object receives no shadow that would otherwise be cast onto it. .. rst-class:: classref-property-setget -- void **set_distance_fade_max_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_distance_fade_max_distance** **(** **)** +- |void| **set_distance_fade_max_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_distance_fade_max_distance**\ (\ ) Distance at which the object appears fully opaque. @@ -2055,8 +2055,8 @@ Distance at which the object appears fully opaque. .. rst-class:: classref-property-setget -- void **set_distance_fade_min_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_distance_fade_min_distance** **(** **)** +- |void| **set_distance_fade_min_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_distance_fade_min_distance**\ (\ ) Distance at which the object starts to become visible. If the object is less than this distance away, it will be invisible. @@ -2074,8 +2074,8 @@ Distance at which the object starts to become visible. If the object is less tha .. rst-class:: classref-property-setget -- void **set_distance_fade** **(** :ref:`DistanceFadeMode` value **)** -- :ref:`DistanceFadeMode` **get_distance_fade** **(** **)** +- |void| **set_distance_fade**\ (\ value\: :ref:`DistanceFadeMode`\ ) +- :ref:`DistanceFadeMode` **get_distance_fade**\ (\ ) Specifies which type of fade to use. Can be any of the :ref:`DistanceFadeMode`\ s. @@ -2091,8 +2091,8 @@ Specifies which type of fade to use. Can be any of the :ref:`DistanceFadeMode` value **)** -- :ref:`Color` **get_emission** **(** **)** +- |void| **set_emission**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_emission**\ (\ ) The emitted light's color. See :ref:`emission_enabled`. @@ -2108,8 +2108,8 @@ The emitted light's color. See :ref:`emission_enabled` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| +- |void| **set_feature**\ (\ feature\: :ref:`Feature`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_feature**\ (\ feature\: :ref:`Feature`\ ) |const| If ``true``, the body emits light. Emitting light makes the object appear brighter. The object can also cast light on other objects if a :ref:`VoxelGI`, SDFGI, or :ref:`LightmapGI` is used and this object is used in baked lighting. @@ -2125,8 +2125,8 @@ If ``true``, the body emits light. Emitting light makes the object appear bright .. rst-class:: classref-property-setget -- void **set_emission_energy_multiplier** **(** :ref:`float` value **)** -- :ref:`float` **get_emission_energy_multiplier** **(** **)** +- |void| **set_emission_energy_multiplier**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_emission_energy_multiplier**\ (\ ) Multiplier for emitted light. See :ref:`emission_enabled`. @@ -2142,8 +2142,8 @@ Multiplier for emitted light. See :ref:`emission_enabled` value **)** -- :ref:`float` **get_emission_intensity** **(** **)** +- |void| **set_emission_intensity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_emission_intensity**\ (\ ) Luminance of emitted light, measured in nits (candela per square meter). Only available when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units` is enabled. The default is roughly equivalent to an indoor lightbulb. @@ -2159,8 +2159,8 @@ Luminance of emitted light, measured in nits (candela per square meter). Only av .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| Use ``UV2`` to read from the :ref:`emission_texture`. @@ -2176,8 +2176,8 @@ Use ``UV2`` to read from the :ref:`emission_texture` value **)** -- :ref:`EmissionOperator` **get_emission_operator** **(** **)** +- |void| **set_emission_operator**\ (\ value\: :ref:`EmissionOperator`\ ) +- :ref:`EmissionOperator` **get_emission_operator**\ (\ ) Sets how :ref:`emission` interacts with :ref:`emission_texture`. Can either add or multiply. See :ref:`EmissionOperator` for options. @@ -2193,8 +2193,8 @@ Sets how :ref:`emission` interacts with .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| Texture that specifies how much surface emits light at a given point. @@ -2210,8 +2210,8 @@ Texture that specifies how much surface emits light at a given point. .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, the object is rendered at the same size regardless of distance. @@ -2227,8 +2227,8 @@ If ``true``, the object is rendered at the same size regardless of distance. .. rst-class:: classref-property-setget -- void **set_grow_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_grow_enabled** **(** **)** +- |void| **set_grow_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_grow_enabled**\ (\ ) If ``true``, enables the vertex grow setting. This can be used to create mesh-based outlines using a second material pass and its :ref:`cull_mode` set to :ref:`CULL_FRONT`. See also :ref:`grow_amount`. @@ -2246,8 +2246,8 @@ If ``true``, enables the vertex grow setting. This can be used to create mesh-ba .. rst-class:: classref-property-setget -- void **set_grow** **(** :ref:`float` value **)** -- :ref:`float` **get_grow** **(** **)** +- |void| **set_grow**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_grow**\ (\ ) Grows object vertices in the direction of their normals. Only effective if :ref:`grow` is ``true``. @@ -2263,8 +2263,8 @@ Grows object vertices in the direction of their normals. Only effective if :ref: .. rst-class:: classref-property-setget -- void **set_heightmap_deep_parallax** **(** :ref:`bool` value **)** -- :ref:`bool` **is_heightmap_deep_parallax_enabled** **(** **)** +- |void| **set_heightmap_deep_parallax**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_heightmap_deep_parallax_enabled**\ (\ ) If ``true``, uses parallax occlusion mapping to represent depth in the material instead of simple offset mapping (see :ref:`heightmap_enabled`). This results in a more convincing depth effect, but is much more expensive on the GPU. Only enable this on materials where it makes a significant visual difference. @@ -2280,8 +2280,8 @@ If ``true``, uses parallax occlusion mapping to represent depth in the material .. rst-class:: classref-property-setget -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| +- |void| **set_feature**\ (\ feature\: :ref:`Feature`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_feature**\ (\ feature\: :ref:`Feature`\ ) |const| If ``true``, height mapping is enabled (also called "parallax mapping" or "depth mapping"). See also :ref:`normal_enabled`. Height mapping is a demanding feature on the GPU, so it should only be used on materials where it makes a significant visual difference. @@ -2299,8 +2299,8 @@ If ``true``, height mapping is enabled (also called "parallax mapping" or "depth .. rst-class:: classref-property-setget -- void **set_heightmap_deep_parallax_flip_binormal** **(** :ref:`bool` value **)** -- :ref:`bool` **get_heightmap_deep_parallax_flip_binormal** **(** **)** +- |void| **set_heightmap_deep_parallax_flip_binormal**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_heightmap_deep_parallax_flip_binormal**\ (\ ) If ``true``, flips the mesh's binormal vectors when interpreting the height map. If the heightmap effect looks strange when the camera moves (even with a reasonable :ref:`heightmap_scale`), try setting this to ``true``. @@ -2316,8 +2316,8 @@ If ``true``, flips the mesh's binormal vectors when interpreting the height map. .. rst-class:: classref-property-setget -- void **set_heightmap_deep_parallax_flip_tangent** **(** :ref:`bool` value **)** -- :ref:`bool` **get_heightmap_deep_parallax_flip_tangent** **(** **)** +- |void| **set_heightmap_deep_parallax_flip_tangent**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_heightmap_deep_parallax_flip_tangent**\ (\ ) If ``true``, flips the mesh's tangent vectors when interpreting the height map. If the heightmap effect looks strange when the camera moves (even with a reasonable :ref:`heightmap_scale`), try setting this to ``true``. @@ -2333,8 +2333,8 @@ If ``true``, flips the mesh's tangent vectors when interpreting the height map. .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, interprets the height map texture as a depth map, with brighter values appearing to be "lower" in altitude compared to darker values. @@ -2352,8 +2352,8 @@ This can be enabled for compatibility with some materials authored for Godot 3.x .. rst-class:: classref-property-setget -- void **set_heightmap_deep_parallax_max_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_heightmap_deep_parallax_max_layers** **(** **)** +- |void| **set_heightmap_deep_parallax_max_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_heightmap_deep_parallax_max_layers**\ (\ ) The number of layers to use for parallax occlusion mapping when the camera is up close to the material. Higher values result in a more convincing depth effect, especially in materials that have steep height changes. Higher values have a significant cost on the GPU, so it should only be increased on materials where it makes a significant visual difference. @@ -2371,8 +2371,8 @@ The number of layers to use for parallax occlusion mapping when the camera is up .. rst-class:: classref-property-setget -- void **set_heightmap_deep_parallax_min_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_heightmap_deep_parallax_min_layers** **(** **)** +- |void| **set_heightmap_deep_parallax_min_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_heightmap_deep_parallax_min_layers**\ (\ ) The number of layers to use for parallax occlusion mapping when the camera is far away from the material. Higher values result in a more convincing depth effect, especially in materials that have steep height changes. Higher values have a significant cost on the GPU, so it should only be increased on materials where it makes a significant visual difference. @@ -2390,8 +2390,8 @@ The number of layers to use for parallax occlusion mapping when the camera is fa .. rst-class:: classref-property-setget -- void **set_heightmap_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_heightmap_scale** **(** **)** +- |void| **set_heightmap_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_heightmap_scale**\ (\ ) The heightmap scale to use for the parallax effect (see :ref:`heightmap_enabled`). The default value is tuned so that the highest point (value = 255) appears to be 5 cm higher than the lowest point (value = 0). Higher values result in a deeper appearance, but may result in artifacts appearing when looking at the material from oblique angles, especially when the camera moves. Negative values can be used to invert the parallax effect, but this is different from inverting the texture using :ref:`heightmap_flip_texture` as the material will also appear to be "closer" to the camera. In most cases, :ref:`heightmap_scale` should be kept to a positive value. @@ -2409,8 +2409,8 @@ The heightmap scale to use for the parallax effect (see :ref:`heightmap_enabled< .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| The texture to use as a height map. See also :ref:`heightmap_enabled`. @@ -2430,8 +2430,8 @@ For best results, the texture should be normalized (with :ref:`heightmap_scale` value **)** -- :ref:`float` **get_metallic** **(** **)** +- |void| **set_metallic**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_metallic**\ (\ ) A high value makes the material appear more like a metal. Non-metals use their albedo as the diffuse color and add diffuse to the specular reflection. With non-metals, the reflection appears on top of the albedo color. Metals use their albedo as a multiplier to the specular reflection and set the diffuse color to black resulting in a tinted reflection. Materials work better when fully metal or fully non-metal, values between ``0`` and ``1`` should only be used for blending between metal and non-metal sections. To alter the amount of reflection use :ref:`roughness`. @@ -2447,8 +2447,8 @@ A high value makes the material appear more like a metal. Non-metals use their a .. rst-class:: classref-property-setget -- void **set_specular** **(** :ref:`float` value **)** -- :ref:`float` **get_specular** **(** **)** +- |void| **set_specular**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_specular**\ (\ ) Adjusts the strength of specular reflections. Specular reflections are composed of scene reflections and the specular lobe which is the bright spot that is reflected from light sources. When set to ``0.0``, no specular reflections will be visible. This differs from the :ref:`SPECULAR_DISABLED` :ref:`SpecularMode` as :ref:`SPECULAR_DISABLED` only applies to the specular lobe from the light source. @@ -2466,8 +2466,8 @@ Adjusts the strength of specular reflections. Specular reflections are composed .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| Texture used to specify metallic for an object. This is multiplied by :ref:`metallic`. @@ -2483,8 +2483,8 @@ Texture used to specify metallic for an object. This is multiplied by :ref:`meta .. rst-class:: classref-property-setget -- void **set_metallic_texture_channel** **(** :ref:`TextureChannel` value **)** -- :ref:`TextureChannel` **get_metallic_texture_channel** **(** **)** +- |void| **set_metallic_texture_channel**\ (\ value\: :ref:`TextureChannel`\ ) +- :ref:`TextureChannel` **get_metallic_texture_channel**\ (\ ) Specifies the channel of the :ref:`metallic_texture` in which the metallic information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use. @@ -2500,8 +2500,8 @@ Specifies the channel of the :ref:`metallic_texture` value **)** -- :ref:`float` **get_msdf_outline_size** **(** **)** +- |void| **set_msdf_outline_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_msdf_outline_size**\ (\ ) The width of the shape outline. @@ -2517,8 +2517,8 @@ The width of the shape outline. .. rst-class:: classref-property-setget -- void **set_msdf_pixel_range** **(** :ref:`float` value **)** -- :ref:`float` **get_msdf_pixel_range** **(** **)** +- |void| **set_msdf_pixel_range**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_msdf_pixel_range**\ (\ ) The width of the range around the shape between the minimum and maximum representable signed distance. @@ -2534,8 +2534,8 @@ The width of the range around the shape between the minimum and maximum represen .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, depth testing is disabled and the object will be drawn in render order. @@ -2551,8 +2551,8 @@ If ``true``, depth testing is disabled and the object will be drawn in render or .. rst-class:: classref-property-setget -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| +- |void| **set_feature**\ (\ feature\: :ref:`Feature`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_feature**\ (\ feature\: :ref:`Feature`\ ) |const| If ``true``, normal mapping is enabled. This has a slight performance cost, especially on mobile GPUs. @@ -2568,8 +2568,8 @@ If ``true``, normal mapping is enabled. This has a slight performance cost, espe .. rst-class:: classref-property-setget -- void **set_normal_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_normal_scale** **(** **)** +- |void| **set_normal_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_normal_scale**\ (\ ) The strength of the normal map's effect. @@ -2585,8 +2585,8 @@ The strength of the normal map's effect. .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| Texture used to specify the normal at a given pixel. The :ref:`normal_texture` only uses the red and green channels; the blue and alpha channels are ignored. The normal read from :ref:`normal_texture` is oriented around the surface normal provided by the :ref:`Mesh`. @@ -2608,8 +2608,8 @@ Texture used to specify the normal at a given pixel. The :ref:`normal_texture` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| The Occlusion/Roughness/Metallic texture to use. This is a more efficient replacement of :ref:`ao_texture`, :ref:`roughness_texture` and :ref:`metallic_texture` in :ref:`ORMMaterial3D`. Ambient occlusion is stored in the red channel. Roughness map is stored in the green channel. Metallic map is stored in the blue channel. The alpha channel is ignored. @@ -2625,8 +2625,8 @@ The Occlusion/Roughness/Metallic texture to use. This is a more efficient replac .. rst-class:: classref-property-setget -- void **set_particles_anim_h_frames** **(** :ref:`int` value **)** -- :ref:`int` **get_particles_anim_h_frames** **(** **)** +- |void| **set_particles_anim_h_frames**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_particles_anim_h_frames**\ (\ ) The number of horizontal frames in the particle sprite sheet. Only enabled when using :ref:`BILLBOARD_PARTICLES`. See :ref:`billboard_mode`. @@ -2642,8 +2642,8 @@ The number of horizontal frames in the particle sprite sheet. Only enabled when .. rst-class:: classref-property-setget -- void **set_particles_anim_loop** **(** :ref:`bool` value **)** -- :ref:`bool` **get_particles_anim_loop** **(** **)** +- |void| **set_particles_anim_loop**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_particles_anim_loop**\ (\ ) If ``true``, particle animations are looped. Only enabled when using :ref:`BILLBOARD_PARTICLES`. See :ref:`billboard_mode`. @@ -2659,8 +2659,8 @@ If ``true``, particle animations are looped. Only enabled when using :ref:`BILLB .. rst-class:: classref-property-setget -- void **set_particles_anim_v_frames** **(** :ref:`int` value **)** -- :ref:`int` **get_particles_anim_v_frames** **(** **)** +- |void| **set_particles_anim_v_frames**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_particles_anim_v_frames**\ (\ ) The number of vertical frames in the particle sprite sheet. Only enabled when using :ref:`BILLBOARD_PARTICLES`. See :ref:`billboard_mode`. @@ -2676,8 +2676,8 @@ The number of vertical frames in the particle sprite sheet. Only enabled when us .. rst-class:: classref-property-setget -- void **set_point_size** **(** :ref:`float` value **)** -- :ref:`float` **get_point_size** **(** **)** +- |void| **set_point_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_point_size**\ (\ ) The point size in pixels. See :ref:`use_point_size`. @@ -2693,8 +2693,8 @@ The point size in pixels. See :ref:`use_point_size` value **)** -- :ref:`float` **get_proximity_fade_distance** **(** **)** +- |void| **set_proximity_fade_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_proximity_fade_distance**\ (\ ) Distance over which the fade effect takes place. The larger the distance the longer it takes for an object to fade. @@ -2710,8 +2710,8 @@ Distance over which the fade effect takes place. The larger the distance the lon .. rst-class:: classref-property-setget -- void **set_proximity_fade_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_proximity_fade_enabled** **(** **)** +- |void| **set_proximity_fade_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_proximity_fade_enabled**\ (\ ) If ``true``, the proximity fade effect is enabled. The proximity fade effect fades out each pixel based on its distance to another object. @@ -2727,8 +2727,8 @@ If ``true``, the proximity fade effect is enabled. The proximity fade effect fad .. rst-class:: classref-property-setget -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| +- |void| **set_feature**\ (\ feature\: :ref:`Feature`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_feature**\ (\ feature\: :ref:`Feature`\ ) |const| If ``true``, the refraction effect is enabled. Distorts transparency based on light from behind the object. @@ -2744,8 +2744,8 @@ If ``true``, the refraction effect is enabled. Distorts transparency based on li .. rst-class:: classref-property-setget -- void **set_refraction** **(** :ref:`float` value **)** -- :ref:`float` **get_refraction** **(** **)** +- |void| **set_refraction**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_refraction**\ (\ ) The strength of the refraction effect. @@ -2761,8 +2761,8 @@ The strength of the refraction effect. .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| Texture that controls the strength of the refraction per-pixel. Multiplied by :ref:`refraction_scale`. @@ -2778,8 +2778,8 @@ Texture that controls the strength of the refraction per-pixel. Multiplied by :r .. rst-class:: classref-property-setget -- void **set_refraction_texture_channel** **(** :ref:`TextureChannel` value **)** -- :ref:`TextureChannel` **get_refraction_texture_channel** **(** **)** +- |void| **set_refraction_texture_channel**\ (\ value\: :ref:`TextureChannel`\ ) +- :ref:`TextureChannel` **get_refraction_texture_channel**\ (\ ) Specifies the channel of the :ref:`refraction_texture` in which the refraction information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored refraction in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use. @@ -2795,8 +2795,8 @@ Specifies the channel of the :ref:`refraction_texture` value **)** -- :ref:`float` **get_rim** **(** **)** +- |void| **set_rim**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_rim**\ (\ ) Sets the strength of the rim lighting effect. @@ -2812,8 +2812,8 @@ Sets the strength of the rim lighting effect. .. rst-class:: classref-property-setget -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| +- |void| **set_feature**\ (\ feature\: :ref:`Feature`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_feature**\ (\ feature\: :ref:`Feature`\ ) |const| If ``true``, rim effect is enabled. Rim lighting increases the brightness at glancing angles on an object. @@ -2831,8 +2831,8 @@ If ``true``, rim effect is enabled. Rim lighting increases the brightness at gla .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| Texture used to set the strength of the rim lighting effect per-pixel. Multiplied by :ref:`rim`. @@ -2848,8 +2848,8 @@ Texture used to set the strength of the rim lighting effect per-pixel. Multiplie .. rst-class:: classref-property-setget -- void **set_rim_tint** **(** :ref:`float` value **)** -- :ref:`float` **get_rim_tint** **(** **)** +- |void| **set_rim_tint**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_rim_tint**\ (\ ) The amount of to blend light and albedo color when rendering rim effect. If ``0`` the light color is used, while ``1`` means albedo color is used. An intermediate value generally works best. @@ -2865,8 +2865,8 @@ The amount of to blend light and albedo color when rendering rim effect. If ``0` .. rst-class:: classref-property-setget -- void **set_roughness** **(** :ref:`float` value **)** -- :ref:`float` **get_roughness** **(** **)** +- |void| **set_roughness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_roughness**\ (\ ) Surface reflection. A value of ``0`` represents a perfect mirror while a value of ``1`` completely blurs the reflection. See also :ref:`metallic`. @@ -2882,8 +2882,8 @@ Surface reflection. A value of ``0`` represents a perfect mirror while a value o .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| Texture used to control the roughness per-pixel. Multiplied by :ref:`roughness`. @@ -2899,8 +2899,8 @@ Texture used to control the roughness per-pixel. Multiplied by :ref:`roughness` value **)** -- :ref:`TextureChannel` **get_roughness_texture_channel** **(** **)** +- |void| **set_roughness_texture_channel**\ (\ value\: :ref:`TextureChannel`\ ) +- :ref:`TextureChannel` **get_roughness_texture_channel**\ (\ ) Specifies the channel of the :ref:`roughness_texture` in which the roughness information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use. @@ -2916,8 +2916,8 @@ Specifies the channel of the :ref:`roughness_texture` value **)** -- :ref:`ShadingMode` **get_shading_mode** **(** **)** +- |void| **set_shading_mode**\ (\ value\: :ref:`ShadingMode`\ ) +- :ref:`ShadingMode` **get_shading_mode**\ (\ ) Sets whether the shading takes place, per-pixel, per-vertex or unshaded. Per-vertex lighting is faster, making it the best choice for mobile applications, however it looks considerably worse than per-pixel. Unshaded rendering is the fastest, but disables all interactions with lights. @@ -2935,8 +2935,8 @@ Sets whether the shading takes place, per-pixel, per-vertex or unshaded. Per-ver .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, enables the "shadow to opacity" render mode where lighting modifies the alpha so shadowed areas are opaque and non-shadowed areas are transparent. Useful for overlaying shadows onto a camera feed in AR. @@ -2952,8 +2952,8 @@ If ``true``, enables the "shadow to opacity" render mode where lighting modifies .. rst-class:: classref-property-setget -- void **set_specular_mode** **(** :ref:`SpecularMode` value **)** -- :ref:`SpecularMode` **get_specular_mode** **(** **)** +- |void| **set_specular_mode**\ (\ value\: :ref:`SpecularMode`\ ) +- :ref:`SpecularMode` **get_specular_mode**\ (\ ) The method for rendering the specular blob. See :ref:`SpecularMode`. @@ -2971,8 +2971,8 @@ The method for rendering the specular blob. See :ref:`SpecularMode` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| +- |void| **set_feature**\ (\ feature\: :ref:`Feature`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_feature**\ (\ feature\: :ref:`Feature`\ ) |const| If ``true``, subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges. Subsurface scattering quality is controlled by :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_quality`. @@ -2988,8 +2988,8 @@ If ``true``, subsurface scattering is enabled. Emulates light that penetrates an .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, subsurface scattering will use a special mode optimized for the color and density of human skin, such as boosting the intensity of the red channel in subsurface scattering. @@ -3005,8 +3005,8 @@ If ``true``, subsurface scattering will use a special mode optimized for the col .. rst-class:: classref-property-setget -- void **set_subsurface_scattering_strength** **(** :ref:`float` value **)** -- :ref:`float` **get_subsurface_scattering_strength** **(** **)** +- |void| **set_subsurface_scattering_strength**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_subsurface_scattering_strength**\ (\ ) The strength of the subsurface scattering effect. The depth of the effect is also controlled by :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_scale`, which is set globally. @@ -3022,8 +3022,8 @@ The strength of the subsurface scattering effect. The depth of the effect is als .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| Texture used to control the subsurface scattering strength. Stored in the red texture channel. Multiplied by :ref:`subsurf_scatter_strength`. @@ -3039,8 +3039,8 @@ Texture used to control the subsurface scattering strength. Stored in the red te .. rst-class:: classref-property-setget -- void **set_transmittance_boost** **(** :ref:`float` value **)** -- :ref:`float` **get_transmittance_boost** **(** **)** +- |void| **set_transmittance_boost**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_transmittance_boost**\ (\ ) The intensity of the subsurface scattering transmittance effect. @@ -3056,8 +3056,8 @@ The intensity of the subsurface scattering transmittance effect. .. rst-class:: classref-property-setget -- void **set_transmittance_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_transmittance_color** **(** **)** +- |void| **set_transmittance_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_transmittance_color**\ (\ ) The color to multiply the subsurface scattering transmittance effect with. Ignored if :ref:`subsurf_scatter_skin_mode` is ``true``. @@ -3073,8 +3073,8 @@ The color to multiply the subsurface scattering transmittance effect with. Ignor .. rst-class:: classref-property-setget -- void **set_transmittance_depth** **(** :ref:`float` value **)** -- :ref:`float` **get_transmittance_depth** **(** **)** +- |void| **set_transmittance_depth**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_transmittance_depth**\ (\ ) The depth of the subsurface scattering transmittance effect. @@ -3090,8 +3090,8 @@ The depth of the subsurface scattering transmittance effect. .. rst-class:: classref-property-setget -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| +- |void| **set_feature**\ (\ feature\: :ref:`Feature`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_feature**\ (\ feature\: :ref:`Feature`\ ) |const| If ``true``, enables subsurface scattering transmittance. Only effective if :ref:`subsurf_scatter_enabled` is ``true``. See also :ref:`backlight_enabled`. @@ -3107,8 +3107,8 @@ If ``true``, enables subsurface scattering transmittance. Only effective if :ref .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** |const| +- |void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| 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``. @@ -3124,8 +3124,8 @@ The texture to use for multiplying the intensity of the subsurface scattering tr .. rst-class:: classref-property-setget -- void **set_texture_filter** **(** :ref:`TextureFilter` value **)** -- :ref:`TextureFilter` **get_texture_filter** **(** **)** +- |void| **set_texture_filter**\ (\ value\: :ref:`TextureFilter`\ ) +- :ref:`TextureFilter` **get_texture_filter**\ (\ ) Filter flags for the texture. See :ref:`TextureFilter` for options. @@ -3143,8 +3143,8 @@ Filter flags for the texture. See :ref:`TextureFilter` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| Repeat flags for the texture. See :ref:`TextureFilter` for options. @@ -3160,8 +3160,8 @@ Repeat flags for the texture. See :ref:`TextureFilter` value **)** -- :ref:`Transparency` **get_transparency** **(** **)** +- |void| **set_transparency**\ (\ value\: :ref:`Transparency`\ ) +- :ref:`Transparency` **get_transparency**\ (\ ) The material's transparency mode. Some transparency modes will disable shadow casting. Any transparency mode other than :ref:`TRANSPARENCY_DISABLED` has a greater performance impact compared to opaque rendering. See also :ref:`blend_mode`. @@ -3177,8 +3177,8 @@ The material's transparency mode. Some transparency modes will disable shadow ca .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, enables parts of the shader required for :ref:`GPUParticles3D` trails to function. This also requires using a mesh with appropriate skinning, such as :ref:`RibbonTrailMesh` or :ref:`TubeTrailMesh`. Enabling this feature outside of materials used in :ref:`GPUParticles3D` meshes will break material rendering. @@ -3194,8 +3194,8 @@ If ``true``, enables parts of the shader required for :ref:`GPUParticles3D` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, render point size can be changed. @@ -3213,8 +3213,8 @@ If ``true``, render point size can be changed. .. rst-class:: classref-property-setget -- void **set_uv1_offset** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_uv1_offset** **(** **)** +- |void| **set_uv1_offset**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_uv1_offset**\ (\ ) How much to offset the ``UV`` coordinates. This amount will be added to ``UV`` in the vertex function. This can be used to offset a texture. The Z component is used when :ref:`uv1_triplanar` is enabled, but it is not used anywhere else. @@ -3230,8 +3230,8 @@ How much to offset the ``UV`` coordinates. This amount will be added to ``UV`` i .. rst-class:: classref-property-setget -- void **set_uv1_scale** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_uv1_scale** **(** **)** +- |void| **set_uv1_scale**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_uv1_scale**\ (\ ) How much to scale the ``UV`` coordinates. This is multiplied by ``UV`` in the vertex function. The Z component is used when :ref:`uv1_triplanar` is enabled, but it is not used anywhere else. @@ -3247,8 +3247,8 @@ How much to scale the ``UV`` coordinates. This is multiplied by ``UV`` in the ve .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, instead of using ``UV`` textures will use a triplanar texture lookup to determine how to apply textures. Triplanar uses the orientation of the object's surface to blend between texture coordinates. It reads from the source texture 3 times, once for each axis and then blends between the results based on how closely the pixel aligns with each axis. This is often used for natural features to get a realistic blend of materials. Because triplanar texturing requires many more texture reads per-pixel it is much slower than normal UV texturing. Additionally, because it is blending the texture between the three axes, it is unsuitable when you are trying to achieve crisp texturing. @@ -3264,8 +3264,8 @@ If ``true``, instead of using ``UV`` textures will use a triplanar texture looku .. rst-class:: classref-property-setget -- void **set_uv1_triplanar_blend_sharpness** **(** :ref:`float` value **)** -- :ref:`float` **get_uv1_triplanar_blend_sharpness** **(** **)** +- |void| **set_uv1_triplanar_blend_sharpness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_uv1_triplanar_blend_sharpness**\ (\ ) A lower number blends the texture more softly while a higher number blends the texture more sharply. @@ -3283,8 +3283,8 @@ A lower number blends the texture more softly while a higher number blends the t .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, triplanar mapping for ``UV`` is calculated in world space rather than object local space. See also :ref:`uv1_triplanar`. @@ -3300,8 +3300,8 @@ If ``true``, triplanar mapping for ``UV`` is calculated in world space rather th .. rst-class:: classref-property-setget -- void **set_uv2_offset** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_uv2_offset** **(** **)** +- |void| **set_uv2_offset**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_uv2_offset**\ (\ ) How much to offset the ``UV2`` coordinates. This amount will be added to ``UV2`` in the vertex function. This can be used to offset a texture. The Z component is used when :ref:`uv2_triplanar` is enabled, but it is not used anywhere else. @@ -3317,8 +3317,8 @@ How much to offset the ``UV2`` coordinates. This amount will be added to ``UV2`` .. rst-class:: classref-property-setget -- void **set_uv2_scale** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_uv2_scale** **(** **)** +- |void| **set_uv2_scale**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_uv2_scale**\ (\ ) How much to scale the ``UV2`` coordinates. This is multiplied by ``UV2`` in the vertex function. The Z component is used when :ref:`uv2_triplanar` is enabled, but it is not used anywhere else. @@ -3334,8 +3334,8 @@ How much to scale the ``UV2`` coordinates. This is multiplied by ``UV2`` in the .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, instead of using ``UV2`` textures will use a triplanar texture lookup to determine how to apply textures. Triplanar uses the orientation of the object's surface to blend between texture coordinates. It reads from the source texture 3 times, once for each axis and then blends between the results based on how closely the pixel aligns with each axis. This is often used for natural features to get a realistic blend of materials. Because triplanar texturing requires many more texture reads per-pixel it is much slower than normal UV texturing. Additionally, because it is blending the texture between the three axes, it is unsuitable when you are trying to achieve crisp texturing. @@ -3351,8 +3351,8 @@ If ``true``, instead of using ``UV2`` textures will use a triplanar texture look .. rst-class:: classref-property-setget -- void **set_uv2_triplanar_blend_sharpness** **(** :ref:`float` value **)** -- :ref:`float` **get_uv2_triplanar_blend_sharpness** **(** **)** +- |void| **set_uv2_triplanar_blend_sharpness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_uv2_triplanar_blend_sharpness**\ (\ ) A lower number blends the texture more softly while a higher number blends the texture more sharply. @@ -3370,8 +3370,8 @@ A lower number blends the texture more softly while a higher number blends the t .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, triplanar mapping for ``UV2`` is calculated in world space rather than object local space. See also :ref:`uv2_triplanar`. @@ -3387,8 +3387,8 @@ If ``true``, triplanar mapping for ``UV2`` is calculated in world space rather t .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, vertex colors are considered to be stored in sRGB color space and are converted to linear color space during rendering. If ``false``, vertex colors are considered to be stored in linear color space and are rendered as-is. See also :ref:`albedo_texture_force_srgb`. @@ -3406,8 +3406,8 @@ If ``true``, vertex colors are considered to be stored in sRGB color space and a .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, the vertex color is used as albedo color. @@ -3424,7 +3424,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| +:ref:`bool` **get_feature**\ (\ feature\: :ref:`Feature`\ ) |const| Returns ``true``, if the specified :ref:`Feature` is enabled. @@ -3436,7 +3436,7 @@ Returns ``true``, if the specified :ref:`Feature` i .. rst-class:: classref-method -:ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +:ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| Returns ``true``, if the specified flag is enabled. See :ref:`Flags` enumerator for options. @@ -3448,7 +3448,7 @@ Returns ``true``, if the specified flag is enabled. See :ref:`Flags` **get_texture** **(** :ref:`TextureParam` param **)** |const| +:ref:`Texture2D` **get_texture**\ (\ param\: :ref:`TextureParam`\ ) |const| Returns the :ref:`Texture2D` associated with the specified :ref:`TextureParam`. @@ -3460,7 +3460,7 @@ Returns the :ref:`Texture2D` associated with the specified :ref .. rst-class:: classref-method -void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** +|void| **set_feature**\ (\ feature\: :ref:`Feature`, enable\: :ref:`bool`\ ) If ``true``, enables the specified :ref:`Feature`. Many features that are available in **BaseMaterial3D**\ s need to be enabled before use. This way the cost for using the feature is only incurred when specified. Features can also be enabled by setting the corresponding member to ``true``. @@ -3472,7 +3472,7 @@ If ``true``, enables the specified :ref:`Feature`. .. rst-class:: classref-method -void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +|void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) If ``true``, enables the specified flag. Flags are optional behavior that can be turned on and off. Only one flag can be enabled at a time with this function, the flag enumerators cannot be bit-masked together to enable or disable multiple flags at once. Flags can also be enabled by setting the corresponding member to ``true``. See :ref:`Flags` enumerator for options. @@ -3484,7 +3484,7 @@ If ``true``, enables the specified flag. Flags are optional behavior that can be .. rst-class:: classref-method -void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** +|void| **set_texture**\ (\ param\: :ref:`TextureParam`, texture\: :ref:`Texture2D`\ ) Sets the texture for the slot specified by ``param``. See :ref:`TextureParam` for available slots. @@ -3495,3 +3495,4 @@ Sets the texture for the slot specified by ``param``. See :ref:`TextureParam` | :ref:`Basis` **(** **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`Basis` **(** :ref:`Basis` from **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`Basis` **(** :ref:`Quaternion` from **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`Basis`\ (\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`Basis`\ (\ from\: :ref:`Basis`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`Basis`\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`Basis`\ (\ from\: :ref:`Quaternion`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`Basis`\ (\ x_axis\: :ref:`Vector3`, y_axis\: :ref:`Vector3`, z_axis\: :ref:`Vector3`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -96,45 +96,45 @@ Methods .. table:: :widths: auto - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`determinant` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`from_euler` **(** :ref:`Vector3` euler, :ref:`int` order=2 **)** |static| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`from_scale` **(** :ref:`Vector3` scale **)** |static| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_euler` **(** :ref:`int` order=2 **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`get_rotation_quaternion` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_scale` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`inverse` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_conformal` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Basis` b **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_finite` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`looking_at` **(** :ref:`Vector3` target, :ref:`Vector3` up=Vector3(0, 1, 0), :ref:`bool` use_model_front=false **)** |static| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`orthonormalized` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` angle **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`scaled` **(** :ref:`Vector3` scale **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`slerp` **(** :ref:`Basis` to, :ref:`float` weight **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`tdotx` **(** :ref:`Vector3` with **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`tdoty` **(** :ref:`Vector3` with **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`tdotz` **(** :ref:`Vector3` with **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`transposed` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`determinant`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`from_euler`\ (\ euler\: :ref:`Vector3`, order\: :ref:`int` = 2\ ) |static| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`from_scale`\ (\ scale\: :ref:`Vector3`\ ) |static| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_euler`\ (\ order\: :ref:`int` = 2\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`get_rotation_quaternion`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_scale`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`inverse`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_conformal`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equal_approx`\ (\ b\: :ref:`Basis`\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`looking_at`\ (\ target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) |static| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`orthonormalized`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`rotated`\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`scaled`\ (\ scale\: :ref:`Vector3`\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`slerp`\ (\ to\: :ref:`Basis`, weight\: :ref:`float`\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`tdotx`\ (\ with\: :ref:`Vector3`\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`tdoty`\ (\ with\: :ref:`Vector3`\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`tdotz`\ (\ with\: :ref:`Vector3`\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`transposed`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -144,25 +144,25 @@ Operators .. table:: :widths: auto - +-------------------------------+-----------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Basis` right **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`operator *` **(** :ref:`Basis` right **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator *` **(** :ref:`Vector3` right **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`operator *` **(** :ref:`float` right **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`operator *` **(** :ref:`int` right **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`operator /` **(** :ref:`float` right **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`operator /` **(** :ref:`int` right **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Basis` right **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator []` **(** :ref:`int` index **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------+ + +-------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Basis`\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`operator *`\ (\ right\: :ref:`Basis`\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator *`\ (\ right\: :ref:`Vector3`\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`operator *`\ (\ right\: :ref:`float`\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`operator *`\ (\ right\: :ref:`int`\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`operator /`\ (\ right\: :ref:`float`\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`operator /`\ (\ right\: :ref:`int`\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Basis`\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -292,7 +292,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Basis` **Basis** **(** **)** +:ref:`Basis` **Basis**\ (\ ) Constructs a **Basis** identical to the :ref:`IDENTITY`. @@ -302,7 +302,7 @@ Constructs a **Basis** identical to the :ref:`IDENTITY` **Basis** **(** :ref:`Basis` from **)** +:ref:`Basis` **Basis**\ (\ from\: :ref:`Basis`\ ) Constructs a **Basis** as a copy of the given **Basis**. @@ -312,7 +312,7 @@ Constructs a **Basis** as a copy of the given **Basis**. .. rst-class:: classref-constructor -:ref:`Basis` **Basis** **(** :ref:`Vector3` axis, :ref:`float` angle **)** +:ref:`Basis` **Basis**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) Constructs a **Basis** that only represents rotation, rotated around the ``axis`` by the given ``angle``, in radians. The axis must be a normalized vector. @@ -324,7 +324,7 @@ Constructs a **Basis** that only represents rotation, rotated around the ``axis` .. rst-class:: classref-constructor -:ref:`Basis` **Basis** **(** :ref:`Quaternion` from **)** +:ref:`Basis` **Basis**\ (\ from\: :ref:`Quaternion`\ ) Constructs a **Basis** that only represents rotation from the given :ref:`Quaternion`. @@ -336,7 +336,7 @@ Constructs a **Basis** that only represents rotation from the given :ref:`Quater .. rst-class:: classref-constructor -:ref:`Basis` **Basis** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** +:ref:`Basis` **Basis**\ (\ x_axis\: :ref:`Vector3`, y_axis\: :ref:`Vector3`, z_axis\: :ref:`Vector3`\ ) Constructs a **Basis** from 3 axis vectors. These are the columns of the basis matrix. @@ -353,7 +353,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **determinant** **(** **)** |const| +:ref:`float` **determinant**\ (\ ) |const| Returns the `determinant `__ of this basis's matrix. For advanced math, this number can be used to determine a few attributes: @@ -371,7 +371,7 @@ Returns the `determinant `__ of this .. rst-class:: classref-method -:ref:`Basis` **from_euler** **(** :ref:`Vector3` euler, :ref:`int` order=2 **)** |static| +:ref:`Basis` **from_euler**\ (\ euler\: :ref:`Vector3`, order\: :ref:`int` = 2\ ) |static| Constructs a new **Basis** that only represents rotation from the given :ref:`Vector3` of `Euler angles `__, in radians. @@ -410,7 +410,7 @@ The order of each consecutive rotation can be changed with ``order`` (see :ref:` .. rst-class:: classref-method -:ref:`Basis` **from_scale** **(** :ref:`Vector3` scale **)** |static| +:ref:`Basis` **from_scale**\ (\ scale\: :ref:`Vector3`\ ) |static| Constructs a new **Basis** that only represents scale, with no rotation or shear, from the given ``scale`` vector. @@ -445,7 +445,7 @@ Constructs a new **Basis** that only represents scale, with no rotation or shear .. rst-class:: classref-method -:ref:`Vector3` **get_euler** **(** :ref:`int` order=2 **)** |const| +:ref:`Vector3` **get_euler**\ (\ order\: :ref:`int` = 2\ ) |const| Returns this basis's rotation as a :ref:`Vector3` of `Euler angles `__, in radians. @@ -469,7 +469,7 @@ The order of each consecutive rotation can be changed with ``order`` (see :ref:` .. rst-class:: classref-method -:ref:`Quaternion` **get_rotation_quaternion** **(** **)** |const| +:ref:`Quaternion` **get_rotation_quaternion**\ (\ ) |const| Returns this basis's rotation as a :ref:`Quaternion`. @@ -483,7 +483,7 @@ Returns this basis's rotation as a :ref:`Quaternion`. .. rst-class:: classref-method -:ref:`Vector3` **get_scale** **(** **)** |const| +:ref:`Vector3` **get_scale**\ (\ ) |const| 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. @@ -528,7 +528,7 @@ Returns the length of each axis of this basis, as a :ref:`Vector3 .. rst-class:: classref-method -:ref:`Basis` **inverse** **(** **)** |const| +:ref:`Basis` **inverse**\ (\ ) |const| Returns the `inverse of this basis's matrix `__. @@ -540,7 +540,7 @@ Returns the `inverse of this basis's matrix ` **is_conformal** **(** **)** |const| +:ref:`bool` **is_conformal**\ (\ ) |const| 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. @@ -552,7 +552,7 @@ Returns ``true`` if this basis is conformal. A conformal basis is both *orthogon .. rst-class:: classref-method -:ref:`bool` **is_equal_approx** **(** :ref:`Basis` b **)** |const| +:ref:`bool` **is_equal_approx**\ (\ b\: :ref:`Basis`\ ) |const| Returns ``true`` if this basis and ``b`` are approximately equal, by calling :ref:`@GlobalScope.is_equal_approx` on all vector components. @@ -564,7 +564,7 @@ Returns ``true`` if this basis and ``b`` are approximately equal, by calling :re .. rst-class:: classref-method -:ref:`bool` **is_finite** **(** **)** |const| +:ref:`bool` **is_finite**\ (\ ) |const| Returns ``true`` if this basis is finite, by calling :ref:`@GlobalScope.is_finite` on all vector components. @@ -576,7 +576,7 @@ Returns ``true`` if this basis is finite, by calling :ref:`@GlobalScope.is_finit .. rst-class:: classref-method -:ref:`Basis` **looking_at** **(** :ref:`Vector3` target, :ref:`Vector3` up=Vector3(0, 1, 0), :ref:`bool` use_model_front=false **)** |static| +:ref:`Basis` **looking_at**\ (\ target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) |static| Creates a new **Basis** with a rotation such that the forward axis (-Z) points towards the ``target`` position. @@ -592,7 +592,7 @@ The up axis (+Y) points as close to the ``up`` vector as possible while staying .. rst-class:: classref-method -:ref:`Basis` **orthonormalized** **(** **)** |const| +:ref:`Basis` **orthonormalized**\ (\ ) |const| 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. @@ -630,7 +630,7 @@ It is often useful to call this method to avoid rounding errors on a rotating ba .. rst-class:: classref-method -:ref:`Basis` **rotated** **(** :ref:`Vector3` axis, :ref:`float` angle **)** |const| +:ref:`Basis` **rotated**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| Returns this basis rotated around the given ``axis`` by ``angle`` (in radians). The ``axis`` must be a normalized vector (see :ref:`Vector3.normalized`). @@ -667,7 +667,7 @@ Positive values rotate this basis clockwise around the axis, while negative valu .. rst-class:: classref-method -:ref:`Basis` **scaled** **(** :ref:`Vector3` scale **)** |const| +:ref:`Basis` **scaled**\ (\ scale\: :ref:`Vector3`\ ) |const| Returns this basis with each axis's components scaled by the given ``scale``'s components. @@ -712,7 +712,7 @@ The basis matrix's rows are multiplied by ``scale``'s components. This operation .. rst-class:: classref-method -:ref:`Basis` **slerp** **(** :ref:`Basis` to, :ref:`float` weight **)** |const| +:ref:`Basis` **slerp**\ (\ to\: :ref:`Basis`, weight\: :ref:`float`\ ) |const| Performs a spherical-linear interpolation with the ``to`` basis, given a ``weight``. Both this basis and ``to`` should represent a rotation. @@ -737,7 +737,7 @@ Performs a spherical-linear interpolation with the ``to`` basis, given a ``weigh .. rst-class:: classref-method -:ref:`float` **tdotx** **(** :ref:`Vector3` with **)** |const| +:ref:`float` **tdotx**\ (\ with\: :ref:`Vector3`\ ) |const| Returns the transposed dot product between ``with`` and the :ref:`x` axis (see :ref:`transposed`). @@ -751,7 +751,7 @@ This is equivalent to ``basis.x.dot(vector)``. .. rst-class:: classref-method -:ref:`float` **tdoty** **(** :ref:`Vector3` with **)** |const| +:ref:`float` **tdoty**\ (\ with\: :ref:`Vector3`\ ) |const| Returns the transposed dot product between ``with`` and the :ref:`y` axis (see :ref:`transposed`). @@ -765,7 +765,7 @@ This is equivalent to ``basis.y.dot(vector)``. .. rst-class:: classref-method -:ref:`float` **tdotz** **(** :ref:`Vector3` with **)** |const| +:ref:`float` **tdotz**\ (\ with\: :ref:`Vector3`\ ) |const| Returns the transposed dot product between ``with`` and the :ref:`z` axis (see :ref:`transposed`). @@ -779,7 +779,7 @@ This is equivalent to ``basis.z.dot(vector)``. .. rst-class:: classref-method -:ref:`Basis` **transposed** **(** **)** |const| +:ref:`Basis` **transposed**\ (\ ) |const| Returns the transposed version of this basis. This turns the basis matrix's columns into rows, and its rows into columns. @@ -827,7 +827,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Basis` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Basis`\ ) Returns ``true`` if the components of both **Basis** matrices are not equal. @@ -841,7 +841,7 @@ Returns ``true`` if the components of both **Basis** matrices are not equal. .. rst-class:: classref-operator -:ref:`Basis` **operator *** **(** :ref:`Basis` right **)** +:ref:`Basis` **operator ***\ (\ right\: :ref:`Basis`\ ) Transforms (multiplies) the ``right`` basis by this basis. @@ -855,7 +855,7 @@ This is the operation performed between parent and child :ref:`Node3D` **operator *** **(** :ref:`Vector3` right **)** +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3`\ ) Transforms (multiplies) the ``right`` vector by this basis, returning a :ref:`Vector3`. @@ -882,7 +882,7 @@ Transforms (multiplies) the ``right`` vector by this basis, returning a :ref:`Ve .. rst-class:: classref-operator -:ref:`Basis` **operator *** **(** :ref:`float` right **)** +:ref:`Basis` **operator ***\ (\ right\: :ref:`float`\ ) 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. @@ -894,7 +894,7 @@ Multiplies all components of the **Basis** by the given :ref:`float .. rst-class:: classref-operator -:ref:`Basis` **operator *** **(** :ref:`int` right **)** +:ref:`Basis` **operator ***\ (\ right\: :ref:`int`\ ) 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. @@ -906,7 +906,7 @@ Multiplies all components of the **Basis** by the given :ref:`int`. T .. rst-class:: classref-operator -:ref:`Basis` **operator /** **(** :ref:`float` right **)** +:ref:`Basis` **operator /**\ (\ right\: :ref:`float`\ ) Divides 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. @@ -918,7 +918,7 @@ Divides all components of the **Basis** by the given :ref:`float`. .. rst-class:: classref-operator -:ref:`Basis` **operator /** **(** :ref:`int` right **)** +:ref:`Basis` **operator /**\ (\ right\: :ref:`int`\ ) Divides 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. @@ -930,7 +930,7 @@ Divides all components of the **Basis** by the given :ref:`int`. This .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`Basis` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Basis`\ ) Returns ``true`` if the components of both **Basis** matrices are exactly equal. @@ -944,7 +944,7 @@ Returns ``true`` if the components of both **Basis** matrices are exactly equal. .. rst-class:: classref-operator -:ref:`Vector3` **operator []** **(** :ref:`int` index **)** +:ref:`Vector3` **operator []**\ (\ index\: :ref:`int`\ ) 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`. @@ -957,3 +957,4 @@ Accesses each axis (column) of this basis by their index. Index ``0`` is the sam .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index 6ad3f5e32f9..3921c5ae443 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -29,33 +29,33 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`convert_to_image` **(** **)** |const| | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create` **(** :ref:`Vector2i` size **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_from_image_alpha` **(** :ref:`Image` image, :ref:`float` threshold=0.1 **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_bit` **(** :ref:`int` x, :ref:`int` y **)** |const| | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_bitv` **(** :ref:`Vector2i` position **)** |const| | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_size` **(** **)** |const| | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_true_bit_count` **(** **)** |const| | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`grow_mask` **(** :ref:`int` pixels, :ref:`Rect2i` rect **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array[]` | :ref:`opaque_to_polygons` **(** :ref:`Rect2i` rect, :ref:`float` epsilon=2.0 **)** |const| | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`resize` **(** :ref:`Vector2i` new_size **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bit` **(** :ref:`int` x, :ref:`int` y, :ref:`bool` bit **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bit_rect` **(** :ref:`Rect2i` rect, :ref:`bool` bit **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bitv` **(** :ref:`Vector2i` position, :ref:`bool` bit **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`convert_to_image`\ (\ ) |const| | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create`\ (\ size\: :ref:`Vector2i`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_from_image_alpha`\ (\ image\: :ref:`Image`, threshold\: :ref:`float` = 0.1\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_bit`\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_bitv`\ (\ position\: :ref:`Vector2i`\ ) |const| | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_size`\ (\ ) |const| | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_true_bit_count`\ (\ ) |const| | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`grow_mask`\ (\ pixels\: :ref:`int`, rect\: :ref:`Rect2i`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`PackedVector2Array`\] | :ref:`opaque_to_polygons`\ (\ rect\: :ref:`Rect2i`, epsilon\: :ref:`float` = 2.0\ ) |const| | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`resize`\ (\ new_size\: :ref:`Vector2i`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bit`\ (\ x\: :ref:`int`, y\: :ref:`int`, bit\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bit_rect`\ (\ rect\: :ref:`Rect2i`, bit\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bitv`\ (\ position\: :ref:`Vector2i`, bit\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -70,7 +70,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Image` **convert_to_image** **(** **)** |const| +:ref:`Image` **convert_to_image**\ (\ ) |const| Returns an image of the same size as the bitmap and with a :ref:`Format` of type :ref:`Image.FORMAT_L8`. ``true`` bits of the bitmap are being converted into white pixels, and ``false`` bits into black. @@ -82,7 +82,7 @@ Returns an image of the same size as the bitmap and with a :ref:`Format` size **)** +|void| **create**\ (\ size\: :ref:`Vector2i`\ ) Creates a bitmap with the specified size, filled with ``false``. @@ -94,7 +94,7 @@ Creates a bitmap with the specified size, filled with ``false``. .. rst-class:: classref-method -void **create_from_image_alpha** **(** :ref:`Image` image, :ref:`float` threshold=0.1 **)** +|void| **create_from_image_alpha**\ (\ image\: :ref:`Image`, threshold\: :ref:`float` = 0.1\ ) Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to ``false`` if the alpha value of the image at that position is equal to ``threshold`` or less, and ``true`` in other case. @@ -106,7 +106,7 @@ Creates a bitmap that matches the given image dimensions, every element of the b .. rst-class:: classref-method -:ref:`bool` **get_bit** **(** :ref:`int` x, :ref:`int` y **)** |const| +:ref:`bool` **get_bit**\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) |const| Returns bitmap's value at the specified position. @@ -118,7 +118,7 @@ Returns bitmap's value at the specified position. .. rst-class:: classref-method -:ref:`bool` **get_bitv** **(** :ref:`Vector2i` position **)** |const| +:ref:`bool` **get_bitv**\ (\ position\: :ref:`Vector2i`\ ) |const| Returns bitmap's value at the specified position. @@ -130,7 +130,7 @@ Returns bitmap's value at the specified position. .. rst-class:: classref-method -:ref:`Vector2i` **get_size** **(** **)** |const| +:ref:`Vector2i` **get_size**\ (\ ) |const| Returns bitmap's dimensions. @@ -142,7 +142,7 @@ Returns bitmap's dimensions. .. rst-class:: classref-method -:ref:`int` **get_true_bit_count** **(** **)** |const| +:ref:`int` **get_true_bit_count**\ (\ ) |const| Returns the number of bitmap elements that are set to ``true``. @@ -154,7 +154,7 @@ Returns the number of bitmap elements that are set to ``true``. .. rst-class:: classref-method -void **grow_mask** **(** :ref:`int` pixels, :ref:`Rect2i` rect **)** +|void| **grow_mask**\ (\ pixels\: :ref:`int`, rect\: :ref:`Rect2i`\ ) Applies morphological dilation or erosion to the bitmap. If ``pixels`` is positive, dilation is applied to the bitmap. If ``pixels`` is negative, erosion is applied to the bitmap. ``rect`` defines the area where the morphological operation is applied. Pixels located outside the ``rect`` are unaffected by :ref:`grow_mask`. @@ -166,7 +166,7 @@ Applies morphological dilation or erosion to the bitmap. If ``pixels`` is positi .. rst-class:: classref-method -:ref:`PackedVector2Array[]` **opaque_to_polygons** **(** :ref:`Rect2i` rect, :ref:`float` epsilon=2.0 **)** |const| +:ref:`Array`\[:ref:`PackedVector2Array`\] **opaque_to_polygons**\ (\ rect\: :ref:`Rect2i`, epsilon\: :ref:`float` = 2.0\ ) |const| Creates an :ref:`Array` of polygons covering a rectangular portion of the bitmap. It uses a marching squares algorithm, followed by Ramer-Douglas-Peucker (RDP) reduction of the number of vertices. Each polygon is described as a :ref:`PackedVector2Array` of its vertices. @@ -186,7 +186,7 @@ To get polygons covering the whole bitmap, pass: .. rst-class:: classref-method -void **resize** **(** :ref:`Vector2i` new_size **)** +|void| **resize**\ (\ new_size\: :ref:`Vector2i`\ ) Resizes the image to ``new_size``. @@ -198,7 +198,7 @@ Resizes the image to ``new_size``. .. rst-class:: classref-method -void **set_bit** **(** :ref:`int` x, :ref:`int` y, :ref:`bool` bit **)** +|void| **set_bit**\ (\ x\: :ref:`int`, y\: :ref:`int`, bit\: :ref:`bool`\ ) Sets the bitmap's element at the specified position, to the specified value. @@ -210,7 +210,7 @@ Sets the bitmap's element at the specified position, to the specified value. .. rst-class:: classref-method -void **set_bit_rect** **(** :ref:`Rect2i` rect, :ref:`bool` bit **)** +|void| **set_bit_rect**\ (\ rect\: :ref:`Rect2i`, bit\: :ref:`bool`\ ) Sets a rectangular portion of the bitmap to the specified value. @@ -222,7 +222,7 @@ Sets a rectangular portion of the bitmap to the specified value. .. rst-class:: classref-method -void **set_bitv** **(** :ref:`Vector2i` position, :ref:`bool` bit **)** +|void| **set_bitv**\ (\ position\: :ref:`Vector2i`, bit\: :ref:`bool`\ ) Sets the bitmap's element at the specified position, to the specified value. @@ -233,3 +233,4 @@ Sets the bitmap's element at the specified position, to the specified value. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_bone2d.rst b/classes/class_bone2d.rst index 6b1e6cb6699..cdd73514b34 100644 --- a/classes/class_bone2d.rst +++ b/classes/class_bone2d.rst @@ -47,25 +47,25 @@ Methods .. table:: :widths: auto - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_rest` **(** **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_autocalculate_length_and_angle` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_bone_angle` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_index_in_skeleton` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_length` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_skeleton_rest` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_autocalculate_length_and_angle` **(** :ref:`bool` auto_calculate **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bone_angle` **(** :ref:`float` angle **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_length` **(** :ref:`float` length **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_rest`\ (\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_autocalculate_length_and_angle`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_bone_angle`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_index_in_skeleton`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_length`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_skeleton_rest`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_autocalculate_length_and_angle`\ (\ auto_calculate\: :ref:`bool`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bone_angle`\ (\ angle\: :ref:`float`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_length`\ (\ length\: :ref:`float`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -84,8 +84,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_rest** **(** :ref:`Transform2D` value **)** -- :ref:`Transform2D` **get_rest** **(** **)** +- |void| **set_rest**\ (\ value\: :ref:`Transform2D`\ ) +- :ref:`Transform2D` **get_rest**\ (\ ) Rest transform of the bone. You can reset the node's transforms to this value using :ref:`apply_rest`. @@ -102,7 +102,7 @@ Method Descriptions .. rst-class:: classref-method -void **apply_rest** **(** **)** +|void| **apply_rest**\ (\ ) Resets the bone to the rest pose. This is equivalent to setting :ref:`Node2D.transform` to :ref:`rest`. @@ -114,7 +114,7 @@ Resets the bone to the rest pose. This is equivalent to setting :ref:`Node2D.tra .. rst-class:: classref-method -:ref:`bool` **get_autocalculate_length_and_angle** **(** **)** |const| +:ref:`bool` **get_autocalculate_length_and_angle**\ (\ ) |const| Returns whether this **Bone2D** is going to autocalculate its length and bone angle using its first **Bone2D** child node, if one exists. If there are no **Bone2D** children, then it cannot autocalculate these values and will print a warning. @@ -126,7 +126,7 @@ Returns whether this **Bone2D** is going to autocalculate its length and bone an .. rst-class:: classref-method -:ref:`float` **get_bone_angle** **(** **)** |const| +:ref:`float` **get_bone_angle**\ (\ ) |const| Returns the angle of the bone in the **Bone2D**. @@ -140,7 +140,7 @@ Returns the angle of the bone in the **Bone2D**. .. rst-class:: classref-method -:ref:`int` **get_index_in_skeleton** **(** **)** |const| +:ref:`int` **get_index_in_skeleton**\ (\ ) |const| Returns the node's index as part of the entire skeleton. See :ref:`Skeleton2D`. @@ -152,7 +152,7 @@ Returns the node's index as part of the entire skeleton. See :ref:`Skeleton2D` **get_length** **(** **)** |const| +:ref:`float` **get_length**\ (\ ) |const| Returns the length of the bone in the **Bone2D** node. @@ -164,7 +164,7 @@ Returns the length of the bone in the **Bone2D** node. .. rst-class:: classref-method -:ref:`Transform2D` **get_skeleton_rest** **(** **)** |const| +:ref:`Transform2D` **get_skeleton_rest**\ (\ ) |const| Returns the node's :ref:`rest` :ref:`Transform2D` if it doesn't have a parent, or its rest pose relative to its parent. @@ -176,7 +176,7 @@ Returns the node's :ref:`rest` :ref:`Transform2D` auto_calculate **)** +|void| **set_autocalculate_length_and_angle**\ (\ auto_calculate\: :ref:`bool`\ ) When set to ``true``, the **Bone2D** node will attempt to automatically calculate the bone angle and length using the first child **Bone2D** node, if one exists. If none exist, the **Bone2D** cannot automatically calculate these values and will print a warning. @@ -188,7 +188,7 @@ When set to ``true``, the **Bone2D** node will attempt to automatically calculat .. rst-class:: classref-method -void **set_bone_angle** **(** :ref:`float` angle **)** +|void| **set_bone_angle**\ (\ angle\: :ref:`float`\ ) Sets the bone angle for the **Bone2D**. This is typically set to the rotation from the **Bone2D** to a child **Bone2D** node. @@ -202,7 +202,7 @@ Sets the bone angle for the **Bone2D**. This is typically set to the rotation fr .. rst-class:: classref-method -void **set_length** **(** :ref:`float` length **)** +|void| **set_length**\ (\ length\: :ref:`float`\ ) Sets the length of the bone in the **Bone2D**. @@ -213,3 +213,4 @@ Sets the length of the bone in the **Bone2D**. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_boneattachment3d.rst b/classes/class_boneattachment3d.rst index 5e1b43e35bc..727d5ac0694 100644 --- a/classes/class_boneattachment3d.rst +++ b/classes/class_boneattachment3d.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: tag + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -45,17 +48,17 @@ Methods .. table:: :widths: auto - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_external_skeleton` **(** **)** |const| | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_use_external_skeleton` **(** **)** |const| | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`on_bone_pose_update` **(** :ref:`int` bone_index **)** | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_external_skeleton` **(** :ref:`NodePath` external_skeleton **)** | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_use_external_skeleton` **(** :ref:`bool` use_external_skeleton **)** | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_external_skeleton`\ (\ ) |const| | + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_use_external_skeleton`\ (\ ) |const| | + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`on_bone_pose_update`\ (\ bone_index\: :ref:`int`\ ) | + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_external_skeleton`\ (\ external_skeleton\: :ref:`NodePath`\ ) | + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_use_external_skeleton`\ (\ use_external_skeleton\: :ref:`bool`\ ) | + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -74,8 +77,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bone_idx** **(** :ref:`int` value **)** -- :ref:`int` **get_bone_idx** **(** **)** +- |void| **set_bone_idx**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_bone_idx**\ (\ ) The index of the attached bone. @@ -91,8 +94,8 @@ The index of the attached bone. .. rst-class:: classref-property-setget -- void **set_bone_name** **(** :ref:`String` value **)** -- :ref:`String` **get_bone_name** **(** **)** +- |void| **set_bone_name**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_bone_name**\ (\ ) The name of the attached bone. @@ -108,8 +111,8 @@ The name of the attached bone. .. rst-class:: classref-property-setget -- void **set_override_pose** **(** :ref:`bool` value **)** -- :ref:`bool` **get_override_pose** **(** **)** +- |void| **set_override_pose**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_override_pose**\ (\ ) Whether the BoneAttachment3D node will override the bone pose of the bone it is attached to. When set to ``true``, the BoneAttachment3D node can change the pose of the bone. When set to ``false``, the BoneAttachment3D will always be set to the bone's transform. @@ -126,7 +129,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`NodePath` **get_external_skeleton** **(** **)** |const| +:ref:`NodePath` **get_external_skeleton**\ (\ ) |const| Returns the :ref:`NodePath` to the external :ref:`Skeleton3D` node, if one has been set. @@ -138,7 +141,7 @@ Returns the :ref:`NodePath` to the external :ref:`Skeleton3D` **get_use_external_skeleton** **(** **)** |const| +:ref:`bool` **get_use_external_skeleton**\ (\ ) |const| Returns whether the BoneAttachment3D node is using an external :ref:`Skeleton3D` rather than attempting to use its parent node as the :ref:`Skeleton3D`. @@ -150,7 +153,7 @@ Returns whether the BoneAttachment3D node is using an external :ref:`Skeleton3D< .. rst-class:: classref-method -void **on_bone_pose_update** **(** :ref:`int` bone_index **)** +|void| **on_bone_pose_update**\ (\ bone_index\: :ref:`int`\ ) A function that is called automatically when the :ref:`Skeleton3D` the BoneAttachment3D node is using has a bone that has changed its pose. This function is where the BoneAttachment3D node updates its position so it is correctly bound when it is *not* set to override the bone pose. @@ -162,7 +165,7 @@ A function that is called automatically when the :ref:`Skeleton3D` external_skeleton **)** +|void| **set_external_skeleton**\ (\ external_skeleton\: :ref:`NodePath`\ ) Sets the :ref:`NodePath` to the external skeleton that the BoneAttachment3D node should use. See :ref:`set_use_external_skeleton` to enable the external :ref:`Skeleton3D` node. @@ -174,7 +177,7 @@ Sets the :ref:`NodePath` to the external skeleton that the BoneA .. rst-class:: classref-method -void **set_use_external_skeleton** **(** :ref:`bool` use_external_skeleton **)** +|void| **set_use_external_skeleton**\ (\ use_external_skeleton\: :ref:`bool`\ ) Sets whether the BoneAttachment3D node will use an external :ref:`Skeleton3D` node rather than attempting to use its parent node as the :ref:`Skeleton3D`. When set to ``true``, the BoneAttachment3D node will use the external :ref:`Skeleton3D` node set in :ref:`set_external_skeleton`. @@ -185,3 +188,4 @@ Sets whether the BoneAttachment3D node will use an external :ref:`Skeleton3D` | :ref:`find_profile_bone_name` **(** :ref:`StringName` skeleton_bone_name **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_skeleton_bone_name` **(** :ref:`StringName` profile_bone_name **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_skeleton_bone_name` **(** :ref:`StringName` profile_bone_name, :ref:`StringName` skeleton_bone_name **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`find_profile_bone_name`\ (\ skeleton_bone_name\: :ref:`StringName`\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_skeleton_bone_name`\ (\ profile_bone_name\: :ref:`StringName`\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_skeleton_bone_name`\ (\ profile_bone_name\: :ref:`StringName`, skeleton_bone_name\: :ref:`StringName`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -71,7 +71,7 @@ Signals .. rst-class:: classref-signal -**bone_map_updated** **(** **)** +**bone_map_updated**\ (\ ) This signal is emitted when change the key value in the **BoneMap**. This is used to validate mapping and to update **BoneMap** editor. @@ -83,7 +83,7 @@ This signal is emitted when change the key value in the **BoneMap**. This is use .. rst-class:: classref-signal -**profile_updated** **(** **)** +**profile_updated**\ (\ ) This signal is emitted when change the value in profile or change the reference of profile. This is used to update key names in the **BoneMap** and to redraw the **BoneMap** editor. @@ -104,8 +104,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_profile** **(** :ref:`SkeletonProfile` value **)** -- :ref:`SkeletonProfile` **get_profile** **(** **)** +- |void| **set_profile**\ (\ value\: :ref:`SkeletonProfile`\ ) +- :ref:`SkeletonProfile` **get_profile**\ (\ ) A :ref:`SkeletonProfile` of the mapping target. Key names in the **BoneMap** are synchronized with it. @@ -122,7 +122,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`StringName` **find_profile_bone_name** **(** :ref:`StringName` skeleton_bone_name **)** |const| +:ref:`StringName` **find_profile_bone_name**\ (\ skeleton_bone_name\: :ref:`StringName`\ ) |const| Returns a profile bone name having ``skeleton_bone_name``. If not found, an empty :ref:`StringName` will be returned. @@ -136,7 +136,7 @@ In the retargeting process, the returned bone name is the bone name of the targe .. rst-class:: classref-method -:ref:`StringName` **get_skeleton_bone_name** **(** :ref:`StringName` profile_bone_name **)** |const| +:ref:`StringName` **get_skeleton_bone_name**\ (\ profile_bone_name\: :ref:`StringName`\ ) |const| Returns a skeleton bone name is mapped to ``profile_bone_name``. @@ -150,7 +150,7 @@ In the retargeting process, the returned bone name is the bone name of the sourc .. rst-class:: classref-method -void **set_skeleton_bone_name** **(** :ref:`StringName` profile_bone_name, :ref:`StringName` skeleton_bone_name **)** +|void| **set_skeleton_bone_name**\ (\ profile_bone_name\: :ref:`StringName`, skeleton_bone_name\: :ref:`StringName`\ ) Maps a skeleton bone name to ``profile_bone_name``. @@ -163,3 +163,4 @@ In the retargeting process, the setting bone name is the bone name of the source .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_bool.rst b/classes/class_bool.rst index 8ae33e6c036..11cad195b4f 100644 --- a/classes/class_bool.rst +++ b/classes/class_bool.rst @@ -81,15 +81,15 @@ Constructors .. table:: :widths: auto - +-------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`bool` **(** **)** | - +-------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`bool` **(** :ref:`bool` from **)** | - +-------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`bool` **(** :ref:`float` from **)** | - +-------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`bool` **(** :ref:`int` from **)** | - +-------------------------+-------------------------------------------------------------------------------------+ + +-------------------------+----------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`bool`\ (\ ) | + +-------------------------+----------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`bool`\ (\ from\: :ref:`bool`\ ) | + +-------------------------+----------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`bool`\ (\ from\: :ref:`float`\ ) | + +-------------------------+----------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`bool`\ (\ from\: :ref:`int`\ ) | + +-------------------------+----------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -99,15 +99,15 @@ Operators .. table:: :widths: auto - +-------------------------+--------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`bool` right **)** | - +-------------------------+--------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<` **(** :ref:`bool` right **)** | - +-------------------------+--------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`bool` right **)** | - +-------------------------+--------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >` **(** :ref:`bool` right **)** | - +-------------------------+--------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`bool`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<`\ (\ right\: :ref:`bool`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`bool`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >`\ (\ right\: :ref:`bool`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -122,7 +122,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`bool` **bool** **(** **)** +:ref:`bool` **bool**\ (\ ) Constructs a **bool** set to ``false``. @@ -132,7 +132,7 @@ Constructs a **bool** set to ``false``. .. rst-class:: classref-constructor -:ref:`bool` **bool** **(** :ref:`bool` from **)** +:ref:`bool` **bool**\ (\ from\: :ref:`bool`\ ) Constructs a **bool** as a copy of the given **bool**. @@ -142,7 +142,7 @@ Constructs a **bool** as a copy of the given **bool**. .. rst-class:: classref-constructor -:ref:`bool` **bool** **(** :ref:`float` from **)** +:ref:`bool` **bool**\ (\ from\: :ref:`float`\ ) Cast a :ref:`float` value to a boolean value. Returns ``false`` if ``from`` is equal to ``0.0`` (including ``-0.0``), and ``true`` for all other values (including :ref:`@GDScript.INF` and :ref:`@GDScript.NAN`). @@ -152,7 +152,7 @@ Cast a :ref:`float` value to a boolean value. Returns ``false`` if .. rst-class:: classref-constructor -:ref:`bool` **bool** **(** :ref:`int` from **)** +:ref:`bool` **bool**\ (\ from\: :ref:`int`\ ) Cast an :ref:`int` value to a boolean value. Returns ``false`` if ``from`` is equal to ``0``, and ``true`` for all other values. @@ -169,7 +169,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`bool` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`bool`\ ) Returns ``true`` if the two booleans are not equal. That is, one is ``true`` and the other is ``false``. This operation can be seen as a logical XOR. @@ -181,7 +181,7 @@ Returns ``true`` if the two booleans are not equal. That is, one is ``true`` and .. rst-class:: classref-operator -:ref:`bool` **operator <** **(** :ref:`bool` right **)** +:ref:`bool` **operator <**\ (\ right\: :ref:`bool`\ ) Returns ``true`` if the left operand is ``false`` and the right operand is ``true``. @@ -193,7 +193,7 @@ Returns ``true`` if the left operand is ``false`` and the right operand is ``tru .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`bool` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`bool`\ ) Returns ``true`` if the two booleans are equal. That is, both are ``true`` or both are ``false``. This operation can be seen as a logical EQ or XNOR. @@ -205,7 +205,7 @@ Returns ``true`` if the two booleans are equal. That is, both are ``true`` or bo .. rst-class:: classref-operator -:ref:`bool` **operator >** **(** :ref:`bool` right **)** +:ref:`bool` **operator >**\ (\ right\: :ref:`bool`\ ) Returns ``true`` if the left operand is ``true`` and the right operand is ``false``. @@ -216,3 +216,4 @@ Returns ``true`` if the left operand is ``true`` and the right operand is ``fals .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index acd05fb7838..20336ea66ca 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -52,9 +52,9 @@ Methods .. table:: :widths: auto - +-------------------------------+---------------------------------------------------------------------------------------------------+ - | :ref:`Control` | :ref:`add_spacer` **(** :ref:`bool` begin **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------+ + +-------------------------------+------------------------------------------------------------------------------------------------+ + | :ref:`Control` | :ref:`add_spacer`\ (\ begin\: :ref:`bool`\ ) | + +-------------------------------+------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -124,8 +124,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_alignment** **(** :ref:`AlignmentMode` value **)** -- :ref:`AlignmentMode` **get_alignment** **(** **)** +- |void| **set_alignment**\ (\ value\: :ref:`AlignmentMode`\ ) +- :ref:`AlignmentMode` **get_alignment**\ (\ ) The alignment of the container's children (must be one of :ref:`ALIGNMENT_BEGIN`, :ref:`ALIGNMENT_CENTER`, or :ref:`ALIGNMENT_END`). @@ -141,8 +141,8 @@ The alignment of the container's children (must be one of :ref:`ALIGNMENT_BEGIN< .. rst-class:: classref-property-setget -- void **set_vertical** **(** :ref:`bool` value **)** -- :ref:`bool` **is_vertical** **(** **)** +- |void| **set_vertical**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_vertical**\ (\ ) If ``true``, the **BoxContainer** will arrange its children vertically, rather than horizontally. @@ -161,7 +161,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Control` **add_spacer** **(** :ref:`bool` begin **)** +:ref:`Control` **add_spacer**\ (\ begin\: :ref:`bool`\ ) Adds a :ref:`Control` node to the box as a spacer. If ``begin`` is ``true``, it will insert the :ref:`Control` node in front of all other children. @@ -189,3 +189,4 @@ The space between the **BoxContainer**'s elements, in pixels. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_boxmesh.rst b/classes/class_boxmesh.rst index a4d69b3f0fb..164246af107 100644 --- a/classes/class_boxmesh.rst +++ b/classes/class_boxmesh.rst @@ -60,8 +60,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_size**\ (\ ) The box's width, height and depth. @@ -77,8 +77,8 @@ The box's width, height and depth. .. rst-class:: classref-property-setget -- void **set_subdivide_depth** **(** :ref:`int` value **)** -- :ref:`int` **get_subdivide_depth** **(** **)** +- |void| **set_subdivide_depth**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_subdivide_depth**\ (\ ) Number of extra edge loops inserted along the Z axis. @@ -94,8 +94,8 @@ Number of extra edge loops inserted along the Z axis. .. rst-class:: classref-property-setget -- void **set_subdivide_height** **(** :ref:`int` value **)** -- :ref:`int` **get_subdivide_height** **(** **)** +- |void| **set_subdivide_height**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_subdivide_height**\ (\ ) Number of extra edge loops inserted along the Y axis. @@ -111,8 +111,8 @@ Number of extra edge loops inserted along the Y axis. .. rst-class:: classref-property-setget -- void **set_subdivide_width** **(** :ref:`int` value **)** -- :ref:`int` **get_subdivide_width** **(** **)** +- |void| **set_subdivide_width**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_subdivide_width**\ (\ ) Number of extra edge loops inserted along the X axis. @@ -123,3 +123,4 @@ Number of extra edge loops inserted along the X axis. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_boxoccluder3d.rst b/classes/class_boxoccluder3d.rst index 9b250759ddd..80a543dcb31 100644 --- a/classes/class_boxoccluder3d.rst +++ b/classes/class_boxoccluder3d.rst @@ -59,8 +59,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_size**\ (\ ) The box's size in 3D units. @@ -71,3 +71,4 @@ The box's size in 3D units. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_boxshape3d.rst b/classes/class_boxshape3d.rst index 65d0aa5aef1..00aecb2cb3c 100644 --- a/classes/class_boxshape3d.rst +++ b/classes/class_boxshape3d.rst @@ -63,8 +63,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_size**\ (\ ) The box's width, height and depth. @@ -75,3 +75,4 @@ The box's width, height and depth. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_button.rst b/classes/class_button.rst index 5fed12417f8..24b8f9106f4 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -80,6 +80,8 @@ Properties +-------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ | :ref:`HorizontalAlignment` | :ref:`alignment` | ``1`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ + | :ref:`AutowrapMode` | :ref:`autowrap_mode` | ``0`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`clip_text` | ``false`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`expand_icon` | ``false`` | @@ -188,8 +190,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_text_alignment** **(** :ref:`HorizontalAlignment` value **)** -- :ref:`HorizontalAlignment` **get_text_alignment** **(** **)** +- |void| **set_text_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) +- :ref:`HorizontalAlignment` **get_text_alignment**\ (\ ) Text alignment policy for the button's text, use one of the :ref:`HorizontalAlignment` constants. @@ -197,6 +199,23 @@ Text alignment policy for the button's text, use one of the :ref:`HorizontalAlig ---- +.. _class_Button_property_autowrap_mode: + +.. rst-class:: classref-property + +:ref:`AutowrapMode` **autowrap_mode** = ``0`` + +.. rst-class:: classref-property-setget + +- |void| **set_autowrap_mode**\ (\ value\: :ref:`AutowrapMode`\ ) +- :ref:`AutowrapMode` **get_autowrap_mode**\ (\ ) + +If set to something other than :ref:`TextServer.AUTOWRAP_OFF`, the text gets wrapped inside the node's bounding rectangle. + +.. rst-class:: classref-item-separator + +---- + .. _class_Button_property_clip_text: .. rst-class:: classref-property @@ -205,8 +224,8 @@ Text alignment policy for the button's text, use one of the :ref:`HorizontalAlig .. rst-class:: classref-property-setget -- void **set_clip_text** **(** :ref:`bool` value **)** -- :ref:`bool` **get_clip_text** **(** **)** +- |void| **set_clip_text**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_clip_text**\ (\ ) When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. @@ -222,8 +241,8 @@ When this property is enabled, text that is too large to fit the button is clipp .. rst-class:: classref-property-setget -- void **set_expand_icon** **(** :ref:`bool` value **)** -- :ref:`bool` **is_expand_icon** **(** **)** +- |void| **set_expand_icon**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_expand_icon**\ (\ ) When enabled, the button's icon will expand/shrink to fit the button's size while keeping its aspect. See also :ref:`icon_max_width`. @@ -239,8 +258,8 @@ When enabled, the button's icon will expand/shrink to fit the button's size whil .. rst-class:: classref-property-setget -- void **set_flat** **(** :ref:`bool` value **)** -- :ref:`bool` **is_flat** **(** **)** +- |void| **set_flat**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_flat**\ (\ ) Flat buttons don't display decoration. @@ -256,8 +275,8 @@ Flat buttons don't display decoration. .. rst-class:: classref-property-setget -- void **set_button_icon** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_button_icon** **(** **)** +- |void| **set_button_icon**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_button_icon**\ (\ ) Button's icon, if text is present the icon will be placed before the text. @@ -275,8 +294,8 @@ To edit margin and spacing of the icon, use :ref:`h_separation` value **)** -- :ref:`HorizontalAlignment` **get_icon_alignment** **(** **)** +- |void| **set_icon_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) +- :ref:`HorizontalAlignment` **get_icon_alignment**\ (\ ) Specifies if the icon should be aligned horizontally to the left, right, or center of a button. Uses the same :ref:`HorizontalAlignment` constants as the text alignment. If centered horizontally and vertically, text will draw on top of the icon. @@ -292,8 +311,8 @@ Specifies if the icon should be aligned horizontally to the left, right, or cent .. rst-class:: classref-property-setget -- void **set_language** **(** :ref:`String` value **)** -- :ref:`String` **get_language** **(** **)** +- |void| **set_language**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_language**\ (\ ) Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -309,8 +328,8 @@ Language code used for line-breaking and text shaping algorithms, if left empty .. rst-class:: classref-property-setget -- void **set_text** **(** :ref:`String` value **)** -- :ref:`String` **get_text** **(** **)** +- |void| **set_text**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_text**\ (\ ) The button's text that will be displayed inside the button's area. @@ -326,8 +345,8 @@ The button's text that will be displayed inside the button's area. .. rst-class:: classref-property-setget -- void **set_text_direction** **(** :ref:`TextDirection` value **)** -- :ref:`TextDirection` **get_text_direction** **(** **)** +- |void| **set_text_direction**\ (\ value\: :ref:`TextDirection`\ ) +- :ref:`TextDirection` **get_text_direction**\ (\ ) Base text writing direction. @@ -343,8 +362,8 @@ Base text writing direction. .. rst-class:: classref-property-setget -- void **set_text_overrun_behavior** **(** :ref:`OverrunBehavior` value **)** -- :ref:`OverrunBehavior` **get_text_overrun_behavior** **(** **)** +- |void| **set_text_overrun_behavior**\ (\ value\: :ref:`OverrunBehavior`\ ) +- :ref:`OverrunBehavior` **get_text_overrun_behavior**\ (\ ) Sets the clipping behavior when the text exceeds the node's bounding rectangle. See :ref:`OverrunBehavior` for a description of all modes. @@ -360,8 +379,8 @@ Sets the clipping behavior when the text exceeds the node's bounding rectangle. .. rst-class:: classref-property-setget -- void **set_vertical_icon_alignment** **(** :ref:`VerticalAlignment` value **)** -- :ref:`VerticalAlignment` **get_vertical_icon_alignment** **(** **)** +- |void| **set_vertical_icon_alignment**\ (\ value\: :ref:`VerticalAlignment`\ ) +- :ref:`VerticalAlignment` **get_vertical_icon_alignment**\ (\ ) Specifies if the icon should be aligned vertically to the top, bottom, or center of a button. Uses the same :ref:`VerticalAlignment` constants as the text alignment. If centered horizontally and vertically, text will draw on top of the icon. @@ -739,3 +758,4 @@ Default :ref:`StyleBox` for the **Button** (for right-to-left la .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index 2905b6bdf73..4b9a673c66e 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -45,11 +45,11 @@ Methods .. table:: :widths: auto - +---------------------------------------+------------------------------------------------------------------------------------+ - | :ref:`BaseButton[]` | :ref:`get_buttons` **(** **)** | - +---------------------------------------+------------------------------------------------------------------------------------+ - | :ref:`BaseButton` | :ref:`get_pressed_button` **(** **)** | - +---------------------------------------+------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`BaseButton`\] | :ref:`get_buttons`\ (\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`BaseButton` | :ref:`get_pressed_button`\ (\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -64,7 +64,7 @@ Signals .. rst-class:: classref-signal -**pressed** **(** :ref:`BaseButton` button **)** +**pressed**\ (\ button\: :ref:`BaseButton`\ ) Emitted when one of the buttons of the group is pressed. @@ -85,8 +85,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_allow_unpress** **(** :ref:`bool` value **)** -- :ref:`bool` **is_allow_unpress** **(** **)** +- |void| **set_allow_unpress**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_allow_unpress**\ (\ ) If ``true``, it is possible to unpress all buttons in this **ButtonGroup**. @@ -103,7 +103,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`BaseButton[]` **get_buttons** **(** **)** +:ref:`Array`\[:ref:`BaseButton`\] **get_buttons**\ (\ ) Returns an :ref:`Array` of :ref:`Button`\ s who have this as their **ButtonGroup** (see :ref:`BaseButton.button_group`). @@ -115,7 +115,7 @@ Returns an :ref:`Array` of :ref:`Button`\ s who have .. rst-class:: classref-method -:ref:`BaseButton` **get_pressed_button** **(** **)** +:ref:`BaseButton` **get_pressed_button**\ (\ ) Returns the current pressed button. @@ -126,3 +126,4 @@ Returns the current pressed button. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_callable.rst b/classes/class_callable.rst index 2658af1bd1f..3bad01040e5 100644 --- a/classes/class_callable.rst +++ b/classes/class_callable.rst @@ -80,13 +80,13 @@ Constructors .. table:: :widths: auto - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Callable` | :ref:`Callable` **(** **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Callable` | :ref:`Callable` **(** :ref:`Callable` from **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Callable` | :ref:`Callable` **(** :ref:`Object` object, :ref:`StringName` method **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Callable` | :ref:`Callable`\ (\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Callable` | :ref:`Callable`\ (\ from\: :ref:`Callable`\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Callable` | :ref:`Callable`\ (\ object\: :ref:`Object`, method\: :ref:`StringName`\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -96,43 +96,43 @@ Methods .. table:: :widths: auto - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Callable` | :ref:`bind` **(** ... **)** |vararg| |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Callable` | :ref:`bindv` **(** :ref:`Array` arguments **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`call` **(** ... **)** |vararg| |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | void | :ref:`call_deferred` **(** ... **)** |vararg| |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`callv` **(** :ref:`Array` arguments **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_bound_arguments` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_bound_arguments_count` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_method` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_object` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_object_id` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`hash` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_custom` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_null` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_standard` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rpc` **(** ... **)** |vararg| |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rpc_id` **(** :ref:`int` peer_id, ... **)** |vararg| |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Callable` | :ref:`unbind` **(** :ref:`int` argcount **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Callable` | :ref:`bind`\ (\ ...\ ) |vararg| |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Callable` | :ref:`bindv`\ (\ arguments\: :ref:`Array`\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`call`\ (\ ...\ ) |vararg| |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`call_deferred`\ (\ ...\ ) |vararg| |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`callv`\ (\ arguments\: :ref:`Array`\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_bound_arguments`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_bound_arguments_count`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_method`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_object`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_object_id`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`hash`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_custom`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_null`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_standard`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rpc`\ (\ ...\ ) |vararg| |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rpc_id`\ (\ peer_id\: :ref:`int`, ...\ ) |vararg| |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Callable` | :ref:`unbind`\ (\ argcount\: :ref:`int`\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -142,11 +142,11 @@ Operators .. table:: :widths: auto - +-------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Callable` right **)** | - +-------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Callable` right **)** | - +-------------------------+------------------------------------------------------------------------------------------------------------+ + +-------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Callable`\ ) | + +-------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Callable`\ ) | + +-------------------------+---------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -161,7 +161,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Callable` **Callable** **(** **)** +:ref:`Callable` **Callable**\ (\ ) Constructs an empty **Callable**, with no object nor method bound. @@ -171,7 +171,7 @@ Constructs an empty **Callable**, with no object nor method bound. .. rst-class:: classref-constructor -:ref:`Callable` **Callable** **(** :ref:`Callable` from **)** +:ref:`Callable` **Callable**\ (\ from\: :ref:`Callable`\ ) Constructs a **Callable** as a copy of the given **Callable**. @@ -181,7 +181,7 @@ Constructs a **Callable** as a copy of the given **Callable**. .. rst-class:: classref-constructor -:ref:`Callable` **Callable** **(** :ref:`Object` object, :ref:`StringName` method **)** +:ref:`Callable` **Callable**\ (\ object\: :ref:`Object`, method\: :ref:`StringName`\ ) Creates a new **Callable** for the method named ``method`` in the specified ``object``. @@ -198,7 +198,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Callable` **bind** **(** ... **)** |vararg| |const| +:ref:`Callable` **bind**\ (\ ...\ ) |vararg| |const| Returns a copy of this **Callable** with one or more arguments bound. When called, the bound arguments are passed *after* the arguments supplied by :ref:`call`. See also :ref:`unbind`. @@ -212,7 +212,7 @@ Returns a copy of this **Callable** with one or more arguments bound. When calle .. rst-class:: classref-method -:ref:`Callable` **bindv** **(** :ref:`Array` arguments **)** +:ref:`Callable` **bindv**\ (\ arguments\: :ref:`Array`\ ) Returns a copy of this **Callable** with one or more arguments bound, reading them from an array. When called, the bound arguments are passed *after* the arguments supplied by :ref:`call`. See also :ref:`unbind`. @@ -226,7 +226,7 @@ Returns a copy of this **Callable** with one or more arguments bound, reading th .. rst-class:: classref-method -:ref:`Variant` **call** **(** ... **)** |vararg| |const| +:ref:`Variant` **call**\ (\ ...\ ) |vararg| |const| Calls the method represented by this **Callable**. Arguments can be passed and should match the method's signature. @@ -238,7 +238,7 @@ Calls the method represented by this **Callable**. Arguments can be passed and s .. rst-class:: classref-method -void **call_deferred** **(** ... **)** |vararg| |const| +|void| **call_deferred**\ (\ ...\ ) |vararg| |const| Calls the method represented by this **Callable** in deferred mode, i.e. at the end of the current frame. Arguments can be passed and should match the method's signature. @@ -269,7 +269,7 @@ See also :ref:`Object.call_deferred`. .. rst-class:: classref-method -:ref:`Variant` **callv** **(** :ref:`Array` arguments **)** |const| +:ref:`Variant` **callv**\ (\ arguments\: :ref:`Array`\ ) |const| Calls the method represented by this **Callable**. Unlike :ref:`call`, this method expects all arguments to be contained inside the ``arguments`` :ref:`Array`. @@ -281,7 +281,7 @@ Calls the method represented by this **Callable**. Unlike :ref:`call` **get_bound_arguments** **(** **)** |const| +:ref:`Array` **get_bound_arguments**\ (\ ) |const| Return the bound arguments (as long as :ref:`get_bound_arguments_count` is greater than zero), or empty (if :ref:`get_bound_arguments_count` is less than or equal to zero). @@ -293,7 +293,7 @@ Return the bound arguments (as long as :ref:`get_bound_arguments_count` **get_bound_arguments_count** **(** **)** |const| +:ref:`int` **get_bound_arguments_count**\ (\ ) |const| Returns the total amount of arguments bound (or unbound) via successive :ref:`bind` or :ref:`unbind` calls. If the amount of arguments unbound is greater than the ones bound, this function returns a value less than zero. @@ -305,7 +305,7 @@ Returns the total amount of arguments bound (or unbound) via successive :ref:`bi .. rst-class:: classref-method -:ref:`StringName` **get_method** **(** **)** |const| +:ref:`StringName` **get_method**\ (\ ) |const| Returns the name of the method represented by this **Callable**. If the callable is a GDScript lambda function, returns the function's name or ``""``. @@ -317,7 +317,7 @@ Returns the name of the method represented by this **Callable**. If the callable .. rst-class:: classref-method -:ref:`Object` **get_object** **(** **)** |const| +:ref:`Object` **get_object**\ (\ ) |const| Returns the object on which this **Callable** is called. @@ -329,7 +329,7 @@ Returns the object on which this **Callable** is called. .. rst-class:: classref-method -:ref:`int` **get_object_id** **(** **)** |const| +:ref:`int` **get_object_id**\ (\ ) |const| Returns the ID of this **Callable**'s object (see :ref:`Object.get_instance_id`). @@ -341,7 +341,7 @@ Returns the ID of this **Callable**'s object (see :ref:`Object.get_instance_id` **hash** **(** **)** |const| +:ref:`int` **hash**\ (\ ) |const| Returns the 32-bit hash value of this **Callable**'s object. @@ -355,7 +355,7 @@ Returns the 32-bit hash value of this **Callable**'s object. .. rst-class:: classref-method -:ref:`bool` **is_custom** **(** **)** |const| +:ref:`bool` **is_custom**\ (\ ) |const| Returns ``true`` if this **Callable** is a custom callable. Custom callables are created from :ref:`bind` or :ref:`unbind`. In GDScript, lambda functions are also custom callables. @@ -367,7 +367,7 @@ Returns ``true`` if this **Callable** is a custom callable. Custom callables are .. rst-class:: classref-method -:ref:`bool` **is_null** **(** **)** |const| +:ref:`bool` **is_null**\ (\ ) |const| Returns ``true`` if this **Callable** has no target to call the method on. @@ -379,7 +379,7 @@ Returns ``true`` if this **Callable** has no target to call the method on. .. rst-class:: classref-method -:ref:`bool` **is_standard** **(** **)** |const| +:ref:`bool` **is_standard**\ (\ ) |const| Returns ``true`` if this **Callable** is a standard callable. This method is the opposite of :ref:`is_custom`. Returns ``false`` if this callable is a lambda function. @@ -391,7 +391,7 @@ Returns ``true`` if this **Callable** is a standard callable. This method is the .. rst-class:: classref-method -:ref:`bool` **is_valid** **(** **)** |const| +:ref:`bool` **is_valid**\ (\ ) |const| Returns ``true`` if the callable's object exists and has a valid method name assigned, or is a custom callable. @@ -403,7 +403,7 @@ Returns ``true`` if the callable's object exists and has a valid method name ass .. rst-class:: classref-method -void **rpc** **(** ... **)** |vararg| |const| +|void| **rpc**\ (\ ...\ ) |vararg| |const| Perform an RPC (Remote Procedure Call) on all connected peers. This is used for multiplayer and is normally not available, unless the function being called has been marked as *RPC* (using :ref:`@GDScript.@rpc` or :ref:`Node.rpc_config`). Calling this method on unsupported functions will result in an error. See :ref:`Node.rpc`. @@ -415,7 +415,7 @@ Perform an RPC (Remote Procedure Call) on all connected peers. This is used for .. rst-class:: classref-method -void **rpc_id** **(** :ref:`int` peer_id, ... **)** |vararg| |const| +|void| **rpc_id**\ (\ peer_id\: :ref:`int`, ...\ ) |vararg| |const| Perform an RPC (Remote Procedure Call) on a specific peer ID (see multiplayer documentation for reference). This is used for multiplayer and is normally not available unless the function being called has been marked as *RPC* (using :ref:`@GDScript.@rpc` or :ref:`Node.rpc_config`). Calling this method on unsupported functions will result in an error. See :ref:`Node.rpc_id`. @@ -427,7 +427,7 @@ Perform an RPC (Remote Procedure Call) on a specific peer ID (see multiplayer do .. rst-class:: classref-method -:ref:`Callable` **unbind** **(** :ref:`int` argcount **)** |const| +:ref:`Callable` **unbind**\ (\ argcount\: :ref:`int`\ ) |const| Returns a copy of this **Callable** with a number of arguments unbound. In other words, when the new callable is called the last few arguments supplied by the user are ignored, according to ``argcount``. The remaining arguments are passed to the callable. This allows to use the original callable in a context that attempts to pass more arguments than this callable can handle, e.g. a signal with a fixed number of arguments. See also :ref:`bind`. @@ -452,7 +452,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Callable` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Callable`\ ) Returns ``true`` if both **Callable**\ s invoke different targets. @@ -464,7 +464,7 @@ Returns ``true`` if both **Callable**\ s invoke different targets. .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`Callable` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Callable`\ ) Returns ``true`` if both **Callable**\ s invoke the same custom target. @@ -475,3 +475,4 @@ Returns ``true`` if both **Callable**\ s invoke the same custom target. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_callbacktweener.rst b/classes/class_callbacktweener.rst index 8031aa7245c..961111b782b 100644 --- a/classes/class_callbacktweener.rst +++ b/classes/class_callbacktweener.rst @@ -33,9 +33,9 @@ Methods .. table:: :widths: auto - +-----------------------------------------------+------------------------------------------------------------------------------------------------------+ - | :ref:`CallbackTweener` | :ref:`set_delay` **(** :ref:`float` delay **)** | - +-----------------------------------------------+------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+---------------------------------------------------------------------------------------------------+ + | :ref:`CallbackTweener` | :ref:`set_delay`\ (\ delay\: :ref:`float`\ ) | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -50,7 +50,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`CallbackTweener` **set_delay** **(** :ref:`float` delay **)** +:ref:`CallbackTweener` **set_delay**\ (\ delay\: :ref:`float`\ ) Makes the callback call delayed by given time in seconds. @@ -68,3 +68,4 @@ Makes the callback call delayed by given time in seconds. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 440fc6a0e40..9b02b053424 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -110,29 +110,29 @@ Methods .. table:: :widths: auto - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`align` **(** **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`force_update_scroll` **(** **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_drag_margin` **(** :ref:`Side` margin **)** |const| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_limit` **(** :ref:`Side` margin **)** |const| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_screen_center_position` **(** **)** |const| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_target_position` **(** **)** |const| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_current` **(** **)** |const| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`make_current` **(** **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reset_smoothing` **(** **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_drag_margin` **(** :ref:`Side` margin, :ref:`float` drag_margin **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_limit` **(** :ref:`Side` margin, :ref:`int` limit **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`align`\ (\ ) | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_update_scroll`\ (\ ) | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_drag_margin`\ (\ margin\: :ref:`Side`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_limit`\ (\ margin\: :ref:`Side`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_screen_center_position`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_target_position`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_current`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`make_current`\ (\ ) | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reset_smoothing`\ (\ ) | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_drag_margin`\ (\ margin\: :ref:`Side`, drag_margin\: :ref:`float`\ ) | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_limit`\ (\ margin\: :ref:`Side`, limit\: :ref:`int`\ ) | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -208,8 +208,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_anchor_mode** **(** :ref:`AnchorMode` value **)** -- :ref:`AnchorMode` **get_anchor_mode** **(** **)** +- |void| **set_anchor_mode**\ (\ value\: :ref:`AnchorMode`\ ) +- :ref:`AnchorMode` **get_anchor_mode**\ (\ ) The Camera2D's anchor point. See :ref:`AnchorMode` constants. @@ -225,8 +225,8 @@ The Camera2D's anchor point. See :ref:`AnchorMode` con .. rst-class:: classref-property-setget -- void **set_custom_viewport** **(** :ref:`Node` value **)** -- :ref:`Node` **get_custom_viewport** **(** **)** +- |void| **set_custom_viewport**\ (\ value\: :ref:`Node`\ ) +- :ref:`Node` **get_custom_viewport**\ (\ ) The custom :ref:`Viewport` node attached to the **Camera2D**. If ``null`` or not a :ref:`Viewport`, uses the default viewport instead. @@ -242,8 +242,8 @@ The custom :ref:`Viewport` node attached to the **Camera2D**. If .. rst-class:: classref-property-setget -- void **set_drag_margin** **(** :ref:`Side` margin, :ref:`float` drag_margin **)** -- :ref:`float` **get_drag_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_drag_margin**\ (\ margin\: :ref:`Side`, drag_margin\: :ref:`float`\ ) +- :ref:`float` **get_drag_margin**\ (\ margin\: :ref:`Side`\ ) |const| Bottom margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the bottom edge of the screen. @@ -259,8 +259,8 @@ Bottom margin needed to drag the camera. A value of ``1`` makes the camera move .. rst-class:: classref-property-setget -- void **set_drag_horizontal_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_drag_horizontal_enabled** **(** **)** +- |void| **set_drag_horizontal_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_drag_horizontal_enabled**\ (\ ) If ``true``, the camera only moves when reaching the horizontal (left and right) drag margins. If ``false``, the camera moves horizontally regardless of margins. @@ -276,8 +276,8 @@ If ``true``, the camera only moves when reaching the horizontal (left and right) .. rst-class:: classref-property-setget -- void **set_drag_horizontal_offset** **(** :ref:`float` value **)** -- :ref:`float` **get_drag_horizontal_offset** **(** **)** +- |void| **set_drag_horizontal_offset**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_drag_horizontal_offset**\ (\ ) The relative horizontal drag offset of the camera between the right (``-1``) and left (``1``) drag margins. @@ -295,8 +295,8 @@ The relative horizontal drag offset of the camera between the right (``-1``) and .. rst-class:: classref-property-setget -- void **set_drag_margin** **(** :ref:`Side` margin, :ref:`float` drag_margin **)** -- :ref:`float` **get_drag_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_drag_margin**\ (\ margin\: :ref:`Side`, drag_margin\: :ref:`float`\ ) +- :ref:`float` **get_drag_margin**\ (\ margin\: :ref:`Side`\ ) |const| Left margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the left edge of the screen. @@ -312,8 +312,8 @@ Left margin needed to drag the camera. A value of ``1`` makes the camera move on .. rst-class:: classref-property-setget -- void **set_drag_margin** **(** :ref:`Side` margin, :ref:`float` drag_margin **)** -- :ref:`float` **get_drag_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_drag_margin**\ (\ margin\: :ref:`Side`, drag_margin\: :ref:`float`\ ) +- :ref:`float` **get_drag_margin**\ (\ margin\: :ref:`Side`\ ) |const| Right margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the right edge of the screen. @@ -329,8 +329,8 @@ Right margin needed to drag the camera. A value of ``1`` makes the camera move o .. rst-class:: classref-property-setget -- void **set_drag_margin** **(** :ref:`Side` margin, :ref:`float` drag_margin **)** -- :ref:`float` **get_drag_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_drag_margin**\ (\ margin\: :ref:`Side`, drag_margin\: :ref:`float`\ ) +- :ref:`float` **get_drag_margin**\ (\ margin\: :ref:`Side`\ ) |const| Top margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the top edge of the screen. @@ -346,8 +346,8 @@ Top margin needed to drag the camera. A value of ``1`` makes the camera move onl .. rst-class:: classref-property-setget -- void **set_drag_vertical_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_drag_vertical_enabled** **(** **)** +- |void| **set_drag_vertical_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_drag_vertical_enabled**\ (\ ) If ``true``, the camera only moves when reaching the vertical (top and bottom) drag margins. If ``false``, the camera moves vertically regardless of the drag margins. @@ -363,8 +363,8 @@ If ``true``, the camera only moves when reaching the vertical (top and bottom) d .. rst-class:: classref-property-setget -- void **set_drag_vertical_offset** **(** :ref:`float` value **)** -- :ref:`float` **get_drag_vertical_offset** **(** **)** +- |void| **set_drag_vertical_offset**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_drag_vertical_offset**\ (\ ) The relative vertical drag offset of the camera between the bottom (``-1``) and top (``1``) drag margins. @@ -382,8 +382,8 @@ The relative vertical drag offset of the camera between the bottom (``-1``) and .. rst-class:: classref-property-setget -- void **set_margin_drawing_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_margin_drawing_enabled** **(** **)** +- |void| **set_margin_drawing_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_margin_drawing_enabled**\ (\ ) If ``true``, draws the camera's drag margin rectangle in the editor. @@ -399,8 +399,8 @@ If ``true``, draws the camera's drag margin rectangle in the editor. .. rst-class:: classref-property-setget -- void **set_limit_drawing_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_limit_drawing_enabled** **(** **)** +- |void| **set_limit_drawing_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_limit_drawing_enabled**\ (\ ) If ``true``, draws the camera's limits rectangle in the editor. @@ -416,8 +416,8 @@ If ``true``, draws the camera's limits rectangle in the editor. .. rst-class:: classref-property-setget -- void **set_screen_drawing_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_screen_drawing_enabled** **(** **)** +- |void| **set_screen_drawing_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_screen_drawing_enabled**\ (\ ) If ``true``, draws the camera's screen rectangle in the editor. @@ -433,8 +433,8 @@ If ``true``, draws the camera's screen rectangle in the editor. .. rst-class:: classref-property-setget -- void **set_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_enabled** **(** **)** +- |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_enabled**\ (\ ) Controls whether the camera can be active or not. If ``true``, the **Camera2D** will become the main camera when it enters the scene tree and there is no active camera currently (see :ref:`Viewport.get_camera_2d`). @@ -452,8 +452,8 @@ When the camera is currently active and :ref:`enabled` value **)** -- :ref:`bool` **is_ignoring_rotation** **(** **)** +- |void| **set_ignore_rotation**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_ignoring_rotation**\ (\ ) If ``true``, the camera's rendered view is not affected by its :ref:`Node2D.rotation` and :ref:`Node2D.global_rotation`. @@ -469,8 +469,8 @@ If ``true``, the camera's rendered view is not affected by its :ref:`Node2D.rota .. rst-class:: classref-property-setget -- void **set_limit** **(** :ref:`Side` margin, :ref:`int` limit **)** -- :ref:`int` **get_limit** **(** :ref:`Side` margin **)** |const| +- |void| **set_limit**\ (\ margin\: :ref:`Side`, limit\: :ref:`int`\ ) +- :ref:`int` **get_limit**\ (\ margin\: :ref:`Side`\ ) |const| Bottom scroll limit in pixels. The camera stops moving when reaching this value, but :ref:`offset` can push the view past the limit. @@ -486,8 +486,8 @@ Bottom scroll limit in pixels. The camera stops moving when reaching this value, .. rst-class:: classref-property-setget -- void **set_limit** **(** :ref:`Side` margin, :ref:`int` limit **)** -- :ref:`int` **get_limit** **(** :ref:`Side` margin **)** |const| +- |void| **set_limit**\ (\ margin\: :ref:`Side`, limit\: :ref:`int`\ ) +- :ref:`int` **get_limit**\ (\ margin\: :ref:`Side`\ ) |const| Left scroll limit in pixels. The camera stops moving when reaching this value, but :ref:`offset` can push the view past the limit. @@ -503,8 +503,8 @@ Left scroll limit in pixels. The camera stops moving when reaching this value, b .. rst-class:: classref-property-setget -- void **set_limit** **(** :ref:`Side` margin, :ref:`int` limit **)** -- :ref:`int` **get_limit** **(** :ref:`Side` margin **)** |const| +- |void| **set_limit**\ (\ margin\: :ref:`Side`, limit\: :ref:`int`\ ) +- :ref:`int` **get_limit**\ (\ margin\: :ref:`Side`\ ) |const| Right scroll limit in pixels. The camera stops moving when reaching this value, but :ref:`offset` can push the view past the limit. @@ -520,8 +520,8 @@ Right scroll limit in pixels. The camera stops moving when reaching this value, .. rst-class:: classref-property-setget -- void **set_limit_smoothing_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_limit_smoothing_enabled** **(** **)** +- |void| **set_limit_smoothing_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_limit_smoothing_enabled**\ (\ ) If ``true``, the camera smoothly stops when reaches its limits. @@ -541,8 +541,8 @@ This property has no effect if :ref:`position_smoothing_enabled` margin, :ref:`int` limit **)** -- :ref:`int` **get_limit** **(** :ref:`Side` margin **)** |const| +- |void| **set_limit**\ (\ margin\: :ref:`Side`, limit\: :ref:`int`\ ) +- :ref:`int` **get_limit**\ (\ margin\: :ref:`Side`\ ) |const| Top scroll limit in pixels. The camera stops moving when reaching this value, but :ref:`offset` can push the view past the limit. @@ -558,8 +558,8 @@ Top scroll limit in pixels. The camera stops moving when reaching this value, bu .. rst-class:: classref-property-setget -- void **set_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_offset** **(** **)** +- |void| **set_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_offset**\ (\ ) The camera's relative offset. Useful for looking around or camera shake animations. The offsetted camera can go past the limits defined in :ref:`limit_top`, :ref:`limit_bottom`, :ref:`limit_left` and :ref:`limit_right`. @@ -575,8 +575,8 @@ The camera's relative offset. Useful for looking around or camera shake animatio .. rst-class:: classref-property-setget -- void **set_position_smoothing_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_position_smoothing_enabled** **(** **)** +- |void| **set_position_smoothing_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_position_smoothing_enabled**\ (\ ) If ``true``, the camera's view smoothly moves towards its target position at :ref:`position_smoothing_speed`. @@ -592,8 +592,8 @@ If ``true``, the camera's view smoothly moves towards its target position at :re .. rst-class:: classref-property-setget -- void **set_position_smoothing_speed** **(** :ref:`float` value **)** -- :ref:`float` **get_position_smoothing_speed** **(** **)** +- |void| **set_position_smoothing_speed**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_position_smoothing_speed**\ (\ ) Speed in pixels per second of the camera's smoothing effect when :ref:`position_smoothing_enabled` is ``true``. @@ -609,8 +609,8 @@ Speed in pixels per second of the camera's smoothing effect when :ref:`position_ .. rst-class:: classref-property-setget -- void **set_process_callback** **(** :ref:`Camera2DProcessCallback` value **)** -- :ref:`Camera2DProcessCallback` **get_process_callback** **(** **)** +- |void| **set_process_callback**\ (\ value\: :ref:`Camera2DProcessCallback`\ ) +- :ref:`Camera2DProcessCallback` **get_process_callback**\ (\ ) The camera's process callback. See :ref:`Camera2DProcessCallback`. @@ -626,8 +626,8 @@ The camera's process callback. See :ref:`Camera2DProcessCallback` value **)** -- :ref:`bool` **is_rotation_smoothing_enabled** **(** **)** +- |void| **set_rotation_smoothing_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_rotation_smoothing_enabled**\ (\ ) If ``true``, the camera's view smoothly rotates, via asymptotic smoothing, to align with its target rotation at :ref:`rotation_smoothing_speed`. @@ -645,8 +645,8 @@ If ``true``, the camera's view smoothly rotates, via asymptotic smoothing, to al .. rst-class:: classref-property-setget -- void **set_rotation_smoothing_speed** **(** :ref:`float` value **)** -- :ref:`float` **get_rotation_smoothing_speed** **(** **)** +- |void| **set_rotation_smoothing_speed**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_rotation_smoothing_speed**\ (\ ) The angular, asymptotic speed of the camera's rotation smoothing effect when :ref:`rotation_smoothing_enabled` is ``true``. @@ -662,8 +662,8 @@ The angular, asymptotic speed of the camera's rotation smoothing effect when :re .. rst-class:: classref-property-setget -- void **set_zoom** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_zoom** **(** **)** +- |void| **set_zoom**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_zoom**\ (\ ) The camera's zoom. A zoom of ``Vector(2, 2)`` doubles the size seen in the viewport. A zoom of ``Vector(0.5, 0.5)`` halves the size seen in the viewport. @@ -682,7 +682,7 @@ Method Descriptions .. rst-class:: classref-method -void **align** **(** **)** +|void| **align**\ (\ ) Aligns the camera to the tracked node. @@ -694,7 +694,7 @@ Aligns the camera to the tracked node. .. rst-class:: classref-method -void **force_update_scroll** **(** **)** +|void| **force_update_scroll**\ (\ ) Forces the camera to update scroll immediately. @@ -706,7 +706,7 @@ Forces the camera to update scroll immediately. .. rst-class:: classref-method -:ref:`float` **get_drag_margin** **(** :ref:`Side` margin **)** |const| +:ref:`float` **get_drag_margin**\ (\ margin\: :ref:`Side`\ ) |const| Returns the specified :ref:`Side`'s margin. See also :ref:`drag_bottom_margin`, :ref:`drag_top_margin`, :ref:`drag_left_margin`, and :ref:`drag_right_margin`. @@ -718,7 +718,7 @@ Returns the specified :ref:`Side`'s margin. See also :re .. rst-class:: classref-method -:ref:`int` **get_limit** **(** :ref:`Side` margin **)** |const| +:ref:`int` **get_limit**\ (\ margin\: :ref:`Side`\ ) |const| Returns the camera limit for the specified :ref:`Side`. See also :ref:`limit_bottom`, :ref:`limit_top`, :ref:`limit_left`, and :ref:`limit_right`. @@ -730,7 +730,7 @@ Returns the camera limit for the specified :ref:`Side`. .. rst-class:: classref-method -:ref:`Vector2` **get_screen_center_position** **(** **)** |const| +:ref:`Vector2` **get_screen_center_position**\ (\ ) |const| Returns the center of the screen from this camera's point of view, in global coordinates. @@ -744,7 +744,7 @@ Returns the center of the screen from this camera's point of view, in global coo .. rst-class:: classref-method -:ref:`Vector2` **get_target_position** **(** **)** |const| +:ref:`Vector2` **get_target_position**\ (\ ) |const| Returns this camera's target position, in global coordinates. @@ -758,7 +758,7 @@ Returns this camera's target position, in global coordinates. .. rst-class:: classref-method -:ref:`bool` **is_current** **(** **)** |const| +:ref:`bool` **is_current**\ (\ ) |const| Returns ``true`` if this **Camera2D** is the active camera (see :ref:`Viewport.get_camera_2d`). @@ -770,7 +770,7 @@ Returns ``true`` if this **Camera2D** is the active camera (see :ref:`Viewport.g .. rst-class:: classref-method -void **make_current** **(** **)** +|void| **make_current**\ (\ ) Forces this **Camera2D** to become the current active one. :ref:`enabled` must be ``true``. @@ -782,7 +782,7 @@ Forces this **Camera2D** to become the current active one. :ref:`enabled` margin, :ref:`float` drag_margin **)** +|void| **set_drag_margin**\ (\ margin\: :ref:`Side`, drag_margin\: :ref:`float`\ ) Sets the specified :ref:`Side`'s margin. See also :ref:`drag_bottom_margin`, :ref:`drag_top_margin`, :ref:`drag_left_margin`, and :ref:`drag_right_margin`. @@ -808,7 +808,7 @@ Sets the specified :ref:`Side`'s margin. See also :ref:` .. rst-class:: classref-method -void **set_limit** **(** :ref:`Side` margin, :ref:`int` limit **)** +|void| **set_limit**\ (\ margin\: :ref:`Side`, limit\: :ref:`int`\ ) Sets the camera limit for the specified :ref:`Side`. See also :ref:`limit_bottom`, :ref:`limit_top`, :ref:`limit_left`, and :ref:`limit_right`. @@ -819,3 +819,4 @@ Sets the camera limit for the specified :ref:`Side`. See .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_camera3d.rst b/classes/class_camera3d.rst index 4d2d6ccce42..9020c383286 100644 --- a/classes/class_camera3d.rst +++ b/classes/class_camera3d.rst @@ -41,6 +41,8 @@ Properties +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`CameraAttributes` | :ref:`attributes` | | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ + | :ref:`Compositor` | :ref:`compositor` | | + +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`int` | :ref:`cull_mask` | ``1048575`` | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`bool` | :ref:`current` | ``false`` | @@ -76,45 +78,45 @@ Methods .. table:: :widths: auto - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_current` **(** :ref:`bool` enable_next=true **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`get_camera_projection` **(** **)** |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_camera_rid` **(** **)** |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`get_camera_transform` **(** **)** |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_cull_mask_value` **(** :ref:`int` layer_number **)** |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Plane[]` | :ref:`get_frustum` **(** **)** |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_pyramid_shape_rid` **(** **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_position_behind` **(** :ref:`Vector3` world_point **)** |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_position_in_frustum` **(** :ref:`Vector3` world_point **)** |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`make_current` **(** **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`project_local_ray_normal` **(** :ref:`Vector2` screen_point **)** |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`project_position` **(** :ref:`Vector2` screen_point, :ref:`float` z_depth **)** |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`project_ray_normal` **(** :ref:`Vector2` screen_point **)** |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`project_ray_origin` **(** :ref:`Vector2` screen_point **)** |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cull_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_frustum` **(** :ref:`float` size, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_orthogonal` **(** :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_perspective` **(** :ref:`float` fov, :ref:`float` z_near, :ref:`float` z_far **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`unproject_position` **(** :ref:`Vector3` world_point **)** |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_current`\ (\ enable_next\: :ref:`bool` = true\ ) | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`get_camera_projection`\ (\ ) |const| | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_camera_rid`\ (\ ) |const| | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`get_camera_transform`\ (\ ) |const| | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_cull_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Plane`\] | :ref:`get_frustum`\ (\ ) |const| | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_pyramid_shape_rid`\ (\ ) | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_position_behind`\ (\ world_point\: :ref:`Vector3`\ ) |const| | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_position_in_frustum`\ (\ world_point\: :ref:`Vector3`\ ) |const| | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`make_current`\ (\ ) | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`project_local_ray_normal`\ (\ screen_point\: :ref:`Vector2`\ ) |const| | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`project_position`\ (\ screen_point\: :ref:`Vector2`, z_depth\: :ref:`float`\ ) |const| | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`project_ray_normal`\ (\ screen_point\: :ref:`Vector2`\ ) |const| | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`project_ray_origin`\ (\ screen_point\: :ref:`Vector2`\ ) |const| | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cull_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_frustum`\ (\ size\: :ref:`float`, offset\: :ref:`Vector2`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_orthogonal`\ (\ size\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_perspective`\ (\ fov\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`unproject_position`\ (\ world_point\: :ref:`Vector3`\ ) |const| | + +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -232,8 +234,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_attributes** **(** :ref:`CameraAttributes` value **)** -- :ref:`CameraAttributes` **get_attributes** **(** **)** +- |void| **set_attributes**\ (\ value\: :ref:`CameraAttributes`\ ) +- :ref:`CameraAttributes` **get_attributes**\ (\ ) The :ref:`CameraAttributes` to use for this camera. @@ -241,6 +243,23 @@ The :ref:`CameraAttributes` to use for this camera. ---- +.. _class_Camera3D_property_compositor: + +.. rst-class:: classref-property + +:ref:`Compositor` **compositor** + +.. rst-class:: classref-property-setget + +- |void| **set_compositor**\ (\ value\: :ref:`Compositor`\ ) +- :ref:`Compositor` **get_compositor**\ (\ ) + +The :ref:`Compositor` to use for this camera. + +.. rst-class:: classref-item-separator + +---- + .. _class_Camera3D_property_cull_mask: .. rst-class:: classref-property @@ -249,8 +268,8 @@ The :ref:`CameraAttributes` to use for this camera. .. rst-class:: classref-property-setget -- void **set_cull_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_cull_mask** **(** **)** +- |void| **set_cull_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_cull_mask**\ (\ ) The culling mask that describes which :ref:`VisualInstance3D.layers` are rendered by this camera. By default, all 20 user-visible layers are rendered. @@ -272,8 +291,8 @@ To adjust :ref:`cull_mask` more easily using .. rst-class:: classref-property-setget -- void **set_current** **(** :ref:`bool` value **)** -- :ref:`bool` **is_current** **(** **)** +- |void| **set_current**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_current**\ (\ ) If ``true``, the ancestor :ref:`Viewport` is currently using this camera. @@ -291,8 +310,8 @@ If multiple cameras are in the scene, one will always be made current. For examp .. rst-class:: classref-property-setget -- void **set_doppler_tracking** **(** :ref:`DopplerTracking` value **)** -- :ref:`DopplerTracking` **get_doppler_tracking** **(** **)** +- |void| **set_doppler_tracking**\ (\ value\: :ref:`DopplerTracking`\ ) +- :ref:`DopplerTracking` **get_doppler_tracking**\ (\ ) If not :ref:`DOPPLER_TRACKING_DISABLED`, this camera will simulate the `Doppler effect `__ for objects changed in particular ``_process`` methods. See :ref:`DopplerTracking` for possible values. @@ -308,8 +327,8 @@ If not :ref:`DOPPLER_TRACKING_DISABLED` value **)** -- :ref:`Environment` **get_environment** **(** **)** +- |void| **set_environment**\ (\ value\: :ref:`Environment`\ ) +- :ref:`Environment` **get_environment**\ (\ ) The :ref:`Environment` to use for this camera. @@ -325,8 +344,8 @@ The :ref:`Environment` to use for this camera. .. rst-class:: classref-property-setget -- void **set_far** **(** :ref:`float` value **)** -- :ref:`float` **get_far** **(** **)** +- |void| **set_far**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_far**\ (\ ) The distance to the far culling boundary for this camera relative to its local Z axis. Higher values allow the camera to see further away, while decreasing :ref:`far` can improve performance if it results in objects being partially or fully culled. @@ -342,8 +361,8 @@ The distance to the far culling boundary for this camera relative to its local Z .. rst-class:: classref-property-setget -- void **set_fov** **(** :ref:`float` value **)** -- :ref:`float` **get_fov** **(** **)** +- |void| **set_fov**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fov**\ (\ ) The camera's field of view angle (in degrees). Only applicable in perspective mode. Since :ref:`keep_aspect` locks one axis, :ref:`fov` sets the other axis' field of view angle. @@ -369,8 +388,8 @@ For reference, the default vertical field of view value (``75.0``) is equivalent .. rst-class:: classref-property-setget -- void **set_frustum_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_frustum_offset** **(** **)** +- |void| **set_frustum_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_frustum_offset**\ (\ ) The camera's frustum offset. This can be changed from the default to create "tilted frustum" effects such as `Y-shearing `__. @@ -388,8 +407,8 @@ The camera's frustum offset. This can be changed from the default to create "til .. rst-class:: classref-property-setget -- void **set_h_offset** **(** :ref:`float` value **)** -- :ref:`float` **get_h_offset** **(** **)** +- |void| **set_h_offset**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_h_offset**\ (\ ) The horizontal (X) offset of the camera viewport. @@ -405,8 +424,8 @@ The horizontal (X) offset of the camera viewport. .. rst-class:: classref-property-setget -- void **set_keep_aspect_mode** **(** :ref:`KeepAspect` value **)** -- :ref:`KeepAspect` **get_keep_aspect_mode** **(** **)** +- |void| **set_keep_aspect_mode**\ (\ value\: :ref:`KeepAspect`\ ) +- :ref:`KeepAspect` **get_keep_aspect_mode**\ (\ ) The axis to lock during :ref:`fov`/:ref:`size` adjustments. Can be either :ref:`KEEP_WIDTH` or :ref:`KEEP_HEIGHT`. @@ -422,8 +441,8 @@ The axis to lock during :ref:`fov`/:ref:`size` value **)** -- :ref:`float` **get_near** **(** **)** +- |void| **set_near**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_near**\ (\ ) The distance to the near culling boundary for this camera relative to its local Z axis. Lower values allow the camera to see objects more up close to its origin, at the cost of lower precision across the *entire* range. Values lower than the default can lead to increased Z-fighting. @@ -439,8 +458,8 @@ The distance to the near culling boundary for this camera relative to its local .. rst-class:: classref-property-setget -- void **set_projection** **(** :ref:`ProjectionType` value **)** -- :ref:`ProjectionType` **get_projection** **(** **)** +- |void| **set_projection**\ (\ value\: :ref:`ProjectionType`\ ) +- :ref:`ProjectionType` **get_projection**\ (\ ) The camera's projection mode. In :ref:`PROJECTION_PERSPECTIVE` mode, objects' Z distance from the camera's local space scales their perceived size. @@ -456,8 +475,8 @@ The camera's projection mode. In :ref:`PROJECTION_PERSPECTIVE` value **)** -- :ref:`float` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_size**\ (\ ) The camera's size in meters measured as the diameter of the width or height, depending on :ref:`keep_aspect`. Only applicable in orthogonal and frustum modes. @@ -473,8 +492,8 @@ The camera's size in meters measured as the diameter of the width or height, dep .. rst-class:: classref-property-setget -- void **set_v_offset** **(** :ref:`float` value **)** -- :ref:`float` **get_v_offset** **(** **)** +- |void| **set_v_offset**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_v_offset**\ (\ ) The vertical (Y) offset of the camera viewport. @@ -491,7 +510,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear_current** **(** :ref:`bool` enable_next=true **)** +|void| **clear_current**\ (\ enable_next\: :ref:`bool` = true\ ) If this is the current camera, remove it from being current. If ``enable_next`` is ``true``, request to make the next camera current, if any. @@ -503,7 +522,7 @@ If this is the current camera, remove it from being current. If ``enable_next`` .. rst-class:: classref-method -:ref:`Projection` **get_camera_projection** **(** **)** |const| +:ref:`Projection` **get_camera_projection**\ (\ ) |const| Returns the projection matrix that this camera uses to render to its associated viewport. The camera must be part of the scene tree to function. @@ -515,7 +534,7 @@ Returns the projection matrix that this camera uses to render to its associated .. rst-class:: classref-method -:ref:`RID` **get_camera_rid** **(** **)** |const| +:ref:`RID` **get_camera_rid**\ (\ ) |const| Returns the camera's RID from the :ref:`RenderingServer`. @@ -527,7 +546,7 @@ Returns the camera's RID from the :ref:`RenderingServer`. .. rst-class:: classref-method -:ref:`Transform3D` **get_camera_transform** **(** **)** |const| +:ref:`Transform3D` **get_camera_transform**\ (\ ) |const| Returns the transform of the camera plus the vertical (:ref:`v_offset`) and horizontal (:ref:`h_offset`) offsets; and any other adjustments made to the position and orientation of the camera by subclassed cameras such as :ref:`XRCamera3D`. @@ -539,7 +558,7 @@ Returns the transform of the camera plus the vertical (:ref:`v_offset` **get_cull_mask_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_cull_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`cull_mask` is enabled, given a ``layer_number`` between 1 and 20. @@ -551,7 +570,7 @@ Returns whether or not the specified layer of the :ref:`cull_mask` **get_frustum** **(** **)** |const| +:ref:`Array`\[:ref:`Plane`\] **get_frustum**\ (\ ) |const| Returns the camera's frustum planes in world space units as an array of :ref:`Plane`\ s in the following order: near, far, left, top, right, bottom. Not to be confused with :ref:`frustum_offset`. @@ -563,7 +582,7 @@ Returns the camera's frustum planes in world space units as an array of :ref:`Pl .. rst-class:: classref-method -:ref:`RID` **get_pyramid_shape_rid** **(** **)** +:ref:`RID` **get_pyramid_shape_rid**\ (\ ) Returns the RID of a pyramid shape encompassing the camera's view frustum, ignoring the camera's near plane. The tip of the pyramid represents the position of the camera. @@ -575,7 +594,7 @@ Returns the RID of a pyramid shape encompassing the camera's view frustum, ignor .. rst-class:: classref-method -:ref:`bool` **is_position_behind** **(** :ref:`Vector3` world_point **)** |const| +:ref:`bool` **is_position_behind**\ (\ world_point\: :ref:`Vector3`\ ) |const| Returns ``true`` if the given position is behind the camera (the blue part of the linked diagram). `See this diagram `__ for an overview of position query methods. @@ -589,7 +608,7 @@ Returns ``true`` if the given position is behind the camera (the blue part of th .. rst-class:: classref-method -:ref:`bool` **is_position_in_frustum** **(** :ref:`Vector3` world_point **)** |const| +:ref:`bool` **is_position_in_frustum**\ (\ world_point\: :ref:`Vector3`\ ) |const| Returns ``true`` if the given position is inside the camera's frustum (the green part of the linked diagram). `See this diagram `__ for an overview of position query methods. @@ -601,7 +620,7 @@ Returns ``true`` if the given position is inside the camera's frustum (the green .. rst-class:: classref-method -void **make_current** **(** **)** +|void| **make_current**\ (\ ) Makes this camera the current camera for the :ref:`Viewport` (see class description). If the camera node is outside the scene tree, it will attempt to become current once it's added. @@ -613,7 +632,7 @@ Makes this camera the current camera for the :ref:`Viewport` (se .. rst-class:: classref-method -:ref:`Vector3` **project_local_ray_normal** **(** :ref:`Vector2` screen_point **)** |const| +:ref:`Vector3` **project_local_ray_normal**\ (\ screen_point\: :ref:`Vector2`\ ) |const| Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc. @@ -625,7 +644,7 @@ Returns a normal vector from the screen point location directed along the camera .. rst-class:: classref-method -:ref:`Vector3` **project_position** **(** :ref:`Vector2` screen_point, :ref:`float` z_depth **)** |const| +:ref:`Vector3` **project_position**\ (\ screen_point\: :ref:`Vector2`, z_depth\: :ref:`float`\ ) |const| Returns the 3D point in world space that maps to the given 2D coordinate in the :ref:`Viewport` rectangle on a plane that is the given ``z_depth`` distance into the scene away from the camera. @@ -637,7 +656,7 @@ Returns the 3D point in world space that maps to the given 2D coordinate in the .. rst-class:: classref-method -:ref:`Vector3` **project_ray_normal** **(** :ref:`Vector2` screen_point **)** |const| +:ref:`Vector3` **project_ray_normal**\ (\ screen_point\: :ref:`Vector2`\ ) |const| Returns a normal vector in world space, that is the result of projecting a point on the :ref:`Viewport` rectangle by the inverse camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. @@ -649,7 +668,7 @@ Returns a normal vector in world space, that is the result of projecting a point .. rst-class:: classref-method -:ref:`Vector3` **project_ray_origin** **(** :ref:`Vector2` screen_point **)** |const| +:ref:`Vector3` **project_ray_origin**\ (\ screen_point\: :ref:`Vector2`\ ) |const| Returns a 3D position in world space, that is the result of projecting a point on the :ref:`Viewport` rectangle by the inverse camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. @@ -661,7 +680,7 @@ Returns a 3D position in world space, that is the result of projecting a point o .. rst-class:: classref-method -void **set_cull_mask_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_cull_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`cull_mask`, given a ``layer_number`` between 1 and 20. @@ -673,7 +692,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`cull_ma .. rst-class:: classref-method -void **set_frustum** **(** :ref:`float` size, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far **)** +|void| **set_frustum**\ (\ size\: :ref:`float`, offset\: :ref:`Vector2`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) Sets the camera projection to frustum mode (see :ref:`PROJECTION_FRUSTUM`), by specifying a ``size``, an ``offset``, and the ``z_near`` and ``z_far`` clip planes in world space units. See also :ref:`frustum_offset`. @@ -685,7 +704,7 @@ Sets the camera projection to frustum mode (see :ref:`PROJECTION_FRUSTUM` size, :ref:`float` z_near, :ref:`float` z_far **)** +|void| **set_orthogonal**\ (\ size\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) Sets the camera projection to orthogonal mode (see :ref:`PROJECTION_ORTHOGONAL`), by specifying a ``size``, and the ``z_near`` and ``z_far`` clip planes in world space units. (As a hint, 2D games often use this projection, with values specified in pixels.) @@ -697,7 +716,7 @@ Sets the camera projection to orthogonal mode (see :ref:`PROJECTION_ORTHOGONAL` fov, :ref:`float` z_near, :ref:`float` z_far **)** +|void| **set_perspective**\ (\ fov\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) Sets the camera projection to perspective mode (see :ref:`PROJECTION_PERSPECTIVE`), by specifying a ``fov`` (field of view) angle in degrees, and the ``z_near`` and ``z_far`` clip planes in world space units. @@ -709,7 +728,7 @@ Sets the camera projection to perspective mode (see :ref:`PROJECTION_PERSPECTIVE .. rst-class:: classref-method -:ref:`Vector2` **unproject_position** **(** :ref:`Vector3` world_point **)** |const| +:ref:`Vector2` **unproject_position**\ (\ world_point\: :ref:`Vector3`\ ) |const| Returns the 2D coordinate in the :ref:`Viewport` rectangle that maps to the given 3D point in world space. @@ -729,3 +748,4 @@ Returns the 2D coordinate in the :ref:`Viewport` rectangle that .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_cameraattributes.rst b/classes/class_cameraattributes.rst index 169b42d3693..3104407d7d2 100644 --- a/classes/class_cameraattributes.rst +++ b/classes/class_cameraattributes.rst @@ -66,8 +66,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_auto_exposure_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_auto_exposure_enabled** **(** **)** +- |void| **set_auto_exposure_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_auto_exposure_enabled**\ (\ ) If ``true``, enables the tonemapping auto exposure mode of the scene renderer. If ``true``, the renderer will automatically determine the exposure setting to adapt to the scene's illumination and the observed light. @@ -83,8 +83,8 @@ If ``true``, enables the tonemapping auto exposure mode of the scene renderer. I .. rst-class:: classref-property-setget -- void **set_auto_exposure_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_auto_exposure_scale** **(** **)** +- |void| **set_auto_exposure_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_auto_exposure_scale**\ (\ ) The scale of the auto exposure effect. Affects the intensity of auto exposure. @@ -100,8 +100,8 @@ The scale of the auto exposure effect. Affects the intensity of auto exposure. .. rst-class:: classref-property-setget -- void **set_auto_exposure_speed** **(** :ref:`float` value **)** -- :ref:`float` **get_auto_exposure_speed** **(** **)** +- |void| **set_auto_exposure_speed**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_auto_exposure_speed**\ (\ ) The speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure. @@ -117,8 +117,8 @@ The speed of the auto exposure effect. Affects the time needed for the camera to .. rst-class:: classref-property-setget -- void **set_exposure_multiplier** **(** :ref:`float` value **)** -- :ref:`float` **get_exposure_multiplier** **(** **)** +- |void| **set_exposure_multiplier**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_exposure_multiplier**\ (\ ) Multiplier for the exposure amount. A higher value results in a brighter image. @@ -134,8 +134,8 @@ Multiplier for the exposure amount. A higher value results in a brighter image. .. rst-class:: classref-property-setget -- void **set_exposure_sensitivity** **(** :ref:`float` value **)** -- :ref:`float` **get_exposure_sensitivity** **(** **)** +- |void| **set_exposure_sensitivity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_exposure_sensitivity**\ (\ ) Sensitivity of camera sensors, measured in ISO. A higher sensitivity results in a brighter image. Only available when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units` is enabled. When :ref:`auto_exposure_enabled` this can be used as a method of exposure compensation, doubling the value will increase the exposure value (measured in EV100) by 1 stop. @@ -146,3 +146,4 @@ Sensitivity of camera sensors, measured in ISO. A higher sensitivity results in .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_cameraattributesphysical.rst b/classes/class_cameraattributesphysical.rst index a01e3278f4f..3b3c1760fcf 100644 --- a/classes/class_cameraattributesphysical.rst +++ b/classes/class_cameraattributesphysical.rst @@ -68,9 +68,9 @@ Methods .. table:: :widths: auto - +---------------------------+-----------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_fov` **(** **)** |const| | - +---------------------------+-----------------------------------------------------------------------------------+ + +---------------------------+-----------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_fov`\ (\ ) |const| | + +---------------------------+-----------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -89,8 +89,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_auto_exposure_max_exposure_value** **(** :ref:`float` value **)** -- :ref:`float` **get_auto_exposure_max_exposure_value** **(** **)** +- |void| **set_auto_exposure_max_exposure_value**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_auto_exposure_max_exposure_value**\ (\ ) The maximum luminance (in EV100) used when calculating auto exposure. When calculating scene average luminance, color values will be clamped to at least this value. This limits the auto-exposure from exposing below a certain brightness, resulting in a cut off point where the scene will remain bright. @@ -106,8 +106,8 @@ The maximum luminance (in EV100) used when calculating auto exposure. When calcu .. rst-class:: classref-property-setget -- void **set_auto_exposure_min_exposure_value** **(** :ref:`float` value **)** -- :ref:`float` **get_auto_exposure_min_exposure_value** **(** **)** +- |void| **set_auto_exposure_min_exposure_value**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_auto_exposure_min_exposure_value**\ (\ ) The minimum luminance luminance (in EV100) used when calculating auto exposure. When calculating scene average luminance, color values will be clamped to at least this value. This limits the auto-exposure from exposing above a certain brightness, resulting in a cut off point where the scene will remain dark. @@ -123,8 +123,8 @@ The minimum luminance luminance (in EV100) used when calculating auto exposure. .. rst-class:: classref-property-setget -- void **set_aperture** **(** :ref:`float` value **)** -- :ref:`float` **get_aperture** **(** **)** +- |void| **set_aperture**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_aperture**\ (\ ) Size of the aperture of the camera, measured in f-stops. An f-stop is a unitless ratio between the focal length of the camera and the diameter of the aperture. A high aperture setting will result in a smaller aperture which leads to a dimmer image and sharper focus. A low aperture results in a wide aperture which lets in more light resulting in a brighter, less-focused image. Default is appropriate for outdoors at daytime (i.e. for use with a default :ref:`DirectionalLight3D`), for indoor lighting, a value between 2 and 4 is more appropriate. @@ -142,8 +142,8 @@ Only available when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physi .. rst-class:: classref-property-setget -- void **set_shutter_speed** **(** :ref:`float` value **)** -- :ref:`float` **get_shutter_speed** **(** **)** +- |void| **set_shutter_speed**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_shutter_speed**\ (\ ) 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). @@ -161,8 +161,8 @@ Only available when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physi .. rst-class:: classref-property-setget -- void **set_far** **(** :ref:`float` value **)** -- :ref:`float` **get_far** **(** **)** +- |void| **set_far**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_far**\ (\ ) Override value for :ref:`Camera3D.far`. Used internally when calculating depth of field. When attached to a :ref:`Camera3D` as its :ref:`Camera3D.attributes`, it will override the :ref:`Camera3D.far` property. @@ -178,8 +178,8 @@ Override value for :ref:`Camera3D.far`. Used intern .. rst-class:: classref-property-setget -- void **set_focal_length** **(** :ref:`float` value **)** -- :ref:`float` **get_focal_length** **(** **)** +- |void| **set_focal_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_focal_length**\ (\ ) Distance between camera lens and camera aperture, measured in millimeters. Controls field of view and depth of field. A larger focal length will result in a smaller field of view and a narrower depth of field meaning fewer objects will be in focus. A smaller focal length will result in a wider field of view and a larger depth of field meaning more objects will be in focus. When attached to a :ref:`Camera3D` as its :ref:`Camera3D.attributes`, it will override the :ref:`Camera3D.fov` property and the :ref:`Camera3D.keep_aspect` property. @@ -195,8 +195,8 @@ Distance between camera lens and camera aperture, measured in millimeters. Contr .. rst-class:: classref-property-setget -- void **set_focus_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_focus_distance** **(** **)** +- |void| **set_focus_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_focus_distance**\ (\ ) Distance from camera of object that will be in focus, measured in meters. Internally this will be clamped to be at least 1 millimeter larger than :ref:`frustum_focal_length`. @@ -212,8 +212,8 @@ Distance from camera of object that will be in focus, measured in meters. Intern .. rst-class:: classref-property-setget -- void **set_near** **(** :ref:`float` value **)** -- :ref:`float` **get_near** **(** **)** +- |void| **set_near**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_near**\ (\ ) Override value for :ref:`Camera3D.near`. Used internally when calculating depth of field. When attached to a :ref:`Camera3D` as its :ref:`Camera3D.attributes`, it will override the :ref:`Camera3D.near` property. @@ -230,7 +230,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_fov** **(** **)** |const| +:ref:`float` **get_fov**\ (\ ) |const| Returns the vertical field of view that corresponds to the :ref:`frustum_focal_length`. This value is calculated internally whenever :ref:`frustum_focal_length` is changed. @@ -241,3 +241,4 @@ Returns the vertical field of view that corresponds to the :ref:`frustum_focal_l .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_cameraattributespractical.rst b/classes/class_cameraattributespractical.rst index 75c60393919..25a6d7bb593 100644 --- a/classes/class_cameraattributespractical.rst +++ b/classes/class_cameraattributespractical.rst @@ -68,8 +68,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_auto_exposure_max_sensitivity** **(** :ref:`float` value **)** -- :ref:`float` **get_auto_exposure_max_sensitivity** **(** **)** +- |void| **set_auto_exposure_max_sensitivity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_auto_exposure_max_sensitivity**\ (\ ) The maximum sensitivity (in ISO) used when calculating auto exposure. When calculating scene average luminance, color values will be clamped to at least this value. This limits the auto-exposure from exposing below a certain brightness, resulting in a cut off point where the scene will remain bright. @@ -85,8 +85,8 @@ The maximum sensitivity (in ISO) used when calculating auto exposure. When calcu .. rst-class:: classref-property-setget -- void **set_auto_exposure_min_sensitivity** **(** :ref:`float` value **)** -- :ref:`float` **get_auto_exposure_min_sensitivity** **(** **)** +- |void| **set_auto_exposure_min_sensitivity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_auto_exposure_min_sensitivity**\ (\ ) The minimum sensitivity (in ISO) used when calculating auto exposure. When calculating scene average luminance, color values will be clamped to at least this value. This limits the auto-exposure from exposing above a certain brightness, resulting in a cut off point where the scene will remain dark. @@ -102,8 +102,8 @@ The minimum sensitivity (in ISO) used when calculating auto exposure. When calcu .. rst-class:: classref-property-setget -- void **set_dof_blur_amount** **(** :ref:`float` value **)** -- :ref:`float` **get_dof_blur_amount** **(** **)** +- |void| **set_dof_blur_amount**\ (\ value\: :ref:`float`\ ) +- :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 blurriness, but can be much more expensive to calculate. It is best to keep this as low as possible for a given art style. @@ -119,8 +119,8 @@ Sets the maximum amount of blur. When using physically-based blur amounts, will .. rst-class:: classref-property-setget -- void **set_dof_blur_far_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_dof_blur_far_distance** **(** **)** +- |void| **set_dof_blur_far_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_dof_blur_far_distance**\ (\ ) Objects further from the :ref:`Camera3D` by this amount will be blurred by the depth of field effect. Measured in meters. @@ -136,8 +136,8 @@ Objects further from the :ref:`Camera3D` by this amount will be .. rst-class:: classref-property-setget -- void **set_dof_blur_far_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_dof_blur_far_enabled** **(** **)** +- |void| **set_dof_blur_far_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_dof_blur_far_enabled**\ (\ ) Enables depth of field blur for objects further than :ref:`dof_blur_far_distance`. Strength of blur is controlled by :ref:`dof_blur_amount` and modulated by :ref:`dof_blur_far_transition`. @@ -155,8 +155,8 @@ Enables depth of field blur for objects further than :ref:`dof_blur_far_distance .. rst-class:: classref-property-setget -- void **set_dof_blur_far_transition** **(** :ref:`float` value **)** -- :ref:`float` **get_dof_blur_far_transition** **(** **)** +- |void| **set_dof_blur_far_transition**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_dof_blur_far_transition**\ (\ ) When positive, distance over which (starting from :ref:`dof_blur_far_distance`) blur effect will scale from 0 to :ref:`dof_blur_amount`. When negative, uses physically-based scaling so depth of field effect will scale from 0 at :ref:`dof_blur_far_distance` and will increase in a physically accurate way as objects get further from the :ref:`Camera3D`. @@ -172,8 +172,8 @@ When positive, distance over which (starting from :ref:`dof_blur_far_distance` value **)** -- :ref:`float` **get_dof_blur_near_distance** **(** **)** +- |void| **set_dof_blur_near_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_dof_blur_near_distance**\ (\ ) Objects closer from the :ref:`Camera3D` by this amount will be blurred by the depth of field effect. Measured in meters. @@ -189,8 +189,8 @@ Objects closer from the :ref:`Camera3D` by this amount will be b .. rst-class:: classref-property-setget -- void **set_dof_blur_near_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_dof_blur_near_enabled** **(** **)** +- |void| **set_dof_blur_near_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_dof_blur_near_enabled**\ (\ ) Enables depth of field blur for objects closer than :ref:`dof_blur_near_distance`. Strength of blur is controlled by :ref:`dof_blur_amount` and modulated by :ref:`dof_blur_near_transition`. @@ -208,8 +208,8 @@ Enables depth of field blur for objects closer than :ref:`dof_blur_near_distance .. rst-class:: classref-property-setget -- void **set_dof_blur_near_transition** **(** :ref:`float` value **)** -- :ref:`float` **get_dof_blur_near_transition** **(** **)** +- |void| **set_dof_blur_near_transition**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_dof_blur_near_transition**\ (\ ) When positive, distance over which blur effect will scale from 0 to :ref:`dof_blur_amount`, ending at :ref:`dof_blur_near_distance`. When negative, uses physically-based scaling so depth of field effect will scale from 0 at :ref:`dof_blur_near_distance` and will increase in a physically accurate way as objects get closer to the :ref:`Camera3D`. @@ -220,3 +220,4 @@ When positive, distance over which blur effect will scale from 0 to :ref:`dof_bl .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_camerafeed.rst b/classes/class_camerafeed.rst index c4959eb44a6..39512f121db 100644 --- a/classes/class_camerafeed.rst +++ b/classes/class_camerafeed.rst @@ -45,15 +45,15 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`FeedDataType` | :ref:`get_datatype` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_id` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_name` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`FeedPosition` | :ref:`get_position` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------+ + +---------------------------------------------------+-------------------------------------------------------------------------+ + | :ref:`FeedDataType` | :ref:`get_datatype`\ (\ ) |const| | + +---------------------------------------------------+-------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_id`\ (\ ) |const| | + +---------------------------------------------------+-------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_name`\ (\ ) |const| | + +---------------------------------------------------+-------------------------------------------------------------------------+ + | :ref:`FeedPosition` | :ref:`get_position`\ (\ ) |const| | + +---------------------------------------------------+-------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -153,8 +153,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_active** **(** :ref:`bool` value **)** -- :ref:`bool` **is_active** **(** **)** +- |void| **set_active**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_active**\ (\ ) If ``true``, the feed is active. @@ -170,8 +170,8 @@ If ``true``, the feed is active. .. rst-class:: classref-property-setget -- void **set_transform** **(** :ref:`Transform2D` value **)** -- :ref:`Transform2D` **get_transform** **(** **)** +- |void| **set_transform**\ (\ value\: :ref:`Transform2D`\ ) +- :ref:`Transform2D` **get_transform**\ (\ ) The transform applied to the camera's image. @@ -188,7 +188,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`FeedDataType` **get_datatype** **(** **)** |const| +:ref:`FeedDataType` **get_datatype**\ (\ ) |const| Returns feed image data type. @@ -200,7 +200,7 @@ Returns feed image data type. .. rst-class:: classref-method -:ref:`int` **get_id** **(** **)** |const| +:ref:`int` **get_id**\ (\ ) |const| Returns the unique ID for this feed. @@ -212,7 +212,7 @@ Returns the unique ID for this feed. .. rst-class:: classref-method -:ref:`String` **get_name** **(** **)** |const| +:ref:`String` **get_name**\ (\ ) |const| Returns the camera's name. @@ -224,7 +224,7 @@ Returns the camera's name. .. rst-class:: classref-method -:ref:`FeedPosition` **get_position** **(** **)** |const| +:ref:`FeedPosition` **get_position**\ (\ ) |const| Returns the position of camera on the device. @@ -235,3 +235,4 @@ Returns the position of camera on the device. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_cameraserver.rst b/classes/class_cameraserver.rst index eecbd3e0877..dca7797eda0 100644 --- a/classes/class_cameraserver.rst +++ b/classes/class_cameraserver.rst @@ -33,17 +33,17 @@ Methods .. table:: :widths: auto - +---------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_feed` **(** :ref:`CameraFeed` feed **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`CameraFeed[]` | :ref:`feeds` **(** **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`CameraFeed` | :ref:`get_feed` **(** :ref:`int` index **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_feed_count` **(** **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_feed` **(** :ref:`CameraFeed` feed **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_feed`\ (\ feed\: :ref:`CameraFeed`\ ) | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`CameraFeed`\] | :ref:`feeds`\ (\ ) | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`CameraFeed` | :ref:`get_feed`\ (\ index\: :ref:`int`\ ) | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_feed_count`\ (\ ) | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_feed`\ (\ feed\: :ref:`CameraFeed`\ ) | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -58,7 +58,7 @@ Signals .. rst-class:: classref-signal -**camera_feed_added** **(** :ref:`int` id **)** +**camera_feed_added**\ (\ id\: :ref:`int`\ ) Emitted when a :ref:`CameraFeed` is added (e.g. a webcam is plugged in). @@ -70,7 +70,7 @@ Emitted when a :ref:`CameraFeed` is added (e.g. a webcam is pl .. rst-class:: classref-signal -**camera_feed_removed** **(** :ref:`int` id **)** +**camera_feed_removed**\ (\ id\: :ref:`int`\ ) Emitted when a :ref:`CameraFeed` is removed (e.g. a webcam is unplugged). @@ -134,7 +134,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_feed** **(** :ref:`CameraFeed` feed **)** +|void| **add_feed**\ (\ feed\: :ref:`CameraFeed`\ ) Adds the camera ``feed`` to the camera server. @@ -146,7 +146,7 @@ Adds the camera ``feed`` to the camera server. .. rst-class:: classref-method -:ref:`CameraFeed[]` **feeds** **(** **)** +:ref:`Array`\[:ref:`CameraFeed`\] **feeds**\ (\ ) Returns an array of :ref:`CameraFeed`\ s. @@ -158,7 +158,7 @@ Returns an array of :ref:`CameraFeed`\ s. .. rst-class:: classref-method -:ref:`CameraFeed` **get_feed** **(** :ref:`int` index **)** +:ref:`CameraFeed` **get_feed**\ (\ index\: :ref:`int`\ ) Returns the :ref:`CameraFeed` corresponding to the camera with the given ``index``. @@ -170,7 +170,7 @@ Returns the :ref:`CameraFeed` corresponding to the camera with .. rst-class:: classref-method -:ref:`int` **get_feed_count** **(** **)** +:ref:`int` **get_feed_count**\ (\ ) Returns the number of :ref:`CameraFeed`\ s registered. @@ -182,7 +182,7 @@ Returns the number of :ref:`CameraFeed`\ s registered. .. rst-class:: classref-method -void **remove_feed** **(** :ref:`CameraFeed` feed **)** +|void| **remove_feed**\ (\ feed\: :ref:`CameraFeed`\ ) Removes the specified camera ``feed``. @@ -193,3 +193,4 @@ Removes the specified camera ``feed``. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_cameratexture.rst b/classes/class_cameratexture.rst index 49ec8a2c371..e0d4f6f5d09 100644 --- a/classes/class_cameratexture.rst +++ b/classes/class_cameratexture.rst @@ -58,8 +58,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_camera_feed_id** **(** :ref:`int` value **)** -- :ref:`int` **get_camera_feed_id** **(** **)** +- |void| **set_camera_feed_id**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_camera_feed_id**\ (\ ) The ID of the :ref:`CameraFeed` for which we want to display the image. @@ -75,8 +75,8 @@ The ID of the :ref:`CameraFeed` for which we want to display t .. rst-class:: classref-property-setget -- void **set_camera_active** **(** :ref:`bool` value **)** -- :ref:`bool` **get_camera_active** **(** **)** +- |void| **set_camera_active**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_camera_active**\ (\ ) Convenience property that gives access to the active property of the :ref:`CameraFeed`. @@ -92,8 +92,8 @@ Convenience property that gives access to the active property of the :ref:`Camer .. rst-class:: classref-property-setget -- void **set_which_feed** **(** :ref:`FeedImage` value **)** -- :ref:`FeedImage` **get_which_feed** **(** **)** +- |void| **set_which_feed**\ (\ value\: :ref:`FeedImage`\ ) +- :ref:`FeedImage` **get_which_feed**\ (\ ) Which image within the :ref:`CameraFeed` we want access to, important if the camera image is split in a Y and CbCr component. @@ -104,3 +104,4 @@ Which image within the :ref:`CameraFeed` we want access to, im .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_canvasgroup.rst b/classes/class_canvasgroup.rst index 0a8e5bf56c3..ad6c99f447d 100644 --- a/classes/class_canvasgroup.rst +++ b/classes/class_canvasgroup.rst @@ -75,8 +75,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_clear_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_clear_margin** **(** **)** +- |void| **set_clear_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_clear_margin**\ (\ ) Sets the size of the margin used to expand the clearing rect of this **CanvasGroup**. This expands the area of the backbuffer that will be used by the **CanvasGroup**. A smaller margin will reduce the area of the backbuffer used which can increase performance, however if :ref:`use_mipmaps` is enabled, a small margin may result in mipmap errors at the edge of the **CanvasGroup**. Accordingly, this should be left as small as possible, but should be increased if artifacts appear along the edges of the canvas group. @@ -92,8 +92,8 @@ Sets the size of the margin used to expand the clearing rect of this **CanvasGro .. rst-class:: classref-property-setget -- void **set_fit_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_fit_margin** **(** **)** +- |void| **set_fit_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fit_margin**\ (\ ) Sets the size of a margin used to expand the drawable rect of this **CanvasGroup**. The size of the **CanvasGroup** is determined by fitting a rect around its children then expanding that rect by :ref:`fit_margin`. This increases both the backbuffer area used and the area covered by the **CanvasGroup** both of which can reduce performance. This should be kept as small as possible and should only be expanded when an increased size is needed (e.g. for custom shader effects). @@ -109,8 +109,8 @@ Sets the size of a margin used to expand the drawable rect of this **CanvasGroup .. rst-class:: classref-property-setget -- void **set_use_mipmaps** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_mipmaps** **(** **)** +- |void| **set_use_mipmaps**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_mipmaps**\ (\ ) If ``true``, calculates mipmaps for the backbuffer before drawing the **CanvasGroup** so that mipmaps can be used in a custom :ref:`ShaderMaterial` attached to the **CanvasGroup**. Generating mipmaps has a performance cost so this should not be enabled unless required. @@ -121,3 +121,4 @@ If ``true``, calculates mipmaps for the backbuffer before drawing the **CanvasGr .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 9f0427e2160..5e9b8f196e8 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -88,121 +88,123 @@ Methods .. table:: :widths: auto - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_draw` **(** **)** |virtual| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_animation_slice` **(** :ref:`float` animation_length, :ref:`float` slice_begin, :ref:`float` slice_end, :ref:`float` offset=0.0 **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_arc` **(** :ref:`Vector2` center, :ref:`float` radius, :ref:`float` start_angle, :ref:`float` end_angle, :ref:`int` point_count, :ref:`Color` color, :ref:`float` width=-1.0, :ref:`bool` antialiased=false **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`int` font_size=16, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_char_outline` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`int` font_size=16, :ref:`int` size=-1, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_circle` **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_colored_polygon` **(** :ref:`PackedVector2Array` points, :ref:`Color` color, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`Texture2D` texture=null **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_dashed_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=-1.0, :ref:`float` dash=2.0, :ref:`bool` aligned=true **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_end_animation` **(** **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_lcd_texture_rect_region` **(** :ref:`Texture2D` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=-1.0, :ref:`bool` antialiased=false **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_mesh` **(** :ref:`Mesh` mesh, :ref:`Texture2D` texture, :ref:`Transform2D` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`Color` modulate=Color(1, 1, 1, 1) **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_msdf_texture_rect_region` **(** :ref:`Texture2D` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`float` outline=0.0, :ref:`float` pixel_range=4.0, :ref:`float` scale=1.0 **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_multiline` **(** :ref:`PackedVector2Array` points, :ref:`Color` color, :ref:`float` width=-1.0 **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_multiline_colors` **(** :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=-1.0 **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_multiline_string` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, :ref:`int` max_lines=-1, :ref:`Color` modulate=Color(1, 1, 1, 1), |bitfield|\<:ref:`LineBreakFlag`\> brk_flags=3, |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_multiline_string_outline` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, :ref:`int` max_lines=-1, :ref:`int` size=1, :ref:`Color` modulate=Color(1, 1, 1, 1), |bitfield|\<:ref:`LineBreakFlag`\> brk_flags=3, |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_multimesh` **(** :ref:`MultiMesh` multimesh, :ref:`Texture2D` texture **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_polygon` **(** :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`Texture2D` texture=null **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_polyline` **(** :ref:`PackedVector2Array` points, :ref:`Color` color, :ref:`float` width=-1.0, :ref:`bool` antialiased=false **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_polyline_colors` **(** :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=-1.0, :ref:`bool` antialiased=false **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_primitive` **(** :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs, :ref:`Texture2D` texture=null **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_rect` **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true, :ref:`float` width=-1.0 **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_set_transform` **(** :ref:`Vector2` position, :ref:`float` rotation=0.0, :ref:`Vector2` scale=Vector2(1, 1) **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_set_transform_matrix` **(** :ref:`Transform2D` xform **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, :ref:`Color` modulate=Color(1, 1, 1, 1), |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_string_outline` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, :ref:`int` size=1, :ref:`Color` modulate=Color(1, 1, 1, 1), |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_texture` **(** :ref:`Texture2D` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_texture_rect` **(** :ref:`Texture2D` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_texture_rect_region` **(** :ref:`Texture2D` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false, :ref:`bool` clip_uv=true **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`force_update_transform` **(** **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_canvas` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_canvas_item` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_global_mouse_position` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_local_mouse_position` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_screen_transform` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_transform` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_visibility_layer_bit` **(** :ref:`int` layer **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`World2D` | :ref:`get_world_2d` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`hide` **(** **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`make_canvas_position_local` **(** :ref:`Vector2` screen_point **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_to_front` **(** **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`queue_redraw` **(** **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_visibility_layer_bit` **(** :ref:`int` layer, :ref:`bool` enabled **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`show` **(** **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_draw`\ (\ ) |virtual| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_animation_slice`\ (\ animation_length\: :ref:`float`, slice_begin\: :ref:`float`, slice_end\: :ref:`float`, offset\: :ref:`float` = 0.0\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_arc`\ (\ center\: :ref:`Vector2`, radius\: :ref:`float`, start_angle\: :ref:`float`, end_angle\: :ref:`float`, point_count\: :ref:`int`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_char`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_char_outline`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, size\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_circle`\ (\ position\: :ref:`Vector2`, radius\: :ref:`float`, color\: :ref:`Color`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_colored_polygon`\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`Texture2D` = null\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_dashed_line`\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, dash\: :ref:`float` = 2.0, aligned\: :ref:`bool` = true\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_end_animation`\ (\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_lcd_texture_rect_region`\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_line`\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_mesh`\ (\ mesh\: :ref:`Mesh`, texture\: :ref:`Texture2D`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_msdf_texture_rect_region`\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), outline\: :ref:`float` = 0.0, pixel_range\: :ref:`float` = 4.0, scale\: :ref:`float` = 1.0\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_multiline`\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, width\: :ref:`float` = -1.0\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_multiline_colors`\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_multiline_string`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_multiline_string_outline`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_multimesh`\ (\ multimesh\: :ref:`MultiMesh`, texture\: :ref:`Texture2D`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_polygon`\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`Texture2D` = null\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_polyline`\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_polyline_colors`\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_primitive`\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array`, texture\: :ref:`Texture2D` = null\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_rect`\ (\ rect\: :ref:`Rect2`, color\: :ref:`Color`, filled\: :ref:`bool` = true, width\: :ref:`float` = -1.0\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_set_transform`\ (\ position\: :ref:`Vector2`, rotation\: :ref:`float` = 0.0, scale\: :ref:`Vector2` = Vector2(1, 1)\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_set_transform_matrix`\ (\ xform\: :ref:`Transform2D`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_string`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_string_outline`\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_style_box`\ (\ style_box\: :ref:`StyleBox`, rect\: :ref:`Rect2`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_texture`\ (\ texture\: :ref:`Texture2D`, position\: :ref:`Vector2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_texture_rect`\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, tile\: :ref:`bool`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_texture_rect_region`\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false, clip_uv\: :ref:`bool` = true\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_update_transform`\ (\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_canvas`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_canvas_item`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CanvasLayer` | :ref:`get_canvas_layer_node`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_canvas_transform`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_global_mouse_position`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_global_transform`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_global_transform_with_canvas`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_local_mouse_position`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_screen_transform`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_transform`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_viewport_rect`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_viewport_transform`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_visibility_layer_bit`\ (\ layer\: :ref:`int`\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`World2D` | :ref:`get_world_2d`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`hide`\ (\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_local_transform_notification_enabled`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_transform_notification_enabled`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_visible_in_tree`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`make_canvas_position_local`\ (\ screen_point\: :ref:`Vector2`\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`InputEvent` | :ref:`make_input_local`\ (\ event\: :ref:`InputEvent`\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_to_front`\ (\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`queue_redraw`\ (\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_notify_local_transform`\ (\ enable\: :ref:`bool`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_notify_transform`\ (\ enable\: :ref:`bool`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_visibility_layer_bit`\ (\ layer\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`show`\ (\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -217,7 +219,7 @@ Signals .. rst-class:: classref-signal -**draw** **(** **)** +**draw**\ (\ ) Emitted when the **CanvasItem** must redraw, *after* the related :ref:`NOTIFICATION_DRAW` notification, and *before* :ref:`_draw` is called. @@ -231,7 +233,7 @@ Emitted when the **CanvasItem** must redraw, *after* the related :ref:`NOTIFICAT .. rst-class:: classref-signal -**hidden** **(** **)** +**hidden**\ (\ ) Emitted when becoming hidden. @@ -243,7 +245,7 @@ Emitted when becoming hidden. .. rst-class:: classref-signal -**item_rect_changed** **(** **)** +**item_rect_changed**\ (\ ) Emitted when the item's :ref:`Rect2` boundaries (position or size) have changed, or when an action is taking place that may have impacted these boundaries (e.g. changing :ref:`Sprite2D.texture`). @@ -255,7 +257,7 @@ Emitted when the item's :ref:`Rect2` boundaries (position or size) .. rst-class:: classref-signal -**visibility_changed** **(** **)** +**visibility_changed**\ (\ ) Emitted when the visibility (hidden/visible) changes. @@ -520,8 +522,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_clip_children_mode** **(** :ref:`ClipChildrenMode` value **)** -- :ref:`ClipChildrenMode` **get_clip_children_mode** **(** **)** +- |void| **set_clip_children_mode**\ (\ value\: :ref:`ClipChildrenMode`\ ) +- :ref:`ClipChildrenMode` **get_clip_children_mode**\ (\ ) Allows the current node to clip children nodes, essentially acting as a mask. @@ -537,8 +539,8 @@ Allows the current node to clip children nodes, essentially acting as a mask. .. rst-class:: classref-property-setget -- void **set_light_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_light_mask** **(** **)** +- |void| **set_light_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_light_mask**\ (\ ) The rendering layers in which this **CanvasItem** responds to :ref:`Light2D` nodes. @@ -554,8 +556,8 @@ The rendering layers in which this **CanvasItem** responds to :ref:`Light2D` value **)** -- :ref:`Material` **get_material** **(** **)** +- |void| **set_material**\ (\ value\: :ref:`Material`\ ) +- :ref:`Material` **get_material**\ (\ ) The material applied to this **CanvasItem**. @@ -571,8 +573,8 @@ The material applied to this **CanvasItem**. .. rst-class:: classref-property-setget -- void **set_modulate** **(** :ref:`Color` value **)** -- :ref:`Color` **get_modulate** **(** **)** +- |void| **set_modulate**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_modulate**\ (\ ) The color applied to this **CanvasItem**. This property does affect child **CanvasItem**\ s, unlike :ref:`self_modulate` which only affects the node itself. @@ -588,8 +590,8 @@ The color applied to this **CanvasItem**. This property does affect child **Canv .. rst-class:: classref-property-setget -- void **set_self_modulate** **(** :ref:`Color` value **)** -- :ref:`Color` **get_self_modulate** **(** **)** +- |void| **set_self_modulate**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_self_modulate**\ (\ ) The color applied to this **CanvasItem**. This property does **not** affect child **CanvasItem**\ s, unlike :ref:`modulate` which affects both the node itself and its children. @@ -607,8 +609,8 @@ The color applied to this **CanvasItem**. This property does **not** affect chil .. rst-class:: classref-property-setget -- void **set_draw_behind_parent** **(** :ref:`bool` value **)** -- :ref:`bool` **is_draw_behind_parent_enabled** **(** **)** +- |void| **set_draw_behind_parent**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_draw_behind_parent_enabled**\ (\ ) If ``true``, the object draws behind its parent. @@ -624,8 +626,8 @@ If ``true``, the object draws behind its parent. .. rst-class:: classref-property-setget -- void **set_texture_filter** **(** :ref:`TextureFilter` value **)** -- :ref:`TextureFilter` **get_texture_filter** **(** **)** +- |void| **set_texture_filter**\ (\ value\: :ref:`TextureFilter`\ ) +- :ref:`TextureFilter` **get_texture_filter**\ (\ ) The texture filtering mode to use on this **CanvasItem**. @@ -641,8 +643,8 @@ The texture filtering mode to use on this **CanvasItem**. .. rst-class:: classref-property-setget -- void **set_texture_repeat** **(** :ref:`TextureRepeat` value **)** -- :ref:`TextureRepeat` **get_texture_repeat** **(** **)** +- |void| **set_texture_repeat**\ (\ value\: :ref:`TextureRepeat`\ ) +- :ref:`TextureRepeat` **get_texture_repeat**\ (\ ) The texture repeating mode to use on this **CanvasItem**. @@ -658,8 +660,8 @@ The texture repeating mode to use on this **CanvasItem**. .. rst-class:: classref-property-setget -- void **set_as_top_level** **(** :ref:`bool` value **)** -- :ref:`bool` **is_set_as_top_level** **(** **)** +- |void| **set_as_top_level**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_set_as_top_level**\ (\ ) If ``true``, this **CanvasItem** will *not* inherit its transform from parent **CanvasItem**\ s. Its draw order will also be changed to make it draw on top of other **CanvasItem**\ s that do not have :ref:`top_level` set to ``true``. The **CanvasItem** will effectively act as if it was placed as a child of a bare :ref:`Node`. @@ -675,8 +677,8 @@ If ``true``, this **CanvasItem** will *not* inherit its transform from parent ** .. rst-class:: classref-property-setget -- void **set_use_parent_material** **(** :ref:`bool` value **)** -- :ref:`bool` **get_use_parent_material** **(** **)** +- |void| **set_use_parent_material**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_parent_material**\ (\ ) If ``true``, the parent **CanvasItem**'s :ref:`material` property is used as this one's material. @@ -692,8 +694,8 @@ If ``true``, the parent **CanvasItem**'s :ref:`material` value **)** -- :ref:`int` **get_visibility_layer** **(** **)** +- |void| **set_visibility_layer**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_visibility_layer**\ (\ ) The rendering layer in which this **CanvasItem** is rendered by :ref:`Viewport` nodes. A :ref:`Viewport` will render a **CanvasItem** if it and all its parents share a layer with the :ref:`Viewport`'s canvas cull mask. @@ -709,8 +711,8 @@ The rendering layer in which this **CanvasItem** is rendered by :ref:`Viewport` value **)** -- :ref:`bool` **is_visible** **(** **)** +- |void| **set_visible**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_visible**\ (\ ) If ``true``, this **CanvasItem** is drawn. The node is only visible if all of its ancestors are visible as well (in other words, :ref:`is_visible_in_tree` must return ``true``). @@ -728,10 +730,10 @@ If ``true``, this **CanvasItem** is drawn. The node is only visible if all of it .. rst-class:: classref-property-setget -- void **set_y_sort_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_y_sort_enabled** **(** **)** +- |void| **set_y_sort_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_y_sort_enabled**\ (\ ) -If ``true``, child nodes with the lowest Y position are drawn before those with a higher Y position. If ``false``, Y-sorting is disabled. Y-sorting only affects children that inherit from **CanvasItem**. +If ``true``, this **CanvasItem** and its **CanvasItem** child nodes are sorted according to the Y position. Nodes with a lower Y position are drawn before those with a higher Y position. If ``false``, Y-sorting is disabled. You can nest nodes with Y-sorting. Child Y-sorted nodes are sorted in the same space as the parent Y-sort. This feature allows you to organize a scene better or divide it into multiple ones without changing your scene tree. @@ -747,8 +749,8 @@ You can nest nodes with Y-sorting. Child Y-sorted nodes are sorted in the same s .. rst-class:: classref-property-setget -- void **set_z_as_relative** **(** :ref:`bool` value **)** -- :ref:`bool` **is_z_relative** **(** **)** +- |void| **set_z_as_relative**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_z_relative**\ (\ ) If ``true``, the node's Z index is relative to its parent's Z index. If this node's Z index is 2 and its parent's effective Z index is 3, then this node's effective Z index will be 2 + 3 = 5. @@ -764,8 +766,8 @@ If ``true``, the node's Z index is relative to its parent's Z index. If this nod .. rst-class:: classref-property-setget -- void **set_z_index** **(** :ref:`int` value **)** -- :ref:`int` **get_z_index** **(** **)** +- |void| **set_z_index**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_z_index**\ (\ ) Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others. Must be between :ref:`RenderingServer.CANVAS_ITEM_Z_MIN` and :ref:`RenderingServer.CANVAS_ITEM_Z_MAX` (inclusive). @@ -784,7 +786,7 @@ Method Descriptions .. rst-class:: classref-method -void **_draw** **(** **)** |virtual| +|void| **_draw**\ (\ ) |virtual| Called when **CanvasItem** has been requested to redraw (after :ref:`queue_redraw` is called, either manually or by the engine). @@ -798,7 +800,7 @@ Corresponds to the :ref:`NOTIFICATION_DRAW` animation_length, :ref:`float` slice_begin, :ref:`float` slice_end, :ref:`float` offset=0.0 **)** +|void| **draw_animation_slice**\ (\ animation_length\: :ref:`float`, slice_begin\: :ref:`float`, slice_end\: :ref:`float`, offset\: :ref:`float` = 0.0\ ) Subsequent drawing commands will be ignored unless they fall within the specified animation slice. This is a faster way to implement animations that loop on background rather than redrawing constantly. @@ -810,7 +812,7 @@ Subsequent drawing commands will be ignored unless they fall within the specifie .. rst-class:: classref-method -void **draw_arc** **(** :ref:`Vector2` center, :ref:`float` radius, :ref:`float` start_angle, :ref:`float` end_angle, :ref:`int` point_count, :ref:`Color` color, :ref:`float` width=-1.0, :ref:`bool` antialiased=false **)** +|void| **draw_arc**\ (\ center\: :ref:`Vector2`, radius\: :ref:`float`, start_angle\: :ref:`float`, end_angle\: :ref:`float`, point_count\: :ref:`int`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) Draws an unfilled arc between the given angles with a uniform ``color`` and ``width`` and optional antialiasing (supported only for positive ``width``). The larger the value of ``point_count``, the smoother the curve. See also :ref:`draw_circle`. @@ -826,7 +828,7 @@ The arc is drawn from ``start_angle`` towards the value of ``end_angle`` so in c .. rst-class:: classref-method -void **draw_char** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`int` font_size=16, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** |const| +|void| **draw_char**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| Draws a string first character using a custom font. @@ -838,7 +840,7 @@ Draws a string first character using a custom font. .. rst-class:: classref-method -void **draw_char_outline** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`int` font_size=16, :ref:`int` size=-1, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** |const| +|void| **draw_char_outline**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, size\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| Draws a string first character outline using a custom font. @@ -850,7 +852,7 @@ Draws a string first character outline using a custom font. .. rst-class:: classref-method -void **draw_circle** **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** +|void| **draw_circle**\ (\ position\: :ref:`Vector2`, radius\: :ref:`float`, color\: :ref:`Color`\ ) Draws a colored, filled circle. See also :ref:`draw_arc`, :ref:`draw_polyline` and :ref:`draw_polygon`. @@ -862,7 +864,7 @@ Draws a colored, filled circle. See also :ref:`draw_arc` points, :ref:`Color` color, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`Texture2D` texture=null **)** +|void| **draw_colored_polygon**\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`Texture2D` = null\ ) Draws a colored polygon of any number of points, convex or concave. Unlike :ref:`draw_polygon`, a single color must be specified for the whole polygon. @@ -874,7 +876,7 @@ Draws a colored polygon of any number of points, convex or concave. Unlike :ref: .. rst-class:: classref-method -void **draw_dashed_line** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=-1.0, :ref:`float` dash=2.0, :ref:`bool` aligned=true **)** +|void| **draw_dashed_line**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, dash\: :ref:`float` = 2.0, aligned\: :ref:`bool` = true\ ) Draws a dashed line from a 2D point to another, with a given color and width. See also :ref:`draw_multiline` and :ref:`draw_polyline`. @@ -888,7 +890,7 @@ If ``width`` is negative, then a two-point primitives will be drawn instead of a .. rst-class:: classref-method -void **draw_end_animation** **(** **)** +|void| **draw_end_animation**\ (\ ) After submitting all animations slices via :ref:`draw_animation_slice`, this function can be used to revert drawing to its default state (all subsequent drawing commands will be visible). If you don't care about this particular use case, usage of this function after submitting the slices is not required. @@ -900,7 +902,7 @@ After submitting all animations slices via :ref:`draw_animation_slice` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** +|void| **draw_lcd_texture_rect_region**\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) Draws a textured rectangle region of the font texture with LCD subpixel anti-aliasing at a given position, optionally modulated by a color. @@ -921,7 +923,7 @@ Texture is drawn using the following blend operation, blend mode of the :ref:`Ca .. rst-class:: classref-method -void **draw_line** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=-1.0, :ref:`bool` antialiased=false **)** +|void| **draw_line**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased. See also :ref:`draw_multiline` and :ref:`draw_polyline`. @@ -935,7 +937,7 @@ If ``width`` is negative, then a two-point primitive will be drawn instead of a .. rst-class:: classref-method -void **draw_mesh** **(** :ref:`Mesh` mesh, :ref:`Texture2D` texture, :ref:`Transform2D` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`Color` modulate=Color(1, 1, 1, 1) **)** +|void| **draw_mesh**\ (\ mesh\: :ref:`Mesh`, texture\: :ref:`Texture2D`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) Draws a :ref:`Mesh` in 2D, using the provided texture. See :ref:`MeshInstance2D` for related documentation. @@ -947,7 +949,7 @@ Draws a :ref:`Mesh` in 2D, using the provided texture. See :ref:`Mes .. rst-class:: classref-method -void **draw_msdf_texture_rect_region** **(** :ref:`Texture2D` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`float` outline=0.0, :ref:`float` pixel_range=4.0, :ref:`float` scale=1.0 **)** +|void| **draw_msdf_texture_rect_region**\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), outline\: :ref:`float` = 0.0, pixel_range\: :ref:`float` = 4.0, scale\: :ref:`float` = 1.0\ ) Draws a textured rectangle region of the multi-channel signed distance field texture at a given position, optionally modulated by a color. See :ref:`FontFile.multichannel_signed_distance_field` for more information and caveats about MSDF font rendering. @@ -963,7 +965,7 @@ Value of the ``pixel_range`` should the same that was used during distance field .. rst-class:: classref-method -void **draw_multiline** **(** :ref:`PackedVector2Array` points, :ref:`Color` color, :ref:`float` width=-1.0 **)** +|void| **draw_multiline**\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, width\: :ref:`float` = -1.0\ ) Draws multiple disconnected lines with a uniform ``width`` and ``color``. Each line is defined by two consecutive points from ``points`` array, i.e. i-th segment consists of ``points[2 * i]``, ``points[2 * i + 1]`` endpoints. When drawing large amounts of lines, this is faster than using individual :ref:`draw_line` calls. To draw interconnected lines, use :ref:`draw_polyline` instead. @@ -977,7 +979,7 @@ If ``width`` is negative, then two-point primitives will be drawn instead of a f .. rst-class:: classref-method -void **draw_multiline_colors** **(** :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=-1.0 **)** +|void| **draw_multiline_colors**\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0\ ) Draws multiple disconnected lines with a uniform ``width`` and segment-by-segment coloring. Each segment is defined by two consecutive points from ``points`` array and a corresponding color from ``colors`` array, i.e. i-th segment consists of ``points[2 * i]``, ``points[2 * i + 1]`` endpoints and has ``colors[i]`` color. When drawing large amounts of lines, this is faster than using individual :ref:`draw_line` calls. To draw interconnected lines, use :ref:`draw_polyline_colors` instead. @@ -991,7 +993,7 @@ If ``width`` is negative, then two-point primitives will be drawn instead of a f .. rst-class:: classref-method -void **draw_multiline_string** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, :ref:`int` max_lines=-1, :ref:`Color` modulate=Color(1, 1, 1, 1), |bitfield|\<:ref:`LineBreakFlag`\> brk_flags=3, |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| +|void| **draw_multiline_string**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| Breaks ``text`` into lines and draws it using the specified ``font`` at the ``pos`` (top-left corner). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width. @@ -1003,7 +1005,7 @@ Breaks ``text`` into lines and draws it using the specified ``font`` at the ``po .. rst-class:: classref-method -void **draw_multiline_string_outline** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, :ref:`int` max_lines=-1, :ref:`int` size=1, :ref:`Color` modulate=Color(1, 1, 1, 1), |bitfield|\<:ref:`LineBreakFlag`\> brk_flags=3, |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| +|void| **draw_multiline_string_outline**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| Breaks ``text`` to the lines and draws text outline using the specified ``font`` at the ``pos`` (top-left corner). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width. @@ -1015,7 +1017,7 @@ Breaks ``text`` to the lines and draws text outline using the specified ``font`` .. rst-class:: classref-method -void **draw_multimesh** **(** :ref:`MultiMesh` multimesh, :ref:`Texture2D` texture **)** +|void| **draw_multimesh**\ (\ multimesh\: :ref:`MultiMesh`, texture\: :ref:`Texture2D`\ ) Draws a :ref:`MultiMesh` in 2D with the provided texture. See :ref:`MultiMeshInstance2D` for related documentation. @@ -1027,7 +1029,7 @@ Draws a :ref:`MultiMesh` in 2D with the provided texture. See : .. rst-class:: classref-method -void **draw_polygon** **(** :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`Texture2D` texture=null **)** +|void| **draw_polygon**\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`Texture2D` = null\ ) Draws a solid polygon of any number of points, convex or concave. Unlike :ref:`draw_colored_polygon`, each point's color can be changed individually. See also :ref:`draw_polyline` and :ref:`draw_polyline_colors`. If you need more flexibility (such as being able to use bones), use :ref:`RenderingServer.canvas_item_add_triangle_array` instead. @@ -1039,7 +1041,7 @@ Draws a solid polygon of any number of points, convex or concave. Unlike :ref:`d .. rst-class:: classref-method -void **draw_polyline** **(** :ref:`PackedVector2Array` points, :ref:`Color` color, :ref:`float` width=-1.0, :ref:`bool` antialiased=false **)** +|void| **draw_polyline**\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) Draws interconnected line segments with a uniform ``color`` and ``width`` and optional antialiasing (supported only for positive ``width``). When drawing large amounts of lines, this is faster than using individual :ref:`draw_line` calls. To draw disconnected lines, use :ref:`draw_multiline` instead. See also :ref:`draw_polygon`. @@ -1053,7 +1055,7 @@ If ``width`` is negative, it will be ignored and the polyline will be drawn usin .. rst-class:: classref-method -void **draw_polyline_colors** **(** :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=-1.0, :ref:`bool` antialiased=false **)** +|void| **draw_polyline_colors**\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) Draws interconnected line segments with a uniform ``width``, point-by-point coloring, and optional antialiasing (supported only for positive ``width``). Colors assigned to line points match by index between ``points`` and ``colors``, i.e. each line segment is filled with a gradient between the colors of the endpoints. When drawing large amounts of lines, this is faster than using individual :ref:`draw_line` calls. To draw disconnected lines, use :ref:`draw_multiline_colors` instead. See also :ref:`draw_polygon`. @@ -1067,7 +1069,7 @@ If ``width`` is negative, it will be ignored and the polyline will be drawn usin .. rst-class:: classref-method -void **draw_primitive** **(** :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs, :ref:`Texture2D` texture=null **)** +|void| **draw_primitive**\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array`, texture\: :ref:`Texture2D` = null\ ) Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle, and 4 points for a quad. If 0 points or more than 4 points are specified, nothing will be drawn and an error message will be printed. See also :ref:`draw_line`, :ref:`draw_polyline`, :ref:`draw_polygon`, and :ref:`draw_rect`. @@ -1079,7 +1081,7 @@ Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for .. rst-class:: classref-method -void **draw_rect** **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true, :ref:`float` width=-1.0 **)** +|void| **draw_rect**\ (\ rect\: :ref:`Rect2`, color\: :ref:`Color`, filled\: :ref:`bool` = true, width\: :ref:`float` = -1.0\ ) Draws a rectangle. If ``filled`` is ``true``, the rectangle will be filled with the ``color`` specified. If ``filled`` is ``false``, the rectangle will be drawn as a stroke with the ``color`` and ``width`` specified. See also :ref:`draw_texture_rect`. @@ -1097,7 +1099,7 @@ If ``width`` is negative, then two-point primitives will be drawn instead of a f .. rst-class:: classref-method -void **draw_set_transform** **(** :ref:`Vector2` position, :ref:`float` rotation=0.0, :ref:`Vector2` scale=Vector2(1, 1) **)** +|void| **draw_set_transform**\ (\ position\: :ref:`Vector2`, rotation\: :ref:`float` = 0.0, scale\: :ref:`Vector2` = Vector2(1, 1)\ ) Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this. @@ -1111,7 +1113,7 @@ Sets a custom transform for drawing via components. Anything drawn afterwards wi .. rst-class:: classref-method -void **draw_set_transform_matrix** **(** :ref:`Transform2D` xform **)** +|void| **draw_set_transform_matrix**\ (\ xform\: :ref:`Transform2D`\ ) Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this. @@ -1123,7 +1125,7 @@ Sets a custom transform for drawing via matrix. Anything drawn afterwards will b .. rst-class:: classref-method -void **draw_string** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, :ref:`Color` modulate=Color(1, 1, 1, 1), |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| +|void| **draw_string**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| Draws ``text`` using the specified ``font`` at the ``pos`` (bottom-left corner using the baseline of the font). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width. @@ -1162,7 +1164,7 @@ See also :ref:`Font.draw_string`. .. rst-class:: classref-method -void **draw_string_outline** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, :ref:`int` size=1, :ref:`Color` modulate=Color(1, 1, 1, 1), |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| +|void| **draw_string_outline**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| Draws ``text`` outline using the specified ``font`` at the ``pos`` (bottom-left corner using the baseline of the font). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width. @@ -1174,7 +1176,7 @@ Draws ``text`` outline using the specified ``font`` at the ``pos`` (bottom-left .. rst-class:: classref-method -void **draw_style_box** **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** +|void| **draw_style_box**\ (\ style_box\: :ref:`StyleBox`, rect\: :ref:`Rect2`\ ) Draws a styled rectangle. @@ -1186,7 +1188,7 @@ Draws a styled rectangle. .. rst-class:: classref-method -void **draw_texture** **(** :ref:`Texture2D` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** +|void| **draw_texture**\ (\ texture\: :ref:`Texture2D`, position\: :ref:`Vector2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) Draws a texture at a given position. @@ -1198,7 +1200,7 @@ Draws a texture at a given position. .. rst-class:: classref-method -void **draw_texture_rect** **(** :ref:`Texture2D` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false **)** +|void| **draw_texture_rect**\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, tile\: :ref:`bool`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) Draws a textured rectangle at a given position, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped. See also :ref:`draw_rect` and :ref:`draw_texture_rect_region`. @@ -1210,7 +1212,7 @@ Draws a textured rectangle at a given position, optionally modulated by a color. .. rst-class:: classref-method -void **draw_texture_rect_region** **(** :ref:`Texture2D` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false, :ref:`bool` clip_uv=true **)** +|void| **draw_texture_rect_region**\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false, clip_uv\: :ref:`bool` = true\ ) Draws a textured rectangle from a texture's region (specified by ``src_rect``) at a given position, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped. See also :ref:`draw_texture_rect`. @@ -1222,7 +1224,7 @@ Draws a textured rectangle from a texture's region (specified by ``src_rect``) a .. rst-class:: classref-method -void **force_update_transform** **(** **)** +|void| **force_update_transform**\ (\ ) Forces the transform to update. Transform changes in physics are not instant for performance reasons. Transforms are accumulated and then set. Use this if you need an up-to-date transform when doing physics operations. @@ -1234,7 +1236,7 @@ Forces the transform to update. Transform changes in physics are not instant for .. rst-class:: classref-method -:ref:`RID` **get_canvas** **(** **)** |const| +:ref:`RID` **get_canvas**\ (\ ) |const| Returns the :ref:`RID` of the :ref:`World2D` canvas where this item is in. @@ -1246,7 +1248,7 @@ Returns the :ref:`RID` of the :ref:`World2D` canvas wh .. rst-class:: classref-method -:ref:`RID` **get_canvas_item** **(** **)** |const| +:ref:`RID` **get_canvas_item**\ (\ ) |const| Returns the canvas item RID used by :ref:`RenderingServer` for this item. @@ -1254,11 +1256,23 @@ Returns the canvas item RID used by :ref:`RenderingServer ---- +.. _class_CanvasItem_method_get_canvas_layer_node: + +.. rst-class:: classref-method + +:ref:`CanvasLayer` **get_canvas_layer_node**\ (\ ) |const| + +Returns the :ref:`CanvasLayer` that contains this node, or ``null`` if the node is not in any :ref:`CanvasLayer`. + +.. rst-class:: classref-item-separator + +---- + .. _class_CanvasItem_method_get_canvas_transform: .. rst-class:: classref-method -:ref:`Transform2D` **get_canvas_transform** **(** **)** |const| +:ref:`Transform2D` **get_canvas_transform**\ (\ ) |const| Returns the transform from the coordinate system of the canvas, this item is in, to the :ref:`Viewport`\ s coordinate system. @@ -1270,7 +1284,7 @@ Returns the transform from the coordinate system of the canvas, this item is in, .. rst-class:: classref-method -:ref:`Vector2` **get_global_mouse_position** **(** **)** |const| +:ref:`Vector2` **get_global_mouse_position**\ (\ ) |const| Returns the mouse's position in the :ref:`CanvasLayer` that this **CanvasItem** is in using the coordinate system of the :ref:`CanvasLayer`. @@ -1284,7 +1298,7 @@ Returns the mouse's position in the :ref:`CanvasLayer` that t .. rst-class:: classref-method -:ref:`Transform2D` **get_global_transform** **(** **)** |const| +:ref:`Transform2D` **get_global_transform**\ (\ ) |const| Returns the global transform matrix of this item, i.e. the combined transform up to the topmost **CanvasItem** node. The topmost item is a **CanvasItem** that either has no parent, has non-**CanvasItem** parent or it has :ref:`top_level` enabled. @@ -1296,7 +1310,7 @@ Returns the global transform matrix of this item, i.e. the combined transform up .. rst-class:: classref-method -:ref:`Transform2D` **get_global_transform_with_canvas** **(** **)** |const| +:ref:`Transform2D` **get_global_transform_with_canvas**\ (\ ) |const| Returns the transform from the local coordinate system of this **CanvasItem** to the :ref:`Viewport`\ s coordinate system. @@ -1308,7 +1322,7 @@ Returns the transform from the local coordinate system of this **CanvasItem** to .. rst-class:: classref-method -:ref:`Vector2` **get_local_mouse_position** **(** **)** |const| +:ref:`Vector2` **get_local_mouse_position**\ (\ ) |const| Returns the mouse's position in this **CanvasItem** using the local coordinate system of this **CanvasItem**. @@ -1320,7 +1334,7 @@ Returns the mouse's position in this **CanvasItem** using the local coordinate s .. rst-class:: classref-method -:ref:`Transform2D` **get_screen_transform** **(** **)** |const| +:ref:`Transform2D` **get_screen_transform**\ (\ ) |const| Returns the transform of this **CanvasItem** in global screen coordinates (i.e. taking window position into account). Mostly useful for editor plugins. @@ -1334,7 +1348,7 @@ Equals to :ref:`get_global_transform` **get_transform** **(** **)** |const| +:ref:`Transform2D` **get_transform**\ (\ ) |const| Returns the transform matrix of this item. @@ -1346,7 +1360,7 @@ Returns the transform matrix of this item. .. rst-class:: classref-method -:ref:`Rect2` **get_viewport_rect** **(** **)** |const| +:ref:`Rect2` **get_viewport_rect**\ (\ ) |const| Returns the viewport's boundaries as a :ref:`Rect2`. @@ -1358,7 +1372,7 @@ Returns the viewport's boundaries as a :ref:`Rect2`. .. rst-class:: classref-method -:ref:`Transform2D` **get_viewport_transform** **(** **)** |const| +:ref:`Transform2D` **get_viewport_transform**\ (\ ) |const| Returns the transform from the coordinate system of the canvas, this item is in, to the :ref:`Viewport`\ s embedders coordinate system. @@ -1370,7 +1384,7 @@ Returns the transform from the coordinate system of the canvas, this item is in, .. rst-class:: classref-method -:ref:`bool` **get_visibility_layer_bit** **(** :ref:`int` layer **)** |const| +:ref:`bool` **get_visibility_layer_bit**\ (\ layer\: :ref:`int`\ ) |const| Returns an individual bit on the rendering visibility layer. @@ -1382,7 +1396,7 @@ Returns an individual bit on the rendering visibility layer. .. rst-class:: classref-method -:ref:`World2D` **get_world_2d** **(** **)** |const| +:ref:`World2D` **get_world_2d**\ (\ ) |const| Returns the :ref:`World2D` where this item is in. @@ -1394,7 +1408,7 @@ Returns the :ref:`World2D` where this item is in. .. rst-class:: classref-method -void **hide** **(** **)** +|void| **hide**\ (\ ) Hide the **CanvasItem** if it's currently visible. This is equivalent to setting :ref:`visible` to ``false``. @@ -1406,7 +1420,7 @@ Hide the **CanvasItem** if it's currently visible. This is equivalent to setting .. rst-class:: classref-method -:ref:`bool` **is_local_transform_notification_enabled** **(** **)** |const| +:ref:`bool` **is_local_transform_notification_enabled**\ (\ ) |const| Returns ``true`` if local transform notifications are communicated to children. @@ -1418,7 +1432,7 @@ Returns ``true`` if local transform notifications are communicated to children. .. rst-class:: classref-method -:ref:`bool` **is_transform_notification_enabled** **(** **)** |const| +:ref:`bool` **is_transform_notification_enabled**\ (\ ) |const| Returns ``true`` if global transform notifications are communicated to children. @@ -1430,7 +1444,7 @@ Returns ``true`` if global transform notifications are communicated to children. .. rst-class:: classref-method -:ref:`bool` **is_visible_in_tree** **(** **)** |const| +: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 therefore not drawn (see :ref:`_draw`). @@ -1442,7 +1456,7 @@ Returns ``true`` if the node is present in the :ref:`SceneTree` .. rst-class:: classref-method -:ref:`Vector2` **make_canvas_position_local** **(** :ref:`Vector2` screen_point **)** |const| +:ref:`Vector2` **make_canvas_position_local**\ (\ screen_point\: :ref:`Vector2`\ ) |const| Assigns ``screen_point`` as this node's new local transform. @@ -1454,7 +1468,7 @@ Assigns ``screen_point`` as this node's new local transform. .. rst-class:: classref-method -:ref:`InputEvent` **make_input_local** **(** :ref:`InputEvent` event **)** |const| +:ref:`InputEvent` **make_input_local**\ (\ event\: :ref:`InputEvent`\ ) |const| Transformations issued by ``event``'s inputs are applied in local space instead of global space. @@ -1466,7 +1480,7 @@ Transformations issued by ``event``'s inputs are applied in local space instead .. rst-class:: classref-method -void **move_to_front** **(** **)** +|void| **move_to_front**\ (\ ) Moves this node to display on top of its siblings. @@ -1480,7 +1494,7 @@ Internally, the node is moved to the bottom of parent's children list. The metho .. rst-class:: classref-method -void **queue_redraw** **(** **)** +|void| **queue_redraw**\ (\ ) Queues the **CanvasItem** to redraw. During idle time, if **CanvasItem** is visible, :ref:`NOTIFICATION_DRAW` is sent and :ref:`_draw` is called. This only occurs **once** per frame, even if this method has been called multiple times. @@ -1492,7 +1506,7 @@ Queues the **CanvasItem** to redraw. During idle time, if **CanvasItem** is visi .. rst-class:: classref-method -void **set_notify_local_transform** **(** :ref:`bool` enable **)** +|void| **set_notify_local_transform**\ (\ enable\: :ref:`bool`\ ) If ``enable`` is ``true``, this node will receive :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED` when its local transform changes. @@ -1504,7 +1518,7 @@ If ``enable`` is ``true``, this node will receive :ref:`NOTIFICATION_LOCAL_TRANS .. rst-class:: classref-method -void **set_notify_transform** **(** :ref:`bool` enable **)** +|void| **set_notify_transform**\ (\ enable\: :ref:`bool`\ ) If ``enable`` is ``true``, this node will receive :ref:`NOTIFICATION_TRANSFORM_CHANGED` when its global transform changes. @@ -1516,7 +1530,7 @@ If ``enable`` is ``true``, this node will receive :ref:`NOTIFICATION_TRANSFORM_C .. rst-class:: classref-method -void **set_visibility_layer_bit** **(** :ref:`int` layer, :ref:`bool` enabled **)** +|void| **set_visibility_layer_bit**\ (\ layer\: :ref:`int`, enabled\: :ref:`bool`\ ) Set/clear individual bits on the rendering visibility layer. This simplifies editing this **CanvasItem**'s visibility layer. @@ -1528,7 +1542,7 @@ Set/clear individual bits on the rendering visibility layer. This simplifies edi .. rst-class:: classref-method -void **show** **(** **)** +|void| **show**\ (\ ) Show the **CanvasItem** if it's currently hidden. This is equivalent to setting :ref:`visible` to ``true``. For controls that inherit :ref:`Popup`, the correct way to make them visible is to call one of the multiple ``popup*()`` functions instead. @@ -1539,3 +1553,4 @@ Show the **CanvasItem** if it's currently hidden. This is equivalent to setting .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index 9a244683fc2..eb657b52a74 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -149,8 +149,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_blend_mode** **(** :ref:`BlendMode` value **)** -- :ref:`BlendMode` **get_blend_mode** **(** **)** +- |void| **set_blend_mode**\ (\ value\: :ref:`BlendMode`\ ) +- :ref:`BlendMode` **get_blend_mode**\ (\ ) The manner in which a material's rendering is applied to underlying textures. @@ -166,8 +166,8 @@ The manner in which a material's rendering is applied to underlying textures. .. rst-class:: classref-property-setget -- void **set_light_mode** **(** :ref:`LightMode` value **)** -- :ref:`LightMode` **get_light_mode** **(** **)** +- |void| **set_light_mode**\ (\ value\: :ref:`LightMode`\ ) +- :ref:`LightMode` **get_light_mode**\ (\ ) The manner in which material reacts to lighting. @@ -183,8 +183,8 @@ The manner in which material reacts to lighting. .. rst-class:: classref-property-setget -- void **set_particles_anim_h_frames** **(** :ref:`int` value **)** -- :ref:`int` **get_particles_anim_h_frames** **(** **)** +- |void| **set_particles_anim_h_frames**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_particles_anim_h_frames**\ (\ ) The number of columns in the spritesheet assigned as :ref:`Texture2D` for a :ref:`GPUParticles2D` or :ref:`CPUParticles2D`. @@ -202,8 +202,8 @@ The number of columns in the spritesheet assigned as :ref:`Texture2D` value **)** -- :ref:`bool` **get_particles_anim_loop** **(** **)** +- |void| **set_particles_anim_loop**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_particles_anim_loop**\ (\ ) If ``true``, the particles animation will loop. @@ -221,8 +221,8 @@ If ``true``, the particles animation will loop. .. rst-class:: classref-property-setget -- void **set_particles_anim_v_frames** **(** :ref:`int` value **)** -- :ref:`int` **get_particles_anim_v_frames** **(** **)** +- |void| **set_particles_anim_v_frames**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_particles_anim_v_frames**\ (\ ) The number of rows in the spritesheet assigned as :ref:`Texture2D` for a :ref:`GPUParticles2D` or :ref:`CPUParticles2D`. @@ -240,8 +240,8 @@ The number of rows in the spritesheet assigned as :ref:`Texture2D` value **)** -- :ref:`bool` **get_particles_animation** **(** **)** +- |void| **set_particles_animation**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_particles_animation**\ (\ ) If ``true``, enable spritesheet-based animation features when assigned to :ref:`GPUParticles2D` and :ref:`CPUParticles2D` nodes. The :ref:`ParticleProcessMaterial.anim_speed_max` or :ref:`CPUParticles2D.anim_speed_max` should also be set to a positive value for the animation to play. @@ -254,3 +254,4 @@ This property (and other ``particles_anim_*`` properties that depend on it) has .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index 9078e14198d..792e9d30454 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -76,15 +76,15 @@ Methods .. table:: :widths: auto - +---------------------------------------+----------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_canvas` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_final_transform` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------+ - | void | :ref:`hide` **(** **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------+ - | void | :ref:`show` **(** **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------+ + +---------------------------------------+----------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_canvas`\ (\ ) |const| | + +---------------------------------------+----------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_final_transform`\ (\ ) |const| | + +---------------------------------------+----------------------------------------------------------------------------------------+ + | |void| | :ref:`hide`\ (\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------+ + | |void| | :ref:`show`\ (\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -99,7 +99,7 @@ Signals .. rst-class:: classref-signal -**visibility_changed** **(** **)** +**visibility_changed**\ (\ ) Emitted when visibility of the layer is changed. See :ref:`visible`. @@ -120,8 +120,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_custom_viewport** **(** :ref:`Node` value **)** -- :ref:`Node` **get_custom_viewport** **(** **)** +- |void| **set_custom_viewport**\ (\ value\: :ref:`Node`\ ) +- :ref:`Node` **get_custom_viewport**\ (\ ) The custom :ref:`Viewport` node assigned to the **CanvasLayer**. If ``null``, uses the default viewport instead. @@ -137,8 +137,8 @@ The custom :ref:`Viewport` node assigned to the **CanvasLayer**. .. rst-class:: classref-property-setget -- void **set_follow_viewport** **(** :ref:`bool` value **)** -- :ref:`bool` **is_following_viewport** **(** **)** +- |void| **set_follow_viewport**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_following_viewport**\ (\ ) If enabled, the **CanvasLayer** will use the viewport's transform, so it will move when camera moves instead of being anchored in a fixed position on the screen. @@ -156,8 +156,8 @@ Together with :ref:`follow_viewport_scale` value **)** -- :ref:`float` **get_follow_viewport_scale** **(** **)** +- |void| **set_follow_viewport_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_follow_viewport_scale**\ (\ ) Scales the layer when using :ref:`follow_viewport_enabled`. Layers moving into the foreground should have increasing scales, while layers moving into the background should have decreasing scales. @@ -173,8 +173,8 @@ Scales the layer when using :ref:`follow_viewport_enabled` value **)** -- :ref:`int` **get_layer** **(** **)** +- |void| **set_layer**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_layer**\ (\ ) Layer index for draw order. Lower values are drawn behind higher values. @@ -192,8 +192,8 @@ Layer index for draw order. Lower values are drawn behind higher values. .. rst-class:: classref-property-setget -- void **set_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_offset** **(** **)** +- |void| **set_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_offset**\ (\ ) The layer's base offset. @@ -209,8 +209,8 @@ The layer's base offset. .. rst-class:: classref-property-setget -- void **set_rotation** **(** :ref:`float` value **)** -- :ref:`float` **get_rotation** **(** **)** +- |void| **set_rotation**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_rotation**\ (\ ) The layer's rotation in radians. @@ -226,8 +226,8 @@ The layer's rotation in radians. .. rst-class:: classref-property-setget -- void **set_scale** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_scale** **(** **)** +- |void| **set_scale**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_scale**\ (\ ) The layer's scale. @@ -243,8 +243,8 @@ The layer's scale. .. rst-class:: classref-property-setget -- void **set_transform** **(** :ref:`Transform2D` value **)** -- :ref:`Transform2D` **get_transform** **(** **)** +- |void| **set_transform**\ (\ value\: :ref:`Transform2D`\ ) +- :ref:`Transform2D` **get_transform**\ (\ ) The layer's transform. @@ -260,8 +260,8 @@ The layer's transform. .. rst-class:: classref-property-setget -- void **set_visible** **(** :ref:`bool` value **)** -- :ref:`bool` **is_visible** **(** **)** +- |void| **set_visible**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_visible**\ (\ ) If ``false``, any :ref:`CanvasItem` under this **CanvasLayer** will be hidden. @@ -280,7 +280,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **get_canvas** **(** **)** |const| +:ref:`RID` **get_canvas**\ (\ ) |const| Returns the RID of the canvas used by this layer. @@ -292,7 +292,7 @@ Returns the RID of the canvas used by this layer. .. rst-class:: classref-method -:ref:`Transform2D` **get_final_transform** **(** **)** |const| +:ref:`Transform2D` **get_final_transform**\ (\ ) |const| Returns the transform from the **CanvasLayer**\ s coordinate system to the :ref:`Viewport`\ s coordinate system. @@ -304,7 +304,7 @@ Returns the transform from the **CanvasLayer**\ s coordinate system to the :ref: .. rst-class:: classref-method -void **hide** **(** **)** +|void| **hide**\ (\ ) Hides any :ref:`CanvasItem` under this **CanvasLayer**. This is equivalent to setting :ref:`visible` to ``false``. @@ -316,7 +316,7 @@ Hides any :ref:`CanvasItem` under this **CanvasLayer**. This i .. rst-class:: classref-method -void **show** **(** **)** +|void| **show**\ (\ ) Shows any :ref:`CanvasItem` under this **CanvasLayer**. This is equivalent to setting :ref:`visible` to ``true``. @@ -327,3 +327,4 @@ Shows any :ref:`CanvasItem` under this **CanvasLayer**. This i .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_canvasmodulate.rst b/classes/class_canvasmodulate.rst index 0c8e1787f48..645746d72f6 100644 --- a/classes/class_canvasmodulate.rst +++ b/classes/class_canvasmodulate.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: color + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -50,8 +53,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_color** **(** **)** +- |void| **set_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_color**\ (\ ) The tint color to apply. @@ -62,3 +65,4 @@ The tint color to apply. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_canvastexture.rst b/classes/class_canvastexture.rst index bf92b2dd98c..281813669d7 100644 --- a/classes/class_canvastexture.rst +++ b/classes/class_canvastexture.rst @@ -73,8 +73,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_diffuse_texture** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_diffuse_texture** **(** **)** +- |void| **set_diffuse_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_diffuse_texture**\ (\ ) The diffuse (color) texture to use. This is the main texture you want to set in most cases. @@ -90,8 +90,8 @@ The diffuse (color) texture to use. This is the main texture you want to set in .. rst-class:: classref-property-setget -- void **set_normal_texture** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_normal_texture** **(** **)** +- |void| **set_normal_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_normal_texture**\ (\ ) The normal map texture to use. Only has a visible effect if :ref:`Light2D`\ s are affecting this **CanvasTexture**. @@ -109,8 +109,8 @@ The normal map texture to use. Only has a visible effect if :ref:`Light2D` value **)** -- :ref:`Color` **get_specular_color** **(** **)** +- |void| **set_specular_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_specular_color**\ (\ ) The multiplier for specular reflection colors. The :ref:`Light2D`'s color is also taken into account when determining the reflection color. Only has a visible effect if :ref:`Light2D`\ s are affecting this **CanvasTexture**. @@ -126,8 +126,8 @@ The multiplier for specular reflection colors. The :ref:`Light2D` .. rst-class:: classref-property-setget -- void **set_specular_shininess** **(** :ref:`float` value **)** -- :ref:`float` **get_specular_shininess** **(** **)** +- |void| **set_specular_shininess**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_specular_shininess**\ (\ ) The specular exponent for :ref:`Light2D` specular reflections. Higher values result in a more glossy/"wet" look, with reflections becoming more localized and less visible overall. The default value of ``1.0`` disables specular reflections entirely. Only has a visible effect if :ref:`Light2D`\ s are affecting this **CanvasTexture**. @@ -143,8 +143,8 @@ The specular exponent for :ref:`Light2D` specular reflections. Hi .. rst-class:: classref-property-setget -- void **set_specular_texture** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_specular_texture** **(** **)** +- |void| **set_specular_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_specular_texture**\ (\ ) The specular map to use for :ref:`Light2D` specular reflections. This should be a grayscale or colored texture, with brighter areas resulting in a higher :ref:`specular_shininess` value. Using a colored :ref:`specular_texture` allows controlling specular shininess on a per-channel basis. Only has a visible effect if :ref:`Light2D`\ s are affecting this **CanvasTexture**. @@ -160,8 +160,8 @@ The specular map to use for :ref:`Light2D` specular reflections. .. rst-class:: classref-property-setget -- void **set_texture_filter** **(** :ref:`TextureFilter` value **)** -- :ref:`TextureFilter` **get_texture_filter** **(** **)** +- |void| **set_texture_filter**\ (\ value\: :ref:`TextureFilter`\ ) +- :ref:`TextureFilter` **get_texture_filter**\ (\ ) The texture filtering mode to use when drawing this **CanvasTexture**. @@ -177,8 +177,8 @@ The texture filtering mode to use when drawing this **CanvasTexture**. .. rst-class:: classref-property-setget -- void **set_texture_repeat** **(** :ref:`TextureRepeat` value **)** -- :ref:`TextureRepeat` **get_texture_repeat** **(** **)** +- |void| **set_texture_repeat**\ (\ value\: :ref:`TextureRepeat`\ ) +- :ref:`TextureRepeat` **get_texture_repeat**\ (\ ) The texture repeat mode to use when drawing this **CanvasTexture**. @@ -189,3 +189,4 @@ The texture repeat mode to use when drawing this **CanvasTexture**. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_capsulemesh.rst b/classes/class_capsulemesh.rst index 9a6686e0c50..2cdbd1b4777 100644 --- a/classes/class_capsulemesh.rst +++ b/classes/class_capsulemesh.rst @@ -56,8 +56,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_height** **(** :ref:`float` value **)** -- :ref:`float` **get_height** **(** **)** +- |void| **set_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_height**\ (\ ) Total height of the capsule mesh (including the hemispherical ends). @@ -73,8 +73,8 @@ Total height of the capsule mesh (including the hemispherical ends). .. rst-class:: classref-property-setget -- void **set_radial_segments** **(** :ref:`int` value **)** -- :ref:`int` **get_radial_segments** **(** **)** +- |void| **set_radial_segments**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_radial_segments**\ (\ ) Number of radial segments on the capsule mesh. @@ -90,8 +90,8 @@ Number of radial segments on the capsule mesh. .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) Radius of the capsule mesh. @@ -107,8 +107,8 @@ Radius of the capsule mesh. .. rst-class:: classref-property-setget -- void **set_rings** **(** :ref:`int` value **)** -- :ref:`int` **get_rings** **(** **)** +- |void| **set_rings**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_rings**\ (\ ) Number of rings along the height of the capsule. @@ -119,3 +119,4 @@ Number of rings along the height of the capsule. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index f845eb04122..d2d002d1079 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -54,8 +54,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_height** **(** :ref:`float` value **)** -- :ref:`float` **get_height** **(** **)** +- |void| **set_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_height**\ (\ ) The capsule's height. @@ -71,8 +71,8 @@ The capsule's height. .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) The capsule's radius. @@ -83,3 +83,4 @@ The capsule's radius. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_capsuleshape3d.rst b/classes/class_capsuleshape3d.rst index 4406449bdbe..0bde8e5d166 100644 --- a/classes/class_capsuleshape3d.rst +++ b/classes/class_capsuleshape3d.rst @@ -61,8 +61,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_height** **(** :ref:`float` value **)** -- :ref:`float` **get_height** **(** **)** +- |void| **set_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_height**\ (\ ) The capsule's height. @@ -78,8 +78,8 @@ The capsule's height. .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) The capsule's radius. @@ -90,3 +90,4 @@ The capsule's radius. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index a5063b808cb..65262727954 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -57,8 +57,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_use_top_left** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_top_left** **(** **)** +- |void| **set_use_top_left**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_top_left**\ (\ ) If ``true``, centers children relative to the **CenterContainer**'s top left corner. @@ -69,3 +69,4 @@ If ``true``, centers children relative to the **CenterContainer**'s top left cor .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_characterbody2d.rst b/classes/class_characterbody2d.rst index 1e9767c8fd5..b18d5619598 100644 --- a/classes/class_characterbody2d.rst +++ b/classes/class_characterbody2d.rst @@ -84,43 +84,43 @@ Methods .. table:: :widths: auto - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_floor_snap` **(** **)** | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_floor_angle` **(** :ref:`Vector2` up_direction=Vector2(0, -1) **)** |const| | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_floor_normal` **(** **)** |const| | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_last_motion` **(** **)** |const| | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`KinematicCollision2D` | :ref:`get_last_slide_collision` **(** **)** | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_platform_velocity` **(** **)** |const| | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_position_delta` **(** **)** |const| | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_real_velocity` **(** **)** |const| | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`KinematicCollision2D` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_slide_collision_count` **(** **)** |const| | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_wall_normal` **(** **)** |const| | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_on_ceiling` **(** **)** |const| | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_on_ceiling_only` **(** **)** |const| | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_on_floor` **(** **)** |const| | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_on_floor_only` **(** **)** |const| | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_on_wall` **(** **)** |const| | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_on_wall_only` **(** **)** |const| | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`move_and_slide` **(** **)** | - +---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_floor_snap`\ (\ ) | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_floor_angle`\ (\ up_direction\: :ref:`Vector2` = Vector2(0, -1)\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_floor_normal`\ (\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_last_motion`\ (\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`KinematicCollision2D` | :ref:`get_last_slide_collision`\ (\ ) | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_platform_velocity`\ (\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_position_delta`\ (\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_real_velocity`\ (\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`KinematicCollision2D` | :ref:`get_slide_collision`\ (\ slide_idx\: :ref:`int`\ ) | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_slide_collision_count`\ (\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_wall_normal`\ (\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_on_ceiling`\ (\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_on_ceiling_only`\ (\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_on_floor`\ (\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_on_floor_only`\ (\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_on_wall`\ (\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_on_wall_only`\ (\ ) |const| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`move_and_slide`\ (\ ) | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -204,8 +204,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_floor_block_on_wall_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_floor_block_on_wall_enabled** **(** **)** +- |void| **set_floor_block_on_wall_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_floor_block_on_wall_enabled**\ (\ ) If ``true``, the body will be able to move on the floor only. This option avoids to be able to walk on walls, it will however allow to slide down along them. @@ -221,8 +221,8 @@ If ``true``, the body will be able to move on the floor only. This option avoids .. rst-class:: classref-property-setget -- void **set_floor_constant_speed_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_floor_constant_speed_enabled** **(** **)** +- |void| **set_floor_constant_speed_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_floor_constant_speed_enabled**\ (\ ) If ``false`` (by default), the body will move faster on downward slopes and slower on upward slopes. @@ -240,8 +240,8 @@ If ``true``, the body will always move at the same speed on the ground no matter .. rst-class:: classref-property-setget -- void **set_floor_max_angle** **(** :ref:`float` value **)** -- :ref:`float` **get_floor_max_angle** **(** **)** +- |void| **set_floor_max_angle**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_floor_max_angle**\ (\ ) Maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall, when calling :ref:`move_and_slide`. The default value equals 45 degrees. @@ -257,8 +257,8 @@ Maximum angle (in radians) where a slope is still considered a floor (or a ceili .. rst-class:: classref-property-setget -- void **set_floor_snap_length** **(** :ref:`float` value **)** -- :ref:`float` **get_floor_snap_length** **(** **)** +- |void| **set_floor_snap_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_floor_snap_length**\ (\ ) Sets a snapping distance. When set to a value different from ``0.0``, the body is kept attached to slopes when calling :ref:`move_and_slide`. The snapping vector is determined by the given distance along the opposite direction of the :ref:`up_direction`. @@ -276,8 +276,8 @@ As long as the snapping vector is in contact with the ground and the body moves .. rst-class:: classref-property-setget -- void **set_floor_stop_on_slope_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_floor_stop_on_slope_enabled** **(** **)** +- |void| **set_floor_stop_on_slope_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_floor_stop_on_slope_enabled**\ (\ ) If ``true``, the body will not slide on slopes when calling :ref:`move_and_slide` when the body is standing still. @@ -295,8 +295,8 @@ If ``false``, the body will slide on floor's slopes when :ref:`velocity` value **)** -- :ref:`int` **get_max_slides** **(** **)** +- |void| **set_max_slides**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_slides**\ (\ ) Maximum number of times the body can change direction before it stops when calling :ref:`move_and_slide`. @@ -312,8 +312,8 @@ Maximum number of times the body can change direction before it stops when calli .. rst-class:: classref-property-setget -- void **set_motion_mode** **(** :ref:`MotionMode` value **)** -- :ref:`MotionMode` **get_motion_mode** **(** **)** +- |void| **set_motion_mode**\ (\ value\: :ref:`MotionMode`\ ) +- :ref:`MotionMode` **get_motion_mode**\ (\ ) Sets the motion mode which defines the behavior of :ref:`move_and_slide`. See :ref:`MotionMode` constants for available modes. @@ -329,8 +329,8 @@ Sets the motion mode which defines the behavior of :ref:`move_and_slide` value **)** -- :ref:`int` **get_platform_floor_layers** **(** **)** +- |void| **set_platform_floor_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_platform_floor_layers**\ (\ ) Collision layers that will be included for detecting floor bodies that will act as moving platforms to be followed by the **CharacterBody2D**. By default, all floor bodies are detected and propagate their velocity. @@ -346,8 +346,8 @@ Collision layers that will be included for detecting floor bodies that will act .. rst-class:: classref-property-setget -- void **set_platform_on_leave** **(** :ref:`PlatformOnLeave` value **)** -- :ref:`PlatformOnLeave` **get_platform_on_leave** **(** **)** +- |void| **set_platform_on_leave**\ (\ value\: :ref:`PlatformOnLeave`\ ) +- :ref:`PlatformOnLeave` **get_platform_on_leave**\ (\ ) Sets the behavior to apply when you leave a moving platform. By default, to be physically accurate, when you leave the last platform velocity is applied. See :ref:`PlatformOnLeave` constants for available behavior. @@ -363,8 +363,8 @@ Sets the behavior to apply when you leave a moving platform. By default, to be p .. rst-class:: classref-property-setget -- void **set_platform_wall_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_platform_wall_layers** **(** **)** +- |void| **set_platform_wall_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_platform_wall_layers**\ (\ ) Collision layers that will be included for detecting wall bodies that will act as moving platforms to be followed by the **CharacterBody2D**. By default, all wall bodies are ignored. @@ -380,8 +380,8 @@ Collision layers that will be included for detecting wall bodies that will act a .. rst-class:: classref-property-setget -- void **set_safe_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_safe_margin** **(** **)** +- |void| **set_safe_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_safe_margin**\ (\ ) Extra margin used for collision recovery when calling :ref:`move_and_slide`. @@ -403,8 +403,8 @@ A lower value forces the collision algorithm to use more exact detection, so it .. rst-class:: classref-property-setget -- void **set_slide_on_ceiling_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_slide_on_ceiling_enabled** **(** **)** +- |void| **set_slide_on_ceiling_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_slide_on_ceiling_enabled**\ (\ ) If ``true``, during a jump against the ceiling, the body will slide, if ``false`` it will be stopped and will fall vertically. @@ -420,8 +420,8 @@ If ``true``, during a jump against the ceiling, the body will slide, if ``false` .. rst-class:: classref-property-setget -- void **set_up_direction** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_up_direction** **(** **)** +- |void| **set_up_direction**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_up_direction**\ (\ ) Vector pointing upwards, used to determine what is a wall and what is a floor (or a ceiling) when calling :ref:`move_and_slide`. Defaults to :ref:`Vector2.UP`. As the vector will be normalized it can't be equal to :ref:`Vector2.ZERO`, if you want all collisions to be reported as walls, consider using :ref:`MOTION_MODE_FLOATING` as :ref:`motion_mode`. @@ -437,8 +437,8 @@ Vector pointing upwards, used to determine what is a wall and what is a floor (o .. rst-class:: classref-property-setget -- void **set_velocity** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_velocity** **(** **)** +- |void| **set_velocity**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_velocity**\ (\ ) Current velocity vector in pixels per second, used and modified during calls to :ref:`move_and_slide`. @@ -454,8 +454,8 @@ Current velocity vector in pixels per second, used and modified during calls to .. rst-class:: classref-property-setget -- void **set_wall_min_slide_angle** **(** :ref:`float` value **)** -- :ref:`float` **get_wall_min_slide_angle** **(** **)** +- |void| **set_wall_min_slide_angle**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_wall_min_slide_angle**\ (\ ) Minimum angle (in radians) where the body is allowed to slide when it encounters a slope. The default value equals 15 degrees. This property only affects movement when :ref:`motion_mode` is :ref:`MOTION_MODE_FLOATING`. @@ -472,7 +472,7 @@ Method Descriptions .. rst-class:: classref-method -void **apply_floor_snap** **(** **)** +|void| **apply_floor_snap**\ (\ ) Allows to manually apply a snap to the floor regardless of the body's velocity. This function does nothing when :ref:`is_on_floor` returns ``true``. @@ -484,7 +484,7 @@ Allows to manually apply a snap to the floor regardless of the body's velocity. .. rst-class:: classref-method -:ref:`float` **get_floor_angle** **(** :ref:`Vector2` up_direction=Vector2(0, -1) **)** |const| +:ref:`float` **get_floor_angle**\ (\ up_direction\: :ref:`Vector2` = Vector2(0, -1)\ ) |const| Returns the floor's collision angle at the last collision point according to ``up_direction``, which is :ref:`Vector2.UP` by default. This value is always positive and only valid after calling :ref:`move_and_slide` and when :ref:`is_on_floor` returns ``true``. @@ -496,7 +496,7 @@ Returns the floor's collision angle at the last collision point according to ``u .. rst-class:: classref-method -:ref:`Vector2` **get_floor_normal** **(** **)** |const| +:ref:`Vector2` **get_floor_normal**\ (\ ) |const| Returns the surface normal of the floor at the last collision point. Only valid after calling :ref:`move_and_slide` and when :ref:`is_on_floor` returns ``true``. @@ -508,7 +508,7 @@ Returns the surface normal of the floor at the last collision point. Only valid .. rst-class:: classref-method -:ref:`Vector2` **get_last_motion** **(** **)** |const| +:ref:`Vector2` **get_last_motion**\ (\ ) |const| Returns the last motion applied to the **CharacterBody2D** during the last call to :ref:`move_and_slide`. The movement can be split into multiple motions when sliding occurs, and this method return the last one, which is useful to retrieve the current direction of the movement. @@ -520,7 +520,7 @@ Returns the last motion applied to the **CharacterBody2D** during the last call .. rst-class:: classref-method -:ref:`KinematicCollision2D` **get_last_slide_collision** **(** **)** +:ref:`KinematicCollision2D` **get_last_slide_collision**\ (\ ) Returns a :ref:`KinematicCollision2D`, which contains information about the latest collision that occurred during the last call to :ref:`move_and_slide`. @@ -532,7 +532,7 @@ Returns a :ref:`KinematicCollision2D`, which contain .. rst-class:: classref-method -:ref:`Vector2` **get_platform_velocity** **(** **)** |const| +:ref:`Vector2` **get_platform_velocity**\ (\ ) |const| Returns the linear velocity of the platform at the last collision point. Only valid after calling :ref:`move_and_slide`. @@ -544,7 +544,7 @@ Returns the linear velocity of the platform at the last collision point. Only va .. rst-class:: classref-method -:ref:`Vector2` **get_position_delta** **(** **)** |const| +:ref:`Vector2` **get_position_delta**\ (\ ) |const| Returns the travel (position delta) that occurred during the last call to :ref:`move_and_slide`. @@ -556,7 +556,7 @@ Returns the travel (position delta) that occurred during the last call to :ref:` .. rst-class:: classref-method -:ref:`Vector2` **get_real_velocity** **(** **)** |const| +:ref:`Vector2` **get_real_velocity**\ (\ ) |const| Returns the current real velocity since the last call to :ref:`move_and_slide`. For example, when you climb a slope, you will move diagonally even though the velocity is horizontal. This method returns the diagonal movement, as opposed to :ref:`velocity` which returns the requested velocity. @@ -568,7 +568,7 @@ Returns the current real velocity since the last call to :ref:`move_and_slide` **get_slide_collision** **(** :ref:`int` slide_idx **)** +:ref:`KinematicCollision2D` **get_slide_collision**\ (\ slide_idx\: :ref:`int`\ ) Returns a :ref:`KinematicCollision2D`, which contains information about a collision that occurred during the last call to :ref:`move_and_slide`. Since the body can collide several times in a single call to :ref:`move_and_slide`, you must specify the index of the collision in the range 0 to (:ref:`get_slide_collision_count` - 1). @@ -601,7 +601,7 @@ Returns a :ref:`KinematicCollision2D`, which contain .. rst-class:: classref-method -:ref:`int` **get_slide_collision_count** **(** **)** |const| +:ref:`int` **get_slide_collision_count**\ (\ ) |const| Returns the number of times the body collided and changed direction during the last call to :ref:`move_and_slide`. @@ -613,7 +613,7 @@ Returns the number of times the body collided and changed direction during the l .. rst-class:: classref-method -:ref:`Vector2` **get_wall_normal** **(** **)** |const| +:ref:`Vector2` **get_wall_normal**\ (\ ) |const| Returns the surface normal of the wall at the last collision point. Only valid after calling :ref:`move_and_slide` and when :ref:`is_on_wall` returns ``true``. @@ -625,7 +625,7 @@ Returns the surface normal of the wall at the last collision point. Only valid a .. rst-class:: classref-method -:ref:`bool` **is_on_ceiling** **(** **)** |const| +:ref:`bool` **is_on_ceiling**\ (\ ) |const| Returns ``true`` if the body collided with the ceiling on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "ceiling" or not. @@ -637,7 +637,7 @@ Returns ``true`` if the body collided with the ceiling on the last call of :ref: .. rst-class:: classref-method -:ref:`bool` **is_on_ceiling_only** **(** **)** |const| +:ref:`bool` **is_on_ceiling_only**\ (\ ) |const| Returns ``true`` if the body collided only with the ceiling on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "ceiling" or not. @@ -649,7 +649,7 @@ Returns ``true`` if the body collided only with the ceiling on the last call of .. rst-class:: classref-method -:ref:`bool` **is_on_floor** **(** **)** |const| +:ref:`bool` **is_on_floor**\ (\ ) |const| Returns ``true`` if the body collided with the floor on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "floor" or not. @@ -661,7 +661,7 @@ Returns ``true`` if the body collided with the floor on the last call of :ref:`m .. rst-class:: classref-method -:ref:`bool` **is_on_floor_only** **(** **)** |const| +:ref:`bool` **is_on_floor_only**\ (\ ) |const| Returns ``true`` if the body collided only with the floor on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "floor" or not. @@ -673,7 +673,7 @@ Returns ``true`` if the body collided only with the floor on the last call of :r .. rst-class:: classref-method -:ref:`bool` **is_on_wall** **(** **)** |const| +:ref:`bool` **is_on_wall**\ (\ ) |const| Returns ``true`` if the body collided with a wall on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "wall" or not. @@ -685,7 +685,7 @@ Returns ``true`` if the body collided with a wall on the last call of :ref:`move .. rst-class:: classref-method -:ref:`bool` **is_on_wall_only** **(** **)** |const| +:ref:`bool` **is_on_wall_only**\ (\ ) |const| Returns ``true`` if the body collided only with a wall on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "wall" or not. @@ -697,7 +697,7 @@ Returns ``true`` if the body collided only with a wall on the last call of :ref: .. rst-class:: classref-method -:ref:`bool` **move_and_slide** **(** **)** +:ref:`bool` **move_and_slide**\ (\ ) Moves the body based on :ref:`velocity`. If the body collides with another, it will slide along the other body (by default only on floor) rather than stop immediately. If the other body is a **CharacterBody2D** or :ref:`RigidBody2D`, it will also be affected by the motion of the other body. You can use this to make moving and rotating platforms, or to make nodes push other nodes. @@ -716,3 +716,4 @@ Returns ``true`` if the body collided, otherwise, returns ``false``. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_characterbody3d.rst b/classes/class_characterbody3d.rst index 27f0252ea22..d9e49bf051b 100644 --- a/classes/class_characterbody3d.rst +++ b/classes/class_characterbody3d.rst @@ -86,45 +86,45 @@ Methods .. table:: :widths: auto - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_floor_snap` **(** **)** | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_floor_angle` **(** :ref:`Vector3` up_direction=Vector3(0, 1, 0) **)** |const| | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_floor_normal` **(** **)** |const| | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_last_motion` **(** **)** |const| | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`KinematicCollision3D` | :ref:`get_last_slide_collision` **(** **)** | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_platform_angular_velocity` **(** **)** |const| | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_platform_velocity` **(** **)** |const| | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_position_delta` **(** **)** |const| | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_real_velocity` **(** **)** |const| | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`KinematicCollision3D` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_slide_collision_count` **(** **)** |const| | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_wall_normal` **(** **)** |const| | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_on_ceiling` **(** **)** |const| | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_on_ceiling_only` **(** **)** |const| | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_on_floor` **(** **)** |const| | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_on_floor_only` **(** **)** |const| | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_on_wall` **(** **)** |const| | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_on_wall_only` **(** **)** |const| | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`move_and_slide` **(** **)** | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_floor_snap`\ (\ ) | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_floor_angle`\ (\ up_direction\: :ref:`Vector3` = Vector3(0, 1, 0)\ ) |const| | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_floor_normal`\ (\ ) |const| | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_last_motion`\ (\ ) |const| | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`KinematicCollision3D` | :ref:`get_last_slide_collision`\ (\ ) | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_platform_angular_velocity`\ (\ ) |const| | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_platform_velocity`\ (\ ) |const| | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_position_delta`\ (\ ) |const| | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_real_velocity`\ (\ ) |const| | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`KinematicCollision3D` | :ref:`get_slide_collision`\ (\ slide_idx\: :ref:`int`\ ) | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_slide_collision_count`\ (\ ) |const| | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_wall_normal`\ (\ ) |const| | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_on_ceiling`\ (\ ) |const| | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_on_ceiling_only`\ (\ ) |const| | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_on_floor`\ (\ ) |const| | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_on_floor_only`\ (\ ) |const| | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_on_wall`\ (\ ) |const| | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_on_wall_only`\ (\ ) |const| | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`move_and_slide`\ (\ ) | + +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -208,8 +208,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_floor_block_on_wall_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_floor_block_on_wall_enabled** **(** **)** +- |void| **set_floor_block_on_wall_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_floor_block_on_wall_enabled**\ (\ ) If ``true``, the body will be able to move on the floor only. This option avoids to be able to walk on walls, it will however allow to slide down along them. @@ -225,8 +225,8 @@ If ``true``, the body will be able to move on the floor only. This option avoids .. rst-class:: classref-property-setget -- void **set_floor_constant_speed_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_floor_constant_speed_enabled** **(** **)** +- |void| **set_floor_constant_speed_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_floor_constant_speed_enabled**\ (\ ) If ``false`` (by default), the body will move faster on downward slopes and slower on upward slopes. @@ -244,8 +244,8 @@ If ``true``, the body will always move at the same speed on the ground no matter .. rst-class:: classref-property-setget -- void **set_floor_max_angle** **(** :ref:`float` value **)** -- :ref:`float` **get_floor_max_angle** **(** **)** +- |void| **set_floor_max_angle**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_floor_max_angle**\ (\ ) Maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall, when calling :ref:`move_and_slide`. The default value equals 45 degrees. @@ -261,8 +261,8 @@ Maximum angle (in radians) where a slope is still considered a floor (or a ceili .. rst-class:: classref-property-setget -- void **set_floor_snap_length** **(** :ref:`float` value **)** -- :ref:`float` **get_floor_snap_length** **(** **)** +- |void| **set_floor_snap_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_floor_snap_length**\ (\ ) Sets a snapping distance. When set to a value different from ``0.0``, the body is kept attached to slopes when calling :ref:`move_and_slide`. The snapping vector is determined by the given distance along the opposite direction of the :ref:`up_direction`. @@ -280,8 +280,8 @@ As long as the snapping vector is in contact with the ground and the body moves .. rst-class:: classref-property-setget -- void **set_floor_stop_on_slope_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_floor_stop_on_slope_enabled** **(** **)** +- |void| **set_floor_stop_on_slope_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_floor_stop_on_slope_enabled**\ (\ ) If ``true``, the body will not slide on slopes when calling :ref:`move_and_slide` when the body is standing still. @@ -299,8 +299,8 @@ If ``false``, the body will slide on floor's slopes when :ref:`velocity` value **)** -- :ref:`int` **get_max_slides** **(** **)** +- |void| **set_max_slides**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_slides**\ (\ ) Maximum number of times the body can change direction before it stops when calling :ref:`move_and_slide`. @@ -316,8 +316,8 @@ Maximum number of times the body can change direction before it stops when calli .. rst-class:: classref-property-setget -- void **set_motion_mode** **(** :ref:`MotionMode` value **)** -- :ref:`MotionMode` **get_motion_mode** **(** **)** +- |void| **set_motion_mode**\ (\ value\: :ref:`MotionMode`\ ) +- :ref:`MotionMode` **get_motion_mode**\ (\ ) Sets the motion mode which defines the behavior of :ref:`move_and_slide`. See :ref:`MotionMode` constants for available modes. @@ -333,8 +333,8 @@ Sets the motion mode which defines the behavior of :ref:`move_and_slide` value **)** -- :ref:`int` **get_platform_floor_layers** **(** **)** +- |void| **set_platform_floor_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_platform_floor_layers**\ (\ ) Collision layers that will be included for detecting floor bodies that will act as moving platforms to be followed by the **CharacterBody3D**. By default, all floor bodies are detected and propagate their velocity. @@ -350,8 +350,8 @@ Collision layers that will be included for detecting floor bodies that will act .. rst-class:: classref-property-setget -- void **set_platform_on_leave** **(** :ref:`PlatformOnLeave` value **)** -- :ref:`PlatformOnLeave` **get_platform_on_leave** **(** **)** +- |void| **set_platform_on_leave**\ (\ value\: :ref:`PlatformOnLeave`\ ) +- :ref:`PlatformOnLeave` **get_platform_on_leave**\ (\ ) Sets the behavior to apply when you leave a moving platform. By default, to be physically accurate, when you leave the last platform velocity is applied. See :ref:`PlatformOnLeave` constants for available behavior. @@ -367,8 +367,8 @@ Sets the behavior to apply when you leave a moving platform. By default, to be p .. rst-class:: classref-property-setget -- void **set_platform_wall_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_platform_wall_layers** **(** **)** +- |void| **set_platform_wall_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_platform_wall_layers**\ (\ ) Collision layers that will be included for detecting wall bodies that will act as moving platforms to be followed by the **CharacterBody3D**. By default, all wall bodies are ignored. @@ -384,8 +384,8 @@ Collision layers that will be included for detecting wall bodies that will act a .. rst-class:: classref-property-setget -- void **set_safe_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_safe_margin** **(** **)** +- |void| **set_safe_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_safe_margin**\ (\ ) Extra margin used for collision recovery when calling :ref:`move_and_slide`. @@ -407,8 +407,8 @@ A lower value forces the collision algorithm to use more exact detection, so it .. rst-class:: classref-property-setget -- void **set_slide_on_ceiling_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_slide_on_ceiling_enabled** **(** **)** +- |void| **set_slide_on_ceiling_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_slide_on_ceiling_enabled**\ (\ ) If ``true``, during a jump against the ceiling, the body will slide, if ``false`` it will be stopped and will fall vertically. @@ -424,8 +424,8 @@ If ``true``, during a jump against the ceiling, the body will slide, if ``false` .. rst-class:: classref-property-setget -- void **set_up_direction** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_up_direction** **(** **)** +- |void| **set_up_direction**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_up_direction**\ (\ ) Vector pointing upwards, used to determine what is a wall and what is a floor (or a ceiling) when calling :ref:`move_and_slide`. Defaults to :ref:`Vector3.UP`. As the vector will be normalized it can't be equal to :ref:`Vector3.ZERO`, if you want all collisions to be reported as walls, consider using :ref:`MOTION_MODE_FLOATING` as :ref:`motion_mode`. @@ -441,8 +441,8 @@ Vector pointing upwards, used to determine what is a wall and what is a floor (o .. rst-class:: classref-property-setget -- void **set_velocity** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_velocity** **(** **)** +- |void| **set_velocity**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_velocity**\ (\ ) Current velocity vector (typically meters per second), used and modified during calls to :ref:`move_and_slide`. @@ -458,8 +458,8 @@ Current velocity vector (typically meters per second), used and modified during .. rst-class:: classref-property-setget -- void **set_wall_min_slide_angle** **(** :ref:`float` value **)** -- :ref:`float` **get_wall_min_slide_angle** **(** **)** +- |void| **set_wall_min_slide_angle**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_wall_min_slide_angle**\ (\ ) Minimum angle (in radians) where the body is allowed to slide when it encounters a slope. The default value equals 15 degrees. When :ref:`motion_mode` is :ref:`MOTION_MODE_GROUNDED`, it only affects movement if :ref:`floor_block_on_wall` is ``true``. @@ -476,7 +476,7 @@ Method Descriptions .. rst-class:: classref-method -void **apply_floor_snap** **(** **)** +|void| **apply_floor_snap**\ (\ ) Allows to manually apply a snap to the floor regardless of the body's velocity. This function does nothing when :ref:`is_on_floor` returns ``true``. @@ -488,7 +488,7 @@ Allows to manually apply a snap to the floor regardless of the body's velocity. .. rst-class:: classref-method -:ref:`float` **get_floor_angle** **(** :ref:`Vector3` up_direction=Vector3(0, 1, 0) **)** |const| +:ref:`float` **get_floor_angle**\ (\ up_direction\: :ref:`Vector3` = Vector3(0, 1, 0)\ ) |const| Returns the floor's collision angle at the last collision point according to ``up_direction``, which is :ref:`Vector3.UP` by default. This value is always positive and only valid after calling :ref:`move_and_slide` and when :ref:`is_on_floor` returns ``true``. @@ -500,7 +500,7 @@ Returns the floor's collision angle at the last collision point according to ``u .. rst-class:: classref-method -:ref:`Vector3` **get_floor_normal** **(** **)** |const| +:ref:`Vector3` **get_floor_normal**\ (\ ) |const| Returns the surface normal of the floor at the last collision point. Only valid after calling :ref:`move_and_slide` and when :ref:`is_on_floor` returns ``true``. @@ -512,7 +512,7 @@ Returns the surface normal of the floor at the last collision point. Only valid .. rst-class:: classref-method -:ref:`Vector3` **get_last_motion** **(** **)** |const| +:ref:`Vector3` **get_last_motion**\ (\ ) |const| Returns the last motion applied to the **CharacterBody3D** during the last call to :ref:`move_and_slide`. The movement can be split into multiple motions when sliding occurs, and this method return the last one, which is useful to retrieve the current direction of the movement. @@ -524,7 +524,7 @@ Returns the last motion applied to the **CharacterBody3D** during the last call .. rst-class:: classref-method -:ref:`KinematicCollision3D` **get_last_slide_collision** **(** **)** +:ref:`KinematicCollision3D` **get_last_slide_collision**\ (\ ) Returns a :ref:`KinematicCollision3D`, which contains information about the latest collision that occurred during the last call to :ref:`move_and_slide`. @@ -536,7 +536,7 @@ Returns a :ref:`KinematicCollision3D`, which contain .. rst-class:: classref-method -:ref:`Vector3` **get_platform_angular_velocity** **(** **)** |const| +:ref:`Vector3` **get_platform_angular_velocity**\ (\ ) |const| Returns the angular velocity of the platform at the last collision point. Only valid after calling :ref:`move_and_slide`. @@ -548,7 +548,7 @@ Returns the angular velocity of the platform at the last collision point. Only v .. rst-class:: classref-method -:ref:`Vector3` **get_platform_velocity** **(** **)** |const| +:ref:`Vector3` **get_platform_velocity**\ (\ ) |const| Returns the linear velocity of the platform at the last collision point. Only valid after calling :ref:`move_and_slide`. @@ -560,7 +560,7 @@ Returns the linear velocity of the platform at the last collision point. Only va .. rst-class:: classref-method -:ref:`Vector3` **get_position_delta** **(** **)** |const| +:ref:`Vector3` **get_position_delta**\ (\ ) |const| Returns the travel (position delta) that occurred during the last call to :ref:`move_and_slide`. @@ -572,7 +572,7 @@ Returns the travel (position delta) that occurred during the last call to :ref:` .. rst-class:: classref-method -:ref:`Vector3` **get_real_velocity** **(** **)** |const| +:ref:`Vector3` **get_real_velocity**\ (\ ) |const| Returns the current real velocity since the last call to :ref:`move_and_slide`. For example, when you climb a slope, you will move diagonally even though the velocity is horizontal. This method returns the diagonal movement, as opposed to :ref:`velocity` which returns the requested velocity. @@ -584,7 +584,7 @@ Returns the current real velocity since the last call to :ref:`move_and_slide` **get_slide_collision** **(** :ref:`int` slide_idx **)** +:ref:`KinematicCollision3D` **get_slide_collision**\ (\ slide_idx\: :ref:`int`\ ) Returns a :ref:`KinematicCollision3D`, which contains information about a collision that occurred during the last call to :ref:`move_and_slide`. Since the body can collide several times in a single call to :ref:`move_and_slide`, you must specify the index of the collision in the range 0 to (:ref:`get_slide_collision_count` - 1). @@ -596,7 +596,7 @@ Returns a :ref:`KinematicCollision3D`, which contain .. rst-class:: classref-method -:ref:`int` **get_slide_collision_count** **(** **)** |const| +:ref:`int` **get_slide_collision_count**\ (\ ) |const| Returns the number of times the body collided and changed direction during the last call to :ref:`move_and_slide`. @@ -608,7 +608,7 @@ Returns the number of times the body collided and changed direction during the l .. rst-class:: classref-method -:ref:`Vector3` **get_wall_normal** **(** **)** |const| +:ref:`Vector3` **get_wall_normal**\ (\ ) |const| Returns the surface normal of the wall at the last collision point. Only valid after calling :ref:`move_and_slide` and when :ref:`is_on_wall` returns ``true``. @@ -620,7 +620,7 @@ Returns the surface normal of the wall at the last collision point. Only valid a .. rst-class:: classref-method -:ref:`bool` **is_on_ceiling** **(** **)** |const| +:ref:`bool` **is_on_ceiling**\ (\ ) |const| Returns ``true`` if the body collided with the ceiling on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "ceiling" or not. @@ -632,7 +632,7 @@ Returns ``true`` if the body collided with the ceiling on the last call of :ref: .. rst-class:: classref-method -:ref:`bool` **is_on_ceiling_only** **(** **)** |const| +:ref:`bool` **is_on_ceiling_only**\ (\ ) |const| Returns ``true`` if the body collided only with the ceiling on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "ceiling" or not. @@ -644,7 +644,7 @@ Returns ``true`` if the body collided only with the ceiling on the last call of .. rst-class:: classref-method -:ref:`bool` **is_on_floor** **(** **)** |const| +:ref:`bool` **is_on_floor**\ (\ ) |const| Returns ``true`` if the body collided with the floor on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "floor" or not. @@ -656,7 +656,7 @@ Returns ``true`` if the body collided with the floor on the last call of :ref:`m .. rst-class:: classref-method -:ref:`bool` **is_on_floor_only** **(** **)** |const| +:ref:`bool` **is_on_floor_only**\ (\ ) |const| Returns ``true`` if the body collided only with the floor on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "floor" or not. @@ -668,7 +668,7 @@ Returns ``true`` if the body collided only with the floor on the last call of :r .. rst-class:: classref-method -:ref:`bool` **is_on_wall** **(** **)** |const| +:ref:`bool` **is_on_wall**\ (\ ) |const| Returns ``true`` if the body collided with a wall on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "wall" or not. @@ -680,7 +680,7 @@ Returns ``true`` if the body collided with a wall on the last call of :ref:`move .. rst-class:: classref-method -:ref:`bool` **is_on_wall_only** **(** **)** |const| +:ref:`bool` **is_on_wall_only**\ (\ ) |const| Returns ``true`` if the body collided only with a wall on the last call of :ref:`move_and_slide`. Otherwise, returns ``false``. The :ref:`up_direction` and :ref:`floor_max_angle` are used to determine whether a surface is "wall" or not. @@ -692,7 +692,7 @@ Returns ``true`` if the body collided only with a wall on the last call of :ref: .. rst-class:: classref-method -:ref:`bool` **move_and_slide** **(** **)** +:ref:`bool` **move_and_slide**\ (\ ) Moves the body based on :ref:`velocity`. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a **CharacterBody3D** or :ref:`RigidBody3D`, it will also be affected by the motion of the other body. You can use this to make moving and rotating platforms, or to make nodes push other nodes. @@ -709,3 +709,4 @@ Returns ``true`` if the body collided, otherwise, returns ``false``. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_charfxtransform.rst b/classes/class_charfxtransform.rst index 17c130e8f28..72f6f398acf 100644 --- a/classes/class_charfxtransform.rst +++ b/classes/class_charfxtransform.rst @@ -83,8 +83,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_color** **(** **)** +- |void| **set_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_color**\ (\ ) The color the character will be drawn with. @@ -100,8 +100,8 @@ The color the character will be drawn with. .. rst-class:: classref-property-setget -- void **set_elapsed_time** **(** :ref:`float` value **)** -- :ref:`float` **get_elapsed_time** **(** **)** +- |void| **set_elapsed_time**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_elapsed_time**\ (\ ) The time elapsed since the :ref:`RichTextLabel` was added to the scene tree (in seconds). Time stops when the :ref:`RichTextLabel` is paused (see :ref:`Node.process_mode`). Resets when the text in the :ref:`RichTextLabel` is changed. @@ -119,8 +119,8 @@ The time elapsed since the :ref:`RichTextLabel` was added t .. rst-class:: classref-property-setget -- void **set_environment** **(** :ref:`Dictionary` value **)** -- :ref:`Dictionary` **get_environment** **(** **)** +- |void| **set_environment**\ (\ value\: :ref:`Dictionary`\ ) +- :ref:`Dictionary` **get_environment**\ (\ ) Contains the arguments passed in the opening BBCode tag. By default, arguments are strings; if their contents match a type such as :ref:`bool`, :ref:`int` or :ref:`float`, they will be converted automatically. Color codes in the form ``#rrggbb`` or ``#rgb`` will be converted to an opaque :ref:`Color`. String arguments may not contain spaces, even if they're quoted. If present, quotes will also be present in the final string. @@ -142,8 +142,8 @@ For example, the opening BBCode tag ``[example foo=hello bar=true baz=42 color=# .. rst-class:: classref-property-setget -- void **set_font** **(** :ref:`RID` value **)** -- :ref:`RID` **get_font** **(** **)** +- |void| **set_font**\ (\ value\: :ref:`RID`\ ) +- :ref:`RID` **get_font**\ (\ ) Font resource used to render glyph. @@ -159,8 +159,8 @@ Font resource used to render glyph. .. rst-class:: classref-property-setget -- void **set_glyph_count** **(** :ref:`int` value **)** -- :ref:`int` **get_glyph_count** **(** **)** +- |void| **set_glyph_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_glyph_count**\ (\ ) Number of glyphs in the grapheme cluster. This value is set in the first glyph of a cluster. Setting this property won't affect drawing. @@ -176,8 +176,8 @@ Number of glyphs in the grapheme cluster. This value is set in the first glyph o .. rst-class:: classref-property-setget -- void **set_glyph_flags** **(** :ref:`int` value **)** -- :ref:`int` **get_glyph_flags** **(** **)** +- |void| **set_glyph_flags**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_glyph_flags**\ (\ ) Glyph flags. See :ref:`GraphemeFlag` for more info. Setting this property won't affect drawing. @@ -193,8 +193,8 @@ Glyph flags. See :ref:`GraphemeFlag` for more info .. rst-class:: classref-property-setget -- void **set_glyph_index** **(** :ref:`int` value **)** -- :ref:`int` **get_glyph_index** **(** **)** +- |void| **set_glyph_index**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_glyph_index**\ (\ ) Font specific glyph index. @@ -210,8 +210,8 @@ Font specific glyph index. .. rst-class:: classref-property-setget -- void **set_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_offset** **(** **)** +- |void| **set_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_offset**\ (\ ) The position offset the character will be drawn with (in pixels). @@ -227,8 +227,8 @@ The position offset the character will be drawn with (in pixels). .. rst-class:: classref-property-setget -- void **set_outline** **(** :ref:`bool` value **)** -- :ref:`bool` **is_outline** **(** **)** +- |void| **set_outline**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_outline**\ (\ ) If ``true``, FX transform is called for outline drawing. Setting this property won't affect drawing. @@ -244,8 +244,8 @@ If ``true``, FX transform is called for outline drawing. Setting this property w .. rst-class:: classref-property-setget -- void **set_range** **(** :ref:`Vector2i` value **)** -- :ref:`Vector2i` **get_range** **(** **)** +- |void| **set_range**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_range**\ (\ ) Absolute character range in the string, corresponding to the glyph. Setting this property won't affect drawing. @@ -261,8 +261,8 @@ Absolute character range in the string, corresponding to the glyph. Setting this .. rst-class:: classref-property-setget -- void **set_relative_index** **(** :ref:`int` value **)** -- :ref:`int` **get_relative_index** **(** **)** +- |void| **set_relative_index**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_relative_index**\ (\ ) The character offset of the glyph, relative to the current :ref:`RichTextEffect` custom block. Setting this property won't affect drawing. @@ -278,8 +278,8 @@ The character offset of the glyph, relative to the current :ref:`RichTextEffect< .. rst-class:: classref-property-setget -- void **set_transform** **(** :ref:`Transform2D` value **)** -- :ref:`Transform2D` **get_transform** **(** **)** +- |void| **set_transform**\ (\ value\: :ref:`Transform2D`\ ) +- :ref:`Transform2D` **get_transform**\ (\ ) The current transform of the current glyph. It can be overridden (for example, by driving the position and rotation from a curve). You can also alter the existing value to apply transforms on top of other effects. @@ -295,8 +295,8 @@ The current transform of the current glyph. It can be overridden (for example, b .. rst-class:: classref-property-setget -- void **set_visibility** **(** :ref:`bool` value **)** -- :ref:`bool` **is_visible** **(** **)** +- |void| **set_visibility**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_visible**\ (\ ) If ``true``, the character will be drawn. If ``false``, the character will be hidden. Characters around hidden characters will reflow to take the space of hidden characters. If this is not desired, set their :ref:`color` to ``Color(1, 1, 1, 0)`` instead. @@ -307,3 +307,4 @@ If ``true``, the character will be drawn. If ``false``, the character will be hi .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index c5cf9502a45..39f6ea010a5 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -187,3 +187,4 @@ The check icon to display when the **CheckBox** is unchecked and is disabled. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_checkbutton.rst b/classes/class_checkbutton.rst index 6eb1ff05d2d..fc6901bc1e2 100644 --- a/classes/class_checkbutton.rst +++ b/classes/class_checkbutton.rst @@ -185,3 +185,4 @@ The icon to display when the **CheckButton** is unchecked (for right-to-left lay .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_circleshape2d.rst b/classes/class_circleshape2d.rst index 7fb99a52b11..f239f248dc3 100644 --- a/classes/class_circleshape2d.rst +++ b/classes/class_circleshape2d.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) The circle's radius. @@ -64,3 +64,4 @@ The circle's radius. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index cad69319776..e0e2ebfdf49 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -29,53 +29,53 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`can_instantiate` **(** :ref:`StringName` class **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`class_exists` **(** :ref:`StringName` class **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`class_get_enum_constants` **(** :ref:`StringName` class, :ref:`StringName` enum, :ref:`bool` no_inheritance=false **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`class_get_enum_list` **(** :ref:`StringName` class, :ref:`bool` no_inheritance=false **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`class_get_integer_constant` **(** :ref:`StringName` class, :ref:`StringName` name **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`class_get_integer_constant_enum` **(** :ref:`StringName` class, :ref:`StringName` name, :ref:`bool` no_inheritance=false **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`class_get_integer_constant_list` **(** :ref:`StringName` class, :ref:`bool` no_inheritance=false **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`class_get_method_list` **(** :ref:`StringName` class, :ref:`bool` no_inheritance=false **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`class_get_property` **(** :ref:`Object` object, :ref:`StringName` property **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`class_get_property_list` **(** :ref:`StringName` class, :ref:`bool` no_inheritance=false **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`class_get_signal` **(** :ref:`StringName` class, :ref:`StringName` signal **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`class_get_signal_list` **(** :ref:`StringName` class, :ref:`bool` no_inheritance=false **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`class_has_enum` **(** :ref:`StringName` class, :ref:`StringName` name, :ref:`bool` no_inheritance=false **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`class_has_integer_constant` **(** :ref:`StringName` class, :ref:`StringName` name **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`class_has_method` **(** :ref:`StringName` class, :ref:`StringName` method, :ref:`bool` no_inheritance=false **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`class_has_signal` **(** :ref:`StringName` class, :ref:`StringName` signal **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`class_set_property` **(** :ref:`Object` object, :ref:`StringName` property, :ref:`Variant` value **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_class_list` **(** **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_inheriters_from_class` **(** :ref:`StringName` class **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_parent_class` **(** :ref:`StringName` class **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`instantiate` **(** :ref:`StringName` class **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_class_enabled` **(** :ref:`StringName` class **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_parent_class` **(** :ref:`StringName` class, :ref:`StringName` inherits **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`can_instantiate`\ (\ class\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`class_exists`\ (\ class\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`class_get_enum_constants`\ (\ class\: :ref:`StringName`, enum\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`class_get_enum_list`\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`class_get_integer_constant`\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`class_get_integer_constant_enum`\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`class_get_integer_constant_list`\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`class_get_method_list`\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`class_get_property`\ (\ object\: :ref:`Object`, property\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`class_get_property_list`\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`class_get_signal`\ (\ class\: :ref:`StringName`, signal\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`class_get_signal_list`\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`class_has_enum`\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`class_has_integer_constant`\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`class_has_method`\ (\ class\: :ref:`StringName`, method\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`class_has_signal`\ (\ class\: :ref:`StringName`, signal\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`class_set_property`\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_class_list`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_inheriters_from_class`\ (\ class\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_parent_class`\ (\ class\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`instantiate`\ (\ class\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_class_enabled`\ (\ class\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_parent_class`\ (\ class\: :ref:`StringName`, inherits\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -90,7 +90,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **can_instantiate** **(** :ref:`StringName` class **)** |const| +:ref:`bool` **can_instantiate**\ (\ class\: :ref:`StringName`\ ) |const| Returns ``true`` if objects can be instantiated from the specified ``class``, otherwise returns ``false``. @@ -102,7 +102,7 @@ Returns ``true`` if objects can be instantiated from the specified ``class``, ot .. rst-class:: classref-method -:ref:`bool` **class_exists** **(** :ref:`StringName` class **)** |const| +:ref:`bool` **class_exists**\ (\ class\: :ref:`StringName`\ ) |const| Returns whether the specified ``class`` is available or not. @@ -114,7 +114,7 @@ Returns whether the specified ``class`` is available or not. .. rst-class:: classref-method -:ref:`PackedStringArray` **class_get_enum_constants** **(** :ref:`StringName` class, :ref:`StringName` enum, :ref:`bool` no_inheritance=false **)** |const| +:ref:`PackedStringArray` **class_get_enum_constants**\ (\ class\: :ref:`StringName`, enum\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| Returns an array with all the keys in ``enum`` of ``class`` or its ancestry. @@ -126,7 +126,7 @@ Returns an array with all the keys in ``enum`` of ``class`` or its ancestry. .. rst-class:: classref-method -:ref:`PackedStringArray` **class_get_enum_list** **(** :ref:`StringName` class, :ref:`bool` no_inheritance=false **)** |const| +:ref:`PackedStringArray` **class_get_enum_list**\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| Returns an array with all the enums of ``class`` or its ancestry. @@ -138,7 +138,7 @@ Returns an array with all the enums of ``class`` or its ancestry. .. rst-class:: classref-method -:ref:`int` **class_get_integer_constant** **(** :ref:`StringName` class, :ref:`StringName` name **)** |const| +:ref:`int` **class_get_integer_constant**\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| Returns the value of the integer constant ``name`` of ``class`` or its ancestry. Always returns 0 when the constant could not be found. @@ -150,7 +150,7 @@ Returns the value of the integer constant ``name`` of ``class`` or its ancestry. .. rst-class:: classref-method -:ref:`StringName` **class_get_integer_constant_enum** **(** :ref:`StringName` class, :ref:`StringName` name, :ref:`bool` no_inheritance=false **)** |const| +:ref:`StringName` **class_get_integer_constant_enum**\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| Returns which enum the integer constant ``name`` of ``class`` or its ancestry belongs to. @@ -162,7 +162,7 @@ Returns which enum the integer constant ``name`` of ``class`` or its ancestry be .. rst-class:: classref-method -:ref:`PackedStringArray` **class_get_integer_constant_list** **(** :ref:`StringName` class, :ref:`bool` no_inheritance=false **)** |const| +:ref:`PackedStringArray` **class_get_integer_constant_list**\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| Returns an array with the names all the integer constants of ``class`` or its ancestry. @@ -174,7 +174,7 @@ Returns an array with the names all the integer constants of ``class`` or its an .. rst-class:: classref-method -:ref:`Dictionary[]` **class_get_method_list** **(** :ref:`StringName` class, :ref:`bool` no_inheritance=false **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **class_get_method_list**\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| Returns an array with all the methods of ``class`` or its ancestry if ``no_inheritance`` is ``false``. Every element of the array is a :ref:`Dictionary` with the following keys: ``args``, ``default_args``, ``flags``, ``id``, ``name``, ``return: (class_name, hint, hint_string, name, type, usage)``. @@ -188,7 +188,7 @@ Returns an array with all the methods of ``class`` or its ancestry if ``no_inher .. rst-class:: classref-method -:ref:`Variant` **class_get_property** **(** :ref:`Object` object, :ref:`StringName` property **)** |const| +:ref:`Variant` **class_get_property**\ (\ object\: :ref:`Object`, property\: :ref:`StringName`\ ) |const| Returns the value of ``property`` of ``object`` or its ancestry. @@ -200,7 +200,7 @@ Returns the value of ``property`` of ``object`` or its ancestry. .. rst-class:: classref-method -:ref:`Dictionary[]` **class_get_property_list** **(** :ref:`StringName` class, :ref:`bool` no_inheritance=false **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **class_get_property_list**\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| Returns an array with all the properties of ``class`` or its ancestry if ``no_inheritance`` is ``false``. @@ -212,7 +212,7 @@ Returns an array with all the properties of ``class`` or its ancestry if ``no_in .. rst-class:: classref-method -:ref:`Dictionary` **class_get_signal** **(** :ref:`StringName` class, :ref:`StringName` signal **)** |const| +:ref:`Dictionary` **class_get_signal**\ (\ class\: :ref:`StringName`, signal\: :ref:`StringName`\ ) |const| Returns the ``signal`` data of ``class`` or its ancestry. The returned value is a :ref:`Dictionary` with the following keys: ``args``, ``default_args``, ``flags``, ``id``, ``name``, ``return: (class_name, hint, hint_string, name, type, usage)``. @@ -224,7 +224,7 @@ Returns the ``signal`` data of ``class`` or its ancestry. The returned value is .. rst-class:: classref-method -:ref:`Dictionary[]` **class_get_signal_list** **(** :ref:`StringName` class, :ref:`bool` no_inheritance=false **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **class_get_signal_list**\ (\ class\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| Returns an array with all the signals of ``class`` or its ancestry if ``no_inheritance`` is ``false``. Every element of the array is a :ref:`Dictionary` as described in :ref:`class_get_signal`. @@ -236,7 +236,7 @@ Returns an array with all the signals of ``class`` or its ancestry if ``no_inher .. rst-class:: classref-method -:ref:`bool` **class_has_enum** **(** :ref:`StringName` class, :ref:`StringName` name, :ref:`bool` no_inheritance=false **)** |const| +:ref:`bool` **class_has_enum**\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| Returns whether ``class`` or its ancestry has an enum called ``name`` or not. @@ -248,7 +248,7 @@ Returns whether ``class`` or its ancestry has an enum called ``name`` or not. .. rst-class:: classref-method -:ref:`bool` **class_has_integer_constant** **(** :ref:`StringName` class, :ref:`StringName` name **)** |const| +:ref:`bool` **class_has_integer_constant**\ (\ class\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| Returns whether ``class`` or its ancestry has an integer constant called ``name`` or not. @@ -260,7 +260,7 @@ Returns whether ``class`` or its ancestry has an integer constant called ``name` .. rst-class:: classref-method -:ref:`bool` **class_has_method** **(** :ref:`StringName` class, :ref:`StringName` method, :ref:`bool` no_inheritance=false **)** |const| +:ref:`bool` **class_has_method**\ (\ class\: :ref:`StringName`, method\: :ref:`StringName`, no_inheritance\: :ref:`bool` = false\ ) |const| Returns whether ``class`` (or its ancestry if ``no_inheritance`` is ``false``) has a method called ``method`` or not. @@ -272,7 +272,7 @@ Returns whether ``class`` (or its ancestry if ``no_inheritance`` is ``false``) h .. rst-class:: classref-method -:ref:`bool` **class_has_signal** **(** :ref:`StringName` class, :ref:`StringName` signal **)** |const| +:ref:`bool` **class_has_signal**\ (\ class\: :ref:`StringName`, signal\: :ref:`StringName`\ ) |const| Returns whether ``class`` or its ancestry has a signal called ``signal`` or not. @@ -284,7 +284,7 @@ Returns whether ``class`` or its ancestry has a signal called ``signal`` or not. .. rst-class:: classref-method -:ref:`Error` **class_set_property** **(** :ref:`Object` object, :ref:`StringName` property, :ref:`Variant` value **)** |const| +:ref:`Error` **class_set_property**\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) |const| Sets ``property`` value of ``object`` to ``value``. @@ -296,7 +296,7 @@ Sets ``property`` value of ``object`` to ``value``. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_class_list** **(** **)** |const| +:ref:`PackedStringArray` **get_class_list**\ (\ ) |const| Returns the names of all the classes available. @@ -308,7 +308,7 @@ Returns the names of all the classes available. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_inheriters_from_class** **(** :ref:`StringName` class **)** |const| +:ref:`PackedStringArray` **get_inheriters_from_class**\ (\ class\: :ref:`StringName`\ ) |const| Returns the names of all the classes that directly or indirectly inherit from ``class``. @@ -320,7 +320,7 @@ Returns the names of all the classes that directly or indirectly inherit from `` .. rst-class:: classref-method -:ref:`StringName` **get_parent_class** **(** :ref:`StringName` class **)** |const| +:ref:`StringName` **get_parent_class**\ (\ class\: :ref:`StringName`\ ) |const| Returns the parent class of ``class``. @@ -332,7 +332,7 @@ Returns the parent class of ``class``. .. rst-class:: classref-method -:ref:`Variant` **instantiate** **(** :ref:`StringName` class **)** |const| +:ref:`Variant` **instantiate**\ (\ class\: :ref:`StringName`\ ) |const| Creates an instance of ``class``. @@ -344,7 +344,7 @@ Creates an instance of ``class``. .. rst-class:: classref-method -:ref:`bool` **is_class_enabled** **(** :ref:`StringName` class **)** |const| +:ref:`bool` **is_class_enabled**\ (\ class\: :ref:`StringName`\ ) |const| Returns whether this ``class`` is enabled or not. @@ -356,7 +356,7 @@ Returns whether this ``class`` is enabled or not. .. rst-class:: classref-method -:ref:`bool` **is_parent_class** **(** :ref:`StringName` class, :ref:`StringName` inherits **)** |const| +:ref:`bool` **is_parent_class**\ (\ class\: :ref:`StringName`, inherits\: :ref:`StringName`\ ) |const| Returns whether ``inherits`` is an ancestor of ``class`` or not. @@ -367,3 +367,4 @@ Returns whether ``inherits`` is an ancestor of ``class`` or not. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_codeedit.rst b/classes/class_codeedit.rst index 3d2ca0d1e60..4290a5f874f 100644 --- a/classes/class_codeedit.rst +++ b/classes/class_codeedit.rst @@ -31,51 +31,51 @@ Properties .. table:: :widths: auto - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`auto_brace_completion_enabled` | ``false`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`auto_brace_completion_highlight_matching` | ``false`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`auto_brace_completion_pairs` | ``{ "\"": "\"", "'": "'", "(": ")", "[": "]", "{": "}" }`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`code_completion_enabled` | ``false`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`String[]` | :ref:`code_completion_prefixes` | ``[]`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`String[]` | :ref:`delimiter_comments` | ``[]`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`String[]` | :ref:`delimiter_strings` | ``["' '", "\" \""]`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`gutters_draw_bookmarks` | ``false`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`gutters_draw_breakpoints_gutter` | ``false`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`gutters_draw_executing_lines` | ``false`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`gutters_draw_fold_gutter` | ``false`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`gutters_draw_line_numbers` | ``false`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`gutters_zero_pad_line_numbers` | ``false`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`indent_automatic` | ``false`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`String[]` | :ref:`indent_automatic_prefixes` | ``[":", "{", "[", "("]`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`int` | :ref:`indent_size` | ``4`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`indent_use_spaces` | ``false`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`LayoutDirection` | layout_direction | ``2`` (overrides :ref:`Control`) | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`line_folding` | ``false`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`int[]` | :ref:`line_length_guidelines` | ``[]`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`symbol_lookup_on_click` | ``false`` | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ - | :ref:`TextDirection` | text_direction | ``1`` (overrides :ref:`TextEdit`) | - +------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`auto_brace_completion_enabled` | ``false`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`auto_brace_completion_highlight_matching` | ``false`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`auto_brace_completion_pairs` | ``{ "\"": "\"", "'": "'", "(": ")", "[": "]", "{": "}" }`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`code_completion_enabled` | ``false`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`String`\] | :ref:`code_completion_prefixes` | ``[]`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`String`\] | :ref:`delimiter_comments` | ``[]`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`String`\] | :ref:`delimiter_strings` | ``["' '", "\" \""]`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`gutters_draw_bookmarks` | ``false`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`gutters_draw_breakpoints_gutter` | ``false`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`gutters_draw_executing_lines` | ``false`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`gutters_draw_fold_gutter` | ``false`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`gutters_draw_line_numbers` | ``false`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`gutters_zero_pad_line_numbers` | ``false`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`indent_automatic` | ``false`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`String`\] | :ref:`indent_automatic_prefixes` | ``[":", "{", "[", "("]`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`int` | :ref:`indent_size` | ``4`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`indent_use_spaces` | ``false`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`LayoutDirection` | layout_direction | ``2`` (overrides :ref:`Control`) | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`line_folding` | ``false`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`int`\] | :ref:`line_length_guidelines` | ``[]`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`symbol_lookup_on_click` | ``false`` | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`TextDirection` | text_direction | ``1`` (overrides :ref:`TextEdit`) | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -85,141 +85,141 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_confirm_code_completion` **(** :ref:`bool` replace **)** |virtual| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`_filter_code_completion_candidates` **(** :ref:`Dictionary[]` candidates **)** |virtual| |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_request_code_completion` **(** :ref:`bool` force **)** |virtual| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_auto_brace_completion_pair` **(** :ref:`String` start_key, :ref:`String` end_key **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_code_completion_option` **(** :ref:`CodeCompletionKind` type, :ref:`String` display_text, :ref:`String` insert_text, :ref:`Color` text_color=Color(1, 1, 1, 1), :ref:`Resource` icon=null, :ref:`Variant` value=0, :ref:`int` location=1024 **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_comment_delimiter` **(** :ref:`String` start_key, :ref:`String` end_key, :ref:`bool` line_only=false **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_string_delimiter` **(** :ref:`String` start_key, :ref:`String` end_key, :ref:`bool` line_only=false **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`can_fold_line` **(** :ref:`int` line **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`cancel_code_completion` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_bookmarked_lines` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_breakpointed_lines` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_comment_delimiters` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_executing_lines` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_string_delimiters` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`confirm_code_completion` **(** :ref:`bool` replace=false **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`convert_indent` **(** :ref:`int` from_line=-1, :ref:`int` to_line=-1 **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_code_region` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`do_indent` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`duplicate_lines` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fold_all_lines` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fold_line` **(** :ref:`int` line **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_auto_brace_completion_close_key` **(** :ref:`String` open_key **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_bookmarked_lines` **(** **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_breakpointed_lines` **(** **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_code_completion_option` **(** :ref:`int` index **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`get_code_completion_options` **(** **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_code_completion_selected_index` **(** **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_code_region_end_tag` **(** **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_code_region_start_tag` **(** **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_delimiter_end_key` **(** :ref:`int` delimiter_index **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_delimiter_end_position` **(** :ref:`int` line, :ref:`int` column **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_delimiter_start_key` **(** :ref:`int` delimiter_index **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_delimiter_start_position` **(** :ref:`int` line, :ref:`int` column **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_executing_lines` **(** **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int[]` | :ref:`get_folded_lines` **(** **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_text_for_code_completion` **(** **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_text_for_symbol_lookup` **(** **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_text_with_cursor_char` **(** :ref:`int` line, :ref:`int` column **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_auto_brace_completion_close_key` **(** :ref:`String` close_key **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_auto_brace_completion_open_key` **(** :ref:`String` open_key **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_comment_delimiter` **(** :ref:`String` start_key **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_string_delimiter` **(** :ref:`String` start_key **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`indent_lines` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`is_in_comment` **(** :ref:`int` line, :ref:`int` column=-1 **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`is_in_string` **(** :ref:`int` line, :ref:`int` column=-1 **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_line_bookmarked` **(** :ref:`int` line **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_line_breakpointed` **(** :ref:`int` line **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_line_code_region_end` **(** :ref:`int` line **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_line_code_region_start` **(** :ref:`int` line **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_line_executing` **(** :ref:`int` line **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_line_folded` **(** :ref:`int` line **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_comment_delimiter` **(** :ref:`String` start_key **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_string_delimiter` **(** :ref:`String` start_key **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`request_code_completion` **(** :ref:`bool` force=false **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_code_completion_selected_index` **(** :ref:`int` index **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_code_hint` **(** :ref:`String` code_hint **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_code_hint_draw_below` **(** :ref:`bool` draw_below **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_code_region_tags` **(** :ref:`String` start="region", :ref:`String` end="endregion" **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_line_as_bookmarked` **(** :ref:`int` line, :ref:`bool` bookmarked **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_line_as_breakpoint` **(** :ref:`int` line, :ref:`bool` breakpointed **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_line_as_executing` **(** :ref:`int` line, :ref:`bool` executing **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_symbol_lookup_word_as_valid` **(** :ref:`bool` valid **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`toggle_foldable_line` **(** :ref:`int` line **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`unfold_all_lines` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`unfold_line` **(** :ref:`int` line **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`unindent_lines` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`update_code_completion_options` **(** :ref:`bool` force **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_confirm_code_completion`\ (\ replace\: :ref:`bool`\ ) |virtual| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_filter_code_completion_candidates`\ (\ candidates\: :ref:`Array`\[:ref:`Dictionary`\]\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_request_code_completion`\ (\ force\: :ref:`bool`\ ) |virtual| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_auto_brace_completion_pair`\ (\ start_key\: :ref:`String`, end_key\: :ref:`String`\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_code_completion_option`\ (\ type\: :ref:`CodeCompletionKind`, display_text\: :ref:`String`, insert_text\: :ref:`String`, text_color\: :ref:`Color` = Color(1, 1, 1, 1), icon\: :ref:`Resource` = null, value\: :ref:`Variant` = null, location\: :ref:`int` = 1024\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_comment_delimiter`\ (\ start_key\: :ref:`String`, end_key\: :ref:`String`, line_only\: :ref:`bool` = false\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_string_delimiter`\ (\ start_key\: :ref:`String`, end_key\: :ref:`String`, line_only\: :ref:`bool` = false\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`can_fold_line`\ (\ line\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cancel_code_completion`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_bookmarked_lines`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_breakpointed_lines`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_comment_delimiters`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_executing_lines`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_string_delimiters`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`confirm_code_completion`\ (\ replace\: :ref:`bool` = false\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`convert_indent`\ (\ from_line\: :ref:`int` = -1, to_line\: :ref:`int` = -1\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_code_region`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`do_indent`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`duplicate_lines`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fold_all_lines`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fold_line`\ (\ line\: :ref:`int`\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_auto_brace_completion_close_key`\ (\ open_key\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_bookmarked_lines`\ (\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_breakpointed_lines`\ (\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_code_completion_option`\ (\ index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_code_completion_options`\ (\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_code_completion_selected_index`\ (\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_code_region_end_tag`\ (\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_code_region_start_tag`\ (\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_delimiter_end_key`\ (\ delimiter_index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_delimiter_end_position`\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_delimiter_start_key`\ (\ delimiter_index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_delimiter_start_position`\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_executing_lines`\ (\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`int`\] | :ref:`get_folded_lines`\ (\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_text_for_code_completion`\ (\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_text_for_symbol_lookup`\ (\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_text_with_cursor_char`\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_auto_brace_completion_close_key`\ (\ close_key\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_auto_brace_completion_open_key`\ (\ open_key\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_comment_delimiter`\ (\ start_key\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_string_delimiter`\ (\ start_key\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`indent_lines`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`is_in_comment`\ (\ line\: :ref:`int`, column\: :ref:`int` = -1\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`is_in_string`\ (\ line\: :ref:`int`, column\: :ref:`int` = -1\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_line_bookmarked`\ (\ line\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_line_breakpointed`\ (\ line\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_line_code_region_end`\ (\ line\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_line_code_region_start`\ (\ line\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_line_executing`\ (\ line\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_line_folded`\ (\ line\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_comment_delimiter`\ (\ start_key\: :ref:`String`\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_string_delimiter`\ (\ start_key\: :ref:`String`\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`request_code_completion`\ (\ force\: :ref:`bool` = false\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_code_completion_selected_index`\ (\ index\: :ref:`int`\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_code_hint`\ (\ code_hint\: :ref:`String`\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_code_hint_draw_below`\ (\ draw_below\: :ref:`bool`\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_code_region_tags`\ (\ start\: :ref:`String` = "region", end\: :ref:`String` = "endregion"\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_as_bookmarked`\ (\ line\: :ref:`int`, bookmarked\: :ref:`bool`\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_as_breakpoint`\ (\ line\: :ref:`int`, breakpointed\: :ref:`bool`\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_as_executing`\ (\ line\: :ref:`int`, executing\: :ref:`bool`\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_symbol_lookup_word_as_valid`\ (\ valid\: :ref:`bool`\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`toggle_foldable_line`\ (\ line\: :ref:`int`\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unfold_all_lines`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unfold_line`\ (\ line\: :ref:`int`\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unindent_lines`\ (\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update_code_completion_options`\ (\ force\: :ref:`bool`\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -294,7 +294,7 @@ Signals .. rst-class:: classref-signal -**breakpoint_toggled** **(** :ref:`int` line **)** +**breakpoint_toggled**\ (\ line\: :ref:`int`\ ) Emitted when a breakpoint is added or removed from a line. If the line is moved via backspace a removed is emitted at the old line. @@ -306,7 +306,7 @@ Emitted when a breakpoint is added or removed from a line. If the line is moved .. rst-class:: classref-signal -**code_completion_requested** **(** **)** +**code_completion_requested**\ (\ ) Emitted when the user requests code completion. @@ -318,7 +318,7 @@ Emitted when the user requests code completion. .. rst-class:: classref-signal -**symbol_lookup** **(** :ref:`String` symbol, :ref:`int` line, :ref:`int` column **)** +**symbol_lookup**\ (\ symbol\: :ref:`String`, line\: :ref:`int`, column\: :ref:`int`\ ) Emitted when the user has clicked on a valid symbol. @@ -330,7 +330,7 @@ Emitted when the user has clicked on a valid symbol. .. rst-class:: classref-signal -**symbol_validate** **(** :ref:`String` symbol **)** +**symbol_validate**\ (\ symbol\: :ref:`String`\ ) Emitted when the user hovers over a symbol. The symbol should be validated and responded to, by calling :ref:`set_symbol_lookup_word_as_valid`. @@ -488,8 +488,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_auto_brace_completion_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_auto_brace_completion_enabled** **(** **)** +- |void| **set_auto_brace_completion_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_auto_brace_completion_enabled**\ (\ ) Sets whether brace pairs should be autocompleted. @@ -505,8 +505,8 @@ Sets whether brace pairs should be autocompleted. .. rst-class:: classref-property-setget -- void **set_highlight_matching_braces_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_highlight_matching_braces_enabled** **(** **)** +- |void| **set_highlight_matching_braces_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_highlight_matching_braces_enabled**\ (\ ) Highlight mismatching brace pairs. @@ -522,8 +522,8 @@ Highlight mismatching brace pairs. .. rst-class:: classref-property-setget -- void **set_auto_brace_completion_pairs** **(** :ref:`Dictionary` value **)** -- :ref:`Dictionary` **get_auto_brace_completion_pairs** **(** **)** +- |void| **set_auto_brace_completion_pairs**\ (\ value\: :ref:`Dictionary`\ ) +- :ref:`Dictionary` **get_auto_brace_completion_pairs**\ (\ ) Sets the brace pairs to be autocompleted. @@ -539,8 +539,8 @@ Sets the brace pairs to be autocompleted. .. rst-class:: classref-property-setget -- void **set_code_completion_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_code_completion_enabled** **(** **)** +- |void| **set_code_completion_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_code_completion_enabled**\ (\ ) Sets whether code completion is allowed. @@ -552,12 +552,12 @@ Sets whether code completion is allowed. .. rst-class:: classref-property -:ref:`String[]` **code_completion_prefixes** = ``[]`` +:ref:`Array`\[:ref:`String`\] **code_completion_prefixes** = ``[]`` .. rst-class:: classref-property-setget -- void **set_code_completion_prefixes** **(** :ref:`String[]` value **)** -- :ref:`String[]` **get_code_completion_prefixes** **(** **)** +- |void| **set_code_completion_prefixes**\ (\ value\: :ref:`Array`\[:ref:`String`\]\ ) +- :ref:`Array`\[:ref:`String`\] **get_code_completion_prefixes**\ (\ ) Sets prefixes that will trigger code completion. @@ -569,12 +569,12 @@ Sets prefixes that will trigger code completion. .. rst-class:: classref-property -:ref:`String[]` **delimiter_comments** = ``[]`` +:ref:`Array`\[:ref:`String`\] **delimiter_comments** = ``[]`` .. rst-class:: classref-property-setget -- void **set_comment_delimiters** **(** :ref:`String[]` value **)** -- :ref:`String[]` **get_comment_delimiters** **(** **)** +- |void| **set_comment_delimiters**\ (\ value\: :ref:`Array`\[:ref:`String`\]\ ) +- :ref:`Array`\[:ref:`String`\] **get_comment_delimiters**\ (\ ) Sets the comment delimiters. All existing comment delimiters will be removed. @@ -586,12 +586,12 @@ Sets the comment delimiters. All existing comment delimiters will be removed. .. rst-class:: classref-property -:ref:`String[]` **delimiter_strings** = ``["' '", "\" \""]`` +:ref:`Array`\[:ref:`String`\] **delimiter_strings** = ``["' '", "\" \""]`` .. rst-class:: classref-property-setget -- void **set_string_delimiters** **(** :ref:`String[]` value **)** -- :ref:`String[]` **get_string_delimiters** **(** **)** +- |void| **set_string_delimiters**\ (\ value\: :ref:`Array`\[:ref:`String`\]\ ) +- :ref:`Array`\[:ref:`String`\] **get_string_delimiters**\ (\ ) Sets the string delimiters. All existing string delimiters will be removed. @@ -607,8 +607,8 @@ Sets the string delimiters. All existing string delimiters will be removed. .. rst-class:: classref-property-setget -- void **set_draw_bookmarks_gutter** **(** :ref:`bool` value **)** -- :ref:`bool` **is_drawing_bookmarks_gutter** **(** **)** +- |void| **set_draw_bookmarks_gutter**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_drawing_bookmarks_gutter**\ (\ ) Sets if bookmarked should be drawn in the gutter. This gutter is shared with breakpoints and executing lines. @@ -624,8 +624,8 @@ Sets if bookmarked should be drawn in the gutter. This gutter is shared with bre .. rst-class:: classref-property-setget -- void **set_draw_breakpoints_gutter** **(** :ref:`bool` value **)** -- :ref:`bool` **is_drawing_breakpoints_gutter** **(** **)** +- |void| **set_draw_breakpoints_gutter**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_drawing_breakpoints_gutter**\ (\ ) Sets if breakpoints should be drawn in the gutter. This gutter is shared with bookmarks and executing lines. @@ -641,8 +641,8 @@ Sets if breakpoints should be drawn in the gutter. This gutter is shared with bo .. rst-class:: classref-property-setget -- void **set_draw_executing_lines_gutter** **(** :ref:`bool` value **)** -- :ref:`bool` **is_drawing_executing_lines_gutter** **(** **)** +- |void| **set_draw_executing_lines_gutter**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_drawing_executing_lines_gutter**\ (\ ) Sets if executing lines should be marked in the gutter. This gutter is shared with breakpoints and bookmarks lines. @@ -658,8 +658,8 @@ Sets if executing lines should be marked in the gutter. This gutter is shared wi .. rst-class:: classref-property-setget -- void **set_draw_fold_gutter** **(** :ref:`bool` value **)** -- :ref:`bool` **is_drawing_fold_gutter** **(** **)** +- |void| **set_draw_fold_gutter**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_drawing_fold_gutter**\ (\ ) Sets if foldable lines icons should be drawn in the gutter. @@ -675,8 +675,8 @@ Sets if foldable lines icons should be drawn in the gutter. .. rst-class:: classref-property-setget -- void **set_draw_line_numbers** **(** :ref:`bool` value **)** -- :ref:`bool` **is_draw_line_numbers_enabled** **(** **)** +- |void| **set_draw_line_numbers**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_draw_line_numbers_enabled**\ (\ ) Sets if line numbers should be drawn in the gutter. @@ -692,8 +692,8 @@ Sets if line numbers should be drawn in the gutter. .. rst-class:: classref-property-setget -- void **set_line_numbers_zero_padded** **(** :ref:`bool` value **)** -- :ref:`bool` **is_line_numbers_zero_padded** **(** **)** +- |void| **set_line_numbers_zero_padded**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_line_numbers_zero_padded**\ (\ ) Sets if line numbers drawn in the gutter are zero padded. @@ -709,8 +709,8 @@ Sets if line numbers drawn in the gutter are zero padded. .. rst-class:: classref-property-setget -- void **set_auto_indent_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_auto_indent_enabled** **(** **)** +- |void| **set_auto_indent_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_auto_indent_enabled**\ (\ ) Sets whether automatic indent are enabled, this will add an extra indent if a prefix or brace is found. @@ -722,12 +722,12 @@ Sets whether automatic indent are enabled, this will add an extra indent if a pr .. rst-class:: classref-property -:ref:`String[]` **indent_automatic_prefixes** = ``[":", "{", "[", "("]`` +:ref:`Array`\[:ref:`String`\] **indent_automatic_prefixes** = ``[":", "{", "[", "("]`` .. rst-class:: classref-property-setget -- void **set_auto_indent_prefixes** **(** :ref:`String[]` value **)** -- :ref:`String[]` **get_auto_indent_prefixes** **(** **)** +- |void| **set_auto_indent_prefixes**\ (\ value\: :ref:`Array`\[:ref:`String`\]\ ) +- :ref:`Array`\[:ref:`String`\] **get_auto_indent_prefixes**\ (\ ) Prefixes to trigger an automatic indent. @@ -743,8 +743,8 @@ Prefixes to trigger an automatic indent. .. rst-class:: classref-property-setget -- void **set_indent_size** **(** :ref:`int` value **)** -- :ref:`int` **get_indent_size** **(** **)** +- |void| **set_indent_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_indent_size**\ (\ ) Size of the tabulation indent (one :kbd:`Tab` press) in characters. If :ref:`indent_use_spaces` is enabled the number of spaces to use. @@ -760,8 +760,8 @@ Size of the tabulation indent (one :kbd:`Tab` press) in characters. If :ref:`ind .. rst-class:: classref-property-setget -- void **set_indent_using_spaces** **(** :ref:`bool` value **)** -- :ref:`bool` **is_indent_using_spaces** **(** **)** +- |void| **set_indent_using_spaces**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_indent_using_spaces**\ (\ ) Use spaces instead of tabs for indentation. @@ -777,8 +777,8 @@ Use spaces instead of tabs for indentation. .. rst-class:: classref-property-setget -- void **set_line_folding_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_line_folding_enabled** **(** **)** +- |void| **set_line_folding_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_line_folding_enabled**\ (\ ) Sets whether line folding is allowed. @@ -790,12 +790,12 @@ Sets whether line folding is allowed. .. rst-class:: classref-property -:ref:`int[]` **line_length_guidelines** = ``[]`` +:ref:`Array`\[:ref:`int`\] **line_length_guidelines** = ``[]`` .. rst-class:: classref-property-setget -- void **set_line_length_guidelines** **(** :ref:`int[]` value **)** -- :ref:`int[]` **get_line_length_guidelines** **(** **)** +- |void| **set_line_length_guidelines**\ (\ value\: :ref:`Array`\[:ref:`int`\]\ ) +- :ref:`Array`\[:ref:`int`\] **get_line_length_guidelines**\ (\ ) Draws vertical lines at the provided columns. The first entry is considered a main hard guideline and is draw more prominently. @@ -811,8 +811,8 @@ Draws vertical lines at the provided columns. The first entry is considered a ma .. rst-class:: classref-property-setget -- void **set_symbol_lookup_on_click_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_symbol_lookup_on_click_enabled** **(** **)** +- |void| **set_symbol_lookup_on_click_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_symbol_lookup_on_click_enabled**\ (\ ) Set when a validated word from :ref:`symbol_validate` is clicked, the :ref:`symbol_lookup` should be emitted. @@ -829,7 +829,7 @@ Method Descriptions .. rst-class:: classref-method -void **_confirm_code_completion** **(** :ref:`bool` replace **)** |virtual| +|void| **_confirm_code_completion**\ (\ replace\: :ref:`bool`\ ) |virtual| Override this method to define how the selected entry should be inserted. If ``replace`` is true, any existing text should be replaced. @@ -841,7 +841,7 @@ Override this method to define how the selected entry should be inserted. If ``r .. rst-class:: classref-method -:ref:`Dictionary[]` **_filter_code_completion_candidates** **(** :ref:`Dictionary[]` candidates **)** |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_filter_code_completion_candidates**\ (\ candidates\: :ref:`Array`\[:ref:`Dictionary`\]\ ) |virtual| |const| Override this method to define what items in ``candidates`` should be displayed. @@ -855,7 +855,7 @@ Both ``candidates`` and the return is a :ref:`Array` of :ref:`Dicti .. rst-class:: classref-method -void **_request_code_completion** **(** :ref:`bool` force **)** |virtual| +|void| **_request_code_completion**\ (\ force\: :ref:`bool`\ ) |virtual| Override this method to define what happens when the user requests code completion. If ``force`` is true, any checks should be bypassed. @@ -867,7 +867,7 @@ Override this method to define what happens when the user requests code completi .. rst-class:: classref-method -void **add_auto_brace_completion_pair** **(** :ref:`String` start_key, :ref:`String` end_key **)** +|void| **add_auto_brace_completion_pair**\ (\ start_key\: :ref:`String`, end_key\: :ref:`String`\ ) Adds a brace pair. @@ -881,7 +881,7 @@ Both the start and end keys must be symbols. Only the start key has to be unique .. rst-class:: classref-method -void **add_code_completion_option** **(** :ref:`CodeCompletionKind` type, :ref:`String` display_text, :ref:`String` insert_text, :ref:`Color` text_color=Color(1, 1, 1, 1), :ref:`Resource` icon=null, :ref:`Variant` value=0, :ref:`int` location=1024 **)** +|void| **add_code_completion_option**\ (\ type\: :ref:`CodeCompletionKind`, display_text\: :ref:`String`, insert_text\: :ref:`String`, text_color\: :ref:`Color` = Color(1, 1, 1, 1), icon\: :ref:`Resource` = null, value\: :ref:`Variant` = null, location\: :ref:`int` = 1024\ ) Submits an item to the queue of potential candidates for the autocomplete menu. Call :ref:`update_code_completion_options` to update the list. @@ -897,7 +897,7 @@ Submits an item to the queue of potential candidates for the autocomplete menu. .. rst-class:: classref-method -void **add_comment_delimiter** **(** :ref:`String` start_key, :ref:`String` end_key, :ref:`bool` line_only=false **)** +|void| **add_comment_delimiter**\ (\ start_key\: :ref:`String`, end_key\: :ref:`String`, line_only\: :ref:`bool` = false\ ) Adds a comment delimiter. @@ -913,7 +913,7 @@ Both the start and end keys must be symbols. Only the start key has to be unique .. rst-class:: classref-method -void **add_string_delimiter** **(** :ref:`String` start_key, :ref:`String` end_key, :ref:`bool` line_only=false **)** +|void| **add_string_delimiter**\ (\ start_key\: :ref:`String`, end_key\: :ref:`String`, line_only\: :ref:`bool` = false\ ) Adds a string delimiter. @@ -929,7 +929,7 @@ Both the start and end keys must be symbols. Only the start key has to be unique .. rst-class:: classref-method -:ref:`bool` **can_fold_line** **(** :ref:`int` line **)** |const| +:ref:`bool` **can_fold_line**\ (\ line\: :ref:`int`\ ) |const| Returns if the given line is foldable, that is, it has indented lines right below it or a comment / string block. @@ -941,7 +941,7 @@ Returns if the given line is foldable, that is, it has indented lines right belo .. rst-class:: classref-method -void **cancel_code_completion** **(** **)** +|void| **cancel_code_completion**\ (\ ) Cancels the autocomplete menu. @@ -953,7 +953,7 @@ Cancels the autocomplete menu. .. rst-class:: classref-method -void **clear_bookmarked_lines** **(** **)** +|void| **clear_bookmarked_lines**\ (\ ) Clears all bookmarked lines. @@ -965,7 +965,7 @@ Clears all bookmarked lines. .. rst-class:: classref-method -void **clear_breakpointed_lines** **(** **)** +|void| **clear_breakpointed_lines**\ (\ ) Clears all breakpointed lines. @@ -977,7 +977,7 @@ Clears all breakpointed lines. .. rst-class:: classref-method -void **clear_comment_delimiters** **(** **)** +|void| **clear_comment_delimiters**\ (\ ) Removes all comment delimiters. @@ -989,7 +989,7 @@ Removes all comment delimiters. .. rst-class:: classref-method -void **clear_executing_lines** **(** **)** +|void| **clear_executing_lines**\ (\ ) Clears all executed lines. @@ -1001,7 +1001,7 @@ Clears all executed lines. .. rst-class:: classref-method -void **clear_string_delimiters** **(** **)** +|void| **clear_string_delimiters**\ (\ ) Removes all string delimiters. @@ -1013,7 +1013,7 @@ Removes all string delimiters. .. rst-class:: classref-method -void **confirm_code_completion** **(** :ref:`bool` replace=false **)** +|void| **confirm_code_completion**\ (\ replace\: :ref:`bool` = false\ ) Inserts the selected entry into the text. If ``replace`` is true, any existing text is replaced rather than merged. @@ -1025,7 +1025,7 @@ Inserts the selected entry into the text. If ``replace`` is true, any existing t .. rst-class:: classref-method -void **convert_indent** **(** :ref:`int` from_line=-1, :ref:`int` to_line=-1 **)** +|void| **convert_indent**\ (\ from_line\: :ref:`int` = -1, to_line\: :ref:`int` = -1\ ) Converts the indents of lines between ``from_line`` and ``to_line`` to tabs or spaces as set by :ref:`indent_use_spaces`. @@ -1039,7 +1039,7 @@ Values of ``-1`` convert the entire text. .. rst-class:: classref-method -void **create_code_region** **(** **)** +|void| **create_code_region**\ (\ ) Creates a new code region with the selection. At least one single line comment delimiter have to be defined (see :ref:`add_comment_delimiter`). @@ -1057,7 +1057,7 @@ Code regions are delimited using start and end tags (respectively ``region`` and .. rst-class:: classref-method -void **do_indent** **(** **)** +|void| **do_indent**\ (\ ) Perform an indent as if the user activated the "ui_text_indent" action. @@ -1069,7 +1069,7 @@ Perform an indent as if the user activated the "ui_text_indent" action. .. rst-class:: classref-method -void **duplicate_lines** **(** **)** +|void| **duplicate_lines**\ (\ ) Duplicates all lines currently selected with any caret. Duplicates the entire line beneath the current one no matter where the caret is within the line. @@ -1081,7 +1081,7 @@ Duplicates all lines currently selected with any caret. Duplicates the entire li .. rst-class:: classref-method -void **fold_all_lines** **(** **)** +|void| **fold_all_lines**\ (\ ) Folds all lines that are possible to be folded (see :ref:`can_fold_line`). @@ -1093,7 +1093,7 @@ Folds all lines that are possible to be folded (see :ref:`can_fold_line` line **)** +|void| **fold_line**\ (\ line\: :ref:`int`\ ) Folds the given line, if possible (see :ref:`can_fold_line`). @@ -1105,7 +1105,7 @@ Folds the given line, if possible (see :ref:`can_fold_line` **get_auto_brace_completion_close_key** **(** :ref:`String` open_key **)** |const| +:ref:`String` **get_auto_brace_completion_close_key**\ (\ open_key\: :ref:`String`\ ) |const| Gets the matching auto brace close key for ``open_key``. @@ -1117,7 +1117,7 @@ Gets the matching auto brace close key for ``open_key``. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_bookmarked_lines** **(** **)** |const| +:ref:`PackedInt32Array` **get_bookmarked_lines**\ (\ ) |const| Gets all bookmarked lines. @@ -1129,7 +1129,7 @@ Gets all bookmarked lines. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_breakpointed_lines** **(** **)** |const| +:ref:`PackedInt32Array` **get_breakpointed_lines**\ (\ ) |const| Gets all breakpointed lines. @@ -1141,7 +1141,7 @@ Gets all breakpointed lines. .. rst-class:: classref-method -:ref:`Dictionary` **get_code_completion_option** **(** :ref:`int` index **)** |const| +:ref:`Dictionary` **get_code_completion_option**\ (\ index\: :ref:`int`\ ) |const| Gets the completion option at ``index``. The return :ref:`Dictionary` has the following key-values: @@ -1165,7 +1165,7 @@ Gets the completion option at ``index``. The return :ref:`Dictionary` **get_code_completion_options** **(** **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_code_completion_options**\ (\ ) |const| Gets all completion options, see :ref:`get_code_completion_option` for return content. @@ -1177,7 +1177,7 @@ Gets all completion options, see :ref:`get_code_completion_option` **get_code_completion_selected_index** **(** **)** |const| +:ref:`int` **get_code_completion_selected_index**\ (\ ) |const| Gets the index of the current selected completion option. @@ -1189,7 +1189,7 @@ Gets the index of the current selected completion option. .. rst-class:: classref-method -:ref:`String` **get_code_region_end_tag** **(** **)** |const| +:ref:`String` **get_code_region_end_tag**\ (\ ) |const| Returns the code region end tag (without comment delimiter). @@ -1201,7 +1201,7 @@ Returns the code region end tag (without comment delimiter). .. rst-class:: classref-method -:ref:`String` **get_code_region_start_tag** **(** **)** |const| +:ref:`String` **get_code_region_start_tag**\ (\ ) |const| Returns the code region start tag (without comment delimiter). @@ -1213,7 +1213,7 @@ Returns the code region start tag (without comment delimiter). .. rst-class:: classref-method -:ref:`String` **get_delimiter_end_key** **(** :ref:`int` delimiter_index **)** |const| +:ref:`String` **get_delimiter_end_key**\ (\ delimiter_index\: :ref:`int`\ ) |const| Gets the end key for a string or comment region index. @@ -1225,7 +1225,7 @@ Gets the end key for a string or comment region index. .. rst-class:: classref-method -:ref:`Vector2` **get_delimiter_end_position** **(** :ref:`int` line, :ref:`int` column **)** |const| +:ref:`Vector2` **get_delimiter_end_position**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| If ``line`` ``column`` is in a string or comment, returns the end position of the region. If not or no end could be found, both :ref:`Vector2` values will be ``-1``. @@ -1237,7 +1237,7 @@ If ``line`` ``column`` is in a string or comment, returns the end position of th .. rst-class:: classref-method -:ref:`String` **get_delimiter_start_key** **(** :ref:`int` delimiter_index **)** |const| +:ref:`String` **get_delimiter_start_key**\ (\ delimiter_index\: :ref:`int`\ ) |const| Gets the start key for a string or comment region index. @@ -1249,7 +1249,7 @@ Gets the start key for a string or comment region index. .. rst-class:: classref-method -:ref:`Vector2` **get_delimiter_start_position** **(** :ref:`int` line, :ref:`int` column **)** |const| +:ref:`Vector2` **get_delimiter_start_position**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| If ``line`` ``column`` is in a string or comment, returns the start position of the region. If not or no start could be found, both :ref:`Vector2` values will be ``-1``. @@ -1261,7 +1261,7 @@ If ``line`` ``column`` is in a string or comment, returns the start position of .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_executing_lines** **(** **)** |const| +:ref:`PackedInt32Array` **get_executing_lines**\ (\ ) |const| Gets all executing lines. @@ -1273,7 +1273,7 @@ Gets all executing lines. .. rst-class:: classref-method -:ref:`int[]` **get_folded_lines** **(** **)** |const| +:ref:`Array`\[:ref:`int`\] **get_folded_lines**\ (\ ) |const| Returns all lines that are current folded. @@ -1285,7 +1285,7 @@ Returns all lines that are current folded. .. rst-class:: classref-method -:ref:`String` **get_text_for_code_completion** **(** **)** |const| +:ref:`String` **get_text_for_code_completion**\ (\ ) |const| Returns the full text with char ``0xFFFF`` at the caret location. @@ -1297,7 +1297,7 @@ Returns the full text with char ``0xFFFF`` at the caret location. .. rst-class:: classref-method -:ref:`String` **get_text_for_symbol_lookup** **(** **)** |const| +:ref:`String` **get_text_for_symbol_lookup**\ (\ ) |const| Returns the full text with char ``0xFFFF`` at the cursor location. @@ -1309,7 +1309,7 @@ Returns the full text with char ``0xFFFF`` at the cursor location. .. rst-class:: classref-method -:ref:`String` **get_text_with_cursor_char** **(** :ref:`int` line, :ref:`int` column **)** |const| +:ref:`String` **get_text_with_cursor_char**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| Returns the full text with char ``0xFFFF`` at the specified location. @@ -1321,7 +1321,7 @@ Returns the full text with char ``0xFFFF`` at the specified location. .. rst-class:: classref-method -:ref:`bool` **has_auto_brace_completion_close_key** **(** :ref:`String` close_key **)** |const| +:ref:`bool` **has_auto_brace_completion_close_key**\ (\ close_key\: :ref:`String`\ ) |const| Returns ``true`` if close key ``close_key`` exists. @@ -1333,7 +1333,7 @@ Returns ``true`` if close key ``close_key`` exists. .. rst-class:: classref-method -:ref:`bool` **has_auto_brace_completion_open_key** **(** :ref:`String` open_key **)** |const| +:ref:`bool` **has_auto_brace_completion_open_key**\ (\ open_key\: :ref:`String`\ ) |const| Returns ``true`` if open key ``open_key`` exists. @@ -1345,7 +1345,7 @@ Returns ``true`` if open key ``open_key`` exists. .. rst-class:: classref-method -:ref:`bool` **has_comment_delimiter** **(** :ref:`String` start_key **)** |const| +:ref:`bool` **has_comment_delimiter**\ (\ start_key\: :ref:`String`\ ) |const| Returns ``true`` if comment ``start_key`` exists. @@ -1357,7 +1357,7 @@ Returns ``true`` if comment ``start_key`` exists. .. rst-class:: classref-method -:ref:`bool` **has_string_delimiter** **(** :ref:`String` start_key **)** |const| +:ref:`bool` **has_string_delimiter**\ (\ start_key\: :ref:`String`\ ) |const| Returns ``true`` if string ``start_key`` exists. @@ -1369,7 +1369,7 @@ Returns ``true`` if string ``start_key`` exists. .. rst-class:: classref-method -void **indent_lines** **(** **)** +|void| **indent_lines**\ (\ ) Indents selected lines, or in the case of no selection the caret line by one. @@ -1381,7 +1381,7 @@ Indents selected lines, or in the case of no selection the caret line by one. .. rst-class:: classref-method -:ref:`int` **is_in_comment** **(** :ref:`int` line, :ref:`int` column=-1 **)** |const| +:ref:`int` **is_in_comment**\ (\ line\: :ref:`int`, column\: :ref:`int` = -1\ ) |const| Returns delimiter index if ``line`` ``column`` is in a comment. If ``column`` is not provided, will return delimiter index if the entire ``line`` is a comment. Otherwise ``-1``. @@ -1393,7 +1393,7 @@ Returns delimiter index if ``line`` ``column`` is in a comment. If ``column`` is .. rst-class:: classref-method -:ref:`int` **is_in_string** **(** :ref:`int` line, :ref:`int` column=-1 **)** |const| +:ref:`int` **is_in_string**\ (\ line\: :ref:`int`, column\: :ref:`int` = -1\ ) |const| Returns the delimiter index if ``line`` ``column`` is in a string. If ``column`` is not provided, will return the delimiter index if the entire ``line`` is a string. Otherwise ``-1``. @@ -1405,7 +1405,7 @@ Returns the delimiter index if ``line`` ``column`` is in a string. If ``column`` .. rst-class:: classref-method -:ref:`bool` **is_line_bookmarked** **(** :ref:`int` line **)** |const| +:ref:`bool` **is_line_bookmarked**\ (\ line\: :ref:`int`\ ) |const| Returns whether the line at the specified index is bookmarked or not. @@ -1417,7 +1417,7 @@ Returns whether the line at the specified index is bookmarked or not. .. rst-class:: classref-method -:ref:`bool` **is_line_breakpointed** **(** :ref:`int` line **)** |const| +:ref:`bool` **is_line_breakpointed**\ (\ line\: :ref:`int`\ ) |const| Returns whether the line at the specified index is breakpointed or not. @@ -1429,7 +1429,7 @@ Returns whether the line at the specified index is breakpointed or not. .. rst-class:: classref-method -:ref:`bool` **is_line_code_region_end** **(** :ref:`int` line **)** |const| +:ref:`bool` **is_line_code_region_end**\ (\ line\: :ref:`int`\ ) |const| Returns whether the line at the specified index is a code region end. @@ -1441,7 +1441,7 @@ Returns whether the line at the specified index is a code region end. .. rst-class:: classref-method -:ref:`bool` **is_line_code_region_start** **(** :ref:`int` line **)** |const| +:ref:`bool` **is_line_code_region_start**\ (\ line\: :ref:`int`\ ) |const| Returns whether the line at the specified index is a code region start. @@ -1453,7 +1453,7 @@ Returns whether the line at the specified index is a code region start. .. rst-class:: classref-method -:ref:`bool` **is_line_executing** **(** :ref:`int` line **)** |const| +:ref:`bool` **is_line_executing**\ (\ line\: :ref:`int`\ ) |const| Returns whether the line at the specified index is marked as executing or not. @@ -1465,7 +1465,7 @@ Returns whether the line at the specified index is marked as executing or not. .. rst-class:: classref-method -:ref:`bool` **is_line_folded** **(** :ref:`int` line **)** |const| +:ref:`bool` **is_line_folded**\ (\ line\: :ref:`int`\ ) |const| Returns whether the line at the specified index is folded or not. @@ -1477,7 +1477,7 @@ Returns whether the line at the specified index is folded or not. .. rst-class:: classref-method -void **remove_comment_delimiter** **(** :ref:`String` start_key **)** +|void| **remove_comment_delimiter**\ (\ start_key\: :ref:`String`\ ) Removes the comment delimiter with ``start_key``. @@ -1489,7 +1489,7 @@ Removes the comment delimiter with ``start_key``. .. rst-class:: classref-method -void **remove_string_delimiter** **(** :ref:`String` start_key **)** +|void| **remove_string_delimiter**\ (\ start_key\: :ref:`String`\ ) Removes the string delimiter with ``start_key``. @@ -1501,7 +1501,7 @@ Removes the string delimiter with ``start_key``. .. rst-class:: classref-method -void **request_code_completion** **(** :ref:`bool` force=false **)** +|void| **request_code_completion**\ (\ force\: :ref:`bool` = false\ ) Emits :ref:`code_completion_requested`, if ``force`` is true will bypass all checks. Otherwise will check that the caret is in a word or in front of a prefix. Will ignore the request if all current options are of type file path, node path or signal. @@ -1513,7 +1513,7 @@ Emits :ref:`code_completion_requested` index **)** +|void| **set_code_completion_selected_index**\ (\ index\: :ref:`int`\ ) Sets the current selected completion option. @@ -1525,7 +1525,7 @@ Sets the current selected completion option. .. rst-class:: classref-method -void **set_code_hint** **(** :ref:`String` code_hint **)** +|void| **set_code_hint**\ (\ code_hint\: :ref:`String`\ ) Sets the code hint text. Pass an empty string to clear. @@ -1537,7 +1537,7 @@ Sets the code hint text. Pass an empty string to clear. .. rst-class:: classref-method -void **set_code_hint_draw_below** **(** :ref:`bool` draw_below **)** +|void| **set_code_hint_draw_below**\ (\ draw_below\: :ref:`bool`\ ) Sets if the code hint should draw below the text. @@ -1549,7 +1549,7 @@ Sets if the code hint should draw below the text. .. rst-class:: classref-method -void **set_code_region_tags** **(** :ref:`String` start="region", :ref:`String` end="endregion" **)** +|void| **set_code_region_tags**\ (\ start\: :ref:`String` = "region", end\: :ref:`String` = "endregion"\ ) Sets the code region start and end tags (without comment delimiter). @@ -1561,7 +1561,7 @@ Sets the code region start and end tags (without comment delimiter). .. rst-class:: classref-method -void **set_line_as_bookmarked** **(** :ref:`int` line, :ref:`bool` bookmarked **)** +|void| **set_line_as_bookmarked**\ (\ line\: :ref:`int`, bookmarked\: :ref:`bool`\ ) Sets the line as bookmarked. @@ -1573,7 +1573,7 @@ Sets the line as bookmarked. .. rst-class:: classref-method -void **set_line_as_breakpoint** **(** :ref:`int` line, :ref:`bool` breakpointed **)** +|void| **set_line_as_breakpoint**\ (\ line\: :ref:`int`, breakpointed\: :ref:`bool`\ ) Sets the line as breakpointed. @@ -1585,7 +1585,7 @@ Sets the line as breakpointed. .. rst-class:: classref-method -void **set_line_as_executing** **(** :ref:`int` line, :ref:`bool` executing **)** +|void| **set_line_as_executing**\ (\ line\: :ref:`int`, executing\: :ref:`bool`\ ) Sets the line as executing. @@ -1597,7 +1597,7 @@ Sets the line as executing. .. rst-class:: classref-method -void **set_symbol_lookup_word_as_valid** **(** :ref:`bool` valid **)** +|void| **set_symbol_lookup_word_as_valid**\ (\ valid\: :ref:`bool`\ ) Sets the symbol emitted by :ref:`symbol_validate` as a valid lookup. @@ -1609,7 +1609,7 @@ Sets the symbol emitted by :ref:`symbol_validate` line **)** +|void| **toggle_foldable_line**\ (\ line\: :ref:`int`\ ) Toggle the folding of the code block at the given line. @@ -1621,7 +1621,7 @@ Toggle the folding of the code block at the given line. .. rst-class:: classref-method -void **unfold_all_lines** **(** **)** +|void| **unfold_all_lines**\ (\ ) Unfolds all lines, folded or not. @@ -1633,7 +1633,7 @@ Unfolds all lines, folded or not. .. rst-class:: classref-method -void **unfold_line** **(** :ref:`int` line **)** +|void| **unfold_line**\ (\ line\: :ref:`int`\ ) Unfolds all lines that were previously folded. @@ -1645,7 +1645,7 @@ Unfolds all lines that were previously folded. .. rst-class:: classref-method -void **unindent_lines** **(** **)** +|void| **unindent_lines**\ (\ ) Unindents selected lines, or in the case of no selection the caret line by one. Same as performing "ui_text_unindent" action. @@ -1657,7 +1657,7 @@ Unindents selected lines, or in the case of no selection the caret line by one. .. rst-class:: classref-method -void **update_code_completion_options** **(** :ref:`bool` force **)** +|void| **update_code_completion_options**\ (\ force\: :ref:`bool`\ ) Submits all completion options added with :ref:`add_code_completion_option`. Will try to force the autocomplete menu to popup, if ``force`` is ``true``. @@ -1975,3 +1975,4 @@ Sets a custom :ref:`Texture2D` to draw at the end of a folded l .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_codehighlighter.rst b/classes/class_codehighlighter.rst index da00c53bd7e..8e079493e94 100644 --- a/classes/class_codehighlighter.rst +++ b/classes/class_codehighlighter.rst @@ -53,35 +53,35 @@ Methods .. table:: :widths: auto - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_color_region` **(** :ref:`String` start_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_keyword_color` **(** :ref:`String` keyword, :ref:`Color` color **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_member_keyword_color` **(** :ref:`String` member_keyword, :ref:`Color` color **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_color_regions` **(** **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_keyword_colors` **(** **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_member_keyword_colors` **(** **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_keyword_color` **(** :ref:`String` keyword **)** |const| | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_member_keyword_color` **(** :ref:`String` member_keyword **)** |const| | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_color_region` **(** :ref:`String` start_key **)** |const| | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_keyword_color` **(** :ref:`String` keyword **)** |const| | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_member_keyword_color` **(** :ref:`String` member_keyword **)** |const| | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_color_region` **(** :ref:`String` start_key **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_keyword_color` **(** :ref:`String` keyword **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_member_keyword_color` **(** :ref:`String` member_keyword **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_color_region`\ (\ start_key\: :ref:`String`, end_key\: :ref:`String`, color\: :ref:`Color`, line_only\: :ref:`bool` = false\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_keyword_color`\ (\ keyword\: :ref:`String`, color\: :ref:`Color`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_member_keyword_color`\ (\ member_keyword\: :ref:`String`, color\: :ref:`Color`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_color_regions`\ (\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_keyword_colors`\ (\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_member_keyword_colors`\ (\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_keyword_color`\ (\ keyword\: :ref:`String`\ ) |const| | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_member_keyword_color`\ (\ member_keyword\: :ref:`String`\ ) |const| | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_color_region`\ (\ start_key\: :ref:`String`\ ) |const| | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_keyword_color`\ (\ keyword\: :ref:`String`\ ) |const| | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_member_keyword_color`\ (\ member_keyword\: :ref:`String`\ ) |const| | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_color_region`\ (\ start_key\: :ref:`String`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_keyword_color`\ (\ keyword\: :ref:`String`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_member_keyword_color`\ (\ member_keyword\: :ref:`String`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -100,8 +100,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_color_regions** **(** :ref:`Dictionary` value **)** -- :ref:`Dictionary` **get_color_regions** **(** **)** +- |void| **set_color_regions**\ (\ value\: :ref:`Dictionary`\ ) +- :ref:`Dictionary` **get_color_regions**\ (\ ) Sets the color regions. All existing regions will be removed. The :ref:`Dictionary` key is the region start and end key, separated by a space. The value is the region color. @@ -117,8 +117,8 @@ Sets the color regions. All existing regions will be removed. The :ref:`Dictiona .. rst-class:: classref-property-setget -- void **set_function_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_function_color** **(** **)** +- |void| **set_function_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_function_color**\ (\ ) Sets color for functions. A function is a non-keyword string followed by a '('. @@ -134,8 +134,8 @@ Sets color for functions. A function is a non-keyword string followed by a '('. .. rst-class:: classref-property-setget -- void **set_keyword_colors** **(** :ref:`Dictionary` value **)** -- :ref:`Dictionary` **get_keyword_colors** **(** **)** +- |void| **set_keyword_colors**\ (\ value\: :ref:`Dictionary`\ ) +- :ref:`Dictionary` **get_keyword_colors**\ (\ ) Sets the keyword colors. All existing keywords will be removed. The :ref:`Dictionary` key is the keyword. The value is the keyword color. @@ -151,8 +151,8 @@ Sets the keyword colors. All existing keywords will be removed. The :ref:`Dictio .. rst-class:: classref-property-setget -- void **set_member_keyword_colors** **(** :ref:`Dictionary` value **)** -- :ref:`Dictionary` **get_member_keyword_colors** **(** **)** +- |void| **set_member_keyword_colors**\ (\ value\: :ref:`Dictionary`\ ) +- :ref:`Dictionary` **get_member_keyword_colors**\ (\ ) Sets the member keyword colors. All existing member keyword will be removed. The :ref:`Dictionary` key is the member keyword. The value is the member keyword color. @@ -168,8 +168,8 @@ Sets the member keyword colors. All existing member keyword will be removed. The .. rst-class:: classref-property-setget -- void **set_member_variable_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_member_variable_color** **(** **)** +- |void| **set_member_variable_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_member_variable_color**\ (\ ) Sets color for member variables. A member variable is non-keyword, non-function string proceeded with a '.'. @@ -185,8 +185,8 @@ Sets color for member variables. A member variable is non-keyword, non-function .. rst-class:: classref-property-setget -- void **set_number_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_number_color** **(** **)** +- |void| **set_number_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_number_color**\ (\ ) Sets the color for numbers. @@ -202,8 +202,8 @@ Sets the color for numbers. .. rst-class:: classref-property-setget -- void **set_symbol_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_symbol_color** **(** **)** +- |void| **set_symbol_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_symbol_color**\ (\ ) Sets the color for symbols. @@ -220,7 +220,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_color_region** **(** :ref:`String` start_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** +|void| **add_color_region**\ (\ start_key\: :ref:`String`, end_key\: :ref:`String`, color\: :ref:`Color`, line_only\: :ref:`bool` = false\ ) Adds a color region such as comments or strings. @@ -236,7 +236,7 @@ Both the start and end keys must be symbols. Only the start key has to be unique .. rst-class:: classref-method -void **add_keyword_color** **(** :ref:`String` keyword, :ref:`Color` color **)** +|void| **add_keyword_color**\ (\ keyword\: :ref:`String`, color\: :ref:`Color`\ ) Sets the color for a keyword. @@ -250,7 +250,7 @@ The keyword cannot contain any symbols except '\_'. .. rst-class:: classref-method -void **add_member_keyword_color** **(** :ref:`String` member_keyword, :ref:`Color` color **)** +|void| **add_member_keyword_color**\ (\ member_keyword\: :ref:`String`, color\: :ref:`Color`\ ) Sets the color for a member keyword. @@ -266,7 +266,7 @@ It will not be highlighted if preceded by a '.'. .. rst-class:: classref-method -void **clear_color_regions** **(** **)** +|void| **clear_color_regions**\ (\ ) Removes all color regions. @@ -278,7 +278,7 @@ Removes all color regions. .. rst-class:: classref-method -void **clear_keyword_colors** **(** **)** +|void| **clear_keyword_colors**\ (\ ) Removes all keywords. @@ -290,7 +290,7 @@ Removes all keywords. .. rst-class:: classref-method -void **clear_member_keyword_colors** **(** **)** +|void| **clear_member_keyword_colors**\ (\ ) Removes all member keywords. @@ -302,7 +302,7 @@ Removes all member keywords. .. rst-class:: classref-method -:ref:`Color` **get_keyword_color** **(** :ref:`String` keyword **)** |const| +:ref:`Color` **get_keyword_color**\ (\ keyword\: :ref:`String`\ ) |const| Returns the color for a keyword. @@ -314,7 +314,7 @@ Returns the color for a keyword. .. rst-class:: classref-method -:ref:`Color` **get_member_keyword_color** **(** :ref:`String` member_keyword **)** |const| +:ref:`Color` **get_member_keyword_color**\ (\ member_keyword\: :ref:`String`\ ) |const| Returns the color for a member keyword. @@ -326,7 +326,7 @@ Returns the color for a member keyword. .. rst-class:: classref-method -:ref:`bool` **has_color_region** **(** :ref:`String` start_key **)** |const| +:ref:`bool` **has_color_region**\ (\ start_key\: :ref:`String`\ ) |const| Returns ``true`` if the start key exists, else ``false``. @@ -338,7 +338,7 @@ Returns ``true`` if the start key exists, else ``false``. .. rst-class:: classref-method -:ref:`bool` **has_keyword_color** **(** :ref:`String` keyword **)** |const| +:ref:`bool` **has_keyword_color**\ (\ keyword\: :ref:`String`\ ) |const| Returns ``true`` if the keyword exists, else ``false``. @@ -350,7 +350,7 @@ Returns ``true`` if the keyword exists, else ``false``. .. rst-class:: classref-method -:ref:`bool` **has_member_keyword_color** **(** :ref:`String` member_keyword **)** |const| +:ref:`bool` **has_member_keyword_color**\ (\ member_keyword\: :ref:`String`\ ) |const| Returns ``true`` if the member keyword exists, else ``false``. @@ -362,7 +362,7 @@ Returns ``true`` if the member keyword exists, else ``false``. .. rst-class:: classref-method -void **remove_color_region** **(** :ref:`String` start_key **)** +|void| **remove_color_region**\ (\ start_key\: :ref:`String`\ ) Removes the color region that uses that start key. @@ -374,7 +374,7 @@ Removes the color region that uses that start key. .. rst-class:: classref-method -void **remove_keyword_color** **(** :ref:`String` keyword **)** +|void| **remove_keyword_color**\ (\ keyword\: :ref:`String`\ ) Removes the keyword. @@ -386,7 +386,7 @@ Removes the keyword. .. rst-class:: classref-method -void **remove_member_keyword_color** **(** :ref:`String` member_keyword **)** +|void| **remove_member_keyword_color**\ (\ member_keyword\: :ref:`String`\ ) Removes the member keyword. @@ -397,3 +397,4 @@ Removes the member keyword. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 65654ec68e1..5100fa0bc75 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -53,65 +53,65 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_input_event` **(** :ref:`Viewport` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** |virtual| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_mouse_enter` **(** **)** |virtual| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_mouse_exit` **(** **)** |virtual| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_mouse_shape_enter` **(** :ref:`int` shape_idx **)** |virtual| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_mouse_shape_exit` **(** :ref:`int` shape_idx **)** |virtual| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_collision_layer_value` **(** :ref:`int` layer_number **)** |const| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_collision_mask_value` **(** :ref:`int` layer_number **)** |const| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_shape_owner_one_way_collision_margin` **(** :ref:`int` owner_id **)** |const| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_shape_owners` **(** **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_shape_owner_disabled` **(** :ref:`int` owner_id **)** |const| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_shape_owner_one_way_collision_enabled` **(** :ref:`int` owner_id **)** |const| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_shape_owner` **(** :ref:`int` owner_id **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** |const| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** |const| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Shape2D` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** |const| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shape_owner_get_shape_index` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** |const| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shape_owner_set_disabled` **(** :ref:`int` owner_id, :ref:`bool` disabled **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shape_owner_set_one_way_collision` **(** :ref:`int` owner_id, :ref:`bool` enable **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shape_owner_set_one_way_collision_margin` **(** :ref:`int` owner_id, :ref:`float` margin **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_input_event`\ (\ viewport\: :ref:`Viewport`, event\: :ref:`InputEvent`, shape_idx\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_mouse_enter`\ (\ ) |virtual| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_mouse_exit`\ (\ ) |virtual| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_mouse_shape_enter`\ (\ shape_idx\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_mouse_shape_exit`\ (\ shape_idx\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`create_shape_owner`\ (\ owner\: :ref:`Object`\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_collision_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_collision_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_shape_owner_one_way_collision_margin`\ (\ owner_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_shape_owners`\ (\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_shape_owner_disabled`\ (\ owner_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_shape_owner_one_way_collision_enabled`\ (\ owner_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_shape_owner`\ (\ owner_id\: :ref:`int`\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shape_find_owner`\ (\ shape_index\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_owner_add_shape`\ (\ owner_id\: :ref:`int`, shape\: :ref:`Shape2D`\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_owner_clear_shapes`\ (\ owner_id\: :ref:`int`\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`shape_owner_get_owner`\ (\ owner_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Shape2D` | :ref:`shape_owner_get_shape`\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shape_owner_get_shape_count`\ (\ owner_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shape_owner_get_shape_index`\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`shape_owner_get_transform`\ (\ owner_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_owner_remove_shape`\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_owner_set_disabled`\ (\ owner_id\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_owner_set_one_way_collision`\ (\ owner_id\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_owner_set_one_way_collision_margin`\ (\ owner_id\: :ref:`int`, margin\: :ref:`float`\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_owner_set_transform`\ (\ owner_id\: :ref:`int`, transform\: :ref:`Transform2D`\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -126,7 +126,7 @@ Signals .. rst-class:: classref-signal -**input_event** **(** :ref:`Node` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** +**input_event**\ (\ viewport\: :ref:`Node`, event\: :ref:`InputEvent`, shape_idx\: :ref:`int`\ ) Emitted when an input event occurs. Requires :ref:`input_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. See :ref:`_input_event` for details. @@ -138,7 +138,7 @@ Emitted when an input event occurs. Requires :ref:`input_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. Note that moving between different shapes within a single **CollisionObject2D** won't cause this signal to be emitted. @@ -152,7 +152,7 @@ Emitted when the mouse pointer enters any of this object's shapes. Requires :ref .. rst-class:: classref-signal -**mouse_exited** **(** **)** +**mouse_exited**\ (\ ) Emitted when the mouse pointer exits all this object's shapes. Requires :ref:`input_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. Note that moving between different shapes within a single **CollisionObject2D** won't cause this signal to be emitted. @@ -166,7 +166,7 @@ Emitted when the mouse pointer exits all this object's shapes. Requires :ref:`in .. rst-class:: classref-signal -**mouse_shape_entered** **(** :ref:`int` shape_idx **)** +**mouse_shape_entered**\ (\ shape_idx\: :ref:`int`\ ) Emitted when the mouse pointer enters any of this object's shapes or moves from one shape to another. ``shape_idx`` is the child index of the newly entered :ref:`Shape2D`. Requires :ref:`input_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. @@ -178,7 +178,7 @@ Emitted when the mouse pointer enters any of this object's shapes or moves from .. rst-class:: classref-signal -**mouse_shape_exited** **(** :ref:`int` shape_idx **)** +**mouse_shape_exited**\ (\ shape_idx\: :ref:`int`\ ) Emitted when the mouse pointer exits any of this object's shapes. ``shape_idx`` is the child index of the exited :ref:`Shape2D`. Requires :ref:`input_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. @@ -242,8 +242,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_collision_layer** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_layer** **(** **)** +- |void| **set_collision_layer**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_layer**\ (\ ) The physics layers this CollisionObject2D is in. Collision objects can exist in one or more of 32 different layers. See also :ref:`collision_mask`. @@ -261,8 +261,8 @@ The physics layers this CollisionObject2D is in. Collision objects can exist in .. rst-class:: classref-property-setget -- void **set_collision_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_mask** **(** **)** +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) The physics layers this CollisionObject2D scans. Collision objects can scan one or more of 32 different layers. See also :ref:`collision_layer`. @@ -280,8 +280,8 @@ The physics layers this CollisionObject2D scans. Collision objects can scan one .. rst-class:: classref-property-setget -- void **set_collision_priority** **(** :ref:`float` value **)** -- :ref:`float` **get_collision_priority** **(** **)** +- |void| **set_collision_priority**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_collision_priority**\ (\ ) The priority used to solve colliding when occurring penetration. The higher the priority is, the lower the penetration into the object will be. This can for example be used to prevent the player from breaking through the boundaries of a level. @@ -297,8 +297,8 @@ The priority used to solve colliding when occurring penetration. The higher the .. rst-class:: classref-property-setget -- void **set_disable_mode** **(** :ref:`DisableMode` value **)** -- :ref:`DisableMode` **get_disable_mode** **(** **)** +- |void| **set_disable_mode**\ (\ value\: :ref:`DisableMode`\ ) +- :ref:`DisableMode` **get_disable_mode**\ (\ ) Defines the behavior in physics when :ref:`Node.process_mode` is set to :ref:`Node.PROCESS_MODE_DISABLED`. See :ref:`DisableMode` for more details about the different modes. @@ -314,8 +314,8 @@ Defines the behavior in physics when :ref:`Node.process_mode` value **)** -- :ref:`bool` **is_pickable** **(** **)** +- |void| **set_pickable**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_pickable**\ (\ ) If ``true``, this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events. Requires at least one :ref:`collision_layer` bit to be set. @@ -332,7 +332,7 @@ Method Descriptions .. rst-class:: classref-method -void **_input_event** **(** :ref:`Viewport` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** |virtual| +|void| **_input_event**\ (\ viewport\: :ref:`Viewport`, event\: :ref:`InputEvent`, shape_idx\: :ref:`int`\ ) |virtual| Accepts unhandled :ref:`InputEvent`\ s. ``shape_idx`` is the child index of the clicked :ref:`Shape2D`. Connect to :ref:`input_event` to easily pick up these events. @@ -346,7 +346,7 @@ Accepts unhandled :ref:`InputEvent`\ s. ``shape_idx`` is the c .. rst-class:: classref-method -void **_mouse_enter** **(** **)** |virtual| +|void| **_mouse_enter**\ (\ ) |virtual| Called when the mouse pointer enters any of this object's shapes. Requires :ref:`input_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. Note that moving between different shapes within a single **CollisionObject2D** won't cause this function to be called. @@ -358,7 +358,7 @@ Called when the mouse pointer enters any of this object's shapes. Requires :ref: .. rst-class:: classref-method -void **_mouse_exit** **(** **)** |virtual| +|void| **_mouse_exit**\ (\ ) |virtual| Called when the mouse pointer exits all this object's shapes. Requires :ref:`input_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. Note that moving between different shapes within a single **CollisionObject2D** won't cause this function to be called. @@ -370,7 +370,7 @@ Called when the mouse pointer exits all this object's shapes. Requires :ref:`inp .. rst-class:: classref-method -void **_mouse_shape_enter** **(** :ref:`int` shape_idx **)** |virtual| +|void| **_mouse_shape_enter**\ (\ shape_idx\: :ref:`int`\ ) |virtual| Called when the mouse pointer enters any of this object's shapes or moves from one shape to another. ``shape_idx`` is the child index of the newly entered :ref:`Shape2D`. Requires :ref:`input_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be called. @@ -382,7 +382,7 @@ Called when the mouse pointer enters any of this object's shapes or moves from o .. rst-class:: classref-method -void **_mouse_shape_exit** **(** :ref:`int` shape_idx **)** |virtual| +|void| **_mouse_shape_exit**\ (\ shape_idx\: :ref:`int`\ ) |virtual| Called when the mouse pointer exits any of this object's shapes. ``shape_idx`` is the child index of the exited :ref:`Shape2D`. Requires :ref:`input_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be called. @@ -394,7 +394,7 @@ Called when the mouse pointer exits any of this object's shapes. ``shape_idx`` i .. rst-class:: classref-method -:ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** +:ref:`int` **create_shape_owner**\ (\ owner\: :ref:`Object`\ ) Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference. @@ -406,7 +406,7 @@ Creates a new shape owner for the given object. Returns ``owner_id`` of the new .. rst-class:: classref-method -:ref:`bool` **get_collision_layer_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_collision_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`collision_layer` is enabled, given a ``layer_number`` between 1 and 32. @@ -418,7 +418,7 @@ Returns whether or not the specified layer of the :ref:`collision_layer` **get_collision_mask_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -430,7 +430,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_rid** **(** **)** |const| +:ref:`RID` **get_rid**\ (\ ) |const| Returns the object's :ref:`RID`. @@ -442,7 +442,7 @@ Returns the object's :ref:`RID`. .. rst-class:: classref-method -:ref:`float` **get_shape_owner_one_way_collision_margin** **(** :ref:`int` owner_id **)** |const| +:ref:`float` **get_shape_owner_one_way_collision_margin**\ (\ owner_id\: :ref:`int`\ ) |const| Returns the ``one_way_collision_margin`` of the shape owner identified by given ``owner_id``. @@ -454,7 +454,7 @@ Returns the ``one_way_collision_margin`` of the shape owner identified by given .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_shape_owners** **(** **)** +:ref:`PackedInt32Array` **get_shape_owners**\ (\ ) Returns an :ref:`Array` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument. @@ -466,7 +466,7 @@ Returns an :ref:`Array` of ``owner_id`` identifiers. You can use th .. rst-class:: classref-method -:ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** |const| +:ref:`bool` **is_shape_owner_disabled**\ (\ owner_id\: :ref:`int`\ ) |const| If ``true``, the shape owner and its shapes are disabled. @@ -478,7 +478,7 @@ If ``true``, the shape owner and its shapes are disabled. .. rst-class:: classref-method -:ref:`bool` **is_shape_owner_one_way_collision_enabled** **(** :ref:`int` owner_id **)** |const| +:ref:`bool` **is_shape_owner_one_way_collision_enabled**\ (\ owner_id\: :ref:`int`\ ) |const| Returns ``true`` if collisions for the shape owner originating from this **CollisionObject2D** will not be reported to collided with **CollisionObject2D**\ s. @@ -490,7 +490,7 @@ Returns ``true`` if collisions for the shape owner originating from this **Colli .. rst-class:: classref-method -void **remove_shape_owner** **(** :ref:`int` owner_id **)** +|void| **remove_shape_owner**\ (\ owner_id\: :ref:`int`\ ) Removes the given shape owner. @@ -502,7 +502,7 @@ Removes the given shape owner. .. rst-class:: classref-method -void **set_collision_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_collision_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`collision_layer`, given a ``layer_number`` between 1 and 32. @@ -514,7 +514,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. rst-class:: classref-method -void **set_collision_mask_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. @@ -526,7 +526,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. rst-class:: classref-method -:ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** |const| +:ref:`int` **shape_find_owner**\ (\ shape_index\: :ref:`int`\ ) |const| Returns the ``owner_id`` of the given shape. @@ -538,7 +538,7 @@ Returns the ``owner_id`` of the given shape. .. rst-class:: classref-method -void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** +|void| **shape_owner_add_shape**\ (\ owner_id\: :ref:`int`, shape\: :ref:`Shape2D`\ ) Adds a :ref:`Shape2D` to the shape owner. @@ -550,7 +550,7 @@ Adds a :ref:`Shape2D` to the shape owner. .. rst-class:: classref-method -void **shape_owner_clear_shapes** **(** :ref:`int` owner_id **)** +|void| **shape_owner_clear_shapes**\ (\ owner_id\: :ref:`int`\ ) Removes all shapes from the shape owner. @@ -562,7 +562,7 @@ Removes all shapes from the shape owner. .. rst-class:: classref-method -:ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** |const| +:ref:`Object` **shape_owner_get_owner**\ (\ owner_id\: :ref:`int`\ ) |const| Returns the parent object of the given shape owner. @@ -574,7 +574,7 @@ Returns the parent object of the given shape owner. .. rst-class:: classref-method -:ref:`Shape2D` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| +:ref:`Shape2D` **shape_owner_get_shape**\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| Returns the :ref:`Shape2D` with the given ID from the given shape owner. @@ -586,7 +586,7 @@ Returns the :ref:`Shape2D` with the given ID from the given shape .. rst-class:: classref-method -:ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** |const| +:ref:`int` **shape_owner_get_shape_count**\ (\ owner_id\: :ref:`int`\ ) |const| Returns the number of shapes the given shape owner contains. @@ -598,7 +598,7 @@ Returns the number of shapes the given shape owner contains. .. rst-class:: classref-method -:ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| +:ref:`int` **shape_owner_get_shape_index**\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| Returns the child index of the :ref:`Shape2D` with the given ID from the given shape owner. @@ -610,7 +610,7 @@ Returns the child index of the :ref:`Shape2D` with the given ID f .. rst-class:: classref-method -:ref:`Transform2D` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** |const| +:ref:`Transform2D` **shape_owner_get_transform**\ (\ owner_id\: :ref:`int`\ ) |const| Returns the shape owner's :ref:`Transform2D`. @@ -622,7 +622,7 @@ Returns the shape owner's :ref:`Transform2D`. .. rst-class:: classref-method -void **shape_owner_remove_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** +|void| **shape_owner_remove_shape**\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) Removes a shape from the given shape owner. @@ -634,7 +634,7 @@ Removes a shape from the given shape owner. .. rst-class:: classref-method -void **shape_owner_set_disabled** **(** :ref:`int` owner_id, :ref:`bool` disabled **)** +|void| **shape_owner_set_disabled**\ (\ owner_id\: :ref:`int`, disabled\: :ref:`bool`\ ) If ``true``, disables the given shape owner. @@ -646,7 +646,7 @@ If ``true``, disables the given shape owner. .. rst-class:: classref-method -void **shape_owner_set_one_way_collision** **(** :ref:`int` owner_id, :ref:`bool` enable **)** +|void| **shape_owner_set_one_way_collision**\ (\ owner_id\: :ref:`int`, enable\: :ref:`bool`\ ) If ``enable`` is ``true``, collisions for the shape owner originating from this **CollisionObject2D** will not be reported to collided with **CollisionObject2D**\ s. @@ -658,7 +658,7 @@ If ``enable`` is ``true``, collisions for the shape owner originating from this .. rst-class:: classref-method -void **shape_owner_set_one_way_collision_margin** **(** :ref:`int` owner_id, :ref:`float` margin **)** +|void| **shape_owner_set_one_way_collision_margin**\ (\ owner_id\: :ref:`int`, margin\: :ref:`float`\ ) Sets the ``one_way_collision_margin`` of the shape owner identified by given ``owner_id`` to ``margin`` pixels. @@ -670,7 +670,7 @@ Sets the ``one_way_collision_margin`` of the shape owner identified by given ``o .. rst-class:: classref-method -void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** +|void| **shape_owner_set_transform**\ (\ owner_id\: :ref:`int`, transform\: :ref:`Transform2D`\ ) Sets the :ref:`Transform2D` of the given shape owner. @@ -681,3 +681,4 @@ Sets the :ref:`Transform2D` of the given shape owner. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_collisionobject3d.rst b/classes/class_collisionobject3d.rst index 554625c2de3..06e2beb1c3f 100644 --- a/classes/class_collisionobject3d.rst +++ b/classes/class_collisionobject3d.rst @@ -55,53 +55,53 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_input_event` **(** :ref:`Camera3D` camera, :ref:`InputEvent` event, :ref:`Vector3` position, :ref:`Vector3` normal, :ref:`int` shape_idx **)** |virtual| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_mouse_enter` **(** **)** |virtual| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_mouse_exit` **(** **)** |virtual| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_collision_layer_value` **(** :ref:`int` layer_number **)** |const| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_collision_mask_value` **(** :ref:`int` layer_number **)** |const| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_shape_owners` **(** **)** | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_shape_owner_disabled` **(** :ref:`int` owner_id **)** |const| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_shape_owner` **(** :ref:`int` owner_id **)** | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** |const| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape3D` shape **)** | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** |const| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Shape3D` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** |const| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shape_owner_get_shape_index` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** |const| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shape_owner_set_disabled` **(** :ref:`int` owner_id, :ref:`bool` disabled **)** | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform3D` transform **)** | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_input_event`\ (\ camera\: :ref:`Camera3D`, event\: :ref:`InputEvent`, position\: :ref:`Vector3`, normal\: :ref:`Vector3`, shape_idx\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_mouse_enter`\ (\ ) |virtual| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_mouse_exit`\ (\ ) |virtual| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`create_shape_owner`\ (\ owner\: :ref:`Object`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_collision_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_collision_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_shape_owners`\ (\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_shape_owner_disabled`\ (\ owner_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_shape_owner`\ (\ owner_id\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shape_find_owner`\ (\ shape_index\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_owner_add_shape`\ (\ owner_id\: :ref:`int`, shape\: :ref:`Shape3D`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_owner_clear_shapes`\ (\ owner_id\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`shape_owner_get_owner`\ (\ owner_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Shape3D` | :ref:`shape_owner_get_shape`\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shape_owner_get_shape_count`\ (\ owner_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shape_owner_get_shape_index`\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`shape_owner_get_transform`\ (\ owner_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_owner_remove_shape`\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_owner_set_disabled`\ (\ owner_id\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_owner_set_transform`\ (\ owner_id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -116,7 +116,7 @@ Signals .. rst-class:: classref-signal -**input_event** **(** :ref:`Node` camera, :ref:`InputEvent` event, :ref:`Vector3` position, :ref:`Vector3` normal, :ref:`int` shape_idx **)** +**input_event**\ (\ camera\: :ref:`Node`, event\: :ref:`InputEvent`, position\: :ref:`Vector3`, normal\: :ref:`Vector3`, shape_idx\: :ref:`int`\ ) Emitted when the object receives an unhandled :ref:`InputEvent`. ``position`` is the location in world space of the mouse pointer on the surface of the shape with index ``shape_idx`` and ``normal`` is the normal vector of the surface at that point. @@ -128,7 +128,7 @@ Emitted when the object receives an unhandled :ref:`InputEvent .. rst-class:: classref-signal -**mouse_entered** **(** **)** +**mouse_entered**\ (\ ) Emitted when the mouse pointer enters any of this object's shapes. Requires :ref:`input_ray_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. @@ -142,7 +142,7 @@ Emitted when the mouse pointer enters any of this object's shapes. Requires :ref .. rst-class:: classref-signal -**mouse_exited** **(** **)** +**mouse_exited**\ (\ ) Emitted when the mouse pointer exits all this object's shapes. Requires :ref:`input_ray_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. @@ -208,8 +208,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_collision_layer** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_layer** **(** **)** +- |void| **set_collision_layer**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_layer**\ (\ ) The physics layers this CollisionObject3D **is in**. Collision objects can exist in one or more of 32 different layers. See also :ref:`collision_mask`. @@ -227,8 +227,8 @@ The physics layers this CollisionObject3D **is in**. Collision objects can exist .. rst-class:: classref-property-setget -- void **set_collision_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_mask** **(** **)** +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) The physics layers this CollisionObject3D **scans**. Collision objects can scan one or more of 32 different layers. See also :ref:`collision_layer`. @@ -246,8 +246,8 @@ The physics layers this CollisionObject3D **scans**. Collision objects can scan .. rst-class:: classref-property-setget -- void **set_collision_priority** **(** :ref:`float` value **)** -- :ref:`float` **get_collision_priority** **(** **)** +- |void| **set_collision_priority**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_collision_priority**\ (\ ) The priority used to solve colliding when occurring penetration. The higher the priority is, the lower the penetration into the object will be. This can for example be used to prevent the player from breaking through the boundaries of a level. @@ -263,8 +263,8 @@ The priority used to solve colliding when occurring penetration. The higher the .. rst-class:: classref-property-setget -- void **set_disable_mode** **(** :ref:`DisableMode` value **)** -- :ref:`DisableMode` **get_disable_mode** **(** **)** +- |void| **set_disable_mode**\ (\ value\: :ref:`DisableMode`\ ) +- :ref:`DisableMode` **get_disable_mode**\ (\ ) Defines the behavior in physics when :ref:`Node.process_mode` is set to :ref:`Node.PROCESS_MODE_DISABLED`. See :ref:`DisableMode` for more details about the different modes. @@ -280,8 +280,8 @@ Defines the behavior in physics when :ref:`Node.process_mode` value **)** -- :ref:`bool` **get_capture_input_on_drag** **(** **)** +- |void| **set_capture_input_on_drag**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_capture_input_on_drag**\ (\ ) If ``true``, the **CollisionObject3D** will continue to receive input events as the mouse is dragged across its shapes. @@ -297,8 +297,8 @@ If ``true``, the **CollisionObject3D** will continue to receive input events as .. rst-class:: classref-property-setget -- void **set_ray_pickable** **(** :ref:`bool` value **)** -- :ref:`bool` **is_ray_pickable** **(** **)** +- |void| **set_ray_pickable**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_ray_pickable**\ (\ ) If ``true``, this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events. Requires at least one :ref:`collision_layer` bit to be set. @@ -315,7 +315,7 @@ Method Descriptions .. rst-class:: classref-method -void **_input_event** **(** :ref:`Camera3D` camera, :ref:`InputEvent` event, :ref:`Vector3` position, :ref:`Vector3` normal, :ref:`int` shape_idx **)** |virtual| +|void| **_input_event**\ (\ camera\: :ref:`Camera3D`, event\: :ref:`InputEvent`, position\: :ref:`Vector3`, normal\: :ref:`Vector3`, shape_idx\: :ref:`int`\ ) |virtual| Receives unhandled :ref:`InputEvent`\ s. ``position`` is the location in world space of the mouse pointer on the surface of the shape with index ``shape_idx`` and ``normal`` is the normal vector of the surface at that point. Connect to the :ref:`input_event` signal to easily pick up these events. @@ -329,7 +329,7 @@ Receives unhandled :ref:`InputEvent`\ s. ``position`` is the l .. rst-class:: classref-method -void **_mouse_enter** **(** **)** |virtual| +|void| **_mouse_enter**\ (\ ) |virtual| Called when the mouse pointer enters any of this object's shapes. Requires :ref:`input_ray_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. Note that moving between different shapes within a single **CollisionObject3D** won't cause this function to be called. @@ -341,7 +341,7 @@ Called when the mouse pointer enters any of this object's shapes. Requires :ref: .. rst-class:: classref-method -void **_mouse_exit** **(** **)** |virtual| +|void| **_mouse_exit**\ (\ ) |virtual| Called when the mouse pointer exits all this object's shapes. Requires :ref:`input_ray_pickable` to be ``true`` and at least one :ref:`collision_layer` bit to be set. Note that moving between different shapes within a single **CollisionObject3D** won't cause this function to be called. @@ -353,7 +353,7 @@ Called when the mouse pointer exits all this object's shapes. Requires :ref:`inp .. rst-class:: classref-method -:ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** +:ref:`int` **create_shape_owner**\ (\ owner\: :ref:`Object`\ ) Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference. @@ -365,7 +365,7 @@ Creates a new shape owner for the given object. Returns ``owner_id`` of the new .. rst-class:: classref-method -:ref:`bool` **get_collision_layer_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_collision_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`collision_layer` is enabled, given a ``layer_number`` between 1 and 32. @@ -377,7 +377,7 @@ Returns whether or not the specified layer of the :ref:`collision_layer` **get_collision_mask_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -389,7 +389,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_rid** **(** **)** |const| +:ref:`RID` **get_rid**\ (\ ) |const| Returns the object's :ref:`RID`. @@ -401,7 +401,7 @@ Returns the object's :ref:`RID`. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_shape_owners** **(** **)** +:ref:`PackedInt32Array` **get_shape_owners**\ (\ ) Returns an :ref:`Array` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument. @@ -413,7 +413,7 @@ Returns an :ref:`Array` of ``owner_id`` identifiers. You can use th .. rst-class:: classref-method -:ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** |const| +:ref:`bool` **is_shape_owner_disabled**\ (\ owner_id\: :ref:`int`\ ) |const| If ``true``, the shape owner and its shapes are disabled. @@ -425,7 +425,7 @@ If ``true``, the shape owner and its shapes are disabled. .. rst-class:: classref-method -void **remove_shape_owner** **(** :ref:`int` owner_id **)** +|void| **remove_shape_owner**\ (\ owner_id\: :ref:`int`\ ) Removes the given shape owner. @@ -437,7 +437,7 @@ Removes the given shape owner. .. rst-class:: classref-method -void **set_collision_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_collision_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`collision_layer`, given a ``layer_number`` between 1 and 32. @@ -449,7 +449,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. rst-class:: classref-method -void **set_collision_mask_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. @@ -461,7 +461,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. rst-class:: classref-method -:ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** |const| +:ref:`int` **shape_find_owner**\ (\ shape_index\: :ref:`int`\ ) |const| Returns the ``owner_id`` of the given shape. @@ -473,7 +473,7 @@ Returns the ``owner_id`` of the given shape. .. rst-class:: classref-method -void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape3D` shape **)** +|void| **shape_owner_add_shape**\ (\ owner_id\: :ref:`int`, shape\: :ref:`Shape3D`\ ) Adds a :ref:`Shape3D` to the shape owner. @@ -485,7 +485,7 @@ Adds a :ref:`Shape3D` to the shape owner. .. rst-class:: classref-method -void **shape_owner_clear_shapes** **(** :ref:`int` owner_id **)** +|void| **shape_owner_clear_shapes**\ (\ owner_id\: :ref:`int`\ ) Removes all shapes from the shape owner. @@ -497,7 +497,7 @@ Removes all shapes from the shape owner. .. rst-class:: classref-method -:ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** |const| +:ref:`Object` **shape_owner_get_owner**\ (\ owner_id\: :ref:`int`\ ) |const| Returns the parent object of the given shape owner. @@ -509,7 +509,7 @@ Returns the parent object of the given shape owner. .. rst-class:: classref-method -:ref:`Shape3D` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| +:ref:`Shape3D` **shape_owner_get_shape**\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| Returns the :ref:`Shape3D` with the given ID from the given shape owner. @@ -521,7 +521,7 @@ Returns the :ref:`Shape3D` with the given ID from the given shape .. rst-class:: classref-method -:ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** |const| +:ref:`int` **shape_owner_get_shape_count**\ (\ owner_id\: :ref:`int`\ ) |const| Returns the number of shapes the given shape owner contains. @@ -533,7 +533,7 @@ Returns the number of shapes the given shape owner contains. .. rst-class:: classref-method -:ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| +:ref:`int` **shape_owner_get_shape_index**\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) |const| Returns the child index of the :ref:`Shape3D` with the given ID from the given shape owner. @@ -545,7 +545,7 @@ Returns the child index of the :ref:`Shape3D` with the given ID f .. rst-class:: classref-method -:ref:`Transform3D` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** |const| +:ref:`Transform3D` **shape_owner_get_transform**\ (\ owner_id\: :ref:`int`\ ) |const| Returns the shape owner's :ref:`Transform3D`. @@ -557,7 +557,7 @@ Returns the shape owner's :ref:`Transform3D`. .. rst-class:: classref-method -void **shape_owner_remove_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** +|void| **shape_owner_remove_shape**\ (\ owner_id\: :ref:`int`, shape_id\: :ref:`int`\ ) Removes a shape from the given shape owner. @@ -569,7 +569,7 @@ Removes a shape from the given shape owner. .. rst-class:: classref-method -void **shape_owner_set_disabled** **(** :ref:`int` owner_id, :ref:`bool` disabled **)** +|void| **shape_owner_set_disabled**\ (\ owner_id\: :ref:`int`, disabled\: :ref:`bool`\ ) If ``true``, disables the given shape owner. @@ -581,7 +581,7 @@ If ``true``, disables the given shape owner. .. rst-class:: classref-method -void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform3D` transform **)** +|void| **shape_owner_set_transform**\ (\ owner_id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) Sets the :ref:`Transform3D` of the given shape owner. @@ -592,3 +592,4 @@ Sets the :ref:`Transform3D` of the given shape owner. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index 1b5918473e4..2d9fd9da366 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -91,8 +91,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_build_mode** **(** :ref:`BuildMode` value **)** -- :ref:`BuildMode` **get_build_mode** **(** **)** +- |void| **set_build_mode**\ (\ value\: :ref:`BuildMode`\ ) +- :ref:`BuildMode` **get_build_mode**\ (\ ) Collision build mode. Use one of the :ref:`BuildMode` constants. @@ -108,8 +108,8 @@ Collision build mode. Use one of the :ref:`BuildMode` value **)** -- :ref:`bool` **is_disabled** **(** **)** +- |void| **set_disabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_disabled**\ (\ ) If ``true``, no collisions will be detected. @@ -125,8 +125,8 @@ If ``true``, no collisions will be detected. .. rst-class:: classref-property-setget -- void **set_one_way_collision** **(** :ref:`bool` value **)** -- :ref:`bool` **is_one_way_collision_enabled** **(** **)** +- |void| **set_one_way_collision**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_one_way_collision_enabled**\ (\ ) If ``true``, only edges that face up, relative to **CollisionPolygon2D**'s rotation, will collide with other objects. @@ -144,8 +144,8 @@ If ``true``, only edges that face up, relative to **CollisionPolygon2D**'s rotat .. rst-class:: classref-property-setget -- void **set_one_way_collision_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_one_way_collision_margin** **(** **)** +- |void| **set_one_way_collision_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_one_way_collision_margin**\ (\ ) The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the polygon at a high velocity. @@ -161,8 +161,8 @@ The margin used for one-way collision (in pixels). Higher values will make the s .. rst-class:: classref-property-setget -- void **set_polygon** **(** :ref:`PackedVector2Array` value **)** -- :ref:`PackedVector2Array` **get_polygon** **(** **)** +- |void| **set_polygon**\ (\ value\: :ref:`PackedVector2Array`\ ) +- :ref:`PackedVector2Array` **get_polygon**\ (\ ) The polygon's list of vertices. Each point will be connected to the next, and the final point will be connected to the first. @@ -177,3 +177,4 @@ The polygon's list of vertices. Each point will be connected to the next, and th .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_collisionpolygon3d.rst b/classes/class_collisionpolygon3d.rst index 237788b2e50..eaba73a5891 100644 --- a/classes/class_collisionpolygon3d.rst +++ b/classes/class_collisionpolygon3d.rst @@ -58,8 +58,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_depth** **(** :ref:`float` value **)** -- :ref:`float` **get_depth** **(** **)** +- |void| **set_depth**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_depth**\ (\ ) Length that the resulting collision extends in either direction perpendicular to its 2D polygon. @@ -75,8 +75,8 @@ Length that the resulting collision extends in either direction perpendicular to .. rst-class:: classref-property-setget -- void **set_disabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_disabled** **(** **)** +- |void| **set_disabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_disabled**\ (\ ) If ``true``, no collision will be produced. @@ -92,8 +92,8 @@ If ``true``, no collision will be produced. .. rst-class:: classref-property-setget -- void **set_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_margin** **(** **)** +- |void| **set_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_margin**\ (\ ) The collision margin for the generated :ref:`Shape3D`. See :ref:`Shape3D.margin` for more details. @@ -109,8 +109,8 @@ The collision margin for the generated :ref:`Shape3D`. See :ref:` .. rst-class:: classref-property-setget -- void **set_polygon** **(** :ref:`PackedVector2Array` value **)** -- :ref:`PackedVector2Array` **get_polygon** **(** **)** +- |void| **set_polygon**\ (\ value\: :ref:`PackedVector2Array`\ ) +- :ref:`PackedVector2Array` **get_polygon**\ (\ ) Array of vertices which define the 2D polygon in the local XY plane. @@ -123,3 +123,4 @@ Array of vertices which define the 2D polygon in the local XY plane. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 8f23ab24682..47db055107c 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -71,8 +71,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_debug_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_debug_color** **(** **)** +- |void| **set_debug_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_debug_color**\ (\ ) The collision shape debug color. @@ -90,8 +90,8 @@ The collision shape debug color. .. rst-class:: classref-property-setget -- void **set_disabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_disabled** **(** **)** +- |void| **set_disabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_disabled**\ (\ ) A disabled collision shape has no effect in the world. This property should be changed with :ref:`Object.set_deferred`. @@ -107,8 +107,8 @@ A disabled collision shape has no effect in the world. This property should be c .. rst-class:: classref-property-setget -- void **set_one_way_collision** **(** :ref:`bool` value **)** -- :ref:`bool` **is_one_way_collision_enabled** **(** **)** +- |void| **set_one_way_collision**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_one_way_collision_enabled**\ (\ ) Sets whether this collision shape should only detect collision on one side (top or bottom). @@ -126,8 +126,8 @@ Sets whether this collision shape should only detect collision on one side (top .. rst-class:: classref-property-setget -- void **set_one_way_collision_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_one_way_collision_margin** **(** **)** +- |void| **set_one_way_collision_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_one_way_collision_margin**\ (\ ) The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the shape at a high velocity. @@ -143,8 +143,8 @@ The margin used for one-way collision (in pixels). Higher values will make the s .. rst-class:: classref-property-setget -- void **set_shape** **(** :ref:`Shape2D` value **)** -- :ref:`Shape2D` **get_shape** **(** **)** +- |void| **set_shape**\ (\ value\: :ref:`Shape2D`\ ) +- :ref:`Shape2D` **get_shape**\ (\ ) The actual shape owned by this collision shape. @@ -155,3 +155,4 @@ The actual shape owned by this collision shape. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_collisionshape3d.rst b/classes/class_collisionshape3d.rst index be61d7c5a56..8c199da95ac 100644 --- a/classes/class_collisionshape3d.rst +++ b/classes/class_collisionshape3d.rst @@ -58,11 +58,11 @@ Methods .. table:: :widths: auto - +------+------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`make_convex_from_siblings` **(** **)** | - +------+------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | - +------+------------------------------------------------------------------------------------------------------------------------------+ + +--------+---------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`make_convex_from_siblings`\ (\ ) | + +--------+---------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`resource_changed`\ (\ resource\: :ref:`Resource`\ ) | + +--------+---------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -81,8 +81,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_disabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_disabled** **(** **)** +- |void| **set_disabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_disabled**\ (\ ) A disabled collision shape has no effect in the world. @@ -98,8 +98,8 @@ A disabled collision shape has no effect in the world. .. rst-class:: classref-property-setget -- void **set_shape** **(** :ref:`Shape3D` value **)** -- :ref:`Shape3D` **get_shape** **(** **)** +- |void| **set_shape**\ (\ value\: :ref:`Shape3D`\ ) +- :ref:`Shape3D` **get_shape**\ (\ ) The actual shape owned by this collision shape. @@ -116,7 +116,7 @@ Method Descriptions .. rst-class:: classref-method -void **make_convex_from_siblings** **(** **)** +|void| **make_convex_from_siblings**\ (\ ) Sets the collision shape's shape to the addition of all its convexed :ref:`MeshInstance3D` siblings geometry. @@ -128,7 +128,7 @@ Sets the collision shape's shape to the addition of all its convexed :ref:`MeshI .. rst-class:: classref-method -void **resource_changed** **(** :ref:`Resource` resource **)** +|void| **resource_changed**\ (\ resource\: :ref:`Resource`\ ) **Deprecated:** Use :ref:`Resource.changed` instead. @@ -141,3 +141,4 @@ This method does nothing. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_color.rst b/classes/class_color.rst index 0698715d5f5..ab3fd2977e8 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -80,21 +80,21 @@ Constructors .. table:: :widths: auto - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`Color` **(** **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`Color` **(** :ref:`Color` from, :ref:`float` alpha **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`Color` **(** :ref:`Color` from **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`Color` **(** :ref:`String` code **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`Color` **(** :ref:`String` code, :ref:`float` alpha **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`Color`\ (\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`Color`\ (\ from\: :ref:`Color`, alpha\: :ref:`float`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`Color`\ (\ from\: :ref:`Color`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`Color`\ (\ code\: :ref:`String`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`Color`\ (\ code\: :ref:`String`, alpha\: :ref:`float`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`Color`\ (\ r\: :ref:`float`, g\: :ref:`float`, b\: :ref:`float`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`Color`\ (\ r\: :ref:`float`, g\: :ref:`float`, b\: :ref:`float`, a\: :ref:`float`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -104,57 +104,57 @@ Methods .. table:: :widths: auto - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`blend` **(** :ref:`Color` over **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`clamp` **(** :ref:`Color` min=Color(0, 0, 0, 0), :ref:`Color` max=Color(1, 1, 1, 1) **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`darkened` **(** :ref:`float` amount **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`from_hsv` **(** :ref:`float` h, :ref:`float` s, :ref:`float` v, :ref:`float` alpha=1.0 **)** |static| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`from_ok_hsl` **(** :ref:`float` h, :ref:`float` s, :ref:`float` l, :ref:`float` alpha=1.0 **)** |static| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`from_rgbe9995` **(** :ref:`int` rgbe **)** |static| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`from_string` **(** :ref:`String` str, :ref:`Color` default **)** |static| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_luminance` **(** **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`hex` **(** :ref:`int` hex **)** |static| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`hex64` **(** :ref:`int` hex **)** |static| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`html` **(** :ref:`String` rgba **)** |static| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`html_is_valid` **(** :ref:`String` color **)** |static| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`inverted` **(** **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Color` to **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`lerp` **(** :ref:`Color` to, :ref:`float` weight **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`lightened` **(** :ref:`float` amount **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`linear_to_srgb` **(** **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`srgb_to_linear` **(** **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`to_abgr32` **(** **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`to_abgr64` **(** **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`to_argb32` **(** **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`to_argb64` **(** **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`to_html` **(** :ref:`bool` with_alpha=true **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`to_rgba32` **(** **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`to_rgba64` **(** **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`blend`\ (\ over\: :ref:`Color`\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`clamp`\ (\ min\: :ref:`Color` = Color(0, 0, 0, 0), max\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`darkened`\ (\ amount\: :ref:`float`\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`from_hsv`\ (\ h\: :ref:`float`, s\: :ref:`float`, v\: :ref:`float`, alpha\: :ref:`float` = 1.0\ ) |static| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`from_ok_hsl`\ (\ h\: :ref:`float`, s\: :ref:`float`, l\: :ref:`float`, alpha\: :ref:`float` = 1.0\ ) |static| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`from_rgbe9995`\ (\ rgbe\: :ref:`int`\ ) |static| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`from_string`\ (\ str\: :ref:`String`, default\: :ref:`Color`\ ) |static| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_luminance`\ (\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`hex`\ (\ hex\: :ref:`int`\ ) |static| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`hex64`\ (\ hex\: :ref:`int`\ ) |static| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`html`\ (\ rgba\: :ref:`String`\ ) |static| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`html_is_valid`\ (\ color\: :ref:`String`\ ) |static| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`inverted`\ (\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equal_approx`\ (\ to\: :ref:`Color`\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`lerp`\ (\ to\: :ref:`Color`, weight\: :ref:`float`\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`lightened`\ (\ amount\: :ref:`float`\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`linear_to_srgb`\ (\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`srgb_to_linear`\ (\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`to_abgr32`\ (\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`to_abgr64`\ (\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`to_argb32`\ (\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`to_argb64`\ (\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`to_html`\ (\ with_alpha\: :ref:`bool` = true\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`to_rgba32`\ (\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`to_rgba64`\ (\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -164,33 +164,33 @@ Operators .. table:: :widths: auto - +---------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Color` right **)** | - +---------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`operator *` **(** :ref:`Color` right **)** | - +---------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`operator *` **(** :ref:`float` right **)** | - +---------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`operator *` **(** :ref:`int` right **)** | - +---------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`operator +` **(** :ref:`Color` right **)** | - +---------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`operator -` **(** :ref:`Color` right **)** | - +---------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`operator /` **(** :ref:`Color` right **)** | - +---------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`operator /` **(** :ref:`float` right **)** | - +---------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`operator /` **(** :ref:`int` right **)** | - +---------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Color` right **)** | - +---------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator []` **(** :ref:`int` index **)** | - +---------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`operator unary+` **(** **)** | - +---------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`operator unary-` **(** **)** | - +---------------------------+------------------------------------------------------------------------------------------------+ + +---------------------------+---------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Color`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`operator *`\ (\ right\: :ref:`Color`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`operator *`\ (\ right\: :ref:`float`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`operator *`\ (\ right\: :ref:`int`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`operator +`\ (\ right\: :ref:`Color`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`operator -`\ (\ right\: :ref:`Color`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`operator /`\ (\ right\: :ref:`Color`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`operator /`\ (\ right\: :ref:`float`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`operator /`\ (\ right\: :ref:`int`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Color`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`operator unary+`\ (\ ) | + +---------------------------+---------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`operator unary-`\ (\ ) | + +---------------------------+---------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -1519,7 +1519,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Color` **Color** **(** **)** +:ref:`Color` **Color**\ (\ ) Constructs a default **Color** from opaque black. This is the same as :ref:`BLACK`. @@ -1531,7 +1531,7 @@ Constructs a default **Color** from opaque black. This is the same as :ref:`BLAC .. rst-class:: classref-constructor -:ref:`Color` **Color** **(** :ref:`Color` from, :ref:`float` alpha **)** +:ref:`Color` **Color**\ (\ from\: :ref:`Color`, alpha\: :ref:`float`\ ) Constructs a **Color** from the existing color, with :ref:`a` set to the given ``alpha`` value. @@ -1554,7 +1554,7 @@ Constructs a **Color** from the existing color, with :ref:`a` **Color** **(** :ref:`Color` from **)** +:ref:`Color` **Color**\ (\ from\: :ref:`Color`\ ) Constructs a **Color** as a copy of the given **Color**. @@ -1564,7 +1564,7 @@ Constructs a **Color** as a copy of the given **Color**. .. rst-class:: classref-constructor -:ref:`Color` **Color** **(** :ref:`String` code **)** +:ref:`Color` **Color**\ (\ code\: :ref:`String`\ ) Constructs a **Color** either from an HTML color code or from a standardized color name. The supported color names are the same as the constants. @@ -1574,7 +1574,7 @@ Constructs a **Color** either from an HTML color code or from a standardized col .. rst-class:: classref-constructor -:ref:`Color` **Color** **(** :ref:`String` code, :ref:`float` alpha **)** +:ref:`Color` **Color**\ (\ code\: :ref:`String`, alpha\: :ref:`float`\ ) Constructs a **Color** either from an HTML color code or from a standardized color name, with ``alpha`` on the range of 0.0 to 1.0. The supported color names are the same as the constants. @@ -1584,7 +1584,7 @@ Constructs a **Color** either from an HTML color code or from a standardized col .. rst-class:: classref-constructor -:ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** +:ref:`Color` **Color**\ (\ r\: :ref:`float`, g\: :ref:`float`, b\: :ref:`float`\ ) Constructs a **Color** from RGB values, typically between 0.0 and 1.0. :ref:`a` is set to 1.0. @@ -1607,7 +1607,7 @@ Constructs a **Color** from RGB values, typically between 0.0 and 1.0. :ref:`a` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** +:ref:`Color` **Color**\ (\ r\: :ref:`float`, g\: :ref:`float`, b\: :ref:`float`, a\: :ref:`float`\ ) Constructs a **Color** from RGBA values, typically between 0.0 and 1.0. @@ -1637,7 +1637,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Color` **blend** **(** :ref:`Color` over **)** |const| +:ref:`Color` **blend**\ (\ over\: :ref:`Color`\ ) |const| Returns a new color resulting from overlaying this color over the given color. In a painting program, you can imagine it as the ``over`` color painted over this color (including alpha). @@ -1666,7 +1666,7 @@ Returns a new color resulting from overlaying this color over the given color. I .. rst-class:: classref-method -:ref:`Color` **clamp** **(** :ref:`Color` min=Color(0, 0, 0, 0), :ref:`Color` max=Color(1, 1, 1, 1) **)** |const| +:ref:`Color` **clamp**\ (\ min\: :ref:`Color` = Color(0, 0, 0, 0), max\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| Returns a new color with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -1678,7 +1678,7 @@ Returns a new color with all components clamped between the components of ``min` .. rst-class:: classref-method -:ref:`Color` **darkened** **(** :ref:`float` amount **)** |const| +:ref:`Color` **darkened**\ (\ amount\: :ref:`float`\ ) |const| Returns a new color resulting from making this color darker by the specified ``amount`` (ratio from 0.0 to 1.0). See also :ref:`lightened`. @@ -1705,7 +1705,7 @@ Returns a new color resulting from making this color darker by the specified ``a .. rst-class:: classref-method -:ref:`Color` **from_hsv** **(** :ref:`float` h, :ref:`float` s, :ref:`float` v, :ref:`float` alpha=1.0 **)** |static| +:ref:`Color` **from_hsv**\ (\ h\: :ref:`float`, s\: :ref:`float`, v\: :ref:`float`, alpha\: :ref:`float` = 1.0\ ) |static| Constructs a color from an `HSV profile `__. The hue (``h``), saturation (``s``), and value (``v``) are typically between 0.0 and 1.0. @@ -1730,7 +1730,7 @@ Constructs a color from an `HSV profile ` **from_ok_hsl** **(** :ref:`float` h, :ref:`float` s, :ref:`float` l, :ref:`float` alpha=1.0 **)** |static| +:ref:`Color` **from_ok_hsl**\ (\ h\: :ref:`float`, s\: :ref:`float`, l\: :ref:`float`, alpha\: :ref:`float` = 1.0\ ) |static| Constructs a color from an `OK HSL profile `__. The hue (``h``), saturation (``s``), and lightness (``l``) are typically between 0.0 and 1.0. @@ -1755,7 +1755,7 @@ Constructs a color from an `OK HSL profile ` **from_rgbe9995** **(** :ref:`int` rgbe **)** |static| +:ref:`Color` **from_rgbe9995**\ (\ rgbe\: :ref:`int`\ ) |static| Decodes a **Color** from a RGBE9995 format integer. See :ref:`Image.FORMAT_RGBE9995`. @@ -1767,7 +1767,7 @@ Decodes a **Color** from a RGBE9995 format integer. See :ref:`Image.FORMAT_RGBE9 .. rst-class:: classref-method -:ref:`Color` **from_string** **(** :ref:`String` str, :ref:`Color` default **)** |static| +:ref:`Color` **from_string**\ (\ str\: :ref:`String`, default\: :ref:`Color`\ ) |static| Creates a **Color** from the given string, which can be either an HTML color code or a named color (case-insensitive). Returns ``default`` if the color cannot be inferred from the string. @@ -1779,7 +1779,7 @@ Creates a **Color** from the given string, which can be either an HTML color cod .. rst-class:: classref-method -:ref:`float` **get_luminance** **(** **)** |const| +:ref:`float` **get_luminance**\ (\ ) |const| Returns the light intensity of the color, as a value between 0.0 and 1.0 (inclusive). This is useful when determining light or dark color. Colors with a luminance smaller than 0.5 can be generally considered dark. @@ -1793,7 +1793,7 @@ Returns the light intensity of the color, as a value between 0.0 and 1.0 (inclus .. rst-class:: classref-method -:ref:`Color` **hex** **(** :ref:`int` hex **)** |static| +:ref:`Color` **hex**\ (\ hex\: :ref:`int`\ ) |static| Returns the **Color** associated with the provided ``hex`` integer in 32-bit RGBA format (8 bits per channel). @@ -1824,7 +1824,7 @@ In GDScript and C#, the :ref:`int` is best visualized with hexadecima .. rst-class:: classref-method -:ref:`Color` **hex64** **(** :ref:`int` hex **)** |static| +:ref:`Color` **hex64**\ (\ hex\: :ref:`int`\ ) |static| Returns the **Color** associated with the provided ``hex`` integer in 64-bit RGBA format (16 bits per channel). @@ -1838,7 +1838,7 @@ In GDScript and C#, the :ref:`int` is best visualized with hexadecima .. rst-class:: classref-method -:ref:`Color` **html** **(** :ref:`String` rgba **)** |static| +:ref:`Color` **html**\ (\ rgba\: :ref:`String`\ ) |static| Returns a new color from ``rgba``, an HTML hexadecimal color string. ``rgba`` is not case-sensitive, and may be prefixed by a hash sign (``#``). @@ -1869,7 +1869,7 @@ Returns a new color from ``rgba``, an HTML hexadecimal color string. ``rgba`` is .. rst-class:: classref-method -:ref:`bool` **html_is_valid** **(** :ref:`String` color **)** |static| +:ref:`bool` **html_is_valid**\ (\ color\: :ref:`String`\ ) |static| Returns ``true`` if ``color`` is a valid HTML hexadecimal color string. The string must be a hexadecimal value (case-insensitive) of either 3, 4, 6 or 8 digits, and may be prefixed by a hash sign (``#``). This method is identical to :ref:`String.is_valid_html_color`. @@ -1906,7 +1906,7 @@ Returns ``true`` if ``color`` is a valid HTML hexadecimal color string. The stri .. rst-class:: classref-method -:ref:`Color` **inverted** **(** **)** |const| +:ref:`Color` **inverted**\ (\ ) |const| Returns the color with its :ref:`r`, :ref:`g`, and :ref:`b` components inverted (``(1 - r, 1 - g, 1 - b, a)``). @@ -1935,7 +1935,7 @@ Returns the color with its :ref:`r`, :ref:`g` **is_equal_approx** **(** :ref:`Color` to **)** |const| +:ref:`bool` **is_equal_approx**\ (\ to\: :ref:`Color`\ ) |const| Returns ``true`` if this color and ``to`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. @@ -1947,7 +1947,7 @@ Returns ``true`` if this color and ``to`` are approximately equal, by running :r .. rst-class:: classref-method -:ref:`Color` **lerp** **(** :ref:`Color` to, :ref:`float` weight **)** |const| +:ref:`Color` **lerp**\ (\ to\: :ref:`Color`, weight\: :ref:`float`\ ) |const| Returns the linear interpolation between this color's components and ``to``'s components. The interpolation factor ``weight`` should be between 0.0 and 1.0 (inclusive). See also :ref:`@GlobalScope.lerp`. @@ -1982,7 +1982,7 @@ Returns the linear interpolation between this color's components and ``to``'s co .. rst-class:: classref-method -:ref:`Color` **lightened** **(** :ref:`float` amount **)** |const| +:ref:`Color` **lightened**\ (\ amount\: :ref:`float`\ ) |const| Returns a new color resulting from making this color lighter by the specified ``amount``, which should be a ratio from 0.0 to 1.0. See also :ref:`darkened`. @@ -2009,7 +2009,7 @@ Returns a new color resulting from making this color lighter by the specified `` .. rst-class:: classref-method -:ref:`Color` **linear_to_srgb** **(** **)** |const| +:ref:`Color` **linear_to_srgb**\ (\ ) |const| Returns the color converted to the `sRGB `__ color space. This method assumes the original color is in the linear color space. See also :ref:`srgb_to_linear` which performs the opposite operation. @@ -2021,7 +2021,7 @@ Returns the color converted to the `sRGB `__ .. rst-class:: classref-method -:ref:`Color` **srgb_to_linear** **(** **)** |const| +:ref:`Color` **srgb_to_linear**\ (\ ) |const| Returns the color converted to the linear color space. This method assumes the original color already is in the sRGB color space. See also :ref:`linear_to_srgb` which performs the opposite operation. @@ -2033,7 +2033,7 @@ Returns the color converted to the linear color space. This method assumes the o .. rst-class:: classref-method -:ref:`int` **to_abgr32** **(** **)** |const| +:ref:`int` **to_abgr32**\ (\ ) |const| Returns the color converted to a 32-bit integer in ABGR format (each component is 8 bits). ABGR is the reversed version of the default RGBA format. @@ -2060,7 +2060,7 @@ Returns the color converted to a 32-bit integer in ABGR format (each component i .. rst-class:: classref-method -:ref:`int` **to_abgr64** **(** **)** |const| +:ref:`int` **to_abgr64**\ (\ ) |const| Returns the color converted to a 64-bit integer in ABGR format (each component is 16 bits). ABGR is the reversed version of the default RGBA format. @@ -2087,7 +2087,7 @@ Returns the color converted to a 64-bit integer in ABGR format (each component i .. rst-class:: classref-method -:ref:`int` **to_argb32** **(** **)** |const| +:ref:`int` **to_argb32**\ (\ ) |const| Returns the color converted to a 32-bit integer in ARGB format (each component is 8 bits). ARGB is more compatible with DirectX. @@ -2114,7 +2114,7 @@ Returns the color converted to a 32-bit integer in ARGB format (each component i .. rst-class:: classref-method -:ref:`int` **to_argb64** **(** **)** |const| +:ref:`int` **to_argb64**\ (\ ) |const| Returns the color converted to a 64-bit integer in ARGB format (each component is 16 bits). ARGB is more compatible with DirectX. @@ -2141,7 +2141,7 @@ Returns the color converted to a 64-bit integer in ARGB format (each component i .. rst-class:: classref-method -:ref:`String` **to_html** **(** :ref:`bool` with_alpha=true **)** |const| +:ref:`String` **to_html**\ (\ with_alpha\: :ref:`bool` = true\ ) |const| Returns the color converted to an HTML hexadecimal color :ref:`String` in RGBA format, without the hash (``#``) prefix. @@ -2172,7 +2172,7 @@ Setting ``with_alpha`` to ``false``, excludes alpha from the hexadecimal string, .. rst-class:: classref-method -:ref:`int` **to_rgba32** **(** **)** |const| +:ref:`int` **to_rgba32**\ (\ ) |const| Returns the color converted to a 32-bit integer in RGBA format (each component is 8 bits). RGBA is Godot's default format. @@ -2199,7 +2199,7 @@ Returns the color converted to a 32-bit integer in RGBA format (each component i .. rst-class:: classref-method -:ref:`int` **to_rgba64** **(** **)** |const| +:ref:`int` **to_rgba64**\ (\ ) |const| Returns the color converted to a 64-bit integer in RGBA format (each component is 16 bits). RGBA is Godot's default format. @@ -2231,7 +2231,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Color` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Color`\ ) Returns ``true`` if the colors are not exactly equal. @@ -2245,7 +2245,7 @@ Returns ``true`` if the colors are not exactly equal. .. rst-class:: classref-operator -:ref:`Color` **operator *** **(** :ref:`Color` right **)** +:ref:`Color` **operator ***\ (\ right\: :ref:`Color`\ ) Multiplies each component of the **Color** by the components of the given **Color**. @@ -2257,7 +2257,7 @@ Multiplies each component of the **Color** by the components of the given **Colo .. rst-class:: classref-operator -:ref:`Color` **operator *** **(** :ref:`float` right **)** +:ref:`Color` **operator ***\ (\ right\: :ref:`float`\ ) Multiplies each component of the **Color** by the given :ref:`float`. @@ -2269,7 +2269,7 @@ Multiplies each component of the **Color** by the given :ref:`float .. rst-class:: classref-operator -:ref:`Color` **operator *** **(** :ref:`int` right **)** +:ref:`Color` **operator ***\ (\ right\: :ref:`int`\ ) Multiplies each component of the **Color** by the given :ref:`int`. @@ -2281,7 +2281,7 @@ Multiplies each component of the **Color** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`Color` **operator +** **(** :ref:`Color` right **)** +:ref:`Color` **operator +**\ (\ right\: :ref:`Color`\ ) Adds each component of the **Color** with the components of the given **Color**. @@ -2293,7 +2293,7 @@ Adds each component of the **Color** with the components of the given **Color**. .. rst-class:: classref-operator -:ref:`Color` **operator -** **(** :ref:`Color` right **)** +:ref:`Color` **operator -**\ (\ right\: :ref:`Color`\ ) Subtracts each component of the **Color** by the components of the given **Color**. @@ -2305,7 +2305,7 @@ Subtracts each component of the **Color** by the components of the given **Color .. rst-class:: classref-operator -:ref:`Color` **operator /** **(** :ref:`Color` right **)** +:ref:`Color` **operator /**\ (\ right\: :ref:`Color`\ ) Divides each component of the **Color** by the components of the given **Color**. @@ -2317,7 +2317,7 @@ Divides each component of the **Color** by the components of the given **Color** .. rst-class:: classref-operator -:ref:`Color` **operator /** **(** :ref:`float` right **)** +:ref:`Color` **operator /**\ (\ right\: :ref:`float`\ ) Divides each component of the **Color** by the given :ref:`float`. @@ -2329,7 +2329,7 @@ Divides each component of the **Color** by the given :ref:`float`. .. rst-class:: classref-operator -:ref:`Color` **operator /** **(** :ref:`int` right **)** +:ref:`Color` **operator /**\ (\ right\: :ref:`int`\ ) Divides each component of the **Color** by the given :ref:`int`. @@ -2341,7 +2341,7 @@ Divides each component of the **Color** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`Color` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Color`\ ) Returns ``true`` if the colors are exactly equal. @@ -2355,7 +2355,7 @@ Returns ``true`` if the colors are exactly equal. .. rst-class:: classref-operator -:ref:`float` **operator []** **(** :ref:`int` index **)** +:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) Access color components using their index. ``[0]`` is equivalent to :ref:`r`, ``[1]`` is equivalent to :ref:`g`, ``[2]`` is equivalent to :ref:`b`, and ``[3]`` is equivalent to :ref:`a`. @@ -2367,7 +2367,7 @@ Access color components using their index. ``[0]`` is equivalent to :ref:`r` **operator unary+** **(** **)** +:ref:`Color` **operator unary+**\ (\ ) Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -2379,7 +2379,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`Color` **operator unary-** **(** **)** +:ref:`Color` **operator unary-**\ (\ ) Inverts the given color. This is equivalent to ``Color.WHITE - c`` or ``Color(1 - c.r, 1 - c.g, 1 - c.b, 1 - c.a)``. Unlike with :ref:`inverted`, the :ref:`a` component is inverted, too. @@ -2390,3 +2390,4 @@ Inverts the given color. This is equivalent to ``Color.WHITE - c`` or ``Color(1 .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 8cd48f4ff44..d7212ec9eaf 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -70,19 +70,19 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_preset` **(** :ref:`Color` color **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_recent_preset` **(** :ref:`Color` color **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`erase_preset` **(** :ref:`Color` color **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`erase_recent_preset` **(** :ref:`Color` color **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedColorArray` | :ref:`get_presets` **(** **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedColorArray` | :ref:`get_recent_presets` **(** **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_preset`\ (\ color\: :ref:`Color`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_recent_preset`\ (\ color\: :ref:`Color`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`erase_preset`\ (\ color\: :ref:`Color`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`erase_recent_preset`\ (\ color\: :ref:`Color`\ ) | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedColorArray` | :ref:`get_presets`\ (\ ) |const| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedColorArray` | :ref:`get_recent_presets`\ (\ ) |const| | + +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -147,7 +147,7 @@ Signals .. rst-class:: classref-signal -**color_changed** **(** :ref:`Color` color **)** +**color_changed**\ (\ color\: :ref:`Color`\ ) Emitted when the color is changed. @@ -159,7 +159,7 @@ Emitted when the color is changed. .. rst-class:: classref-signal -**preset_added** **(** :ref:`Color` color **)** +**preset_added**\ (\ color\: :ref:`Color`\ ) Emitted when a preset is added. @@ -171,7 +171,7 @@ Emitted when a preset is added. .. rst-class:: classref-signal -**preset_removed** **(** :ref:`Color` color **)** +**preset_removed**\ (\ color\: :ref:`Color`\ ) Emitted when a preset is removed. @@ -293,8 +293,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_can_add_swatches** **(** :ref:`bool` value **)** -- :ref:`bool` **are_swatches_enabled** **(** **)** +- |void| **set_can_add_swatches**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **are_swatches_enabled**\ (\ ) If ``true``, it's possible to add presets under Swatches. If ``false``, the button to add presets is disabled. @@ -310,8 +310,8 @@ If ``true``, it's possible to add presets under Swatches. If ``false``, the butt .. rst-class:: classref-property-setget -- void **set_pick_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_pick_color** **(** **)** +- |void| **set_pick_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_pick_color**\ (\ ) The currently selected color. @@ -327,8 +327,8 @@ The currently selected color. .. rst-class:: classref-property-setget -- void **set_color_mode** **(** :ref:`ColorModeType` value **)** -- :ref:`ColorModeType` **get_color_mode** **(** **)** +- |void| **set_color_mode**\ (\ value\: :ref:`ColorModeType`\ ) +- :ref:`ColorModeType` **get_color_mode**\ (\ ) The currently selected color mode. See :ref:`ColorModeType`. @@ -344,8 +344,8 @@ The currently selected color mode. See :ref:`ColorModeType` value **)** -- :ref:`bool` **are_modes_visible** **(** **)** +- |void| **set_modes_visible**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **are_modes_visible**\ (\ ) If ``true``, the color mode buttons are visible. @@ -361,8 +361,8 @@ If ``true``, the color mode buttons are visible. .. rst-class:: classref-property-setget -- void **set_deferred_mode** **(** :ref:`bool` value **)** -- :ref:`bool` **is_deferred_mode** **(** **)** +- |void| **set_deferred_mode**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_deferred_mode**\ (\ ) If ``true``, the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues). @@ -378,8 +378,8 @@ If ``true``, the color will apply only after the user releases the mouse button, .. rst-class:: classref-property-setget -- void **set_edit_alpha** **(** :ref:`bool` value **)** -- :ref:`bool` **is_editing_alpha** **(** **)** +- |void| **set_edit_alpha**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_editing_alpha**\ (\ ) If ``true``, shows an alpha channel slider (opacity). @@ -395,8 +395,8 @@ If ``true``, shows an alpha channel slider (opacity). .. rst-class:: classref-property-setget -- void **set_hex_visible** **(** :ref:`bool` value **)** -- :ref:`bool` **is_hex_visible** **(** **)** +- |void| **set_hex_visible**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_hex_visible**\ (\ ) If ``true``, the hex color code input field is visible. @@ -412,8 +412,8 @@ If ``true``, the hex color code input field is visible. .. rst-class:: classref-property-setget -- void **set_picker_shape** **(** :ref:`PickerShapeType` value **)** -- :ref:`PickerShapeType` **get_picker_shape** **(** **)** +- |void| **set_picker_shape**\ (\ value\: :ref:`PickerShapeType`\ ) +- :ref:`PickerShapeType` **get_picker_shape**\ (\ ) The shape of the color space view. See :ref:`PickerShapeType`. @@ -429,8 +429,8 @@ The shape of the color space view. See :ref:`PickerShapeType` value **)** -- :ref:`bool` **are_presets_visible** **(** **)** +- |void| **set_presets_visible**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **are_presets_visible**\ (\ ) If ``true``, the Swatches and Recent Colors presets are visible. @@ -446,8 +446,8 @@ If ``true``, the Swatches and Recent Colors presets are visible. .. rst-class:: classref-property-setget -- void **set_sampler_visible** **(** :ref:`bool` value **)** -- :ref:`bool` **is_sampler_visible** **(** **)** +- |void| **set_sampler_visible**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_sampler_visible**\ (\ ) If ``true``, the color sampler and color preview are visible. @@ -463,8 +463,8 @@ If ``true``, the color sampler and color preview are visible. .. rst-class:: classref-property-setget -- void **set_sliders_visible** **(** :ref:`bool` value **)** -- :ref:`bool` **are_sliders_visible** **(** **)** +- |void| **set_sliders_visible**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **are_sliders_visible**\ (\ ) If ``true``, the color sliders are visible. @@ -481,7 +481,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_preset** **(** :ref:`Color` color **)** +|void| **add_preset**\ (\ color\: :ref:`Color`\ ) Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. @@ -495,7 +495,7 @@ Adds the given color to a list of color presets. The presets are displayed in th .. rst-class:: classref-method -void **add_recent_preset** **(** :ref:`Color` color **)** +|void| **add_recent_preset**\ (\ color\: :ref:`Color`\ ) Adds the given color to a list of color recent presets so that it can be picked later. Recent presets are the colors that were picked recently, a new preset is automatically created and added to recent presets when you pick a new color. @@ -509,7 +509,7 @@ Adds the given color to a list of color recent presets so that it can be picked .. rst-class:: classref-method -void **erase_preset** **(** :ref:`Color` color **)** +|void| **erase_preset**\ (\ color\: :ref:`Color`\ ) Removes the given color from the list of color presets of this color picker. @@ -521,7 +521,7 @@ Removes the given color from the list of color presets of this color picker. .. rst-class:: classref-method -void **erase_recent_preset** **(** :ref:`Color` color **)** +|void| **erase_recent_preset**\ (\ color\: :ref:`Color`\ ) Removes the given color from the list of color recent presets of this color picker. @@ -533,7 +533,7 @@ Removes the given color from the list of color recent presets of this color pick .. rst-class:: classref-method -:ref:`PackedColorArray` **get_presets** **(** **)** |const| +:ref:`PackedColorArray` **get_presets**\ (\ ) |const| Returns the list of colors in the presets of the color picker. @@ -545,7 +545,7 @@ Returns the list of colors in the presets of the color picker. .. rst-class:: classref-method -:ref:`PackedColorArray` **get_recent_presets** **(** **)** |const| +:ref:`PackedColorArray` **get_recent_presets**\ (\ ) |const| Returns the list of colors in the recent presets of the color picker. @@ -801,3 +801,4 @@ The icon for rectangular wheel picker shapes. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index 08ef4700487..4d83b4323e4 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -58,11 +58,11 @@ Methods .. table:: :widths: auto - +---------------------------------------+--------------------------------------------------------------------------+ - | :ref:`ColorPicker` | :ref:`get_picker` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------+ - | :ref:`PopupPanel` | :ref:`get_popup` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------+ + +---------------------------------------+--------------------------------------------------------------------+ + | :ref:`ColorPicker` | :ref:`get_picker`\ (\ ) | + +---------------------------------------+--------------------------------------------------------------------+ + | :ref:`PopupPanel` | :ref:`get_popup`\ (\ ) | + +---------------------------------------+--------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -89,7 +89,7 @@ Signals .. rst-class:: classref-signal -**color_changed** **(** :ref:`Color` color **)** +**color_changed**\ (\ color\: :ref:`Color`\ ) Emitted when the color changes. @@ -101,7 +101,7 @@ Emitted when the color changes. .. rst-class:: classref-signal -**picker_created** **(** **)** +**picker_created**\ (\ ) Emitted when the :ref:`ColorPicker` is created (the button is pressed for the first time). @@ -113,7 +113,7 @@ Emitted when the :ref:`ColorPicker` is created (the button is .. rst-class:: classref-signal -**popup_closed** **(** **)** +**popup_closed**\ (\ ) Emitted when the :ref:`ColorPicker` is closed. @@ -134,8 +134,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_pick_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_pick_color** **(** **)** +- |void| **set_pick_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_pick_color**\ (\ ) The currently selected color. @@ -151,8 +151,8 @@ The currently selected color. .. rst-class:: classref-property-setget -- void **set_edit_alpha** **(** :ref:`bool` value **)** -- :ref:`bool` **is_editing_alpha** **(** **)** +- |void| **set_edit_alpha**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_editing_alpha**\ (\ ) If ``true``, the alpha channel in the displayed :ref:`ColorPicker` will be visible. @@ -169,7 +169,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`ColorPicker` **get_picker** **(** **)** +:ref:`ColorPicker` **get_picker**\ (\ ) Returns the :ref:`ColorPicker` that this node toggles. @@ -183,7 +183,7 @@ Returns the :ref:`ColorPicker` that this node toggles. .. rst-class:: classref-method -:ref:`PopupPanel` **get_popup** **(** **)** +:ref:`PopupPanel` **get_popup**\ (\ ) Returns the control's :ref:`PopupPanel` which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden. @@ -213,3 +213,4 @@ The background of the color preview rect on the button. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_colorrect.rst b/classes/class_colorrect.rst index 6a29a32142d..b88adb12d76 100644 --- a/classes/class_colorrect.rst +++ b/classes/class_colorrect.rst @@ -57,8 +57,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_color** **(** **)** +- |void| **set_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_color**\ (\ ) The fill color of the rectangle. @@ -69,3 +69,4 @@ The fill color of the rectangle. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_compositor.rst b/classes/class_compositor.rst new file mode 100644 index 00000000000..04400068c81 --- /dev/null +++ b/classes/class_compositor.rst @@ -0,0 +1,67 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Compositor.xml. + +.. _class_Compositor: + +Compositor +========== + +**Experimental:** More customisation of the rendering pipeline will be added in the future. + +**Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +The compositor resource holds the configuration with which rendering of a viewport can be customised. + +.. rst-class:: classref-introduction-group + +Description +----------- + +The compositor resource holds the configuration with which rendering of a viewport can be customised. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------+ + | :ref:`Array`\[:ref:`CompositorEffect`\] | :ref:`compositor_effects` | ``[]`` | + +------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_Compositor_property_compositor_effects: + +.. rst-class:: classref-property + +:ref:`Array`\[:ref:`CompositorEffect`\] **compositor_effects** = ``[]`` + +.. rst-class:: classref-property-setget + +- |void| **set_compositor_effects**\ (\ value\: :ref:`Array`\[:ref:`CompositorEffect`\]\ ) +- :ref:`Array`\[:ref:`CompositorEffect`\] **get_compositor_effects**\ (\ ) + +The custom :ref:`CompositorEffect`\ s that are applied during rendering of viewports using this compositor. + +.. |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.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_compositoreffect.rst b/classes/class_compositoreffect.rst new file mode 100644 index 00000000000..bbc7dbf0b5f --- /dev/null +++ b/classes/class_compositoreffect.rst @@ -0,0 +1,301 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CompositorEffect.xml. + +.. _class_CompositorEffect: + +CompositorEffect +================ + +**Experimental:** The implementation may change as more of the rendering internals are exposed over time. + +**Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +This resource allows for creating a custom rendering effect. + +.. rst-class:: classref-introduction-group + +Description +----------- + +This resource defines a custom rendering effect that can be applied to :ref:`Viewport`\ s through the viewports' :ref:`Environment`. You can implement a callback that is called during rendering at a given stage of the rendering pipeline and allows you to insert additional passes. Note that this callback happens on the rendering thread. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`access_resolved_color` | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`access_resolved_depth` | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ + | :ref:`EffectCallbackType` | :ref:`effect_callback_type` | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`enabled` | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`needs_motion_vectors` | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`needs_normal_roughness` | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`needs_separate_specular` | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_render_callback`\ (\ effect_callback_type\: :ref:`int`, render_data\: :ref:`RenderData`\ ) |virtual| | + +--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Enumerations +------------ + +.. _enum_CompositorEffect_EffectCallbackType: + +.. rst-class:: classref-enumeration + +enum **EffectCallbackType**: + +.. _class_CompositorEffect_constant_EFFECT_CALLBACK_TYPE_PRE_OPAQUE: + +.. rst-class:: classref-enumeration-constant + +:ref:`EffectCallbackType` **EFFECT_CALLBACK_TYPE_PRE_OPAQUE** = ``0`` + +The callback is called before our opaque rendering pass, but after depth prepass (if applicable). + +.. _class_CompositorEffect_constant_EFFECT_CALLBACK_TYPE_POST_OPAQUE: + +.. rst-class:: classref-enumeration-constant + +:ref:`EffectCallbackType` **EFFECT_CALLBACK_TYPE_POST_OPAQUE** = ``1`` + +The callback is called after our opaque rendering pass, but before our sky is rendered. + +.. _class_CompositorEffect_constant_EFFECT_CALLBACK_TYPE_POST_SKY: + +.. rst-class:: classref-enumeration-constant + +:ref:`EffectCallbackType` **EFFECT_CALLBACK_TYPE_POST_SKY** = ``2`` + +The callback is called after our sky is rendered, but before our back buffers are created (and if enabled, before subsurface scattering and/or screen space reflections). + +.. _class_CompositorEffect_constant_EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT: + +.. rst-class:: classref-enumeration-constant + +:ref:`EffectCallbackType` **EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT** = ``3`` + +The callback is called before our transparent rendering pass, but after our sky is rendered and we've created our back buffers. + +.. _class_CompositorEffect_constant_EFFECT_CALLBACK_TYPE_POST_TRANSPARENT: + +.. rst-class:: classref-enumeration-constant + +:ref:`EffectCallbackType` **EFFECT_CALLBACK_TYPE_POST_TRANSPARENT** = ``4`` + +The callback is called after our transparent rendering pass, but before any build in post effects and output to our render target. + +.. _class_CompositorEffect_constant_EFFECT_CALLBACK_TYPE_MAX: + +.. rst-class:: classref-enumeration-constant + +:ref:`EffectCallbackType` **EFFECT_CALLBACK_TYPE_MAX** = ``5`` + +Represents the size of the :ref:`EffectCallbackType` enum. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_CompositorEffect_property_access_resolved_color: + +.. rst-class:: classref-property + +:ref:`bool` **access_resolved_color** + +.. rst-class:: classref-property-setget + +- |void| **set_access_resolved_color**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_access_resolved_color**\ (\ ) + +If ``true`` and MSAA is enabled, this will trigger a color buffer resolve before the effect is run. + +\ **Note:** In :ref:`_render_callback`, to access the resolved buffer use: + +:: + + var render_scene_buffers : RenderSceneBuffersRD = render_data.get_render_scene_buffers() + var color_buffer = render_scene_buffers.get_texture("render_buffers", "color") + +.. rst-class:: classref-item-separator + +---- + +.. _class_CompositorEffect_property_access_resolved_depth: + +.. rst-class:: classref-property + +:ref:`bool` **access_resolved_depth** + +.. rst-class:: classref-property-setget + +- |void| **set_access_resolved_depth**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_access_resolved_depth**\ (\ ) + +If ``true`` and MSAA is enabled, this will trigger a depth buffer resolve before the effect is run. + +\ **Note:** In :ref:`_render_callback`, to access the resolved buffer use: + +:: + + var render_scene_buffers : RenderSceneBuffersRD = render_data.get_render_scene_buffers() + var depth_buffer = render_scene_buffers.get_texture("render_buffers", "depth") + +.. rst-class:: classref-item-separator + +---- + +.. _class_CompositorEffect_property_effect_callback_type: + +.. rst-class:: classref-property + +:ref:`EffectCallbackType` **effect_callback_type** + +.. rst-class:: classref-property-setget + +- |void| **set_effect_callback_type**\ (\ value\: :ref:`EffectCallbackType`\ ) +- :ref:`EffectCallbackType` **get_effect_callback_type**\ (\ ) + +The type of effect that is implemented, determines at what stage of rendering the callback is called. + +.. rst-class:: classref-item-separator + +---- + +.. _class_CompositorEffect_property_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **enabled** + +.. rst-class:: classref-property-setget + +- |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_enabled**\ (\ ) + +If ``true`` this rendering effect is applied to any viewport it is added to. + +.. rst-class:: classref-item-separator + +---- + +.. _class_CompositorEffect_property_needs_motion_vectors: + +.. rst-class:: classref-property + +:ref:`bool` **needs_motion_vectors** + +.. rst-class:: classref-property-setget + +- |void| **set_needs_motion_vectors**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_needs_motion_vectors**\ (\ ) + +If ``true`` this triggers motion vectors being calculated during the opaque render state. + +\ **Note:** In :ref:`_render_callback`, to access the motion vector buffer use: + +:: + + var render_scene_buffers : RenderSceneBuffersRD = render_data.get_render_scene_buffers() + var motion_buffer = render_scene_buffers.get_velocity_texture() + +.. rst-class:: classref-item-separator + +---- + +.. _class_CompositorEffect_property_needs_normal_roughness: + +.. rst-class:: classref-property + +:ref:`bool` **needs_normal_roughness** + +.. rst-class:: classref-property-setget + +- |void| **set_needs_normal_roughness**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_needs_normal_roughness**\ (\ ) + +If ``true`` this triggers normal and roughness data to be output during our depth pre-pass, only applicable for the Forward+ renderer. + +\ **Note:** In :ref:`_render_callback`, to access the roughness buffer use: + +:: + + var render_scene_buffers : RenderSceneBuffersRD = render_data.get_render_scene_buffers() + var roughness_buffer = render_scene_buffers.get_texture("forward_clustered", "normal_roughness") + +.. rst-class:: classref-item-separator + +---- + +.. _class_CompositorEffect_property_needs_separate_specular: + +.. rst-class:: classref-property + +:ref:`bool` **needs_separate_specular** + +.. rst-class:: classref-property-setget + +- |void| **set_needs_separate_specular**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_needs_separate_specular**\ (\ ) + +If ``true`` this triggers specular data being rendered to a separate buffer and combined after effects have been applied, only applicable for the Forward+ renderer. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_CompositorEffect_private_method__render_callback: + +.. rst-class:: classref-method + +|void| **_render_callback**\ (\ effect_callback_type\: :ref:`int`, render_data\: :ref:`RenderData`\ ) |virtual| + +Implement this function with your custom rendering code. ``effect_callback_type`` should always match the effect callback type you've specified in :ref:`effect_callback_type`. ``render_data`` provides access to the rendering state, it is only valid during rendering and should not be stored. + +.. |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.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_compressedcubemap.rst b/classes/class_compressedcubemap.rst index ad7a5e358d9..8efe7d06a25 100644 --- a/classes/class_compressedcubemap.rst +++ b/classes/class_compressedcubemap.rst @@ -44,3 +44,4 @@ See :ref:`Cubemap` for a general description of cubemaps. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_compressedcubemaparray.rst b/classes/class_compressedcubemaparray.rst index b3cf5e83510..71b3fd5fce6 100644 --- a/classes/class_compressedcubemaparray.rst +++ b/classes/class_compressedcubemaparray.rst @@ -44,3 +44,4 @@ See :ref:`CubemapArray` for a general description of cubemap .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_compressedtexture2d.rst b/classes/class_compressedtexture2d.rst index 313b2f53edf..d9ffa1cf611 100644 --- a/classes/class_compressedtexture2d.rst +++ b/classes/class_compressedtexture2d.rst @@ -57,9 +57,9 @@ Methods .. table:: :widths: auto - +---------------------------------------+-------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------+ + +---------------------------------------+----------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -78,8 +78,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- :ref:`Error` **load** **(** :ref:`String` path **)** -- :ref:`String` **get_load_path** **(** **)** +- :ref:`Error` **load**\ (\ path\: :ref:`String`\ ) +- :ref:`String` **get_load_path**\ (\ ) The **CompressedTexture2D**'s file path to a ``.ctex`` file. @@ -96,7 +96,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **load** **(** :ref:`String` path **)** +:ref:`Error` **load**\ (\ path\: :ref:`String`\ ) Loads the texture from the specified ``path``. @@ -107,3 +107,4 @@ Loads the texture from the specified ``path``. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_compressedtexture2darray.rst b/classes/class_compressedtexture2darray.rst index 53ce44df3da..7ea9a4de684 100644 --- a/classes/class_compressedtexture2darray.rst +++ b/classes/class_compressedtexture2darray.rst @@ -44,3 +44,4 @@ See :ref:`Texture2DArray` for a general description of tex .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_compressedtexture3d.rst b/classes/class_compressedtexture3d.rst index 4a24f97fc97..b88c5a1bb3c 100644 --- a/classes/class_compressedtexture3d.rst +++ b/classes/class_compressedtexture3d.rst @@ -45,9 +45,9 @@ Methods .. table:: :widths: auto - +---------------------------------------+-------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------+ + +---------------------------------------+----------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -66,8 +66,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- :ref:`Error` **load** **(** :ref:`String` path **)** -- :ref:`String` **get_load_path** **(** **)** +- :ref:`Error` **load**\ (\ path\: :ref:`String`\ ) +- :ref:`String` **get_load_path**\ (\ ) The **CompressedTexture3D**'s file path to a ``.ctex3d`` file. @@ -84,7 +84,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **load** **(** :ref:`String` path **)** +:ref:`Error` **load**\ (\ path\: :ref:`String`\ ) Loads the texture from the specified ``path``. @@ -95,3 +95,4 @@ Loads the texture from the specified ``path``. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_compressedtexturelayered.rst b/classes/class_compressedtexturelayered.rst index df135518397..f14ef46aeee 100644 --- a/classes/class_compressedtexturelayered.rst +++ b/classes/class_compressedtexturelayered.rst @@ -43,9 +43,9 @@ Methods .. table:: :widths: auto - +---------------------------------------+------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------+ + +---------------------------------------+---------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -64,8 +64,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- :ref:`Error` **load** **(** :ref:`String` path **)** -- :ref:`String` **get_load_path** **(** **)** +- :ref:`Error` **load**\ (\ path\: :ref:`String`\ ) +- :ref:`String` **get_load_path**\ (\ ) The path the texture should be loaded from. @@ -82,7 +82,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **load** **(** :ref:`String` path **)** +:ref:`Error` **load**\ (\ path\: :ref:`String`\ ) Loads the texture at ``path``. @@ -93,3 +93,4 @@ Loads the texture at ``path``. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index 83b4a241d7c..e97183b52a1 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -58,8 +58,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_segments** **(** :ref:`PackedVector2Array` value **)** -- :ref:`PackedVector2Array` **get_segments** **(** **)** +- |void| **set_segments**\ (\ value\: :ref:`PackedVector2Array`\ ) +- :ref:`PackedVector2Array` **get_segments**\ (\ ) The array of points that make up the **ConcavePolygonShape2D**'s line segments. The array (of length divisible by two) is naturally divided into pairs (one pair for each segment); each pair consists of the starting point of a segment and the endpoint of a segment. @@ -70,3 +70,4 @@ The array of points that make up the **ConcavePolygonShape2D**'s line segments. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_concavepolygonshape3d.rst b/classes/class_concavepolygonshape3d.rst index 268074f54fa..898385d056d 100644 --- a/classes/class_concavepolygonshape3d.rst +++ b/classes/class_concavepolygonshape3d.rst @@ -56,11 +56,11 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`get_faces` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_faces` **(** :ref:`PackedVector3Array` faces **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`get_faces`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_faces`\ (\ faces\: :ref:`PackedVector3Array`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -79,8 +79,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_backface_collision_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_backface_collision_enabled** **(** **)** +- |void| **set_backface_collision_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_backface_collision_enabled**\ (\ ) If set to ``true``, collisions occur on both sides of the concave shape faces. Otherwise they occur only along the face normals. @@ -97,7 +97,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedVector3Array` **get_faces** **(** **)** |const| +:ref:`PackedVector3Array` **get_faces**\ (\ ) |const| Returns the faces of the trimesh shape as an array of vertices. The array (of length divisible by three) is naturally divided into triples; each triple of vertices defines a triangle. @@ -109,7 +109,7 @@ Returns the faces of the trimesh shape as an array of vertices. The array (of le .. rst-class:: classref-method -void **set_faces** **(** :ref:`PackedVector3Array` faces **)** +|void| **set_faces**\ (\ faces\: :ref:`PackedVector3Array`\ ) Sets the faces of the trimesh shape from an array of vertices. The ``faces`` array should be composed of triples such that each triple of vertices defines a triangle. @@ -120,3 +120,4 @@ Sets the faces of the trimesh shape from an array of vertices. The ``faces`` arr .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_conetwistjoint3d.rst b/classes/class_conetwistjoint3d.rst index 11c9de63300..079ca1eb9b3 100644 --- a/classes/class_conetwistjoint3d.rst +++ b/classes/class_conetwistjoint3d.rst @@ -49,11 +49,11 @@ Methods .. table:: :widths: auto - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_param` **(** :ref:`Param` param **)** |const| | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_param` **(** :ref:`Param` param, :ref:`float` value **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_param`\ (\ param\: :ref:`Param`\ ) |const| | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_param`\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -145,8 +145,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The speed with which the swing or twist will take place. @@ -164,8 +164,8 @@ The higher, the faster. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| Defines, how fast the swing- and twist-speed-difference on both sides gets synced. @@ -181,8 +181,8 @@ Defines, how fast the swing- and twist-speed-difference on both sides gets synce .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint. @@ -198,8 +198,8 @@ The ease with which the joint starts to twist. If it's too low, it takes more fo .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| Swing is rotation from side to side, around the axis perpendicular to the twist axis. @@ -221,8 +221,8 @@ If below 0.05, this behavior is locked. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| Twist is the rotation around the twist axis, this value defined how far the joint can twist. @@ -241,7 +241,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +:ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| Returns the value of the specified parameter. @@ -253,7 +253,7 @@ Returns the value of the specified parameter. .. rst-class:: classref-method -void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** +|void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) Sets the value of the specified parameter. @@ -264,3 +264,4 @@ Sets the value of the specified parameter. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index a7c6ac56ebb..212f0415dbe 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -130,41 +130,41 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`encode_to_text` **(** **)** |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`erase_section` **(** :ref:`String` section **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`erase_section_key` **(** :ref:`String` section, :ref:`String` key **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_section_keys` **(** :ref:`String` section **)** |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_sections` **(** **)** |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_section` **(** :ref:`String` section **)** |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_section_key` **(** :ref:`String` section, :ref:`String` key **)** |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load_encrypted` **(** :ref:`String` path, :ref:`PackedByteArray` key **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load_encrypted_pass` **(** :ref:`String` path, :ref:`String` password **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`parse` **(** :ref:`String` data **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save` **(** :ref:`String` path **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save_encrypted` **(** :ref:`String` path, :ref:`PackedByteArray` key **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save_encrypted_pass` **(** :ref:`String` path, :ref:`String` password **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`encode_to_text`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`erase_section`\ (\ section\: :ref:`String`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`erase_section_key`\ (\ section\: :ref:`String`, key\: :ref:`String`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_section_keys`\ (\ section\: :ref:`String`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_sections`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_value`\ (\ section\: :ref:`String`, key\: :ref:`String`, default\: :ref:`Variant` = null\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_section`\ (\ section\: :ref:`String`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_section_key`\ (\ section\: :ref:`String`, key\: :ref:`String`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_encrypted`\ (\ path\: :ref:`String`, key\: :ref:`PackedByteArray`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_encrypted_pass`\ (\ path\: :ref:`String`, password\: :ref:`String`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`parse`\ (\ data\: :ref:`String`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save_encrypted`\ (\ path\: :ref:`String`, key\: :ref:`PackedByteArray`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save_encrypted_pass`\ (\ path\: :ref:`String`, password\: :ref:`String`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_value`\ (\ section\: :ref:`String`, key\: :ref:`String`, value\: :ref:`Variant`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -179,7 +179,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Removes the entire contents of the config. @@ -191,7 +191,7 @@ Removes the entire contents of the config. .. rst-class:: classref-method -:ref:`String` **encode_to_text** **(** **)** |const| +:ref:`String` **encode_to_text**\ (\ ) |const| Obtain the text version of this config file (the same text that would be written to a file). @@ -203,7 +203,7 @@ Obtain the text version of this config file (the same text that would be written .. rst-class:: classref-method -void **erase_section** **(** :ref:`String` section **)** +|void| **erase_section**\ (\ section\: :ref:`String`\ ) Deletes the specified section along with all the key-value pairs inside. Raises an error if the section does not exist. @@ -215,7 +215,7 @@ Deletes the specified section along with all the key-value pairs inside. Raises .. rst-class:: classref-method -void **erase_section_key** **(** :ref:`String` section, :ref:`String` key **)** +|void| **erase_section_key**\ (\ section\: :ref:`String`, key\: :ref:`String`\ ) Deletes the specified key in a section. Raises an error if either the section or the key do not exist. @@ -227,7 +227,7 @@ Deletes the specified key in a section. Raises an error if either the section or .. rst-class:: classref-method -:ref:`PackedStringArray` **get_section_keys** **(** :ref:`String` section **)** |const| +:ref:`PackedStringArray` **get_section_keys**\ (\ section\: :ref:`String`\ ) |const| Returns an array of all defined key identifiers in the specified section. Raises an error and returns an empty array if the section does not exist. @@ -239,7 +239,7 @@ Returns an array of all defined key identifiers in the specified section. Raises .. rst-class:: classref-method -:ref:`PackedStringArray` **get_sections** **(** **)** |const| +:ref:`PackedStringArray` **get_sections**\ (\ ) |const| Returns an array of all defined section identifiers. @@ -251,7 +251,7 @@ Returns an array of all defined section identifiers. .. rst-class:: classref-method -:ref:`Variant` **get_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** |const| +:ref:`Variant` **get_value**\ (\ section\: :ref:`String`, key\: :ref:`String`, default\: :ref:`Variant` = null\ ) |const| Returns the current value for the specified section and key. If either the section or the key do not exist, the method returns the fallback ``default`` value. If ``default`` is not specified or set to ``null``, an error is also raised. @@ -263,7 +263,7 @@ Returns the current value for the specified section and key. If either the secti .. rst-class:: classref-method -:ref:`bool` **has_section** **(** :ref:`String` section **)** |const| +:ref:`bool` **has_section**\ (\ section\: :ref:`String`\ ) |const| Returns ``true`` if the specified section exists. @@ -275,7 +275,7 @@ Returns ``true`` if the specified section exists. .. rst-class:: classref-method -:ref:`bool` **has_section_key** **(** :ref:`String` section, :ref:`String` key **)** |const| +:ref:`bool` **has_section_key**\ (\ section\: :ref:`String`, key\: :ref:`String`\ ) |const| Returns ``true`` if the specified section-key pair exists. @@ -287,7 +287,7 @@ Returns ``true`` if the specified section-key pair exists. .. rst-class:: classref-method -:ref:`Error` **load** **(** :ref:`String` path **)** +:ref:`Error` **load**\ (\ path\: :ref:`String`\ ) Loads the config file specified as a parameter. The file's contents are parsed and loaded in the **ConfigFile** object which the method was called on. @@ -301,7 +301,7 @@ Returns :ref:`@GlobalScope.OK` on success, or on .. rst-class:: classref-method -:ref:`Error` **load_encrypted** **(** :ref:`String` path, :ref:`PackedByteArray` key **)** +:ref:`Error` **load_encrypted**\ (\ path\: :ref:`String`, key\: :ref:`PackedByteArray`\ ) Loads the encrypted config file specified as a parameter, using the provided ``key`` to decrypt it. The file's contents are parsed and loaded in the **ConfigFile** object which the method was called on. @@ -315,7 +315,7 @@ Returns :ref:`@GlobalScope.OK` on success, or on .. rst-class:: classref-method -:ref:`Error` **load_encrypted_pass** **(** :ref:`String` path, :ref:`String` password **)** +:ref:`Error` **load_encrypted_pass**\ (\ path\: :ref:`String`, password\: :ref:`String`\ ) Loads the encrypted config file specified as a parameter, using the provided ``password`` to decrypt it. The file's contents are parsed and loaded in the **ConfigFile** object which the method was called on. @@ -329,7 +329,7 @@ Returns :ref:`@GlobalScope.OK` on success, or on .. rst-class:: classref-method -:ref:`Error` **parse** **(** :ref:`String` data **)** +:ref:`Error` **parse**\ (\ data\: :ref:`String`\ ) Parses the passed string as the contents of a config file. The string is parsed and loaded in the ConfigFile object which the method was called on. @@ -343,7 +343,7 @@ Returns :ref:`@GlobalScope.OK` on success, or on .. rst-class:: classref-method -:ref:`Error` **save** **(** :ref:`String` path **)** +:ref:`Error` **save**\ (\ path\: :ref:`String`\ ) Saves the contents of the **ConfigFile** object to the file specified as a parameter. The output file uses an INI-style structure. @@ -357,7 +357,7 @@ Returns :ref:`@GlobalScope.OK` on success, or on .. rst-class:: classref-method -:ref:`Error` **save_encrypted** **(** :ref:`String` path, :ref:`PackedByteArray` key **)** +:ref:`Error` **save_encrypted**\ (\ path\: :ref:`String`, key\: :ref:`PackedByteArray`\ ) Saves the contents of the **ConfigFile** object to the AES-256 encrypted file specified as a parameter, using the provided ``key`` to encrypt it. The output file uses an INI-style structure. @@ -371,7 +371,7 @@ Returns :ref:`@GlobalScope.OK` on success, or on .. rst-class:: classref-method -:ref:`Error` **save_encrypted_pass** **(** :ref:`String` path, :ref:`String` password **)** +:ref:`Error` **save_encrypted_pass**\ (\ path\: :ref:`String`, password\: :ref:`String`\ ) Saves the contents of the **ConfigFile** object to the AES-256 encrypted file specified as a parameter, using the provided ``password`` to encrypt it. The output file uses an INI-style structure. @@ -385,7 +385,7 @@ Returns :ref:`@GlobalScope.OK` on success, or on .. rst-class:: classref-method -void **set_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** +|void| **set_value**\ (\ section\: :ref:`String`, key\: :ref:`String`, value\: :ref:`Variant`\ ) Assigns a value to the specified key of the specified section. If either the section or the key do not exist, they are created. Passing a ``null`` value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed. @@ -396,3 +396,4 @@ Assigns a value to the specified key of the specified section. If either the sec .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index bf95b48927e..16e1c04761a 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -64,9 +64,9 @@ Methods .. table:: :widths: auto - +-----------------------------+-----------------------------------------------------------------------------------------+ - | :ref:`Button` | :ref:`get_cancel_button` **(** **)** | - +-----------------------------+-----------------------------------------------------------------------------------------+ + +-----------------------------+-----------------------------------------------------------------------------------+ + | :ref:`Button` | :ref:`get_cancel_button`\ (\ ) | + +-----------------------------+-----------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -85,8 +85,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_cancel_button_text** **(** :ref:`String` value **)** -- :ref:`String` **get_cancel_button_text** **(** **)** +- |void| **set_cancel_button_text**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_cancel_button_text**\ (\ ) The text displayed by the cancel button (see :ref:`get_cancel_button`). @@ -103,7 +103,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Button` **get_cancel_button** **(** **)** +:ref:`Button` **get_cancel_button**\ (\ ) Returns the cancel button. @@ -116,3 +116,4 @@ Returns the cancel button. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_container.rst b/classes/class_container.rst index 6411771ef09..f8ea36cad8b 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -50,15 +50,15 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_get_allowed_size_flags_horizontal` **(** **)** |virtual| |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_get_allowed_size_flags_vertical` **(** **)** |virtual| |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fit_child_in_rect` **(** :ref:`Control` child, :ref:`Rect2` rect **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`queue_sort` **(** **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_get_allowed_size_flags_horizontal`\ (\ ) |virtual| |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_get_allowed_size_flags_vertical`\ (\ ) |virtual| |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fit_child_in_rect`\ (\ child\: :ref:`Control`, rect\: :ref:`Rect2`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`queue_sort`\ (\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -73,7 +73,7 @@ Signals .. rst-class:: classref-signal -**pre_sort_children** **(** **)** +**pre_sort_children**\ (\ ) Emitted when children are going to be sorted. @@ -85,7 +85,7 @@ Emitted when children are going to be sorted. .. rst-class:: classref-signal -**sort_children** **(** **)** +**sort_children**\ (\ ) Emitted when sorting the children is needed. @@ -127,7 +127,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedInt32Array` **_get_allowed_size_flags_horizontal** **(** **)** |virtual| |const| +:ref:`PackedInt32Array` **_get_allowed_size_flags_horizontal**\ (\ ) |virtual| |const| Implement to return a list of allowed horizontal :ref:`SizeFlags` for child nodes. This doesn't technically prevent the usages of any other size flags, if your implementation requires that. This only limits the options available to the user in the Inspector dock. @@ -141,7 +141,7 @@ Implement to return a list of allowed horizontal :ref:`SizeFlags` **_get_allowed_size_flags_vertical** **(** **)** |virtual| |const| +:ref:`PackedInt32Array` **_get_allowed_size_flags_vertical**\ (\ ) |virtual| |const| Implement to return a list of allowed vertical :ref:`SizeFlags` for child nodes. This doesn't technically prevent the usages of any other size flags, if your implementation requires that. This only limits the options available to the user in the Inspector dock. @@ -155,7 +155,7 @@ Implement to return a list of allowed vertical :ref:`SizeFlags` child, :ref:`Rect2` rect **)** +|void| **fit_child_in_rect**\ (\ child\: :ref:`Control`, rect\: :ref:`Rect2`\ ) Fit a child control in a given rect. This is mainly a helper for creating custom container classes. @@ -167,7 +167,7 @@ Fit a child control in a given rect. This is mainly a helper for creating custom .. rst-class:: classref-method -void **queue_sort** **(** **)** +|void| **queue_sort**\ (\ ) Queue resort of the contained children. This is called automatically anyway, but can be called upon request. @@ -178,3 +178,4 @@ Queue resort of the contained children. This is called automatically anyway, but .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_control.rst b/classes/class_control.rst index b5419093db5..66c0ffb4d50 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -131,11 +131,11 @@ Properties +--------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`size` | ``Vector2(0, 0)`` | +--------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ - | |bitfield|\<:ref:`SizeFlags`\> | :ref:`size_flags_horizontal` | ``1`` | + | |bitfield|\[:ref:`SizeFlags`\] | :ref:`size_flags_horizontal` | ``1`` | +--------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ | :ref:`float` | :ref:`size_flags_stretch_ratio` | ``1.0`` | +--------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ - | |bitfield|\<:ref:`SizeFlags`\> | :ref:`size_flags_vertical` | ``1`` | + | |bitfield|\[:ref:`SizeFlags`\] | :ref:`size_flags_vertical` | ``1`` | +--------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ | :ref:`Theme` | :ref:`theme` | | +--------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ @@ -152,179 +152,179 @@ Methods .. table:: :widths: auto - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_can_drop_data` **(** :ref:`Vector2` at_position, :ref:`Variant` data **)** |virtual| |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_drop_data` **(** :ref:`Vector2` at_position, :ref:`Variant` data **)** |virtual| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_drag_data` **(** :ref:`Vector2` at_position **)** |virtual| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_minimum_size` **(** **)** |virtual| |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_tooltip` **(** :ref:`Vector2` at_position **)** |virtual| |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_gui_input` **(** :ref:`InputEvent` event **)** |virtual| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_point` **(** :ref:`Vector2` point **)** |virtual| |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`_make_custom_tooltip` **(** :ref:`String` for_text **)** |virtual| |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i[]` | :ref:`_structured_text_parser` **(** :ref:`Array` args, :ref:`String` text **)** |virtual| |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`accept_event` **(** **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_theme_color_override` **(** :ref:`StringName` name, :ref:`Color` color **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_theme_constant_override` **(** :ref:`StringName` name, :ref:`int` constant **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_theme_font_override` **(** :ref:`StringName` name, :ref:`Font` font **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_theme_font_size_override` **(** :ref:`StringName` name, :ref:`int` font_size **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_theme_icon_override` **(** :ref:`StringName` name, :ref:`Texture2D` texture **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_theme_stylebox_override` **(** :ref:`StringName` name, :ref:`StyleBox` stylebox **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`begin_bulk_theme_override` **(** **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`end_bulk_theme_override` **(** **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Control` | :ref:`find_next_valid_focus` **(** **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Control` | :ref:`find_prev_valid_focus` **(** **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Control` | :ref:`find_valid_focus_neighbor` **(** :ref:`Side` side **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`force_drag` **(** :ref:`Variant` data, :ref:`Control` preview **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_anchor` **(** :ref:`Side` side **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_begin` **(** **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_combined_minimum_size` **(** **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`CursorShape` | :ref:`get_cursor_shape` **(** :ref:`Vector2` position=Vector2(0, 0) **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_end` **(** **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_focus_neighbor` **(** :ref:`Side` side **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_global_rect` **(** **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_offset` **(** :ref:`Side` offset **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_parent_area_size` **(** **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Control` | :ref:`get_parent_control` **(** **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_rect` **(** **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_screen_position` **(** **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_theme_color` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_theme_constant` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_theme_default_base_scale` **(** **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Font` | :ref:`get_theme_default_font` **(** **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_theme_default_font_size` **(** **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Font` | :ref:`get_theme_font` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_theme_font_size` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_theme_icon` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StyleBox` | :ref:`get_theme_stylebox` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_tooltip` **(** :ref:`Vector2` at_position=Vector2(0, 0) **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`grab_click_focus` **(** **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`grab_focus` **(** **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_focus` **(** **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_color` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_color_override` **(** :ref:`StringName` name **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_constant` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_constant_override` **(** :ref:`StringName` name **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_font` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_font_override` **(** :ref:`StringName` name **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_font_size` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_font_size_override` **(** :ref:`StringName` name **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_icon` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_icon_override` **(** :ref:`StringName` name **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_stylebox` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_stylebox_override` **(** :ref:`StringName` name **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_drag_successful` **(** **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_layout_rtl` **(** **)** |const| | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`release_focus` **(** **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_theme_color_override` **(** :ref:`StringName` name **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_theme_constant_override` **(** :ref:`StringName` name **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_theme_font_override` **(** :ref:`StringName` name **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_theme_font_size_override` **(** :ref:`StringName` name **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_theme_icon_override` **(** :ref:`StringName` name **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_theme_stylebox_override` **(** :ref:`StringName` name **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reset_size` **(** **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_anchor` **(** :ref:`Side` side, :ref:`float` anchor, :ref:`bool` keep_offset=false, :ref:`bool` push_opposite_anchor=true **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_anchor_and_offset` **(** :ref:`Side` side, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=false **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_anchors_and_offsets_preset` **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_anchors_preset` **(** :ref:`LayoutPreset` preset, :ref:`bool` keep_offsets=false **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_begin` **(** :ref:`Vector2` position **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_drag_forwarding` **(** :ref:`Callable` drag_func, :ref:`Callable` can_drop_func, :ref:`Callable` drop_func **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_drag_preview` **(** :ref:`Control` control **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_end` **(** :ref:`Vector2` position **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_focus_neighbor` **(** :ref:`Side` side, :ref:`NodePath` neighbor **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_global_position` **(** :ref:`Vector2` position, :ref:`bool` keep_offsets=false **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_offset` **(** :ref:`Side` side, :ref:`float` offset **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_offsets_preset` **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_position` **(** :ref:`Vector2` position, :ref:`bool` keep_offsets=false **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_size` **(** :ref:`Vector2` size, :ref:`bool` keep_offsets=false **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`update_minimum_size` **(** **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`warp_mouse` **(** :ref:`Vector2` position **)** | - +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_can_drop_data`\ (\ at_position\: :ref:`Vector2`, data\: :ref:`Variant`\ ) |virtual| |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_drop_data`\ (\ at_position\: :ref:`Vector2`, data\: :ref:`Variant`\ ) |virtual| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_drag_data`\ (\ at_position\: :ref:`Vector2`\ ) |virtual| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_minimum_size`\ (\ ) |virtual| |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_tooltip`\ (\ at_position\: :ref:`Vector2`\ ) |virtual| |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_gui_input`\ (\ event\: :ref:`InputEvent`\ ) |virtual| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_point`\ (\ point\: :ref:`Vector2`\ ) |virtual| |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`_make_custom_tooltip`\ (\ for_text\: :ref:`String`\ ) |virtual| |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector3i`\] | :ref:`_structured_text_parser`\ (\ args\: :ref:`Array`, text\: :ref:`String`\ ) |virtual| |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accept_event`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_theme_color_override`\ (\ name\: :ref:`StringName`, color\: :ref:`Color`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_theme_constant_override`\ (\ name\: :ref:`StringName`, constant\: :ref:`int`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_theme_font_override`\ (\ name\: :ref:`StringName`, font\: :ref:`Font`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_theme_font_size_override`\ (\ name\: :ref:`StringName`, font_size\: :ref:`int`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_theme_icon_override`\ (\ name\: :ref:`StringName`, texture\: :ref:`Texture2D`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_theme_stylebox_override`\ (\ name\: :ref:`StringName`, stylebox\: :ref:`StyleBox`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`begin_bulk_theme_override`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`end_bulk_theme_override`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Control` | :ref:`find_next_valid_focus`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Control` | :ref:`find_prev_valid_focus`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Control` | :ref:`find_valid_focus_neighbor`\ (\ side\: :ref:`Side`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_drag`\ (\ data\: :ref:`Variant`, preview\: :ref:`Control`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_anchor`\ (\ side\: :ref:`Side`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_begin`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_combined_minimum_size`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CursorShape` | :ref:`get_cursor_shape`\ (\ position\: :ref:`Vector2` = Vector2(0, 0)\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_end`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_focus_neighbor`\ (\ side\: :ref:`Side`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_global_rect`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_minimum_size`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_offset`\ (\ offset\: :ref:`Side`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_parent_area_size`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Control` | :ref:`get_parent_control`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_rect`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_screen_position`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_theme_color`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_theme_constant`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_theme_default_base_scale`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Font` | :ref:`get_theme_default_font`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_theme_default_font_size`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Font` | :ref:`get_theme_font`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_theme_font_size`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_theme_icon`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StyleBox` | :ref:`get_theme_stylebox`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_tooltip`\ (\ at_position\: :ref:`Vector2` = Vector2(0, 0)\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`grab_click_focus`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`grab_focus`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_focus`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_color`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_color_override`\ (\ name\: :ref:`StringName`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_constant`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_constant_override`\ (\ name\: :ref:`StringName`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_font`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_font_override`\ (\ name\: :ref:`StringName`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_font_size`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_font_size_override`\ (\ name\: :ref:`StringName`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_icon`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_icon_override`\ (\ name\: :ref:`StringName`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_stylebox`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_stylebox_override`\ (\ name\: :ref:`StringName`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_drag_successful`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_layout_rtl`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`release_focus`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_theme_color_override`\ (\ name\: :ref:`StringName`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_theme_constant_override`\ (\ name\: :ref:`StringName`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_theme_font_override`\ (\ name\: :ref:`StringName`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_theme_font_size_override`\ (\ name\: :ref:`StringName`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_theme_icon_override`\ (\ name\: :ref:`StringName`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_theme_stylebox_override`\ (\ name\: :ref:`StringName`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reset_size`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_anchor`\ (\ side\: :ref:`Side`, anchor\: :ref:`float`, keep_offset\: :ref:`bool` = false, push_opposite_anchor\: :ref:`bool` = true\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_anchor_and_offset`\ (\ side\: :ref:`Side`, anchor\: :ref:`float`, offset\: :ref:`float`, push_opposite_anchor\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_anchors_and_offsets_preset`\ (\ preset\: :ref:`LayoutPreset`, resize_mode\: :ref:`LayoutPresetMode` = 0, margin\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_anchors_preset`\ (\ preset\: :ref:`LayoutPreset`, keep_offsets\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_begin`\ (\ position\: :ref:`Vector2`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_drag_forwarding`\ (\ drag_func\: :ref:`Callable`, can_drop_func\: :ref:`Callable`, drop_func\: :ref:`Callable`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_drag_preview`\ (\ control\: :ref:`Control`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_end`\ (\ position\: :ref:`Vector2`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_focus_neighbor`\ (\ side\: :ref:`Side`, neighbor\: :ref:`NodePath`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_global_position`\ (\ position\: :ref:`Vector2`, keep_offsets\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_offset`\ (\ side\: :ref:`Side`, offset\: :ref:`float`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_offsets_preset`\ (\ preset\: :ref:`LayoutPreset`, resize_mode\: :ref:`LayoutPresetMode` = 0, margin\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_position`\ (\ position\: :ref:`Vector2`, keep_offsets\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_size`\ (\ size\: :ref:`Vector2`, keep_offsets\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update_minimum_size`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`warp_mouse`\ (\ position\: :ref:`Vector2`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -339,7 +339,7 @@ Signals .. rst-class:: classref-signal -**focus_entered** **(** **)** +**focus_entered**\ (\ ) Emitted when the node gains focus. @@ -351,7 +351,7 @@ Emitted when the node gains focus. .. rst-class:: classref-signal -**focus_exited** **(** **)** +**focus_exited**\ (\ ) Emitted when the node loses focus. @@ -363,7 +363,7 @@ Emitted when the node loses focus. .. rst-class:: classref-signal -**gui_input** **(** :ref:`InputEvent` event **)** +**gui_input**\ (\ event\: :ref:`InputEvent`\ ) Emitted when the node receives an :ref:`InputEvent`. @@ -375,7 +375,7 @@ Emitted when the node receives an :ref:`InputEvent`. .. rst-class:: classref-signal -**minimum_size_changed** **(** **)** +**minimum_size_changed**\ (\ ) Emitted when the node's minimum size changes. @@ -387,7 +387,7 @@ Emitted when the node's minimum size changes. .. rst-class:: classref-signal -**mouse_entered** **(** **)** +**mouse_entered**\ (\ ) Emitted when the mouse cursor enters the control's (or any child control's) visible area, that is not occluded behind other Controls or Windows, provided its :ref:`mouse_filter` lets the event reach it and regardless if it's currently focused or not. @@ -401,7 +401,7 @@ Emitted when the mouse cursor enters the control's (or any child control's) visi .. rst-class:: classref-signal -**mouse_exited** **(** **)** +**mouse_exited**\ (\ ) Emitted when the mouse cursor leaves the control's (and all child control's) visible area, that is not occluded behind other Controls or Windows, provided its :ref:`mouse_filter` lets the event reach it and regardless if it's currently focused or not. @@ -423,7 +423,7 @@ Emitted when the mouse cursor leaves the control's (and all child control's) vis .. rst-class:: classref-signal -**resized** **(** **)** +**resized**\ (\ ) Emitted when the control changes size. @@ -435,7 +435,7 @@ Emitted when the control changes size. .. rst-class:: classref-signal -**size_flags_changed** **(** **)** +**size_flags_changed**\ (\ ) Emitted when one of the size flags changes. See :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. @@ -447,7 +447,7 @@ Emitted when one of the size flags changes. See :ref:`size_flags_horizontal` notification is sent. @@ -1103,7 +1103,7 @@ See also :ref:`NOTIFICATION_MOUSE_EXIT_SELF` lets the event reach it and regardless if it's currently focused or not. @@ -1117,7 +1117,7 @@ See also :ref:`NOTIFICATION_MOUSE_ENTER` lets the event reach it and regardless if it's currently focused or not. @@ -1204,7 +1204,7 @@ Property Descriptions .. rst-class:: classref-property-setget -- :ref:`float` **get_anchor** **(** :ref:`Side` side **)** |const| +- :ref:`float` **get_anchor**\ (\ side\: :ref:`Side`\ ) |const| Anchors the bottom edge of the node to the origin, the center, or the end of its parent control. It changes how the bottom offset updates when the node moves or changes size. You can use one of the :ref:`Anchor` constants for convenience. @@ -1220,7 +1220,7 @@ Anchors the bottom edge of the node to the origin, the center, or the end of its .. rst-class:: classref-property-setget -- :ref:`float` **get_anchor** **(** :ref:`Side` side **)** |const| +- :ref:`float` **get_anchor**\ (\ side\: :ref:`Side`\ ) |const| Anchors the left edge of the node to the origin, the center or the end of its parent control. It changes how the left offset updates when the node moves or changes size. You can use one of the :ref:`Anchor` constants for convenience. @@ -1236,7 +1236,7 @@ Anchors the left edge of the node to the origin, the center or the end of its pa .. rst-class:: classref-property-setget -- :ref:`float` **get_anchor** **(** :ref:`Side` side **)** |const| +- :ref:`float` **get_anchor**\ (\ side\: :ref:`Side`\ ) |const| Anchors the right edge of the node to the origin, the center or the end of its parent control. It changes how the right offset updates when the node moves or changes size. You can use one of the :ref:`Anchor` constants for convenience. @@ -1252,7 +1252,7 @@ Anchors the right edge of the node to the origin, the center or the end of its p .. rst-class:: classref-property-setget -- :ref:`float` **get_anchor** **(** :ref:`Side` side **)** |const| +- :ref:`float` **get_anchor**\ (\ side\: :ref:`Side`\ ) |const| Anchors the top edge of the node to the origin, the center or the end of its parent control. It changes how the top offset updates when the node moves or changes size. You can use one of the :ref:`Anchor` constants for convenience. @@ -1268,12 +1268,12 @@ Anchors the top edge of the node to the origin, the center or the end of its par .. rst-class:: classref-property-setget -- void **set_auto_translate** **(** :ref:`bool` value **)** -- :ref:`bool` **is_auto_translating** **(** **)** +- |void| **set_auto_translate**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_auto_translating**\ (\ ) -Toggles if any text should automatically change to its translated version depending on the current locale. +**Deprecated:** Use :ref:`Node.auto_translate_mode` instead. -Also decides if the node's strings should be parsed for POT generation. +Toggles if any text should automatically change to its translated version depending on the current locale. .. rst-class:: classref-item-separator @@ -1287,8 +1287,8 @@ Also decides if the node's strings should be parsed for POT generation. .. rst-class:: classref-property-setget -- void **set_clip_contents** **(** :ref:`bool` value **)** -- :ref:`bool` **is_clipping_contents** **(** **)** +- |void| **set_clip_contents**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_clipping_contents**\ (\ ) Enables whether rendering of :ref:`CanvasItem` based children should be clipped to this control's rectangle. If ``true``, parts of a child which would be visibly outside of this control's rectangle will not be rendered and won't receive input. @@ -1304,8 +1304,8 @@ Enables whether rendering of :ref:`CanvasItem` based children .. rst-class:: classref-property-setget -- void **set_custom_minimum_size** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_custom_minimum_size** **(** **)** +- |void| **set_custom_minimum_size**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_custom_minimum_size**\ (\ ) The minimum size of the node's bounding rectangle. If you set it to a value greater than (0, 0), the node's bounding rectangle will always have at least this size, even if its content is smaller. If it's set to (0, 0), the node sizes automatically to fit its content, be it a texture or child nodes. @@ -1321,8 +1321,8 @@ The minimum size of the node's bounding rectangle. If you set it to a value grea .. rst-class:: classref-property-setget -- void **set_focus_mode** **(** :ref:`FocusMode` value **)** -- :ref:`FocusMode` **get_focus_mode** **(** **)** +- |void| **set_focus_mode**\ (\ value\: :ref:`FocusMode`\ ) +- :ref:`FocusMode` **get_focus_mode**\ (\ ) The focus access mode for the control (None, Click or All). Only one Control can be focused at the same time, and it will receive keyboard, gamepad, and mouse signals. @@ -1338,8 +1338,8 @@ The focus access mode for the control (None, Click or All). Only one Control can .. rst-class:: classref-property-setget -- void **set_focus_neighbor** **(** :ref:`Side` side, :ref:`NodePath` neighbor **)** -- :ref:`NodePath` **get_focus_neighbor** **(** :ref:`Side` side **)** |const| +- |void| **set_focus_neighbor**\ (\ side\: :ref:`Side`, neighbor\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_focus_neighbor**\ (\ side\: :ref:`Side`\ ) |const| Tells Godot which node it should give focus to if the user presses the down arrow on the keyboard or down on a gamepad by default. You can change the key by editing the :ref:`ProjectSettings.input/ui_down` input action. The node must be a **Control**. If this property is not set, Godot will give focus to the closest **Control** to the bottom of this one. @@ -1355,8 +1355,8 @@ Tells Godot which node it should give focus to if the user presses the down arro .. rst-class:: classref-property-setget -- void **set_focus_neighbor** **(** :ref:`Side` side, :ref:`NodePath` neighbor **)** -- :ref:`NodePath` **get_focus_neighbor** **(** :ref:`Side` side **)** |const| +- |void| **set_focus_neighbor**\ (\ side\: :ref:`Side`, neighbor\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_focus_neighbor**\ (\ side\: :ref:`Side`\ ) |const| Tells Godot which node it should give focus to if the user presses the left arrow on the keyboard or left on a gamepad by default. You can change the key by editing the :ref:`ProjectSettings.input/ui_left` input action. The node must be a **Control**. If this property is not set, Godot will give focus to the closest **Control** to the left of this one. @@ -1372,8 +1372,8 @@ Tells Godot which node it should give focus to if the user presses the left arro .. rst-class:: classref-property-setget -- void **set_focus_neighbor** **(** :ref:`Side` side, :ref:`NodePath` neighbor **)** -- :ref:`NodePath` **get_focus_neighbor** **(** :ref:`Side` side **)** |const| +- |void| **set_focus_neighbor**\ (\ side\: :ref:`Side`, neighbor\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_focus_neighbor**\ (\ side\: :ref:`Side`\ ) |const| Tells Godot which node it should give focus to if the user presses the right arrow on the keyboard or right on a gamepad by default. You can change the key by editing the :ref:`ProjectSettings.input/ui_right` input action. The node must be a **Control**. If this property is not set, Godot will give focus to the closest **Control** to the right of this one. @@ -1389,8 +1389,8 @@ Tells Godot which node it should give focus to if the user presses the right arr .. rst-class:: classref-property-setget -- void **set_focus_neighbor** **(** :ref:`Side` side, :ref:`NodePath` neighbor **)** -- :ref:`NodePath` **get_focus_neighbor** **(** :ref:`Side` side **)** |const| +- |void| **set_focus_neighbor**\ (\ side\: :ref:`Side`, neighbor\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_focus_neighbor**\ (\ side\: :ref:`Side`\ ) |const| Tells Godot which node it should give focus to if the user presses the top arrow on the keyboard or top on a gamepad by default. You can change the key by editing the :ref:`ProjectSettings.input/ui_up` input action. The node must be a **Control**. If this property is not set, Godot will give focus to the closest **Control** to the top of this one. @@ -1406,8 +1406,8 @@ Tells Godot which node it should give focus to if the user presses the top arrow .. rst-class:: classref-property-setget -- void **set_focus_next** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_focus_next** **(** **)** +- |void| **set_focus_next**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_focus_next**\ (\ ) Tells Godot which node it should give focus to if the user presses :kbd:`Tab` on a keyboard by default. You can change the key by editing the :ref:`ProjectSettings.input/ui_focus_next` input action. @@ -1425,8 +1425,8 @@ If this property is not set, Godot will select a "best guess" based on surroundi .. rst-class:: classref-property-setget -- void **set_focus_previous** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_focus_previous** **(** **)** +- |void| **set_focus_previous**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_focus_previous**\ (\ ) Tells Godot which node it should give focus to if the user presses :kbd:`Shift + Tab` on a keyboard by default. You can change the key by editing the :ref:`ProjectSettings.input/ui_focus_prev` input action. @@ -1444,7 +1444,7 @@ If this property is not set, Godot will select a "best guess" based on surroundi .. rst-class:: classref-property-setget -- :ref:`Vector2` **get_global_position** **(** **)** +- :ref:`Vector2` **get_global_position**\ (\ ) The node's global position, relative to the world (usually to the :ref:`CanvasLayer`). @@ -1460,8 +1460,8 @@ The node's global position, relative to the world (usually to the :ref:`CanvasLa .. rst-class:: classref-property-setget -- void **set_h_grow_direction** **(** :ref:`GrowDirection` value **)** -- :ref:`GrowDirection` **get_h_grow_direction** **(** **)** +- |void| **set_h_grow_direction**\ (\ value\: :ref:`GrowDirection`\ ) +- :ref:`GrowDirection` **get_h_grow_direction**\ (\ ) Controls the direction on the horizontal axis in which the control should grow if its horizontal minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size. @@ -1477,8 +1477,8 @@ Controls the direction on the horizontal axis in which the control should grow i .. rst-class:: classref-property-setget -- void **set_v_grow_direction** **(** :ref:`GrowDirection` value **)** -- :ref:`GrowDirection` **get_v_grow_direction** **(** **)** +- |void| **set_v_grow_direction**\ (\ value\: :ref:`GrowDirection`\ ) +- :ref:`GrowDirection` **get_v_grow_direction**\ (\ ) Controls the direction on the vertical axis in which the control should grow if its vertical minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size. @@ -1494,8 +1494,8 @@ Controls the direction on the vertical axis in which the control should grow if .. rst-class:: classref-property-setget -- void **set_layout_direction** **(** :ref:`LayoutDirection` value **)** -- :ref:`LayoutDirection` **get_layout_direction** **(** **)** +- |void| **set_layout_direction**\ (\ value\: :ref:`LayoutDirection`\ ) +- :ref:`LayoutDirection` **get_layout_direction**\ (\ ) Controls layout direction and text writing direction. Right-to-left layouts are necessary for certain languages (e.g. Arabic and Hebrew). @@ -1511,8 +1511,8 @@ Controls layout direction and text writing direction. Right-to-left layouts are .. rst-class:: classref-property-setget -- void **set_localize_numeral_system** **(** :ref:`bool` value **)** -- :ref:`bool` **is_localizing_numeral_system** **(** **)** +- |void| **set_localize_numeral_system**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_localizing_numeral_system**\ (\ ) If ``true``, automatically converts code line numbers, list indices, :ref:`SpinBox` and :ref:`ProgressBar` values from the Western Arabic (0..9) to the numeral systems used in current locale. @@ -1530,8 +1530,8 @@ If ``true``, automatically converts code line numbers, list indices, :ref:`SpinB .. rst-class:: classref-property-setget -- void **set_default_cursor_shape** **(** :ref:`CursorShape` value **)** -- :ref:`CursorShape` **get_default_cursor_shape** **(** **)** +- |void| **set_default_cursor_shape**\ (\ value\: :ref:`CursorShape`\ ) +- :ref:`CursorShape` **get_default_cursor_shape**\ (\ ) The default cursor shape for this control. Useful for Godot plugins and applications or games that use the system's mouse cursors. @@ -1549,8 +1549,8 @@ The default cursor shape for this control. Useful for Godot plugins and applicat .. rst-class:: classref-property-setget -- void **set_mouse_filter** **(** :ref:`MouseFilter` value **)** -- :ref:`MouseFilter` **get_mouse_filter** **(** **)** +- |void| **set_mouse_filter**\ (\ value\: :ref:`MouseFilter`\ ) +- :ref:`MouseFilter` **get_mouse_filter**\ (\ ) Controls whether the control will be able to receive mouse button input events through :ref:`_gui_input` and how these events should be handled. Also controls whether the control can receive the :ref:`mouse_entered`, and :ref:`mouse_exited` signals. See the constants to learn what each does. @@ -1566,8 +1566,8 @@ Controls whether the control will be able to receive mouse button input events t .. rst-class:: classref-property-setget -- void **set_force_pass_scroll_events** **(** :ref:`bool` value **)** -- :ref:`bool` **is_force_pass_scroll_events** **(** **)** +- |void| **set_force_pass_scroll_events**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_force_pass_scroll_events**\ (\ ) When enabled, scroll wheel events processed by :ref:`_gui_input` will be passed to the parent control even if :ref:`mouse_filter` is set to :ref:`MOUSE_FILTER_STOP`. As it defaults to true, this allows nested scrollable containers to work out of the box. @@ -1585,8 +1585,8 @@ You should disable it on the root of your UI if you do not want scroll events to .. rst-class:: classref-property-setget -- void **set_offset** **(** :ref:`Side` side, :ref:`float` offset **)** -- :ref:`float` **get_offset** **(** :ref:`Side` offset **)** |const| +- |void| **set_offset**\ (\ side\: :ref:`Side`, offset\: :ref:`float`\ ) +- :ref:`float` **get_offset**\ (\ offset\: :ref:`Side`\ ) |const| Distance between the node's bottom edge and its parent control, based on :ref:`anchor_bottom`. @@ -1604,8 +1604,8 @@ Offsets are often controlled by one or multiple parent :ref:`Container` side, :ref:`float` offset **)** -- :ref:`float` **get_offset** **(** :ref:`Side` offset **)** |const| +- |void| **set_offset**\ (\ side\: :ref:`Side`, offset\: :ref:`float`\ ) +- :ref:`float` **get_offset**\ (\ offset\: :ref:`Side`\ ) |const| Distance between the node's left edge and its parent control, based on :ref:`anchor_left`. @@ -1623,8 +1623,8 @@ Offsets are often controlled by one or multiple parent :ref:`Container` side, :ref:`float` offset **)** -- :ref:`float` **get_offset** **(** :ref:`Side` offset **)** |const| +- |void| **set_offset**\ (\ side\: :ref:`Side`, offset\: :ref:`float`\ ) +- :ref:`float` **get_offset**\ (\ offset\: :ref:`Side`\ ) |const| Distance between the node's right edge and its parent control, based on :ref:`anchor_right`. @@ -1642,8 +1642,8 @@ Offsets are often controlled by one or multiple parent :ref:`Container` side, :ref:`float` offset **)** -- :ref:`float` **get_offset** **(** :ref:`Side` offset **)** |const| +- |void| **set_offset**\ (\ side\: :ref:`Side`, offset\: :ref:`float`\ ) +- :ref:`float` **get_offset**\ (\ offset\: :ref:`Side`\ ) |const| Distance between the node's top edge and its parent control, based on :ref:`anchor_top`. @@ -1661,8 +1661,8 @@ Offsets are often controlled by one or multiple parent :ref:`Container` value **)** -- :ref:`Vector2` **get_pivot_offset** **(** **)** +- |void| **set_pivot_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_pivot_offset**\ (\ ) By default, the node's pivot is its top-left corner. When you change its :ref:`rotation` or :ref:`scale`, it will rotate or scale around this pivot. Set this property to :ref:`size` / 2 to pivot around the Control's center. @@ -1678,7 +1678,7 @@ By default, the node's pivot is its top-left corner. When you change its :ref:`r .. rst-class:: classref-property-setget -- :ref:`Vector2` **get_position** **(** **)** +- :ref:`Vector2` **get_position**\ (\ ) The node's position, relative to its containing node. It corresponds to the rectangle's top-left corner. The property is not affected by :ref:`pivot_offset`. @@ -1694,8 +1694,8 @@ The node's position, relative to its containing node. It corresponds to the rect .. rst-class:: classref-property-setget -- void **set_rotation** **(** :ref:`float` value **)** -- :ref:`float` **get_rotation** **(** **)** +- |void| **set_rotation**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_rotation**\ (\ ) The node's rotation around its pivot, in radians. See :ref:`pivot_offset` to change the pivot's position. @@ -1713,8 +1713,8 @@ The node's rotation around its pivot, in radians. See :ref:`pivot_offset` value **)** -- :ref:`float` **get_rotation_degrees** **(** **)** +- |void| **set_rotation_degrees**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_rotation_degrees**\ (\ ) Helper property to access :ref:`rotation` in degrees instead of radians. @@ -1730,8 +1730,8 @@ Helper property to access :ref:`rotation` in de .. rst-class:: classref-property-setget -- void **set_scale** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_scale** **(** **)** +- |void| **set_scale**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_scale**\ (\ ) The node's scale, relative to its :ref:`size`. Change this property to scale the node around its :ref:`pivot_offset`. The Control's :ref:`tooltip_text` will also scale according to this value. @@ -1753,8 +1753,8 @@ The node's scale, relative to its :ref:`size`. Chan .. rst-class:: classref-property-setget -- void **set_shortcut_context** **(** :ref:`Node` value **)** -- :ref:`Node` **get_shortcut_context** **(** **)** +- |void| **set_shortcut_context**\ (\ value\: :ref:`Node`\ ) +- :ref:`Node` **get_shortcut_context**\ (\ ) The :ref:`Node` which must be a parent of the focused **Control** for the shortcut to be activated. If ``null``, the shortcut can be activated when any control is focused (a global shortcut). This allows shortcuts to be accepted only when the user has a certain area of the GUI focused. @@ -1770,7 +1770,7 @@ The :ref:`Node` which must be a parent of the focused **Control** fo .. rst-class:: classref-property-setget -- :ref:`Vector2` **get_size** **(** **)** +- :ref:`Vector2` **get_size**\ (\ ) The size of the node's bounding rectangle, in the node's coordinate system. :ref:`Container` nodes update this property automatically. @@ -1782,12 +1782,12 @@ The size of the node's bounding rectangle, in the node's coordinate system. :ref .. rst-class:: classref-property -|bitfield|\<:ref:`SizeFlags`\> **size_flags_horizontal** = ``1`` +|bitfield|\[:ref:`SizeFlags`\] **size_flags_horizontal** = ``1`` .. rst-class:: classref-property-setget -- void **set_h_size_flags** **(** |bitfield|\<:ref:`SizeFlags`\> value **)** -- |bitfield|\<:ref:`SizeFlags`\> **get_h_size_flags** **(** **)** +- |void| **set_h_size_flags**\ (\ value\: |bitfield|\[:ref:`SizeFlags`\]\ ) +- |bitfield|\[:ref:`SizeFlags`\] **get_h_size_flags**\ (\ ) Tells the parent :ref:`Container` nodes how they should resize and place the node on the X axis. Use a combination of the :ref:`SizeFlags` constants to change the flags. See the constants to learn what each does. @@ -1803,8 +1803,8 @@ Tells the parent :ref:`Container` nodes how they should resize .. rst-class:: classref-property-setget -- void **set_stretch_ratio** **(** :ref:`float` value **)** -- :ref:`float` **get_stretch_ratio** **(** **)** +- |void| **set_stretch_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_stretch_ratio**\ (\ ) If the node and at least one of its neighbors uses the :ref:`SIZE_EXPAND` size flag, the parent :ref:`Container` will let it take more or less space depending on this property. If this node has a stretch ratio of 2 and its neighbor a ratio of 1, this node will take two thirds of the available space. @@ -1816,12 +1816,12 @@ If the node and at least one of its neighbors uses the :ref:`SIZE_EXPAND`\> **size_flags_vertical** = ``1`` +|bitfield|\[:ref:`SizeFlags`\] **size_flags_vertical** = ``1`` .. rst-class:: classref-property-setget -- void **set_v_size_flags** **(** |bitfield|\<:ref:`SizeFlags`\> value **)** -- |bitfield|\<:ref:`SizeFlags`\> **get_v_size_flags** **(** **)** +- |void| **set_v_size_flags**\ (\ value\: |bitfield|\[:ref:`SizeFlags`\]\ ) +- |bitfield|\[:ref:`SizeFlags`\] **get_v_size_flags**\ (\ ) Tells the parent :ref:`Container` nodes how they should resize and place the node on the Y axis. Use a combination of the :ref:`SizeFlags` constants to change the flags. See the constants to learn what each does. @@ -1837,8 +1837,8 @@ Tells the parent :ref:`Container` nodes how they should resize .. rst-class:: classref-property-setget -- void **set_theme** **(** :ref:`Theme` value **)** -- :ref:`Theme` **get_theme** **(** **)** +- |void| **set_theme**\ (\ value\: :ref:`Theme`\ ) +- :ref:`Theme` **get_theme**\ (\ ) The :ref:`Theme` resource this node and all its **Control** and :ref:`Window` children use. If a child node has its own :ref:`Theme` resource set, theme items are merged with child's definitions having higher priority. @@ -1856,8 +1856,8 @@ The :ref:`Theme` resource this node and all its **Control** and :re .. rst-class:: classref-property-setget -- void **set_theme_type_variation** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_theme_type_variation** **(** **)** +- |void| **set_theme_type_variation**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_theme_type_variation**\ (\ ) The name of a theme type variation used by this **Control** to look up its own theme items. When empty, the class name of the node is used (e.g. ``Button`` for the :ref:`Button` control), as well as the class names of all parent classes (in order of inheritance). @@ -1879,8 +1879,8 @@ When set, this property gives the highest priority to the type of the specified .. rst-class:: classref-property-setget -- void **set_tooltip_text** **(** :ref:`String` value **)** -- :ref:`String` **get_tooltip_text** **(** **)** +- |void| **set_tooltip_text**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_tooltip_text**\ (\ ) The default tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments, provided that the :ref:`mouse_filter` property is not :ref:`MOUSE_FILTER_IGNORE`. The time required for the tooltip to appear can be changed with the :ref:`ProjectSettings.gui/timers/tooltip_delay_sec` option. See also :ref:`get_tooltip`. @@ -1922,7 +1922,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_can_drop_data** **(** :ref:`Vector2` at_position, :ref:`Variant` data **)** |virtual| |const| +:ref:`bool` **_can_drop_data**\ (\ at_position\: :ref:`Vector2`, data\: :ref:`Variant`\ ) |virtual| |const| Godot calls this method to test if ``data`` from a control's :ref:`_get_drag_data` can be dropped at ``at_position``. ``at_position`` is local to this control. @@ -1957,7 +1957,7 @@ This method should only be used to test the data. Process the data in :ref:`_dro .. rst-class:: classref-method -void **_drop_data** **(** :ref:`Vector2` at_position, :ref:`Variant` data **)** |virtual| +|void| **_drop_data**\ (\ at_position\: :ref:`Vector2`, data\: :ref:`Variant`\ ) |virtual| Godot calls this method to pass you the ``data`` from a control's :ref:`_get_drag_data` result. Godot first calls :ref:`_can_drop_data` to test if ``data`` is allowed to drop at ``at_position`` where ``at_position`` is local to this control. @@ -1994,7 +1994,7 @@ Godot calls this method to pass you the ``data`` from a control's :ref:`_get_dra .. rst-class:: classref-method -:ref:`Variant` **_get_drag_data** **(** :ref:`Vector2` at_position **)** |virtual| +:ref:`Variant` **_get_drag_data**\ (\ at_position\: :ref:`Vector2`\ ) |virtual| Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns ``null`` if there is no data to drag. Controls that want to receive drop data should implement :ref:`_can_drop_data` and :ref:`_drop_data`. ``at_position`` is local to this control. Drag may be forced with :ref:`force_drag`. @@ -2029,7 +2029,7 @@ A preview that will follow the mouse that should represent the data can be set w .. rst-class:: classref-method -:ref:`Vector2` **_get_minimum_size** **(** **)** |virtual| |const| +:ref:`Vector2` **_get_minimum_size**\ (\ ) |virtual| |const| Virtual method to be implemented by the user. Returns the minimum size for this control. Alternative to :ref:`custom_minimum_size` for controlling minimum size via code. The actual minimum size will be the max value of these two (in each axis separately). @@ -2045,7 +2045,7 @@ If not overridden, defaults to :ref:`Vector2.ZERO`. .. rst-class:: classref-method -:ref:`String` **_get_tooltip** **(** :ref:`Vector2` at_position **)** |virtual| |const| +:ref:`String` **_get_tooltip**\ (\ at_position\: :ref:`Vector2`\ ) |virtual| |const| Virtual method to be implemented by the user. Returns the tooltip text for the position ``at_position`` in control's local coordinates, which will typically appear when the cursor is resting over this control. See :ref:`get_tooltip`. @@ -2059,7 +2059,7 @@ Virtual method to be implemented by the user. Returns the tooltip text for the p .. rst-class:: classref-method -void **_gui_input** **(** :ref:`InputEvent` event **)** |virtual| +|void| **_gui_input**\ (\ event\: :ref:`InputEvent`\ ) |virtual| Virtual method to be implemented by the user. Use this method to process and accept inputs on UI elements. See :ref:`accept_event`. @@ -2112,7 +2112,7 @@ The event won't trigger if: .. rst-class:: classref-method -:ref:`bool` **_has_point** **(** :ref:`Vector2` point **)** |virtual| |const| +:ref:`bool` **_has_point**\ (\ point\: :ref:`Vector2`\ ) |virtual| |const| Virtual method to be implemented by the user. Returns whether the given ``point`` is inside this control. @@ -2128,7 +2128,7 @@ If not overridden, default behavior is checking if the point is within control's .. rst-class:: classref-method -:ref:`Object` **_make_custom_tooltip** **(** :ref:`String` for_text **)** |virtual| |const| +:ref:`Object` **_make_custom_tooltip**\ (\ for_text\: :ref:`String`\ ) |virtual| |const| Virtual method to be implemented by the user. Returns a **Control** node that should be used as a tooltip instead of the default one. The ``for_text`` includes the contents of the :ref:`tooltip_text` property. @@ -2194,7 +2194,7 @@ The returned node will be added as child to a :ref:`PopupPanel .. rst-class:: classref-method -:ref:`Vector3i[]` **_structured_text_parser** **(** :ref:`Array` args, :ref:`String` text **)** |virtual| |const| +:ref:`Array`\[:ref:`Vector3i`\] **_structured_text_parser**\ (\ args\: :ref:`Array`, text\: :ref:`String`\ ) |virtual| |const| User defined BiDi algorithm override function. @@ -2208,7 +2208,7 @@ Returns an :ref:`Array` of :ref:`Vector3i` text ran .. rst-class:: classref-method -void **accept_event** **(** **)** +|void| **accept_event**\ (\ ) Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to :ref:`Node._unhandled_input` or :ref:`Node._unhandled_key_input`. @@ -2222,7 +2222,7 @@ Marks an input event as handled. Once you accept an input event, it stops propag .. rst-class:: classref-method -void **add_theme_color_override** **(** :ref:`StringName` name, :ref:`Color` color **)** +|void| **add_theme_color_override**\ (\ name\: :ref:`StringName`, color\: :ref:`Color`\ ) Creates a local override for a theme :ref:`Color` with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_color_override`. @@ -2261,7 +2261,7 @@ See also :ref:`get_theme_color`. .. rst-class:: classref-method -void **add_theme_constant_override** **(** :ref:`StringName` name, :ref:`int` constant **)** +|void| **add_theme_constant_override**\ (\ name\: :ref:`StringName`, constant\: :ref:`int`\ ) Creates a local override for a theme constant with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_constant_override`. @@ -2275,7 +2275,7 @@ See also :ref:`get_theme_constant`. .. rst-class:: classref-method -void **add_theme_font_override** **(** :ref:`StringName` name, :ref:`Font` font **)** +|void| **add_theme_font_override**\ (\ name\: :ref:`StringName`, font\: :ref:`Font`\ ) Creates a local override for a theme :ref:`Font` with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_font_override`. @@ -2289,7 +2289,7 @@ See also :ref:`get_theme_font`. .. rst-class:: classref-method -void **add_theme_font_size_override** **(** :ref:`StringName` name, :ref:`int` font_size **)** +|void| **add_theme_font_size_override**\ (\ name\: :ref:`StringName`, font_size\: :ref:`int`\ ) Creates a local override for a theme font size with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_font_size_override`. @@ -2303,7 +2303,7 @@ See also :ref:`get_theme_font_size`. .. rst-class:: classref-method -void **add_theme_icon_override** **(** :ref:`StringName` name, :ref:`Texture2D` texture **)** +|void| **add_theme_icon_override**\ (\ name\: :ref:`StringName`, texture\: :ref:`Texture2D`\ ) Creates a local override for a theme icon with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_icon_override`. @@ -2317,7 +2317,7 @@ See also :ref:`get_theme_icon`. .. rst-class:: classref-method -void **add_theme_stylebox_override** **(** :ref:`StringName` name, :ref:`StyleBox` stylebox **)** +|void| **add_theme_stylebox_override**\ (\ name\: :ref:`StringName`, stylebox\: :ref:`StyleBox`\ ) Creates a local override for a theme :ref:`StyleBox` with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_stylebox_override`. @@ -2362,7 +2362,7 @@ See also :ref:`get_theme_stylebox`. .. rst-class:: classref-method -void **begin_bulk_theme_override** **(** **)** +|void| **begin_bulk_theme_override**\ (\ ) Prevents ``*_theme_*_override`` methods from emitting :ref:`NOTIFICATION_THEME_CHANGED` until :ref:`end_bulk_theme_override` is called. @@ -2374,7 +2374,7 @@ Prevents ``*_theme_*_override`` methods from emitting :ref:`NOTIFICATION_THEME_C .. rst-class:: classref-method -void **end_bulk_theme_override** **(** **)** +|void| **end_bulk_theme_override**\ (\ ) Ends a bulk theme override update. See :ref:`begin_bulk_theme_override`. @@ -2386,7 +2386,7 @@ Ends a bulk theme override update. See :ref:`begin_bulk_theme_override` **find_next_valid_focus** **(** **)** |const| +:ref:`Control` **find_next_valid_focus**\ (\ ) |const| Finds the next (below in the tree) **Control** that can receive the focus. @@ -2398,7 +2398,7 @@ Finds the next (below in the tree) **Control** that can receive the focus. .. rst-class:: classref-method -:ref:`Control` **find_prev_valid_focus** **(** **)** |const| +:ref:`Control` **find_prev_valid_focus**\ (\ ) |const| Finds the previous (above in the tree) **Control** that can receive the focus. @@ -2410,7 +2410,7 @@ Finds the previous (above in the tree) **Control** that can receive the focus. .. rst-class:: classref-method -:ref:`Control` **find_valid_focus_neighbor** **(** :ref:`Side` side **)** |const| +:ref:`Control` **find_valid_focus_neighbor**\ (\ side\: :ref:`Side`\ ) |const| Finds the next **Control** that can receive the focus on the specified :ref:`Side`. @@ -2424,7 +2424,7 @@ Finds the next **Control** that can receive the focus on the specified :ref:`Sid .. rst-class:: classref-method -void **force_drag** **(** :ref:`Variant` data, :ref:`Control` preview **)** +|void| **force_drag**\ (\ data\: :ref:`Variant`, preview\: :ref:`Control`\ ) Forces drag and bypasses :ref:`_get_drag_data` and :ref:`set_drag_preview` by passing ``data`` and ``preview``. Drag will start even if the mouse is neither over nor pressed on this control. @@ -2438,7 +2438,7 @@ The methods :ref:`_can_drop_data` a .. rst-class:: classref-method -:ref:`float` **get_anchor** **(** :ref:`Side` side **)** |const| +:ref:`float` **get_anchor**\ (\ side\: :ref:`Side`\ ) |const| Returns the anchor for the specified :ref:`Side`. A getter method for :ref:`anchor_bottom`, :ref:`anchor_left`, :ref:`anchor_right` and :ref:`anchor_top`. @@ -2450,7 +2450,7 @@ Returns the anchor for the specified :ref:`Side`. A gett .. rst-class:: classref-method -:ref:`Vector2` **get_begin** **(** **)** |const| +:ref:`Vector2` **get_begin**\ (\ ) |const| Returns :ref:`offset_left` and :ref:`offset_top`. See also :ref:`position`. @@ -2462,7 +2462,7 @@ Returns :ref:`offset_left` and :ref:`offset_ .. rst-class:: classref-method -:ref:`Vector2` **get_combined_minimum_size** **(** **)** |const| +:ref:`Vector2` **get_combined_minimum_size**\ (\ ) |const| Returns combined minimum size from :ref:`custom_minimum_size` and :ref:`get_minimum_size`. @@ -2474,7 +2474,7 @@ Returns combined minimum size from :ref:`custom_minimum_size` **get_cursor_shape** **(** :ref:`Vector2` position=Vector2(0, 0) **)** |const| +:ref:`CursorShape` **get_cursor_shape**\ (\ position\: :ref:`Vector2` = Vector2(0, 0)\ ) |const| Returns the mouse cursor shape the control displays on mouse hover. See :ref:`CursorShape`. @@ -2486,7 +2486,7 @@ Returns the mouse cursor shape the control displays on mouse hover. See :ref:`Cu .. rst-class:: classref-method -:ref:`Vector2` **get_end** **(** **)** |const| +:ref:`Vector2` **get_end**\ (\ ) |const| Returns :ref:`offset_right` and :ref:`offset_bottom`. @@ -2498,7 +2498,7 @@ Returns :ref:`offset_right` and :ref:`offse .. rst-class:: classref-method -:ref:`NodePath` **get_focus_neighbor** **(** :ref:`Side` side **)** |const| +:ref:`NodePath` **get_focus_neighbor**\ (\ side\: :ref:`Side`\ ) |const| Returns the focus neighbor for the specified :ref:`Side`. A getter method for :ref:`focus_neighbor_bottom`, :ref:`focus_neighbor_left`, :ref:`focus_neighbor_right` and :ref:`focus_neighbor_top`. @@ -2512,7 +2512,7 @@ Returns the focus neighbor for the specified :ref:`Side` .. rst-class:: classref-method -:ref:`Rect2` **get_global_rect** **(** **)** |const| +:ref:`Rect2` **get_global_rect**\ (\ ) |const| Returns the position and size of the control relative to the containing canvas. See :ref:`global_position` and :ref:`size`. @@ -2528,7 +2528,7 @@ Returns the position and size of the control relative to the containing canvas. .. rst-class:: classref-method -:ref:`Vector2` **get_minimum_size** **(** **)** |const| +:ref:`Vector2` **get_minimum_size**\ (\ ) |const| Returns the minimum size for this control. See :ref:`custom_minimum_size`. @@ -2540,7 +2540,7 @@ Returns the minimum size for this control. See :ref:`custom_minimum_size` **get_offset** **(** :ref:`Side` offset **)** |const| +:ref:`float` **get_offset**\ (\ offset\: :ref:`Side`\ ) |const| Returns the offset for the specified :ref:`Side`. A getter method for :ref:`offset_bottom`, :ref:`offset_left`, :ref:`offset_right` and :ref:`offset_top`. @@ -2552,7 +2552,7 @@ Returns the offset for the specified :ref:`Side`. A gett .. rst-class:: classref-method -:ref:`Vector2` **get_parent_area_size** **(** **)** |const| +:ref:`Vector2` **get_parent_area_size**\ (\ ) |const| Returns the width/height occupied in the parent control. @@ -2564,7 +2564,7 @@ Returns the width/height occupied in the parent control. .. rst-class:: classref-method -:ref:`Control` **get_parent_control** **(** **)** |const| +:ref:`Control` **get_parent_control**\ (\ ) |const| Returns the parent control node. @@ -2576,7 +2576,7 @@ Returns the parent control node. .. rst-class:: classref-method -:ref:`Rect2` **get_rect** **(** **)** |const| +:ref:`Rect2` **get_rect**\ (\ ) |const| Returns the position and size of the control in the coordinate system of the containing node. See :ref:`position`, :ref:`scale` and :ref:`size`. @@ -2592,7 +2592,7 @@ Returns the position and size of the control in the coordinate system of the con .. rst-class:: classref-method -:ref:`Vector2` **get_screen_position** **(** **)** |const| +:ref:`Vector2` **get_screen_position**\ (\ ) |const| Returns the position of this **Control** in global screen coordinates (i.e. taking window position into account). Mostly useful for editor plugins. @@ -2614,7 +2614,7 @@ Equals to :ref:`global_position` if the .. rst-class:: classref-method -:ref:`Color` **get_theme_color** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`Color` **get_theme_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns a :ref:`Color` from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a color item with the specified ``name`` and ``theme_type``. If ``theme_type`` is omitted the class name of the current control is used as the type, or :ref:`theme_type_variation` if it is defined. If the type is a class name its parent classes are also checked, in order of inheritance. If the type is a variation its base types are checked, in order of dependency, then the control's class name and its parent classes are checked. @@ -2651,7 +2651,7 @@ For the current control its local overrides are considered first (see :ref:`add_ .. rst-class:: classref-method -:ref:`int` **get_theme_constant** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`int` **get_theme_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns a constant from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a constant item with the specified ``name`` and ``theme_type``. @@ -2665,7 +2665,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`float` **get_theme_default_base_scale** **(** **)** |const| +:ref:`float` **get_theme_default_base_scale**\ (\ ) |const| Returns the default base scale value from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a valid :ref:`Theme.default_base_scale` value. @@ -2679,7 +2679,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`Font` **get_theme_default_font** **(** **)** |const| +:ref:`Font` **get_theme_default_font**\ (\ ) |const| Returns the default font from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a valid :ref:`Theme.default_font` value. @@ -2693,7 +2693,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`int` **get_theme_default_font_size** **(** **)** |const| +:ref:`int` **get_theme_default_font_size**\ (\ ) |const| Returns the default font size value from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a valid :ref:`Theme.default_font_size` value. @@ -2707,7 +2707,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`Font` **get_theme_font** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`Font` **get_theme_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns a :ref:`Font` from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a font item with the specified ``name`` and ``theme_type``. @@ -2721,7 +2721,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`int` **get_theme_font_size** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`int` **get_theme_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns a font size from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a font size item with the specified ``name`` and ``theme_type``. @@ -2735,7 +2735,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`Texture2D` **get_theme_icon** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`Texture2D` **get_theme_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns an icon from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has an icon item with the specified ``name`` and ``theme_type``. @@ -2749,7 +2749,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`StyleBox` **get_theme_stylebox** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`StyleBox` **get_theme_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns a :ref:`StyleBox` from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a stylebox item with the specified ``name`` and ``theme_type``. @@ -2763,7 +2763,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`String` **get_tooltip** **(** :ref:`Vector2` at_position=Vector2(0, 0) **)** |const| +:ref:`String` **get_tooltip**\ (\ at_position\: :ref:`Vector2` = Vector2(0, 0)\ ) |const| Returns the tooltip text for the position ``at_position`` in control's local coordinates, which will typically appear when the cursor is resting over this control. By default, it returns :ref:`tooltip_text`. @@ -2779,7 +2779,7 @@ This method can be overridden to customize its behavior. See :ref:`_get_tooltip< .. rst-class:: classref-method -void **grab_click_focus** **(** **)** +|void| **grab_click_focus**\ (\ ) Creates an :ref:`InputEventMouseButton` that attempts to click the control. If the event is received, the control acquires focus. @@ -2808,7 +2808,7 @@ Creates an :ref:`InputEventMouseButton` that attemp .. rst-class:: classref-method -void **grab_focus** **(** **)** +|void| **grab_focus**\ (\ ) Steal the focus from another control and become the focused control (see :ref:`focus_mode`). @@ -2822,7 +2822,7 @@ Steal the focus from another control and become the focused control (see :ref:`f .. rst-class:: classref-method -:ref:`bool` **has_focus** **(** **)** |const| +:ref:`bool` **has_focus**\ (\ ) |const| Returns ``true`` if this is the current focused control. See :ref:`focus_mode`. @@ -2834,7 +2834,7 @@ Returns ``true`` if this is the current focused control. See :ref:`focus_mode` **has_theme_color** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`bool` **has_theme_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a color item with the specified ``name`` and ``theme_type``. @@ -2848,7 +2848,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`bool` **has_theme_color_override** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_theme_color_override**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if there is a local override for a theme :ref:`Color` with the specified ``name`` in this **Control** node. @@ -2862,7 +2862,7 @@ See :ref:`add_theme_color_override` **has_theme_constant** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`bool` **has_theme_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a constant item with the specified ``name`` and ``theme_type``. @@ -2876,7 +2876,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`bool` **has_theme_constant_override** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_theme_constant_override**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if there is a local override for a theme constant with the specified ``name`` in this **Control** node. @@ -2890,7 +2890,7 @@ See :ref:`add_theme_constant_override` **has_theme_font** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`bool` **has_theme_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a font item with the specified ``name`` and ``theme_type``. @@ -2904,7 +2904,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`bool` **has_theme_font_override** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_theme_font_override**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if there is a local override for a theme :ref:`Font` with the specified ``name`` in this **Control** node. @@ -2918,7 +2918,7 @@ See :ref:`add_theme_font_override` .. rst-class:: classref-method -:ref:`bool` **has_theme_font_size** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`bool` **has_theme_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a font size item with the specified ``name`` and ``theme_type``. @@ -2932,7 +2932,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`bool` **has_theme_font_size_override** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_theme_font_size_override**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if there is a local override for a theme font size with the specified ``name`` in this **Control** node. @@ -2946,7 +2946,7 @@ See :ref:`add_theme_font_size_override` **has_theme_icon** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`bool` **has_theme_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns ``true`` if there is a matching :ref:`Theme` in the tree that has an icon item with the specified ``name`` and ``theme_type``. @@ -2960,7 +2960,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`bool` **has_theme_icon_override** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_theme_icon_override**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if there is a local override for a theme icon with the specified ``name`` in this **Control** node. @@ -2974,7 +2974,7 @@ See :ref:`add_theme_icon_override` .. rst-class:: classref-method -:ref:`bool` **has_theme_stylebox** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`bool` **has_theme_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a stylebox item with the specified ``name`` and ``theme_type``. @@ -2988,7 +2988,7 @@ See :ref:`get_theme_color` for details. .. rst-class:: classref-method -:ref:`bool` **has_theme_stylebox_override** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_theme_stylebox_override**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if there is a local override for a theme :ref:`StyleBox` with the specified ``name`` in this **Control** node. @@ -3002,7 +3002,7 @@ See :ref:`add_theme_stylebox_override` **is_drag_successful** **(** **)** |const| +:ref:`bool` **is_drag_successful**\ (\ ) |const| Returns ``true`` if a drag operation is successful. Alternative to :ref:`Viewport.gui_is_drag_successful`. @@ -3016,7 +3016,7 @@ Best used with :ref:`Node.NOTIFICATION_DRAG_END` **is_layout_rtl** **(** **)** |const| +:ref:`bool` **is_layout_rtl**\ (\ ) |const| Returns ``true`` if layout is right-to-left. @@ -3028,7 +3028,7 @@ Returns ``true`` if layout is right-to-left. .. rst-class:: classref-method -void **release_focus** **(** **)** +|void| **release_focus**\ (\ ) Give up the focus. No other control will be able to receive input. @@ -3040,7 +3040,7 @@ Give up the focus. No other control will be able to receive input. .. rst-class:: classref-method -void **remove_theme_color_override** **(** :ref:`StringName` name **)** +|void| **remove_theme_color_override**\ (\ name\: :ref:`StringName`\ ) Removes a local override for a theme :ref:`Color` with the specified ``name`` previously added by :ref:`add_theme_color_override` or via the Inspector dock. @@ -3052,7 +3052,7 @@ Removes a local override for a theme :ref:`Color` with the specifie .. rst-class:: classref-method -void **remove_theme_constant_override** **(** :ref:`StringName` name **)** +|void| **remove_theme_constant_override**\ (\ name\: :ref:`StringName`\ ) Removes a local override for a theme constant with the specified ``name`` previously added by :ref:`add_theme_constant_override` or via the Inspector dock. @@ -3064,7 +3064,7 @@ Removes a local override for a theme constant with the specified ``name`` previo .. rst-class:: classref-method -void **remove_theme_font_override** **(** :ref:`StringName` name **)** +|void| **remove_theme_font_override**\ (\ name\: :ref:`StringName`\ ) Removes a local override for a theme :ref:`Font` with the specified ``name`` previously added by :ref:`add_theme_font_override` or via the Inspector dock. @@ -3076,7 +3076,7 @@ Removes a local override for a theme :ref:`Font` with the specified .. rst-class:: classref-method -void **remove_theme_font_size_override** **(** :ref:`StringName` name **)** +|void| **remove_theme_font_size_override**\ (\ name\: :ref:`StringName`\ ) Removes a local override for a theme font size with the specified ``name`` previously added by :ref:`add_theme_font_size_override` or via the Inspector dock. @@ -3088,7 +3088,7 @@ Removes a local override for a theme font size with the specified ``name`` previ .. rst-class:: classref-method -void **remove_theme_icon_override** **(** :ref:`StringName` name **)** +|void| **remove_theme_icon_override**\ (\ name\: :ref:`StringName`\ ) Removes a local override for a theme icon with the specified ``name`` previously added by :ref:`add_theme_icon_override` or via the Inspector dock. @@ -3100,7 +3100,7 @@ Removes a local override for a theme icon with the specified ``name`` previously .. rst-class:: classref-method -void **remove_theme_stylebox_override** **(** :ref:`StringName` name **)** +|void| **remove_theme_stylebox_override**\ (\ name\: :ref:`StringName`\ ) Removes a local override for a theme :ref:`StyleBox` with the specified ``name`` previously added by :ref:`add_theme_stylebox_override` or via the Inspector dock. @@ -3112,7 +3112,7 @@ Removes a local override for a theme :ref:`StyleBox` with the sp .. rst-class:: classref-method -void **reset_size** **(** **)** +|void| **reset_size**\ (\ ) Resets the size to :ref:`get_combined_minimum_size`. This is equivalent to calling ``set_size(Vector2())`` (or any size below the minimum). @@ -3124,7 +3124,7 @@ Resets the size to :ref:`get_combined_minimum_size` side, :ref:`float` anchor, :ref:`bool` keep_offset=false, :ref:`bool` push_opposite_anchor=true **)** +|void| **set_anchor**\ (\ side\: :ref:`Side`, anchor\: :ref:`float`, keep_offset\: :ref:`bool` = false, push_opposite_anchor\: :ref:`bool` = true\ ) Sets the anchor for the specified :ref:`Side` to ``anchor``. A setter method for :ref:`anchor_bottom`, :ref:`anchor_left`, :ref:`anchor_right` and :ref:`anchor_top`. @@ -3140,7 +3140,7 @@ If ``push_opposite_anchor`` is ``true`` and the opposite anchor overlaps this an .. rst-class:: classref-method -void **set_anchor_and_offset** **(** :ref:`Side` side, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=false **)** +|void| **set_anchor_and_offset**\ (\ side\: :ref:`Side`, anchor\: :ref:`float`, offset\: :ref:`float`, push_opposite_anchor\: :ref:`bool` = false\ ) Works the same as :ref:`set_anchor`, but instead of ``keep_offset`` argument and automatic update of offset, it allows to set the offset yourself (see :ref:`set_offset`). @@ -3152,7 +3152,7 @@ Works the same as :ref:`set_anchor`, but instea .. rst-class:: classref-method -void **set_anchors_and_offsets_preset** **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** +|void| **set_anchors_and_offsets_preset**\ (\ preset\: :ref:`LayoutPreset`, resize_mode\: :ref:`LayoutPresetMode` = 0, margin\: :ref:`int` = 0\ ) Sets both anchor preset and offset preset. See :ref:`set_anchors_preset` and :ref:`set_offsets_preset`. @@ -3164,7 +3164,7 @@ Sets both anchor preset and offset preset. See :ref:`set_anchors_preset` preset, :ref:`bool` keep_offsets=false **)** +|void| **set_anchors_preset**\ (\ preset\: :ref:`LayoutPreset`, keep_offsets\: :ref:`bool` = false\ ) Sets the anchors to a ``preset`` from :ref:`LayoutPreset` enum. This is the code equivalent to using the Layout menu in the 2D editor. @@ -3178,7 +3178,7 @@ If ``keep_offsets`` is ``true``, control's position will also be updated. .. rst-class:: classref-method -void **set_begin** **(** :ref:`Vector2` position **)** +|void| **set_begin**\ (\ position\: :ref:`Vector2`\ ) Sets :ref:`offset_left` and :ref:`offset_top` at the same time. Equivalent of changing :ref:`position`. @@ -3190,7 +3190,7 @@ Sets :ref:`offset_left` and :ref:`offset_top .. rst-class:: classref-method -void **set_drag_forwarding** **(** :ref:`Callable` drag_func, :ref:`Callable` can_drop_func, :ref:`Callable` drop_func **)** +|void| **set_drag_forwarding**\ (\ drag_func\: :ref:`Callable`, can_drop_func\: :ref:`Callable`, drop_func\: :ref:`Callable`\ ) Forwards the handling of this control's :ref:`_get_drag_data`, :ref:`_can_drop_data` and :ref:`_drop_data` virtual functions to delegate callables. @@ -3206,7 +3206,7 @@ The function format for each callable should be exactly the same as the virtual .. rst-class:: classref-method -void **set_drag_preview** **(** :ref:`Control` control **)** +|void| **set_drag_preview**\ (\ control\: :ref:`Control`\ ) Shows the given control at the mouse pointer. A good time to call this method is in :ref:`_get_drag_data`. The control must not be in the scene tree. You should not free the control, and you should not keep a reference to the control beyond the duration of the drag. It will be deleted automatically after the drag has ended. @@ -3250,7 +3250,7 @@ Shows the given control at the mouse pointer. A good time to call this method is .. rst-class:: classref-method -void **set_end** **(** :ref:`Vector2` position **)** +|void| **set_end**\ (\ position\: :ref:`Vector2`\ ) Sets :ref:`offset_right` and :ref:`offset_bottom` at the same time. @@ -3262,7 +3262,7 @@ Sets :ref:`offset_right` and :ref:`offset_b .. rst-class:: classref-method -void **set_focus_neighbor** **(** :ref:`Side` side, :ref:`NodePath` neighbor **)** +|void| **set_focus_neighbor**\ (\ side\: :ref:`Side`, neighbor\: :ref:`NodePath`\ ) Sets the focus neighbor for the specified :ref:`Side` to the **Control** at ``neighbor`` node path. A setter method for :ref:`focus_neighbor_bottom`, :ref:`focus_neighbor_left`, :ref:`focus_neighbor_right` and :ref:`focus_neighbor_top`. @@ -3274,7 +3274,7 @@ Sets the focus neighbor for the specified :ref:`Side` to .. rst-class:: classref-method -void **set_global_position** **(** :ref:`Vector2` position, :ref:`bool` keep_offsets=false **)** +|void| **set_global_position**\ (\ position\: :ref:`Vector2`, keep_offsets\: :ref:`bool` = false\ ) Sets the :ref:`global_position` to given ``position``. @@ -3288,7 +3288,7 @@ If ``keep_offsets`` is ``true``, control's anchors will be updated instead of of .. rst-class:: classref-method -void **set_offset** **(** :ref:`Side` side, :ref:`float` offset **)** +|void| **set_offset**\ (\ side\: :ref:`Side`, offset\: :ref:`float`\ ) Sets the offset for the specified :ref:`Side` to ``offset``. A setter method for :ref:`offset_bottom`, :ref:`offset_left`, :ref:`offset_right` and :ref:`offset_top`. @@ -3300,7 +3300,7 @@ Sets the offset for the specified :ref:`Side` to ``offse .. rst-class:: classref-method -void **set_offsets_preset** **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** +|void| **set_offsets_preset**\ (\ preset\: :ref:`LayoutPreset`, resize_mode\: :ref:`LayoutPresetMode` = 0, margin\: :ref:`int` = 0\ ) Sets the offsets to a ``preset`` from :ref:`LayoutPreset` enum. This is the code equivalent to using the Layout menu in the 2D editor. @@ -3316,7 +3316,7 @@ Use parameter ``margin`` to determine the gap between the **Control** and the ed .. rst-class:: classref-method -void **set_position** **(** :ref:`Vector2` position, :ref:`bool` keep_offsets=false **)** +|void| **set_position**\ (\ position\: :ref:`Vector2`, keep_offsets\: :ref:`bool` = false\ ) Sets the :ref:`position` to given ``position``. @@ -3330,7 +3330,7 @@ If ``keep_offsets`` is ``true``, control's anchors will be updated instead of of .. rst-class:: classref-method -void **set_size** **(** :ref:`Vector2` size, :ref:`bool` keep_offsets=false **)** +|void| **set_size**\ (\ size\: :ref:`Vector2`, keep_offsets\: :ref:`bool` = false\ ) Sets the size (see :ref:`size`). @@ -3344,7 +3344,7 @@ If ``keep_offsets`` is ``true``, control's anchors will be updated instead of of .. rst-class:: classref-method -void **update_minimum_size** **(** **)** +|void| **update_minimum_size**\ (\ ) Invalidates the size cache in this node and in parent nodes up to top level. Intended to be used with :ref:`get_minimum_size` when the return value is changed. Setting :ref:`custom_minimum_size` directly calls this method automatically. @@ -3356,7 +3356,7 @@ Invalidates the size cache in this node and in parent nodes up to top level. Int .. rst-class:: classref-method -void **warp_mouse** **(** :ref:`Vector2` position **)** +|void| **warp_mouse**\ (\ position\: :ref:`Vector2`\ ) Moves the mouse cursor to ``position``, relative to :ref:`position` of this **Control**. @@ -3369,3 +3369,4 @@ Moves the mouse cursor to ``position``, relative to :ref:`position` **(** :ref:`PackedVector2Array` point_cloud **)** | - +------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_cloud`\ (\ point_cloud\: :ref:`PackedVector2Array`\ ) | + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -68,8 +68,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_points** **(** :ref:`PackedVector2Array` value **)** -- :ref:`PackedVector2Array` **get_points** **(** **)** +- |void| **set_points**\ (\ value\: :ref:`PackedVector2Array`\ ) +- :ref:`PackedVector2Array` **get_points**\ (\ ) The polygon's list of vertices that form a convex hull. Can be in either clockwise or counterclockwise order. @@ -88,7 +88,7 @@ Method Descriptions .. rst-class:: classref-method -void **set_point_cloud** **(** :ref:`PackedVector2Array` point_cloud **)** +|void| **set_point_cloud**\ (\ point_cloud\: :ref:`PackedVector2Array`\ ) Based on the set of points provided, this assigns the :ref:`points` property using the convex hull algorithm, removing all unneeded points. See :ref:`Geometry2D.convex_hull` for details. @@ -99,3 +99,4 @@ Based on the set of points provided, this assigns the :ref:`points` value **)** -- :ref:`PackedVector3Array` **get_points** **(** **)** +- |void| **set_points**\ (\ value\: :ref:`PackedVector3Array`\ ) +- :ref:`PackedVector3Array` **get_points**\ (\ ) The list of 3D points forming the convex polygon shape. @@ -75,3 +75,4 @@ The list of 3D points forming the convex polygon shape. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index 87857581595..2a57ce32b0a 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -178,27 +178,27 @@ Methods .. table:: :widths: auto - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`convert_from_particles` **(** :ref:`Node` particles **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Curve` | :ref:`get_param_curve` **(** :ref:`Parameter` param **)** |const| | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_param_max` **(** :ref:`Parameter` param **)** |const| | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_param_min` **(** :ref:`Parameter` param **)** |const| | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_particle_flag` **(** :ref:`ParticleFlags` particle_flag **)** |const| | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`restart` **(** **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_param_curve` **(** :ref:`Parameter` param, :ref:`Curve` curve **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_param_max` **(** :ref:`Parameter` param, :ref:`float` value **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_param_min` **(** :ref:`Parameter` param, :ref:`float` value **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_particle_flag` **(** :ref:`ParticleFlags` particle_flag, :ref:`bool` enable **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`convert_from_particles`\ (\ particles\: :ref:`Node`\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`get_param_curve`\ (\ param\: :ref:`Parameter`\ ) |const| | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_param_max`\ (\ param\: :ref:`Parameter`\ ) |const| | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_param_min`\ (\ param\: :ref:`Parameter`\ ) |const| | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_particle_flag`\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`restart`\ (\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_param_curve`\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_param_max`\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_param_min`\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_particle_flag`\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -213,7 +213,7 @@ Signals .. rst-class:: classref-signal -**finished** **(** **)** +**finished**\ (\ ) Emitted when all active particles have finished processing. When :ref:`one_shot` is disabled, particles will process continuously, so this is never emitted. @@ -487,8 +487,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_amount** **(** :ref:`int` value **)** -- :ref:`int` **get_amount** **(** **)** +- |void| **set_amount**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_amount**\ (\ ) Number of particles emitted in one emission cycle. @@ -504,8 +504,8 @@ Number of particles emitted in one emission cycle. .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's rotation will be animated along this :ref:`Curve`. @@ -521,8 +521,8 @@ Each particle's rotation will be animated along this :ref:`Curve`. .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum initial rotation applied to each particle, in degrees. @@ -538,8 +538,8 @@ Maximum initial rotation applied to each particle, in degrees. .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`angle_max`. @@ -555,8 +555,8 @@ Minimum equivalent of :ref:`angle_max`. .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's angular velocity will vary along this :ref:`Curve`. @@ -572,8 +572,8 @@ Each particle's angular velocity will vary along this :ref:`Curve`. .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum initial angular velocity (rotation speed) applied to each particle in *degrees* per second. @@ -589,8 +589,8 @@ Maximum initial angular velocity (rotation speed) applied to each particle in *d .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`angular_velocity_max`. @@ -606,8 +606,8 @@ Minimum equivalent of :ref:`angular_velocity_max` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's animation offset will vary along this :ref:`Curve`. @@ -623,8 +623,8 @@ Each particle's animation offset will vary along this :ref:`Curve`. .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum animation offset that corresponds to frame index in the texture. ``0`` is the first frame, ``1`` is the last one. See :ref:`CanvasItemMaterial.particles_animation`. @@ -640,8 +640,8 @@ Maximum animation offset that corresponds to frame index in the texture. ``0`` i .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`anim_offset_max`. @@ -657,8 +657,8 @@ Minimum equivalent of :ref:`anim_offset_max` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's animation speed will vary along this :ref:`Curve`. @@ -674,8 +674,8 @@ Each particle's animation speed will vary along this :ref:`Curve`. .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum particle animation speed. Animation speed of ``1`` means that the particles will make full ``0`` to ``1`` offset cycle during lifetime, ``2`` means ``2`` cycles etc. @@ -693,8 +693,8 @@ With animation speed greater than ``1``, remember to enable :ref:`CanvasItemMate .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`anim_speed_max`. @@ -710,8 +710,8 @@ Minimum equivalent of :ref:`anim_speed_max` value **)** -- :ref:`Color` **get_color** **(** **)** +- |void| **set_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_color**\ (\ ) Each particle's initial color. If :ref:`texture` is defined, it will be multiplied by this color. @@ -727,8 +727,8 @@ Each particle's initial color. If :ref:`texture` value **)** -- :ref:`Gradient` **get_color_initial_ramp** **(** **)** +- |void| **set_color_initial_ramp**\ (\ value\: :ref:`Gradient`\ ) +- :ref:`Gradient` **get_color_initial_ramp**\ (\ ) Each particle's initial color will vary along this :ref:`GradientTexture1D` (multiplied with :ref:`color`). @@ -744,8 +744,8 @@ Each particle's initial color will vary along this :ref:`GradientTexture1D` value **)** -- :ref:`Gradient` **get_color_ramp** **(** **)** +- |void| **set_color_ramp**\ (\ value\: :ref:`Gradient`\ ) +- :ref:`Gradient` **get_color_ramp**\ (\ ) Each particle's color will vary along this :ref:`Gradient` (multiplied with :ref:`color`). @@ -761,8 +761,8 @@ Each particle's color will vary along this :ref:`Gradient` (mult .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Damping will vary along this :ref:`Curve`. @@ -778,8 +778,8 @@ Damping will vary along this :ref:`Curve`. .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| The maximum rate at which particles lose velocity. For example value of ``100`` means that the particle will go from ``100`` velocity to ``0`` in ``1`` second. @@ -795,8 +795,8 @@ The maximum rate at which particles lose velocity. For example value of ``100`` .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`damping_max`. @@ -812,8 +812,8 @@ Minimum equivalent of :ref:`damping_max` value **)** -- :ref:`Vector2` **get_direction** **(** **)** +- |void| **set_direction**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_direction**\ (\ ) Unit vector specifying the particles' emission direction. @@ -829,8 +829,8 @@ Unit vector specifying the particles' emission direction. .. rst-class:: classref-property-setget -- void **set_draw_order** **(** :ref:`DrawOrder` value **)** -- :ref:`DrawOrder` **get_draw_order** **(** **)** +- |void| **set_draw_order**\ (\ value\: :ref:`DrawOrder`\ ) +- :ref:`DrawOrder` **get_draw_order**\ (\ ) Particle draw order. Uses :ref:`DrawOrder` values. @@ -846,8 +846,8 @@ Particle draw order. Uses :ref:`DrawOrder` values .. rst-class:: classref-property-setget -- void **set_emission_colors** **(** :ref:`PackedColorArray` value **)** -- :ref:`PackedColorArray` **get_emission_colors** **(** **)** +- |void| **set_emission_colors**\ (\ value\: :ref:`PackedColorArray`\ ) +- :ref:`PackedColorArray` **get_emission_colors**\ (\ ) Sets the :ref:`Color`\ s to modulate particles by when using :ref:`EMISSION_SHAPE_POINTS` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. @@ -863,8 +863,8 @@ Sets the :ref:`Color`\ s to modulate particles by when using :ref:` .. rst-class:: classref-property-setget -- void **set_emission_normals** **(** :ref:`PackedVector2Array` value **)** -- :ref:`PackedVector2Array` **get_emission_normals** **(** **)** +- |void| **set_emission_normals**\ (\ value\: :ref:`PackedVector2Array`\ ) +- :ref:`PackedVector2Array` **get_emission_normals**\ (\ ) Sets the direction the particles will be emitted in when using :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. @@ -880,8 +880,8 @@ Sets the direction the particles will be emitted in when using :ref:`EMISSION_SH .. rst-class:: classref-property-setget -- void **set_emission_points** **(** :ref:`PackedVector2Array` value **)** -- :ref:`PackedVector2Array` **get_emission_points** **(** **)** +- |void| **set_emission_points**\ (\ value\: :ref:`PackedVector2Array`\ ) +- :ref:`PackedVector2Array` **get_emission_points**\ (\ ) Sets the initial positions to spawn particles when using :ref:`EMISSION_SHAPE_POINTS` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. @@ -897,8 +897,8 @@ Sets the initial positions to spawn particles when using :ref:`EMISSION_SHAPE_PO .. rst-class:: classref-property-setget -- void **set_emission_rect_extents** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_emission_rect_extents** **(** **)** +- |void| **set_emission_rect_extents**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_emission_rect_extents**\ (\ ) The rectangle's extents if :ref:`emission_shape` is set to :ref:`EMISSION_SHAPE_RECTANGLE`. @@ -914,8 +914,8 @@ The rectangle's extents if :ref:`emission_shape` value **)** -- :ref:`EmissionShape` **get_emission_shape** **(** **)** +- |void| **set_emission_shape**\ (\ value\: :ref:`EmissionShape`\ ) +- :ref:`EmissionShape` **get_emission_shape**\ (\ ) Particles will be emitted inside this region. See :ref:`EmissionShape` for possible values. @@ -931,8 +931,8 @@ Particles will be emitted inside this region. See :ref:`EmissionShape` value **)** -- :ref:`float` **get_emission_sphere_radius** **(** **)** +- |void| **set_emission_sphere_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_emission_sphere_radius**\ (\ ) The sphere's radius if :ref:`emission_shape` is set to :ref:`EMISSION_SHAPE_SPHERE`. @@ -948,8 +948,8 @@ The sphere's radius if :ref:`emission_shape` value **)** -- :ref:`bool` **is_emitting** **(** **)** +- |void| **set_emitting**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_emitting**\ (\ ) If ``true``, particles are being emitted. :ref:`emitting` can be used to start and stop particles from emitting. However, if :ref:`one_shot` is ``true`` setting :ref:`emitting` to ``true`` will not restart the emission cycle until after all active particles finish processing. You can use the :ref:`finished` signal to be notified once all active particles finish processing. @@ -965,8 +965,8 @@ If ``true``, particles are being emitted. :ref:`emitting` value **)** -- :ref:`float` **get_explosiveness_ratio** **(** **)** +- |void| **set_explosiveness_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_explosiveness_ratio**\ (\ ) How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. @@ -982,8 +982,8 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t .. rst-class:: classref-property-setget -- void **set_fixed_fps** **(** :ref:`int` value **)** -- :ref:`int` **get_fixed_fps** **(** **)** +- |void| **set_fixed_fps**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_fixed_fps**\ (\ ) The particle system's frame rate is fixed to a value. For example, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. @@ -999,8 +999,8 @@ The particle system's frame rate is fixed to a value. For example, changing the .. rst-class:: classref-property-setget -- void **set_fractional_delta** **(** :ref:`bool` value **)** -- :ref:`bool` **get_fractional_delta** **(** **)** +- |void| **set_fractional_delta**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_fractional_delta**\ (\ ) If ``true``, results in fractional delta calculation which has a smoother particles display effect. @@ -1016,8 +1016,8 @@ If ``true``, results in fractional delta calculation which has a smoother partic .. rst-class:: classref-property-setget -- void **set_gravity** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_gravity** **(** **)** +- |void| **set_gravity**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_gravity**\ (\ ) Gravity applied to every particle. @@ -1033,8 +1033,8 @@ Gravity applied to every particle. .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's hue will vary along this :ref:`Curve`. @@ -1050,8 +1050,8 @@ Each particle's hue will vary along this :ref:`Curve`. .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum initial hue variation applied to each particle. It will shift the particle color's hue. @@ -1067,8 +1067,8 @@ Maximum initial hue variation applied to each particle. It will shift the partic .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`hue_variation_max`. @@ -1084,8 +1084,8 @@ Minimum equivalent of :ref:`hue_variation_max` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum initial velocity magnitude for each particle. Direction comes from :ref:`direction` and :ref:`spread`. @@ -1101,8 +1101,8 @@ Maximum initial velocity magnitude for each particle. Direction comes from :ref: .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`initial_velocity_max`. @@ -1118,8 +1118,8 @@ Minimum equivalent of :ref:`initial_velocity_max` value **)** -- :ref:`float` **get_lifetime** **(** **)** +- |void| **set_lifetime**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_lifetime**\ (\ ) Amount of time each particle will exist. @@ -1135,8 +1135,8 @@ Amount of time each particle will exist. .. rst-class:: classref-property-setget -- void **set_lifetime_randomness** **(** :ref:`float` value **)** -- :ref:`float` **get_lifetime_randomness** **(** **)** +- |void| **set_lifetime_randomness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_lifetime_randomness**\ (\ ) Particle lifetime randomness ratio. @@ -1152,8 +1152,8 @@ Particle lifetime randomness ratio. .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's linear acceleration will vary along this :ref:`Curve`. @@ -1169,8 +1169,8 @@ Each particle's linear acceleration will vary along this :ref:`Curve` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum linear acceleration applied to each particle in the direction of motion. @@ -1186,8 +1186,8 @@ Maximum linear acceleration applied to each particle in the direction of motion. .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`linear_accel_max`. @@ -1203,8 +1203,8 @@ Minimum equivalent of :ref:`linear_accel_max` value **)** -- :ref:`bool` **get_use_local_coordinates** **(** **)** +- |void| **set_use_local_coordinates**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_local_coordinates**\ (\ ) If ``true``, particles use the parent node's coordinate space (known as local coordinates). This will cause particles to move and rotate along the **CPUParticles2D** node (and its parents) when it is moved or rotated. If ``false``, particles use global coordinates; they will not move or rotate along the **CPUParticles2D** node (and its parents) when it is moved or rotated. @@ -1220,8 +1220,8 @@ If ``true``, particles use the parent node's coordinate space (known as local co .. rst-class:: classref-property-setget -- void **set_one_shot** **(** :ref:`bool` value **)** -- :ref:`bool` **get_one_shot** **(** **)** +- |void| **set_one_shot**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_one_shot**\ (\ ) If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. @@ -1237,8 +1237,8 @@ If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emi .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's orbital velocity will vary along this :ref:`Curve`. @@ -1254,8 +1254,8 @@ Each particle's orbital velocity will vary along this :ref:`Curve`. .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second. @@ -1271,8 +1271,8 @@ Maximum orbital velocity applied to each particle. Makes the particles circle ar .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`orbit_velocity_max`. @@ -1288,8 +1288,8 @@ Minimum equivalent of :ref:`orbit_velocity_max` particle_flag, :ref:`bool` enable **)** -- :ref:`bool` **get_particle_flag** **(** :ref:`ParticleFlags` particle_flag **)** |const| +- |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| Align Y axis of particle with the direction of its velocity. @@ -1305,8 +1305,8 @@ Align Y axis of particle with the direction of its velocity. .. rst-class:: classref-property-setget -- void **set_pre_process_time** **(** :ref:`float` value **)** -- :ref:`float` **get_pre_process_time** **(** **)** +- |void| **set_pre_process_time**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pre_process_time**\ (\ ) Particle system starts as if it had already run for this many seconds. @@ -1322,8 +1322,8 @@ Particle system starts as if it had already run for this many seconds. .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's radial acceleration will vary along this :ref:`Curve`. @@ -1339,8 +1339,8 @@ Each particle's radial acceleration will vary along this :ref:`Curve` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum radial acceleration applied to each particle. Makes particle accelerate away from the origin or towards it if negative. @@ -1356,8 +1356,8 @@ Maximum radial acceleration applied to each particle. Makes particle accelerate .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`radial_accel_max`. @@ -1373,8 +1373,8 @@ Minimum equivalent of :ref:`radial_accel_max` value **)** -- :ref:`float` **get_randomness_ratio** **(** **)** +- |void| **set_randomness_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_randomness_ratio**\ (\ ) Emission lifetime randomness ratio. @@ -1390,8 +1390,8 @@ Emission lifetime randomness ratio. .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's scale will vary along this :ref:`Curve`. @@ -1407,8 +1407,8 @@ Each particle's scale will vary along this :ref:`Curve`. .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum initial scale applied to each particle. @@ -1424,8 +1424,8 @@ Maximum initial scale applied to each particle. .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`scale_amount_max`. @@ -1441,8 +1441,8 @@ Minimum equivalent of :ref:`scale_amount_max` value **)** -- :ref:`Curve` **get_scale_curve_x** **(** **)** +- |void| **set_scale_curve_x**\ (\ value\: :ref:`Curve`\ ) +- :ref:`Curve` **get_scale_curve_x**\ (\ ) Each particle's horizontal scale will vary along this :ref:`Curve`. @@ -1460,8 +1460,8 @@ Each particle's horizontal scale will vary along this :ref:`Curve`. .. rst-class:: classref-property-setget -- void **set_scale_curve_y** **(** :ref:`Curve` value **)** -- :ref:`Curve` **get_scale_curve_y** **(** **)** +- |void| **set_scale_curve_y**\ (\ value\: :ref:`Curve`\ ) +- :ref:`Curve` **get_scale_curve_y**\ (\ ) Each particle's vertical scale will vary along this :ref:`Curve`. @@ -1479,8 +1479,8 @@ Each particle's vertical scale will vary along this :ref:`Curve`. .. rst-class:: classref-property-setget -- void **set_speed_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_speed_scale** **(** **)** +- |void| **set_speed_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_speed_scale**\ (\ ) Particle system's running speed scaling ratio. A value of ``0`` can be used to pause the particles. @@ -1496,8 +1496,8 @@ Particle system's running speed scaling ratio. A value of ``0`` can be used to p .. rst-class:: classref-property-setget -- void **set_split_scale** **(** :ref:`bool` value **)** -- :ref:`bool` **get_split_scale** **(** **)** +- |void| **set_split_scale**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_split_scale**\ (\ ) If ``true``, the scale curve will be split into x and y components. See :ref:`scale_curve_x` and :ref:`scale_curve_y`. @@ -1513,8 +1513,8 @@ If ``true``, the scale curve will be split into x and y components. See :ref:`sc .. rst-class:: classref-property-setget -- void **set_spread** **(** :ref:`float` value **)** -- :ref:`float` **get_spread** **(** **)** +- |void| **set_spread**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_spread**\ (\ ) Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. @@ -1530,8 +1530,8 @@ Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's tangential acceleration will vary along this :ref:`Curve`. @@ -1547,8 +1547,8 @@ Each particle's tangential acceleration will vary along this :ref:`Curve` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. @@ -1564,8 +1564,8 @@ Maximum tangential acceleration applied to each particle. Tangential acceleratio .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`tangential_accel_max`. @@ -1581,8 +1581,8 @@ Minimum equivalent of :ref:`tangential_accel_max` value **)** -- :ref:`Texture2D` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ ) Particle texture. If ``null``, particles will be squares. @@ -1599,7 +1599,7 @@ Method Descriptions .. rst-class:: classref-method -void **convert_from_particles** **(** :ref:`Node` particles **)** +|void| **convert_from_particles**\ (\ particles\: :ref:`Node`\ ) Sets this node's properties to match a given :ref:`GPUParticles2D` node with an assigned :ref:`ParticleProcessMaterial`. @@ -1611,7 +1611,7 @@ Sets this node's properties to match a given :ref:`GPUParticles2D` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +:ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Returns the :ref:`Curve` of the parameter specified by :ref:`Parameter`. @@ -1623,7 +1623,7 @@ Returns the :ref:`Curve` of the parameter specified by :ref:`Parame .. rst-class:: classref-method -:ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +:ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Returns the maximum value range for the given parameter. @@ -1635,7 +1635,7 @@ Returns the maximum value range for the given parameter. .. rst-class:: classref-method -:ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +:ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Returns the minimum value range for the given parameter. @@ -1647,7 +1647,7 @@ Returns the minimum value range for the given parameter. .. rst-class:: classref-method -:ref:`bool` **get_particle_flag** **(** :ref:`ParticleFlags` particle_flag **)** |const| +:ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| Returns the enabled state of the given flag (see :ref:`ParticleFlags` for options). @@ -1659,7 +1659,7 @@ Returns the enabled state of the given flag (see :ref:`ParticleFlags` param, :ref:`Curve` curve **)** +|void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) Sets the :ref:`Curve` of the parameter specified by :ref:`Parameter`. @@ -1683,7 +1683,7 @@ Sets the :ref:`Curve` of the parameter specified by :ref:`Parameter .. rst-class:: classref-method -void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** +|void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) Sets the maximum value for the given parameter. @@ -1695,7 +1695,7 @@ Sets the maximum value for the given parameter. .. rst-class:: classref-method -void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** +|void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) Sets the minimum value for the given parameter. @@ -1707,7 +1707,7 @@ Sets the minimum value for the given parameter. .. rst-class:: classref-method -void **set_particle_flag** **(** :ref:`ParticleFlags` particle_flag, :ref:`bool` enable **)** +|void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) Enables or disables the given flag (see :ref:`ParticleFlags` for options). @@ -1718,3 +1718,4 @@ Enables or disables the given flag (see :ref:`ParticleFlags` | :ref:`amount` | ``8`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Curve` | :ref:`angle_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`angle_max` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`angle_min` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Curve` | :ref:`angular_velocity_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`angular_velocity_max` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`angular_velocity_min` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Curve` | :ref:`anim_offset_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`anim_offset_max` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`anim_offset_min` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Curve` | :ref:`anim_speed_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`anim_speed_max` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`anim_speed_min` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Color` | :ref:`color` | ``Color(1, 1, 1, 1)`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Gradient` | :ref:`color_initial_ramp` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Gradient` | :ref:`color_ramp` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Curve` | :ref:`damping_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`damping_max` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`damping_min` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Vector3` | :ref:`direction` | ``Vector3(1, 0, 0)`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`DrawOrder` | :ref:`draw_order` | ``0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Vector3` | :ref:`emission_box_extents` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`PackedColorArray` | :ref:`emission_colors` | ``PackedColorArray()`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`PackedVector3Array` | :ref:`emission_normals` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`PackedVector3Array` | :ref:`emission_points` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Vector3` | :ref:`emission_ring_axis` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`emission_ring_height` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`emission_ring_inner_radius` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`emission_ring_radius` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`EmissionShape` | :ref:`emission_shape` | ``0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`emission_sphere_radius` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`bool` | :ref:`emitting` | ``true`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`explosiveness` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`int` | :ref:`fixed_fps` | ``0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`flatness` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`bool` | :ref:`fract_delta` | ``true`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Vector3` | :ref:`gravity` | ``Vector3(0, -9.8, 0)`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Curve` | :ref:`hue_variation_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`hue_variation_max` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`hue_variation_min` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`initial_velocity_max` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`initial_velocity_min` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`lifetime` | ``1.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`lifetime_randomness` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Curve` | :ref:`linear_accel_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`linear_accel_max` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`linear_accel_min` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`bool` | :ref:`local_coords` | ``false`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Mesh` | :ref:`mesh` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`bool` | :ref:`one_shot` | ``false`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Curve` | :ref:`orbit_velocity_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`orbit_velocity_max` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`orbit_velocity_min` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`bool` | :ref:`particle_flag_align_y` | ``false`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`bool` | :ref:`particle_flag_disable_z` | ``false`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`bool` | :ref:`particle_flag_rotate_y` | ``false`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`preprocess` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Curve` | :ref:`radial_accel_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`radial_accel_max` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`radial_accel_min` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`randomness` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Curve` | :ref:`scale_amount_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`scale_amount_max` | ``1.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`scale_amount_min` | ``1.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Curve` | :ref:`scale_curve_x` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Curve` | :ref:`scale_curve_y` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Curve` | :ref:`scale_curve_z` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`speed_scale` | ``1.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`bool` | :ref:`split_scale` | ``false`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`spread` | ``45.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`Curve` | :ref:`tangential_accel_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`tangential_accel_max` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`float` | :ref:`tangential_accel_min` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ - | :ref:`AABB` | :ref:`visibility_aabb` | ``AABB(-4, -4, -4, 8, 8, 8)`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------------+ + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`int` | :ref:`amount` | ``8`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Curve` | :ref:`angle_curve` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`angle_max` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`angle_min` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Curve` | :ref:`angular_velocity_curve` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`angular_velocity_max` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`angular_velocity_min` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Curve` | :ref:`anim_offset_curve` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`anim_offset_max` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`anim_offset_min` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Curve` | :ref:`anim_speed_curve` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`anim_speed_max` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`anim_speed_min` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Color` | :ref:`color` | ``Color(1, 1, 1, 1)`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Gradient` | :ref:`color_initial_ramp` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Gradient` | :ref:`color_ramp` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Curve` | :ref:`damping_curve` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`damping_max` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`damping_min` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Vector3` | :ref:`direction` | ``Vector3(1, 0, 0)`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`DrawOrder` | :ref:`draw_order` | ``0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Vector3` | :ref:`emission_box_extents` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`PackedColorArray` | :ref:`emission_colors` | ``PackedColorArray()`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`PackedVector3Array` | :ref:`emission_normals` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`PackedVector3Array` | :ref:`emission_points` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Vector3` | :ref:`emission_ring_axis` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`emission_ring_height` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`emission_ring_inner_radius` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`emission_ring_radius` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`EmissionShape` | :ref:`emission_shape` | ``0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`emission_sphere_radius` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`bool` | :ref:`emitting` | ``true`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`explosiveness` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`int` | :ref:`fixed_fps` | ``0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`flatness` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`bool` | :ref:`fract_delta` | ``true`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Vector3` | :ref:`gravity` | ``Vector3(0, -9.8, 0)`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Curve` | :ref:`hue_variation_curve` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`hue_variation_max` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`hue_variation_min` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`initial_velocity_max` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`initial_velocity_min` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`lifetime` | ``1.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`lifetime_randomness` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Curve` | :ref:`linear_accel_curve` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`linear_accel_max` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`linear_accel_min` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`bool` | :ref:`local_coords` | ``false`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Mesh` | :ref:`mesh` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`bool` | :ref:`one_shot` | ``false`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Curve` | :ref:`orbit_velocity_curve` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`orbit_velocity_max` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`orbit_velocity_min` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`bool` | :ref:`particle_flag_align_y` | ``false`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`bool` | :ref:`particle_flag_disable_z` | ``false`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`bool` | :ref:`particle_flag_rotate_y` | ``false`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`preprocess` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Curve` | :ref:`radial_accel_curve` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`radial_accel_max` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`radial_accel_min` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`randomness` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Curve` | :ref:`scale_amount_curve` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`scale_amount_max` | ``1.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`scale_amount_min` | ``1.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Curve` | :ref:`scale_curve_x` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Curve` | :ref:`scale_curve_y` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Curve` | :ref:`scale_curve_z` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`speed_scale` | ``1.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`bool` | :ref:`split_scale` | ``false`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`spread` | ``45.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`Curve` | :ref:`tangential_accel_curve` | | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`tangential_accel_max` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`float` | :ref:`tangential_accel_min` | ``0.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ + | :ref:`AABB` | :ref:`visibility_aabb` | ``AABB(0, 0, 0, 0, 0, 0)`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ .. rst-class:: classref-reftable-group @@ -196,27 +196,27 @@ Methods .. table:: :widths: auto - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`convert_from_particles` **(** :ref:`Node` particles **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Curve` | :ref:`get_param_curve` **(** :ref:`Parameter` param **)** |const| | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_param_max` **(** :ref:`Parameter` param **)** |const| | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_param_min` **(** :ref:`Parameter` param **)** |const| | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_particle_flag` **(** :ref:`ParticleFlags` particle_flag **)** |const| | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`restart` **(** **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_param_curve` **(** :ref:`Parameter` param, :ref:`Curve` curve **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_param_max` **(** :ref:`Parameter` param, :ref:`float` value **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_param_min` **(** :ref:`Parameter` param, :ref:`float` value **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_particle_flag` **(** :ref:`ParticleFlags` particle_flag, :ref:`bool` enable **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`convert_from_particles`\ (\ particles\: :ref:`Node`\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`get_param_curve`\ (\ param\: :ref:`Parameter`\ ) |const| | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_param_max`\ (\ param\: :ref:`Parameter`\ ) |const| | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_param_min`\ (\ param\: :ref:`Parameter`\ ) |const| | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_particle_flag`\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`restart`\ (\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_param_curve`\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_param_max`\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_param_min`\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_particle_flag`\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -231,7 +231,7 @@ Signals .. rst-class:: classref-signal -**finished** **(** **)** +**finished**\ (\ ) Emitted when all active particles have finished processing. When :ref:`one_shot` is disabled, particles will process continuously, so this is never emitted. @@ -521,8 +521,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_amount** **(** :ref:`int` value **)** -- :ref:`int` **get_amount** **(** **)** +- |void| **set_amount**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_amount**\ (\ ) Number of particles emitted in one emission cycle. @@ -538,8 +538,8 @@ Number of particles emitted in one emission cycle. .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's rotation will be animated along this :ref:`Curve`. @@ -555,8 +555,8 @@ Each particle's rotation will be animated along this :ref:`Curve`. .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum angle. @@ -572,8 +572,8 @@ Maximum angle. .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum angle. @@ -589,8 +589,8 @@ Minimum angle. .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's angular velocity (rotation speed) will vary along this :ref:`Curve` over its lifetime. @@ -606,8 +606,8 @@ Each particle's angular velocity (rotation speed) will vary along this :ref:`Cur .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum initial angular velocity (rotation speed) applied to each particle in *degrees* per second. @@ -623,8 +623,8 @@ Maximum initial angular velocity (rotation speed) applied to each particle in *d .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum initial angular velocity (rotation speed) applied to each particle in *degrees* per second. @@ -640,8 +640,8 @@ Minimum initial angular velocity (rotation speed) applied to each particle in *d .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's animation offset will vary along this :ref:`Curve`. @@ -657,8 +657,8 @@ Each particle's animation offset will vary along this :ref:`Curve`. .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum animation offset. @@ -674,8 +674,8 @@ Maximum animation offset. .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum animation offset. @@ -691,8 +691,8 @@ Minimum animation offset. .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's animation speed will vary along this :ref:`Curve`. @@ -708,8 +708,8 @@ Each particle's animation speed will vary along this :ref:`Curve`. .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum particle animation speed. @@ -725,8 +725,8 @@ Maximum particle animation speed. .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum particle animation speed. @@ -742,8 +742,8 @@ Minimum particle animation speed. .. rst-class:: classref-property-setget -- void **set_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_color** **(** **)** +- |void| **set_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_color**\ (\ ) Each particle's initial color. @@ -761,8 +761,8 @@ Each particle's initial color. .. rst-class:: classref-property-setget -- void **set_color_initial_ramp** **(** :ref:`Gradient` value **)** -- :ref:`Gradient` **get_color_initial_ramp** **(** **)** +- |void| **set_color_initial_ramp**\ (\ value\: :ref:`Gradient`\ ) +- :ref:`Gradient` **get_color_initial_ramp**\ (\ ) Each particle's initial color will vary along this :ref:`GradientTexture1D` (multiplied with :ref:`color`). @@ -780,8 +780,8 @@ Each particle's initial color will vary along this :ref:`GradientTexture1D` value **)** -- :ref:`Gradient` **get_color_ramp** **(** **)** +- |void| **set_color_ramp**\ (\ value\: :ref:`Gradient`\ ) +- :ref:`Gradient` **get_color_ramp**\ (\ ) Each particle's color will vary along this :ref:`GradientTexture1D` over its lifetime (multiplied with :ref:`color`). @@ -799,8 +799,8 @@ Each particle's color will vary along this :ref:`GradientTexture1D` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Damping will vary along this :ref:`Curve`. @@ -816,8 +816,8 @@ Damping will vary along this :ref:`Curve`. .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum damping. @@ -833,8 +833,8 @@ Maximum damping. .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum damping. @@ -850,8 +850,8 @@ Minimum damping. .. rst-class:: classref-property-setget -- void **set_direction** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_direction** **(** **)** +- |void| **set_direction**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_direction**\ (\ ) Unit vector specifying the particles' emission direction. @@ -867,8 +867,8 @@ Unit vector specifying the particles' emission direction. .. rst-class:: classref-property-setget -- void **set_draw_order** **(** :ref:`DrawOrder` value **)** -- :ref:`DrawOrder` **get_draw_order** **(** **)** +- |void| **set_draw_order**\ (\ value\: :ref:`DrawOrder`\ ) +- :ref:`DrawOrder` **get_draw_order**\ (\ ) Particle draw order. Uses :ref:`DrawOrder` values. @@ -884,8 +884,8 @@ Particle draw order. Uses :ref:`DrawOrder` values .. rst-class:: classref-property-setget -- void **set_emission_box_extents** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_emission_box_extents** **(** **)** +- |void| **set_emission_box_extents**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_emission_box_extents**\ (\ ) The rectangle's extents if :ref:`emission_shape` is set to :ref:`EMISSION_SHAPE_BOX`. @@ -901,8 +901,8 @@ The rectangle's extents if :ref:`emission_shape` value **)** -- :ref:`PackedColorArray` **get_emission_colors** **(** **)** +- |void| **set_emission_colors**\ (\ value\: :ref:`PackedColorArray`\ ) +- :ref:`PackedColorArray` **get_emission_colors**\ (\ ) Sets the :ref:`Color`\ s to modulate particles by when using :ref:`EMISSION_SHAPE_POINTS` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. @@ -920,8 +920,8 @@ Sets the :ref:`Color`\ s to modulate particles by when using :ref:` .. rst-class:: classref-property-setget -- void **set_emission_normals** **(** :ref:`PackedVector3Array` value **)** -- :ref:`PackedVector3Array` **get_emission_normals** **(** **)** +- |void| **set_emission_normals**\ (\ value\: :ref:`PackedVector3Array`\ ) +- :ref:`PackedVector3Array` **get_emission_normals**\ (\ ) Sets the direction the particles will be emitted in when using :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. @@ -937,8 +937,8 @@ Sets the direction the particles will be emitted in when using :ref:`EMISSION_SH .. rst-class:: classref-property-setget -- void **set_emission_points** **(** :ref:`PackedVector3Array` value **)** -- :ref:`PackedVector3Array` **get_emission_points** **(** **)** +- |void| **set_emission_points**\ (\ value\: :ref:`PackedVector3Array`\ ) +- :ref:`PackedVector3Array` **get_emission_points**\ (\ ) Sets the initial positions to spawn particles when using :ref:`EMISSION_SHAPE_POINTS` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. @@ -954,8 +954,8 @@ Sets the initial positions to spawn particles when using :ref:`EMISSION_SHAPE_PO .. rst-class:: classref-property-setget -- void **set_emission_ring_axis** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_emission_ring_axis** **(** **)** +- |void| **set_emission_ring_axis**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_emission_ring_axis**\ (\ ) The axis of the ring when using the emitter :ref:`EMISSION_SHAPE_RING`. @@ -971,8 +971,8 @@ The axis of the ring when using the emitter :ref:`EMISSION_SHAPE_RING` value **)** -- :ref:`float` **get_emission_ring_height** **(** **)** +- |void| **set_emission_ring_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_emission_ring_height**\ (\ ) The height of the ring when using the emitter :ref:`EMISSION_SHAPE_RING`. @@ -988,8 +988,8 @@ The height of the ring when using the emitter :ref:`EMISSION_SHAPE_RING` value **)** -- :ref:`float` **get_emission_ring_inner_radius** **(** **)** +- |void| **set_emission_ring_inner_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_emission_ring_inner_radius**\ (\ ) The inner radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING`. @@ -1005,8 +1005,8 @@ The inner radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING` value **)** -- :ref:`float` **get_emission_ring_radius** **(** **)** +- |void| **set_emission_ring_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_emission_ring_radius**\ (\ ) The radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING`. @@ -1022,8 +1022,8 @@ The radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING` value **)** -- :ref:`EmissionShape` **get_emission_shape** **(** **)** +- |void| **set_emission_shape**\ (\ value\: :ref:`EmissionShape`\ ) +- :ref:`EmissionShape` **get_emission_shape**\ (\ ) Particles will be emitted inside this region. See :ref:`EmissionShape` for possible values. @@ -1039,8 +1039,8 @@ Particles will be emitted inside this region. See :ref:`EmissionShape` value **)** -- :ref:`float` **get_emission_sphere_radius** **(** **)** +- |void| **set_emission_sphere_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_emission_sphere_radius**\ (\ ) The sphere's radius if :ref:`EmissionShape` is set to :ref:`EMISSION_SHAPE_SPHERE`. @@ -1056,8 +1056,8 @@ The sphere's radius if :ref:`EmissionShape` i .. rst-class:: classref-property-setget -- void **set_emitting** **(** :ref:`bool` value **)** -- :ref:`bool` **is_emitting** **(** **)** +- |void| **set_emitting**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_emitting**\ (\ ) If ``true``, particles are being emitted. :ref:`emitting` can be used to start and stop particles from emitting. However, if :ref:`one_shot` is ``true`` setting :ref:`emitting` to ``true`` will not restart the emission cycle until after all active particles finish processing. You can use the :ref:`finished` signal to be notified once all active particles finish processing. @@ -1073,8 +1073,8 @@ If ``true``, particles are being emitted. :ref:`emitting` value **)** -- :ref:`float` **get_explosiveness_ratio** **(** **)** +- |void| **set_explosiveness_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_explosiveness_ratio**\ (\ ) How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. @@ -1090,8 +1090,8 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t .. rst-class:: classref-property-setget -- void **set_fixed_fps** **(** :ref:`int` value **)** -- :ref:`int` **get_fixed_fps** **(** **)** +- |void| **set_fixed_fps**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_fixed_fps**\ (\ ) The particle system's frame rate is fixed to a value. For example, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the particle system itself. @@ -1107,8 +1107,8 @@ The particle system's frame rate is fixed to a value. For example, changing the .. rst-class:: classref-property-setget -- void **set_flatness** **(** :ref:`float` value **)** -- :ref:`float` **get_flatness** **(** **)** +- |void| **set_flatness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_flatness**\ (\ ) Amount of :ref:`spread` in Y/Z plane. A value of ``1`` restricts particles to X/Z plane. @@ -1124,8 +1124,8 @@ Amount of :ref:`spread` in Y/Z plane. A va .. rst-class:: classref-property-setget -- void **set_fractional_delta** **(** :ref:`bool` value **)** -- :ref:`bool` **get_fractional_delta** **(** **)** +- |void| **set_fractional_delta**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_fractional_delta**\ (\ ) If ``true``, results in fractional delta calculation which has a smoother particles display effect. @@ -1141,8 +1141,8 @@ If ``true``, results in fractional delta calculation which has a smoother partic .. rst-class:: classref-property-setget -- void **set_gravity** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_gravity** **(** **)** +- |void| **set_gravity**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_gravity**\ (\ ) Gravity applied to every particle. @@ -1158,8 +1158,8 @@ Gravity applied to every particle. .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's hue will vary along this :ref:`Curve`. @@ -1175,8 +1175,8 @@ Each particle's hue will vary along this :ref:`Curve`. .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum hue variation. @@ -1192,8 +1192,8 @@ Maximum hue variation. .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum hue variation. @@ -1209,8 +1209,8 @@ Minimum hue variation. .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum value of the initial velocity. @@ -1226,8 +1226,8 @@ Maximum value of the initial velocity. .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum value of the initial velocity. @@ -1243,8 +1243,8 @@ Minimum value of the initial velocity. .. rst-class:: classref-property-setget -- void **set_lifetime** **(** :ref:`float` value **)** -- :ref:`float` **get_lifetime** **(** **)** +- |void| **set_lifetime**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_lifetime**\ (\ ) Amount of time each particle will exist. @@ -1260,8 +1260,8 @@ Amount of time each particle will exist. .. rst-class:: classref-property-setget -- void **set_lifetime_randomness** **(** :ref:`float` value **)** -- :ref:`float` **get_lifetime_randomness** **(** **)** +- |void| **set_lifetime_randomness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_lifetime_randomness**\ (\ ) Particle lifetime randomness ratio. @@ -1277,8 +1277,8 @@ Particle lifetime randomness ratio. .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's linear acceleration will vary along this :ref:`Curve`. @@ -1294,8 +1294,8 @@ Each particle's linear acceleration will vary along this :ref:`Curve` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum linear acceleration. @@ -1311,8 +1311,8 @@ Maximum linear acceleration. .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum linear acceleration. @@ -1328,8 +1328,8 @@ Minimum linear acceleration. .. rst-class:: classref-property-setget -- void **set_use_local_coordinates** **(** :ref:`bool` value **)** -- :ref:`bool` **get_use_local_coordinates** **(** **)** +- |void| **set_use_local_coordinates**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_local_coordinates**\ (\ ) If ``true``, particles use the parent node's coordinate space (known as local coordinates). This will cause particles to move and rotate along the **CPUParticles3D** node (and its parents) when it is moved or rotated. If ``false``, particles use global coordinates; they will not move or rotate along the **CPUParticles3D** node (and its parents) when it is moved or rotated. @@ -1345,8 +1345,8 @@ If ``true``, particles use the parent node's coordinate space (known as local co .. rst-class:: classref-property-setget -- void **set_mesh** **(** :ref:`Mesh` value **)** -- :ref:`Mesh` **get_mesh** **(** **)** +- |void| **set_mesh**\ (\ value\: :ref:`Mesh`\ ) +- :ref:`Mesh` **get_mesh**\ (\ ) The :ref:`Mesh` used for each particle. If ``null``, particles will be spheres. @@ -1362,8 +1362,8 @@ The :ref:`Mesh` used for each particle. If ``null``, particles will .. rst-class:: classref-property-setget -- void **set_one_shot** **(** :ref:`bool` value **)** -- :ref:`bool` **get_one_shot** **(** **)** +- |void| **set_one_shot**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_one_shot**\ (\ ) If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. @@ -1379,8 +1379,8 @@ If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emi .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's orbital velocity will vary along this :ref:`Curve`. @@ -1396,8 +1396,8 @@ Each particle's orbital velocity will vary along this :ref:`Curve`. .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum orbit velocity. @@ -1413,8 +1413,8 @@ Maximum orbit velocity. .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum orbit velocity. @@ -1430,8 +1430,8 @@ Minimum orbit velocity. .. rst-class:: classref-property-setget -- void **set_particle_flag** **(** :ref:`ParticleFlags` particle_flag, :ref:`bool` enable **)** -- :ref:`bool` **get_particle_flag** **(** :ref:`ParticleFlags` particle_flag **)** |const| +- |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| Align Y axis of particle with the direction of its velocity. @@ -1447,8 +1447,8 @@ Align Y axis of particle with the direction of its velocity. .. rst-class:: classref-property-setget -- void **set_particle_flag** **(** :ref:`ParticleFlags` particle_flag, :ref:`bool` enable **)** -- :ref:`bool` **get_particle_flag** **(** :ref:`ParticleFlags` particle_flag **)** |const| +- |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| If ``true``, particles will not move on the Z axis. @@ -1464,8 +1464,8 @@ If ``true``, particles will not move on the Z axis. .. rst-class:: classref-property-setget -- void **set_particle_flag** **(** :ref:`ParticleFlags` particle_flag, :ref:`bool` enable **)** -- :ref:`bool` **get_particle_flag** **(** :ref:`ParticleFlags` particle_flag **)** |const| +- |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| If ``true``, particles rotate around Y axis by :ref:`angle_min`. @@ -1481,8 +1481,8 @@ If ``true``, particles rotate around Y axis by :ref:`angle_min` value **)** -- :ref:`float` **get_pre_process_time** **(** **)** +- |void| **set_pre_process_time**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pre_process_time**\ (\ ) Particle system starts as if it had already run for this many seconds. @@ -1498,8 +1498,8 @@ Particle system starts as if it had already run for this many seconds. .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's radial acceleration will vary along this :ref:`Curve`. @@ -1515,8 +1515,8 @@ Each particle's radial acceleration will vary along this :ref:`Curve` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum radial acceleration. @@ -1532,8 +1532,8 @@ Maximum radial acceleration. .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum radial acceleration. @@ -1549,8 +1549,8 @@ Minimum radial acceleration. .. rst-class:: classref-property-setget -- void **set_randomness_ratio** **(** :ref:`float` value **)** -- :ref:`float` **get_randomness_ratio** **(** **)** +- |void| **set_randomness_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_randomness_ratio**\ (\ ) Emission lifetime randomness ratio. @@ -1566,8 +1566,8 @@ Emission lifetime randomness ratio. .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's scale will vary along this :ref:`Curve`. @@ -1583,8 +1583,8 @@ Each particle's scale will vary along this :ref:`Curve`. .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum scale. @@ -1600,8 +1600,8 @@ Maximum scale. .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum scale. @@ -1617,8 +1617,8 @@ Minimum scale. .. rst-class:: classref-property-setget -- void **set_scale_curve_x** **(** :ref:`Curve` value **)** -- :ref:`Curve` **get_scale_curve_x** **(** **)** +- |void| **set_scale_curve_x**\ (\ value\: :ref:`Curve`\ ) +- :ref:`Curve` **get_scale_curve_x**\ (\ ) Curve for the scale over life, along the x axis. @@ -1634,8 +1634,8 @@ Curve for the scale over life, along the x axis. .. rst-class:: classref-property-setget -- void **set_scale_curve_y** **(** :ref:`Curve` value **)** -- :ref:`Curve` **get_scale_curve_y** **(** **)** +- |void| **set_scale_curve_y**\ (\ value\: :ref:`Curve`\ ) +- :ref:`Curve` **get_scale_curve_y**\ (\ ) Curve for the scale over life, along the y axis. @@ -1651,8 +1651,8 @@ Curve for the scale over life, along the y axis. .. rst-class:: classref-property-setget -- void **set_scale_curve_z** **(** :ref:`Curve` value **)** -- :ref:`Curve` **get_scale_curve_z** **(** **)** +- |void| **set_scale_curve_z**\ (\ value\: :ref:`Curve`\ ) +- :ref:`Curve` **get_scale_curve_z**\ (\ ) Curve for the scale over life, along the z axis. @@ -1668,8 +1668,8 @@ Curve for the scale over life, along the z axis. .. rst-class:: classref-property-setget -- void **set_speed_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_speed_scale** **(** **)** +- |void| **set_speed_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_speed_scale**\ (\ ) Particle system's running speed scaling ratio. A value of ``0`` can be used to pause the particles. @@ -1685,8 +1685,8 @@ Particle system's running speed scaling ratio. A value of ``0`` can be used to p .. rst-class:: classref-property-setget -- void **set_split_scale** **(** :ref:`bool` value **)** -- :ref:`bool` **get_split_scale** **(** **)** +- |void| **set_split_scale**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_split_scale**\ (\ ) If set to ``true``, three different scale curves can be specified, one per scale axis. @@ -1702,8 +1702,8 @@ If set to ``true``, three different scale curves can be specified, one per scale .. rst-class:: classref-property-setget -- void **set_spread** **(** :ref:`float` value **)** -- :ref:`float` **get_spread** **(** **)** +- |void| **set_spread**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_spread**\ (\ ) Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Applied to X/Z plane and Y/Z planes. @@ -1719,8 +1719,8 @@ Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. .. rst-class:: classref-property-setget -- void **set_param_curve** **(** :ref:`Parameter` param, :ref:`Curve` curve **)** -- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) +- :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's tangential acceleration will vary along this :ref:`Curve`. @@ -1736,8 +1736,8 @@ Each particle's tangential acceleration will vary along this :ref:`Curve` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum tangent acceleration. @@ -1753,8 +1753,8 @@ Maximum tangent acceleration. .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum tangent acceleration. @@ -1766,12 +1766,12 @@ Minimum tangent acceleration. .. rst-class:: classref-property -:ref:`AABB` **visibility_aabb** = ``AABB(-4, -4, -4, 8, 8, 8)`` +:ref:`AABB` **visibility_aabb** = ``AABB(0, 0, 0, 0, 0, 0)`` .. rst-class:: classref-property-setget -- void **set_visibility_aabb** **(** :ref:`AABB` value **)** -- :ref:`AABB` **get_visibility_aabb** **(** **)** +- |void| **set_visibility_aabb**\ (\ value\: :ref:`AABB`\ ) +- :ref:`AABB` **get_visibility_aabb**\ (\ ) The :ref:`AABB` that determines the node's region which needs to be visible on screen for the particle system to be active. @@ -1790,7 +1790,7 @@ Method Descriptions .. rst-class:: classref-method -void **convert_from_particles** **(** :ref:`Node` particles **)** +|void| **convert_from_particles**\ (\ particles\: :ref:`Node`\ ) Sets this node's properties to match a given :ref:`GPUParticles3D` node with an assigned :ref:`ParticleProcessMaterial`. @@ -1802,7 +1802,7 @@ Sets this node's properties to match a given :ref:`GPUParticles3D` **get_param_curve** **(** :ref:`Parameter` param **)** |const| +:ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Returns the :ref:`Curve` of the parameter specified by :ref:`Parameter`. @@ -1814,7 +1814,7 @@ Returns the :ref:`Curve` of the parameter specified by :ref:`Parame .. rst-class:: classref-method -:ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +:ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Returns the maximum value range for the given parameter. @@ -1826,7 +1826,7 @@ Returns the maximum value range for the given parameter. .. rst-class:: classref-method -:ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +:ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Returns the minimum value range for the given parameter. @@ -1838,7 +1838,7 @@ Returns the minimum value range for the given parameter. .. rst-class:: classref-method -:ref:`bool` **get_particle_flag** **(** :ref:`ParticleFlags` particle_flag **)** |const| +:ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| Returns the enabled state of the given particle flag (see :ref:`ParticleFlags` for options). @@ -1850,7 +1850,7 @@ Returns the enabled state of the given particle flag (see :ref:`ParticleFlags` param, :ref:`Curve` curve **)** +|void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) Sets the :ref:`Curve` of the parameter specified by :ref:`Parameter`. @@ -1874,7 +1874,7 @@ Sets the :ref:`Curve` of the parameter specified by :ref:`Parameter .. rst-class:: classref-method -void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** +|void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) Sets the maximum value for the given parameter. @@ -1886,7 +1886,7 @@ Sets the maximum value for the given parameter. .. rst-class:: classref-method -void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** +|void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) Sets the minimum value for the given parameter. @@ -1898,7 +1898,7 @@ Sets the minimum value for the given parameter. .. rst-class:: classref-method -void **set_particle_flag** **(** :ref:`ParticleFlags` particle_flag, :ref:`bool` enable **)** +|void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) Enables or disables the given particle flag (see :ref:`ParticleFlags` for options). @@ -1909,3 +1909,4 @@ Enables or disables the given particle flag (see :ref:`ParticleFlags` | :ref:`constant_time_compare` **(** :ref:`PackedByteArray` trusted, :ref:`PackedByteArray` received **)** | - +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`decrypt` **(** :ref:`CryptoKey` key, :ref:`PackedByteArray` ciphertext **)** | - +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`encrypt` **(** :ref:`CryptoKey` key, :ref:`PackedByteArray` plaintext **)** | - +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`generate_random_bytes` **(** :ref:`int` size **)** | - +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`CryptoKey` | :ref:`generate_rsa` **(** :ref:`int` size **)** | - +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`X509Certificate` | :ref:`generate_self_signed_certificate` **(** :ref:`CryptoKey` key, :ref:`String` issuer_name="CN=myserver,O=myorganisation,C=IT", :ref:`String` not_before="20140101000000", :ref:`String` not_after="20340101000000" **)** | - +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`hmac_digest` **(** :ref:`HashType` hash_type, :ref:`PackedByteArray` key, :ref:`PackedByteArray` msg **)** | - +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`sign` **(** :ref:`HashType` hash_type, :ref:`PackedByteArray` hash, :ref:`CryptoKey` key **)** | - +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`verify` **(** :ref:`HashType` hash_type, :ref:`PackedByteArray` hash, :ref:`PackedByteArray` signature, :ref:`CryptoKey` key **)** | - +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`constant_time_compare`\ (\ trusted\: :ref:`PackedByteArray`, received\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`decrypt`\ (\ key\: :ref:`CryptoKey`, ciphertext\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`encrypt`\ (\ key\: :ref:`CryptoKey`, plaintext\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`generate_random_bytes`\ (\ size\: :ref:`int`\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CryptoKey` | :ref:`generate_rsa`\ (\ size\: :ref:`int`\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`X509Certificate` | :ref:`generate_self_signed_certificate`\ (\ key\: :ref:`CryptoKey`, issuer_name\: :ref:`String` = "CN=myserver,O=myorganisation,C=IT", not_before\: :ref:`String` = "20140101000000", not_after\: :ref:`String` = "20340101000000"\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`hmac_digest`\ (\ hash_type\: :ref:`HashType`, key\: :ref:`PackedByteArray`, msg\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`sign`\ (\ hash_type\: :ref:`HashType`, hash\: :ref:`PackedByteArray`, key\: :ref:`CryptoKey`\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`verify`\ (\ hash_type\: :ref:`HashType`, hash\: :ref:`PackedByteArray`, signature\: :ref:`PackedByteArray`, key\: :ref:`CryptoKey`\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -133,7 +133,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **constant_time_compare** **(** :ref:`PackedByteArray` trusted, :ref:`PackedByteArray` received **)** +:ref:`bool` **constant_time_compare**\ (\ trusted\: :ref:`PackedByteArray`, received\: :ref:`PackedByteArray`\ ) Compares two :ref:`PackedByteArray`\ s for equality without leaking timing information in order to prevent timing attacks. @@ -147,7 +147,7 @@ See `this blog post ` **decrypt** **(** :ref:`CryptoKey` key, :ref:`PackedByteArray` ciphertext **)** +:ref:`PackedByteArray` **decrypt**\ (\ key\: :ref:`CryptoKey`, ciphertext\: :ref:`PackedByteArray`\ ) Decrypt the given ``ciphertext`` with the provided private ``key``. @@ -161,7 +161,7 @@ Decrypt the given ``ciphertext`` with the provided private ``key``. .. rst-class:: classref-method -:ref:`PackedByteArray` **encrypt** **(** :ref:`CryptoKey` key, :ref:`PackedByteArray` plaintext **)** +:ref:`PackedByteArray` **encrypt**\ (\ key\: :ref:`CryptoKey`, plaintext\: :ref:`PackedByteArray`\ ) Encrypt the given ``plaintext`` with the provided public ``key``. @@ -175,7 +175,7 @@ Encrypt the given ``plaintext`` with the provided public ``key``. .. rst-class:: classref-method -:ref:`PackedByteArray` **generate_random_bytes** **(** :ref:`int` size **)** +:ref:`PackedByteArray` **generate_random_bytes**\ (\ size\: :ref:`int`\ ) Generates a :ref:`PackedByteArray` of cryptographically secure random bytes with given ``size``. @@ -187,7 +187,7 @@ Generates a :ref:`PackedByteArray` of cryptographically s .. rst-class:: classref-method -:ref:`CryptoKey` **generate_rsa** **(** :ref:`int` size **)** +:ref:`CryptoKey` **generate_rsa**\ (\ size\: :ref:`int`\ ) Generates an RSA :ref:`CryptoKey` that can be used for creating self-signed certificates and passed to :ref:`StreamPeerTLS.accept_stream`. @@ -199,7 +199,7 @@ Generates an RSA :ref:`CryptoKey` that can be used for creating .. rst-class:: classref-method -:ref:`X509Certificate` **generate_self_signed_certificate** **(** :ref:`CryptoKey` key, :ref:`String` issuer_name="CN=myserver,O=myorganisation,C=IT", :ref:`String` not_before="20140101000000", :ref:`String` not_after="20340101000000" **)** +:ref:`X509Certificate` **generate_self_signed_certificate**\ (\ key\: :ref:`CryptoKey`, issuer_name\: :ref:`String` = "CN=myserver,O=myorganisation,C=IT", not_before\: :ref:`String` = "20140101000000", not_after\: :ref:`String` = "20340101000000"\ ) Generates a self-signed :ref:`X509Certificate` from the given :ref:`CryptoKey` and ``issuer_name``. The certificate validity will be defined by ``not_before`` and ``not_after`` (first valid date and last valid date). The ``issuer_name`` must contain at least "CN=" (common name, i.e. the domain name), "O=" (organization, i.e. your company name), "C=" (country, i.e. 2 lettered ISO-3166 code of the country the organization is based in). @@ -234,7 +234,7 @@ A small example to generate an RSA key and a X509 self-signed certificate. .. rst-class:: classref-method -:ref:`PackedByteArray` **hmac_digest** **(** :ref:`HashType` hash_type, :ref:`PackedByteArray` key, :ref:`PackedByteArray` msg **)** +:ref:`PackedByteArray` **hmac_digest**\ (\ hash_type\: :ref:`HashType`, key\: :ref:`PackedByteArray`, msg\: :ref:`PackedByteArray`\ ) Generates an `HMAC `__ digest of ``msg`` using ``key``. The ``hash_type`` parameter is the hashing algorithm that is used for the inner and outer hashes. @@ -248,7 +248,7 @@ Currently, only :ref:`HashingContext.HASH_SHA256` **sign** **(** :ref:`HashType` hash_type, :ref:`PackedByteArray` hash, :ref:`CryptoKey` key **)** +:ref:`PackedByteArray` **sign**\ (\ hash_type\: :ref:`HashType`, hash\: :ref:`PackedByteArray`, key\: :ref:`CryptoKey`\ ) Sign a given ``hash`` of type ``hash_type`` with the provided private ``key``. @@ -260,7 +260,7 @@ Sign a given ``hash`` of type ``hash_type`` with the provided private ``key``. .. rst-class:: classref-method -:ref:`bool` **verify** **(** :ref:`HashType` hash_type, :ref:`PackedByteArray` hash, :ref:`PackedByteArray` signature, :ref:`CryptoKey` key **)** +:ref:`bool` **verify**\ (\ hash_type\: :ref:`HashType`, hash\: :ref:`PackedByteArray`, signature\: :ref:`PackedByteArray`, key\: :ref:`CryptoKey`\ ) Verify that a given ``signature`` for ``hash`` of type ``hash_type`` against the provided public ``key``. @@ -271,3 +271,4 @@ Verify that a given ``signature`` for ``hash`` of type ``hash_type`` against the .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_cryptokey.rst b/classes/class_cryptokey.rst index 32bce22d797..178df303b2f 100644 --- a/classes/class_cryptokey.rst +++ b/classes/class_cryptokey.rst @@ -38,17 +38,17 @@ Methods .. table:: :widths: auto - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_public_only` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load` **(** :ref:`String` path, :ref:`bool` public_only=false **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load_from_string` **(** :ref:`String` string_key, :ref:`bool` public_only=false **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save` **(** :ref:`String` path, :ref:`bool` public_only=false **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`save_to_string` **(** :ref:`bool` public_only=false **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_public_only`\ (\ ) |const| | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load`\ (\ path\: :ref:`String`, public_only\: :ref:`bool` = false\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_from_string`\ (\ string_key\: :ref:`String`, public_only\: :ref:`bool` = false\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save`\ (\ path\: :ref:`String`, public_only\: :ref:`bool` = false\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`save_to_string`\ (\ public_only\: :ref:`bool` = false\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -63,7 +63,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_public_only** **(** **)** |const| +:ref:`bool` **is_public_only**\ (\ ) |const| Returns ``true`` if this CryptoKey only has the public part, and not the private one. @@ -75,7 +75,7 @@ Returns ``true`` if this CryptoKey only has the public part, and not the private .. rst-class:: classref-method -:ref:`Error` **load** **(** :ref:`String` path, :ref:`bool` public_only=false **)** +:ref:`Error` **load**\ (\ path\: :ref:`String`, public_only\: :ref:`bool` = false\ ) Loads a key from ``path``. If ``public_only`` is ``true``, only the public key will be loaded. @@ -89,7 +89,7 @@ Loads a key from ``path``. If ``public_only`` is ``true``, only the public key w .. rst-class:: classref-method -:ref:`Error` **load_from_string** **(** :ref:`String` string_key, :ref:`bool` public_only=false **)** +:ref:`Error` **load_from_string**\ (\ string_key\: :ref:`String`, public_only\: :ref:`bool` = false\ ) Loads a key from the given ``string_key``. If ``public_only`` is ``true``, only the public key will be loaded. @@ -101,7 +101,7 @@ Loads a key from the given ``string_key``. If ``public_only`` is ``true``, only .. rst-class:: classref-method -:ref:`Error` **save** **(** :ref:`String` path, :ref:`bool` public_only=false **)** +:ref:`Error` **save**\ (\ path\: :ref:`String`, public_only\: :ref:`bool` = false\ ) Saves a key to the given ``path``. If ``public_only`` is ``true``, only the public key will be saved. @@ -115,7 +115,7 @@ Saves a key to the given ``path``. If ``public_only`` is ``true``, only the publ .. rst-class:: classref-method -:ref:`String` **save_to_string** **(** :ref:`bool` public_only=false **)** +:ref:`String` **save_to_string**\ (\ public_only\: :ref:`bool` = false\ ) Returns a string containing the key in PEM format. If ``public_only`` is ``true``, only the public key will be included. @@ -126,3 +126,4 @@ Returns a string containing the key in PEM format. If ``public_only`` is ``true` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_csgbox3d.rst b/classes/class_csgbox3d.rst index ad217382cfb..7b82511c0e8 100644 --- a/classes/class_csgbox3d.rst +++ b/classes/class_csgbox3d.rst @@ -61,8 +61,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_material** **(** :ref:`Material` value **)** -- :ref:`Material` **get_material** **(** **)** +- |void| **set_material**\ (\ value\: :ref:`Material`\ ) +- :ref:`Material` **get_material**\ (\ ) The material used to render the box. @@ -78,8 +78,8 @@ The material used to render the box. .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_size**\ (\ ) The box's width, height and depth. @@ -90,3 +90,4 @@ The box's width, height and depth. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_csgcombiner3d.rst b/classes/class_csgcombiner3d.rst index e4a4528c7a6..f9243de08fe 100644 --- a/classes/class_csgcombiner3d.rst +++ b/classes/class_csgcombiner3d.rst @@ -37,3 +37,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_csgcylinder3d.rst b/classes/class_csgcylinder3d.rst index 005321b136a..e9afb94ede4 100644 --- a/classes/class_csgcylinder3d.rst +++ b/classes/class_csgcylinder3d.rst @@ -69,8 +69,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_cone** **(** :ref:`bool` value **)** -- :ref:`bool` **is_cone** **(** **)** +- |void| **set_cone**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_cone**\ (\ ) If ``true`` a cone is created, the :ref:`radius` will only apply to one side. @@ -86,8 +86,8 @@ If ``true`` a cone is created, the :ref:`radius` value **)** -- :ref:`float` **get_height** **(** **)** +- |void| **set_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_height**\ (\ ) The height of the cylinder. @@ -103,8 +103,8 @@ The height of the cylinder. .. rst-class:: classref-property-setget -- void **set_material** **(** :ref:`Material` value **)** -- :ref:`Material` **get_material** **(** **)** +- |void| **set_material**\ (\ value\: :ref:`Material`\ ) +- :ref:`Material` **get_material**\ (\ ) The material used to render the cylinder. @@ -120,8 +120,8 @@ The material used to render the cylinder. .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) The radius of the cylinder. @@ -137,8 +137,8 @@ The radius of the cylinder. .. rst-class:: classref-property-setget -- void **set_sides** **(** :ref:`int` value **)** -- :ref:`int` **get_sides** **(** **)** +- |void| **set_sides**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_sides**\ (\ ) The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder. @@ -154,8 +154,8 @@ The number of sides of the cylinder, the higher this number the more detail ther .. rst-class:: classref-property-setget -- void **set_smooth_faces** **(** :ref:`bool` value **)** -- :ref:`bool` **get_smooth_faces** **(** **)** +- |void| **set_smooth_faces**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_smooth_faces**\ (\ ) If ``true`` the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. If ``false`` the cylinder will have a flat shaded look. @@ -166,3 +166,4 @@ If ``true`` the normals of the cylinder are set to give a smooth effect making t .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_csgmesh3d.rst b/classes/class_csgmesh3d.rst index b44bf5c4f8c..e8edd4c7803 100644 --- a/classes/class_csgmesh3d.rst +++ b/classes/class_csgmesh3d.rst @@ -61,8 +61,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_material** **(** :ref:`Material` value **)** -- :ref:`Material` **get_material** **(** **)** +- |void| **set_material**\ (\ value\: :ref:`Material`\ ) +- :ref:`Material` **get_material**\ (\ ) The :ref:`Material` used in drawing the CSG shape. @@ -78,8 +78,8 @@ The :ref:`Material` used in drawing the CSG shape. .. rst-class:: classref-property-setget -- void **set_mesh** **(** :ref:`Mesh` value **)** -- :ref:`Mesh` **get_mesh** **(** **)** +- |void| **set_mesh**\ (\ value\: :ref:`Mesh`\ ) +- :ref:`Mesh` **get_mesh**\ (\ ) The :ref:`Mesh` resource to use as a CSG shape. @@ -94,3 +94,4 @@ The :ref:`Mesh` resource to use as a CSG shape. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_csgpolygon3d.rst b/classes/class_csgpolygon3d.rst index 384a440cc0f..0ac1340d28c 100644 --- a/classes/class_csgpolygon3d.rst +++ b/classes/class_csgpolygon3d.rst @@ -192,8 +192,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_depth** **(** :ref:`float` value **)** -- :ref:`float` **get_depth** **(** **)** +- |void| **set_depth**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_depth**\ (\ ) When :ref:`mode` is :ref:`MODE_DEPTH`, the depth of the extrusion. @@ -209,8 +209,8 @@ When :ref:`mode` is :ref:`MODE_DEPTH` value **)** -- :ref:`Material` **get_material** **(** **)** +- |void| **set_material**\ (\ value\: :ref:`Material`\ ) +- :ref:`Material` **get_material**\ (\ ) Material to use for the resulting mesh. The UV maps the top half of the material to the extruded shape (U along the length of the extrusions and V around the outline of the :ref:`polygon`), the bottom-left quarter to the front end face, and the bottom-right quarter to the back end face. @@ -226,8 +226,8 @@ Material to use for the resulting mesh. The UV maps the top half of the material .. rst-class:: classref-property-setget -- void **set_mode** **(** :ref:`Mode` value **)** -- :ref:`Mode` **get_mode** **(** **)** +- |void| **set_mode**\ (\ value\: :ref:`Mode`\ ) +- :ref:`Mode` **get_mode**\ (\ ) The :ref:`mode` used to extrude the :ref:`polygon`. @@ -243,8 +243,8 @@ The :ref:`mode` used to extrude the :ref:`poly .. rst-class:: classref-property-setget -- void **set_path_continuous_u** **(** :ref:`bool` value **)** -- :ref:`bool` **is_path_continuous_u** **(** **)** +- |void| **set_path_continuous_u**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_path_continuous_u**\ (\ ) When :ref:`mode` is :ref:`MODE_PATH`, by default, the top half of the :ref:`material` is stretched along the entire length of the extruded shape. If ``false`` the top half of the material is repeated every step of the extrusion. @@ -260,8 +260,8 @@ When :ref:`mode` is :ref:`MODE_PATH` value **)** -- :ref:`float` **get_path_interval** **(** **)** +- |void| **set_path_interval**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_interval**\ (\ ) When :ref:`mode` is :ref:`MODE_PATH`, the path interval or ratio of path points to extrusions. @@ -277,8 +277,8 @@ When :ref:`mode` is :ref:`MODE_PATH` value **)** -- :ref:`PathIntervalType` **get_path_interval_type** **(** **)** +- |void| **set_path_interval_type**\ (\ value\: :ref:`PathIntervalType`\ ) +- :ref:`PathIntervalType` **get_path_interval_type**\ (\ ) When :ref:`mode` is :ref:`MODE_PATH`, this will determine if the interval should be by distance (:ref:`PATH_INTERVAL_DISTANCE`) or subdivision fractions (:ref:`PATH_INTERVAL_SUBDIVIDE`). @@ -294,8 +294,8 @@ When :ref:`mode` is :ref:`MODE_PATH` value **)** -- :ref:`bool` **is_path_joined** **(** **)** +- |void| **set_path_joined**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_path_joined**\ (\ ) When :ref:`mode` is :ref:`MODE_PATH`, if ``true`` the ends of the path are joined, by adding an extrusion between the last and first points of the path. @@ -311,8 +311,8 @@ When :ref:`mode` is :ref:`MODE_PATH` value **)** -- :ref:`bool` **is_path_local** **(** **)** +- |void| **set_path_local**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_path_local**\ (\ ) When :ref:`mode` is :ref:`MODE_PATH`, if ``true`` the :ref:`Transform3D` of the **CSGPolygon3D** is used as the starting point for the extrusions, not the :ref:`Transform3D` of the :ref:`path_node`. @@ -328,8 +328,8 @@ When :ref:`mode` is :ref:`MODE_PATH` value **)** -- :ref:`NodePath` **get_path_node** **(** **)** +- |void| **set_path_node**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_path_node**\ (\ ) When :ref:`mode` is :ref:`MODE_PATH`, the location of the :ref:`Path3D` object used to extrude the :ref:`polygon`. @@ -345,8 +345,8 @@ When :ref:`mode` is :ref:`MODE_PATH` value **)** -- :ref:`PathRotation` **get_path_rotation** **(** **)** +- |void| **set_path_rotation**\ (\ value\: :ref:`PathRotation`\ ) +- :ref:`PathRotation` **get_path_rotation**\ (\ ) When :ref:`mode` is :ref:`MODE_PATH`, the path rotation method used to rotate the :ref:`polygon` as it is extruded. @@ -362,8 +362,8 @@ When :ref:`mode` is :ref:`MODE_PATH` value **)** -- :ref:`float` **get_path_simplify_angle** **(** **)** +- |void| **set_path_simplify_angle**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_simplify_angle**\ (\ ) When :ref:`mode` is :ref:`MODE_PATH`, extrusions that are less than this angle, will be merged together to reduce polygon count. @@ -379,8 +379,8 @@ When :ref:`mode` is :ref:`MODE_PATH` value **)** -- :ref:`float` **get_path_u_distance** **(** **)** +- |void| **set_path_u_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_u_distance**\ (\ ) When :ref:`mode` is :ref:`MODE_PATH`, this is the distance along the path, in meters, the texture coordinates will tile. When set to 0, texture coordinates will match geometry exactly with no tiling. @@ -396,8 +396,8 @@ When :ref:`mode` is :ref:`MODE_PATH` value **)** -- :ref:`PackedVector2Array` **get_polygon** **(** **)** +- |void| **set_polygon**\ (\ value\: :ref:`PackedVector2Array`\ ) +- :ref:`PackedVector2Array` **get_polygon**\ (\ ) The point array that defines the 2D polygon that is extruded. This can be a convex or concave polygon with 3 or more points. The polygon must *not* have any intersecting edges. Otherwise, triangulation will fail and no mesh will be generated. @@ -415,8 +415,8 @@ The point array that defines the 2D polygon that is extruded. This can be a conv .. rst-class:: classref-property-setget -- void **set_smooth_faces** **(** :ref:`bool` value **)** -- :ref:`bool` **get_smooth_faces** **(** **)** +- |void| **set_smooth_faces**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_smooth_faces**\ (\ ) If ``true``, applies smooth shading to the extrusions. @@ -432,8 +432,8 @@ If ``true``, applies smooth shading to the extrusions. .. rst-class:: classref-property-setget -- void **set_spin_degrees** **(** :ref:`float` value **)** -- :ref:`float` **get_spin_degrees** **(** **)** +- |void| **set_spin_degrees**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_spin_degrees**\ (\ ) When :ref:`mode` is :ref:`MODE_SPIN`, the total number of degrees the :ref:`polygon` is rotated when extruding. @@ -449,8 +449,8 @@ When :ref:`mode` is :ref:`MODE_SPIN` value **)** -- :ref:`int` **get_spin_sides** **(** **)** +- |void| **set_spin_sides**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_spin_sides**\ (\ ) When :ref:`mode` is :ref:`MODE_SPIN`, the number of extrusions made. @@ -461,3 +461,4 @@ When :ref:`mode` is :ref:`MODE_SPIN` value **)** -- :ref:`bool` **get_flip_faces** **(** **)** +- |void| **set_flip_faces**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_flip_faces**\ (\ ) If set, the order of the vertices in each triangle are reversed resulting in the backside of the mesh being drawn. @@ -73,3 +73,4 @@ If set, the order of the vertices in each triangle are reversed resulting in the .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_csgshape3d.rst b/classes/class_csgshape3d.rst index 9880e42cb97..ae60a33eaed 100644 --- a/classes/class_csgshape3d.rst +++ b/classes/class_csgshape3d.rst @@ -64,19 +64,19 @@ Methods .. table:: :widths: auto - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_collision_layer_value` **(** :ref:`int` layer_number **)** |const| | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_collision_mask_value` **(** :ref:`int` layer_number **)** |const| | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_meshes` **(** **)** |const| | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_root_shape` **(** **)** |const| | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_collision_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_collision_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_meshes`\ (\ ) |const| | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_root_shape`\ (\ ) |const| | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -134,8 +134,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_calculate_tangents** **(** :ref:`bool` value **)** -- :ref:`bool` **is_calculating_tangents** **(** **)** +- |void| **set_calculate_tangents**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_calculating_tangents**\ (\ ) Calculate tangents for the CSG shape which allows the use of normal maps. This is only applied on the root shape, this setting is ignored on any child. @@ -151,8 +151,8 @@ Calculate tangents for the CSG shape which allows the use of normal maps. This i .. rst-class:: classref-property-setget -- void **set_collision_layer** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_layer** **(** **)** +- |void| **set_collision_layer**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_layer**\ (\ ) The physics layers this area is in. @@ -172,8 +172,8 @@ A contact is detected if object A is in any of the layers that object B scans, o .. rst-class:: classref-property-setget -- void **set_collision_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_mask** **(** **)** +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) The physics layers this CSG shape scans for collisions. Only effective if :ref:`use_collision` is ``true``. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information. @@ -189,8 +189,8 @@ The physics layers this CSG shape scans for collisions. Only effective if :ref:` .. rst-class:: classref-property-setget -- void **set_collision_priority** **(** :ref:`float` value **)** -- :ref:`float` **get_collision_priority** **(** **)** +- |void| **set_collision_priority**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_collision_priority**\ (\ ) The priority used to solve colliding when occurring penetration. Only effective if :ref:`use_collision` is ``true``. The higher the priority is, the lower the penetration into the object will be. This can for example be used to prevent the player from breaking through the boundaries of a level. @@ -206,8 +206,8 @@ The priority used to solve colliding when occurring penetration. Only effective .. rst-class:: classref-property-setget -- void **set_operation** **(** :ref:`Operation` value **)** -- :ref:`Operation` **get_operation** **(** **)** +- |void| **set_operation**\ (\ value\: :ref:`Operation`\ ) +- :ref:`Operation` **get_operation**\ (\ ) The operation that is performed on this shape. This is ignored for the first CSG child node as the operation is between this node and the previous child of this nodes parent. @@ -223,8 +223,8 @@ The operation that is performed on this shape. This is ignored for the first CSG .. rst-class:: classref-property-setget -- void **set_snap** **(** :ref:`float` value **)** -- :ref:`float` **get_snap** **(** **)** +- |void| **set_snap**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_snap**\ (\ ) Snap makes the mesh vertices snap to a given distance so that the faces of two meshes can be perfectly aligned. A lower value results in greater precision but may be harder to adjust. @@ -240,8 +240,8 @@ Snap makes the mesh vertices snap to a given distance so that the faces of two m .. rst-class:: classref-property-setget -- void **set_use_collision** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_collision** **(** **)** +- |void| **set_use_collision**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_collision**\ (\ ) Adds a collision shape to the physics engine for our CSG shape. This will always act like a static body. Note that the collision shape is still active even if the CSG shape itself is hidden. See also :ref:`collision_mask` and :ref:`collision_priority`. @@ -258,7 +258,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_collision_layer_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_collision_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`collision_layer` is enabled, given a ``layer_number`` between 1 and 32. @@ -270,7 +270,7 @@ Returns whether or not the specified layer of the :ref:`collision_layer` **get_collision_mask_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -282,7 +282,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_meshes** **(** **)** |const| +:ref:`Array` **get_meshes**\ (\ ) |const| Returns an :ref:`Array` with two elements, the first is the :ref:`Transform3D` of this node and the second is the root :ref:`Mesh` of this node. Only works when this node is the root shape. @@ -294,7 +294,7 @@ Returns an :ref:`Array` with two elements, the first is the :ref:`T .. rst-class:: classref-method -:ref:`bool` **is_root_shape** **(** **)** |const| +:ref:`bool` **is_root_shape**\ (\ ) |const| Returns ``true`` if this is a root shape and is thus the object that is rendered. @@ -306,7 +306,7 @@ Returns ``true`` if this is a root shape and is thus the object that is rendered .. rst-class:: classref-method -void **set_collision_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_collision_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`collision_layer`, given a ``layer_number`` between 1 and 32. @@ -318,7 +318,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. rst-class:: classref-method -void **set_collision_mask_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. @@ -329,3 +329,4 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_csgsphere3d.rst b/classes/class_csgsphere3d.rst index cf43c9e35f9..b76dc6fe068 100644 --- a/classes/class_csgsphere3d.rst +++ b/classes/class_csgsphere3d.rst @@ -67,8 +67,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_material** **(** :ref:`Material` value **)** -- :ref:`Material` **get_material** **(** **)** +- |void| **set_material**\ (\ value\: :ref:`Material`\ ) +- :ref:`Material` **get_material**\ (\ ) The material used to render the sphere. @@ -84,8 +84,8 @@ The material used to render the sphere. .. rst-class:: classref-property-setget -- void **set_radial_segments** **(** :ref:`int` value **)** -- :ref:`int` **get_radial_segments** **(** **)** +- |void| **set_radial_segments**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_radial_segments**\ (\ ) Number of vertical slices for the sphere. @@ -101,8 +101,8 @@ Number of vertical slices for the sphere. .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) Radius of the sphere. @@ -118,8 +118,8 @@ Radius of the sphere. .. rst-class:: classref-property-setget -- void **set_rings** **(** :ref:`int` value **)** -- :ref:`int` **get_rings** **(** **)** +- |void| **set_rings**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_rings**\ (\ ) Number of horizontal slices for the sphere. @@ -135,8 +135,8 @@ Number of horizontal slices for the sphere. .. rst-class:: classref-property-setget -- void **set_smooth_faces** **(** :ref:`bool` value **)** -- :ref:`bool` **get_smooth_faces** **(** **)** +- |void| **set_smooth_faces**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_smooth_faces**\ (\ ) If ``true`` the normals of the sphere are set to give a smooth effect making the sphere seem rounded. If ``false`` the sphere will have a flat shaded look. @@ -147,3 +147,4 @@ If ``true`` the normals of the sphere are set to give a smooth effect making the .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_csgtorus3d.rst b/classes/class_csgtorus3d.rst index 24b4e412026..be9dde794f2 100644 --- a/classes/class_csgtorus3d.rst +++ b/classes/class_csgtorus3d.rst @@ -69,8 +69,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_inner_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_inner_radius** **(** **)** +- |void| **set_inner_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_inner_radius**\ (\ ) The inner radius of the torus. @@ -86,8 +86,8 @@ The inner radius of the torus. .. rst-class:: classref-property-setget -- void **set_material** **(** :ref:`Material` value **)** -- :ref:`Material` **get_material** **(** **)** +- |void| **set_material**\ (\ value\: :ref:`Material`\ ) +- :ref:`Material` **get_material**\ (\ ) The material used to render the torus. @@ -103,8 +103,8 @@ The material used to render the torus. .. rst-class:: classref-property-setget -- void **set_outer_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_outer_radius** **(** **)** +- |void| **set_outer_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_outer_radius**\ (\ ) The outer radius of the torus. @@ -120,8 +120,8 @@ The outer radius of the torus. .. rst-class:: classref-property-setget -- void **set_ring_sides** **(** :ref:`int` value **)** -- :ref:`int` **get_ring_sides** **(** **)** +- |void| **set_ring_sides**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_ring_sides**\ (\ ) The number of edges each ring of the torus is constructed of. @@ -137,8 +137,8 @@ The number of edges each ring of the torus is constructed of. .. rst-class:: classref-property-setget -- void **set_sides** **(** :ref:`int` value **)** -- :ref:`int` **get_sides** **(** **)** +- |void| **set_sides**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_sides**\ (\ ) The number of slices the torus is constructed of. @@ -154,8 +154,8 @@ The number of slices the torus is constructed of. .. rst-class:: classref-property-setget -- void **set_smooth_faces** **(** :ref:`bool` value **)** -- :ref:`bool` **get_smooth_faces** **(** **)** +- |void| **set_smooth_faces**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_smooth_faces**\ (\ ) If ``true`` the normals of the torus are set to give a smooth effect making the torus seem rounded. If ``false`` the torus will have a flat shaded look. @@ -166,3 +166,4 @@ If ``true`` the normals of the torus are set to give a smooth effect making the .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_csharpscript.rst b/classes/class_csharpscript.rst index 154e7807e63..6577e00e58d 100644 --- a/classes/class_csharpscript.rst +++ b/classes/class_csharpscript.rst @@ -38,9 +38,9 @@ Methods .. table:: :widths: auto - +-------------------------------+--------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`new` **(** ... **)** |vararg| | - +-------------------------------+--------------------------------------------------------------------+ + +-------------------------------+---------------------------------------------------------------+ + | :ref:`Variant` | :ref:`new`\ (\ ...\ ) |vararg| | + +-------------------------------+---------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -55,7 +55,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **new** **(** ... **)** |vararg| +:ref:`Variant` **new**\ (\ ...\ ) |vararg| Returns a new instance of the script. @@ -66,3 +66,4 @@ Returns a new instance of the script. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index 3aea299aa86..a3ee8cc9050 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -35,9 +35,9 @@ Methods .. table:: :widths: auto - +---------------------------------+----------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`create_placeholder` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------+ + +---------------------------------+----------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`create_placeholder`\ (\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -52,7 +52,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Resource` **create_placeholder** **(** **)** |const| +:ref:`Resource` **create_placeholder**\ (\ ) |const| Creates a placeholder version of this resource (:ref:`PlaceholderCubemap`). @@ -63,3 +63,4 @@ Creates a placeholder version of this resource (:ref:`PlaceholderCubemap` | :ref:`create_placeholder` **(** **)** |const| | - +---------------------------------+---------------------------------------------------------------------------------------------+ + +---------------------------------+---------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`create_placeholder`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -54,7 +54,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Resource` **create_placeholder** **(** **)** |const| +:ref:`Resource` **create_placeholder**\ (\ ) |const| Creates a placeholder version of this resource (:ref:`PlaceholderCubemapArray`). @@ -65,3 +65,4 @@ Creates a placeholder version of this resource (:ref:`PlaceholderCubemapArray` | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`TangentMode` left_mode=0, :ref:`TangentMode` right_mode=0 **)** | - +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`bake` **(** **)** | - +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clean_dupes` **(** **)** | - +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_points` **(** **)** | - +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TangentMode` | :ref:`get_point_left_mode` **(** :ref:`int` index **)** |const| | - +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_point_left_tangent` **(** :ref:`int` index **)** |const| | - +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` index **)** |const| | - +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TangentMode` | :ref:`get_point_right_mode` **(** :ref:`int` index **)** |const| | - +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_point_right_tangent` **(** :ref:`int` index **)** |const| | - +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_point` **(** :ref:`int` index **)** | - +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`sample` **(** :ref:`float` offset **)** |const| | - +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`sample_baked` **(** :ref:`float` offset **)** |const| | - +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_left_mode` **(** :ref:`int` index, :ref:`TangentMode` mode **)** | - +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_left_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | - +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`set_point_offset` **(** :ref:`int` index, :ref:`float` offset **)** | - +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_right_mode` **(** :ref:`int` index, :ref:`TangentMode` mode **)** | - +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_right_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | - +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_value` **(** :ref:`int` index, :ref:`float` y **)** | - +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`add_point`\ (\ position\: :ref:`Vector2`, left_tangent\: :ref:`float` = 0, right_tangent\: :ref:`float` = 0, left_mode\: :ref:`TangentMode` = 0, right_mode\: :ref:`TangentMode` = 0\ ) | + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bake`\ (\ ) | + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clean_dupes`\ (\ ) | + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_points`\ (\ ) | + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TangentMode` | :ref:`get_point_left_mode`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_point_left_tangent`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_point_position`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TangentMode` | :ref:`get_point_right_mode`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_point_right_tangent`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_point`\ (\ index\: :ref:`int`\ ) | + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`sample`\ (\ offset\: :ref:`float`\ ) |const| | + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`sample_baked`\ (\ offset\: :ref:`float`\ ) |const| | + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_left_mode`\ (\ index\: :ref:`int`, mode\: :ref:`TangentMode`\ ) | + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_left_tangent`\ (\ index\: :ref:`int`, tangent\: :ref:`float`\ ) | + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`set_point_offset`\ (\ index\: :ref:`int`, offset\: :ref:`float`\ ) | + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_right_mode`\ (\ index\: :ref:`int`, mode\: :ref:`TangentMode`\ ) | + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_right_tangent`\ (\ index\: :ref:`int`, tangent\: :ref:`float`\ ) | + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_value`\ (\ index\: :ref:`int`, y\: :ref:`float`\ ) | + +--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -100,7 +100,7 @@ Signals .. rst-class:: classref-signal -**range_changed** **(** **)** +**range_changed**\ (\ ) Emitted when :ref:`max_value` or :ref:`min_value` is changed. @@ -160,8 +160,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bake_resolution** **(** :ref:`int` value **)** -- :ref:`int` **get_bake_resolution** **(** **)** +- |void| **set_bake_resolution**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_bake_resolution**\ (\ ) The number of points to include in the baked (i.e. cached) curve data. @@ -177,8 +177,8 @@ The number of points to include in the baked (i.e. cached) curve data. .. rst-class:: classref-property-setget -- void **set_max_value** **(** :ref:`float` value **)** -- :ref:`float` **get_max_value** **(** **)** +- |void| **set_max_value**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_max_value**\ (\ ) The maximum value the curve can reach. @@ -194,8 +194,8 @@ The maximum value the curve can reach. .. rst-class:: classref-property-setget -- void **set_min_value** **(** :ref:`float` value **)** -- :ref:`float` **get_min_value** **(** **)** +- |void| **set_min_value**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_min_value**\ (\ ) The minimum value the curve can reach. @@ -211,8 +211,8 @@ The minimum value the curve can reach. .. rst-class:: classref-property-setget -- void **set_point_count** **(** :ref:`int` value **)** -- :ref:`int` **get_point_count** **(** **)** +- |void| **set_point_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_point_count**\ (\ ) The number of points describing the curve. @@ -229,7 +229,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **add_point** **(** :ref:`Vector2` position, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`TangentMode` left_mode=0, :ref:`TangentMode` right_mode=0 **)** +:ref:`int` **add_point**\ (\ position\: :ref:`Vector2`, left_tangent\: :ref:`float` = 0, right_tangent\: :ref:`float` = 0, left_mode\: :ref:`TangentMode` = 0, right_mode\: :ref:`TangentMode` = 0\ ) Adds a point to the curve. For each side, if the ``*_mode`` is :ref:`TANGENT_LINEAR`, the ``*_tangent`` angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the ``*_tangent`` angle if ``*_mode`` is set to :ref:`TANGENT_FREE`. @@ -241,7 +241,7 @@ Adds a point to the curve. For each side, if the ``*_mode`` is :ref:`TANGENT_LIN .. rst-class:: classref-method -void **bake** **(** **)** +|void| **bake**\ (\ ) Recomputes the baked cache of points for the curve. @@ -253,7 +253,7 @@ Recomputes the baked cache of points for the curve. .. rst-class:: classref-method -void **clean_dupes** **(** **)** +|void| **clean_dupes**\ (\ ) Removes duplicate points, i.e. points that are less than 0.00001 units (engine epsilon value) away from their neighbor on the curve. @@ -265,7 +265,7 @@ Removes duplicate points, i.e. points that are less than 0.00001 units (engine e .. rst-class:: classref-method -void **clear_points** **(** **)** +|void| **clear_points**\ (\ ) Removes all points from the curve. @@ -277,7 +277,7 @@ Removes all points from the curve. .. rst-class:: classref-method -:ref:`TangentMode` **get_point_left_mode** **(** :ref:`int` index **)** |const| +:ref:`TangentMode` **get_point_left_mode**\ (\ index\: :ref:`int`\ ) |const| Returns the left :ref:`TangentMode` for the point at ``index``. @@ -289,7 +289,7 @@ Returns the left :ref:`TangentMode` for the point at ``i .. rst-class:: classref-method -:ref:`float` **get_point_left_tangent** **(** :ref:`int` index **)** |const| +:ref:`float` **get_point_left_tangent**\ (\ index\: :ref:`int`\ ) |const| Returns the left tangent angle (in degrees) for the point at ``index``. @@ -301,7 +301,7 @@ Returns the left tangent angle (in degrees) for the point at ``index``. .. rst-class:: classref-method -:ref:`Vector2` **get_point_position** **(** :ref:`int` index **)** |const| +:ref:`Vector2` **get_point_position**\ (\ index\: :ref:`int`\ ) |const| Returns the curve coordinates for the point at ``index``. @@ -313,7 +313,7 @@ Returns the curve coordinates for the point at ``index``. .. rst-class:: classref-method -:ref:`TangentMode` **get_point_right_mode** **(** :ref:`int` index **)** |const| +:ref:`TangentMode` **get_point_right_mode**\ (\ index\: :ref:`int`\ ) |const| Returns the right :ref:`TangentMode` for the point at ``index``. @@ -325,7 +325,7 @@ Returns the right :ref:`TangentMode` for the point at `` .. rst-class:: classref-method -:ref:`float` **get_point_right_tangent** **(** :ref:`int` index **)** |const| +:ref:`float` **get_point_right_tangent**\ (\ index\: :ref:`int`\ ) |const| Returns the right tangent angle (in degrees) for the point at ``index``. @@ -337,7 +337,7 @@ Returns the right tangent angle (in degrees) for the point at ``index``. .. rst-class:: classref-method -void **remove_point** **(** :ref:`int` index **)** +|void| **remove_point**\ (\ index\: :ref:`int`\ ) Removes the point at ``index`` from the curve. @@ -349,7 +349,7 @@ Removes the point at ``index`` from the curve. .. rst-class:: classref-method -:ref:`float` **sample** **(** :ref:`float` offset **)** |const| +:ref:`float` **sample**\ (\ offset\: :ref:`float`\ ) |const| Returns the Y value for the point that would exist at the X position ``offset`` along the curve. @@ -361,7 +361,7 @@ Returns the Y value for the point that would exist at the X position ``offset`` .. rst-class:: classref-method -:ref:`float` **sample_baked** **(** :ref:`float` offset **)** |const| +:ref:`float` **sample_baked**\ (\ offset\: :ref:`float`\ ) |const| Returns the Y value for the point that would exist at the X position ``offset`` along the curve using the baked cache. Bakes the curve's points if not already baked. @@ -373,7 +373,7 @@ Returns the Y value for the point that would exist at the X position ``offset`` .. rst-class:: classref-method -void **set_point_left_mode** **(** :ref:`int` index, :ref:`TangentMode` mode **)** +|void| **set_point_left_mode**\ (\ index\: :ref:`int`, mode\: :ref:`TangentMode`\ ) Sets the left :ref:`TangentMode` for the point at ``index`` to ``mode``. @@ -385,7 +385,7 @@ Sets the left :ref:`TangentMode` for the point at ``inde .. rst-class:: classref-method -void **set_point_left_tangent** **(** :ref:`int` index, :ref:`float` tangent **)** +|void| **set_point_left_tangent**\ (\ index\: :ref:`int`, tangent\: :ref:`float`\ ) Sets the left tangent angle for the point at ``index`` to ``tangent``. @@ -397,7 +397,7 @@ Sets the left tangent angle for the point at ``index`` to ``tangent``. .. rst-class:: classref-method -:ref:`int` **set_point_offset** **(** :ref:`int` index, :ref:`float` offset **)** +:ref:`int` **set_point_offset**\ (\ index\: :ref:`int`, offset\: :ref:`float`\ ) Sets the offset from ``0.5``. @@ -409,7 +409,7 @@ Sets the offset from ``0.5``. .. rst-class:: classref-method -void **set_point_right_mode** **(** :ref:`int` index, :ref:`TangentMode` mode **)** +|void| **set_point_right_mode**\ (\ index\: :ref:`int`, mode\: :ref:`TangentMode`\ ) Sets the right :ref:`TangentMode` for the point at ``index`` to ``mode``. @@ -421,7 +421,7 @@ Sets the right :ref:`TangentMode` for the point at ``ind .. rst-class:: classref-method -void **set_point_right_tangent** **(** :ref:`int` index, :ref:`float` tangent **)** +|void| **set_point_right_tangent**\ (\ index\: :ref:`int`, tangent\: :ref:`float`\ ) Sets the right tangent angle for the point at ``index`` to ``tangent``. @@ -433,7 +433,7 @@ Sets the right tangent angle for the point at ``index`` to ``tangent``. .. rst-class:: classref-method -void **set_point_value** **(** :ref:`int` index, :ref:`float` y **)** +|void| **set_point_value**\ (\ index\: :ref:`int`, y\: :ref:`float`\ ) Assigns the vertical position ``y`` to the point at ``index``. @@ -444,3 +444,4 @@ Assigns the vertical position ``y`` to the point at ``index``. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index a2091861254..0155f97be39 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -45,45 +45,45 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`Vector2` in=Vector2(0, 0), :ref:`Vector2` out=Vector2(0, 0), :ref:`int` index=-1 **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_points` **(** **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_baked_length` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`get_baked_points` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_closest_offset` **(** :ref:`Vector2` to_point **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_point` **(** :ref:`int` idx **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`sample` **(** :ref:`int` idx, :ref:`float` t **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`sample_baked` **(** :ref:`float` offset=0.0, :ref:`bool` cubic=false **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`sample_baked_with_rotation` **(** :ref:`float` offset=0.0, :ref:`bool` cubic=false **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`samplef` **(** :ref:`float` fofs **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` position **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` position **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector2` position **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`tessellate_even_length` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_length=20.0 **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_point`\ (\ position\: :ref:`Vector2`, in\: :ref:`Vector2` = Vector2(0, 0), out\: :ref:`Vector2` = Vector2(0, 0), index\: :ref:`int` = -1\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_points`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_baked_length`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`get_baked_points`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_closest_offset`\ (\ to_point\: :ref:`Vector2`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_closest_point`\ (\ to_point\: :ref:`Vector2`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_point_in`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_point_out`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_point_position`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_point`\ (\ idx\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`sample`\ (\ idx\: :ref:`int`, t\: :ref:`float`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`sample_baked`\ (\ offset\: :ref:`float` = 0.0, cubic\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`sample_baked_with_rotation`\ (\ offset\: :ref:`float` = 0.0, cubic\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`samplef`\ (\ fofs\: :ref:`float`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_in`\ (\ idx\: :ref:`int`, position\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_out`\ (\ idx\: :ref:`int`, position\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_position`\ (\ idx\: :ref:`int`, position\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`tessellate`\ (\ max_stages\: :ref:`int` = 5, tolerance_degrees\: :ref:`float` = 4\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`tessellate_even_length`\ (\ max_stages\: :ref:`int` = 5, tolerance_length\: :ref:`float` = 20.0\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -102,8 +102,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bake_interval** **(** :ref:`float` value **)** -- :ref:`float` **get_bake_interval** **(** **)** +- |void| **set_bake_interval**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_bake_interval**\ (\ ) The distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time the :ref:`get_baked_points` or :ref:`get_baked_length` function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. @@ -119,8 +119,8 @@ The distance in pixels between two adjacent cached points. Changing it forces th .. rst-class:: classref-property-setget -- void **set_point_count** **(** :ref:`int` value **)** -- :ref:`int` **get_point_count** **(** **)** +- |void| **set_point_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_point_count**\ (\ ) The number of points describing the curve. @@ -137,7 +137,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_point** **(** :ref:`Vector2` position, :ref:`Vector2` in=Vector2(0, 0), :ref:`Vector2` out=Vector2(0, 0), :ref:`int` index=-1 **)** +|void| **add_point**\ (\ position\: :ref:`Vector2`, in\: :ref:`Vector2` = Vector2(0, 0), out\: :ref:`Vector2` = Vector2(0, 0), index\: :ref:`int` = -1\ ) Adds a point with the specified ``position`` relative to the curve's own position, with control points ``in`` and ``out``. Appends the new point at the end of the point list. @@ -151,7 +151,7 @@ If ``index`` is given, the new point is inserted before the existing point ident .. rst-class:: classref-method -void **clear_points** **(** **)** +|void| **clear_points**\ (\ ) Removes all points from the curve. @@ -163,7 +163,7 @@ Removes all points from the curve. .. rst-class:: classref-method -:ref:`float` **get_baked_length** **(** **)** |const| +:ref:`float` **get_baked_length**\ (\ ) |const| Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`bake_interval`), it should be approximate enough. @@ -175,7 +175,7 @@ Returns the total length of the curve, based on the cached points. Given enough .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_baked_points** **(** **)** |const| +:ref:`PackedVector2Array` **get_baked_points**\ (\ ) |const| Returns the cache of points as a :ref:`PackedVector2Array`. @@ -187,7 +187,7 @@ Returns the cache of points as a :ref:`PackedVector2Array` **get_closest_offset** **(** :ref:`Vector2` to_point **)** |const| +:ref:`float` **get_closest_offset**\ (\ to_point\: :ref:`Vector2`\ ) |const| Returns the closest offset to ``to_point``. This offset is meant to be used in :ref:`sample_baked`. @@ -201,7 +201,7 @@ Returns the closest offset to ``to_point``. This offset is meant to be used in : .. rst-class:: classref-method -:ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` to_point **)** |const| +:ref:`Vector2` **get_closest_point**\ (\ to_point\: :ref:`Vector2`\ ) |const| Returns the closest point on baked segments (in curve's local space) to ``to_point``. @@ -215,7 +215,7 @@ Returns the closest point on baked segments (in curve's local space) to ``to_poi .. rst-class:: classref-method -:ref:`Vector2` **get_point_in** **(** :ref:`int` idx **)** |const| +:ref:`Vector2` **get_point_in**\ (\ idx\: :ref:`int`\ ) |const| Returns the position of the control point leading to the vertex ``idx``. The returned position is relative to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0)``. @@ -227,7 +227,7 @@ Returns the position of the control point leading to the vertex ``idx``. The ret .. rst-class:: classref-method -:ref:`Vector2` **get_point_out** **(** :ref:`int` idx **)** |const| +:ref:`Vector2` **get_point_out**\ (\ idx\: :ref:`int`\ ) |const| Returns the position of the control point leading out of the vertex ``idx``. The returned position is relative to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0)``. @@ -239,7 +239,7 @@ Returns the position of the control point leading out of the vertex ``idx``. The .. rst-class:: classref-method -:ref:`Vector2` **get_point_position** **(** :ref:`int` idx **)** |const| +:ref:`Vector2` **get_point_position**\ (\ idx\: :ref:`int`\ ) |const| Returns the position of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0)``. @@ -251,7 +251,7 @@ Returns the position of the vertex ``idx``. If the index is out of bounds, the f .. rst-class:: classref-method -void **remove_point** **(** :ref:`int` idx **)** +|void| **remove_point**\ (\ idx\: :ref:`int`\ ) Deletes the point ``idx`` from the curve. Sends an error to the console if ``idx`` is out of bounds. @@ -263,7 +263,7 @@ Deletes the point ``idx`` from the curve. Sends an error to the console if ``idx .. rst-class:: classref-method -:ref:`Vector2` **sample** **(** :ref:`int` idx, :ref:`float` t **)** |const| +:ref:`Vector2` **sample**\ (\ idx\: :ref:`int`, t\: :ref:`float`\ ) |const| Returns the position between the vertex ``idx`` and the vertex ``idx + 1``, where ``t`` controls if the point is the first vertex (``t = 0.0``), the last vertex (``t = 1.0``), or in between. Values of ``t`` outside the range (``0.0 >= t <=1``) give strange, but predictable results. @@ -277,7 +277,7 @@ If ``idx`` is out of bounds it is truncated to the first or last vertex, and ``t .. rst-class:: classref-method -:ref:`Vector2` **sample_baked** **(** :ref:`float` offset=0.0, :ref:`bool` cubic=false **)** |const| +:ref:`Vector2` **sample_baked**\ (\ offset\: :ref:`float` = 0.0, cubic\: :ref:`bool` = false\ ) |const| Returns a point within the curve at position ``offset``, where ``offset`` is measured as a pixel distance along the curve. @@ -293,7 +293,7 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and .. rst-class:: classref-method -:ref:`Transform2D` **sample_baked_with_rotation** **(** :ref:`float` offset=0.0, :ref:`bool` cubic=false **)** |const| +:ref:`Transform2D` **sample_baked_with_rotation**\ (\ offset\: :ref:`float` = 0.0, cubic\: :ref:`bool` = false\ ) |const| Similar to :ref:`sample_baked`, but returns :ref:`Transform2D` that includes a rotation along the curve, with :ref:`Transform2D.origin` as the point position and the :ref:`Transform2D.x` vector pointing in the direction of the path at that point. Returns an empty transform if the length of the curve is ``0``. @@ -314,7 +314,7 @@ Similar to :ref:`sample_baked`, but returns : .. rst-class:: classref-method -:ref:`Vector2` **samplef** **(** :ref:`float` fofs **)** |const| +:ref:`Vector2` **samplef**\ (\ fofs\: :ref:`float`\ ) |const| Returns the position at the vertex ``fofs``. It calls :ref:`sample` using the integer part of ``fofs`` as ``idx``, and its fractional part as ``t``. @@ -326,7 +326,7 @@ Returns the position at the vertex ``fofs``. It calls :ref:`sample` idx, :ref:`Vector2` position **)** +|void| **set_point_in**\ (\ idx\: :ref:`int`, position\: :ref:`Vector2`\ ) Sets the position of the control point leading to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. @@ -338,7 +338,7 @@ Sets the position of the control point leading to the vertex ``idx``. If the ind .. rst-class:: classref-method -void **set_point_out** **(** :ref:`int` idx, :ref:`Vector2` position **)** +|void| **set_point_out**\ (\ idx\: :ref:`int`, position\: :ref:`Vector2`\ ) Sets the position of the control point leading out of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. @@ -350,7 +350,7 @@ Sets the position of the control point leading out of the vertex ``idx``. If the .. rst-class:: classref-method -void **set_point_position** **(** :ref:`int` idx, :ref:`Vector2` position **)** +|void| **set_point_position**\ (\ idx\: :ref:`int`, position\: :ref:`Vector2`\ ) Sets the position for the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. @@ -362,7 +362,7 @@ Sets the position for the vertex ``idx``. If the index is out of bounds, the fun .. rst-class:: classref-method -:ref:`PackedVector2Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** |const| +:ref:`PackedVector2Array` **tessellate**\ (\ max_stages\: :ref:`int` = 5, tolerance_degrees\: :ref:`float` = 4\ ) |const| Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. @@ -380,7 +380,7 @@ This approximation makes straight segments between each point, then subdivides t .. rst-class:: classref-method -:ref:`PackedVector2Array` **tessellate_even_length** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_length=20.0 **)** |const| +:ref:`PackedVector2Array` **tessellate_even_length**\ (\ max_stages\: :ref:`int` = 5, tolerance_length\: :ref:`float` = 20.0\ ) |const| Returns a list of points along the curve, with almost uniform density. ``max_stages`` controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care! @@ -393,3 +393,4 @@ Returns a list of points along the curve, with almost uniform density. ``max_sta .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 7290a30f6d8..f70d683d098 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -47,55 +47,55 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_point` **(** :ref:`Vector3` position, :ref:`Vector3` in=Vector3(0, 0, 0), :ref:`Vector3` out=Vector3(0, 0, 0), :ref:`int` index=-1 **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_points` **(** **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_baked_length` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`get_baked_points` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`get_baked_tilts` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`get_baked_up_vectors` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_closest_offset` **(** :ref:`Vector3` to_point **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_point_tilt` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_point` **(** :ref:`int` idx **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`sample` **(** :ref:`int` idx, :ref:`float` t **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`sample_baked` **(** :ref:`float` offset=0.0, :ref:`bool` cubic=false **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`sample_baked_up_vector` **(** :ref:`float` offset, :ref:`bool` apply_tilt=false **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`sample_baked_with_rotation` **(** :ref:`float` offset=0.0, :ref:`bool` cubic=false, :ref:`bool` apply_tilt=false **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`samplef` **(** :ref:`float` fofs **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` position **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` position **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector3` position **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_tilt` **(** :ref:`int` idx, :ref:`float` tilt **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`tessellate_even_length` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_length=0.2 **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_point`\ (\ position\: :ref:`Vector3`, in\: :ref:`Vector3` = Vector3(0, 0, 0), out\: :ref:`Vector3` = Vector3(0, 0, 0), index\: :ref:`int` = -1\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_points`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_baked_length`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`get_baked_points`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`get_baked_tilts`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`get_baked_up_vectors`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_closest_offset`\ (\ to_point\: :ref:`Vector3`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_closest_point`\ (\ to_point\: :ref:`Vector3`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_point_in`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_point_out`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_point_position`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_point_tilt`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_point`\ (\ idx\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`sample`\ (\ idx\: :ref:`int`, t\: :ref:`float`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`sample_baked`\ (\ offset\: :ref:`float` = 0.0, cubic\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`sample_baked_up_vector`\ (\ offset\: :ref:`float`, apply_tilt\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`sample_baked_with_rotation`\ (\ offset\: :ref:`float` = 0.0, cubic\: :ref:`bool` = false, apply_tilt\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`samplef`\ (\ fofs\: :ref:`float`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_in`\ (\ idx\: :ref:`int`, position\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_out`\ (\ idx\: :ref:`int`, position\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_position`\ (\ idx\: :ref:`int`, position\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_tilt`\ (\ idx\: :ref:`int`, tilt\: :ref:`float`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`tessellate`\ (\ max_stages\: :ref:`int` = 5, tolerance_degrees\: :ref:`float` = 4\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`tessellate_even_length`\ (\ max_stages\: :ref:`int` = 5, tolerance_length\: :ref:`float` = 0.2\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -114,8 +114,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bake_interval** **(** :ref:`float` value **)** -- :ref:`float` **get_bake_interval** **(** **)** +- |void| **set_bake_interval**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_bake_interval**\ (\ ) The distance in meters between two adjacent cached points. Changing it forces the cache to be recomputed the next time the :ref:`get_baked_points` or :ref:`get_baked_length` function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. @@ -131,8 +131,8 @@ The distance in meters between two adjacent cached points. Changing it forces th .. rst-class:: classref-property-setget -- void **set_point_count** **(** :ref:`int` value **)** -- :ref:`int` **get_point_count** **(** **)** +- |void| **set_point_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_point_count**\ (\ ) The number of points describing the curve. @@ -148,8 +148,8 @@ The number of points describing the curve. .. rst-class:: classref-property-setget -- void **set_up_vector_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_up_vector_enabled** **(** **)** +- |void| **set_up_vector_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_up_vector_enabled**\ (\ ) If ``true``, the curve will bake up vectors used for orientation. This is used when :ref:`PathFollow3D.rotation_mode` is set to :ref:`PathFollow3D.ROTATION_ORIENTED`. Changing it forces the cache to be recomputed. @@ -166,7 +166,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_point** **(** :ref:`Vector3` position, :ref:`Vector3` in=Vector3(0, 0, 0), :ref:`Vector3` out=Vector3(0, 0, 0), :ref:`int` index=-1 **)** +|void| **add_point**\ (\ position\: :ref:`Vector3`, in\: :ref:`Vector3` = Vector3(0, 0, 0), out\: :ref:`Vector3` = Vector3(0, 0, 0), index\: :ref:`int` = -1\ ) Adds a point with the specified ``position`` relative to the curve's own position, with control points ``in`` and ``out``. Appends the new point at the end of the point list. @@ -180,7 +180,7 @@ If ``index`` is given, the new point is inserted before the existing point ident .. rst-class:: classref-method -void **clear_points** **(** **)** +|void| **clear_points**\ (\ ) Removes all points from the curve. @@ -192,7 +192,7 @@ Removes all points from the curve. .. rst-class:: classref-method -:ref:`float` **get_baked_length** **(** **)** |const| +:ref:`float` **get_baked_length**\ (\ ) |const| Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`bake_interval`), it should be approximate enough. @@ -204,7 +204,7 @@ Returns the total length of the curve, based on the cached points. Given enough .. rst-class:: classref-method -:ref:`PackedVector3Array` **get_baked_points** **(** **)** |const| +:ref:`PackedVector3Array` **get_baked_points**\ (\ ) |const| Returns the cache of points as a :ref:`PackedVector3Array`. @@ -216,7 +216,7 @@ Returns the cache of points as a :ref:`PackedVector3Array` **get_baked_tilts** **(** **)** |const| +:ref:`PackedFloat32Array` **get_baked_tilts**\ (\ ) |const| Returns the cache of tilts as a :ref:`PackedFloat32Array`. @@ -228,7 +228,7 @@ Returns the cache of tilts as a :ref:`PackedFloat32Array` **get_baked_up_vectors** **(** **)** |const| +:ref:`PackedVector3Array` **get_baked_up_vectors**\ (\ ) |const| Returns the cache of up vectors as a :ref:`PackedVector3Array`. @@ -242,7 +242,7 @@ If :ref:`up_vector_enabled` is ``false .. rst-class:: classref-method -:ref:`float` **get_closest_offset** **(** :ref:`Vector3` to_point **)** |const| +:ref:`float` **get_closest_offset**\ (\ to_point\: :ref:`Vector3`\ ) |const| Returns the closest offset to ``to_point``. This offset is meant to be used in :ref:`sample_baked` or :ref:`sample_baked_up_vector`. @@ -256,7 +256,7 @@ Returns the closest offset to ``to_point``. This offset is meant to be used in : .. rst-class:: classref-method -:ref:`Vector3` **get_closest_point** **(** :ref:`Vector3` to_point **)** |const| +:ref:`Vector3` **get_closest_point**\ (\ to_point\: :ref:`Vector3`\ ) |const| Returns the closest point on baked segments (in curve's local space) to ``to_point``. @@ -270,7 +270,7 @@ Returns the closest point on baked segments (in curve's local space) to ``to_poi .. rst-class:: classref-method -:ref:`Vector3` **get_point_in** **(** :ref:`int` idx **)** |const| +:ref:`Vector3` **get_point_in**\ (\ idx\: :ref:`int`\ ) |const| Returns the position of the control point leading to the vertex ``idx``. The returned position is relative to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0, 0)``. @@ -282,7 +282,7 @@ Returns the position of the control point leading to the vertex ``idx``. The ret .. rst-class:: classref-method -:ref:`Vector3` **get_point_out** **(** :ref:`int` idx **)** |const| +:ref:`Vector3` **get_point_out**\ (\ idx\: :ref:`int`\ ) |const| Returns the position of the control point leading out of the vertex ``idx``. The returned position is relative to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0, 0)``. @@ -294,7 +294,7 @@ Returns the position of the control point leading out of the vertex ``idx``. The .. rst-class:: classref-method -:ref:`Vector3` **get_point_position** **(** :ref:`int` idx **)** |const| +:ref:`Vector3` **get_point_position**\ (\ idx\: :ref:`int`\ ) |const| Returns the position of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0, 0)``. @@ -306,7 +306,7 @@ Returns the position of the vertex ``idx``. If the index is out of bounds, the f .. rst-class:: classref-method -:ref:`float` **get_point_tilt** **(** :ref:`int` idx **)** |const| +:ref:`float` **get_point_tilt**\ (\ idx\: :ref:`int`\ ) |const| Returns the tilt angle in radians for the point ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``0``. @@ -318,7 +318,7 @@ Returns the tilt angle in radians for the point ``idx``. If the index is out of .. rst-class:: classref-method -void **remove_point** **(** :ref:`int` idx **)** +|void| **remove_point**\ (\ idx\: :ref:`int`\ ) Deletes the point ``idx`` from the curve. Sends an error to the console if ``idx`` is out of bounds. @@ -330,7 +330,7 @@ Deletes the point ``idx`` from the curve. Sends an error to the console if ``idx .. rst-class:: classref-method -:ref:`Vector3` **sample** **(** :ref:`int` idx, :ref:`float` t **)** |const| +:ref:`Vector3` **sample**\ (\ idx\: :ref:`int`, t\: :ref:`float`\ ) |const| Returns the position between the vertex ``idx`` and the vertex ``idx + 1``, where ``t`` controls if the point is the first vertex (``t = 0.0``), the last vertex (``t = 1.0``), or in between. Values of ``t`` outside the range (``0.0 >= t <=1``) give strange, but predictable results. @@ -344,7 +344,7 @@ If ``idx`` is out of bounds it is truncated to the first or last vertex, and ``t .. rst-class:: classref-method -:ref:`Vector3` **sample_baked** **(** :ref:`float` offset=0.0, :ref:`bool` cubic=false **)** |const| +:ref:`Vector3` **sample_baked**\ (\ offset\: :ref:`float` = 0.0, cubic\: :ref:`bool` = false\ ) |const| Returns a point within the curve at position ``offset``, where ``offset`` is measured as a distance in 3D units along the curve. To do that, it finds the two cached points where the ``offset`` lies between, then interpolates the values. This interpolation is cubic if ``cubic`` is set to ``true``, or linear if set to ``false``. @@ -358,7 +358,7 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and .. rst-class:: classref-method -:ref:`Vector3` **sample_baked_up_vector** **(** :ref:`float` offset, :ref:`bool` apply_tilt=false **)** |const| +:ref:`Vector3` **sample_baked_up_vector**\ (\ offset\: :ref:`float`, apply_tilt\: :ref:`bool` = false\ ) |const| Returns an up vector within the curve at position ``offset``, where ``offset`` is measured as a distance in 3D units along the curve. To do that, it finds the two cached up vectors where the ``offset`` lies between, then interpolates the values. If ``apply_tilt`` is ``true``, an interpolated tilt is applied to the interpolated up vector. @@ -372,7 +372,7 @@ If the curve has no up vectors, the function sends an error to the console, and .. rst-class:: classref-method -:ref:`Transform3D` **sample_baked_with_rotation** **(** :ref:`float` offset=0.0, :ref:`bool` cubic=false, :ref:`bool` apply_tilt=false **)** |const| +:ref:`Transform3D` **sample_baked_with_rotation**\ (\ offset\: :ref:`float` = 0.0, cubic\: :ref:`bool` = false, apply_tilt\: :ref:`bool` = false\ ) |const| Returns a :ref:`Transform3D` with ``origin`` as point position, ``basis.x`` as sideway vector, ``basis.y`` as up vector, ``basis.z`` as forward vector. When the curve length is 0, there is no reasonable way to calculate the rotation, all vectors aligned with global space axes. See also :ref:`sample_baked`. @@ -384,7 +384,7 @@ Returns a :ref:`Transform3D` with ``origin`` as point positio .. rst-class:: classref-method -:ref:`Vector3` **samplef** **(** :ref:`float` fofs **)** |const| +:ref:`Vector3` **samplef**\ (\ fofs\: :ref:`float`\ ) |const| Returns the position at the vertex ``fofs``. It calls :ref:`sample` using the integer part of ``fofs`` as ``idx``, and its fractional part as ``t``. @@ -396,7 +396,7 @@ Returns the position at the vertex ``fofs``. It calls :ref:`sample` idx, :ref:`Vector3` position **)** +|void| **set_point_in**\ (\ idx\: :ref:`int`, position\: :ref:`Vector3`\ ) Sets the position of the control point leading to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. @@ -408,7 +408,7 @@ Sets the position of the control point leading to the vertex ``idx``. If the ind .. rst-class:: classref-method -void **set_point_out** **(** :ref:`int` idx, :ref:`Vector3` position **)** +|void| **set_point_out**\ (\ idx\: :ref:`int`, position\: :ref:`Vector3`\ ) Sets the position of the control point leading out of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. @@ -420,7 +420,7 @@ Sets the position of the control point leading out of the vertex ``idx``. If the .. rst-class:: classref-method -void **set_point_position** **(** :ref:`int` idx, :ref:`Vector3` position **)** +|void| **set_point_position**\ (\ idx\: :ref:`int`, position\: :ref:`Vector3`\ ) Sets the position for the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. @@ -432,7 +432,7 @@ Sets the position for the vertex ``idx``. If the index is out of bounds, the fun .. rst-class:: classref-method -void **set_point_tilt** **(** :ref:`int` idx, :ref:`float` tilt **)** +|void| **set_point_tilt**\ (\ idx\: :ref:`int`, tilt\: :ref:`float`\ ) Sets the tilt angle in radians for the point ``idx``. If the index is out of bounds, the function sends an error to the console. @@ -446,7 +446,7 @@ The tilt controls the rotation along the look-at axis an object traveling the pa .. rst-class:: classref-method -:ref:`PackedVector3Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** |const| +:ref:`PackedVector3Array` **tessellate**\ (\ max_stages\: :ref:`int` = 5, tolerance_degrees\: :ref:`float` = 4\ ) |const| Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. @@ -464,7 +464,7 @@ This approximation makes straight segments between each point, then subdivides t .. rst-class:: classref-method -:ref:`PackedVector3Array` **tessellate_even_length** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_length=0.2 **)** |const| +:ref:`PackedVector3Array` **tessellate_even_length**\ (\ max_stages\: :ref:`int` = 5, tolerance_length\: :ref:`float` = 0.2\ ) |const| Returns a list of points along the curve, with almost uniform density. ``max_stages`` controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care! @@ -477,3 +477,4 @@ Returns a list of points along the curve, with almost uniform density. ``max_sta .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index 26c7b161189..26b7a18f9e8 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -89,8 +89,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_curve** **(** :ref:`Curve` value **)** -- :ref:`Curve` **get_curve** **(** **)** +- |void| **set_curve**\ (\ value\: :ref:`Curve`\ ) +- :ref:`Curve` **get_curve**\ (\ ) The :ref:`Curve` that is rendered onto the texture. @@ -106,8 +106,8 @@ The :ref:`Curve` that is rendered onto the texture. .. rst-class:: classref-property-setget -- void **set_texture_mode** **(** :ref:`TextureMode` value **)** -- :ref:`TextureMode` **get_texture_mode** **(** **)** +- |void| **set_texture_mode**\ (\ value\: :ref:`TextureMode`\ ) +- :ref:`TextureMode` **get_texture_mode**\ (\ ) The format the texture should be generated with. When passing a CurveTexture as an input to a :ref:`Shader`, this may need to be adjusted. @@ -123,8 +123,8 @@ The format the texture should be generated with. When passing a CurveTexture as .. rst-class:: classref-property-setget -- void **set_width** **(** :ref:`int` value **)** -- :ref:`int` **get_width** **(** **)** +- |void| **set_width**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_width**\ (\ ) The width of the texture (in pixels). Higher values make it possible to represent high-frequency data better (such as sudden direction changes), at the cost of increased generation time and memory usage. @@ -135,3 +135,4 @@ The width of the texture (in pixels). Higher values make it possible to represen .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_curvexyztexture.rst b/classes/class_curvexyztexture.rst index 7f10d55d6f6..01a55d98737 100644 --- a/classes/class_curvexyztexture.rst +++ b/classes/class_curvexyztexture.rst @@ -60,8 +60,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_curve_x** **(** :ref:`Curve` value **)** -- :ref:`Curve` **get_curve_x** **(** **)** +- |void| **set_curve_x**\ (\ value\: :ref:`Curve`\ ) +- :ref:`Curve` **get_curve_x**\ (\ ) The :ref:`Curve` that is rendered onto the texture's red channel. @@ -77,8 +77,8 @@ The :ref:`Curve` that is rendered onto the texture's red channel. .. rst-class:: classref-property-setget -- void **set_curve_y** **(** :ref:`Curve` value **)** -- :ref:`Curve` **get_curve_y** **(** **)** +- |void| **set_curve_y**\ (\ value\: :ref:`Curve`\ ) +- :ref:`Curve` **get_curve_y**\ (\ ) The :ref:`Curve` that is rendered onto the texture's green channel. @@ -94,8 +94,8 @@ The :ref:`Curve` that is rendered onto the texture's green channel. .. rst-class:: classref-property-setget -- void **set_curve_z** **(** :ref:`Curve` value **)** -- :ref:`Curve` **get_curve_z** **(** **)** +- |void| **set_curve_z**\ (\ value\: :ref:`Curve`\ ) +- :ref:`Curve` **get_curve_z**\ (\ ) The :ref:`Curve` that is rendered onto the texture's blue channel. @@ -111,8 +111,8 @@ The :ref:`Curve` that is rendered onto the texture's blue channel. .. rst-class:: classref-property-setget -- void **set_width** **(** :ref:`int` value **)** -- :ref:`int` **get_width** **(** **)** +- |void| **set_width**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_width**\ (\ ) The width of the texture (in pixels). Higher values make it possible to represent high-frequency data better (such as sudden direction changes), at the cost of increased generation time and memory usage. @@ -123,3 +123,4 @@ The width of the texture (in pixels). Higher values make it possible to represen .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_cylindermesh.rst b/classes/class_cylindermesh.rst index 3ee943ee87d..6d1f4ba7213 100644 --- a/classes/class_cylindermesh.rst +++ b/classes/class_cylindermesh.rst @@ -62,8 +62,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bottom_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_bottom_radius** **(** **)** +- |void| **set_bottom_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_bottom_radius**\ (\ ) Bottom radius of the cylinder. If set to ``0.0``, the bottom faces will not be generated, resulting in a conic shape. See also :ref:`cap_bottom`. @@ -79,8 +79,8 @@ Bottom radius of the cylinder. If set to ``0.0``, the bottom faces will not be g .. rst-class:: classref-property-setget -- void **set_cap_bottom** **(** :ref:`bool` value **)** -- :ref:`bool` **is_cap_bottom** **(** **)** +- |void| **set_cap_bottom**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_cap_bottom**\ (\ ) If ``true``, generates a cap at the bottom of the cylinder. This can be set to ``false`` to speed up generation and rendering when the cap is never seen by the camera. See also :ref:`bottom_radius`. @@ -98,8 +98,8 @@ If ``true``, generates a cap at the bottom of the cylinder. This can be set to ` .. rst-class:: classref-property-setget -- void **set_cap_top** **(** :ref:`bool` value **)** -- :ref:`bool` **is_cap_top** **(** **)** +- |void| **set_cap_top**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_cap_top**\ (\ ) If ``true``, generates a cap at the top of the cylinder. This can be set to ``false`` to speed up generation and rendering when the cap is never seen by the camera. See also :ref:`top_radius`. @@ -117,8 +117,8 @@ If ``true``, generates a cap at the top of the cylinder. This can be set to ``fa .. rst-class:: classref-property-setget -- void **set_height** **(** :ref:`float` value **)** -- :ref:`float` **get_height** **(** **)** +- |void| **set_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_height**\ (\ ) Full height of the cylinder. @@ -134,8 +134,8 @@ Full height of the cylinder. .. rst-class:: classref-property-setget -- void **set_radial_segments** **(** :ref:`int` value **)** -- :ref:`int` **get_radial_segments** **(** **)** +- |void| **set_radial_segments**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_radial_segments**\ (\ ) Number of radial segments on the cylinder. Higher values result in a more detailed cylinder/cone at the cost of performance. @@ -151,8 +151,8 @@ Number of radial segments on the cylinder. Higher values result in a more detail .. rst-class:: classref-property-setget -- void **set_rings** **(** :ref:`int` value **)** -- :ref:`int` **get_rings** **(** **)** +- |void| **set_rings**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_rings**\ (\ ) Number of edge rings along the height of the cylinder. Changing :ref:`rings` does not have any visual impact unless a shader or procedural mesh tool is used to alter the vertex data. Higher values result in more subdivisions, which can be used to create smoother-looking effects with shaders or procedural mesh tools (at the cost of performance). When not altering the vertex data using a shader or procedural mesh tool, :ref:`rings` should be kept to its default value. @@ -168,8 +168,8 @@ Number of edge rings along the height of the cylinder. Changing :ref:`rings` value **)** -- :ref:`float` **get_top_radius** **(** **)** +- |void| **set_top_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_top_radius**\ (\ ) Top radius of the cylinder. If set to ``0.0``, the top faces will not be generated, resulting in a conic shape. See also :ref:`cap_top`. @@ -180,3 +180,4 @@ Top radius of the cylinder. If set to ``0.0``, the top faces will not be generat .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_cylindershape3d.rst b/classes/class_cylindershape3d.rst index f06d6d1ccb4..fa8cd2d328d 100644 --- a/classes/class_cylindershape3d.rst +++ b/classes/class_cylindershape3d.rst @@ -67,8 +67,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_height** **(** :ref:`float` value **)** -- :ref:`float` **get_height** **(** **)** +- |void| **set_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_height**\ (\ ) The cylinder's height. @@ -84,8 +84,8 @@ The cylinder's height. .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) The cylinder's radius. @@ -96,3 +96,4 @@ The cylinder's radius. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index 5681fd97874..e72bda7c7df 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -56,8 +56,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_damping** **(** :ref:`float` value **)** -- :ref:`float` **get_damping** **(** **)** +- |void| **set_damping**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_damping**\ (\ ) The spring joint's damping ratio. A value between ``0`` and ``1``. When the two bodies move into different directions the system tries to align them to the spring axis again. A high :ref:`damping` value forces the attached bodies to align faster. @@ -73,8 +73,8 @@ The spring joint's damping ratio. A value between ``0`` and ``1``. When the two .. rst-class:: classref-property-setget -- void **set_length** **(** :ref:`float` value **)** -- :ref:`float` **get_length** **(** **)** +- |void| **set_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_length**\ (\ ) The spring joint's maximum length. The two attached bodies cannot stretch it past this value. @@ -90,8 +90,8 @@ The spring joint's maximum length. The two attached bodies cannot stretch it pas .. rst-class:: classref-property-setget -- void **set_rest_length** **(** :ref:`float` value **)** -- :ref:`float` **get_rest_length** **(** **)** +- |void| **set_rest_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_rest_length**\ (\ ) When the bodies attached to the spring joint move they stretch or squash it. The joint always tries to resize towards this length. @@ -107,8 +107,8 @@ When the bodies attached to the spring joint move they stretch or squash it. The .. rst-class:: classref-property-setget -- void **set_stiffness** **(** :ref:`float` value **)** -- :ref:`float` **get_stiffness** **(** **)** +- |void| **set_stiffness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_stiffness**\ (\ ) The higher the value, the less the bodies attached to the joint will deform it. The joint applies an opposing force to the bodies, the product of the stiffness multiplied by the size difference from its resting length. @@ -119,3 +119,4 @@ The higher the value, the less the bodies attached to the joint will deform it. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_decal.rst b/classes/class_decal.rst index 7076acf53b6..d18440b5557 100644 --- a/classes/class_decal.rst +++ b/classes/class_decal.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: stain + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -79,11 +82,11 @@ Methods .. table:: :widths: auto - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_texture` **(** :ref:`DecalTexture` type **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_texture` **(** :ref:`DecalTexture` type, :ref:`Texture2D` texture **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_texture`\ (\ type\: :ref:`DecalTexture`\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_texture`\ (\ type\: :ref:`DecalTexture`, texture\: :ref:`Texture2D`\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -157,8 +160,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_albedo_mix** **(** :ref:`float` value **)** -- :ref:`float` **get_albedo_mix** **(** **)** +- |void| **set_albedo_mix**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_albedo_mix**\ (\ ) Blends the albedo :ref:`Color` of the decal with albedo :ref:`Color` of the underlying mesh. This can be set to ``0.0`` to create a decal that only affects normal or ORM. In this case, an albedo texture is still required as its alpha channel will determine where the normal and ORM will be overridden. See also :ref:`modulate`. @@ -174,8 +177,8 @@ Blends the albedo :ref:`Color` of the decal with albedo :ref:`Color .. rst-class:: classref-property-setget -- void **set_cull_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_cull_mask** **(** **)** +- |void| **set_cull_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_cull_mask**\ (\ ) Specifies which :ref:`VisualInstance3D.layers` this decal will project on. By default, Decals affect all layers. This is used so you can specify which types of objects receive the Decal and which do not. This is especially useful so you can ensure that dynamic objects don't accidentally receive a Decal intended for the terrain under them. @@ -191,8 +194,8 @@ Specifies which :ref:`VisualInstance3D.layers` value **)** -- :ref:`float` **get_distance_fade_begin** **(** **)** +- |void| **set_distance_fade_begin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_distance_fade_begin**\ (\ ) The distance from the camera at which the Decal begins to fade away (in 3D units). @@ -208,8 +211,8 @@ The distance from the camera at which the Decal begins to fade away (in 3D units .. rst-class:: classref-property-setget -- void **set_enable_distance_fade** **(** :ref:`bool` value **)** -- :ref:`bool` **is_distance_fade_enabled** **(** **)** +- |void| **set_enable_distance_fade**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_distance_fade_enabled**\ (\ ) If ``true``, decals will smoothly fade away when far from the active :ref:`Camera3D` starting at :ref:`distance_fade_begin`. The Decal will fade out over :ref:`distance_fade_begin` + :ref:`distance_fade_length`, after which it will be culled and not sent to the shader at all. Use this to reduce the number of active Decals in a scene and thus improve performance. @@ -225,8 +228,8 @@ If ``true``, decals will smoothly fade away when far from the active :ref:`Camer .. rst-class:: classref-property-setget -- void **set_distance_fade_length** **(** :ref:`float` value **)** -- :ref:`float` **get_distance_fade_length** **(** **)** +- |void| **set_distance_fade_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_distance_fade_length**\ (\ ) The distance over which the Decal fades (in 3D units). The Decal becomes slowly more transparent over this distance and is completely invisible at the end. Higher values result in a smoother fade-out transition, which is more suited when the camera moves fast. @@ -242,8 +245,8 @@ The distance over which the Decal fades (in 3D units). The Decal becomes slowly .. rst-class:: classref-property-setget -- void **set_emission_energy** **(** :ref:`float` value **)** -- :ref:`float` **get_emission_energy** **(** **)** +- |void| **set_emission_energy**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_emission_energy**\ (\ ) Energy multiplier for the emission texture. This will make the decal emit light at a higher or lower intensity, independently of the albedo color. See also :ref:`modulate`. @@ -259,8 +262,8 @@ Energy multiplier for the emission texture. This will make the decal emit light .. rst-class:: classref-property-setget -- void **set_lower_fade** **(** :ref:`float` value **)** -- :ref:`float` **get_lower_fade** **(** **)** +- |void| **set_lower_fade**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_lower_fade**\ (\ ) Sets the curve over which the decal will fade as the surface gets further from the center of the :ref:`AABB`. Only positive values are valid (negative values will be clamped to ``0.0``). See also :ref:`upper_fade`. @@ -276,8 +279,8 @@ Sets the curve over which the decal will fade as the surface gets further from t .. rst-class:: classref-property-setget -- void **set_modulate** **(** :ref:`Color` value **)** -- :ref:`Color` **get_modulate** **(** **)** +- |void| **set_modulate**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_modulate**\ (\ ) Changes the :ref:`Color` of the Decal by multiplying the albedo and emission colors with this value. The alpha component is only taken into account when multiplying the albedo color, not the emission color. See also :ref:`emission_energy` and :ref:`albedo_mix` to change the emission and albedo intensity independently of each other. @@ -293,8 +296,8 @@ Changes the :ref:`Color` of the Decal by multiplying the albedo and .. rst-class:: classref-property-setget -- void **set_normal_fade** **(** :ref:`float` value **)** -- :ref:`float` **get_normal_fade** **(** **)** +- |void| **set_normal_fade**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_normal_fade**\ (\ ) Fades the Decal if the angle between the Decal's :ref:`AABB` and the target surface becomes too large. A value of ``0`` projects the Decal regardless of angle, a value of ``1`` limits the Decal to surfaces that are nearly perpendicular. @@ -312,8 +315,8 @@ Fades the Decal if the angle between the Decal's :ref:`AABB` and the .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_size**\ (\ ) Sets the size of the :ref:`AABB` used by the decal. All dimensions must be set to a value greater than zero (they will be clamped to ``0.001`` if this is not the case). The AABB goes from ``-size/2`` to ``size/2``. @@ -331,8 +334,8 @@ Sets the size of the :ref:`AABB` used by the decal. All dimensions m .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`DecalTexture` type, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`DecalTexture` type **)** |const| +- |void| **set_texture**\ (\ type\: :ref:`DecalTexture`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ type\: :ref:`DecalTexture`\ ) |const| :ref:`Texture2D` with the base :ref:`Color` of the Decal. Either this or the :ref:`texture_emission` must be set for the Decal to be visible. Use the alpha channel like a mask to smoothly blend the edges of the decal with the underlying object. @@ -350,8 +353,8 @@ Sets the size of the :ref:`AABB` used by the decal. All dimensions m .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`DecalTexture` type, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`DecalTexture` type **)** |const| +- |void| **set_texture**\ (\ type\: :ref:`DecalTexture`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ type\: :ref:`DecalTexture`\ ) |const| :ref:`Texture2D` with the emission :ref:`Color` of the Decal. Either this or the :ref:`texture_albedo` must be set for the Decal to be visible. Use the alpha channel like a mask to smoothly blend the edges of the decal with the underlying object. @@ -369,8 +372,8 @@ Sets the size of the :ref:`AABB` used by the decal. All dimensions m .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`DecalTexture` type, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`DecalTexture` type **)** |const| +- |void| **set_texture**\ (\ type\: :ref:`DecalTexture`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ type\: :ref:`DecalTexture`\ ) |const| :ref:`Texture2D` with the per-pixel normal map for the decal. Use this to add extra detail to decals. @@ -390,8 +393,8 @@ Sets the size of the :ref:`AABB` used by the decal. All dimensions m .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`DecalTexture` type, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_texture** **(** :ref:`DecalTexture` type **)** |const| +- |void| **set_texture**\ (\ type\: :ref:`DecalTexture`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ type\: :ref:`DecalTexture`\ ) |const| :ref:`Texture2D` storing ambient occlusion, roughness, and metallic for the decal. Use this to add extra detail to decals. @@ -411,8 +414,8 @@ Sets the size of the :ref:`AABB` used by the decal. All dimensions m .. rst-class:: classref-property-setget -- void **set_upper_fade** **(** :ref:`float` value **)** -- :ref:`float` **get_upper_fade** **(** **)** +- |void| **set_upper_fade**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_upper_fade**\ (\ ) Sets the curve over which the decal will fade as the surface gets further from the center of the :ref:`AABB`. Only positive values are valid (negative values will be clamped to ``0.0``). See also :ref:`lower_fade`. @@ -429,7 +432,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Texture2D` **get_texture** **(** :ref:`DecalTexture` type **)** |const| +:ref:`Texture2D` **get_texture**\ (\ type\: :ref:`DecalTexture`\ ) |const| Returns the :ref:`Texture2D` associated with the specified :ref:`DecalTexture`. This is a convenience method, in most cases you should access the texture directly. @@ -462,7 +465,7 @@ One case where this is better than accessing the texture directly is when you wa .. rst-class:: classref-method -void **set_texture** **(** :ref:`DecalTexture` type, :ref:`Texture2D` texture **)** +|void| **set_texture**\ (\ type\: :ref:`DecalTexture`, texture\: :ref:`Texture2D`\ ) Sets the :ref:`Texture2D` associated with the specified :ref:`DecalTexture`. This is a convenience method, in most cases you should access the texture directly. @@ -494,3 +497,4 @@ One case where this is better than accessing the texture directly is when you wa .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index 89a9d73ad34..08c0c1245e8 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -212,11 +212,11 @@ Constructors .. table:: :widths: auto - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`Dictionary` **(** **)** | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`Dictionary` **(** :ref:`Dictionary` from **)** | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`Dictionary`\ (\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`Dictionary`\ (\ from\: :ref:`Dictionary`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -226,39 +226,39 @@ Methods .. table:: :widths: auto - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`duplicate` **(** :ref:`bool` deep=false **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`erase` **(** :ref:`Variant` key **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`find_key` **(** :ref:`Variant` value **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get` **(** :ref:`Variant` key, :ref:`Variant` default=null **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_or_add` **(** :ref:`Variant` key, :ref:`Variant` default=null **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has` **(** :ref:`Variant` key **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_all` **(** :ref:`Array` keys **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`hash` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_read_only` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`keys` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`make_read_only` **(** **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`merge` **(** :ref:`Dictionary` dictionary, :ref:`bool` overwrite=false **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`values` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`duplicate`\ (\ deep\: :ref:`bool` = false\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`erase`\ (\ key\: :ref:`Variant`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`find_key`\ (\ value\: :ref:`Variant`\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get`\ (\ key\: :ref:`Variant`, default\: :ref:`Variant` = null\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_or_add`\ (\ key\: :ref:`Variant`, default\: :ref:`Variant` = null\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ key\: :ref:`Variant`\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_all`\ (\ keys\: :ref:`Array`\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`hash`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_read_only`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`keys`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`make_read_only`\ (\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`merge`\ (\ dictionary\: :ref:`Dictionary`, overwrite\: :ref:`bool` = false\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`values`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -268,13 +268,13 @@ Operators .. table:: :widths: auto - +-------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Dictionary` right **)** | - +-------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Dictionary` right **)** | - +-------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`operator []` **(** :ref:`Variant` key **)** | - +-------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Dictionary`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Dictionary`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`operator []`\ (\ key\: :ref:`Variant`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -289,7 +289,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Dictionary` **Dictionary** **(** **)** +:ref:`Dictionary` **Dictionary**\ (\ ) Constructs an empty **Dictionary**. @@ -299,7 +299,7 @@ Constructs an empty **Dictionary**. .. rst-class:: classref-constructor -:ref:`Dictionary` **Dictionary** **(** :ref:`Dictionary` from **)** +:ref:`Dictionary` **Dictionary**\ (\ from\: :ref:`Dictionary`\ ) Returns the same dictionary as ``from``. If you need a copy of the dictionary, use :ref:`duplicate`. @@ -316,7 +316,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the dictionary, removing all entries from it. @@ -328,7 +328,7 @@ Clears the dictionary, removing all entries from it. .. rst-class:: classref-method -:ref:`Dictionary` **duplicate** **(** :ref:`bool` deep=false **)** |const| +:ref:`Dictionary` **duplicate**\ (\ deep\: :ref:`bool` = false\ ) |const| Creates and returns a new copy of the dictionary. If ``deep`` is ``true``, inner **Dictionary** and :ref:`Array` keys and values are also copied, recursively. @@ -340,7 +340,7 @@ Creates and returns a new copy of the dictionary. If ``deep`` is ``true``, inner .. rst-class:: classref-method -:ref:`bool` **erase** **(** :ref:`Variant` key **)** +:ref:`bool` **erase**\ (\ key\: :ref:`Variant`\ ) Removes the dictionary entry by key, if it exists. Returns ``true`` if the given ``key`` existed in the dictionary, otherwise ``false``. @@ -354,7 +354,7 @@ Removes the dictionary entry by key, if it exists. Returns ``true`` if the given .. rst-class:: classref-method -:ref:`Variant` **find_key** **(** :ref:`Variant` value **)** |const| +:ref:`Variant` **find_key**\ (\ value\: :ref:`Variant`\ ) |const| Finds and returns the first key whose associated value is equal to ``value``, or ``null`` if it is not found. @@ -368,7 +368,7 @@ Finds and returns the first key whose associated value is equal to ``value``, or .. rst-class:: classref-method -:ref:`Variant` **get** **(** :ref:`Variant` key, :ref:`Variant` default=null **)** |const| +:ref:`Variant` **get**\ (\ key\: :ref:`Variant`, default\: :ref:`Variant` = null\ ) |const| Returns the corresponding value for the given ``key`` in the dictionary. If the ``key`` does not exist, returns ``default``, or ``null`` if the parameter is omitted. @@ -380,7 +380,7 @@ Returns the corresponding value for the given ``key`` in the dictionary. If the .. rst-class:: classref-method -:ref:`Variant` **get_or_add** **(** :ref:`Variant` key, :ref:`Variant` default=null **)** +:ref:`Variant` **get_or_add**\ (\ key\: :ref:`Variant`, default\: :ref:`Variant` = null\ ) Gets a value and ensures the key is set. If the ``key`` exists in the dictionary, this behaves like :ref:`get`. Otherwise, the ``default`` value is inserted into the dictionary and returned. @@ -392,7 +392,7 @@ Gets a value and ensures the key is set. If the ``key`` exists in the dictionary .. rst-class:: classref-method -:ref:`bool` **has** **(** :ref:`Variant` key **)** |const| +:ref:`bool` **has**\ (\ key\: :ref:`Variant`\ ) |const| Returns ``true`` if the dictionary contains an entry with the given ``key``. @@ -441,7 +441,7 @@ In GDScript, this is equivalent to the ``in`` operator: .. rst-class:: classref-method -:ref:`bool` **has_all** **(** :ref:`Array` keys **)** |const| +:ref:`bool` **has_all**\ (\ keys\: :ref:`Array`\ ) |const| Returns ``true`` if the dictionary contains all keys in the given ``keys`` array. @@ -458,7 +458,7 @@ Returns ``true`` if the dictionary contains all keys in the given ``keys`` array .. rst-class:: classref-method -:ref:`int` **hash** **(** **)** |const| +:ref:`int` **hash**\ (\ ) |const| Returns a hashed 32-bit integer value representing the dictionary contents. @@ -494,7 +494,7 @@ Returns a hashed 32-bit integer value representing the dictionary contents. .. rst-class:: classref-method -:ref:`bool` **is_empty** **(** **)** |const| +:ref:`bool` **is_empty**\ (\ ) |const| Returns ``true`` if the dictionary is empty (its size is ``0``). See also :ref:`size`. @@ -506,7 +506,7 @@ Returns ``true`` if the dictionary is empty (its size is ``0``). See also :ref:` .. rst-class:: classref-method -:ref:`bool` **is_read_only** **(** **)** |const| +:ref:`bool` **is_read_only**\ (\ ) |const| Returns ``true`` if the dictionary is read-only. See :ref:`make_read_only`. Dictionaries are automatically read-only if declared with ``const`` keyword. @@ -518,7 +518,7 @@ Returns ``true`` if the dictionary is read-only. See :ref:`make_read_only` **keys** **(** **)** |const| +:ref:`Array` **keys**\ (\ ) |const| Returns the list of keys in the dictionary. @@ -530,7 +530,7 @@ Returns the list of keys in the dictionary. .. rst-class:: classref-method -void **make_read_only** **(** **)** +|void| **make_read_only**\ (\ ) Makes the dictionary read-only, i.e. disables modification of the dictionary's contents. Does not apply to nested content, e.g. content of nested dictionaries. @@ -542,7 +542,7 @@ Makes the dictionary read-only, i.e. disables modification of the dictionary's c .. rst-class:: classref-method -void **merge** **(** :ref:`Dictionary` dictionary, :ref:`bool` overwrite=false **)** +|void| **merge**\ (\ dictionary\: :ref:`Dictionary`, overwrite\: :ref:`bool` = false\ ) Adds entries from ``dictionary`` to this dictionary. By default, duplicate keys are not copied over, unless ``overwrite`` is ``true``. @@ -596,7 +596,7 @@ Adds entries from ``dictionary`` to this dictionary. By default, duplicate keys .. rst-class:: classref-method -:ref:`int` **size** **(** **)** |const| +:ref:`int` **size**\ (\ ) |const| Returns the number of entries in the dictionary. Empty dictionaries (``{ }``) always return ``0``. See also :ref:`is_empty`. @@ -608,7 +608,7 @@ Returns the number of entries in the dictionary. Empty dictionaries (``{ }``) al .. rst-class:: classref-method -:ref:`Array` **values** **(** **)** |const| +:ref:`Array` **values**\ (\ ) |const| Returns the list of values in this dictionary. @@ -625,7 +625,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Dictionary` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Dictionary`\ ) Returns ``true`` if the two dictionaries do not contain the same keys and values. @@ -637,7 +637,7 @@ Returns ``true`` if the two dictionaries do not contain the same keys and values .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`Dictionary` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Dictionary`\ ) Returns ``true`` if the two dictionaries contain the same keys and values. The order of the entries does not matter. @@ -651,7 +651,7 @@ Returns ``true`` if the two dictionaries contain the same keys and values. The o .. rst-class:: classref-operator -:ref:`Variant` **operator []** **(** :ref:`Variant` key **)** +:ref:`Variant` **operator []**\ (\ key\: :ref:`Variant`\ ) Returns the corresponding value for the given ``key`` in the dictionary. If the entry does not exist, fails and returns ``null``. For safe access, use :ref:`get` or :ref:`has`. @@ -662,3 +662,4 @@ Returns the corresponding value for the given ``key`` in the dictionary. If the .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_diraccess.rst b/classes/class_diraccess.rst index 354e5fbffc2..3d676161349 100644 --- a/classes/class_diraccess.rst +++ b/classes/class_diraccess.rst @@ -118,67 +118,67 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`change_dir` **(** :ref:`String` to_dir **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`copy` **(** :ref:`String` from, :ref:`String` to, :ref:`int` chmod_flags=-1 **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`copy_absolute` **(** :ref:`String` from, :ref:`String` to, :ref:`int` chmod_flags=-1 **)** |static| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`current_is_dir` **(** **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`dir_exists` **(** :ref:`String` path **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`dir_exists_absolute` **(** :ref:`String` path **)** |static| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_current_dir` **(** :ref:`bool` include_drive=true **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_current_drive` **(** **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_directories` **(** **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_directories_at` **(** :ref:`String` path **)** |static| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_drive_count` **(** **)** |static| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_drive_name` **(** :ref:`int` idx **)** |static| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_files` **(** **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_files_at` **(** :ref:`String` path **)** |static| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_next` **(** **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`get_open_error` **(** **)** |static| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_space_left` **(** **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_case_sensitive` **(** :ref:`String` path **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`list_dir_begin` **(** **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`list_dir_end` **(** **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`make_dir` **(** :ref:`String` path **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`make_dir_absolute` **(** :ref:`String` path **)** |static| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`make_dir_recursive` **(** :ref:`String` path **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`make_dir_recursive_absolute` **(** :ref:`String` path **)** |static| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`DirAccess` | :ref:`open` **(** :ref:`String` path **)** |static| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`remove` **(** :ref:`String` path **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`remove_absolute` **(** :ref:`String` path **)** |static| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`rename` **(** :ref:`String` from, :ref:`String` to **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`rename_absolute` **(** :ref:`String` from, :ref:`String` to **)** |static| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`change_dir`\ (\ to_dir\: :ref:`String`\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`copy`\ (\ from\: :ref:`String`, to\: :ref:`String`, chmod_flags\: :ref:`int` = -1\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`copy_absolute`\ (\ from\: :ref:`String`, to\: :ref:`String`, chmod_flags\: :ref:`int` = -1\ ) |static| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`current_is_dir`\ (\ ) |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`dir_exists`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`dir_exists_absolute`\ (\ path\: :ref:`String`\ ) |static| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`file_exists`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_current_dir`\ (\ include_drive\: :ref:`bool` = true\ ) |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_current_drive`\ (\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_directories`\ (\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_directories_at`\ (\ path\: :ref:`String`\ ) |static| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_drive_count`\ (\ ) |static| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_drive_name`\ (\ idx\: :ref:`int`\ ) |static| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_files`\ (\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_files_at`\ (\ path\: :ref:`String`\ ) |static| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_next`\ (\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`get_open_error`\ (\ ) |static| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_space_left`\ (\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_case_sensitive`\ (\ path\: :ref:`String`\ ) |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`list_dir_begin`\ (\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`list_dir_end`\ (\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`make_dir`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`make_dir_absolute`\ (\ path\: :ref:`String`\ ) |static| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`make_dir_recursive`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`make_dir_recursive_absolute`\ (\ path\: :ref:`String`\ ) |static| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`DirAccess` | :ref:`open`\ (\ path\: :ref:`String`\ ) |static| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`remove`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`remove_absolute`\ (\ path\: :ref:`String`\ ) |static| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`rename`\ (\ from\: :ref:`String`, to\: :ref:`String`\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`rename_absolute`\ (\ from\: :ref:`String`, to\: :ref:`String`\ ) |static| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -197,8 +197,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_include_hidden** **(** :ref:`bool` value **)** -- :ref:`bool` **get_include_hidden** **(** **)** +- |void| **set_include_hidden**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_include_hidden**\ (\ ) If ``true``, hidden files are included when navigating the directory. @@ -216,8 +216,8 @@ Affects :ref:`list_dir_begin`, :ref:`get_ .. rst-class:: classref-property-setget -- void **set_include_navigational** **(** :ref:`bool` value **)** -- :ref:`bool` **get_include_navigational** **(** **)** +- |void| **set_include_navigational**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_include_navigational**\ (\ ) If ``true``, ``.`` and ``..`` are included when navigating the directory. @@ -236,7 +236,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **change_dir** **(** :ref:`String` to_dir **)** +:ref:`Error` **change_dir**\ (\ to_dir\: :ref:`String`\ ) Changes the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. ``newdir`` or ``../newdir``), or an absolute path (e.g. ``/tmp/newdir`` or ``res://somedir/newdir``). @@ -252,7 +252,7 @@ Returns one of the :ref:`Error` code constants (:ref:`@ .. rst-class:: classref-method -:ref:`Error` **copy** **(** :ref:`String` from, :ref:`String` to, :ref:`int` chmod_flags=-1 **)** +:ref:`Error` **copy**\ (\ from\: :ref:`String`, to\: :ref:`String`, chmod_flags\: :ref:`int` = -1\ ) Copies the ``from`` file to the ``to`` destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. @@ -268,7 +268,7 @@ Returns one of the :ref:`Error` code constants (:ref:`@ .. rst-class:: classref-method -:ref:`Error` **copy_absolute** **(** :ref:`String` from, :ref:`String` to, :ref:`int` chmod_flags=-1 **)** |static| +:ref:`Error` **copy_absolute**\ (\ from\: :ref:`String`, to\: :ref:`String`, chmod_flags\: :ref:`int` = -1\ ) |static| Static version of :ref:`copy`. Supports only absolute paths. @@ -280,7 +280,7 @@ Static version of :ref:`copy`. Supports only absolu .. rst-class:: classref-method -:ref:`bool` **current_is_dir** **(** **)** |const| +:ref:`bool` **current_is_dir**\ (\ ) |const| Returns whether the current item processed with the last :ref:`get_next` call is a directory (``.`` and ``..`` are considered directories). @@ -292,7 +292,7 @@ Returns whether the current item processed with the last :ref:`get_next` **dir_exists** **(** :ref:`String` path **)** +:ref:`bool` **dir_exists**\ (\ path\: :ref:`String`\ ) Returns whether the target directory exists. The argument can be relative to the current directory, or an absolute path. @@ -304,7 +304,7 @@ Returns whether the target directory exists. The argument can be relative to the .. rst-class:: classref-method -:ref:`bool` **dir_exists_absolute** **(** :ref:`String` path **)** |static| +:ref:`bool` **dir_exists_absolute**\ (\ path\: :ref:`String`\ ) |static| Static version of :ref:`dir_exists`. Supports only absolute paths. @@ -316,7 +316,7 @@ Static version of :ref:`dir_exists`. Supports .. rst-class:: classref-method -:ref:`bool` **file_exists** **(** :ref:`String` path **)** +:ref:`bool` **file_exists**\ (\ path\: :ref:`String`\ ) Returns whether the target file exists. The argument can be relative to the current directory, or an absolute path. @@ -330,7 +330,7 @@ For a static equivalent, use :ref:`FileAccess.file_exists` **get_current_dir** **(** :ref:`bool` include_drive=true **)** |const| +:ref:`String` **get_current_dir**\ (\ include_drive\: :ref:`bool` = true\ ) |const| Returns the absolute path to the currently opened directory (e.g. ``res://folder`` or ``C:\tmp\folder``). @@ -342,7 +342,7 @@ Returns the absolute path to the currently opened directory (e.g. ``res://folder .. rst-class:: classref-method -:ref:`int` **get_current_drive** **(** **)** +:ref:`int` **get_current_drive**\ (\ ) Returns the currently opened directory's drive index. See :ref:`get_drive_name` to convert returned index to the name of the drive. @@ -354,7 +354,7 @@ Returns the currently opened directory's drive index. See :ref:`get_drive_name` **get_directories** **(** **)** +:ref:`PackedStringArray` **get_directories**\ (\ ) Returns a :ref:`PackedStringArray` containing filenames of the directory contents, excluding files. The array is sorted alphabetically. @@ -368,7 +368,7 @@ Affected by :ref:`include_hidden` and : .. rst-class:: classref-method -:ref:`PackedStringArray` **get_directories_at** **(** :ref:`String` path **)** |static| +:ref:`PackedStringArray` **get_directories_at**\ (\ path\: :ref:`String`\ ) |static| Returns a :ref:`PackedStringArray` containing filenames of the directory contents, excluding files, at the given ``path``. The array is sorted alphabetically. @@ -382,7 +382,7 @@ Use :ref:`get_directories` if you want m .. rst-class:: classref-method -:ref:`int` **get_drive_count** **(** **)** |static| +:ref:`int` **get_drive_count**\ (\ ) |static| On Windows, returns the number of drives (partitions) mounted on the current filesystem. @@ -400,7 +400,7 @@ On other platforms, the method returns 0. .. rst-class:: classref-method -:ref:`String` **get_drive_name** **(** :ref:`int` idx **)** |static| +:ref:`String` **get_drive_name**\ (\ idx\: :ref:`int`\ ) |static| On Windows, returns the name of the drive (partition) passed as an argument (e.g. ``C:``). @@ -418,7 +418,7 @@ On other platforms, or if the requested drive does not exist, the method returns .. rst-class:: classref-method -:ref:`PackedStringArray` **get_files** **(** **)** +:ref:`PackedStringArray` **get_files**\ (\ ) Returns a :ref:`PackedStringArray` containing filenames of the directory contents, excluding directories. The array is sorted alphabetically. @@ -434,7 +434,7 @@ Affected by :ref:`include_hidden`. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_files_at** **(** :ref:`String` path **)** |static| +:ref:`PackedStringArray` **get_files_at**\ (\ path\: :ref:`String`\ ) |static| Returns a :ref:`PackedStringArray` containing filenames of the directory contents, excluding directories, at the given ``path``. The array is sorted alphabetically. @@ -448,7 +448,7 @@ Use :ref:`get_files` if you want more control .. rst-class:: classref-method -:ref:`String` **get_next** **(** **)** +:ref:`String` **get_next**\ (\ ) Returns the next element (file or directory) in the current directory. @@ -462,7 +462,7 @@ The name of the file or directory is returned (and not its full path). Once the .. rst-class:: classref-method -:ref:`Error` **get_open_error** **(** **)** |static| +:ref:`Error` **get_open_error**\ (\ ) |static| Returns the result of the last :ref:`open` call in the current thread. @@ -474,7 +474,7 @@ Returns the result of the last :ref:`open` call in .. rst-class:: classref-method -:ref:`int` **get_space_left** **(** **)** +:ref:`int` **get_space_left**\ (\ ) Returns the available space on the current directory's disk, in bytes. Returns ``0`` if the platform-specific method to query the available space fails. @@ -486,7 +486,7 @@ Returns the available space on the current directory's disk, in bytes. Returns ` .. rst-class:: classref-method -:ref:`bool` **is_case_sensitive** **(** :ref:`String` path **)** |const| +:ref:`bool` **is_case_sensitive**\ (\ path\: :ref:`String`\ ) |const| Returns ``true`` if the file system or directory use case sensitive file names. @@ -500,7 +500,7 @@ Returns ``true`` if the file system or directory use case sensitive file names. .. rst-class:: classref-method -:ref:`Error` **list_dir_begin** **(** **)** +:ref:`Error` **list_dir_begin**\ (\ ) Initializes the stream used to list all files and directories using the :ref:`get_next` function, closing the currently opened stream if needed. Once the stream has been processed, it should typically be closed with :ref:`list_dir_end`. @@ -516,7 +516,7 @@ Affected by :ref:`include_hidden` and : .. rst-class:: classref-method -void **list_dir_end** **(** **)** +|void| **list_dir_end**\ (\ ) Closes the current stream opened with :ref:`list_dir_begin` (whether it has been fully processed with :ref:`get_next` does not matter). @@ -528,7 +528,7 @@ Closes the current stream opened with :ref:`list_dir_begin` **make_dir** **(** :ref:`String` path **)** +:ref:`Error` **make_dir**\ (\ path\: :ref:`String`\ ) Creates a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see :ref:`make_dir_recursive`). @@ -542,7 +542,7 @@ Returns one of the :ref:`Error` code constants (:ref:`@ .. rst-class:: classref-method -:ref:`Error` **make_dir_absolute** **(** :ref:`String` path **)** |static| +:ref:`Error` **make_dir_absolute**\ (\ path\: :ref:`String`\ ) |static| Static version of :ref:`make_dir`. Supports only absolute paths. @@ -554,7 +554,7 @@ Static version of :ref:`make_dir`. Supports onl .. rst-class:: classref-method -:ref:`Error` **make_dir_recursive** **(** :ref:`String` path **)** +:ref:`Error` **make_dir_recursive**\ (\ path\: :ref:`String`\ ) Creates a target directory and all necessary intermediate directories in its path, by calling :ref:`make_dir` recursively. The argument can be relative to the current directory, or an absolute path. @@ -568,7 +568,7 @@ Returns one of the :ref:`Error` code constants (:ref:`@ .. rst-class:: classref-method -:ref:`Error` **make_dir_recursive_absolute** **(** :ref:`String` path **)** |static| +:ref:`Error` **make_dir_recursive_absolute**\ (\ path\: :ref:`String`\ ) |static| Static version of :ref:`make_dir_recursive`. Supports only absolute paths. @@ -580,7 +580,7 @@ Static version of :ref:`make_dir_recursive` **open** **(** :ref:`String` path **)** |static| +:ref:`DirAccess` **open**\ (\ path\: :ref:`String`\ ) |static| Creates a new **DirAccess** object and opens an existing directory of the filesystem. The ``path`` argument can be within the project tree (``res://folder``), the user directory (``user://folder``) or an absolute path of the user filesystem (e.g. ``/tmp/folder`` or ``C:\tmp\folder``). @@ -594,7 +594,7 @@ Returns ``null`` if opening the directory failed. You can use :ref:`get_open_err .. rst-class:: classref-method -:ref:`Error` **remove** **(** :ref:`String` path **)** +:ref:`Error` **remove**\ (\ path\: :ref:`String`\ ) Permanently deletes the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. @@ -610,7 +610,7 @@ Returns one of the :ref:`Error` code constants (:ref:`@ .. rst-class:: classref-method -:ref:`Error` **remove_absolute** **(** :ref:`String` path **)** |static| +:ref:`Error` **remove_absolute**\ (\ path\: :ref:`String`\ ) |static| Static version of :ref:`remove`. Supports only absolute paths. @@ -622,7 +622,7 @@ Static version of :ref:`remove`. Supports only ab .. rst-class:: classref-method -:ref:`Error` **rename** **(** :ref:`String` from, :ref:`String` to **)** +:ref:`Error` **rename**\ (\ from\: :ref:`String`, to\: :ref:`String`\ ) Renames (move) the ``from`` file or directory to the ``to`` destination. Both arguments should be paths to files or directories, either relative or absolute. If the destination file or directory exists and is not access-protected, it will be overwritten. @@ -636,7 +636,7 @@ Returns one of the :ref:`Error` code constants (:ref:`@ .. rst-class:: classref-method -:ref:`Error` **rename_absolute** **(** :ref:`String` from, :ref:`String` to **)** |static| +:ref:`Error` **rename_absolute**\ (\ from\: :ref:`String`, to\: :ref:`String`\ ) |static| Static version of :ref:`rename`. Supports only absolute paths. @@ -647,3 +647,4 @@ Static version of :ref:`rename`. Supports only ab .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_directionallight2d.rst b/classes/class_directionallight2d.rst index 5d99424c311..bf7c6ebe4bc 100644 --- a/classes/class_directionallight2d.rst +++ b/classes/class_directionallight2d.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: sun + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -61,8 +64,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_height** **(** :ref:`float` value **)** -- :ref:`float` **get_height** **(** **)** +- |void| **set_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_height**\ (\ ) The height of the light. Used with 2D normal mapping. Ranges from 0 (parallel to the plane) to 1 (perpendicular to the plane). @@ -78,8 +81,8 @@ The height of the light. Used with 2D normal mapping. Ranges from 0 (parallel to .. rst-class:: classref-property-setget -- void **set_max_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_max_distance** **(** **)** +- |void| **set_max_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_max_distance**\ (\ ) The maximum distance from the camera center objects can be before their shadows are culled (in pixels). Decreasing this value can prevent objects located outside the camera from casting shadows (while also improving performance). :ref:`Camera2D.zoom` is not taken into account by :ref:`max_distance`, which means that at higher zoom values, shadows will appear to fade out sooner when zooming onto a given point. @@ -90,3 +93,4 @@ The maximum distance from the camera center objects can be before their shadows .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_directionallight3d.rst b/classes/class_directionallight3d.rst index 27df5ffed1b..beb06d0d0bd 100644 --- a/classes/class_directionallight3d.rst +++ b/classes/class_directionallight3d.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: sun + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -148,8 +151,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_blend_splits** **(** :ref:`bool` value **)** -- :ref:`bool` **is_blend_splits_enabled** **(** **)** +- |void| **set_blend_splits**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_blend_splits_enabled**\ (\ ) If ``true``, shadow detail is sacrificed in exchange for smoother transitions between splits. Enabling shadow blend splitting also has a moderate performance cost. This is ignored when :ref:`directional_shadow_mode` is :ref:`SHADOW_ORTHOGONAL`. @@ -165,8 +168,8 @@ If ``true``, shadow detail is sacrificed in exchange for smoother transitions be .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`float` value **)** -- :ref:`float` **get_param** **(** **)** +- |void| **set_param**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ ) Proportion of :ref:`directional_shadow_max_distance` at which point the shadow starts to fade. At :ref:`directional_shadow_max_distance`, the shadow will disappear. The default value is a balance between smooth fading and distant shadow visibility. If the camera moves fast and the :ref:`directional_shadow_max_distance` is low, consider lowering :ref:`directional_shadow_fade_start` below ``0.8`` to make shadow transitions less noticeable. On the other hand, if you tuned :ref:`directional_shadow_max_distance` to cover the entire scene, you can set :ref:`directional_shadow_fade_start` to ``1.0`` to prevent the shadow from fading in the distance (it will suddenly cut off instead). @@ -182,8 +185,8 @@ Proportion of :ref:`directional_shadow_max_distance` value **)** -- :ref:`float` **get_param** **(** **)** +- |void| **set_param**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ ) The maximum distance for shadow splits. Increasing this value will make directional shadows visible from further away, at the cost of lower overall shadow detail and performance (since more objects need to be included in the directional shadow rendering). @@ -199,8 +202,8 @@ The maximum distance for shadow splits. Increasing this value will make directio .. rst-class:: classref-property-setget -- void **set_shadow_mode** **(** :ref:`ShadowMode` value **)** -- :ref:`ShadowMode` **get_shadow_mode** **(** **)** +- |void| **set_shadow_mode**\ (\ value\: :ref:`ShadowMode`\ ) +- :ref:`ShadowMode` **get_shadow_mode**\ (\ ) The light's shadow rendering algorithm. See :ref:`ShadowMode`. @@ -216,8 +219,8 @@ The light's shadow rendering algorithm. See :ref:`ShadowMode` value **)** -- :ref:`float` **get_param** **(** **)** +- |void| **set_param**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ ) Sets the size of the directional shadow pancake. The pancake offsets the start of the shadow's camera frustum to provide a higher effective depth resolution for the shadow. However, a high pancake size can cause artifacts in the shadows of large objects that are close to the edge of the frustum. Reducing the pancake size can help. Setting the size to ``0`` turns off the pancaking effect. @@ -233,8 +236,8 @@ Sets the size of the directional shadow pancake. The pancake offsets the start o .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`float` value **)** -- :ref:`float` **get_param** **(** **)** +- |void| **set_param**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ ) The distance from camera to shadow split 1. Relative to :ref:`directional_shadow_max_distance`. Only used when :ref:`directional_shadow_mode` is :ref:`SHADOW_PARALLEL_2_SPLITS` or :ref:`SHADOW_PARALLEL_4_SPLITS`. @@ -250,8 +253,8 @@ The distance from camera to shadow split 1. Relative to :ref:`directional_shadow .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`float` value **)** -- :ref:`float` **get_param** **(** **)** +- |void| **set_param**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ ) The distance from shadow split 1 to split 2. Relative to :ref:`directional_shadow_max_distance`. Only used when :ref:`directional_shadow_mode` is :ref:`SHADOW_PARALLEL_4_SPLITS`. @@ -267,8 +270,8 @@ The distance from shadow split 1 to split 2. Relative to :ref:`directional_shado .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`float` value **)** -- :ref:`float` **get_param** **(** **)** +- |void| **set_param**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ ) The distance from shadow split 2 to split 3. Relative to :ref:`directional_shadow_max_distance`. Only used when :ref:`directional_shadow_mode` is :ref:`SHADOW_PARALLEL_4_SPLITS`. @@ -284,8 +287,8 @@ The distance from shadow split 2 to split 3. Relative to :ref:`directional_shado .. rst-class:: classref-property-setget -- void **set_sky_mode** **(** :ref:`SkyMode` value **)** -- :ref:`SkyMode` **get_sky_mode** **(** **)** +- |void| **set_sky_mode**\ (\ value\: :ref:`SkyMode`\ ) +- :ref:`SkyMode` **get_sky_mode**\ (\ ) Set whether this **DirectionalLight3D** is visible in the sky, in the scene, or both in the sky and in the scene. See :ref:`SkyMode` for options. @@ -296,3 +299,4 @@ Set whether this **DirectionalLight3D** is visible in the sky, in the scene, or .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index 55e415cf325..54ae8264aa3 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -31,363 +31,363 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`clipboard_get` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`clipboard_get_image` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`clipboard_get_primary` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`clipboard_has` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`clipboard_has_image` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clipboard_set` **(** :ref:`String` clipboard **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clipboard_set_primary` **(** :ref:`String` clipboard_primary **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`create_status_indicator` **(** :ref:`Image` icon, :ref:`String` tooltip, :ref:`Callable` callback **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`CursorShape` | :ref:`cursor_get_shape` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`cursor_set_custom_image` **(** :ref:`Resource` cursor, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2(0, 0) **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`cursor_set_shape` **(** :ref:`CursorShape` shape **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`delete_status_indicator` **(** :ref:`int` id **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`dialog_input_text` **(** :ref:`String` title, :ref:`String` description, :ref:`String` existing_text, :ref:`Callable` callback **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`dialog_show` **(** :ref:`String` title, :ref:`String` description, :ref:`PackedStringArray` buttons, :ref:`Callable` callback **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`enable_for_stealing_focus` **(** :ref:`int` process_id **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`file_dialog_show` **(** :ref:`String` title, :ref:`String` current_directory, :ref:`String` filename, :ref:`bool` show_hidden, :ref:`FileDialogMode` mode, :ref:`PackedStringArray` filters, :ref:`Callable` callback **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`file_dialog_with_options_show` **(** :ref:`String` title, :ref:`String` current_directory, :ref:`String` root, :ref:`String` filename, :ref:`bool` show_hidden, :ref:`FileDialogMode` mode, :ref:`PackedStringArray` filters, :ref:`Dictionary[]` options, :ref:`Callable` callback **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`force_process_and_drop_events` **(** **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_accent_color` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_base_color` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2[]` | :ref:`get_display_cutouts` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`get_display_safe_area` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_keyboard_focus_screen` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_name` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_primary_screen` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_screen_count` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_screen_from_rect` **(** :ref:`Rect2` rect **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_swap_cancel_ok` **(** **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_window_at_screen_position` **(** :ref:`Vector2i` position **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_window_list` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_check_item` **(** :ref:`String` menu_root, :ref:`String` label, :ref:`Callable` callback=Callable(), :ref:`Callable` key_callback=Callable(), :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_icon_check_item` **(** :ref:`String` menu_root, :ref:`Texture2D` icon, :ref:`String` label, :ref:`Callable` callback=Callable(), :ref:`Callable` key_callback=Callable(), :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_icon_item` **(** :ref:`String` menu_root, :ref:`Texture2D` icon, :ref:`String` label, :ref:`Callable` callback=Callable(), :ref:`Callable` key_callback=Callable(), :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_icon_radio_check_item` **(** :ref:`String` menu_root, :ref:`Texture2D` icon, :ref:`String` label, :ref:`Callable` callback=Callable(), :ref:`Callable` key_callback=Callable(), :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_item` **(** :ref:`String` menu_root, :ref:`String` label, :ref:`Callable` callback=Callable(), :ref:`Callable` key_callback=Callable(), :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_multistate_item` **(** :ref:`String` menu_root, :ref:`String` label, :ref:`int` max_states, :ref:`int` default_state, :ref:`Callable` callback=Callable(), :ref:`Callable` key_callback=Callable(), :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_radio_check_item` **(** :ref:`String` menu_root, :ref:`String` label, :ref:`Callable` callback=Callable(), :ref:`Callable` key_callback=Callable(), :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_separator` **(** :ref:`String` menu_root, :ref:`int` index=-1 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_submenu_item` **(** :ref:`String` menu_root, :ref:`String` label, :ref:`String` submenu, :ref:`int` index=-1 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_clear` **(** :ref:`String` menu_root **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Key` | :ref:`global_menu_get_item_accelerator` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Callable` | :ref:`global_menu_get_item_callback` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_get_item_count` **(** :ref:`String` menu_root **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`global_menu_get_item_icon` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_get_item_indentation_level` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_get_item_index_from_tag` **(** :ref:`String` menu_root, :ref:`Variant` tag **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_get_item_index_from_text` **(** :ref:`String` menu_root, :ref:`String` text **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Callable` | :ref:`global_menu_get_item_key_callback` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_get_item_max_states` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_get_item_state` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`global_menu_get_item_submenu` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`global_menu_get_item_tag` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`global_menu_get_item_text` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`global_menu_get_item_tooltip` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`global_menu_get_system_menu_roots` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`global_menu_is_item_checkable` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`global_menu_is_item_checked` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`global_menu_is_item_disabled` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`global_menu_is_item_hidden` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`global_menu_is_item_radio_checkable` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_remove_item` **(** :ref:`String` menu_root, :ref:`int` idx **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_set_item_accelerator` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Key` keycode **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_set_item_callback` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Callable` callback **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_set_item_checkable` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`bool` checkable **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_set_item_checked` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`bool` checked **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_set_item_disabled` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`bool` disabled **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_set_item_hidden` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`bool` hidden **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_set_item_hover_callbacks` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Callable` callback **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_set_item_icon` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Texture2D` icon **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_set_item_indentation_level` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`int` level **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_set_item_key_callback` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Callable` key_callback **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_set_item_max_states` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`int` max_states **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_set_item_radio_checkable` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`bool` checkable **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_set_item_state` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`int` state **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_set_item_submenu` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`String` submenu **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_set_item_tag` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Variant` tag **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_set_item_text` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`String` text **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_set_item_tooltip` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`String` tooltip **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_menu_set_popup_callbacks` **(** :ref:`String` menu_root, :ref:`Callable` open_callback, :ref:`Callable` close_callback **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_feature` **(** :ref:`Feature` feature **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`help_set_search_callbacks` **(** :ref:`Callable` search_callback, :ref:`Callable` action_callback **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`ime_get_selection` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`ime_get_text` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_dark_mode` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_dark_mode_supported` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_touchscreen_available` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`keyboard_get_current_layout` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Key` | :ref:`keyboard_get_keycode_from_physical` **(** :ref:`Key` keycode **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Key` | :ref:`keyboard_get_label_from_physical` **(** :ref:`Key` keycode **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`keyboard_get_layout_count` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`keyboard_get_layout_language` **(** :ref:`int` index **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`keyboard_get_layout_name` **(** :ref:`int` index **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`keyboard_set_current_layout` **(** :ref:`int` index **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`MouseButtonMask`\> | :ref:`mouse_get_button_state` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`MouseMode` | :ref:`mouse_get_mode` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`mouse_get_position` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`mouse_set_mode` **(** :ref:`MouseMode` mouse_mode **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`process_events` **(** **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`screen_get_dpi` **(** :ref:`int` screen=-1 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`screen_get_image` **(** :ref:`int` screen=-1 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`screen_get_max_scale` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ScreenOrientation` | :ref:`screen_get_orientation` **(** :ref:`int` screen=-1 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`screen_get_pixel` **(** :ref:`Vector2i` position **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`screen_get_position` **(** :ref:`int` screen=-1 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`screen_get_refresh_rate` **(** :ref:`int` screen=-1 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`screen_get_scale` **(** :ref:`int` screen=-1 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`screen_get_size` **(** :ref:`int` screen=-1 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`screen_get_usable_rect` **(** :ref:`int` screen=-1 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`screen_is_kept_on` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`screen_set_keep_on` **(** :ref:`bool` enable **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`screen_set_orientation` **(** :ref:`ScreenOrientation` orientation, :ref:`int` screen=-1 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_icon` **(** :ref:`Image` image **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_native_icon` **(** :ref:`String` filename **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_system_theme_change_callback` **(** :ref:`Callable` callable **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`status_indicator_set_callback` **(** :ref:`int` id, :ref:`Callable` callback **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`status_indicator_set_icon` **(** :ref:`int` id, :ref:`Image` icon **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`status_indicator_set_tooltip` **(** :ref:`int` id, :ref:`String` tooltip **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`tablet_get_current_driver` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`tablet_get_driver_count` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`tablet_get_driver_name` **(** :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`tablet_set_current_driver` **(** :ref:`String` name **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`tts_get_voices` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`tts_get_voices_for_language` **(** :ref:`String` language **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`tts_is_paused` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`tts_is_speaking` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`tts_pause` **(** **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`tts_resume` **(** **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`tts_set_utterance_callback` **(** :ref:`TTSUtteranceEvent` event, :ref:`Callable` callable **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`tts_speak` **(** :ref:`String` text, :ref:`String` voice, :ref:`int` volume=50, :ref:`float` pitch=1.0, :ref:`float` rate=1.0, :ref:`int` utterance_id=0, :ref:`bool` interrupt=false **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`tts_stop` **(** **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`virtual_keyboard_get_height` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`virtual_keyboard_hide` **(** **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`virtual_keyboard_show` **(** :ref:`String` existing_text, :ref:`Rect2` position=Rect2(0, 0, 0, 0), :ref:`VirtualKeyboardType` type=0, :ref:`int` max_length=-1, :ref:`int` cursor_start=-1, :ref:`int` cursor_end=-1 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`warp_mouse` **(** :ref:`Vector2i` position **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`window_can_draw` **(** :ref:`int` window_id=0 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`window_get_active_popup` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`window_get_attached_instance_id` **(** :ref:`int` window_id=0 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`window_get_current_screen` **(** :ref:`int` window_id=0 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`window_get_flag` **(** :ref:`WindowFlags` flag, :ref:`int` window_id=0 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_max_size` **(** :ref:`int` window_id=0 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_min_size` **(** :ref:`int` window_id=0 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`WindowMode` | :ref:`window_get_mode` **(** :ref:`int` window_id=0 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`window_get_native_handle` **(** :ref:`HandleType` handle_type, :ref:`int` window_id=0 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`window_get_popup_safe_rect` **(** :ref:`int` window **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_position` **(** :ref:`int` window_id=0 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_position_with_decorations` **(** :ref:`int` window_id=0 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`window_get_safe_title_margins` **(** :ref:`int` window_id=0 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_size` **(** :ref:`int` window_id=0 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_size_with_decorations` **(** :ref:`int` window_id=0 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_title_size` **(** :ref:`String` title, :ref:`int` window_id=0 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VSyncMode` | :ref:`window_get_vsync_mode` **(** :ref:`int` window_id=0 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`window_is_focused` **(** :ref:`int` window_id=0 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`window_is_maximize_allowed` **(** :ref:`int` window_id=0 **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`window_maximize_on_title_dbl_click` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`window_minimize_on_title_dbl_click` **(** **)** |const| | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_move_to_foreground` **(** :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_request_attention` **(** :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_current_screen` **(** :ref:`int` screen, :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_drop_files_callback` **(** :ref:`Callable` callback, :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_exclusive` **(** :ref:`int` window_id, :ref:`bool` exclusive **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_flag` **(** :ref:`WindowFlags` flag, :ref:`bool` enabled, :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_ime_active` **(** :ref:`bool` active, :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_ime_position` **(** :ref:`Vector2i` position, :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_input_event_callback` **(** :ref:`Callable` callback, :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_input_text_callback` **(** :ref:`Callable` callback, :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_max_size` **(** :ref:`Vector2i` max_size, :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_min_size` **(** :ref:`Vector2i` min_size, :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_mode` **(** :ref:`WindowMode` mode, :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_mouse_passthrough` **(** :ref:`PackedVector2Array` region, :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_popup_safe_rect` **(** :ref:`int` window, :ref:`Rect2i` rect **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_position` **(** :ref:`Vector2i` position, :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_rect_changed_callback` **(** :ref:`Callable` callback, :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_size` **(** :ref:`Vector2i` size, :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_title` **(** :ref:`String` title, :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_transient` **(** :ref:`int` window_id, :ref:`int` parent_window_id **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_vsync_mode` **(** :ref:`VSyncMode` vsync_mode, :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_window_buttons_offset` **(** :ref:`Vector2i` offset, :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`window_set_window_event_callback` **(** :ref:`Callable` callback, :ref:`int` window_id=0 **)** | - +-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`clipboard_get`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`clipboard_get_image`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`clipboard_get_primary`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`clipboard_has`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`clipboard_has_image`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clipboard_set`\ (\ clipboard\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clipboard_set_primary`\ (\ clipboard_primary\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`create_status_indicator`\ (\ icon\: :ref:`Image`, tooltip\: :ref:`String`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CursorShape` | :ref:`cursor_get_shape`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cursor_set_custom_image`\ (\ cursor\: :ref:`Resource`, shape\: :ref:`CursorShape` = 0, hotspot\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cursor_set_shape`\ (\ shape\: :ref:`CursorShape`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`delete_status_indicator`\ (\ id\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`dialog_input_text`\ (\ title\: :ref:`String`, description\: :ref:`String`, existing_text\: :ref:`String`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`dialog_show`\ (\ title\: :ref:`String`, description\: :ref:`String`, buttons\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`enable_for_stealing_focus`\ (\ process_id\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`file_dialog_show`\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`file_dialog_with_options_show`\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, root\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, options\: :ref:`Array`\[:ref:`Dictionary`\], callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_process_and_drop_events`\ (\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_accent_color`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_base_color`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Rect2`\] | :ref:`get_display_cutouts`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`get_display_safe_area`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_keyboard_focus_screen`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_name`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_primary_screen`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_screen_count`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_screen_from_rect`\ (\ rect\: :ref:`Rect2`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_swap_cancel_ok`\ (\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_window_at_screen_position`\ (\ position\: :ref:`Vector2i`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_window_list`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_check_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_icon_check_item`\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_icon_item`\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_icon_radio_check_item`\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_multistate_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, max_states\: :ref:`int`, default_state\: :ref:`int`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_radio_check_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_separator`\ (\ menu_root\: :ref:`String`, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_submenu_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, submenu\: :ref:`String`, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_clear`\ (\ menu_root\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Key` | :ref:`global_menu_get_item_accelerator`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Callable` | :ref:`global_menu_get_item_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_get_item_count`\ (\ menu_root\: :ref:`String`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`global_menu_get_item_icon`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_get_item_indentation_level`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_get_item_index_from_tag`\ (\ menu_root\: :ref:`String`, tag\: :ref:`Variant`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_get_item_index_from_text`\ (\ menu_root\: :ref:`String`, text\: :ref:`String`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Callable` | :ref:`global_menu_get_item_key_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_get_item_max_states`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_get_item_state`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`global_menu_get_item_submenu`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`global_menu_get_item_tag`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`global_menu_get_item_text`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`global_menu_get_item_tooltip`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`global_menu_get_system_menu_roots`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`global_menu_is_item_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`global_menu_is_item_checked`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`global_menu_is_item_disabled`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`global_menu_is_item_hidden`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`global_menu_is_item_radio_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_remove_item`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_accelerator`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, keycode\: :ref:`Key`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_checked`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checked\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_disabled`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_hidden`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, hidden\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_hover_callbacks`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_icon`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_indentation_level`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, level\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_key_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, key_callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_max_states`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, max_states\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_radio_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_state`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, state\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_submenu`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, submenu\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_tag`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, tag\: :ref:`Variant`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_text`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, text\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_tooltip`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_popup_callbacks`\ (\ menu_root\: :ref:`String`, open_callback\: :ref:`Callable`, close_callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_feature`\ (\ feature\: :ref:`Feature`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`help_set_search_callbacks`\ (\ search_callback\: :ref:`Callable`, action_callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`ime_get_selection`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ime_get_text`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_dark_mode`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_dark_mode_supported`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_touchscreen_available`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`keyboard_get_current_layout`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Key` | :ref:`keyboard_get_keycode_from_physical`\ (\ keycode\: :ref:`Key`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Key` | :ref:`keyboard_get_label_from_physical`\ (\ keycode\: :ref:`Key`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`keyboard_get_layout_count`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`keyboard_get_layout_language`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`keyboard_get_layout_name`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`keyboard_set_current_layout`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`MouseButtonMask`\] | :ref:`mouse_get_button_state`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`MouseMode` | :ref:`mouse_get_mode`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`mouse_get_position`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`mouse_set_mode`\ (\ mouse_mode\: :ref:`MouseMode`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`process_events`\ (\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`screen_get_dpi`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`screen_get_image`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`screen_get_max_scale`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ScreenOrientation` | :ref:`screen_get_orientation`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`screen_get_pixel`\ (\ position\: :ref:`Vector2i`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`screen_get_position`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`screen_get_refresh_rate`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`screen_get_scale`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`screen_get_size`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`screen_get_usable_rect`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`screen_is_kept_on`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`screen_set_keep_on`\ (\ enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`screen_set_orientation`\ (\ orientation\: :ref:`ScreenOrientation`, screen\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon`\ (\ image\: :ref:`Image`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_native_icon`\ (\ filename\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_system_theme_change_callback`\ (\ callable\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`status_indicator_set_callback`\ (\ id\: :ref:`int`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`status_indicator_set_icon`\ (\ id\: :ref:`int`, icon\: :ref:`Image`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`status_indicator_set_tooltip`\ (\ id\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`tablet_get_current_driver`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`tablet_get_driver_count`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`tablet_get_driver_name`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tablet_set_current_driver`\ (\ name\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`tts_get_voices`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`tts_get_voices_for_language`\ (\ language\: :ref:`String`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`tts_is_paused`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`tts_is_speaking`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tts_pause`\ (\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tts_resume`\ (\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tts_set_utterance_callback`\ (\ event\: :ref:`TTSUtteranceEvent`, callable\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tts_speak`\ (\ text\: :ref:`String`, voice\: :ref:`String`, volume\: :ref:`int` = 50, pitch\: :ref:`float` = 1.0, rate\: :ref:`float` = 1.0, utterance_id\: :ref:`int` = 0, interrupt\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tts_stop`\ (\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`virtual_keyboard_get_height`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`virtual_keyboard_hide`\ (\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`virtual_keyboard_show`\ (\ existing_text\: :ref:`String`, position\: :ref:`Rect2` = Rect2(0, 0, 0, 0), type\: :ref:`VirtualKeyboardType` = 0, max_length\: :ref:`int` = -1, cursor_start\: :ref:`int` = -1, cursor_end\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`warp_mouse`\ (\ position\: :ref:`Vector2i`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`window_can_draw`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`window_get_active_popup`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`window_get_attached_instance_id`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`window_get_current_screen`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`window_get_flag`\ (\ flag\: :ref:`WindowFlags`, window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_max_size`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_min_size`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`WindowMode` | :ref:`window_get_mode`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`window_get_native_handle`\ (\ handle_type\: :ref:`HandleType`, window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`window_get_popup_safe_rect`\ (\ window\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_position`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_position_with_decorations`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`window_get_safe_title_margins`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_size`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_size_with_decorations`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_title_size`\ (\ title\: :ref:`String`, window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`VSyncMode` | :ref:`window_get_vsync_mode`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`window_is_focused`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`window_is_maximize_allowed`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`window_maximize_on_title_dbl_click`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`window_minimize_on_title_dbl_click`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_move_to_foreground`\ (\ window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_request_attention`\ (\ window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_current_screen`\ (\ screen\: :ref:`int`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_drop_files_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_exclusive`\ (\ window_id\: :ref:`int`, exclusive\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_flag`\ (\ flag\: :ref:`WindowFlags`, enabled\: :ref:`bool`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_ime_active`\ (\ active\: :ref:`bool`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_ime_position`\ (\ position\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_input_event_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_input_text_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_max_size`\ (\ max_size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_min_size`\ (\ min_size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_mode`\ (\ mode\: :ref:`WindowMode`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_mouse_passthrough`\ (\ region\: :ref:`PackedVector2Array`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_popup_safe_rect`\ (\ window\: :ref:`int`, rect\: :ref:`Rect2i`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_position`\ (\ position\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_rect_changed_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_size`\ (\ size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_title`\ (\ title\: :ref:`String`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_transient`\ (\ window_id\: :ref:`int`, parent_window_id\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_vsync_mode`\ (\ vsync_mode\: :ref:`VSyncMode`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_window_buttons_offset`\ (\ offset\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_window_event_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -1468,7 +1468,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **clipboard_get** **(** **)** |const| +:ref:`String` **clipboard_get**\ (\ ) |const| Returns the user's clipboard as a string if possible. @@ -1480,7 +1480,7 @@ Returns the user's clipboard as a string if possible. .. rst-class:: classref-method -:ref:`Image` **clipboard_get_image** **(** **)** |const| +:ref:`Image` **clipboard_get_image**\ (\ ) |const| Returns the user's clipboard as an image if possible. @@ -1492,7 +1492,7 @@ Returns the user's clipboard as an image if possible. .. rst-class:: classref-method -:ref:`String` **clipboard_get_primary** **(** **)** |const| +:ref:`String` **clipboard_get_primary**\ (\ ) |const| Returns the user's `primary `__ clipboard as a string if possible. This is the clipboard that is set when the user selects text in any application, rather than when pressing :kbd:`Ctrl + C`. The clipboard data can then be pasted by clicking the middle mouse button in any application that supports the primary clipboard mechanism. @@ -1506,7 +1506,7 @@ Returns the user's `primary ` **clipboard_has** **(** **)** |const| +:ref:`bool` **clipboard_has**\ (\ ) |const| Returns ``true`` if there is a text content on the user's clipboard. @@ -1518,7 +1518,7 @@ Returns ``true`` if there is a text content on the user's clipboard. .. rst-class:: classref-method -:ref:`bool` **clipboard_has_image** **(** **)** |const| +:ref:`bool` **clipboard_has_image**\ (\ ) |const| Returns ``true`` if there is an image content on the user's clipboard. @@ -1530,7 +1530,7 @@ Returns ``true`` if there is an image content on the user's clipboard. .. rst-class:: classref-method -void **clipboard_set** **(** :ref:`String` clipboard **)** +|void| **clipboard_set**\ (\ clipboard\: :ref:`String`\ ) Sets the user's clipboard content to the given string. @@ -1542,7 +1542,7 @@ Sets the user's clipboard content to the given string. .. rst-class:: classref-method -void **clipboard_set_primary** **(** :ref:`String` clipboard_primary **)** +|void| **clipboard_set_primary**\ (\ clipboard_primary\: :ref:`String`\ ) Sets the user's `primary `__ clipboard content to the given string. This is the clipboard that is set when the user selects text in any application, rather than when pressing :kbd:`Ctrl + C`. The clipboard data can then be pasted by clicking the middle mouse button in any application that supports the primary clipboard mechanism. @@ -1556,7 +1556,7 @@ Sets the user's `primary ` **create_status_indicator** **(** :ref:`Image` icon, :ref:`String` tooltip, :ref:`Callable` callback **)** +:ref:`int` **create_status_indicator**\ (\ icon\: :ref:`Image`, tooltip\: :ref:`String`, callback\: :ref:`Callable`\ ) Creates a new application status indicator with the specified icon, tooltip, and activation callback. @@ -1568,7 +1568,7 @@ Creates a new application status indicator with the specified icon, tooltip, and .. rst-class:: classref-method -:ref:`CursorShape` **cursor_get_shape** **(** **)** |const| +:ref:`CursorShape` **cursor_get_shape**\ (\ ) |const| Returns the default mouse cursor shape set by :ref:`cursor_set_shape`. @@ -1580,7 +1580,7 @@ Returns the default mouse cursor shape set by :ref:`cursor_set_shape` cursor, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2(0, 0) **)** +|void| **cursor_set_custom_image**\ (\ cursor\: :ref:`Resource`, shape\: :ref:`CursorShape` = 0, hotspot\: :ref:`Vector2` = Vector2(0, 0)\ ) Sets a custom mouse cursor image for the defined ``shape``. This means the user's operating system and mouse cursor theme will no longer influence the mouse cursor's appearance. The image must be ``256x256`` or smaller for correct appearance. ``hotspot`` can optionally be set to define the area where the cursor will click. By default, ``hotspot`` is set to ``Vector2(0, 0)``, which is the top-left corner of the image. See also :ref:`cursor_set_shape`. @@ -1592,7 +1592,7 @@ Sets a custom mouse cursor image for the defined ``shape``. This means the user' .. rst-class:: classref-method -void **cursor_set_shape** **(** :ref:`CursorShape` shape **)** +|void| **cursor_set_shape**\ (\ shape\: :ref:`CursorShape`\ ) Sets the default mouse cursor shape. The cursor's appearance will vary depending on the user's operating system and mouse cursor theme. See also :ref:`cursor_get_shape` and :ref:`cursor_set_custom_image`. @@ -1604,7 +1604,7 @@ Sets the default mouse cursor shape. The cursor's appearance will vary depending .. rst-class:: classref-method -void **delete_status_indicator** **(** :ref:`int` id **)** +|void| **delete_status_indicator**\ (\ id\: :ref:`int`\ ) Removes the application status indicator. @@ -1616,7 +1616,7 @@ Removes the application status indicator. .. rst-class:: classref-method -:ref:`Error` **dialog_input_text** **(** :ref:`String` title, :ref:`String` description, :ref:`String` existing_text, :ref:`Callable` callback **)** +:ref:`Error` **dialog_input_text**\ (\ title\: :ref:`String`, description\: :ref:`String`, existing_text\: :ref:`String`, callback\: :ref:`Callable`\ ) Shows a text input dialog which uses the operating system's native look-and-feel. ``callback`` will be called with a :ref:`String` argument equal to the text field's contents when the dialog is closed for any reason. @@ -1630,7 +1630,7 @@ Shows a text input dialog which uses the operating system's native look-and-feel .. rst-class:: classref-method -:ref:`Error` **dialog_show** **(** :ref:`String` title, :ref:`String` description, :ref:`PackedStringArray` buttons, :ref:`Callable` callback **)** +:ref:`Error` **dialog_show**\ (\ title\: :ref:`String`, description\: :ref:`String`, buttons\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) Shows a text dialog which uses the operating system's native look-and-feel. ``callback`` will be called when the dialog is closed for any reason. @@ -1644,7 +1644,7 @@ Shows a text dialog which uses the operating system's native look-and-feel. ``ca .. rst-class:: classref-method -void **enable_for_stealing_focus** **(** :ref:`int` process_id **)** +|void| **enable_for_stealing_focus**\ (\ process_id\: :ref:`int`\ ) Allows the ``process_id`` PID to steal focus from this window. In other words, this disables the operating system's focus stealing protection for the specified PID. @@ -1658,7 +1658,7 @@ Allows the ``process_id`` PID to steal focus from this window. In other words, t .. rst-class:: classref-method -:ref:`Error` **file_dialog_show** **(** :ref:`String` title, :ref:`String` current_directory, :ref:`String` filename, :ref:`bool` show_hidden, :ref:`FileDialogMode` mode, :ref:`PackedStringArray` filters, :ref:`Callable` callback **)** +:ref:`Error` **file_dialog_show**\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) Displays OS native dialog for selecting files or directories in the file system. @@ -1682,7 +1682,7 @@ Callbacks have the following arguments: ``status: bool, selected_paths: PackedSt .. rst-class:: classref-method -:ref:`Error` **file_dialog_with_options_show** **(** :ref:`String` title, :ref:`String` current_directory, :ref:`String` root, :ref:`String` filename, :ref:`bool` show_hidden, :ref:`FileDialogMode` mode, :ref:`PackedStringArray` filters, :ref:`Dictionary[]` options, :ref:`Callable` callback **)** +:ref:`Error` **file_dialog_with_options_show**\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, root\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, options\: :ref:`Array`\[:ref:`Dictionary`\], callback\: :ref:`Callable`\ ) Displays OS native dialog for selecting files or directories in the file system with additional user selectable options. @@ -1714,7 +1714,7 @@ Callbacks have the following arguments: ``status: bool, selected_paths: PackedSt .. rst-class:: classref-method -void **force_process_and_drop_events** **(** **)** +|void| **force_process_and_drop_events**\ (\ ) Forces window manager processing while ignoring all :ref:`InputEvent`\ s. See also :ref:`process_events`. @@ -1728,7 +1728,7 @@ Forces window manager processing while ignoring all :ref:`InputEvent` **get_accent_color** **(** **)** |const| +:ref:`Color` **get_accent_color**\ (\ ) |const| Returns OS theme accent color. Returns ``Color(0, 0, 0, 0)``, if accent color is unknown. @@ -1742,7 +1742,7 @@ Returns OS theme accent color. Returns ``Color(0, 0, 0, 0)``, if accent color is .. rst-class:: classref-method -:ref:`Color` **get_base_color** **(** **)** |const| +:ref:`Color` **get_base_color**\ (\ ) |const| Returns the OS theme base color (default control background). Returns ``Color(0, 0, 0, 0)`` if the base color is unknown. @@ -1756,7 +1756,7 @@ Returns the OS theme base color (default control background). Returns ``Color(0, .. rst-class:: classref-method -:ref:`Rect2[]` **get_display_cutouts** **(** **)** |const| +:ref:`Array`\[:ref:`Rect2`\] **get_display_cutouts**\ (\ ) |const| Returns an :ref:`Array` of :ref:`Rect2`, each of which is the bounding rectangle for a display cutout or notch. These are non-functional areas on edge-to-edge screens used by cameras and sensors. Returns an empty array if the device does not have cutouts. See also :ref:`get_display_safe_area`. @@ -1770,7 +1770,7 @@ Returns an :ref:`Array` of :ref:`Rect2`, each of which .. rst-class:: classref-method -:ref:`Rect2i` **get_display_safe_area** **(** **)** |const| +:ref:`Rect2i` **get_display_safe_area**\ (\ ) |const| Returns the unobscured area of the display where interactive controls should be rendered. See also :ref:`get_display_cutouts`. @@ -1782,7 +1782,7 @@ Returns the unobscured area of the display where interactive controls should be .. rst-class:: classref-method -:ref:`int` **get_keyboard_focus_screen** **(** **)** |const| +:ref:`int` **get_keyboard_focus_screen**\ (\ ) |const| Returns the index of the screen containing the window with the keyboard focus, or the primary screen if there's no focused window. @@ -1794,7 +1794,7 @@ Returns the index of the screen containing the window with the keyboard focus, o .. rst-class:: classref-method -:ref:`String` **get_name** **(** **)** |const| +:ref:`String` **get_name**\ (\ ) |const| Returns the name of the **DisplayServer** currently in use. Most operating systems only have a single **DisplayServer**, but Linux has access to more than one **DisplayServer** (currently X11 and Wayland). @@ -1808,7 +1808,7 @@ The names of built-in display servers are ``Windows``, ``macOS``, ``X11`` (Linux .. rst-class:: classref-method -:ref:`int` **get_primary_screen** **(** **)** |const| +:ref:`int` **get_primary_screen**\ (\ ) |const| Returns index of the primary screen. @@ -1820,7 +1820,7 @@ Returns index of the primary screen. .. rst-class:: classref-method -:ref:`int` **get_screen_count** **(** **)** |const| +:ref:`int` **get_screen_count**\ (\ ) |const| Returns the number of displays available. @@ -1832,7 +1832,7 @@ Returns the number of displays available. .. rst-class:: classref-method -:ref:`int` **get_screen_from_rect** **(** :ref:`Rect2` rect **)** |const| +:ref:`int` **get_screen_from_rect**\ (\ rect\: :ref:`Rect2`\ ) |const| Returns index of the screen which contains specified rectangle. @@ -1844,7 +1844,7 @@ Returns index of the screen which contains specified rectangle. .. rst-class:: classref-method -:ref:`bool` **get_swap_cancel_ok** **(** **)** +:ref:`bool` **get_swap_cancel_ok**\ (\ ) Returns ``true`` if positions of **OK** and **Cancel** buttons are swapped in dialogs. This is enabled by default on Windows to follow interface conventions, and be toggled by changing :ref:`ProjectSettings.gui/common/swap_cancel_ok`. @@ -1858,7 +1858,7 @@ Returns ``true`` if positions of **OK** and **Cancel** buttons are swapped in di .. rst-class:: classref-method -:ref:`int` **get_window_at_screen_position** **(** :ref:`Vector2i` position **)** |const| +:ref:`int` **get_window_at_screen_position**\ (\ position\: :ref:`Vector2i`\ ) |const| Returns the ID of the window at the specified screen ``position`` (in pixels). On multi-monitor setups, the screen position is relative to the virtual desktop area. On multi-monitor setups with different screen resolutions or orientations, the origin may be located outside any display like this: @@ -1879,7 +1879,7 @@ Returns the ID of the window at the specified screen ``position`` (in pixels). O .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_window_list** **(** **)** |const| +:ref:`PackedInt32Array` **get_window_list**\ (\ ) |const| Returns the list of Godot window IDs belonging to this process. @@ -1893,7 +1893,7 @@ Returns the list of Godot window IDs belonging to this process. .. rst-class:: classref-method -:ref:`int` **global_menu_add_check_item** **(** :ref:`String` menu_root, :ref:`String` label, :ref:`Callable` callback=Callable(), :ref:`Callable` key_callback=Callable(), :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** +:ref:`int` **global_menu_add_check_item**\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) Adds a new checkable item with text ``label`` to the global menu with ID ``menu_root``. @@ -1923,7 +1923,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **global_menu_add_icon_check_item** **(** :ref:`String` menu_root, :ref:`Texture2D` icon, :ref:`String` label, :ref:`Callable` callback=Callable(), :ref:`Callable` key_callback=Callable(), :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** +:ref:`int` **global_menu_add_icon_check_item**\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) Adds a new checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``. @@ -1953,7 +1953,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **global_menu_add_icon_item** **(** :ref:`String` menu_root, :ref:`Texture2D` icon, :ref:`String` label, :ref:`Callable` callback=Callable(), :ref:`Callable` key_callback=Callable(), :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** +:ref:`int` **global_menu_add_icon_item**\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) Adds a new item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``. @@ -1983,7 +1983,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **global_menu_add_icon_radio_check_item** **(** :ref:`String` menu_root, :ref:`Texture2D` icon, :ref:`String` label, :ref:`Callable` callback=Callable(), :ref:`Callable` key_callback=Callable(), :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** +:ref:`int` **global_menu_add_icon_radio_check_item**\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) Adds a new radio-checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``. @@ -2015,7 +2015,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **global_menu_add_item** **(** :ref:`String` menu_root, :ref:`String` label, :ref:`Callable` callback=Callable(), :ref:`Callable` key_callback=Callable(), :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** +:ref:`int` **global_menu_add_item**\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) Adds a new item with text ``label`` to the global menu with ID ``menu_root``. @@ -2045,7 +2045,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **global_menu_add_multistate_item** **(** :ref:`String` menu_root, :ref:`String` label, :ref:`int` max_states, :ref:`int` default_state, :ref:`Callable` callback=Callable(), :ref:`Callable` key_callback=Callable(), :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** +:ref:`int` **global_menu_add_multistate_item**\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, max_states\: :ref:`int`, default_state\: :ref:`int`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) Adds a new item with text ``label`` to the global menu with ID ``menu_root``. @@ -2079,7 +2079,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **global_menu_add_radio_check_item** **(** :ref:`String` menu_root, :ref:`String` label, :ref:`Callable` callback=Callable(), :ref:`Callable` key_callback=Callable(), :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** +:ref:`int` **global_menu_add_radio_check_item**\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) Adds a new radio-checkable item with text ``label`` to the global menu with ID ``menu_root``. @@ -2111,7 +2111,7 @@ An ``accelerator`` can optionally be defined, which is a keyboard shortcut that .. rst-class:: classref-method -:ref:`int` **global_menu_add_separator** **(** :ref:`String` menu_root, :ref:`int` index=-1 **)** +:ref:`int` **global_menu_add_separator**\ (\ menu_root\: :ref:`String`, index\: :ref:`int` = -1\ ) Adds a separator between items to the global menu with ID ``menu_root``. Separators also occupy an index. @@ -2137,7 +2137,7 @@ Returns index of the inserted item, it's not guaranteed to be the same as ``inde .. rst-class:: classref-method -:ref:`int` **global_menu_add_submenu_item** **(** :ref:`String` menu_root, :ref:`String` label, :ref:`String` submenu, :ref:`int` index=-1 **)** +:ref:`int` **global_menu_add_submenu_item**\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, submenu\: :ref:`String`, index\: :ref:`int` = -1\ ) Adds an item that will act as a submenu of the global menu ``menu_root``. The ``submenu`` argument is the ID of the global menu root that will be shown when the item is clicked. @@ -2163,7 +2163,7 @@ Returns index of the inserted item, it's not guaranteed to be the same as ``inde .. rst-class:: classref-method -void **global_menu_clear** **(** :ref:`String` menu_root **)** +|void| **global_menu_clear**\ (\ menu_root\: :ref:`String`\ ) Removes all items from the global menu with ID ``menu_root``. @@ -2187,7 +2187,7 @@ Removes all items from the global menu with ID ``menu_root``. .. rst-class:: classref-method -:ref:`Key` **global_menu_get_item_accelerator** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| +:ref:`Key` **global_menu_get_item_accelerator**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| Returns the accelerator of the item at index ``idx``. Accelerators are special combinations of keys that activate the item, no matter which control is focused. @@ -2201,7 +2201,7 @@ Returns the accelerator of the item at index ``idx``. Accelerators are special c .. rst-class:: classref-method -:ref:`Callable` **global_menu_get_item_callback** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| +:ref:`Callable` **global_menu_get_item_callback**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| Returns the callback of the item at index ``idx``. @@ -2215,7 +2215,7 @@ Returns the callback of the item at index ``idx``. .. rst-class:: classref-method -:ref:`int` **global_menu_get_item_count** **(** :ref:`String` menu_root **)** |const| +:ref:`int` **global_menu_get_item_count**\ (\ menu_root\: :ref:`String`\ ) |const| Returns number of items in the global menu with ID ``menu_root``. @@ -2229,7 +2229,7 @@ Returns number of items in the global menu with ID ``menu_root``. .. rst-class:: classref-method -:ref:`Texture2D` **global_menu_get_item_icon** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| +:ref:`Texture2D` **global_menu_get_item_icon**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| Returns the icon of the item at index ``idx``. @@ -2243,7 +2243,7 @@ Returns the icon of the item at index ``idx``. .. rst-class:: classref-method -:ref:`int` **global_menu_get_item_indentation_level** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| +:ref:`int` **global_menu_get_item_indentation_level**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| Returns the horizontal offset of the item at the given ``idx``. @@ -2257,7 +2257,7 @@ Returns the horizontal offset of the item at the given ``idx``. .. rst-class:: classref-method -:ref:`int` **global_menu_get_item_index_from_tag** **(** :ref:`String` menu_root, :ref:`Variant` tag **)** |const| +:ref:`int` **global_menu_get_item_index_from_tag**\ (\ menu_root\: :ref:`String`, tag\: :ref:`Variant`\ ) |const| Returns the index of the item with the specified ``tag``. Index is automatically assigned to each item by the engine. Index can not be set manually. @@ -2271,7 +2271,7 @@ Returns the index of the item with the specified ``tag``. Index is automatically .. rst-class:: classref-method -:ref:`int` **global_menu_get_item_index_from_text** **(** :ref:`String` menu_root, :ref:`String` text **)** |const| +:ref:`int` **global_menu_get_item_index_from_text**\ (\ menu_root\: :ref:`String`, text\: :ref:`String`\ ) |const| Returns the index of the item with the specified ``text``. Index is automatically assigned to each item by the engine. Index can not be set manually. @@ -2285,7 +2285,7 @@ Returns the index of the item with the specified ``text``. Index is automaticall .. rst-class:: classref-method -:ref:`Callable` **global_menu_get_item_key_callback** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| +:ref:`Callable` **global_menu_get_item_key_callback**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| Returns the callback of the item accelerator at index ``idx``. @@ -2299,7 +2299,7 @@ Returns the callback of the item accelerator at index ``idx``. .. rst-class:: classref-method -:ref:`int` **global_menu_get_item_max_states** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| +:ref:`int` **global_menu_get_item_max_states**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| Returns number of states of a multistate item. See :ref:`global_menu_add_multistate_item` for details. @@ -2313,7 +2313,7 @@ Returns number of states of a multistate item. See :ref:`global_menu_add_multist .. rst-class:: classref-method -:ref:`int` **global_menu_get_item_state** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| +:ref:`int` **global_menu_get_item_state**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| Returns the state of a multistate item. See :ref:`global_menu_add_multistate_item` for details. @@ -2327,7 +2327,7 @@ Returns the state of a multistate item. See :ref:`global_menu_add_multistate_ite .. rst-class:: classref-method -:ref:`String` **global_menu_get_item_submenu** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| +:ref:`String` **global_menu_get_item_submenu**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| Returns the submenu ID of the item at index ``idx``. See :ref:`global_menu_add_submenu_item` for more info on how to add a submenu. @@ -2341,7 +2341,7 @@ Returns the submenu ID of the item at index ``idx``. See :ref:`global_menu_add_s .. rst-class:: classref-method -:ref:`Variant` **global_menu_get_item_tag** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| +:ref:`Variant` **global_menu_get_item_tag**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| Returns the metadata of the specified item, which might be of any type. You can set it with :ref:`global_menu_set_item_tag`, which provides a simple way of assigning context data to items. @@ -2355,7 +2355,7 @@ Returns the metadata of the specified item, which might be of any type. You can .. rst-class:: classref-method -:ref:`String` **global_menu_get_item_text** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| +:ref:`String` **global_menu_get_item_text**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| Returns the text of the item at index ``idx``. @@ -2369,7 +2369,7 @@ Returns the text of the item at index ``idx``. .. rst-class:: classref-method -:ref:`String` **global_menu_get_item_tooltip** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| +:ref:`String` **global_menu_get_item_tooltip**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| Returns the tooltip associated with the specified index ``idx``. @@ -2383,7 +2383,7 @@ Returns the tooltip associated with the specified index ``idx``. .. rst-class:: classref-method -:ref:`Dictionary` **global_menu_get_system_menu_roots** **(** **)** |const| +:ref:`Dictionary` **global_menu_get_system_menu_roots**\ (\ ) |const| Returns Dictionary of supported system menu IDs and names. @@ -2397,7 +2397,7 @@ Returns Dictionary of supported system menu IDs and names. .. rst-class:: classref-method -:ref:`bool` **global_menu_is_item_checkable** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| +:ref:`bool` **global_menu_is_item_checkable**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if it has a checkbox or radio button. @@ -2411,7 +2411,7 @@ Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if .. rst-class:: classref-method -:ref:`bool` **global_menu_is_item_checked** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| +:ref:`bool` **global_menu_is_item_checked**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| Returns ``true`` if the item at index ``idx`` is checked. @@ -2425,7 +2425,7 @@ Returns ``true`` if the item at index ``idx`` is checked. .. rst-class:: classref-method -:ref:`bool` **global_menu_is_item_disabled** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| +:ref:`bool` **global_menu_is_item_disabled**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| Returns ``true`` if the item at index ``idx`` is disabled. When it is disabled it can't be selected, or its action invoked. @@ -2441,7 +2441,7 @@ See :ref:`global_menu_set_item_disabled` **global_menu_is_item_hidden** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| +:ref:`bool` **global_menu_is_item_hidden**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| Returns ``true`` if the item at index ``idx`` is hidden. @@ -2457,7 +2457,7 @@ See :ref:`global_menu_set_item_hidden` **global_menu_is_item_radio_checkable** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| +:ref:`bool` **global_menu_is_item_radio_checkable**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| Returns ``true`` if the item at index ``idx`` has radio button-style checkability. @@ -2473,7 +2473,7 @@ Returns ``true`` if the item at index ``idx`` has radio button-style checkabilit .. rst-class:: classref-method -void **global_menu_remove_item** **(** :ref:`String` menu_root, :ref:`int` idx **)** +|void| **global_menu_remove_item**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) Removes the item at index ``idx`` from the global menu ``menu_root``. @@ -2489,7 +2489,7 @@ Removes the item at index ``idx`` from the global menu ``menu_root``. .. rst-class:: classref-method -void **global_menu_set_item_accelerator** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Key` keycode **)** +|void| **global_menu_set_item_accelerator**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, keycode\: :ref:`Key`\ ) Sets the accelerator of the item at index ``idx``. ``keycode`` can be a single :ref:`Key`, or a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). @@ -2503,7 +2503,7 @@ Sets the accelerator of the item at index ``idx``. ``keycode`` can be a single : .. rst-class:: classref-method -void **global_menu_set_item_callback** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Callable` callback **)** +|void| **global_menu_set_item_callback**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) Sets the callback of the item at index ``idx``. Callback is emitted when an item is pressed. @@ -2519,7 +2519,7 @@ Sets the callback of the item at index ``idx``. Callback is emitted when an item .. rst-class:: classref-method -void **global_menu_set_item_checkable** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`bool` checkable **)** +|void| **global_menu_set_item_checkable**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) Sets whether the item at index ``idx`` has a checkbox. If ``false``, sets the type of the item to plain text. @@ -2533,7 +2533,7 @@ Sets whether the item at index ``idx`` has a checkbox. If ``false``, sets the ty .. rst-class:: classref-method -void **global_menu_set_item_checked** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`bool` checked **)** +|void| **global_menu_set_item_checked**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checked\: :ref:`bool`\ ) Sets the checkstate status of the item at index ``idx``. @@ -2547,7 +2547,7 @@ Sets the checkstate status of the item at index ``idx``. .. rst-class:: classref-method -void **global_menu_set_item_disabled** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`bool` disabled **)** +|void| **global_menu_set_item_disabled**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, disabled\: :ref:`bool`\ ) Enables/disables the item at index ``idx``. When it is disabled, it can't be selected and its action can't be invoked. @@ -2561,7 +2561,7 @@ Enables/disables the item at index ``idx``. When it is disabled, it can't be sel .. rst-class:: classref-method -void **global_menu_set_item_hidden** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`bool` hidden **)** +|void| **global_menu_set_item_hidden**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, hidden\: :ref:`bool`\ ) Hides/shows the item at index ``idx``. When it is hidden, an item does not appear in a menu and its action cannot be invoked. @@ -2575,7 +2575,7 @@ Hides/shows the item at index ``idx``. When it is hidden, an item does not appea .. rst-class:: classref-method -void **global_menu_set_item_hover_callbacks** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Callable` callback **)** +|void| **global_menu_set_item_hover_callbacks**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) Sets the callback of the item at index ``idx``. The callback is emitted when an item is hovered. @@ -2591,7 +2591,7 @@ Sets the callback of the item at index ``idx``. The callback is emitted when an .. rst-class:: classref-method -void **global_menu_set_item_icon** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Texture2D` icon **)** +|void| **global_menu_set_item_icon**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) Replaces the :ref:`Texture2D` icon of the specified ``idx``. @@ -2607,7 +2607,7 @@ Replaces the :ref:`Texture2D` icon of the specified ``idx``. .. rst-class:: classref-method -void **global_menu_set_item_indentation_level** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`int` level **)** +|void| **global_menu_set_item_indentation_level**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, level\: :ref:`int`\ ) Sets the horizontal offset of the item at the given ``idx``. @@ -2621,7 +2621,7 @@ Sets the horizontal offset of the item at the given ``idx``. .. rst-class:: classref-method -void **global_menu_set_item_key_callback** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Callable` key_callback **)** +|void| **global_menu_set_item_key_callback**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, key_callback\: :ref:`Callable`\ ) Sets the callback of the item at index ``idx``. Callback is emitted when its accelerator is activated. @@ -2637,7 +2637,7 @@ Sets the callback of the item at index ``idx``. Callback is emitted when its acc .. rst-class:: classref-method -void **global_menu_set_item_max_states** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`int` max_states **)** +|void| **global_menu_set_item_max_states**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, max_states\: :ref:`int`\ ) Sets number of state of a multistate item. See :ref:`global_menu_add_multistate_item` for details. @@ -2651,7 +2651,7 @@ Sets number of state of a multistate item. See :ref:`global_menu_add_multistate_ .. rst-class:: classref-method -void **global_menu_set_item_radio_checkable** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`bool` checkable **)** +|void| **global_menu_set_item_radio_checkable**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) Sets the type of the item at the specified index ``idx`` to radio button. If ``false``, sets the type of the item to plain text. @@ -2667,7 +2667,7 @@ Sets the type of the item at the specified index ``idx`` to radio button. If ``f .. rst-class:: classref-method -void **global_menu_set_item_state** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`int` state **)** +|void| **global_menu_set_item_state**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, state\: :ref:`int`\ ) Sets the state of a multistate item. See :ref:`global_menu_add_multistate_item` for details. @@ -2681,7 +2681,7 @@ Sets the state of a multistate item. See :ref:`global_menu_add_multistate_item` menu_root, :ref:`int` idx, :ref:`String` submenu **)** +|void| **global_menu_set_item_submenu**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, submenu\: :ref:`String`\ ) Sets the submenu of the item at index ``idx``. The submenu is the ID of a global menu root that would be shown when the item is clicked. @@ -2695,7 +2695,7 @@ Sets the submenu of the item at index ``idx``. The submenu is the ID of a global .. rst-class:: classref-method -void **global_menu_set_item_tag** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Variant` tag **)** +|void| **global_menu_set_item_tag**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, tag\: :ref:`Variant`\ ) Sets the metadata of an item, which may be of any type. You can later get it with :ref:`global_menu_get_item_tag`, which provides a simple way of assigning context data to items. @@ -2709,7 +2709,7 @@ Sets the metadata of an item, which may be of any type. You can later get it wit .. rst-class:: classref-method -void **global_menu_set_item_text** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`String` text **)** +|void| **global_menu_set_item_text**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, text\: :ref:`String`\ ) Sets the text of the item at index ``idx``. @@ -2723,7 +2723,7 @@ Sets the text of the item at index ``idx``. .. rst-class:: classref-method -void **global_menu_set_item_tooltip** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`String` tooltip **)** +|void| **global_menu_set_item_tooltip**\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, tooltip\: :ref:`String`\ ) Sets the :ref:`String` tooltip of the item at the specified index ``idx``. @@ -2737,7 +2737,7 @@ Sets the :ref:`String` tooltip of the item at the specified index .. rst-class:: classref-method -void **global_menu_set_popup_callbacks** **(** :ref:`String` menu_root, :ref:`Callable` open_callback, :ref:`Callable` close_callback **)** +|void| **global_menu_set_popup_callbacks**\ (\ menu_root\: :ref:`String`, open_callback\: :ref:`Callable`, close_callback\: :ref:`Callable`\ ) Registers callables to emit when the menu is respectively about to show or closed. @@ -2749,7 +2749,7 @@ Registers callables to emit when the menu is respectively about to show or close .. rst-class:: classref-method -:ref:`bool` **has_feature** **(** :ref:`Feature` feature **)** |const| +:ref:`bool` **has_feature**\ (\ feature\: :ref:`Feature`\ ) |const| Returns ``true`` if the specified ``feature`` is supported by the current **DisplayServer**, ``false`` otherwise. @@ -2761,7 +2761,7 @@ Returns ``true`` if the specified ``feature`` is supported by the current **Disp .. rst-class:: classref-method -void **help_set_search_callbacks** **(** :ref:`Callable` search_callback, :ref:`Callable` action_callback **)** +|void| **help_set_search_callbacks**\ (\ search_callback\: :ref:`Callable`, action_callback\: :ref:`Callable`\ ) Sets native help system search callbacks. @@ -2779,7 +2779,7 @@ Sets native help system search callbacks. .. rst-class:: classref-method -:ref:`Vector2i` **ime_get_selection** **(** **)** |const| +:ref:`Vector2i` **ime_get_selection**\ (\ ) |const| Returns the text selection in the `Input Method Editor `__ composition string, with the :ref:`Vector2i`'s ``x`` component being the caret position and ``y`` being the length of the selection. @@ -2793,7 +2793,7 @@ Returns the text selection in the `Input Method Editor ` **ime_get_text** **(** **)** |const| +:ref:`String` **ime_get_text**\ (\ ) |const| Returns the composition string contained within the `Input Method Editor `__ window. @@ -2807,7 +2807,7 @@ Returns the composition string contained within the `Input Method Editor ` **is_dark_mode** **(** **)** |const| +:ref:`bool` **is_dark_mode**\ (\ ) |const| Returns ``true`` if OS is using dark mode. @@ -2821,7 +2821,7 @@ Returns ``true`` if OS is using dark mode. .. rst-class:: classref-method -:ref:`bool` **is_dark_mode_supported** **(** **)** |const| +:ref:`bool` **is_dark_mode_supported**\ (\ ) |const| Returns ``true`` if OS supports dark mode. @@ -2835,7 +2835,7 @@ Returns ``true`` if OS supports dark mode. .. rst-class:: classref-method -:ref:`bool` **is_touchscreen_available** **(** **)** |const| +:ref:`bool` **is_touchscreen_available**\ (\ ) |const| Returns ``true`` if touch events are available (Android or iOS), the capability is detected on the Web platform or if :ref:`ProjectSettings.input_devices/pointing/emulate_touch_from_mouse` is ``true``. @@ -2847,7 +2847,7 @@ Returns ``true`` if touch events are available (Android or iOS), the capability .. rst-class:: classref-method -:ref:`int` **keyboard_get_current_layout** **(** **)** |const| +:ref:`int` **keyboard_get_current_layout**\ (\ ) |const| Returns active keyboard layout index. @@ -2861,7 +2861,7 @@ Returns active keyboard layout index. .. rst-class:: classref-method -:ref:`Key` **keyboard_get_keycode_from_physical** **(** :ref:`Key` keycode **)** |const| +:ref:`Key` **keyboard_get_keycode_from_physical**\ (\ keycode\: :ref:`Key`\ ) |const| Converts a physical (US QWERTY) ``keycode`` to one in the active keyboard layout. @@ -2875,7 +2875,7 @@ Converts a physical (US QWERTY) ``keycode`` to one in the active keyboard layout .. rst-class:: classref-method -:ref:`Key` **keyboard_get_label_from_physical** **(** :ref:`Key` keycode **)** |const| +:ref:`Key` **keyboard_get_label_from_physical**\ (\ keycode\: :ref:`Key`\ ) |const| Converts a physical (US QWERTY) ``keycode`` to localized label printed on the key in the active keyboard layout. @@ -2889,7 +2889,7 @@ Converts a physical (US QWERTY) ``keycode`` to localized label printed on the ke .. rst-class:: classref-method -:ref:`int` **keyboard_get_layout_count** **(** **)** |const| +:ref:`int` **keyboard_get_layout_count**\ (\ ) |const| Returns the number of keyboard layouts. @@ -2903,7 +2903,7 @@ Returns the number of keyboard layouts. .. rst-class:: classref-method -:ref:`String` **keyboard_get_layout_language** **(** :ref:`int` index **)** |const| +:ref:`String` **keyboard_get_layout_language**\ (\ index\: :ref:`int`\ ) |const| Returns the ISO-639/BCP-47 language code of the keyboard layout at position ``index``. @@ -2917,7 +2917,7 @@ Returns the ISO-639/BCP-47 language code of the keyboard layout at position ``in .. rst-class:: classref-method -:ref:`String` **keyboard_get_layout_name** **(** :ref:`int` index **)** |const| +:ref:`String` **keyboard_get_layout_name**\ (\ index\: :ref:`int`\ ) |const| Returns the localized name of the keyboard layout at position ``index``. @@ -2931,7 +2931,7 @@ Returns the localized name of the keyboard layout at position ``index``. .. rst-class:: classref-method -void **keyboard_set_current_layout** **(** :ref:`int` index **)** +|void| **keyboard_set_current_layout**\ (\ index\: :ref:`int`\ ) Sets the active keyboard layout. @@ -2945,7 +2945,7 @@ Sets the active keyboard layout. .. rst-class:: classref-method -|bitfield|\<:ref:`MouseButtonMask`\> **mouse_get_button_state** **(** **)** |const| +|bitfield|\[:ref:`MouseButtonMask`\] **mouse_get_button_state**\ (\ ) |const| Returns the current state of mouse buttons (whether each button is pressed) as a bitmask. If multiple mouse buttons are pressed at the same time, the bits are added together. Equivalent to :ref:`Input.get_mouse_button_mask`. @@ -2957,7 +2957,7 @@ Returns the current state of mouse buttons (whether each button is pressed) as a .. rst-class:: classref-method -:ref:`MouseMode` **mouse_get_mode** **(** **)** |const| +:ref:`MouseMode` **mouse_get_mode**\ (\ ) |const| Returns the current mouse mode. See also :ref:`mouse_set_mode`. @@ -2969,7 +2969,7 @@ Returns the current mouse mode. See also :ref:`mouse_set_mode` **mouse_get_position** **(** **)** |const| +:ref:`Vector2i` **mouse_get_position**\ (\ ) |const| Returns the mouse cursor's current position in screen coordinates. @@ -2981,7 +2981,7 @@ Returns the mouse cursor's current position in screen coordinates. .. rst-class:: classref-method -void **mouse_set_mode** **(** :ref:`MouseMode` mouse_mode **)** +|void| **mouse_set_mode**\ (\ mouse_mode\: :ref:`MouseMode`\ ) Sets the current mouse mode. See also :ref:`mouse_get_mode`. @@ -2993,7 +2993,7 @@ Sets the current mouse mode. See also :ref:`mouse_get_mode`, :ref:`Input.flush_buffered_events` and :ref:`Input.use_accumulated_input`. @@ -3005,7 +3005,7 @@ Perform window manager processing, including input flushing. See also :ref:`forc .. rst-class:: classref-method -:ref:`int` **screen_get_dpi** **(** :ref:`int` screen=-1 **)** |const| +:ref:`int` **screen_get_dpi**\ (\ screen\: :ref:`int` = -1\ ) |const| Returns the dots per inch density of the specified screen. If ``screen`` is :ref:`SCREEN_OF_MAIN_WINDOW` (the default value), a screen with the main window will be used. @@ -3032,7 +3032,7 @@ Returns the dots per inch density of the specified screen. If ``screen`` is :ref .. rst-class:: classref-method -:ref:`Image` **screen_get_image** **(** :ref:`int` screen=-1 **)** |const| +:ref:`Image` **screen_get_image**\ (\ screen\: :ref:`int` = -1\ ) |const| Returns screenshot of the ``screen``. @@ -3048,7 +3048,7 @@ Returns screenshot of the ``screen``. .. rst-class:: classref-method -:ref:`float` **screen_get_max_scale** **(** **)** |const| +:ref:`float` **screen_get_max_scale**\ (\ ) |const| Returns the greatest scale factor of all screens. @@ -3064,7 +3064,7 @@ Returns the greatest scale factor of all screens. .. rst-class:: classref-method -:ref:`ScreenOrientation` **screen_get_orientation** **(** :ref:`int` screen=-1 **)** |const| +:ref:`ScreenOrientation` **screen_get_orientation**\ (\ screen\: :ref:`int` = -1\ ) |const| Returns the ``screen``'s current orientation. See also :ref:`screen_set_orientation`. @@ -3078,7 +3078,7 @@ Returns the ``screen``'s current orientation. See also :ref:`screen_set_orientat .. rst-class:: classref-method -:ref:`Color` **screen_get_pixel** **(** :ref:`Vector2i` position **)** |const| +:ref:`Color` **screen_get_pixel**\ (\ position\: :ref:`Vector2i`\ ) |const| Returns color of the display pixel at the ``position``. @@ -3094,7 +3094,7 @@ Returns color of the display pixel at the ``position``. .. rst-class:: classref-method -:ref:`Vector2i` **screen_get_position** **(** :ref:`int` screen=-1 **)** |const| +:ref:`Vector2i` **screen_get_position**\ (\ screen\: :ref:`int` = -1\ ) |const| Returns the screen's top-left corner position in pixels. On multi-monitor setups, the screen position is relative to the virtual desktop area. On multi-monitor setups with different screen resolutions or orientations, the origin may be located outside any display like this: @@ -3119,7 +3119,7 @@ See also :ref:`screen_get_size`. .. rst-class:: classref-method -:ref:`float` **screen_get_refresh_rate** **(** :ref:`int` screen=-1 **)** |const| +:ref:`float` **screen_get_refresh_rate**\ (\ screen\: :ref:`int` = -1\ ) |const| Returns the current refresh rate of the specified screen. If ``screen`` is :ref:`SCREEN_OF_MAIN_WINDOW` (the default value), a screen with the main window will be used. @@ -3141,7 +3141,7 @@ To fallback to a default refresh rate if the method fails, try: .. rst-class:: classref-method -:ref:`float` **screen_get_scale** **(** :ref:`int` screen=-1 **)** |const| +:ref:`float` **screen_get_scale**\ (\ screen\: :ref:`int` = -1\ ) |const| Returns the scale factor of the specified screen by index. @@ -3157,7 +3157,7 @@ Returns the scale factor of the specified screen by index. .. rst-class:: classref-method -:ref:`Vector2i` **screen_get_size** **(** :ref:`int` screen=-1 **)** |const| +:ref:`Vector2i` **screen_get_size**\ (\ screen\: :ref:`int` = -1\ ) |const| Returns the screen's size in pixels. See also :ref:`screen_get_position` and :ref:`screen_get_usable_rect`. @@ -3169,7 +3169,7 @@ Returns the screen's size in pixels. See also :ref:`screen_get_position` **screen_get_usable_rect** **(** :ref:`int` screen=-1 **)** |const| +:ref:`Rect2i` **screen_get_usable_rect**\ (\ screen\: :ref:`int` = -1\ ) |const| Returns the portion of the screen that is not obstructed by a status bar in pixels. See also :ref:`screen_get_size`. @@ -3181,7 +3181,7 @@ Returns the portion of the screen that is not obstructed by a status bar in pixe .. rst-class:: classref-method -:ref:`bool` **screen_is_kept_on** **(** **)** |const| +:ref:`bool` **screen_is_kept_on**\ (\ ) |const| Returns ``true`` if the screen should never be turned off by the operating system's power-saving measures. See also :ref:`screen_set_keep_on`. @@ -3193,7 +3193,7 @@ Returns ``true`` if the screen should never be turned off by the operating syste .. rst-class:: classref-method -void **screen_set_keep_on** **(** :ref:`bool` enable **)** +|void| **screen_set_keep_on**\ (\ enable\: :ref:`bool`\ ) Sets whether the screen should never be turned off by the operating system's power-saving measures. See also :ref:`screen_is_kept_on`. @@ -3205,7 +3205,7 @@ Sets whether the screen should never be turned off by the operating system's pow .. rst-class:: classref-method -void **screen_set_orientation** **(** :ref:`ScreenOrientation` orientation, :ref:`int` screen=-1 **)** +|void| **screen_set_orientation**\ (\ orientation\: :ref:`ScreenOrientation`, screen\: :ref:`int` = -1\ ) Sets the ``screen``'s ``orientation``. See also :ref:`screen_get_orientation`. @@ -3219,7 +3219,7 @@ Sets the ``screen``'s ``orientation``. See also :ref:`screen_get_orientation` image **)** +|void| **set_icon**\ (\ image\: :ref:`Image`\ ) Sets the window icon (usually displayed in the top-left corner) with an :ref:`Image`. To use icons in the operating system's native format, use :ref:`set_native_icon` instead. @@ -3231,7 +3231,7 @@ Sets the window icon (usually displayed in the top-left corner) with an :ref:`Im .. rst-class:: classref-method -void **set_native_icon** **(** :ref:`String` filename **)** +|void| **set_native_icon**\ (\ filename\: :ref:`String`\ ) Sets the window icon (usually displayed in the top-left corner) in the operating system's *native* format. The file at ``filename`` must be in ``.ico`` format on Windows or ``.icns`` on macOS. By using specially crafted ``.ico`` or ``.icns`` icons, :ref:`set_native_icon` allows specifying different icons depending on the size the icon is displayed at. This size is determined by the operating system and user preferences (including the display scale factor). To use icons in other formats, use :ref:`set_icon` instead. @@ -3243,7 +3243,7 @@ Sets the window icon (usually displayed in the top-left corner) in the operating .. rst-class:: classref-method -void **set_system_theme_change_callback** **(** :ref:`Callable` callable **)** +|void| **set_system_theme_change_callback**\ (\ callable\: :ref:`Callable`\ ) Sets the ``callable`` that should be called when system theme settings are changed. Callback method should have zero arguments. @@ -3257,7 +3257,7 @@ Sets the ``callable`` that should be called when system theme settings are chang .. rst-class:: classref-method -void **status_indicator_set_callback** **(** :ref:`int` id, :ref:`Callable` callback **)** +|void| **status_indicator_set_callback**\ (\ id\: :ref:`int`, callback\: :ref:`Callable`\ ) Sets the application status indicator activation callback. @@ -3269,7 +3269,7 @@ Sets the application status indicator activation callback. .. rst-class:: classref-method -void **status_indicator_set_icon** **(** :ref:`int` id, :ref:`Image` icon **)** +|void| **status_indicator_set_icon**\ (\ id\: :ref:`int`, icon\: :ref:`Image`\ ) Sets the application status indicator icon. @@ -3281,7 +3281,7 @@ Sets the application status indicator icon. .. rst-class:: classref-method -void **status_indicator_set_tooltip** **(** :ref:`int` id, :ref:`String` tooltip **)** +|void| **status_indicator_set_tooltip**\ (\ id\: :ref:`int`, tooltip\: :ref:`String`\ ) Sets the application status indicator tooltip. @@ -3293,7 +3293,7 @@ Sets the application status indicator tooltip. .. rst-class:: classref-method -:ref:`String` **tablet_get_current_driver** **(** **)** |const| +:ref:`String` **tablet_get_current_driver**\ (\ ) |const| Returns current active tablet driver name. @@ -3307,7 +3307,7 @@ Returns current active tablet driver name. .. rst-class:: classref-method -:ref:`int` **tablet_get_driver_count** **(** **)** |const| +:ref:`int` **tablet_get_driver_count**\ (\ ) |const| Returns the total number of available tablet drivers. @@ -3321,7 +3321,7 @@ Returns the total number of available tablet drivers. .. rst-class:: classref-method -:ref:`String` **tablet_get_driver_name** **(** :ref:`int` idx **)** |const| +:ref:`String` **tablet_get_driver_name**\ (\ idx\: :ref:`int`\ ) |const| Returns the tablet driver name for the given index. @@ -3335,7 +3335,7 @@ Returns the tablet driver name for the given index. .. rst-class:: classref-method -void **tablet_set_current_driver** **(** :ref:`String` name **)** +|void| **tablet_set_current_driver**\ (\ name\: :ref:`String`\ ) Set active tablet driver name. @@ -3357,7 +3357,7 @@ Supported drivers: .. rst-class:: classref-method -:ref:`Dictionary[]` **tts_get_voices** **(** **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **tts_get_voices**\ (\ ) |const| Returns an :ref:`Array` of voice information dictionaries. @@ -3383,7 +3383,7 @@ Note that Godot depends on system libraries for text-to-speech functionality. Th .. rst-class:: classref-method -:ref:`PackedStringArray` **tts_get_voices_for_language** **(** :ref:`String` language **)** |const| +:ref:`PackedStringArray` **tts_get_voices_for_language**\ (\ language\: :ref:`String`\ ) |const| Returns an :ref:`PackedStringArray` of voice identifiers for the ``language``. @@ -3399,7 +3399,7 @@ Returns an :ref:`PackedStringArray` of voice identifier .. rst-class:: classref-method -:ref:`bool` **tts_is_paused** **(** **)** |const| +:ref:`bool` **tts_is_paused**\ (\ ) |const| Returns ``true`` if the synthesizer is in a paused state. @@ -3415,7 +3415,7 @@ Returns ``true`` if the synthesizer is in a paused state. .. rst-class:: classref-method -:ref:`bool` **tts_is_speaking** **(** **)** |const| +:ref:`bool` **tts_is_speaking**\ (\ ) |const| Returns ``true`` if the synthesizer is generating speech, or have utterance waiting in the queue. @@ -3431,7 +3431,7 @@ Returns ``true`` if the synthesizer is generating speech, or have utterance wait .. rst-class:: classref-method -void **tts_pause** **(** **)** +|void| **tts_pause**\ (\ ) Puts the synthesizer into a paused state. @@ -3447,7 +3447,7 @@ Puts the synthesizer into a paused state. .. rst-class:: classref-method -void **tts_resume** **(** **)** +|void| **tts_resume**\ (\ ) Resumes the synthesizer if it was paused. @@ -3463,7 +3463,7 @@ Resumes the synthesizer if it was paused. .. rst-class:: classref-method -void **tts_set_utterance_callback** **(** :ref:`TTSUtteranceEvent` event, :ref:`Callable` callable **)** +|void| **tts_set_utterance_callback**\ (\ event\: :ref:`TTSUtteranceEvent`, callable\: :ref:`Callable`\ ) Adds a callback, which is called when the utterance has started, finished, canceled or reached a text boundary. @@ -3485,7 +3485,7 @@ Adds a callback, which is called when the utterance has started, finished, cance .. rst-class:: classref-method -void **tts_speak** **(** :ref:`String` text, :ref:`String` voice, :ref:`int` volume=50, :ref:`float` pitch=1.0, :ref:`float` rate=1.0, :ref:`int` utterance_id=0, :ref:`bool` interrupt=false **)** +|void| **tts_speak**\ (\ text\: :ref:`String`, voice\: :ref:`String`, volume\: :ref:`int` = 50, pitch\: :ref:`float` = 1.0, rate\: :ref:`float` = 1.0, utterance_id\: :ref:`int` = 0, interrupt\: :ref:`bool` = false\ ) Adds an utterance to the queue. If ``interrupt`` is ``true``, the queue is cleared first. @@ -3515,7 +3515,7 @@ Adds an utterance to the queue. If ``interrupt`` is ``true``, the queue is clear .. rst-class:: classref-method -void **tts_stop** **(** **)** +|void| **tts_stop**\ (\ ) Stops synthesis in progress and removes all utterances from the queue. @@ -3531,7 +3531,7 @@ Stops synthesis in progress and removes all utterances from the queue. .. rst-class:: classref-method -:ref:`int` **virtual_keyboard_get_height** **(** **)** |const| +:ref:`int` **virtual_keyboard_get_height**\ (\ ) |const| Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden. @@ -3543,7 +3543,7 @@ Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyb .. rst-class:: classref-method -void **virtual_keyboard_hide** **(** **)** +|void| **virtual_keyboard_hide**\ (\ ) Hides the virtual keyboard if it is shown, does nothing otherwise. @@ -3555,7 +3555,7 @@ Hides the virtual keyboard if it is shown, does nothing otherwise. .. rst-class:: classref-method -void **virtual_keyboard_show** **(** :ref:`String` existing_text, :ref:`Rect2` position=Rect2(0, 0, 0, 0), :ref:`VirtualKeyboardType` type=0, :ref:`int` max_length=-1, :ref:`int` cursor_start=-1, :ref:`int` cursor_end=-1 **)** +|void| **virtual_keyboard_show**\ (\ existing_text\: :ref:`String`, position\: :ref:`Rect2` = Rect2(0, 0, 0, 0), type\: :ref:`VirtualKeyboardType` = 0, max_length\: :ref:`int` = -1, cursor_start\: :ref:`int` = -1, cursor_end\: :ref:`int` = -1\ ) Shows the virtual keyboard if the platform has one. @@ -3581,7 +3581,7 @@ Shows the virtual keyboard if the platform has one. .. rst-class:: classref-method -void **warp_mouse** **(** :ref:`Vector2i` position **)** +|void| **warp_mouse**\ (\ position\: :ref:`Vector2i`\ ) Sets the mouse cursor position to the given ``position`` relative to an origin at the upper left corner of the currently focused game Window Manager window. @@ -3595,7 +3595,7 @@ Sets the mouse cursor position to the given ``position`` relative to an origin a .. rst-class:: classref-method -:ref:`bool` **window_can_draw** **(** :ref:`int` window_id=0 **)** |const| +:ref:`bool` **window_can_draw**\ (\ window_id\: :ref:`int` = 0\ ) |const| Returns ``true`` if anything can be drawn in the window specified by ``window_id``, ``false`` otherwise. Using the ``--disable-render-loop`` command line argument or a headless build will return ``false``. @@ -3607,7 +3607,7 @@ Returns ``true`` if anything can be drawn in the window specified by ``window_id .. rst-class:: classref-method -:ref:`int` **window_get_active_popup** **(** **)** |const| +:ref:`int` **window_get_active_popup**\ (\ ) |const| Returns ID of the active popup window, or :ref:`INVALID_WINDOW_ID` if there is none. @@ -3619,7 +3619,7 @@ Returns ID of the active popup window, or :ref:`INVALID_WINDOW_ID` **window_get_attached_instance_id** **(** :ref:`int` window_id=0 **)** |const| +:ref:`int` **window_get_attached_instance_id**\ (\ window_id\: :ref:`int` = 0\ ) |const| Returns the :ref:`Object.get_instance_id` of the :ref:`Window` the ``window_id`` is attached to. @@ -3631,7 +3631,7 @@ Returns the :ref:`Object.get_instance_id` o .. rst-class:: classref-method -:ref:`int` **window_get_current_screen** **(** :ref:`int` window_id=0 **)** |const| +:ref:`int` **window_get_current_screen**\ (\ window_id\: :ref:`int` = 0\ ) |const| Returns the screen the window specified by ``window_id`` is currently positioned on. If the screen overlaps multiple displays, the screen where the window's center is located is returned. See also :ref:`window_set_current_screen`. @@ -3643,7 +3643,7 @@ Returns the screen the window specified by ``window_id`` is currently positioned .. rst-class:: classref-method -:ref:`bool` **window_get_flag** **(** :ref:`WindowFlags` flag, :ref:`int` window_id=0 **)** |const| +:ref:`bool` **window_get_flag**\ (\ flag\: :ref:`WindowFlags`, window_id\: :ref:`int` = 0\ ) |const| Returns the current value of the given window's ``flag``. @@ -3655,7 +3655,7 @@ Returns the current value of the given window's ``flag``. .. rst-class:: classref-method -:ref:`Vector2i` **window_get_max_size** **(** :ref:`int` window_id=0 **)** |const| +:ref:`Vector2i` **window_get_max_size**\ (\ window_id\: :ref:`int` = 0\ ) |const| Returns the window's maximum size (in pixels). See also :ref:`window_set_max_size`. @@ -3667,7 +3667,7 @@ Returns the window's maximum size (in pixels). See also :ref:`window_set_max_siz .. rst-class:: classref-method -:ref:`Vector2i` **window_get_min_size** **(** :ref:`int` window_id=0 **)** |const| +:ref:`Vector2i` **window_get_min_size**\ (\ window_id\: :ref:`int` = 0\ ) |const| Returns the window's minimum size (in pixels). See also :ref:`window_set_min_size`. @@ -3679,7 +3679,7 @@ Returns the window's minimum size (in pixels). See also :ref:`window_set_min_siz .. rst-class:: classref-method -:ref:`WindowMode` **window_get_mode** **(** :ref:`int` window_id=0 **)** |const| +:ref:`WindowMode` **window_get_mode**\ (\ window_id\: :ref:`int` = 0\ ) |const| Returns the mode of the given window. @@ -3691,7 +3691,7 @@ Returns the mode of the given window. .. rst-class:: classref-method -:ref:`int` **window_get_native_handle** **(** :ref:`HandleType` handle_type, :ref:`int` window_id=0 **)** |const| +:ref:`int` **window_get_native_handle**\ (\ handle_type\: :ref:`HandleType`, window_id\: :ref:`int` = 0\ ) |const| Returns internal structure pointers for use in plugins. @@ -3705,7 +3705,7 @@ Returns internal structure pointers for use in plugins. .. rst-class:: classref-method -:ref:`Rect2i` **window_get_popup_safe_rect** **(** :ref:`int` window **)** |const| +:ref:`Rect2i` **window_get_popup_safe_rect**\ (\ window\: :ref:`int`\ ) |const| Returns the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system. @@ -3717,7 +3717,7 @@ Returns the bounding box of control, or menu item that was used to open the popu .. rst-class:: classref-method -:ref:`Vector2i` **window_get_position** **(** :ref:`int` window_id=0 **)** |const| +:ref:`Vector2i` **window_get_position**\ (\ window_id\: :ref:`int` = 0\ ) |const| Returns the position of the client area of the given window on the screen. @@ -3729,7 +3729,7 @@ Returns the position of the client area of the given window on the screen. .. rst-class:: classref-method -:ref:`Vector2i` **window_get_position_with_decorations** **(** :ref:`int` window_id=0 **)** |const| +:ref:`Vector2i` **window_get_position_with_decorations**\ (\ window_id\: :ref:`int` = 0\ ) |const| Returns the position of the given window on the screen including the borders drawn by the operating system. See also :ref:`window_get_position`. @@ -3741,7 +3741,7 @@ Returns the position of the given window on the screen including the borders dra .. rst-class:: classref-method -:ref:`Vector3i` **window_get_safe_title_margins** **(** :ref:`int` window_id=0 **)** |const| +:ref:`Vector3i` **window_get_safe_title_margins**\ (\ window_id\: :ref:`int` = 0\ ) |const| Returns left margins (``x``), right margins (``y``) and height (``z``) of the title that are safe to use (contains no buttons or other elements) when :ref:`WINDOW_FLAG_EXTEND_TO_TITLE` flag is set. @@ -3753,7 +3753,7 @@ Returns left margins (``x``), right margins (``y``) and height (``z``) of the ti .. rst-class:: classref-method -:ref:`Vector2i` **window_get_size** **(** :ref:`int` window_id=0 **)** |const| +:ref:`Vector2i` **window_get_size**\ (\ window_id\: :ref:`int` = 0\ ) |const| Returns the size of the window specified by ``window_id`` (in pixels), excluding the borders drawn by the operating system. This is also called the "client area". See also :ref:`window_get_size_with_decorations`, :ref:`window_set_size` and :ref:`window_get_position`. @@ -3765,7 +3765,7 @@ Returns the size of the window specified by ``window_id`` (in pixels), excluding .. rst-class:: classref-method -:ref:`Vector2i` **window_get_size_with_decorations** **(** :ref:`int` window_id=0 **)** |const| +:ref:`Vector2i` **window_get_size_with_decorations**\ (\ window_id\: :ref:`int` = 0\ ) |const| Returns the size of the window specified by ``window_id`` (in pixels), including the borders drawn by the operating system. See also :ref:`window_get_size`. @@ -3777,7 +3777,7 @@ Returns the size of the window specified by ``window_id`` (in pixels), including .. rst-class:: classref-method -:ref:`Vector2i` **window_get_title_size** **(** :ref:`String` title, :ref:`int` window_id=0 **)** |const| +:ref:`Vector2i` **window_get_title_size**\ (\ title\: :ref:`String`, window_id\: :ref:`int` = 0\ ) |const| Returns the estimated window title bar size (including text and window buttons) for the window specified by ``window_id`` (in pixels). This method does not change the window title. @@ -3791,7 +3791,7 @@ Returns the estimated window title bar size (including text and window buttons) .. rst-class:: classref-method -:ref:`VSyncMode` **window_get_vsync_mode** **(** :ref:`int` window_id=0 **)** |const| +:ref:`VSyncMode` **window_get_vsync_mode**\ (\ window_id\: :ref:`int` = 0\ ) |const| Returns the V-Sync mode of the given window. @@ -3803,7 +3803,7 @@ Returns the V-Sync mode of the given window. .. rst-class:: classref-method -:ref:`bool` **window_is_focused** **(** :ref:`int` window_id=0 **)** |const| +:ref:`bool` **window_is_focused**\ (\ window_id\: :ref:`int` = 0\ ) |const| Returns ``true`` if the window specified by ``window_id`` is focused. @@ -3815,7 +3815,7 @@ Returns ``true`` if the window specified by ``window_id`` is focused. .. rst-class:: classref-method -:ref:`bool` **window_is_maximize_allowed** **(** :ref:`int` window_id=0 **)** |const| +:ref:`bool` **window_is_maximize_allowed**\ (\ window_id\: :ref:`int` = 0\ ) |const| Returns ``true`` if the given window can be maximized (the maximize button is enabled). @@ -3827,7 +3827,7 @@ Returns ``true`` if the given window can be maximized (the maximize button is en .. rst-class:: classref-method -:ref:`bool` **window_maximize_on_title_dbl_click** **(** **)** |const| +:ref:`bool` **window_maximize_on_title_dbl_click**\ (\ ) |const| Returns ``true``, if double-click on a window title should maximize it. @@ -3841,7 +3841,7 @@ Returns ``true``, if double-click on a window title should maximize it. .. rst-class:: classref-method -:ref:`bool` **window_minimize_on_title_dbl_click** **(** **)** |const| +:ref:`bool` **window_minimize_on_title_dbl_click**\ (\ ) |const| Returns ``true``, if double-click on a window title should minimize it. @@ -3855,7 +3855,7 @@ Returns ``true``, if double-click on a window title should minimize it. .. rst-class:: classref-method -void **window_move_to_foreground** **(** :ref:`int` window_id=0 **)** +|void| **window_move_to_foreground**\ (\ window_id\: :ref:`int` = 0\ ) Moves the window specified by ``window_id`` to the foreground, so that it is visible over other windows. @@ -3867,7 +3867,7 @@ Moves the window specified by ``window_id`` to the foreground, so that it is vis .. rst-class:: classref-method -void **window_request_attention** **(** :ref:`int` window_id=0 **)** +|void| **window_request_attention**\ (\ window_id\: :ref:`int` = 0\ ) Makes the window specified by ``window_id`` request attention, which is materialized by the window title and taskbar entry blinking until the window is focused. This usually has no visible effect if the window is currently focused. The exact behavior varies depending on the operating system. @@ -3879,7 +3879,7 @@ Makes the window specified by ``window_id`` request attention, which is material .. rst-class:: classref-method -void **window_set_current_screen** **(** :ref:`int` screen, :ref:`int` window_id=0 **)** +|void| **window_set_current_screen**\ (\ screen\: :ref:`int`, window_id\: :ref:`int` = 0\ ) Moves the window specified by ``window_id`` to the specified ``screen``. See also :ref:`window_get_current_screen`. @@ -3891,7 +3891,7 @@ Moves the window specified by ``window_id`` to the specified ``screen``. See als .. rst-class:: classref-method -void **window_set_drop_files_callback** **(** :ref:`Callable` callback, :ref:`int` window_id=0 **)** +|void| **window_set_drop_files_callback**\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) Sets the ``callback`` that should be called when files are dropped from the operating system's file manager to the window specified by ``window_id``. @@ -3907,7 +3907,7 @@ Sets the ``callback`` that should be called when files are dropped from the oper .. rst-class:: classref-method -void **window_set_exclusive** **(** :ref:`int` window_id, :ref:`bool` exclusive **)** +|void| **window_set_exclusive**\ (\ window_id\: :ref:`int`, exclusive\: :ref:`bool`\ ) If set to ``true``, this window will always stay on top of its parent window, parent window will ignore input while this window is opened. @@ -3923,7 +3923,7 @@ If set to ``true``, this window will always stay on top of its parent window, pa .. rst-class:: classref-method -void **window_set_flag** **(** :ref:`WindowFlags` flag, :ref:`bool` enabled, :ref:`int` window_id=0 **)** +|void| **window_set_flag**\ (\ flag\: :ref:`WindowFlags`, enabled\: :ref:`bool`, window_id\: :ref:`int` = 0\ ) Enables or disables the given window's given ``flag``. See :ref:`WindowFlags` for possible values and their behavior. @@ -3935,7 +3935,7 @@ Enables or disables the given window's given ``flag``. See :ref:`WindowFlags` active, :ref:`int` window_id=0 **)** +|void| **window_set_ime_active**\ (\ active\: :ref:`bool`, window_id\: :ref:`int` = 0\ ) Sets whether `Input Method Editor `__ should be enabled for the window specified by ``window_id``. See also :ref:`window_set_ime_position`. @@ -3947,7 +3947,7 @@ Sets whether `Input Method Editor `_ .. rst-class:: classref-method -void **window_set_ime_position** **(** :ref:`Vector2i` position, :ref:`int` window_id=0 **)** +|void| **window_set_ime_position**\ (\ position\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) Sets the position of the `Input Method Editor `__ popup for the specified ``window_id``. Only effective if :ref:`window_set_ime_active` was set to ``true`` for the specified ``window_id``. @@ -3959,7 +3959,7 @@ Sets the position of the `Input Method Editor ` callback, :ref:`int` window_id=0 **)** +|void| **window_set_input_event_callback**\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) Sets the ``callback`` that should be called when any :ref:`InputEvent` is sent to the window specified by ``window_id``. @@ -3973,7 +3973,7 @@ Sets the ``callback`` that should be called when any :ref:`InputEvent` callback, :ref:`int` window_id=0 **)** +|void| **window_set_input_text_callback**\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) Sets the ``callback`` that should be called when text is entered using the virtual keyboard to the window specified by ``window_id``. @@ -3987,7 +3987,7 @@ Sets the ``callback`` that should be called when text is entered using the virtu .. rst-class:: classref-method -void **window_set_max_size** **(** :ref:`Vector2i` max_size, :ref:`int` window_id=0 **)** +|void| **window_set_max_size**\ (\ max_size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) Sets the maximum size of the window specified by ``window_id`` in pixels. Normally, the user will not be able to drag the window to make it smaller than the specified size. See also :ref:`window_get_max_size`. @@ -4003,7 +4003,7 @@ Sets the maximum size of the window specified by ``window_id`` in pixels. Normal .. rst-class:: classref-method -void **window_set_min_size** **(** :ref:`Vector2i` min_size, :ref:`int` window_id=0 **)** +|void| **window_set_min_size**\ (\ min_size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) Sets the minimum size for the given window to ``min_size`` (in pixels). Normally, the user will not be able to drag the window to make it larger than the specified size. See also :ref:`window_get_min_size`. @@ -4021,7 +4021,7 @@ Sets the minimum size for the given window to ``min_size`` (in pixels). Normally .. rst-class:: classref-method -void **window_set_mode** **(** :ref:`WindowMode` mode, :ref:`int` window_id=0 **)** +|void| **window_set_mode**\ (\ mode\: :ref:`WindowMode`, window_id\: :ref:`int` = 0\ ) Sets window mode for the given window to ``mode``. See :ref:`WindowMode` for possible values and how each mode behaves. @@ -4035,7 +4035,7 @@ Sets window mode for the given window to ``mode``. See :ref:`WindowMode` region, :ref:`int` window_id=0 **)** +|void| **window_set_mouse_passthrough**\ (\ region\: :ref:`PackedVector2Array`, window_id\: :ref:`int` = 0\ ) Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through. @@ -4080,7 +4080,7 @@ Passing an empty array will disable passthrough support (all mouse events will b .. rst-class:: classref-method -void **window_set_popup_safe_rect** **(** :ref:`int` window, :ref:`Rect2i` rect **)** +|void| **window_set_popup_safe_rect**\ (\ window\: :ref:`int`, rect\: :ref:`Rect2i`\ ) Sets the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system. Clicking this area will not auto-close this popup. @@ -4092,7 +4092,7 @@ Sets the bounding box of control, or menu item that was used to open the popup w .. rst-class:: classref-method -void **window_set_position** **(** :ref:`Vector2i` position, :ref:`int` window_id=0 **)** +|void| **window_set_position**\ (\ position\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) Sets the position of the given window to ``position``. On multi-monitor setups, the screen position is relative to the virtual desktop area. On multi-monitor setups with different screen resolutions or orientations, the origin may be located outside any display like this: @@ -4119,7 +4119,7 @@ See also :ref:`window_get_position` callback, :ref:`int` window_id=0 **)** +|void| **window_set_rect_changed_callback**\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) Sets the ``callback`` that will be called when the window specified by ``window_id`` is moved or resized. @@ -4133,7 +4133,7 @@ Sets the ``callback`` that will be called when the window specified by ``window_ .. rst-class:: classref-method -void **window_set_size** **(** :ref:`Vector2i` size, :ref:`int` window_id=0 **)** +|void| **window_set_size**\ (\ size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) Sets the size of the given window to ``size`` (in pixels). See also :ref:`window_get_size` and :ref:`window_get_position`. @@ -4147,7 +4147,7 @@ Sets the size of the given window to ``size`` (in pixels). See also :ref:`window .. rst-class:: classref-method -void **window_set_title** **(** :ref:`String` title, :ref:`int` window_id=0 **)** +|void| **window_set_title**\ (\ title\: :ref:`String`, window_id\: :ref:`int` = 0\ ) Sets the title of the given window to ``title``. @@ -4163,7 +4163,7 @@ Sets the title of the given window to ``title``. .. rst-class:: classref-method -void **window_set_transient** **(** :ref:`int` window_id, :ref:`int` parent_window_id **)** +|void| **window_set_transient**\ (\ window_id\: :ref:`int`, parent_window_id\: :ref:`int`\ ) Sets window transient parent. Transient window is will be destroyed with its transient parent and will return focus to their parent when closed. The transient window is displayed on top of a non-exclusive full-screen parent window. Transient windows can't enter full-screen mode. @@ -4179,7 +4179,7 @@ Sets window transient parent. Transient window is will be destroyed with its tra .. rst-class:: classref-method -void **window_set_vsync_mode** **(** :ref:`VSyncMode` vsync_mode, :ref:`int` window_id=0 **)** +|void| **window_set_vsync_mode**\ (\ vsync_mode\: :ref:`VSyncMode`, window_id\: :ref:`int` = 0\ ) Sets the V-Sync mode of the given window. See also :ref:`ProjectSettings.display/window/vsync/vsync_mode`. @@ -4197,7 +4197,7 @@ Depending on the platform and used renderer, the engine will fall back to :ref:` .. rst-class:: classref-method -void **window_set_window_buttons_offset** **(** :ref:`Vector2i` offset, :ref:`int` window_id=0 **)** +|void| **window_set_window_buttons_offset**\ (\ offset\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) When :ref:`WINDOW_FLAG_EXTEND_TO_TITLE` flag is set, set offset to the center of the first titlebar button. @@ -4211,7 +4211,7 @@ When :ref:`WINDOW_FLAG_EXTEND_TO_TITLE` callback, :ref:`int` window_id=0 **)** +|void| **window_set_window_event_callback**\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) Sets the ``callback`` that will be called when an event occurs in the window specified by ``window_id``. @@ -4224,3 +4224,4 @@ Sets the ``callback`` that will be called when an event occurs in the window spe .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_dtlsserver.rst b/classes/class_dtlsserver.rst index 08c1c0ef519..59e7ad7411b 100644 --- a/classes/class_dtlsserver.rst +++ b/classes/class_dtlsserver.rst @@ -180,11 +180,11 @@ Methods .. table:: :widths: auto - +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`setup` **(** :ref:`TLSOptions` server_options **)** | - +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PacketPeerDTLS` | :ref:`take_connection` **(** :ref:`PacketPeerUDP` udp_peer **)** | - +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`setup`\ (\ server_options\: :ref:`TLSOptions`\ ) | + +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PacketPeerDTLS` | :ref:`take_connection`\ (\ udp_peer\: :ref:`PacketPeerUDP`\ ) | + +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -199,7 +199,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **setup** **(** :ref:`TLSOptions` server_options **)** +:ref:`Error` **setup**\ (\ server_options\: :ref:`TLSOptions`\ ) Setup the DTLS server to use the given ``server_options``. See :ref:`TLSOptions.server`. @@ -211,7 +211,7 @@ Setup the DTLS server to use the given ``server_options``. See :ref:`TLSOptions. .. rst-class:: classref-method -:ref:`PacketPeerDTLS` **take_connection** **(** :ref:`PacketPeerUDP` udp_peer **)** +:ref:`PacketPeerDTLS` **take_connection**\ (\ udp_peer\: :ref:`PacketPeerUDP`\ ) Try to initiate the DTLS handshake with the given ``udp_peer`` which must be already connected (see :ref:`PacketPeerUDP.connect_to_host`). @@ -224,3 +224,4 @@ Try to initiate the DTLS handshake with the given ``udp_peer`` which must be alr .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorcommandpalette.rst b/classes/class_editorcommandpalette.rst index 69ed8171c03..420e377ac40 100644 --- a/classes/class_editorcommandpalette.rst +++ b/classes/class_editorcommandpalette.rst @@ -64,11 +64,11 @@ Methods .. table:: :widths: auto - +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_command` **(** :ref:`String` command_name, :ref:`String` key_name, :ref:`Callable` binded_callable, :ref:`String` shortcut_text="None" **)** | - +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_command` **(** :ref:`String` key_name **)** | - +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_command`\ (\ command_name\: :ref:`String`, key_name\: :ref:`String`, binded_callable\: :ref:`Callable`, shortcut_text\: :ref:`String` = "None"\ ) | + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_command`\ (\ key_name\: :ref:`String`\ ) | + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -83,7 +83,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_command** **(** :ref:`String` command_name, :ref:`String` key_name, :ref:`Callable` binded_callable, :ref:`String` shortcut_text="None" **)** +|void| **add_command**\ (\ command_name\: :ref:`String`, key_name\: :ref:`String`, binded_callable\: :ref:`Callable`, shortcut_text\: :ref:`String` = "None"\ ) Adds a custom command to EditorCommandPalette. @@ -103,7 +103,7 @@ Adds a custom command to EditorCommandPalette. .. rst-class:: classref-method -void **remove_command** **(** :ref:`String` key_name **)** +|void| **remove_command**\ (\ key_name\: :ref:`String`\ ) Removes the custom command from EditorCommandPalette. @@ -116,3 +116,4 @@ Removes the custom command from EditorCommandPalette. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editordebuggerplugin.rst b/classes/class_editordebuggerplugin.rst index 54d8df97922..99c51ec7989 100644 --- a/classes/class_editordebuggerplugin.rst +++ b/classes/class_editordebuggerplugin.rst @@ -74,17 +74,17 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_capture` **(** :ref:`String` message, :ref:`Array` data, :ref:`int` session_id **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_capture` **(** :ref:`String` capture **)** |virtual| |const| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_setup_session` **(** :ref:`int` session_id **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorDebuggerSession` | :ref:`get_session` **(** :ref:`int` id **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_sessions` **(** **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_capture`\ (\ message\: :ref:`String`, data\: :ref:`Array`, session_id\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_capture`\ (\ capture\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_setup_session`\ (\ session_id\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`EditorDebuggerSession` | :ref:`get_session`\ (\ id\: :ref:`int`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_sessions`\ (\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -99,7 +99,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_capture** **(** :ref:`String` message, :ref:`Array` data, :ref:`int` session_id **)** |virtual| +:ref:`bool` **_capture**\ (\ message\: :ref:`String`, data\: :ref:`Array`, session_id\: :ref:`int`\ ) |virtual| Override this method to process incoming messages. The ``session_id`` is the ID of the :ref:`EditorDebuggerSession` that received the message (which you can retrieve via :ref:`get_session`). @@ -111,7 +111,7 @@ Override this method to process incoming messages. The ``session_id`` is the ID .. rst-class:: classref-method -:ref:`bool` **_has_capture** **(** :ref:`String` capture **)** |virtual| |const| +:ref:`bool` **_has_capture**\ (\ capture\: :ref:`String`\ ) |virtual| |const| Override this method to enable receiving messages from the debugger. If ``capture`` is "my_message" then messages starting with "my_message:" will be passes to the :ref:`_capture` method. @@ -123,7 +123,7 @@ Override this method to enable receiving messages from the debugger. If ``captur .. rst-class:: classref-method -void **_setup_session** **(** :ref:`int` session_id **)** |virtual| +|void| **_setup_session**\ (\ session_id\: :ref:`int`\ ) |virtual| Override this method to be notified whenever a new :ref:`EditorDebuggerSession` is created (the session may be inactive during this stage). @@ -135,7 +135,7 @@ Override this method to be notified whenever a new :ref:`EditorDebuggerSession` **get_session** **(** :ref:`int` id **)** +:ref:`EditorDebuggerSession` **get_session**\ (\ id\: :ref:`int`\ ) Returns the :ref:`EditorDebuggerSession` with the given ``id``. @@ -147,7 +147,7 @@ Returns the :ref:`EditorDebuggerSession` with the g .. rst-class:: classref-method -:ref:`Array` **get_sessions** **(** **)** +:ref:`Array` **get_sessions**\ (\ ) Returns an array of :ref:`EditorDebuggerSession` currently available to this debugger plugin. @@ -160,3 +160,4 @@ Returns an array of :ref:`EditorDebuggerSession` cu .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editordebuggersession.rst b/classes/class_editordebuggersession.rst index 8e485aff00f..01440cb0765 100644 --- a/classes/class_editordebuggersession.rst +++ b/classes/class_editordebuggersession.rst @@ -31,21 +31,21 @@ Methods .. table:: :widths: auto - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_session_tab` **(** :ref:`Control` control **)** | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_active` **(** **)** | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_breaked` **(** **)** | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_debuggable` **(** **)** | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_session_tab` **(** :ref:`Control` control **)** | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`send_message` **(** :ref:`String` message, :ref:`Array` data=[] **)** | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`toggle_profiler` **(** :ref:`String` profiler, :ref:`bool` enable, :ref:`Array` data=[] **)** | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_session_tab`\ (\ control\: :ref:`Control`\ ) | + +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_active`\ (\ ) | + +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_breaked`\ (\ ) | + +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_debuggable`\ (\ ) | + +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_session_tab`\ (\ control\: :ref:`Control`\ ) | + +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`send_message`\ (\ message\: :ref:`String`, data\: :ref:`Array` = []\ ) | + +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`toggle_profiler`\ (\ profiler\: :ref:`String`, enable\: :ref:`bool`, data\: :ref:`Array` = []\ ) | + +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -60,7 +60,7 @@ Signals .. rst-class:: classref-signal -**breaked** **(** :ref:`bool` can_debug **)** +**breaked**\ (\ can_debug\: :ref:`bool`\ ) Emitted when the attached remote instance enters a break state. If ``can_debug`` is ``true``, the remote instance will enter the debug loop. @@ -72,7 +72,7 @@ Emitted when the attached remote instance enters a break state. If ``can_debug`` .. rst-class:: classref-signal -**continued** **(** **)** +**continued**\ (\ ) Emitted when the attached remote instance exits a break state. @@ -84,7 +84,7 @@ Emitted when the attached remote instance exits a break state. .. rst-class:: classref-signal -**started** **(** **)** +**started**\ (\ ) Emitted when a remote instance is attached to this session (i.e. the session becomes active). @@ -96,7 +96,7 @@ Emitted when a remote instance is attached to this session (i.e. the session bec .. rst-class:: classref-signal -**stopped** **(** **)** +**stopped**\ (\ ) Emitted when a remote instance is detached from this session (i.e. the session becomes inactive). @@ -113,7 +113,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_session_tab** **(** :ref:`Control` control **)** +|void| **add_session_tab**\ (\ control\: :ref:`Control`\ ) Adds the given ``control`` to the debug session UI in the debugger bottom panel. @@ -125,7 +125,7 @@ Adds the given ``control`` to the debug session UI in the debugger bottom panel. .. rst-class:: classref-method -:ref:`bool` **is_active** **(** **)** +:ref:`bool` **is_active**\ (\ ) Returns ``true`` if the debug session is currently attached to a remote instance. @@ -137,7 +137,7 @@ Returns ``true`` if the debug session is currently attached to a remote instance .. rst-class:: classref-method -:ref:`bool` **is_breaked** **(** **)** +:ref:`bool` **is_breaked**\ (\ ) Returns ``true`` if the attached remote instance is currently in the debug loop. @@ -149,7 +149,7 @@ Returns ``true`` if the attached remote instance is currently in the debug loop. .. rst-class:: classref-method -:ref:`bool` **is_debuggable** **(** **)** +:ref:`bool` **is_debuggable**\ (\ ) Returns ``true`` if the attached remote instance can be debugged. @@ -161,7 +161,7 @@ Returns ``true`` if the attached remote instance can be debugged. .. rst-class:: classref-method -void **remove_session_tab** **(** :ref:`Control` control **)** +|void| **remove_session_tab**\ (\ control\: :ref:`Control`\ ) Removes the given ``control`` from the debug session UI in the debugger bottom panel. @@ -173,7 +173,7 @@ Removes the given ``control`` from the debug session UI in the debugger bottom p .. rst-class:: classref-method -void **send_message** **(** :ref:`String` message, :ref:`Array` data=[] **)** +|void| **send_message**\ (\ message\: :ref:`String`, data\: :ref:`Array` = []\ ) Sends the given ``message`` to the attached remote instance, optionally passing additionally ``data``. See :ref:`EngineDebugger` for how to retrieve those messages. @@ -185,7 +185,7 @@ Sends the given ``message`` to the attached remote instance, optionally passing .. rst-class:: classref-method -void **toggle_profiler** **(** :ref:`String` profiler, :ref:`bool` enable, :ref:`Array` data=[] **)** +|void| **toggle_profiler**\ (\ profiler\: :ref:`String`, enable\: :ref:`bool`, data\: :ref:`Array` = []\ ) Toggle the given ``profiler`` on the attached remote instance, optionally passing additionally ``data``. See :ref:`EngineProfiler` for more details. @@ -196,3 +196,4 @@ Toggle the given ``profiler`` on the attached remote instance, optionally passin .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorexportplatform.rst b/classes/class_editorexportplatform.rst index e7abcbb6889..912f05a21a2 100644 --- a/classes/class_editorexportplatform.rst +++ b/classes/class_editorexportplatform.rst @@ -40,9 +40,9 @@ Methods .. table:: :widths: auto - +-----------------------------+---------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_os_name` **(** **)** |const| | - +-----------------------------+---------------------------------------------------------------------------------------+ + +-----------------------------+---------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_os_name`\ (\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -57,7 +57,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **get_os_name** **(** **)** |const| +:ref:`String` **get_os_name**\ (\ ) |const| Returns the name of the export operating system handled by this **EditorExportPlatform** class, as a friendly string. Possible return values are ``Windows``, ``Linux``, ``macOS``, ``Android``, ``iOS``, and ``Web``. @@ -68,3 +68,4 @@ Returns the name of the export operating system handled by this **EditorExportPl .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorexportplatformandroid.rst b/classes/class_editorexportplatformandroid.rst index 246d185a3e7..e69ffbf7463 100644 --- a/classes/class_editorexportplatformandroid.rst +++ b/classes/class_editorexportplatformandroid.rst @@ -1452,7 +1452,7 @@ Array of custom permission strings. :ref:`bool` **permissions/delete_cache_files** -Deprecated. +**Deprecated:** This property may be changed or removed in future versions. .. rst-class:: classref-item-separator @@ -1596,7 +1596,7 @@ Allows an application to find out the space used by any package. See `GET_PACKAG :ref:`bool` **permissions/get_tasks** -Deprecated in API level 21. +**Deprecated:** Deprecated in API level 21. .. rst-class:: classref-item-separator @@ -1872,9 +1872,9 @@ Allows applications to perform I/O operations over NFC. See `NFC ` **permissions/persistent_activity** -Allow an application to make its activities persistent. +**Deprecated:** Deprecated in API level 15. -Deprecated in API level 15. +Allow an application to make its activities persistent. .. rst-class:: classref-item-separator @@ -1886,9 +1886,9 @@ Deprecated in API level 15. :ref:`bool` **permissions/process_outgoing_calls** -Allows an application to see the number being dialed during an outgoing call with the option to redirect the call to a different number or abort the call altogether. See `PROCESS_OUTGOING_CALLS `__. +**Deprecated:** Deprecated in API level 29. -Deprecated in API level 29. +Allows an application to see the number being dialed during an outgoing call with the option to redirect the call to a different number or abort the call altogether. See `PROCESS_OUTGOING_CALLS `__. .. rst-class:: classref-item-separator @@ -1936,9 +1936,9 @@ Allows an application to read the user's contacts data. See `READ_CONTACTS ` **permissions/read_external_storage** -Allows an application to read from external storage. See `READ_EXTERNAL_STORAGE `__. +**Deprecated:** Deprecated in API level 33. -Deprecated in API level 33. +Allows an application to read from external storage. See `READ_EXTERNAL_STORAGE `__. .. rst-class:: classref-item-separator @@ -1974,7 +1974,7 @@ Allows an application to read (but not write) the user's browsing history and bo :ref:`bool` **permissions/read_input_state** -Deprecated in API level 16. +**Deprecated:** Deprecated in API level 16. .. rst-class:: classref-item-separator @@ -2166,7 +2166,7 @@ Allows an application to change the Z-order of tasks. See `REORDER_TASKS ` **permissions/restart_packages** -Deprecated in API level 15. +**Deprecated:** Deprecated in API level 15. .. rst-class:: classref-item-separator @@ -2286,7 +2286,7 @@ Allows low-level access to setting the pointer speed. :ref:`bool` **permissions/set_preferred_applications** -Deprecated in API level 15. +**Deprecated:** Deprecated in API level 15. .. rst-class:: classref-item-separator @@ -2394,7 +2394,7 @@ Allows an application to allow access the subscribed feeds ContentProvider. :ref:`bool` **permissions/subscribed_feeds_write** -Deprecated. +**Deprecated:** This property may be changed or removed in future versions. .. rst-class:: classref-item-separator @@ -2430,7 +2430,7 @@ Allows using the device's IR transmitter, if available. See `TRANSMIT_IR ` **permissions/uninstall_shortcut** -Deprecated. +**Deprecated:** This property may be changed or removed in future versions. .. rst-class:: classref-item-separator @@ -2777,3 +2777,4 @@ Application version visible to the user. Falls back to :ref:`ProjectSettings.app .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorexportplatformios.rst b/classes/class_editorexportplatformios.rst index 054fb517425..e58707a4e1a 100644 --- a/classes/class_editorexportplatformios.rst +++ b/classes/class_editorexportplatformios.rst @@ -730,3 +730,4 @@ If ``true``, the app "Documents" folder can be accessed via iTunes file sharing. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorexportplatformlinuxbsd.rst b/classes/class_editorexportplatformlinuxbsd.rst index 09d4542b2df..8a95d635071 100644 --- a/classes/class_editorexportplatformlinuxbsd.rst +++ b/classes/class_editorexportplatformlinuxbsd.rst @@ -263,3 +263,4 @@ If ``true``, project textures are exported in the S3TC/BPTC format. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorexportplatformmacos.rst b/classes/class_editorexportplatformmacos.rst index 798c79e2f38..f8365fded3a 100644 --- a/classes/class_editorexportplatformmacos.rst +++ b/classes/class_editorexportplatformmacos.rst @@ -1366,3 +1366,4 @@ Xcode version used to build application executable. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorexportplatformpc.rst b/classes/class_editorexportplatformpc.rst index e30e1e4d554..f147dfe99c9 100644 --- a/classes/class_editorexportplatformpc.rst +++ b/classes/class_editorexportplatformpc.rst @@ -23,3 +23,4 @@ Base class for the desktop platform exporter (Windows and Linux/BSD). .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorexportplatformweb.rst b/classes/class_editorexportplatformweb.rst index adc80a7befd..d0e4d8c03da 100644 --- a/classes/class_editorexportplatformweb.rst +++ b/classes/class_editorexportplatformweb.rst @@ -155,9 +155,9 @@ For more information, see the :doc:`Customizing HTML5 Shell <../tutorials/platfo :ref:`bool` **html/experimental_virtual_keyboard** -If ``true``, embeds support for a virtual keyboard into the web page, which is shown when necessary on touchscreen devices. +**Experimental:** This property may be changed or removed in future versions. -\ **Warning:** This feature is experimental and may be changed in a future release. +If ``true``, embeds support for a virtual keyboard into the web page, which is shown when necessary on touchscreen devices. .. rst-class:: classref-item-separator @@ -384,3 +384,4 @@ If ``true`` allows textures to be optimized for mobile through the ETC2 algorith .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorexportplatformwindows.rst b/classes/class_editorexportplatformwindows.rst index e5112eb3798..007bb49085f 100644 --- a/classes/class_editorexportplatformwindows.rst +++ b/classes/class_editorexportplatformwindows.rst @@ -591,3 +591,4 @@ If ``true``, project textures are exported in the S3TC/BPTC format. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index 19e347939ff..e9239426777 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -38,77 +38,77 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_begin_customize_resources` **(** :ref:`EditorExportPlatform` platform, :ref:`PackedStringArray` features **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_begin_customize_scenes` **(** :ref:`EditorExportPlatform` platform, :ref:`PackedStringArray` features **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`_customize_resource` **(** :ref:`Resource` resource, :ref:`String` path **)** |virtual| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`_customize_scene` **(** :ref:`Node` scene, :ref:`String` path **)** |virtual| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_end_customize_resources` **(** **)** |virtual| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_end_customize_scenes` **(** **)** |virtual| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_export_begin` **(** :ref:`PackedStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** |virtual| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_export_end` **(** **)** |virtual| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_export_file` **(** :ref:`String` path, :ref:`String` type, :ref:`PackedStringArray` features **)** |virtual| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_android_dependencies` **(** :ref:`EditorExportPlatform` platform, :ref:`bool` debug **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_android_dependencies_maven_repos` **(** :ref:`EditorExportPlatform` platform, :ref:`bool` debug **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_android_libraries` **(** :ref:`EditorExportPlatform` platform, :ref:`bool` debug **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_android_manifest_activity_element_contents` **(** :ref:`EditorExportPlatform` platform, :ref:`bool` debug **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_android_manifest_application_element_contents` **(** :ref:`EditorExportPlatform` platform, :ref:`bool` debug **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_android_manifest_element_contents` **(** :ref:`EditorExportPlatform` platform, :ref:`bool` debug **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_customization_configuration_hash` **(** **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_export_features` **(** :ref:`EditorExportPlatform` platform, :ref:`bool` debug **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_export_option_warning` **(** :ref:`EditorExportPlatform` platform, :ref:`String` option **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`_get_export_options` **(** :ref:`EditorExportPlatform` platform **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_export_options_overrides` **(** :ref:`EditorExportPlatform` platform **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_name` **(** **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_should_update_export_options` **(** :ref:`EditorExportPlatform` platform **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_supports_platform` **(** :ref:`EditorExportPlatform` platform **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_file` **(** :ref:`String` path, :ref:`PackedByteArray` file, :ref:`bool` remap **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_ios_bundle_file` **(** :ref:`String` path **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_ios_cpp_code` **(** :ref:`String` code **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_ios_embedded_framework` **(** :ref:`String` path **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_ios_framework` **(** :ref:`String` path **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_ios_linker_flags` **(** :ref:`String` flags **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_ios_plist_content` **(** :ref:`String` plist_content **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_ios_project_static_lib` **(** :ref:`String` path **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_macos_plugin_file` **(** :ref:`String` path **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_shared_object` **(** :ref:`String` path, :ref:`PackedStringArray` tags, :ref:`String` target **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_option` **(** :ref:`StringName` name **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`skip` **(** **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_begin_customize_resources`\ (\ platform\: :ref:`EditorExportPlatform`, features\: :ref:`PackedStringArray`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_begin_customize_scenes`\ (\ platform\: :ref:`EditorExportPlatform`, features\: :ref:`PackedStringArray`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`_customize_resource`\ (\ resource\: :ref:`Resource`, path\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`_customize_scene`\ (\ scene\: :ref:`Node`, path\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_end_customize_resources`\ (\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_end_customize_scenes`\ (\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_export_begin`\ (\ features\: :ref:`PackedStringArray`, is_debug\: :ref:`bool`, path\: :ref:`String`, flags\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_export_end`\ (\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_export_file`\ (\ path\: :ref:`String`, type\: :ref:`String`, features\: :ref:`PackedStringArray`\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_android_dependencies`\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_android_dependencies_maven_repos`\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_android_libraries`\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_android_manifest_activity_element_contents`\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_android_manifest_application_element_contents`\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_android_manifest_element_contents`\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_customization_configuration_hash`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_export_features`\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_export_option_warning`\ (\ platform\: :ref:`EditorExportPlatform`, option\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_export_options`\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_export_options_overrides`\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_name`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_should_update_export_options`\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_supports_platform`\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_file`\ (\ path\: :ref:`String`, file\: :ref:`PackedByteArray`, remap\: :ref:`bool`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_ios_bundle_file`\ (\ path\: :ref:`String`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_ios_cpp_code`\ (\ code\: :ref:`String`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_ios_embedded_framework`\ (\ path\: :ref:`String`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_ios_framework`\ (\ path\: :ref:`String`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_ios_linker_flags`\ (\ flags\: :ref:`String`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_ios_plist_content`\ (\ plist_content\: :ref:`String`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_ios_project_static_lib`\ (\ path\: :ref:`String`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_macos_plugin_file`\ (\ path\: :ref:`String`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_shared_object`\ (\ path\: :ref:`String`, tags\: :ref:`PackedStringArray`, target\: :ref:`String`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_option`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`skip`\ (\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -123,7 +123,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_begin_customize_resources** **(** :ref:`EditorExportPlatform` platform, :ref:`PackedStringArray` features **)** |virtual| |const| +:ref:`bool` **_begin_customize_resources**\ (\ platform\: :ref:`EditorExportPlatform`, features\: :ref:`PackedStringArray`\ ) |virtual| |const| Return ``true`` if this plugin will customize resources based on the platform and features used. @@ -137,7 +137,7 @@ When enabled, :ref:`_get_customization_configuration_hash` **_begin_customize_scenes** **(** :ref:`EditorExportPlatform` platform, :ref:`PackedStringArray` features **)** |virtual| |const| +:ref:`bool` **_begin_customize_scenes**\ (\ platform\: :ref:`EditorExportPlatform`, features\: :ref:`PackedStringArray`\ ) |virtual| |const| Return true if this plugin will customize scenes based on the platform and features used. @@ -149,7 +149,7 @@ Return true if this plugin will customize scenes based on the platform and featu .. rst-class:: classref-method -:ref:`Resource` **_customize_resource** **(** :ref:`Resource` resource, :ref:`String` path **)** |virtual| +:ref:`Resource` **_customize_resource**\ (\ resource\: :ref:`Resource`, path\: :ref:`String`\ ) |virtual| Customize a resource. If changes are made to it, return the same or a new resource. Otherwise, return ``null``. @@ -165,7 +165,7 @@ Implementing this method is required if :ref:`_begin_customize_resources` **_customize_scene** **(** :ref:`Node` scene, :ref:`String` path **)** |virtual| +:ref:`Node` **_customize_scene**\ (\ scene\: :ref:`Node`, path\: :ref:`String`\ ) |virtual| Customize a scene. If changes are made to it, return the same or a new scene. Otherwise, return ``null``. If a new scene is returned, it is up to you to dispose of the old one. @@ -179,7 +179,7 @@ Implementing this method is required if :ref:`_begin_customize_scenes` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** |virtual| +|void| **_export_begin**\ (\ features\: :ref:`PackedStringArray`, is_debug\: :ref:`bool`, path\: :ref:`String`, flags\: :ref:`int`\ ) |virtual| Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. ``features`` is the list of features for the export, ``is_debug`` is ``true`` for debug builds, ``path`` is the target path for the exported project. ``flags`` is only used when running a runnable profile, e.g. when using native run on Android. @@ -215,7 +215,7 @@ Virtual method to be overridden by the user. It is called when the export starts .. rst-class:: classref-method -void **_export_end** **(** **)** |virtual| +|void| **_export_end**\ (\ ) |virtual| Virtual method to be overridden by the user. Called when the export is finished. @@ -227,7 +227,7 @@ Virtual method to be overridden by the user. Called when the export is finished. .. rst-class:: classref-method -void **_export_file** **(** :ref:`String` path, :ref:`String` type, :ref:`PackedStringArray` features **)** |virtual| +|void| **_export_file**\ (\ path\: :ref:`String`, type\: :ref:`String`, features\: :ref:`PackedStringArray`\ ) |virtual| Virtual method to be overridden by the user. Called for each exported file, providing arguments that can be used to identify the file. ``path`` is the path of the file, ``type`` is the :ref:`Resource` represented by the file (e.g. :ref:`PackedScene`) and ``features`` is the list of features for the export. @@ -241,7 +241,7 @@ Calling :ref:`skip` inside this callback w .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_android_dependencies** **(** :ref:`EditorExportPlatform` platform, :ref:`bool` debug **)** |virtual| |const| +:ref:`PackedStringArray` **_get_android_dependencies**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| Virtual method to be overridden by the user. This is called to retrieve the set of Android dependencies provided by this plugin. Each returned Android dependency should have the format of an Android remote binary dependency: ``org.godot.example:my-plugin:0.0.0``\ @@ -257,7 +257,7 @@ For more information see `Android documentation on dependencies ` **_get_android_dependencies_maven_repos** **(** :ref:`EditorExportPlatform` platform, :ref:`bool` debug **)** |virtual| |const| +:ref:`PackedStringArray` **_get_android_dependencies_maven_repos**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| Virtual method to be overridden by the user. This is called to retrieve the URLs of Maven repositories for the set of Android dependencies provided by this plugin. @@ -275,7 +275,7 @@ For more information see `Gradle documentation on dependency management ` **_get_android_libraries** **(** :ref:`EditorExportPlatform` platform, :ref:`bool` debug **)** |virtual| |const| +:ref:`PackedStringArray` **_get_android_libraries**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| Virtual method to be overridden by the user. This is called to retrieve the local paths of the Android libraries archive (AAR) files provided by this plugin. @@ -291,7 +291,7 @@ Virtual method to be overridden by the user. This is called to retrieve the loca .. rst-class:: classref-method -:ref:`String` **_get_android_manifest_activity_element_contents** **(** :ref:`EditorExportPlatform` platform, :ref:`bool` debug **)** |virtual| |const| +:ref:`String` **_get_android_manifest_activity_element_contents**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| Virtual method to be overridden by the user. This is used at export time to update the contents of the ``activity`` element in the generated Android manifest. @@ -305,7 +305,7 @@ Virtual method to be overridden by the user. This is used at export time to upda .. rst-class:: classref-method -:ref:`String` **_get_android_manifest_application_element_contents** **(** :ref:`EditorExportPlatform` platform, :ref:`bool` debug **)** |virtual| |const| +:ref:`String` **_get_android_manifest_application_element_contents**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| Virtual method to be overridden by the user. This is used at export time to update the contents of the ``application`` element in the generated Android manifest. @@ -319,7 +319,7 @@ Virtual method to be overridden by the user. This is used at export time to upda .. rst-class:: classref-method -:ref:`String` **_get_android_manifest_element_contents** **(** :ref:`EditorExportPlatform` platform, :ref:`bool` debug **)** |virtual| |const| +:ref:`String` **_get_android_manifest_element_contents**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| Virtual method to be overridden by the user. This is used at export time to update the contents of the ``manifest`` element in the generated Android manifest. @@ -333,7 +333,7 @@ Virtual method to be overridden by the user. This is used at export time to upda .. rst-class:: classref-method -:ref:`int` **_get_customization_configuration_hash** **(** **)** |virtual| |const| +:ref:`int` **_get_customization_configuration_hash**\ (\ ) |virtual| |const| Return a hash based on the configuration passed (for both scenes and resources). This helps keep separate caches for separate export configurations. @@ -347,7 +347,7 @@ Implementing this method is required if :ref:`_begin_customize_resources` **_get_export_features** **(** :ref:`EditorExportPlatform` platform, :ref:`bool` debug **)** |virtual| |const| +:ref:`PackedStringArray` **_get_export_features**\ (\ platform\: :ref:`EditorExportPlatform`, debug\: :ref:`bool`\ ) |virtual| |const| Return a :ref:`PackedStringArray` of additional features this preset, for the given ``platform``, should have. @@ -359,7 +359,7 @@ Return a :ref:`PackedStringArray` of additional feature .. rst-class:: classref-method -:ref:`String` **_get_export_option_warning** **(** :ref:`EditorExportPlatform` platform, :ref:`String` option **)** |virtual| |const| +:ref:`String` **_get_export_option_warning**\ (\ platform\: :ref:`EditorExportPlatform`, option\: :ref:`String`\ ) |virtual| |const| Check the requirements for the given ``option`` and return a non-empty warning string if they are not met. @@ -373,7 +373,7 @@ Check the requirements for the given ``option`` and return a non-empty warning s .. rst-class:: classref-method -:ref:`Dictionary[]` **_get_export_options** **(** :ref:`EditorExportPlatform` platform **)** |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_export_options**\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| Return a list of export options that can be configured for this export plugin. @@ -393,7 +393,7 @@ Each element in the return value is a :ref:`Dictionary` with t .. rst-class:: classref-method -:ref:`Dictionary` **_get_export_options_overrides** **(** :ref:`EditorExportPlatform` platform **)** |virtual| |const| +:ref:`Dictionary` **_get_export_options_overrides**\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| Return a :ref:`Dictionary` of override values for export options, that will be used instead of user-provided values. Overridden options will be hidden from the user interface. @@ -423,7 +423,7 @@ Return a :ref:`Dictionary` of override values for export optio .. rst-class:: classref-method -:ref:`String` **_get_name** **(** **)** |virtual| |const| +:ref:`String` **_get_name**\ (\ ) |virtual| |const| Return the name identifier of this plugin (for future identification by the exporter). The plugins are sorted by name before exporting. @@ -437,7 +437,7 @@ Implementing this method is required. .. rst-class:: classref-method -:ref:`bool` **_should_update_export_options** **(** :ref:`EditorExportPlatform` platform **)** |virtual| |const| +:ref:`bool` **_should_update_export_options**\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| Return ``true``, if the result of :ref:`_get_export_options` has changed and the export options of preset corresponding to ``platform`` should be updated. @@ -449,7 +449,7 @@ Return ``true``, if the result of :ref:`_get_export_options` **_supports_platform** **(** :ref:`EditorExportPlatform` platform **)** |virtual| |const| +:ref:`bool` **_supports_platform**\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| Return ``true`` if the plugin supports the given ``platform``. @@ -461,7 +461,7 @@ Return ``true`` if the plugin supports the given ``platform``. .. rst-class:: classref-method -void **add_file** **(** :ref:`String` path, :ref:`PackedByteArray` file, :ref:`bool` remap **)** +|void| **add_file**\ (\ path\: :ref:`String`, file\: :ref:`PackedByteArray`, remap\: :ref:`bool`\ ) Adds a custom file to be exported. ``path`` is the virtual path that can be used to load the file, ``file`` is the binary data of the file. @@ -475,7 +475,7 @@ When called inside :ref:`_export_file` path **)** +|void| **add_ios_bundle_file**\ (\ path\: :ref:`String`\ ) Adds an iOS bundle file from the given ``path`` to the exported project. @@ -487,7 +487,7 @@ Adds an iOS bundle file from the given ``path`` to the exported project. .. rst-class:: classref-method -void **add_ios_cpp_code** **(** :ref:`String` code **)** +|void| **add_ios_cpp_code**\ (\ code\: :ref:`String`\ ) Adds a C++ code to the iOS export. The final code is created from the code appended by each active export plugin. @@ -499,7 +499,7 @@ Adds a C++ code to the iOS export. The final code is created from the code appen .. rst-class:: classref-method -void **add_ios_embedded_framework** **(** :ref:`String` path **)** +|void| **add_ios_embedded_framework**\ (\ path\: :ref:`String`\ ) Adds a dynamic library (\*.dylib, \*.framework) to Linking Phase in iOS's Xcode project and embeds it into resulting binary. @@ -515,7 +515,7 @@ Adds a dynamic library (\*.dylib, \*.framework) to Linking Phase in iOS's Xcode .. rst-class:: classref-method -void **add_ios_framework** **(** :ref:`String` path **)** +|void| **add_ios_framework**\ (\ path\: :ref:`String`\ ) Adds a static library (\*.a) or dynamic library (\*.dylib, \*.framework) to Linking Phase in iOS's Xcode project. @@ -527,7 +527,7 @@ Adds a static library (\*.a) or dynamic library (\*.dylib, \*.framework) to Link .. rst-class:: classref-method -void **add_ios_linker_flags** **(** :ref:`String` flags **)** +|void| **add_ios_linker_flags**\ (\ flags\: :ref:`String`\ ) Adds linker flags for the iOS export. @@ -539,7 +539,7 @@ Adds linker flags for the iOS export. .. rst-class:: classref-method -void **add_ios_plist_content** **(** :ref:`String` plist_content **)** +|void| **add_ios_plist_content**\ (\ plist_content\: :ref:`String`\ ) Adds content for iOS Property List files. @@ -551,7 +551,7 @@ Adds content for iOS Property List files. .. rst-class:: classref-method -void **add_ios_project_static_lib** **(** :ref:`String` path **)** +|void| **add_ios_project_static_lib**\ (\ path\: :ref:`String`\ ) Adds a static lib from the given ``path`` to the iOS project. @@ -563,7 +563,7 @@ Adds a static lib from the given ``path`` to the iOS project. .. rst-class:: classref-method -void **add_macos_plugin_file** **(** :ref:`String` path **)** +|void| **add_macos_plugin_file**\ (\ path\: :ref:`String`\ ) Adds file or directory matching ``path`` to ``PlugIns`` directory of macOS app bundle. @@ -577,7 +577,7 @@ Adds file or directory matching ``path`` to ``PlugIns`` directory of macOS app b .. rst-class:: classref-method -void **add_shared_object** **(** :ref:`String` path, :ref:`PackedStringArray` tags, :ref:`String` target **)** +|void| **add_shared_object**\ (\ path\: :ref:`String`, tags\: :ref:`PackedStringArray`, target\: :ref:`String`\ ) Adds a shared object or a directory containing only shared objects with the given ``tags`` and destination ``path``. @@ -593,7 +593,7 @@ In case of a directory code-sign will error if you place non code object in dire .. rst-class:: classref-method -:ref:`Variant` **get_option** **(** :ref:`StringName` name **)** |const| +:ref:`Variant` **get_option**\ (\ name\: :ref:`StringName`\ ) |const| Returns the current value of an export option supplied by :ref:`_get_export_options`. @@ -605,7 +605,7 @@ Returns the current value of an export option supplied by :ref:`_get_export_opti .. rst-class:: classref-method -void **skip** **(** **)** +|void| **skip**\ (\ ) To be called inside :ref:`_export_file`. Skips the current file, so it's not included in the export. @@ -616,3 +616,4 @@ To be called inside :ref:`_export_file` | :ref:`get_feature_name` **(** :ref:`Feature` feature **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_class_disabled` **(** :ref:`StringName` class_name **)** |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_class_editor_disabled` **(** :ref:`StringName` class_name **)** |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_class_property_disabled` **(** :ref:`StringName` class_name, :ref:`StringName` property **)** |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_feature_disabled` **(** :ref:`Feature` feature **)** |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load_from_file` **(** :ref:`String` path **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save_to_file` **(** :ref:`String` path **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_disable_class` **(** :ref:`StringName` class_name, :ref:`bool` disable **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_disable_class_editor` **(** :ref:`StringName` class_name, :ref:`bool` disable **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_disable_class_property` **(** :ref:`StringName` class_name, :ref:`StringName` property, :ref:`bool` disable **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_disable_feature` **(** :ref:`Feature` feature, :ref:`bool` disable **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_feature_name`\ (\ feature\: :ref:`Feature`\ ) | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_class_disabled`\ (\ class_name\: :ref:`StringName`\ ) |const| | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_class_editor_disabled`\ (\ class_name\: :ref:`StringName`\ ) |const| | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_class_property_disabled`\ (\ class_name\: :ref:`StringName`, property\: :ref:`StringName`\ ) |const| | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_feature_disabled`\ (\ feature\: :ref:`Feature`\ ) |const| | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_from_file`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save_to_file`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_disable_class`\ (\ class_name\: :ref:`StringName`, disable\: :ref:`bool`\ ) | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_disable_class_editor`\ (\ class_name\: :ref:`StringName`, disable\: :ref:`bool`\ ) | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_disable_class_property`\ (\ class_name\: :ref:`StringName`, property\: :ref:`StringName`, disable\: :ref:`bool`\ ) | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_disable_feature`\ (\ feature\: :ref:`Feature`, disable\: :ref:`bool`\ ) | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -155,7 +155,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **get_feature_name** **(** :ref:`Feature` feature **)** +:ref:`String` **get_feature_name**\ (\ feature\: :ref:`Feature`\ ) Returns the specified ``feature``'s human-readable name. @@ -167,7 +167,7 @@ Returns the specified ``feature``'s human-readable name. .. rst-class:: classref-method -:ref:`bool` **is_class_disabled** **(** :ref:`StringName` class_name **)** |const| +:ref:`bool` **is_class_disabled**\ (\ class_name\: :ref:`StringName`\ ) |const| Returns ``true`` if the class specified by ``class_name`` is disabled. When disabled, the class won't appear in the Create New Node dialog. @@ -179,7 +179,7 @@ Returns ``true`` if the class specified by ``class_name`` is disabled. When disa .. rst-class:: classref-method -:ref:`bool` **is_class_editor_disabled** **(** :ref:`StringName` class_name **)** |const| +:ref:`bool` **is_class_editor_disabled**\ (\ class_name\: :ref:`StringName`\ ) |const| Returns ``true`` if editing for the class specified by ``class_name`` is disabled. When disabled, the class will still appear in the Create New Node dialog but the Inspector will be read-only when selecting a node that extends the class. @@ -191,7 +191,7 @@ Returns ``true`` if editing for the class specified by ``class_name`` is disable .. rst-class:: classref-method -:ref:`bool` **is_class_property_disabled** **(** :ref:`StringName` class_name, :ref:`StringName` property **)** |const| +:ref:`bool` **is_class_property_disabled**\ (\ class_name\: :ref:`StringName`, property\: :ref:`StringName`\ ) |const| Returns ``true`` if ``property`` is disabled in the class specified by ``class_name``. When a property is disabled, it won't appear in the Inspector when selecting a node that extends the class specified by ``class_name``. @@ -203,7 +203,7 @@ Returns ``true`` if ``property`` is disabled in the class specified by ``class_n .. rst-class:: classref-method -:ref:`bool` **is_feature_disabled** **(** :ref:`Feature` feature **)** |const| +:ref:`bool` **is_feature_disabled**\ (\ feature\: :ref:`Feature`\ ) |const| Returns ``true`` if the ``feature`` is disabled. When a feature is disabled, it will disappear from the editor entirely. @@ -215,7 +215,7 @@ Returns ``true`` if the ``feature`` is disabled. When a feature is disabled, it .. rst-class:: classref-method -:ref:`Error` **load_from_file** **(** :ref:`String` path **)** +:ref:`Error` **load_from_file**\ (\ path\: :ref:`String`\ ) Loads an editor feature profile from a file. The file must follow the JSON format obtained by using the feature profile manager's **Export** button or the :ref:`save_to_file` method. @@ -229,7 +229,7 @@ Loads an editor feature profile from a file. The file must follow the JSON forma .. rst-class:: classref-method -:ref:`Error` **save_to_file** **(** :ref:`String` path **)** +:ref:`Error` **save_to_file**\ (\ path\: :ref:`String`\ ) Saves the editor feature profile to a file in JSON format. It can then be imported using the feature profile manager's **Import** button or the :ref:`load_from_file` method. @@ -243,7 +243,7 @@ Saves the editor feature profile to a file in JSON format. It can then be import .. rst-class:: classref-method -void **set_disable_class** **(** :ref:`StringName` class_name, :ref:`bool` disable **)** +|void| **set_disable_class**\ (\ class_name\: :ref:`StringName`, disable\: :ref:`bool`\ ) If ``disable`` is ``true``, disables the class specified by ``class_name``. When disabled, the class won't appear in the Create New Node dialog. @@ -255,7 +255,7 @@ If ``disable`` is ``true``, disables the class specified by ``class_name``. When .. rst-class:: classref-method -void **set_disable_class_editor** **(** :ref:`StringName` class_name, :ref:`bool` disable **)** +|void| **set_disable_class_editor**\ (\ class_name\: :ref:`StringName`, disable\: :ref:`bool`\ ) If ``disable`` is ``true``, disables editing for the class specified by ``class_name``. When disabled, the class will still appear in the Create New Node dialog but the Inspector will be read-only when selecting a node that extends the class. @@ -267,7 +267,7 @@ If ``disable`` is ``true``, disables editing for the class specified by ``class_ .. rst-class:: classref-method -void **set_disable_class_property** **(** :ref:`StringName` class_name, :ref:`StringName` property, :ref:`bool` disable **)** +|void| **set_disable_class_property**\ (\ class_name\: :ref:`StringName`, property\: :ref:`StringName`, disable\: :ref:`bool`\ ) If ``disable`` is ``true``, disables editing for ``property`` in the class specified by ``class_name``. When a property is disabled, it won't appear in the Inspector when selecting a node that extends the class specified by ``class_name``. @@ -279,7 +279,7 @@ If ``disable`` is ``true``, disables editing for ``property`` in the class speci .. rst-class:: classref-method -void **set_disable_feature** **(** :ref:`Feature` feature, :ref:`bool` disable **)** +|void| **set_disable_feature**\ (\ feature\: :ref:`Feature`, disable\: :ref:`bool`\ ) If ``disable`` is ``true``, disables the editor feature specified in ``feature``. When a feature is disabled, it will disappear from the editor entirely. @@ -290,3 +290,4 @@ If ``disable`` is ``true``, disables the editor feature specified in ``feature`` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index 785b372f715..6ffd062b758 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -61,19 +61,19 @@ Methods .. table:: :widths: auto - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_filter` **(** :ref:`String` filter, :ref:`String` description="" **)** | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_side_menu` **(** :ref:`Control` menu, :ref:`String` title="" **)** | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_filters` **(** **)** | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`invalidate` **(** **)** | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_filter`\ (\ filter\: :ref:`String`, description\: :ref:`String` = ""\ ) | + +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_side_menu`\ (\ menu\: :ref:`Control`, title\: :ref:`String` = ""\ ) | + +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_filters`\ (\ ) | + +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`LineEdit` | :ref:`get_line_edit`\ (\ ) | + +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`VBoxContainer` | :ref:`get_vbox`\ (\ ) | + +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`invalidate`\ (\ ) | + +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -88,7 +88,7 @@ Signals .. rst-class:: classref-signal -**dir_selected** **(** :ref:`String` dir **)** +**dir_selected**\ (\ dir\: :ref:`String`\ ) Emitted when a directory is selected. @@ -100,7 +100,7 @@ Emitted when a directory is selected. .. rst-class:: classref-signal -**file_selected** **(** :ref:`String` path **)** +**file_selected**\ (\ path\: :ref:`String`\ ) Emitted when a file is selected. @@ -112,7 +112,7 @@ Emitted when a file is selected. .. rst-class:: classref-signal -**files_selected** **(** :ref:`PackedStringArray` paths **)** +**files_selected**\ (\ paths\: :ref:`PackedStringArray`\ ) Emitted when multiple files are selected. @@ -248,8 +248,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_access** **(** :ref:`Access` value **)** -- :ref:`Access` **get_access** **(** **)** +- |void| **set_access**\ (\ value\: :ref:`Access`\ ) +- :ref:`Access` **get_access**\ (\ ) The location from which the user may select a file, including ``res://``, ``user://``, and the local file system. @@ -265,8 +265,8 @@ The location from which the user may select a file, including ``res://``, ``user .. rst-class:: classref-property-setget -- void **set_current_dir** **(** :ref:`String` value **)** -- :ref:`String` **get_current_dir** **(** **)** +- |void| **set_current_dir**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_current_dir**\ (\ ) The currently occupied directory. @@ -282,8 +282,8 @@ The currently occupied directory. .. rst-class:: classref-property-setget -- void **set_current_file** **(** :ref:`String` value **)** -- :ref:`String` **get_current_file** **(** **)** +- |void| **set_current_file**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_current_file**\ (\ ) The currently selected file. @@ -299,8 +299,8 @@ The currently selected file. .. rst-class:: classref-property-setget -- void **set_current_path** **(** :ref:`String` value **)** -- :ref:`String` **get_current_path** **(** **)** +- |void| **set_current_path**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_current_path**\ (\ ) The file system path in the address bar. @@ -316,8 +316,8 @@ The file system path in the address bar. .. rst-class:: classref-property-setget -- void **set_disable_overwrite_warning** **(** :ref:`bool` value **)** -- :ref:`bool` **is_overwrite_warning_disabled** **(** **)** +- |void| **set_disable_overwrite_warning**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_overwrite_warning_disabled**\ (\ ) If ``true``, the **EditorFileDialog** will not warn the user before overwriting files. @@ -333,8 +333,8 @@ If ``true``, the **EditorFileDialog** will not warn the user before overwriting .. rst-class:: classref-property-setget -- void **set_display_mode** **(** :ref:`DisplayMode` value **)** -- :ref:`DisplayMode` **get_display_mode** **(** **)** +- |void| **set_display_mode**\ (\ value\: :ref:`DisplayMode`\ ) +- :ref:`DisplayMode` **get_display_mode**\ (\ ) The view format in which the **EditorFileDialog** displays resources to the user. @@ -350,8 +350,8 @@ The view format in which the **EditorFileDialog** displays resources to the user .. rst-class:: classref-property-setget -- void **set_file_mode** **(** :ref:`FileMode` value **)** -- :ref:`FileMode` **get_file_mode** **(** **)** +- |void| **set_file_mode**\ (\ value\: :ref:`FileMode`\ ) +- :ref:`FileMode` **get_file_mode**\ (\ ) The dialog's open or save mode, which affects the selection behavior. See :ref:`FileMode`. @@ -367,8 +367,8 @@ The dialog's open or save mode, which affects the selection behavior. See :ref:` .. rst-class:: classref-property-setget -- void **set_filters** **(** :ref:`PackedStringArray` value **)** -- :ref:`PackedStringArray` **get_filters** **(** **)** +- |void| **set_filters**\ (\ value\: :ref:`PackedStringArray`\ ) +- :ref:`PackedStringArray` **get_filters**\ (\ ) The available file type filters. For example, this shows only ``.png`` and ``.gd`` files: ``set_filters(PackedStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))``. Multiple file types can also be specified in a single filter. ``"*.png, *.jpg, *.jpeg ; Supported Images"`` will show both PNG and JPEG files when selected. @@ -384,8 +384,8 @@ The available file type filters. For example, this shows only ``.png`` and ``.gd .. rst-class:: classref-property-setget -- void **set_show_hidden_files** **(** :ref:`bool` value **)** -- :ref:`bool` **is_showing_hidden_files** **(** **)** +- |void| **set_show_hidden_files**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_showing_hidden_files**\ (\ ) If ``true``, hidden files and directories will be visible in the **EditorFileDialog**. This property is synchronized with :ref:`EditorSettings.filesystem/file_dialog/show_hidden_files`. @@ -402,7 +402,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_filter** **(** :ref:`String` filter, :ref:`String` description="" **)** +|void| **add_filter**\ (\ filter\: :ref:`String`, description\: :ref:`String` = ""\ ) Adds a comma-delimited file name ``filter`` option to the **EditorFileDialog** with an optional ``description``, which restricts what files can be picked. @@ -418,7 +418,7 @@ For example, a ``filter`` of ``"*.tscn, *.scn"`` and a ``description`` of ``"Sce .. rst-class:: classref-method -void **add_side_menu** **(** :ref:`Control` menu, :ref:`String` title="" **)** +|void| **add_side_menu**\ (\ menu\: :ref:`Control`, title\: :ref:`String` = ""\ ) Adds the given ``menu`` to the side of the file dialog with the given ``title`` text on top. Only one side menu is allowed. @@ -430,7 +430,7 @@ Adds the given ``menu`` to the side of the file dialog with the given ``title`` .. rst-class:: classref-method -void **clear_filters** **(** **)** +|void| **clear_filters**\ (\ ) Removes all filters except for "All Files (\*)". @@ -442,7 +442,7 @@ Removes all filters except for "All Files (\*)". .. rst-class:: classref-method -:ref:`LineEdit` **get_line_edit** **(** **)** +:ref:`LineEdit` **get_line_edit**\ (\ ) Returns the LineEdit for the selected file. @@ -456,7 +456,7 @@ Returns the LineEdit for the selected file. .. rst-class:: classref-method -:ref:`VBoxContainer` **get_vbox** **(** **)** +:ref:`VBoxContainer` **get_vbox**\ (\ ) Returns the :ref:`VBoxContainer` used to display the file system. @@ -470,7 +470,7 @@ Returns the :ref:`VBoxContainer` used to display the file s .. rst-class:: classref-method -void **invalidate** **(** **)** +|void| **invalidate**\ (\ ) Notify the **EditorFileDialog** that its view of the data is no longer accurate. Updates the view contents on next view update. @@ -481,3 +481,4 @@ Notify the **EditorFileDialog** that its view of the data is no longer accurate. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index e18322711ff..15d1f503ea3 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -31,25 +31,25 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_file_type` **(** :ref:`String` path **)** |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorFileSystemDirectory` | :ref:`get_filesystem` **(** **)** | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorFileSystemDirectory` | :ref:`get_filesystem_path` **(** :ref:`String` path **)** | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_scanning_progress` **(** **)** |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_scanning` **(** **)** |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reimport_files` **(** :ref:`PackedStringArray` files **)** | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`scan` **(** **)** | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`scan_sources` **(** **)** | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`update_file` **(** :ref:`String` path **)** | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_file_type`\ (\ path\: :ref:`String`\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`EditorFileSystemDirectory` | :ref:`get_filesystem`\ (\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`EditorFileSystemDirectory` | :ref:`get_filesystem_path`\ (\ path\: :ref:`String`\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_scanning_progress`\ (\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_scanning`\ (\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reimport_files`\ (\ files\: :ref:`PackedStringArray`\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`scan`\ (\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`scan_sources`\ (\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update_file`\ (\ path\: :ref:`String`\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -64,7 +64,7 @@ Signals .. rst-class:: classref-signal -**filesystem_changed** **(** **)** +**filesystem_changed**\ (\ ) Emitted if the filesystem changed. @@ -76,7 +76,7 @@ Emitted if the filesystem changed. .. rst-class:: classref-signal -**resources_reimported** **(** :ref:`PackedStringArray` resources **)** +**resources_reimported**\ (\ resources\: :ref:`PackedStringArray`\ ) Emitted if a resource is reimported. @@ -88,7 +88,7 @@ Emitted if a resource is reimported. .. rst-class:: classref-signal -**resources_reload** **(** :ref:`PackedStringArray` resources **)** +**resources_reload**\ (\ resources\: :ref:`PackedStringArray`\ ) Emitted if at least one resource is reloaded when the filesystem is scanned. @@ -100,7 +100,7 @@ Emitted if at least one resource is reloaded when the filesystem is scanned. .. rst-class:: classref-signal -**script_classes_updated** **(** **)** +**script_classes_updated**\ (\ ) Emitted when the list of global script classes gets updated. @@ -112,7 +112,7 @@ Emitted when the list of global script classes gets updated. .. rst-class:: classref-signal -**sources_changed** **(** :ref:`bool` exist **)** +**sources_changed**\ (\ exist\: :ref:`bool`\ ) Emitted if the source of any imported file changed. @@ -129,7 +129,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **get_file_type** **(** :ref:`String` path **)** |const| +:ref:`String` **get_file_type**\ (\ path\: :ref:`String`\ ) |const| Returns the resource type of the file, given the full path. This returns a string such as ``"Resource"`` or ``"GDScript"``, *not* a file extension such as ``".gd"``. @@ -141,7 +141,7 @@ Returns the resource type of the file, given the full path. This returns a strin .. rst-class:: classref-method -:ref:`EditorFileSystemDirectory` **get_filesystem** **(** **)** +:ref:`EditorFileSystemDirectory` **get_filesystem**\ (\ ) Gets the root directory object. @@ -153,7 +153,7 @@ Gets the root directory object. .. rst-class:: classref-method -:ref:`EditorFileSystemDirectory` **get_filesystem_path** **(** :ref:`String` path **)** +:ref:`EditorFileSystemDirectory` **get_filesystem_path**\ (\ path\: :ref:`String`\ ) Returns a view into the filesystem at ``path``. @@ -165,7 +165,7 @@ Returns a view into the filesystem at ``path``. .. rst-class:: classref-method -:ref:`float` **get_scanning_progress** **(** **)** |const| +:ref:`float` **get_scanning_progress**\ (\ ) |const| Returns the scan progress for 0 to 1 if the FS is being scanned. @@ -177,7 +177,7 @@ Returns the scan progress for 0 to 1 if the FS is being scanned. .. rst-class:: classref-method -:ref:`bool` **is_scanning** **(** **)** |const| +:ref:`bool` **is_scanning**\ (\ ) |const| Returns ``true`` if the filesystem is being scanned. @@ -189,7 +189,7 @@ Returns ``true`` if the filesystem is being scanned. .. rst-class:: classref-method -void **reimport_files** **(** :ref:`PackedStringArray` files **)** +|void| **reimport_files**\ (\ files\: :ref:`PackedStringArray`\ ) Reimports a set of files. Call this if these files or their ``.import`` files were directly edited by script or an external program. @@ -205,7 +205,7 @@ If the file type changed or the file was newly created, use :ref:`update_file` path **)** +|void| **update_file**\ (\ path\: :ref:`String`\ ) Add a file in an existing directory, or schedule file information to be updated on editor restart. Can be used to update text files saved by an external program. @@ -242,3 +242,4 @@ This will not import the file. To reimport, call :ref:`reimport_files` | :ref:`find_dir_index` **(** :ref:`String` name **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find_file_index` **(** :ref:`String` name **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_file` **(** :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_file_count` **(** **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_file_import_is_valid` **(** :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_file_path` **(** :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_file_script_class_extends` **(** :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_file_script_class_name` **(** :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_file_type` **(** :ref:`int` idx **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_name` **(** **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorFileSystemDirectory` | :ref:`get_parent` **(** **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_path` **(** **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorFileSystemDirectory` | :ref:`get_subdir` **(** :ref:`int` idx **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_subdir_count` **(** **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find_dir_index`\ (\ name\: :ref:`String`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find_file_index`\ (\ name\: :ref:`String`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_file`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_file_count`\ (\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_file_import_is_valid`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_file_path`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_file_script_class_extends`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_file_script_class_name`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_file_type`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_name`\ (\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`EditorFileSystemDirectory` | :ref:`get_parent`\ (\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_path`\ (\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`EditorFileSystemDirectory` | :ref:`get_subdir`\ (\ idx\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_subdir_count`\ (\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -72,7 +72,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **find_dir_index** **(** :ref:`String` name **)** |const| +:ref:`int` **find_dir_index**\ (\ name\: :ref:`String`\ ) |const| Returns the index of the directory with name ``name`` or ``-1`` if not found. @@ -84,7 +84,7 @@ Returns the index of the directory with name ``name`` or ``-1`` if not found. .. rst-class:: classref-method -:ref:`int` **find_file_index** **(** :ref:`String` name **)** |const| +:ref:`int` **find_file_index**\ (\ name\: :ref:`String`\ ) |const| Returns the index of the file with name ``name`` or ``-1`` if not found. @@ -96,7 +96,7 @@ Returns the index of the file with name ``name`` or ``-1`` if not found. .. rst-class:: classref-method -:ref:`String` **get_file** **(** :ref:`int` idx **)** |const| +:ref:`String` **get_file**\ (\ idx\: :ref:`int`\ ) |const| Returns the name of the file at index ``idx``. @@ -108,7 +108,7 @@ Returns the name of the file at index ``idx``. .. rst-class:: classref-method -:ref:`int` **get_file_count** **(** **)** |const| +:ref:`int` **get_file_count**\ (\ ) |const| Returns the number of files in this directory. @@ -120,7 +120,7 @@ Returns the number of files in this directory. .. rst-class:: classref-method -:ref:`bool` **get_file_import_is_valid** **(** :ref:`int` idx **)** |const| +:ref:`bool` **get_file_import_is_valid**\ (\ idx\: :ref:`int`\ ) |const| Returns ``true`` if the file at index ``idx`` imported properly. @@ -132,7 +132,7 @@ Returns ``true`` if the file at index ``idx`` imported properly. .. rst-class:: classref-method -:ref:`String` **get_file_path** **(** :ref:`int` idx **)** |const| +:ref:`String` **get_file_path**\ (\ idx\: :ref:`int`\ ) |const| Returns the path to the file at index ``idx``. @@ -144,7 +144,7 @@ Returns the path to the file at index ``idx``. .. rst-class:: classref-method -:ref:`String` **get_file_script_class_extends** **(** :ref:`int` idx **)** |const| +:ref:`String` **get_file_script_class_extends**\ (\ idx\: :ref:`int`\ ) |const| Returns the base class of the script class defined in the file at index ``idx``. If the file doesn't define a script class using the ``class_name`` syntax, this will return an empty string. @@ -156,7 +156,7 @@ Returns the base class of the script class defined in the file at index ``idx``. .. rst-class:: classref-method -:ref:`String` **get_file_script_class_name** **(** :ref:`int` idx **)** |const| +:ref:`String` **get_file_script_class_name**\ (\ idx\: :ref:`int`\ ) |const| Returns the name of the script class defined in the file at index ``idx``. If the file doesn't define a script class using the ``class_name`` syntax, this will return an empty string. @@ -168,7 +168,7 @@ Returns the name of the script class defined in the file at index ``idx``. If th .. rst-class:: classref-method -:ref:`StringName` **get_file_type** **(** :ref:`int` idx **)** |const| +:ref:`StringName` **get_file_type**\ (\ idx\: :ref:`int`\ ) |const| Returns the resource type of the file at index ``idx``. This returns a string such as ``"Resource"`` or ``"GDScript"``, *not* a file extension such as ``".gd"``. @@ -180,7 +180,7 @@ Returns the resource type of the file at index ``idx``. This returns a string su .. rst-class:: classref-method -:ref:`String` **get_name** **(** **)** +:ref:`String` **get_name**\ (\ ) Returns the name of this directory. @@ -192,7 +192,7 @@ Returns the name of this directory. .. rst-class:: classref-method -:ref:`EditorFileSystemDirectory` **get_parent** **(** **)** +:ref:`EditorFileSystemDirectory` **get_parent**\ (\ ) Returns the parent directory for this directory or ``null`` if called on a directory at ``res://`` or ``user://``. @@ -204,7 +204,7 @@ Returns the parent directory for this directory or ``null`` if called on a direc .. rst-class:: classref-method -:ref:`String` **get_path** **(** **)** |const| +:ref:`String` **get_path**\ (\ ) |const| Returns the path to this directory. @@ -216,7 +216,7 @@ Returns the path to this directory. .. rst-class:: classref-method -:ref:`EditorFileSystemDirectory` **get_subdir** **(** :ref:`int` idx **)** +:ref:`EditorFileSystemDirectory` **get_subdir**\ (\ idx\: :ref:`int`\ ) Returns the subdirectory at index ``idx``. @@ -228,7 +228,7 @@ Returns the subdirectory at index ``idx``. .. rst-class:: classref-method -:ref:`int` **get_subdir_count** **(** **)** |const| +:ref:`int` **get_subdir_count**\ (\ ) |const| Returns the number of subdirectories in this directory. @@ -239,3 +239,4 @@ Returns the number of subdirectories in this directory. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorfilesystemimportformatsupportquery.rst b/classes/class_editorfilesystemimportformatsupportquery.rst index 66e9a1693dc..aecd8f9b1c3 100644 --- a/classes/class_editorfilesystemimportformatsupportquery.rst +++ b/classes/class_editorfilesystemimportformatsupportquery.rst @@ -29,13 +29,13 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_file_extensions` **(** **)** |virtual| |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_active` **(** **)** |virtual| |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_query` **(** **)** |virtual| |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_file_extensions`\ (\ ) |virtual| |const| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_active`\ (\ ) |virtual| |const| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_query`\ (\ ) |virtual| |const| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -50,7 +50,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_file_extensions** **(** **)** |virtual| |const| +:ref:`PackedStringArray` **_get_file_extensions**\ (\ ) |virtual| |const| Return the file extensions supported. @@ -62,7 +62,7 @@ Return the file extensions supported. .. rst-class:: classref-method -:ref:`bool` **_is_active** **(** **)** |virtual| |const| +:ref:`bool` **_is_active**\ (\ ) |virtual| |const| Return whether this importer is active. @@ -74,7 +74,7 @@ Return whether this importer is active. .. rst-class:: classref-method -:ref:`bool` **_query** **(** **)** |virtual| |const| +:ref:`bool` **_query**\ (\ ) |virtual| |const| Query support. Return false if import must not continue. @@ -85,3 +85,4 @@ Query support. Return false if import must not continue. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index 7f1f051cd21..7ced4da7e69 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -154,35 +154,35 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_can_import_threaded` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`_get_import_options` **(** :ref:`String` path, :ref:`int` preset_index **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_import_order` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_importer_name` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_get_option_visibility` **(** :ref:`String` path, :ref:`StringName` option_name, :ref:`Dictionary` options **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_preset_count` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_preset_name` **(** :ref:`int` preset_index **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_priority` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_recognized_extensions` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_resource_type` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_save_extension` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_visible_name` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_import` **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`String[]` platform_variants, :ref:`String[]` gen_files **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`append_import_external_resource` **(** :ref:`String` path, :ref:`Dictionary` custom_options={}, :ref:`String` custom_importer="", :ref:`Variant` generator_parameters=null **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_can_import_threaded`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_import_options`\ (\ path\: :ref:`String`, preset_index\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_import_order`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_importer_name`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_get_option_visibility`\ (\ path\: :ref:`String`, option_name\: :ref:`StringName`, options\: :ref:`Dictionary`\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_preset_count`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_preset_name`\ (\ preset_index\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_priority`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_recognized_extensions`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_resource_type`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_save_extension`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_visible_name`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_import`\ (\ source_file\: :ref:`String`, save_path\: :ref:`String`, options\: :ref:`Dictionary`, platform_variants\: :ref:`Array`\[:ref:`String`\], gen_files\: :ref:`Array`\[:ref:`String`\]\ ) |virtual| |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`append_import_external_resource`\ (\ path\: :ref:`String`, custom_options\: :ref:`Dictionary` = {}, custom_importer\: :ref:`String` = "", generator_parameters\: :ref:`Variant` = null\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -197,7 +197,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_can_import_threaded** **(** **)** |virtual| |const| +:ref:`bool` **_can_import_threaded**\ (\ ) |virtual| |const| Tells whether this importer can be run in parallel on threads, or, on the contrary, it's only safe for the editor to call it from the main thread, for one file at a time. @@ -211,7 +211,7 @@ If this method is not overridden, it will return ``true`` by default (i.e., safe .. rst-class:: classref-method -:ref:`Dictionary[]` **_get_import_options** **(** :ref:`String` path, :ref:`int` preset_index **)** |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_import_options**\ (\ path\: :ref:`String`, preset_index\: :ref:`int`\ ) |virtual| |const| Gets the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: ``name``, ``default_value``, ``property_hint`` (optional), ``hint_string`` (optional), ``usage`` (optional). @@ -223,7 +223,7 @@ Gets the options and default values for the preset at this index. Returns an Arr .. rst-class:: classref-method -:ref:`int` **_get_import_order** **(** **)** |virtual| |const| +:ref:`int` **_get_import_order**\ (\ ) |virtual| |const| Gets the order of this importer to be run when importing resources. Importers with *lower* import orders will be called first, and higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported. The default import order is ``0`` unless overridden by a specific importer. See :ref:`ImportOrder` for some predefined values. @@ -235,7 +235,7 @@ Gets the order of this importer to be run when importing resources. Importers wi .. rst-class:: classref-method -:ref:`String` **_get_importer_name** **(** **)** |virtual| |const| +:ref:`String` **_get_importer_name**\ (\ ) |virtual| |const| Gets the unique name of the importer. @@ -247,7 +247,7 @@ Gets the unique name of the importer. .. rst-class:: classref-method -:ref:`bool` **_get_option_visibility** **(** :ref:`String` path, :ref:`StringName` option_name, :ref:`Dictionary` options **)** |virtual| |const| +:ref:`bool` **_get_option_visibility**\ (\ path\: :ref:`String`, option_name\: :ref:`StringName`, options\: :ref:`Dictionary`\ ) |virtual| |const| This method can be overridden to hide specific import options if conditions are met. This is mainly useful for hiding options that depend on others if one of them is disabled. For example: @@ -288,7 +288,7 @@ Returns ``true`` to make all options always visible. .. rst-class:: classref-method -:ref:`int` **_get_preset_count** **(** **)** |virtual| |const| +:ref:`int` **_get_preset_count**\ (\ ) |virtual| |const| Gets the number of initial presets defined by the plugin. Use :ref:`_get_import_options` to get the default options for the preset and :ref:`_get_preset_name` to get the name of the preset. @@ -300,7 +300,7 @@ Gets the number of initial presets defined by the plugin. Use :ref:`_get_import_ .. rst-class:: classref-method -:ref:`String` **_get_preset_name** **(** :ref:`int` preset_index **)** |virtual| |const| +:ref:`String` **_get_preset_name**\ (\ preset_index\: :ref:`int`\ ) |virtual| |const| Gets the name of the options preset at this index. @@ -312,7 +312,7 @@ Gets the name of the options preset at this index. .. rst-class:: classref-method -:ref:`float` **_get_priority** **(** **)** |virtual| |const| +:ref:`float` **_get_priority**\ (\ ) |virtual| |const| Gets the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. The default priority is ``1.0``. @@ -324,7 +324,7 @@ Gets the priority of this plugin for the recognized extension. Higher priority p .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_recognized_extensions** **(** **)** |virtual| |const| +:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ ) |virtual| |const| Gets the list of file extensions to associate with this loader (case-insensitive). e.g. ``["obj"]``. @@ -336,7 +336,7 @@ Gets the list of file extensions to associate with this loader (case-insensitive .. rst-class:: classref-method -:ref:`String` **_get_resource_type** **(** **)** |virtual| |const| +:ref:`String` **_get_resource_type**\ (\ ) |virtual| |const| Gets the Godot resource type associated with this loader. e.g. ``"Mesh"`` or ``"Animation"``. @@ -348,7 +348,7 @@ Gets the Godot resource type associated with this loader. e.g. ``"Mesh"`` or ``" .. rst-class:: classref-method -:ref:`String` **_get_save_extension** **(** **)** |virtual| |const| +:ref:`String` **_get_save_extension**\ (\ ) |virtual| |const| Gets the extension used to save this resource in the ``.godot/imported`` directory (see :ref:`ProjectSettings.application/config/use_hidden_project_data_directory`). @@ -360,7 +360,7 @@ Gets the extension used to save this resource in the ``.godot/imported`` directo .. rst-class:: classref-method -:ref:`String` **_get_visible_name** **(** **)** |virtual| |const| +:ref:`String` **_get_visible_name**\ (\ ) |virtual| |const| Gets the name to display in the import window. You should choose this name as a continuation to "Import as", e.g. "Import as Special Mesh". @@ -372,7 +372,7 @@ Gets the name to display in the import window. You should choose this name as a .. rst-class:: classref-method -:ref:`Error` **_import** **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`String[]` platform_variants, :ref:`String[]` gen_files **)** |virtual| |const| +:ref:`Error` **_import**\ (\ source_file\: :ref:`String`, save_path\: :ref:`String`, options\: :ref:`Dictionary`, platform_variants\: :ref:`Array`\[:ref:`String`\], gen_files\: :ref:`Array`\[:ref:`String`\]\ ) |virtual| |const| Imports ``source_file`` into ``save_path`` with the import ``options`` specified. The ``platform_variants`` and ``gen_files`` arrays will be modified by this function. @@ -386,7 +386,7 @@ This method must be overridden to do the actual importing work. See this class' .. rst-class:: classref-method -:ref:`Error` **append_import_external_resource** **(** :ref:`String` path, :ref:`Dictionary` custom_options={}, :ref:`String` custom_importer="", :ref:`Variant` generator_parameters=null **)** +:ref:`Error` **append_import_external_resource**\ (\ path\: :ref:`String`, custom_options\: :ref:`Dictionary` = {}, custom_importer\: :ref:`String` = "", generator_parameters\: :ref:`Variant` = null\ ) This function can only be called during the :ref:`_import` callback and it allows manually importing resources from it. This is useful when the imported file generates external resources that require importing (as example, images). Custom parameters for the ".import" file can be passed via the ``custom_options``. Additionally, in cases where multiple importers can handle a file, the ``custom_importer`` ca be specified to force a specific one. This function performs a resource import and returns immediately with a success or error code. ``generator_parameters`` defines optional extra metadata which will be stored as ``generator_parameters`` in the ``remap`` section of the ``.import`` file, for example to store a md5 hash of the source data. @@ -397,3 +397,4 @@ This function can only be called during the :ref:`_import` | :ref:`get_edited_object` **(** **)** | - +-----------------------------+----------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_selected_path` **(** **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------+ + +-----------------------------+----------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_edited_object`\ (\ ) | + +-----------------------------+----------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_selected_path`\ (\ ) |const| | + +-----------------------------+----------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -72,7 +72,7 @@ Signals .. rst-class:: classref-signal -**edited_object_changed** **(** **)** +**edited_object_changed**\ (\ ) Emitted when the object being edited by the inspector has changed. @@ -84,7 +84,7 @@ Emitted when the object being edited by the inspector has changed. .. rst-class:: classref-signal -**object_id_selected** **(** :ref:`int` id **)** +**object_id_selected**\ (\ id\: :ref:`int`\ ) Emitted when the Edit button of an :ref:`Object` has been pressed in the inspector. This is mainly used in the remote scene tree Inspector. @@ -96,7 +96,7 @@ Emitted when the Edit button of an :ref:`Object` has been pressed .. rst-class:: classref-signal -**property_deleted** **(** :ref:`String` property **)** +**property_deleted**\ (\ property\: :ref:`String`\ ) Emitted when a property is removed from the inspector. @@ -108,7 +108,7 @@ Emitted when a property is removed from the inspector. .. rst-class:: classref-signal -**property_edited** **(** :ref:`String` property **)** +**property_edited**\ (\ property\: :ref:`String`\ ) Emitted when a property is edited in the inspector. @@ -120,7 +120,7 @@ Emitted when a property is edited in the inspector. .. rst-class:: classref-signal -**property_keyed** **(** :ref:`String` property, :ref:`Variant` value, :ref:`bool` advance **)** +**property_keyed**\ (\ property\: :ref:`String`, value\: :ref:`Variant`, advance\: :ref:`bool`\ ) Emitted when a property is keyed in the inspector. Properties can be keyed by clicking the "key" icon next to a property when the Animation panel is toggled. @@ -132,7 +132,7 @@ Emitted when a property is keyed in the inspector. Properties can be keyed by cl .. rst-class:: classref-signal -**property_selected** **(** :ref:`String` property **)** +**property_selected**\ (\ property\: :ref:`String`\ ) Emitted when a property is selected in the inspector. @@ -144,7 +144,7 @@ Emitted when a property is selected in the inspector. .. rst-class:: classref-signal -**property_toggled** **(** :ref:`String` property, :ref:`bool` checked **)** +**property_toggled**\ (\ property\: :ref:`String`, checked\: :ref:`bool`\ ) Emitted when a boolean property is toggled in the inspector. @@ -158,7 +158,7 @@ Emitted when a boolean property is toggled in the inspector. .. rst-class:: classref-signal -**resource_selected** **(** :ref:`Resource` resource, :ref:`String` path **)** +**resource_selected**\ (\ resource\: :ref:`Resource`, path\: :ref:`String`\ ) Emitted when a resource is selected in the inspector. @@ -170,7 +170,7 @@ Emitted when a resource is selected in the inspector. .. rst-class:: classref-signal -**restart_requested** **(** **)** +**restart_requested**\ (\ ) Emitted when a property that requires a restart to be applied is edited in the inspector. This is only used in the Project Settings and Editor Settings. @@ -187,7 +187,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Object` **get_edited_object** **(** **)** +:ref:`Object` **get_edited_object**\ (\ ) Returns the object currently selected in this inspector. @@ -199,7 +199,7 @@ Returns the object currently selected in this inspector. .. rst-class:: classref-method -:ref:`String` **get_selected_path** **(** **)** |const| +:ref:`String` **get_selected_path**\ (\ ) |const| Gets the path of the currently selected property. @@ -210,3 +210,4 @@ Gets the path of the currently selected property. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorinspectorplugin.rst b/classes/class_editorinspectorplugin.rst index 30b1c58528c..40a010ebb08 100644 --- a/classes/class_editorinspectorplugin.rst +++ b/classes/class_editorinspectorplugin.rst @@ -48,25 +48,25 @@ Methods .. table:: :widths: auto - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_can_handle` **(** :ref:`Object` object **)** |virtual| |const| | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_parse_begin` **(** :ref:`Object` object **)** |virtual| | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_parse_category` **(** :ref:`Object` object, :ref:`String` category **)** |virtual| | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_parse_end` **(** :ref:`Object` object **)** |virtual| | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_parse_group` **(** :ref:`Object` object, :ref:`String` group **)** |virtual| | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_parse_property` **(** :ref:`Object` object, :ref:`Variant.Type` type, :ref:`String` name, :ref:`PropertyHint` hint_type, :ref:`String` hint_string, |bitfield|\<:ref:`PropertyUsageFlags`\> usage_flags, :ref:`bool` wide **)** |virtual| | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_custom_control` **(** :ref:`Control` control **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_property_editor` **(** :ref:`String` property, :ref:`Control` editor, :ref:`bool` add_to_end=false **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_property_editor_for_multiple_properties` **(** :ref:`String` label, :ref:`PackedStringArray` properties, :ref:`Control` editor **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_can_handle`\ (\ object\: :ref:`Object`\ ) |virtual| |const| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_parse_begin`\ (\ object\: :ref:`Object`\ ) |virtual| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_parse_category`\ (\ object\: :ref:`Object`, category\: :ref:`String`\ ) |virtual| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_parse_end`\ (\ object\: :ref:`Object`\ ) |virtual| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_parse_group`\ (\ object\: :ref:`Object`, group\: :ref:`String`\ ) |virtual| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_parse_property`\ (\ object\: :ref:`Object`, type\: :ref:`Variant.Type`, name\: :ref:`String`, hint_type\: :ref:`PropertyHint`, hint_string\: :ref:`String`, usage_flags\: |bitfield|\[:ref:`PropertyUsageFlags`\], wide\: :ref:`bool`\ ) |virtual| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_custom_control`\ (\ control\: :ref:`Control`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_property_editor`\ (\ property\: :ref:`String`, editor\: :ref:`Control`, add_to_end\: :ref:`bool` = false\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_property_editor_for_multiple_properties`\ (\ label\: :ref:`String`, properties\: :ref:`PackedStringArray`, editor\: :ref:`Control`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -81,7 +81,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_can_handle** **(** :ref:`Object` object **)** |virtual| |const| +:ref:`bool` **_can_handle**\ (\ object\: :ref:`Object`\ ) |virtual| |const| Returns ``true`` if this object can be handled by this plugin. @@ -93,7 +93,7 @@ Returns ``true`` if this object can be handled by this plugin. .. rst-class:: classref-method -void **_parse_begin** **(** :ref:`Object` object **)** |virtual| +|void| **_parse_begin**\ (\ object\: :ref:`Object`\ ) |virtual| Called to allow adding controls at the beginning of the property list for ``object``. @@ -105,7 +105,7 @@ Called to allow adding controls at the beginning of the property list for ``obje .. rst-class:: classref-method -void **_parse_category** **(** :ref:`Object` object, :ref:`String` category **)** |virtual| +|void| **_parse_category**\ (\ object\: :ref:`Object`, category\: :ref:`String`\ ) |virtual| Called to allow adding controls at the beginning of a category in the property list for ``object``. @@ -117,7 +117,7 @@ Called to allow adding controls at the beginning of a category in the property l .. rst-class:: classref-method -void **_parse_end** **(** :ref:`Object` object **)** |virtual| +|void| **_parse_end**\ (\ object\: :ref:`Object`\ ) |virtual| Called to allow adding controls at the end of the property list for ``object``. @@ -129,7 +129,7 @@ Called to allow adding controls at the end of the property list for ``object``. .. rst-class:: classref-method -void **_parse_group** **(** :ref:`Object` object, :ref:`String` group **)** |virtual| +|void| **_parse_group**\ (\ object\: :ref:`Object`, group\: :ref:`String`\ ) |virtual| Called to allow adding controls at the beginning of a group or a sub-group in the property list for ``object``. @@ -141,7 +141,7 @@ Called to allow adding controls at the beginning of a group or a sub-group in th .. rst-class:: classref-method -:ref:`bool` **_parse_property** **(** :ref:`Object` object, :ref:`Variant.Type` type, :ref:`String` name, :ref:`PropertyHint` hint_type, :ref:`String` hint_string, |bitfield|\<:ref:`PropertyUsageFlags`\> usage_flags, :ref:`bool` wide **)** |virtual| +:ref:`bool` **_parse_property**\ (\ object\: :ref:`Object`, type\: :ref:`Variant.Type`, name\: :ref:`String`, hint_type\: :ref:`PropertyHint`, hint_string\: :ref:`String`, usage_flags\: |bitfield|\[:ref:`PropertyUsageFlags`\], wide\: :ref:`bool`\ ) |virtual| Called to allow adding property-specific editors to the property list for ``object``. The added editor control must extend :ref:`EditorProperty`. Returning ``true`` removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one. @@ -153,7 +153,7 @@ Called to allow adding property-specific editors to the property list for ``obje .. rst-class:: classref-method -void **add_custom_control** **(** :ref:`Control` control **)** +|void| **add_custom_control**\ (\ control\: :ref:`Control`\ ) Adds a custom control, which is not necessarily a property editor. @@ -165,7 +165,7 @@ Adds a custom control, which is not necessarily a property editor. .. rst-class:: classref-method -void **add_property_editor** **(** :ref:`String` property, :ref:`Control` editor, :ref:`bool` add_to_end=false **)** +|void| **add_property_editor**\ (\ property\: :ref:`String`, editor\: :ref:`Control`, add_to_end\: :ref:`bool` = false\ ) Adds a property editor for an individual property. The ``editor`` control must extend :ref:`EditorProperty`. @@ -177,7 +177,7 @@ Adds a property editor for an individual property. The ``editor`` control must e .. rst-class:: classref-method -void **add_property_editor_for_multiple_properties** **(** :ref:`String` label, :ref:`PackedStringArray` properties, :ref:`Control` editor **)** +|void| **add_property_editor_for_multiple_properties**\ (\ label\: :ref:`String`, properties\: :ref:`PackedStringArray`, editor\: :ref:`Control`\ ) Adds an editor that allows modifying multiple properties. The ``editor`` control must extend :ref:`EditorProperty`. @@ -188,3 +188,4 @@ Adds an editor that allows modifying multiple properties. The ``editor`` control .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index 5663fb60291..01fa5470d55 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -59,109 +59,109 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`edit_node` **(** :ref:`Node` node **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`edit_resource` **(** :ref:`Resource` resource **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`edit_script` **(** :ref:`Script` script, :ref:`int` line=-1, :ref:`int` column=0, :ref:`bool` grab_focus=true **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Control` | :ref:`get_base_control` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorCommandPalette` | :ref:`get_command_palette` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_current_directory` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_current_feature_profile` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_current_path` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VBoxContainer` | :ref:`get_editor_main_screen` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorPaths` | :ref:`get_editor_paths` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_editor_scale` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorSettings` | :ref:`get_editor_settings` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Theme` | :ref:`get_editor_theme` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SubViewport` | :ref:`get_editor_viewport_2d` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SubViewport` | :ref:`get_editor_viewport_3d` **(** :ref:`int` idx=0 **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`FileSystemDock` | :ref:`get_file_system_dock` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorInspector` | :ref:`get_inspector` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_open_scenes` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_playing_scene` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorFileSystem` | :ref:`get_resource_filesystem` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorResourcePreview` | :ref:`get_resource_previewer` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ScriptEditor` | :ref:`get_script_editor` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_selected_paths` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorSelection` | :ref:`get_selection` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`inspect_object` **(** :ref:`Object` object, :ref:`String` for_property="", :ref:`bool` inspector_only=false **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_multi_window_enabled` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_playing_scene` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_plugin_enabled` **(** :ref:`String` plugin **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D[]` | :ref:`make_mesh_previews` **(** :ref:`Mesh[]` meshes, :ref:`int` preview_size **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`mark_scene_as_unsaved` **(** **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`open_scene_from_path` **(** :ref:`String` scene_filepath **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`play_current_scene` **(** **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`play_custom_scene` **(** :ref:`String` scene_filepath **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`play_main_scene` **(** **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`popup_dialog` **(** :ref:`Window` dialog, :ref:`Rect2i` rect=Rect2i(0, 0, 0, 0) **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`popup_dialog_centered` **(** :ref:`Window` dialog, :ref:`Vector2i` minsize=Vector2i(0, 0) **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`popup_dialog_centered_clamped` **(** :ref:`Window` dialog, :ref:`Vector2i` minsize=Vector2i(0, 0), :ref:`float` fallback_ratio=0.75 **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`popup_dialog_centered_ratio` **(** :ref:`Window` dialog, :ref:`float` ratio=0.8 **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`popup_node_selector` **(** :ref:`Callable` callback, :ref:`StringName[]` valid_types=[] **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`popup_property_selector` **(** :ref:`Object` object, :ref:`Callable` callback, :ref:`PackedInt32Array` type_filter=PackedInt32Array() **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reload_scene_from_path` **(** :ref:`String` scene_filepath **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`restart_editor` **(** :ref:`bool` save=true **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`save_all_scenes` **(** **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save_scene` **(** **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`save_scene_as` **(** :ref:`String` path, :ref:`bool` with_preview=true **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`select_file` **(** :ref:`String` file **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_current_feature_profile` **(** :ref:`String` profile_name **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_main_screen_editor` **(** :ref:`String` name **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_plugin_enabled` **(** :ref:`String` plugin, :ref:`bool` enabled **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`stop_playing_scene` **(** **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`edit_node`\ (\ node\: :ref:`Node`\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`edit_resource`\ (\ resource\: :ref:`Resource`\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`edit_script`\ (\ script\: :ref:`Script`, line\: :ref:`int` = -1, column\: :ref:`int` = 0, grab_focus\: :ref:`bool` = true\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Control` | :ref:`get_base_control`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`EditorCommandPalette` | :ref:`get_command_palette`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_current_directory`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_current_feature_profile`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_current_path`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`get_edited_scene_root`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`VBoxContainer` | :ref:`get_editor_main_screen`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`EditorPaths` | :ref:`get_editor_paths`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_editor_scale`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`EditorSettings` | :ref:`get_editor_settings`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Theme` | :ref:`get_editor_theme`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SubViewport` | :ref:`get_editor_viewport_2d`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SubViewport` | :ref:`get_editor_viewport_3d`\ (\ idx\: :ref:`int` = 0\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FileSystemDock` | :ref:`get_file_system_dock`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`EditorInspector` | :ref:`get_inspector`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_open_scenes`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_playing_scene`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`EditorFileSystem` | :ref:`get_resource_filesystem`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`EditorResourcePreview` | :ref:`get_resource_previewer`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ScriptEditor` | :ref:`get_script_editor`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_selected_paths`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`EditorSelection` | :ref:`get_selection`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`inspect_object`\ (\ object\: :ref:`Object`, for_property\: :ref:`String` = "", inspector_only\: :ref:`bool` = false\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_multi_window_enabled`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_playing_scene`\ (\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_plugin_enabled`\ (\ plugin\: :ref:`String`\ ) |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Texture2D`\] | :ref:`make_mesh_previews`\ (\ meshes\: :ref:`Array`\[:ref:`Mesh`\], preview_size\: :ref:`int`\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`mark_scene_as_unsaved`\ (\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`open_scene_from_path`\ (\ scene_filepath\: :ref:`String`\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play_current_scene`\ (\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play_custom_scene`\ (\ scene_filepath\: :ref:`String`\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play_main_scene`\ (\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_dialog`\ (\ dialog\: :ref:`Window`, rect\: :ref:`Rect2i` = Rect2i(0, 0, 0, 0)\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_dialog_centered`\ (\ dialog\: :ref:`Window`, minsize\: :ref:`Vector2i` = Vector2i(0, 0)\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_dialog_centered_clamped`\ (\ dialog\: :ref:`Window`, minsize\: :ref:`Vector2i` = Vector2i(0, 0), fallback_ratio\: :ref:`float` = 0.75\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_dialog_centered_ratio`\ (\ dialog\: :ref:`Window`, ratio\: :ref:`float` = 0.8\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_node_selector`\ (\ callback\: :ref:`Callable`, valid_types\: :ref:`Array`\[:ref:`StringName`\] = []\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_property_selector`\ (\ object\: :ref:`Object`, callback\: :ref:`Callable`, type_filter\: :ref:`PackedInt32Array` = PackedInt32Array()\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reload_scene_from_path`\ (\ scene_filepath\: :ref:`String`\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`restart_editor`\ (\ save\: :ref:`bool` = true\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`save_all_scenes`\ (\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save_scene`\ (\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`save_scene_as`\ (\ path\: :ref:`String`, with_preview\: :ref:`bool` = true\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select_file`\ (\ file\: :ref:`String`\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_current_feature_profile`\ (\ profile_name\: :ref:`String`\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_main_screen_editor`\ (\ name\: :ref:`String`\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_plugin_enabled`\ (\ plugin\: :ref:`String`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop_playing_scene`\ (\ ) | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -180,8 +180,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_distraction_free_mode** **(** :ref:`bool` value **)** -- :ref:`bool` **is_distraction_free_mode_enabled** **(** **)** +- |void| **set_distraction_free_mode**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_distraction_free_mode_enabled**\ (\ ) If ``true``, enables distraction-free mode which hides side docks to increase the space available for the main view. @@ -197,8 +197,8 @@ If ``true``, enables distraction-free mode which hides side docks to increase th .. rst-class:: classref-property-setget -- void **set_movie_maker_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_movie_maker_enabled** **(** **)** +- |void| **set_movie_maker_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_movie_maker_enabled**\ (\ ) If ``true``, the Movie Maker mode is enabled in the editor. See :ref:`MovieWriter` for more information. @@ -215,7 +215,7 @@ Method Descriptions .. rst-class:: classref-method -void **edit_node** **(** :ref:`Node` node **)** +|void| **edit_node**\ (\ node\: :ref:`Node`\ ) Edits the given :ref:`Node`. The node will be also selected if it's inside the scene tree. @@ -227,7 +227,7 @@ Edits the given :ref:`Node`. The node will be also selected if it's .. rst-class:: classref-method -void **edit_resource** **(** :ref:`Resource` resource **)** +|void| **edit_resource**\ (\ resource\: :ref:`Resource`\ ) Edits the given :ref:`Resource`. If the resource is a :ref:`Script` you can also edit it with :ref:`edit_script` to specify the line and column position. @@ -239,7 +239,7 @@ Edits the given :ref:`Resource`. If the resource is a :ref:`Scri .. rst-class:: classref-method -void **edit_script** **(** :ref:`Script` script, :ref:`int` line=-1, :ref:`int` column=0, :ref:`bool` grab_focus=true **)** +|void| **edit_script**\ (\ script\: :ref:`Script`, line\: :ref:`int` = -1, column\: :ref:`int` = 0, grab_focus\: :ref:`bool` = true\ ) Edits the given :ref:`Script`. The line and column on which to open the script can also be specified. The script will be open with the user-configured editor for the script's language which may be an external editor. @@ -251,7 +251,7 @@ Edits the given :ref:`Script`. The line and column on which to ope .. rst-class:: classref-method -:ref:`Control` **get_base_control** **(** **)** |const| +:ref:`Control` **get_base_control**\ (\ ) |const| Returns the main container of Godot editor's window. For example, you can use it to retrieve the size of the container and place your controls accordingly. @@ -265,7 +265,7 @@ Returns the main container of Godot editor's window. For example, you can use it .. rst-class:: classref-method -:ref:`EditorCommandPalette` **get_command_palette** **(** **)** |const| +:ref:`EditorCommandPalette` **get_command_palette**\ (\ ) |const| Returns the editor's :ref:`EditorCommandPalette` instance. @@ -279,7 +279,7 @@ Returns the editor's :ref:`EditorCommandPalette` ins .. rst-class:: classref-method -:ref:`String` **get_current_directory** **(** **)** |const| +:ref:`String` **get_current_directory**\ (\ ) |const| Returns the current directory being viewed in the :ref:`FileSystemDock`. If a file is selected, its base directory will be returned using :ref:`String.get_base_dir` instead. @@ -291,7 +291,7 @@ Returns the current directory being viewed in the :ref:`FileSystemDock` **get_current_feature_profile** **(** **)** |const| +:ref:`String` **get_current_feature_profile**\ (\ ) |const| Returns the name of the currently activated feature profile. If the default profile is currently active, an empty string is returned instead. @@ -307,7 +307,7 @@ In order to get a reference to the :ref:`EditorFeatureProfile` **get_current_path** **(** **)** |const| +:ref:`String` **get_current_path**\ (\ ) |const| Returns the current path being viewed in the :ref:`FileSystemDock`. @@ -319,7 +319,7 @@ Returns the current path being viewed in the :ref:`FileSystemDock` **get_edited_scene_root** **(** **)** |const| +:ref:`Node` **get_edited_scene_root**\ (\ ) |const| Returns the edited (current) scene's root :ref:`Node`. @@ -331,7 +331,7 @@ Returns the edited (current) scene's root :ref:`Node`. .. rst-class:: classref-method -:ref:`VBoxContainer` **get_editor_main_screen** **(** **)** |const| +:ref:`VBoxContainer` **get_editor_main_screen**\ (\ ) |const| Returns the editor control responsible for main screen plugins and tools. Use it with plugins that implement :ref:`EditorPlugin._has_main_screen`. @@ -347,7 +347,7 @@ Returns the editor control responsible for main screen plugins and tools. Use it .. rst-class:: classref-method -:ref:`EditorPaths` **get_editor_paths** **(** **)** |const| +:ref:`EditorPaths` **get_editor_paths**\ (\ ) |const| Returns the :ref:`EditorPaths` singleton. @@ -359,7 +359,7 @@ Returns the :ref:`EditorPaths` singleton. .. rst-class:: classref-method -:ref:`float` **get_editor_scale** **(** **)** |const| +:ref:`float` **get_editor_scale**\ (\ ) |const| Returns the actual scale of the editor UI (``1.0`` being 100% scale). This can be used to adjust position and dimensions of the UI added by plugins. @@ -373,7 +373,7 @@ Returns the actual scale of the editor UI (``1.0`` being 100% scale). This can b .. rst-class:: classref-method -:ref:`EditorSettings` **get_editor_settings** **(** **)** |const| +:ref:`EditorSettings` **get_editor_settings**\ (\ ) |const| Returns the editor's :ref:`EditorSettings` instance. @@ -385,7 +385,7 @@ Returns the editor's :ref:`EditorSettings` instance. .. rst-class:: classref-method -:ref:`Theme` **get_editor_theme** **(** **)** |const| +:ref:`Theme` **get_editor_theme**\ (\ ) |const| Returns the editor's :ref:`Theme`. @@ -399,7 +399,7 @@ Returns the editor's :ref:`Theme`. .. rst-class:: classref-method -:ref:`SubViewport` **get_editor_viewport_2d** **(** **)** |const| +:ref:`SubViewport` **get_editor_viewport_2d**\ (\ ) |const| Returns the 2D editor :ref:`SubViewport`. It does not have a camera. Instead, the view transforms are done directly and can be accessed with :ref:`Viewport.global_canvas_transform`. @@ -411,7 +411,7 @@ Returns the 2D editor :ref:`SubViewport`. It does not have a .. rst-class:: classref-method -:ref:`SubViewport` **get_editor_viewport_3d** **(** :ref:`int` idx=0 **)** |const| +:ref:`SubViewport` **get_editor_viewport_3d**\ (\ idx\: :ref:`int` = 0\ ) |const| Returns the specified 3D editor :ref:`SubViewport`, from ``0`` to ``3``. The viewport can be used to access the active editor cameras with :ref:`Viewport.get_camera_3d`. @@ -423,7 +423,7 @@ Returns the specified 3D editor :ref:`SubViewport`, from ``0` .. rst-class:: classref-method -:ref:`FileSystemDock` **get_file_system_dock** **(** **)** |const| +:ref:`FileSystemDock` **get_file_system_dock**\ (\ ) |const| Returns the editor's :ref:`FileSystemDock` instance. @@ -437,7 +437,7 @@ Returns the editor's :ref:`FileSystemDock` instance. .. rst-class:: classref-method -:ref:`EditorInspector` **get_inspector** **(** **)** |const| +:ref:`EditorInspector` **get_inspector**\ (\ ) |const| Returns the editor's :ref:`EditorInspector` instance. @@ -451,7 +451,7 @@ Returns the editor's :ref:`EditorInspector` instance. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_open_scenes** **(** **)** |const| +:ref:`PackedStringArray` **get_open_scenes**\ (\ ) |const| Returns an :ref:`Array` with the file paths of the currently opened scenes. @@ -463,7 +463,7 @@ Returns an :ref:`Array` with the file paths of the currently opened .. rst-class:: classref-method -:ref:`String` **get_playing_scene** **(** **)** |const| +:ref:`String` **get_playing_scene**\ (\ ) |const| Returns the name of the scene that is being played. If no scene is currently being played, returns an empty string. @@ -475,7 +475,7 @@ Returns the name of the scene that is being played. If no scene is currently bei .. rst-class:: classref-method -:ref:`EditorFileSystem` **get_resource_filesystem** **(** **)** |const| +:ref:`EditorFileSystem` **get_resource_filesystem**\ (\ ) |const| Returns the editor's :ref:`EditorFileSystem` instance. @@ -487,7 +487,7 @@ Returns the editor's :ref:`EditorFileSystem` instance. .. rst-class:: classref-method -:ref:`EditorResourcePreview` **get_resource_previewer** **(** **)** |const| +:ref:`EditorResourcePreview` **get_resource_previewer**\ (\ ) |const| Returns the editor's :ref:`EditorResourcePreview` instance. @@ -499,7 +499,7 @@ Returns the editor's :ref:`EditorResourcePreview` i .. rst-class:: classref-method -:ref:`ScriptEditor` **get_script_editor** **(** **)** |const| +:ref:`ScriptEditor` **get_script_editor**\ (\ ) |const| Returns the editor's :ref:`ScriptEditor` instance. @@ -513,7 +513,7 @@ Returns the editor's :ref:`ScriptEditor` instance. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_selected_paths** **(** **)** |const| +:ref:`PackedStringArray` **get_selected_paths**\ (\ ) |const| Returns an array containing the paths of the currently selected files (and directories) in the :ref:`FileSystemDock`. @@ -525,7 +525,7 @@ Returns an array containing the paths of the currently selected files (and direc .. rst-class:: classref-method -:ref:`EditorSelection` **get_selection** **(** **)** |const| +:ref:`EditorSelection` **get_selection**\ (\ ) |const| Returns the editor's :ref:`EditorSelection` instance. @@ -537,7 +537,7 @@ Returns the editor's :ref:`EditorSelection` instance. .. rst-class:: classref-method -void **inspect_object** **(** :ref:`Object` object, :ref:`String` for_property="", :ref:`bool` inspector_only=false **)** +|void| **inspect_object**\ (\ object\: :ref:`Object`, for_property\: :ref:`String` = "", inspector_only\: :ref:`bool` = false\ ) Shows the given property on the given ``object`` in the editor's Inspector dock. If ``inspector_only`` is ``true``, plugins will not attempt to edit ``object``. @@ -549,7 +549,7 @@ Shows the given property on the given ``object`` in the editor's Inspector dock. .. rst-class:: classref-method -:ref:`bool` **is_multi_window_enabled** **(** **)** |const| +:ref:`bool` **is_multi_window_enabled**\ (\ ) |const| Returns ``true`` if multiple window support is enabled in the editor. Multiple window support is enabled if *all* of these statements are true: @@ -567,7 +567,7 @@ Returns ``true`` if multiple window support is enabled in the editor. Multiple w .. rst-class:: classref-method -:ref:`bool` **is_playing_scene** **(** **)** |const| +:ref:`bool` **is_playing_scene**\ (\ ) |const| Returns ``true`` if a scene is currently being played, ``false`` otherwise. Paused scenes are considered as being played. @@ -579,7 +579,7 @@ Returns ``true`` if a scene is currently being played, ``false`` otherwise. Paus .. rst-class:: classref-method -:ref:`bool` **is_plugin_enabled** **(** :ref:`String` plugin **)** |const| +:ref:`bool` **is_plugin_enabled**\ (\ plugin\: :ref:`String`\ ) |const| Returns ``true`` if the specified ``plugin`` is enabled. The plugin name is the same as its directory name. @@ -591,7 +591,7 @@ Returns ``true`` if the specified ``plugin`` is enabled. The plugin name is the .. rst-class:: classref-method -:ref:`Texture2D[]` **make_mesh_previews** **(** :ref:`Mesh[]` meshes, :ref:`int` preview_size **)** +:ref:`Array`\[:ref:`Texture2D`\] **make_mesh_previews**\ (\ meshes\: :ref:`Array`\[:ref:`Mesh`\], preview_size\: :ref:`int`\ ) Returns mesh previews rendered at the given size as an :ref:`Array` of :ref:`Texture2D`\ s. @@ -603,7 +603,7 @@ Returns mesh previews rendered at the given size as an :ref:`Array` .. rst-class:: classref-method -void **mark_scene_as_unsaved** **(** **)** +|void| **mark_scene_as_unsaved**\ (\ ) Marks the current scene tab as unsaved. @@ -615,7 +615,7 @@ Marks the current scene tab as unsaved. .. rst-class:: classref-method -void **open_scene_from_path** **(** :ref:`String` scene_filepath **)** +|void| **open_scene_from_path**\ (\ scene_filepath\: :ref:`String`\ ) Opens the scene at the given path. @@ -627,7 +627,7 @@ Opens the scene at the given path. .. rst-class:: classref-method -void **play_current_scene** **(** **)** +|void| **play_current_scene**\ (\ ) Plays the currently active scene. @@ -639,7 +639,7 @@ Plays the currently active scene. .. rst-class:: classref-method -void **play_custom_scene** **(** :ref:`String` scene_filepath **)** +|void| **play_custom_scene**\ (\ scene_filepath\: :ref:`String`\ ) Plays the scene specified by its filepath. @@ -651,7 +651,7 @@ Plays the scene specified by its filepath. .. rst-class:: classref-method -void **play_main_scene** **(** **)** +|void| **play_main_scene**\ (\ ) Plays the main scene. @@ -663,7 +663,7 @@ Plays the main scene. .. rst-class:: classref-method -void **popup_dialog** **(** :ref:`Window` dialog, :ref:`Rect2i` rect=Rect2i(0, 0, 0, 0) **)** +|void| **popup_dialog**\ (\ dialog\: :ref:`Window`, rect\: :ref:`Rect2i` = Rect2i(0, 0, 0, 0)\ ) Pops up the ``dialog`` in the editor UI with :ref:`Window.popup_exclusive`. The dialog must have no current parent, otherwise the method fails. @@ -677,7 +677,7 @@ See also :ref:`Window.set_unparent_when_invisible` dialog, :ref:`Vector2i` minsize=Vector2i(0, 0) **)** +|void| **popup_dialog_centered**\ (\ dialog\: :ref:`Window`, minsize\: :ref:`Vector2i` = Vector2i(0, 0)\ ) Pops up the ``dialog`` in the editor UI with :ref:`Window.popup_exclusive_centered`. The dialog must have no current parent, otherwise the method fails. @@ -691,7 +691,7 @@ See also :ref:`Window.set_unparent_when_invisible` dialog, :ref:`Vector2i` minsize=Vector2i(0, 0), :ref:`float` fallback_ratio=0.75 **)** +|void| **popup_dialog_centered_clamped**\ (\ dialog\: :ref:`Window`, minsize\: :ref:`Vector2i` = Vector2i(0, 0), fallback_ratio\: :ref:`float` = 0.75\ ) Pops up the ``dialog`` in the editor UI with :ref:`Window.popup_exclusive_centered_clamped`. The dialog must have no current parent, otherwise the method fails. @@ -705,7 +705,7 @@ See also :ref:`Window.set_unparent_when_invisible` dialog, :ref:`float` ratio=0.8 **)** +|void| **popup_dialog_centered_ratio**\ (\ dialog\: :ref:`Window`, ratio\: :ref:`float` = 0.8\ ) Pops up the ``dialog`` in the editor UI with :ref:`Window.popup_exclusive_centered_ratio`. The dialog must have no current parent, otherwise the method fails. @@ -719,7 +719,7 @@ See also :ref:`Window.set_unparent_when_invisible` callback, :ref:`StringName[]` valid_types=[] **)** +|void| **popup_node_selector**\ (\ callback\: :ref:`Callable`, valid_types\: :ref:`Array`\[:ref:`StringName`\] = []\ ) Pops up an editor dialog for selecting a :ref:`Node` from the edited scene. The ``callback`` must take a single argument of type :ref:`NodePath`. It is called on the selected :ref:`NodePath` or the empty path ``^""`` if the dialog is canceled. If ``valid_types`` is provided, the dialog will only show Nodes that match one of the listed Node types. @@ -745,7 +745,7 @@ Pops up an editor dialog for selecting a :ref:`Node` from the edited .. rst-class:: classref-method -void **popup_property_selector** **(** :ref:`Object` object, :ref:`Callable` callback, :ref:`PackedInt32Array` type_filter=PackedInt32Array() **)** +|void| **popup_property_selector**\ (\ object\: :ref:`Object`, callback\: :ref:`Callable`, type_filter\: :ref:`PackedInt32Array` = PackedInt32Array()\ ) Pops up an editor dialog for selecting properties from ``object``. The ``callback`` must take a single argument of type :ref:`NodePath`. It is called on the selected property path (see :ref:`NodePath.get_as_property_path`) or the empty path ``^""`` if the dialog is canceled. If ``type_filter`` is provided, the dialog will only show properties that match one of the listed :ref:`Variant.Type` values. @@ -771,7 +771,7 @@ Pops up an editor dialog for selecting properties from ``object``. The ``callbac .. rst-class:: classref-method -void **reload_scene_from_path** **(** :ref:`String` scene_filepath **)** +|void| **reload_scene_from_path**\ (\ scene_filepath\: :ref:`String`\ ) Reloads the scene at the given path. @@ -783,7 +783,7 @@ Reloads the scene at the given path. .. rst-class:: classref-method -void **restart_editor** **(** :ref:`bool` save=true **)** +|void| **restart_editor**\ (\ save\: :ref:`bool` = true\ ) Restarts the editor. This closes the editor and then opens the same project. If ``save`` is ``true``, the project will be saved before restarting. @@ -795,7 +795,7 @@ Restarts the editor. This closes the editor and then opens the same project. If .. rst-class:: classref-method -void **save_all_scenes** **(** **)** +|void| **save_all_scenes**\ (\ ) Saves all opened scenes in the editor. @@ -807,7 +807,7 @@ Saves all opened scenes in the editor. .. rst-class:: classref-method -:ref:`Error` **save_scene** **(** **)** +:ref:`Error` **save_scene**\ (\ ) Saves the currently active scene. Returns either :ref:`@GlobalScope.OK` or :ref:`@GlobalScope.ERR_CANT_CREATE`. @@ -819,7 +819,7 @@ Saves the currently active scene. Returns either :ref:`@GlobalScope.OK` path, :ref:`bool` with_preview=true **)** +|void| **save_scene_as**\ (\ path\: :ref:`String`, with_preview\: :ref:`bool` = true\ ) Saves the currently active scene as a file at ``path``. @@ -831,7 +831,7 @@ Saves the currently active scene as a file at ``path``. .. rst-class:: classref-method -void **select_file** **(** :ref:`String` file **)** +|void| **select_file**\ (\ file\: :ref:`String`\ ) Selects the file, with the path provided by ``file``, in the FileSystem dock. @@ -843,7 +843,7 @@ Selects the file, with the path provided by ``file``, in the FileSystem dock. .. rst-class:: classref-method -void **set_current_feature_profile** **(** :ref:`String` profile_name **)** +|void| **set_current_feature_profile**\ (\ profile_name\: :ref:`String`\ ) Selects and activates the specified feature profile with the given ``profile_name``. Set ``profile_name`` to an empty string to reset to the default feature profile. @@ -859,7 +859,7 @@ A feature profile can be created programmatically using the :ref:`EditorFeatureP .. rst-class:: classref-method -void **set_main_screen_editor** **(** :ref:`String` name **)** +|void| **set_main_screen_editor**\ (\ name\: :ref:`String`\ ) Sets the editor's current main screen to the one specified in ``name``. ``name`` must match the title of the tab in question exactly (e.g. ``2D``, ``3D``, ``Script``, or ``AssetLib`` for default tabs). @@ -871,7 +871,7 @@ Sets the editor's current main screen to the one specified in ``name``. ``name`` .. rst-class:: classref-method -void **set_plugin_enabled** **(** :ref:`String` plugin, :ref:`bool` enabled **)** +|void| **set_plugin_enabled**\ (\ plugin\: :ref:`String`, enabled\: :ref:`bool`\ ) Sets the enabled status of a plugin. The plugin name is the same as its directory name. @@ -883,7 +883,7 @@ Sets the enabled status of a plugin. The plugin name is the same as its director .. rst-class:: classref-method -void **stop_playing_scene** **(** **)** +|void| **stop_playing_scene**\ (\ ) Stops the scene that is currently playing. @@ -894,3 +894,4 @@ Stops the scene that is currently playing. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editornode3dgizmo.rst b/classes/class_editornode3dgizmo.rst index 42280cd0d77..fcc1b8c41b0 100644 --- a/classes/class_editornode3dgizmo.rst +++ b/classes/class_editornode3dgizmo.rst @@ -29,57 +29,57 @@ Methods .. table:: :widths: auto - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_begin_handle_action` **(** :ref:`int` id, :ref:`bool` secondary **)** |virtual| | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_commit_handle` **(** :ref:`int` id, :ref:`bool` secondary, :ref:`Variant` restore, :ref:`bool` cancel **)** |virtual| | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_commit_subgizmos` **(** :ref:`PackedInt32Array` ids, :ref:`Transform3D[]` restores, :ref:`bool` cancel **)** |virtual| | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_handle_name` **(** :ref:`int` id, :ref:`bool` secondary **)** |virtual| |const| | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_handle_value` **(** :ref:`int` id, :ref:`bool` secondary **)** |virtual| |const| | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`_get_subgizmo_transform` **(** :ref:`int` id **)** |virtual| |const| | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_handle_highlighted` **(** :ref:`int` id, :ref:`bool` secondary **)** |virtual| |const| | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_redraw` **(** **)** |virtual| | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_handle` **(** :ref:`int` id, :ref:`bool` secondary, :ref:`Camera3D` camera, :ref:`Vector2` point **)** |virtual| | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_subgizmo_transform` **(** :ref:`int` id, :ref:`Transform3D` transform **)** |virtual| | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_subgizmos_intersect_frustum` **(** :ref:`Camera3D` camera, :ref:`Plane[]` frustum **)** |virtual| |const| | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_subgizmos_intersect_ray` **(** :ref:`Camera3D` camera, :ref:`Vector2` point **)** |virtual| |const| | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_collision_segments` **(** :ref:`PackedVector3Array` segments **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_handles` **(** :ref:`PackedVector3Array` handles, :ref:`Material` material, :ref:`PackedInt32Array` ids, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_lines` **(** :ref:`PackedVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_mesh` **(** :ref:`Mesh` mesh, :ref:`Material` material=null, :ref:`Transform3D` transform=Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), :ref:`SkinReference` skeleton=null **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`float` default_scale=1, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node3D` | :ref:`get_node_3d` **(** **)** |const| | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorNode3DGizmoPlugin` | :ref:`get_plugin` **(** **)** |const| | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_subgizmo_selection` **(** **)** |const| | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_subgizmo_selected` **(** :ref:`int` id **)** |const| | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_hidden` **(** :ref:`bool` hidden **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_node_3d` **(** :ref:`Node` node **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_begin_handle_action`\ (\ id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_commit_handle`\ (\ id\: :ref:`int`, secondary\: :ref:`bool`, restore\: :ref:`Variant`, cancel\: :ref:`bool`\ ) |virtual| | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_commit_subgizmos`\ (\ ids\: :ref:`PackedInt32Array`, restores\: :ref:`Array`\[:ref:`Transform3D`\], cancel\: :ref:`bool`\ ) |virtual| | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_handle_name`\ (\ id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_handle_value`\ (\ id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`_get_subgizmo_transform`\ (\ id\: :ref:`int`\ ) |virtual| |const| | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_handle_highlighted`\ (\ id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_redraw`\ (\ ) |virtual| | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_handle`\ (\ id\: :ref:`int`, secondary\: :ref:`bool`, camera\: :ref:`Camera3D`, point\: :ref:`Vector2`\ ) |virtual| | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_subgizmo_transform`\ (\ id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_subgizmos_intersect_frustum`\ (\ camera\: :ref:`Camera3D`, frustum\: :ref:`Array`\[:ref:`Plane`\]\ ) |virtual| |const| | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_subgizmos_intersect_ray`\ (\ camera\: :ref:`Camera3D`, point\: :ref:`Vector2`\ ) |virtual| |const| | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_collision_segments`\ (\ segments\: :ref:`PackedVector3Array`\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_collision_triangles`\ (\ triangles\: :ref:`TriangleMesh`\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_handles`\ (\ handles\: :ref:`PackedVector3Array`, material\: :ref:`Material`, ids\: :ref:`PackedInt32Array`, billboard\: :ref:`bool` = false, secondary\: :ref:`bool` = false\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_lines`\ (\ lines\: :ref:`PackedVector3Array`, material\: :ref:`Material`, billboard\: :ref:`bool` = false, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_mesh`\ (\ mesh\: :ref:`Mesh`, material\: :ref:`Material` = null, transform\: :ref:`Transform3D` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), skeleton\: :ref:`SkinReference` = null\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_unscaled_billboard`\ (\ material\: :ref:`Material`, default_scale\: :ref:`float` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node3D` | :ref:`get_node_3d`\ (\ ) |const| | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`EditorNode3DGizmoPlugin` | :ref:`get_plugin`\ (\ ) |const| | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_subgizmo_selection`\ (\ ) |const| | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_subgizmo_selected`\ (\ id\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_hidden`\ (\ hidden\: :ref:`bool`\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_node_3d`\ (\ node\: :ref:`Node`\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -94,7 +94,7 @@ Method Descriptions .. rst-class:: classref-method -void **_begin_handle_action** **(** :ref:`int` id, :ref:`bool` secondary **)** |virtual| +|void| **_begin_handle_action**\ (\ id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -108,7 +108,7 @@ void **_begin_handle_action** **(** :ref:`int` id, :ref:`bool` id, :ref:`bool` secondary, :ref:`Variant` restore, :ref:`bool` cancel **)** |virtual| +|void| **_commit_handle**\ (\ id\: :ref:`int`, secondary\: :ref:`bool`, restore\: :ref:`Variant`, cancel\: :ref:`bool`\ ) |virtual| Override this method to commit a handle being edited (handles must have been previously added by :ref:`add_handles`). This usually means creating an :ref:`UndoRedo` action for the change, using the current handle value as "do" and the ``restore`` argument as "undo". @@ -124,7 +124,7 @@ The ``secondary`` argument is ``true`` when the committed handle is secondary (s .. rst-class:: classref-method -void **_commit_subgizmos** **(** :ref:`PackedInt32Array` ids, :ref:`Transform3D[]` restores, :ref:`bool` cancel **)** |virtual| +|void| **_commit_subgizmos**\ (\ ids\: :ref:`PackedInt32Array`, restores\: :ref:`Array`\[:ref:`Transform3D`\], cancel\: :ref:`bool`\ ) |virtual| Override this method to commit a group of subgizmos being edited (see :ref:`_subgizmos_intersect_ray` and :ref:`_subgizmos_intersect_frustum`). This usually means creating an :ref:`UndoRedo` action for the change, using the current transforms as "do" and the ``restores`` transforms as "undo". @@ -138,7 +138,7 @@ If the ``cancel`` argument is ``true``, the ``restores`` transforms should be di .. rst-class:: classref-method -:ref:`String` **_get_handle_name** **(** :ref:`int` id, :ref:`bool` secondary **)** |virtual| |const| +:ref:`String` **_get_handle_name**\ (\ id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| Override this method to return the name of an edited handle (handles must have been previously added by :ref:`add_handles`). Handles can be named for reference to the user when editing. @@ -152,7 +152,7 @@ The ``secondary`` argument is ``true`` when the requested handle is secondary (s .. rst-class:: classref-method -:ref:`Variant` **_get_handle_value** **(** :ref:`int` id, :ref:`bool` secondary **)** |virtual| |const| +:ref:`Variant` **_get_handle_value**\ (\ id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| Override this method to return the current value of a handle. This value will be requested at the start of an edit and used as the ``restore`` argument in :ref:`_commit_handle`. @@ -166,7 +166,7 @@ The ``secondary`` argument is ``true`` when the requested handle is secondary (s .. rst-class:: classref-method -:ref:`Transform3D` **_get_subgizmo_transform** **(** :ref:`int` id **)** |virtual| |const| +:ref:`Transform3D` **_get_subgizmo_transform**\ (\ id\: :ref:`int`\ ) |virtual| |const| Override this method to return the current transform of a subgizmo. This transform will be requested at the start of an edit and used as the ``restore`` argument in :ref:`_commit_subgizmos`. @@ -178,7 +178,7 @@ Override this method to return the current transform of a subgizmo. This transfo .. rst-class:: classref-method -:ref:`bool` **_is_handle_highlighted** **(** :ref:`int` id, :ref:`bool` secondary **)** |virtual| |const| +:ref:`bool` **_is_handle_highlighted**\ (\ id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| Override this method to return ``true`` whenever the given handle should be highlighted in the editor. @@ -192,7 +192,7 @@ The ``secondary`` argument is ``true`` when the requested handle is secondary (s .. rst-class:: classref-method -void **_redraw** **(** **)** |virtual| +|void| **_redraw**\ (\ ) |virtual| Override this method to add all the gizmo elements whenever a gizmo update is requested. It's common to call :ref:`clear` at the beginning of this method and then add visual elements depending on the node's properties. @@ -204,7 +204,7 @@ Override this method to add all the gizmo elements whenever a gizmo update is re .. rst-class:: classref-method -void **_set_handle** **(** :ref:`int` id, :ref:`bool` secondary, :ref:`Camera3D` camera, :ref:`Vector2` point **)** |virtual| +|void| **_set_handle**\ (\ id\: :ref:`int`, secondary\: :ref:`bool`, camera\: :ref:`Camera3D`, point\: :ref:`Vector2`\ ) |virtual| Override this method to update the node properties when the user drags a gizmo handle (previously added with :ref:`add_handles`). The provided ``point`` is the mouse position in screen coordinates and the ``camera`` can be used to convert it to raycasts. @@ -218,7 +218,7 @@ The ``secondary`` argument is ``true`` when the edited handle is secondary (see .. rst-class:: classref-method -void **_set_subgizmo_transform** **(** :ref:`int` id, :ref:`Transform3D` transform **)** |virtual| +|void| **_set_subgizmo_transform**\ (\ id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| Override this method to update the node properties during subgizmo editing (see :ref:`_subgizmos_intersect_ray` and :ref:`_subgizmos_intersect_frustum`). The ``transform`` is given in the :ref:`Node3D`'s local coordinate system. @@ -230,7 +230,7 @@ Override this method to update the node properties during subgizmo editing (see .. rst-class:: classref-method -:ref:`PackedInt32Array` **_subgizmos_intersect_frustum** **(** :ref:`Camera3D` camera, :ref:`Plane[]` frustum **)** |virtual| |const| +:ref:`PackedInt32Array` **_subgizmos_intersect_frustum**\ (\ camera\: :ref:`Camera3D`, frustum\: :ref:`Array`\[:ref:`Plane`\]\ ) |virtual| |const| Override this method to allow selecting subgizmos using mouse drag box selection. Given a ``camera`` and a ``frustum``, this method should return which subgizmos are contained within the frustum. The ``frustum`` argument consists of an array with all the :ref:`Plane`\ s that make up the selection frustum. The returned value should contain a list of unique subgizmo identifiers, which can have any non-negative value and will be used in other virtual methods like :ref:`_get_subgizmo_transform` or :ref:`_commit_subgizmos`. @@ -242,7 +242,7 @@ Override this method to allow selecting subgizmos using mouse drag box selection .. rst-class:: classref-method -:ref:`int` **_subgizmos_intersect_ray** **(** :ref:`Camera3D` camera, :ref:`Vector2` point **)** |virtual| |const| +:ref:`int` **_subgizmos_intersect_ray**\ (\ camera\: :ref:`Camera3D`, point\: :ref:`Vector2`\ ) |virtual| |const| Override this method to allow selecting subgizmos using mouse clicks. Given a ``camera`` and a ``point`` in screen coordinates, this method should return which subgizmo should be selected. The returned value should be a unique subgizmo identifier, which can have any non-negative value and will be used in other virtual methods like :ref:`_get_subgizmo_transform` or :ref:`_commit_subgizmos`. @@ -254,7 +254,7 @@ Override this method to allow selecting subgizmos using mouse clicks. Given a `` .. rst-class:: classref-method -void **add_collision_segments** **(** :ref:`PackedVector3Array` segments **)** +|void| **add_collision_segments**\ (\ segments\: :ref:`PackedVector3Array`\ ) Adds the specified ``segments`` to the gizmo's collision shape for picking. Call this method during :ref:`_redraw`. @@ -266,7 +266,7 @@ Adds the specified ``segments`` to the gizmo's collision shape for picking. Call .. rst-class:: classref-method -void **add_collision_triangles** **(** :ref:`TriangleMesh` triangles **)** +|void| **add_collision_triangles**\ (\ triangles\: :ref:`TriangleMesh`\ ) Adds collision triangles to the gizmo for picking. A :ref:`TriangleMesh` can be generated from a regular :ref:`Mesh` too. Call this method during :ref:`_redraw`. @@ -278,7 +278,7 @@ Adds collision triangles to the gizmo for picking. A :ref:`TriangleMesh` handles, :ref:`Material` material, :ref:`PackedInt32Array` ids, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** +|void| **add_handles**\ (\ handles\: :ref:`PackedVector3Array`, material\: :ref:`Material`, ids\: :ref:`PackedInt32Array`, billboard\: :ref:`bool` = false, secondary\: :ref:`bool` = false\ ) Adds a list of handles (points) which can be used to edit the properties of the gizmo's :ref:`Node3D`. The ``ids`` argument can be used to specify a custom identifier for each handle, if an empty array is passed, the ids will be assigned automatically from the ``handles`` argument order. @@ -294,7 +294,7 @@ There are virtual methods which will be called upon editing of these handles. Ca .. rst-class:: classref-method -void **add_lines** **(** :ref:`PackedVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** +|void| **add_lines**\ (\ lines\: :ref:`PackedVector3Array`, material\: :ref:`Material`, billboard\: :ref:`bool` = false, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this method during :ref:`_redraw`. @@ -306,7 +306,7 @@ Adds lines to the gizmo (as sets of 2 points), with a given material. The lines .. rst-class:: classref-method -void **add_mesh** **(** :ref:`Mesh` mesh, :ref:`Material` material=null, :ref:`Transform3D` transform=Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), :ref:`SkinReference` skeleton=null **)** +|void| **add_mesh**\ (\ mesh\: :ref:`Mesh`, material\: :ref:`Material` = null, transform\: :ref:`Transform3D` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), skeleton\: :ref:`SkinReference` = null\ ) Adds a mesh to the gizmo with the specified ``material``, local ``transform`` and ``skeleton``. Call this method during :ref:`_redraw`. @@ -318,7 +318,7 @@ Adds a mesh to the gizmo with the specified ``material``, local ``transform`` an .. rst-class:: classref-method -void **add_unscaled_billboard** **(** :ref:`Material` material, :ref:`float` default_scale=1, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** +|void| **add_unscaled_billboard**\ (\ material\: :ref:`Material`, default_scale\: :ref:`float` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) Adds an unscaled billboard for visualization and selection. Call this method during :ref:`_redraw`. @@ -330,7 +330,7 @@ Adds an unscaled billboard for visualization and selection. Call this method dur .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Removes everything in the gizmo including meshes, collisions and handles. @@ -342,7 +342,7 @@ Removes everything in the gizmo including meshes, collisions and handles. .. rst-class:: classref-method -:ref:`Node3D` **get_node_3d** **(** **)** |const| +:ref:`Node3D` **get_node_3d**\ (\ ) |const| Returns the :ref:`Node3D` node associated with this gizmo. @@ -354,7 +354,7 @@ Returns the :ref:`Node3D` node associated with this gizmo. .. rst-class:: classref-method -:ref:`EditorNode3DGizmoPlugin` **get_plugin** **(** **)** |const| +:ref:`EditorNode3DGizmoPlugin` **get_plugin**\ (\ ) |const| Returns the :ref:`EditorNode3DGizmoPlugin` that owns this gizmo. It's useful to retrieve materials using :ref:`EditorNode3DGizmoPlugin.get_material`. @@ -366,7 +366,7 @@ Returns the :ref:`EditorNode3DGizmoPlugin` that o .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_subgizmo_selection** **(** **)** |const| +:ref:`PackedInt32Array` **get_subgizmo_selection**\ (\ ) |const| Returns a list of the currently selected subgizmos. Can be used to highlight selected elements during :ref:`_redraw`. @@ -378,7 +378,7 @@ Returns a list of the currently selected subgizmos. Can be used to highlight sel .. rst-class:: classref-method -:ref:`bool` **is_subgizmo_selected** **(** :ref:`int` id **)** |const| +:ref:`bool` **is_subgizmo_selected**\ (\ id\: :ref:`int`\ ) |const| Returns ``true`` if the given subgizmo is currently selected. Can be used to highlight selected elements during :ref:`_redraw`. @@ -390,7 +390,7 @@ Returns ``true`` if the given subgizmo is currently selected. Can be used to hig .. rst-class:: classref-method -void **set_hidden** **(** :ref:`bool` hidden **)** +|void| **set_hidden**\ (\ hidden\: :ref:`bool`\ ) Sets the gizmo's hidden state. If ``true``, the gizmo will be hidden. If ``false``, it will be shown. @@ -402,7 +402,7 @@ Sets the gizmo's hidden state. If ``true``, the gizmo will be hidden. If ``false .. rst-class:: classref-method -void **set_node_3d** **(** :ref:`Node` node **)** +|void| **set_node_3d**\ (\ node\: :ref:`Node`\ ) Sets the reference :ref:`Node3D` node for the gizmo. ``node`` must inherit from :ref:`Node3D`. @@ -413,3 +413,4 @@ Sets the reference :ref:`Node3D` node for the gizmo. ``node`` must .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editornode3dgizmoplugin.rst b/classes/class_editornode3dgizmoplugin.rst index 80c802252b0..1dc15c01563 100644 --- a/classes/class_editornode3dgizmoplugin.rst +++ b/classes/class_editornode3dgizmoplugin.rst @@ -38,53 +38,53 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_begin_handle_action` **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`int` handle_id, :ref:`bool` secondary **)** |virtual| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_can_be_hidden` **(** **)** |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_commit_handle` **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`int` handle_id, :ref:`bool` secondary, :ref:`Variant` restore, :ref:`bool` cancel **)** |virtual| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_commit_subgizmos` **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`PackedInt32Array` ids, :ref:`Transform3D[]` restores, :ref:`bool` cancel **)** |virtual| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorNode3DGizmo` | :ref:`_create_gizmo` **(** :ref:`Node3D` for_node_3d **)** |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_gizmo_name` **(** **)** |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_handle_name` **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`int` handle_id, :ref:`bool` secondary **)** |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_handle_value` **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`int` handle_id, :ref:`bool` secondary **)** |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_priority` **(** **)** |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`_get_subgizmo_transform` **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`int` subgizmo_id **)** |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_gizmo` **(** :ref:`Node3D` for_node_3d **)** |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_handle_highlighted` **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`int` handle_id, :ref:`bool` secondary **)** |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_selectable_when_hidden` **(** **)** |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_redraw` **(** :ref:`EditorNode3DGizmo` gizmo **)** |virtual| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_handle` **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`int` handle_id, :ref:`bool` secondary, :ref:`Camera3D` camera, :ref:`Vector2` screen_pos **)** |virtual| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_subgizmo_transform` **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`int` subgizmo_id, :ref:`Transform3D` transform **)** |virtual| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_subgizmos_intersect_frustum` **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`Camera3D` camera, :ref:`Plane[]` frustum_planes **)** |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_subgizmos_intersect_ray` **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`Camera3D` camera, :ref:`Vector2` screen_pos **)** |virtual| |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_material` **(** :ref:`String` name, :ref:`StandardMaterial3D` material **)** | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_handle_material` **(** :ref:`String` name, :ref:`bool` billboard=false, :ref:`Texture2D` texture=null **)** | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_icon_material` **(** :ref:`String` name, :ref:`Texture2D` texture, :ref:`bool` on_top=false, :ref:`Color` color=Color(1, 1, 1, 1) **)** | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_material` **(** :ref:`String` name, :ref:`Color` color, :ref:`bool` billboard=false, :ref:`bool` on_top=false, :ref:`bool` use_vertex_color=false **)** | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StandardMaterial3D` | :ref:`get_material` **(** :ref:`String` name, :ref:`EditorNode3DGizmo` gizmo=null **)** | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_begin_handle_action`\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_can_be_hidden`\ (\ ) |virtual| |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_commit_handle`\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`, restore\: :ref:`Variant`, cancel\: :ref:`bool`\ ) |virtual| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_commit_subgizmos`\ (\ gizmo\: :ref:`EditorNode3DGizmo`, ids\: :ref:`PackedInt32Array`, restores\: :ref:`Array`\[:ref:`Transform3D`\], cancel\: :ref:`bool`\ ) |virtual| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`EditorNode3DGizmo` | :ref:`_create_gizmo`\ (\ for_node_3d\: :ref:`Node3D`\ ) |virtual| |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_gizmo_name`\ (\ ) |virtual| |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_handle_name`\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_handle_value`\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_priority`\ (\ ) |virtual| |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`_get_subgizmo_transform`\ (\ gizmo\: :ref:`EditorNode3DGizmo`, subgizmo_id\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_gizmo`\ (\ for_node_3d\: :ref:`Node3D`\ ) |virtual| |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_handle_highlighted`\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_selectable_when_hidden`\ (\ ) |virtual| |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_redraw`\ (\ gizmo\: :ref:`EditorNode3DGizmo`\ ) |virtual| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_handle`\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`, camera\: :ref:`Camera3D`, screen_pos\: :ref:`Vector2`\ ) |virtual| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_subgizmo_transform`\ (\ gizmo\: :ref:`EditorNode3DGizmo`, subgizmo_id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_subgizmos_intersect_frustum`\ (\ gizmo\: :ref:`EditorNode3DGizmo`, camera\: :ref:`Camera3D`, frustum_planes\: :ref:`Array`\[:ref:`Plane`\]\ ) |virtual| |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_subgizmos_intersect_ray`\ (\ gizmo\: :ref:`EditorNode3DGizmo`, camera\: :ref:`Camera3D`, screen_pos\: :ref:`Vector2`\ ) |virtual| |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_material`\ (\ name\: :ref:`String`, material\: :ref:`StandardMaterial3D`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_handle_material`\ (\ name\: :ref:`String`, billboard\: :ref:`bool` = false, texture\: :ref:`Texture2D` = null\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_icon_material`\ (\ name\: :ref:`String`, texture\: :ref:`Texture2D`, on_top\: :ref:`bool` = false, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_material`\ (\ name\: :ref:`String`, color\: :ref:`Color`, billboard\: :ref:`bool` = false, on_top\: :ref:`bool` = false, use_vertex_color\: :ref:`bool` = false\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StandardMaterial3D` | :ref:`get_material`\ (\ name\: :ref:`String`, gizmo\: :ref:`EditorNode3DGizmo` = null\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -99,7 +99,7 @@ Method Descriptions .. rst-class:: classref-method -void **_begin_handle_action** **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`int` handle_id, :ref:`bool` secondary **)** |virtual| +|void| **_begin_handle_action**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -113,7 +113,7 @@ void **_begin_handle_action** **(** :ref:`EditorNode3DGizmo` **_can_be_hidden** **(** **)** |virtual| |const| +:ref:`bool` **_can_be_hidden**\ (\ ) |virtual| |const| Override this method to define whether the gizmos handled by this plugin can be hidden or not. Returns ``true`` if not overridden. @@ -125,7 +125,7 @@ Override this method to define whether the gizmos handled by this plugin can be .. rst-class:: classref-method -void **_commit_handle** **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`int` handle_id, :ref:`bool` secondary, :ref:`Variant` restore, :ref:`bool` cancel **)** |virtual| +|void| **_commit_handle**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`, restore\: :ref:`Variant`, cancel\: :ref:`bool`\ ) |virtual| Override this method to commit a handle being edited (handles must have been previously added by :ref:`EditorNode3DGizmo.add_handles` during :ref:`_redraw`). This usually means creating an :ref:`UndoRedo` action for the change, using the current handle value as "do" and the ``restore`` argument as "undo". @@ -143,7 +143,7 @@ Called for this plugin's active gizmos. .. rst-class:: classref-method -void **_commit_subgizmos** **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`PackedInt32Array` ids, :ref:`Transform3D[]` restores, :ref:`bool` cancel **)** |virtual| +|void| **_commit_subgizmos**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, ids\: :ref:`PackedInt32Array`, restores\: :ref:`Array`\[:ref:`Transform3D`\], cancel\: :ref:`bool`\ ) |virtual| Override this method to commit a group of subgizmos being edited (see :ref:`_subgizmos_intersect_ray` and :ref:`_subgizmos_intersect_frustum`). This usually means creating an :ref:`UndoRedo` action for the change, using the current transforms as "do" and the ``restores`` transforms as "undo". @@ -157,7 +157,7 @@ If the ``cancel`` argument is ``true``, the ``restores`` transforms should be di .. rst-class:: classref-method -:ref:`EditorNode3DGizmo` **_create_gizmo** **(** :ref:`Node3D` for_node_3d **)** |virtual| |const| +:ref:`EditorNode3DGizmo` **_create_gizmo**\ (\ for_node_3d\: :ref:`Node3D`\ ) |virtual| |const| Override this method to return a custom :ref:`EditorNode3DGizmo` for the spatial nodes of your choice, return ``null`` for the rest of nodes. See also :ref:`_has_gizmo`. @@ -169,7 +169,7 @@ Override this method to return a custom :ref:`EditorNode3DGizmo` **_get_gizmo_name** **(** **)** |virtual| |const| +:ref:`String` **_get_gizmo_name**\ (\ ) |virtual| |const| Override this method to provide the name that will appear in the gizmo visibility menu. @@ -181,7 +181,7 @@ Override this method to provide the name that will appear in the gizmo visibilit .. rst-class:: classref-method -:ref:`String` **_get_handle_name** **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`int` handle_id, :ref:`bool` secondary **)** |virtual| |const| +:ref:`String` **_get_handle_name**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| Override this method to provide gizmo's handle names. The ``secondary`` argument is ``true`` when the requested handle is secondary (see :ref:`EditorNode3DGizmo.add_handles` for more information). Called for this plugin's active gizmos. @@ -193,7 +193,7 @@ Override this method to provide gizmo's handle names. The ``secondary`` argument .. rst-class:: classref-method -:ref:`Variant` **_get_handle_value** **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`int` handle_id, :ref:`bool` secondary **)** |virtual| |const| +:ref:`Variant` **_get_handle_value**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| Override this method to return the current value of a handle. This value will be requested at the start of an edit and used as the ``restore`` argument in :ref:`_commit_handle`. @@ -209,7 +209,7 @@ Called for this plugin's active gizmos. .. rst-class:: classref-method -:ref:`int` **_get_priority** **(** **)** |virtual| |const| +:ref:`int` **_get_priority**\ (\ ) |virtual| |const| Override this method to set the gizmo's priority. Gizmos with higher priority will have precedence when processing inputs like handles or subgizmos selection. @@ -223,7 +223,7 @@ All built-in editor gizmos return a priority of ``-1``. If not overridden, this .. rst-class:: classref-method -:ref:`Transform3D` **_get_subgizmo_transform** **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`int` subgizmo_id **)** |virtual| |const| +:ref:`Transform3D` **_get_subgizmo_transform**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, subgizmo_id\: :ref:`int`\ ) |virtual| |const| Override this method to return the current transform of a subgizmo. As with all subgizmo methods, the transform should be in local space respect to the gizmo's Node3D. This transform will be requested at the start of an edit and used in the ``restore`` argument in :ref:`_commit_subgizmos`. Called for this plugin's active gizmos. @@ -235,7 +235,7 @@ Override this method to return the current transform of a subgizmo. As with all .. rst-class:: classref-method -:ref:`bool` **_has_gizmo** **(** :ref:`Node3D` for_node_3d **)** |virtual| |const| +:ref:`bool` **_has_gizmo**\ (\ for_node_3d\: :ref:`Node3D`\ ) |virtual| |const| Override this method to define which Node3D nodes have a gizmo from this plugin. Whenever a :ref:`Node3D` node is added to a scene this method is called, if it returns ``true`` the node gets a generic :ref:`EditorNode3DGizmo` assigned and is added to this plugin's list of active gizmos. @@ -247,7 +247,7 @@ Override this method to define which Node3D nodes have a gizmo from this plugin. .. rst-class:: classref-method -:ref:`bool` **_is_handle_highlighted** **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`int` handle_id, :ref:`bool` secondary **)** |virtual| |const| +:ref:`bool` **_is_handle_highlighted**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`\ ) |virtual| |const| Override this method to return ``true`` whenever to given handle should be highlighted in the editor. The ``secondary`` argument is ``true`` when the requested handle is secondary (see :ref:`EditorNode3DGizmo.add_handles` for more information). Called for this plugin's active gizmos. @@ -259,7 +259,7 @@ Override this method to return ``true`` whenever to given handle should be highl .. rst-class:: classref-method -:ref:`bool` **_is_selectable_when_hidden** **(** **)** |virtual| |const| +:ref:`bool` **_is_selectable_when_hidden**\ (\ ) |virtual| |const| Override this method to define whether Node3D with this gizmo should be selectable even when the gizmo is hidden. @@ -271,7 +271,7 @@ Override this method to define whether Node3D with this gizmo should be selectab .. rst-class:: classref-method -void **_redraw** **(** :ref:`EditorNode3DGizmo` gizmo **)** |virtual| +|void| **_redraw**\ (\ gizmo\: :ref:`EditorNode3DGizmo`\ ) |virtual| Override this method to add all the gizmo elements whenever a gizmo update is requested. It's common to call :ref:`EditorNode3DGizmo.clear` at the beginning of this method and then add visual elements depending on the node's properties. @@ -283,7 +283,7 @@ Override this method to add all the gizmo elements whenever a gizmo update is re .. rst-class:: classref-method -void **_set_handle** **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`int` handle_id, :ref:`bool` secondary, :ref:`Camera3D` camera, :ref:`Vector2` screen_pos **)** |virtual| +|void| **_set_handle**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, handle_id\: :ref:`int`, secondary\: :ref:`bool`, camera\: :ref:`Camera3D`, screen_pos\: :ref:`Vector2`\ ) |virtual| Override this method to update the node's properties when the user drags a gizmo handle (previously added with :ref:`EditorNode3DGizmo.add_handles`). The provided ``screen_pos`` is the mouse position in screen coordinates and the ``camera`` can be used to convert it to raycasts. @@ -299,7 +299,7 @@ Called for this plugin's active gizmos. .. rst-class:: classref-method -void **_set_subgizmo_transform** **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`int` subgizmo_id, :ref:`Transform3D` transform **)** |virtual| +|void| **_set_subgizmo_transform**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, subgizmo_id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| Override this method to update the node properties during subgizmo editing (see :ref:`_subgizmos_intersect_ray` and :ref:`_subgizmos_intersect_frustum`). The ``transform`` is given in the Node3D's local coordinate system. Called for this plugin's active gizmos. @@ -311,7 +311,7 @@ Override this method to update the node properties during subgizmo editing (see .. rst-class:: classref-method -:ref:`PackedInt32Array` **_subgizmos_intersect_frustum** **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`Camera3D` camera, :ref:`Plane[]` frustum_planes **)** |virtual| |const| +:ref:`PackedInt32Array` **_subgizmos_intersect_frustum**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, camera\: :ref:`Camera3D`, frustum_planes\: :ref:`Array`\[:ref:`Plane`\]\ ) |virtual| |const| Override this method to allow selecting subgizmos using mouse drag box selection. Given a ``camera`` and ``frustum_planes``, this method should return which subgizmos are contained within the frustums. The ``frustum_planes`` argument consists of an array with all the :ref:`Plane`\ s that make up the selection frustum. The returned value should contain a list of unique subgizmo identifiers, these identifiers can have any non-negative value and will be used in other virtual methods like :ref:`_get_subgizmo_transform` or :ref:`_commit_subgizmos`. Called for this plugin's active gizmos. @@ -323,7 +323,7 @@ Override this method to allow selecting subgizmos using mouse drag box selection .. rst-class:: classref-method -:ref:`int` **_subgizmos_intersect_ray** **(** :ref:`EditorNode3DGizmo` gizmo, :ref:`Camera3D` camera, :ref:`Vector2` screen_pos **)** |virtual| |const| +:ref:`int` **_subgizmos_intersect_ray**\ (\ gizmo\: :ref:`EditorNode3DGizmo`, camera\: :ref:`Camera3D`, screen_pos\: :ref:`Vector2`\ ) |virtual| |const| Override this method to allow selecting subgizmos using mouse clicks. Given a ``camera`` and a ``screen_pos`` in screen coordinates, this method should return which subgizmo should be selected. The returned value should be a unique subgizmo identifier, which can have any non-negative value and will be used in other virtual methods like :ref:`_get_subgizmo_transform` or :ref:`_commit_subgizmos`. Called for this plugin's active gizmos. @@ -335,7 +335,7 @@ Override this method to allow selecting subgizmos using mouse clicks. Given a `` .. rst-class:: classref-method -void **add_material** **(** :ref:`String` name, :ref:`StandardMaterial3D` material **)** +|void| **add_material**\ (\ name\: :ref:`String`, material\: :ref:`StandardMaterial3D`\ ) Adds a new material to the internal material list for the plugin. It can then be accessed with :ref:`get_material`. Should not be overridden. @@ -347,7 +347,7 @@ Adds a new material to the internal material list for the plugin. It can then be .. rst-class:: classref-method -void **create_handle_material** **(** :ref:`String` name, :ref:`bool` billboard=false, :ref:`Texture2D` texture=null **)** +|void| **create_handle_material**\ (\ name\: :ref:`String`, billboard\: :ref:`bool` = false, texture\: :ref:`Texture2D` = null\ ) Creates a handle material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with :ref:`get_material` and used in :ref:`EditorNode3DGizmo.add_handles`. Should not be overridden. @@ -361,7 +361,7 @@ You can optionally provide a texture to use instead of the default icon. .. rst-class:: classref-method -void **create_icon_material** **(** :ref:`String` name, :ref:`Texture2D` texture, :ref:`bool` on_top=false, :ref:`Color` color=Color(1, 1, 1, 1) **)** +|void| **create_icon_material**\ (\ name\: :ref:`String`, texture\: :ref:`Texture2D`, on_top\: :ref:`bool` = false, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) Creates an icon material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with :ref:`get_material` and used in :ref:`EditorNode3DGizmo.add_unscaled_billboard`. Should not be overridden. @@ -373,7 +373,7 @@ Creates an icon material with its variants (selected and/or editable) and adds t .. rst-class:: classref-method -void **create_material** **(** :ref:`String` name, :ref:`Color` color, :ref:`bool` billboard=false, :ref:`bool` on_top=false, :ref:`bool` use_vertex_color=false **)** +|void| **create_material**\ (\ name\: :ref:`String`, color\: :ref:`Color`, billboard\: :ref:`bool` = false, on_top\: :ref:`bool` = false, use_vertex_color\: :ref:`bool` = false\ ) Creates an unshaded material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with :ref:`get_material` and used in :ref:`EditorNode3DGizmo.add_mesh` and :ref:`EditorNode3DGizmo.add_lines`. Should not be overridden. @@ -385,7 +385,7 @@ Creates an unshaded material with its variants (selected and/or editable) and ad .. rst-class:: classref-method -:ref:`StandardMaterial3D` **get_material** **(** :ref:`String` name, :ref:`EditorNode3DGizmo` gizmo=null **)** +:ref:`StandardMaterial3D` **get_material**\ (\ name\: :ref:`String`, gizmo\: :ref:`EditorNode3DGizmo` = null\ ) Gets material from the internal list of materials. If an :ref:`EditorNode3DGizmo` is provided, it will try to get the corresponding variant (selected and/or editable). @@ -396,3 +396,4 @@ Gets material from the internal list of materials. If an :ref:`EditorNode3DGizmo .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorpaths.rst b/classes/class_editorpaths.rst index a8deebe48c4..ce4a559a590 100644 --- a/classes/class_editorpaths.rst +++ b/classes/class_editorpaths.rst @@ -40,19 +40,19 @@ Methods .. table:: :widths: auto - +-----------------------------+--------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_cache_dir` **(** **)** |const| | - +-----------------------------+--------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_config_dir` **(** **)** |const| | - +-----------------------------+--------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_data_dir` **(** **)** |const| | - +-----------------------------+--------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_project_settings_dir` **(** **)** |const| | - +-----------------------------+--------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_self_contained_file` **(** **)** |const| | - +-----------------------------+--------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_self_contained` **(** **)** |const| | - +-----------------------------+--------------------------------------------------------------------------------------------------------+ + +-----------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_cache_dir`\ (\ ) |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_config_dir`\ (\ ) |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_data_dir`\ (\ ) |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_project_settings_dir`\ (\ ) |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_self_contained_file`\ (\ ) |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_self_contained`\ (\ ) |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -67,7 +67,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **get_cache_dir** **(** **)** |const| +:ref:`String` **get_cache_dir**\ (\ ) |const| Returns the absolute path to the user's cache folder. This folder should be used for temporary data that can be removed safely whenever the editor is closed (such as generated resource thumbnails). @@ -87,7 +87,7 @@ Returns the absolute path to the user's cache folder. This folder should be used .. rst-class:: classref-method -:ref:`String` **get_config_dir** **(** **)** |const| +:ref:`String` **get_config_dir**\ (\ ) |const| Returns the absolute path to the user's configuration folder. This folder should be used for *persistent* user configuration files. @@ -107,7 +107,7 @@ Returns the absolute path to the user's configuration folder. This folder should .. rst-class:: classref-method -:ref:`String` **get_data_dir** **(** **)** |const| +:ref:`String` **get_data_dir**\ (\ ) |const| Returns the absolute path to the user's data folder. This folder should be used for *persistent* user data files such as installed export templates. @@ -127,7 +127,7 @@ Returns the absolute path to the user's data folder. This folder should be used .. rst-class:: classref-method -:ref:`String` **get_project_settings_dir** **(** **)** |const| +:ref:`String` **get_project_settings_dir**\ (\ ) |const| Returns the project-specific editor settings path. Projects all have a unique subdirectory inside the settings path where project-specific editor settings are saved. @@ -139,7 +139,7 @@ Returns the project-specific editor settings path. Projects all have a unique su .. rst-class:: classref-method -:ref:`String` **get_self_contained_file** **(** **)** |const| +:ref:`String` **get_self_contained_file**\ (\ ) |const| Returns the absolute path to the self-contained file that makes the current Godot editor instance be considered as self-contained. Returns an empty string if the current Godot editor instance isn't self-contained. See also :ref:`is_self_contained`. @@ -151,7 +151,7 @@ Returns the absolute path to the self-contained file that makes the current Godo .. rst-class:: classref-method -:ref:`bool` **is_self_contained** **(** **)** |const| +:ref:`bool` **is_self_contained**\ (\ ) |const| Returns ``true`` if the editor is marked as self-contained, ``false`` otherwise. When self-contained mode is enabled, user configuration, data and cache files are saved in an ``editor_data/`` folder next to the editor binary. This makes portable usage easier and ensures the Godot editor minimizes file writes outside its own folder. Self-contained mode is not available for exported projects. @@ -170,3 +170,4 @@ Self-contained mode can be enabled by creating a file named ``._sc_`` or ``_sc_` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 43fc2e2e45c..0db648a05e6 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -38,143 +38,143 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_apply_changes` **(** **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_build` **(** **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_clear` **(** **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_disable_plugin` **(** **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_edit` **(** :ref:`Object` object **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_enable_plugin` **(** **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_forward_3d_draw_over_viewport` **(** :ref:`Control` viewport_control **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_forward_3d_force_draw_over_viewport` **(** :ref:`Control` viewport_control **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_forward_3d_gui_input` **(** :ref:`Camera3D` viewport_camera, :ref:`InputEvent` event **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_forward_canvas_draw_over_viewport` **(** :ref:`Control` viewport_control **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_forward_canvas_force_draw_over_viewport` **(** :ref:`Control` viewport_control **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_forward_canvas_gui_input` **(** :ref:`InputEvent` event **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_breakpoints` **(** **)** |virtual| |const| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`_get_plugin_icon` **(** **)** |virtual| |const| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_plugin_name` **(** **)** |virtual| |const| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_state` **(** **)** |virtual| |const| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_unsaved_status` **(** :ref:`String` for_scene **)** |virtual| |const| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_get_window_layout` **(** :ref:`ConfigFile` configuration **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_handles` **(** :ref:`Object` object **)** |virtual| |const| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_main_screen` **(** **)** |virtual| |const| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_make_visible` **(** :ref:`bool` visible **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_save_external_data` **(** **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_state` **(** :ref:`Dictionary` state **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_window_layout` **(** :ref:`ConfigFile` configuration **)** |virtual| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_autoload_singleton` **(** :ref:`String` name, :ref:`String` path **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Button` | :ref:`add_control_to_bottom_panel` **(** :ref:`Control` control, :ref:`String` title **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_control_to_container` **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_control_to_dock` **(** :ref:`DockSlot` slot, :ref:`Control` control **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_custom_type` **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture2D` icon **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_debugger_plugin` **(** :ref:`EditorDebuggerPlugin` script **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_export_plugin` **(** :ref:`EditorExportPlugin` plugin **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_import_plugin` **(** :ref:`EditorImportPlugin` importer, :ref:`bool` first_priority=false **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_inspector_plugin` **(** :ref:`EditorInspectorPlugin` plugin **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_node_3d_gizmo_plugin` **(** :ref:`EditorNode3DGizmoPlugin` plugin **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_resource_conversion_plugin` **(** :ref:`EditorResourceConversionPlugin` plugin **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_scene_format_importer_plugin` **(** :ref:`EditorSceneFormatImporter` scene_format_importer, :ref:`bool` first_priority=false **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_scene_post_import_plugin` **(** :ref:`EditorScenePostImportPlugin` scene_import_plugin, :ref:`bool` first_priority=false **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_tool_menu_item` **(** :ref:`String` name, :ref:`Callable` callable **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_tool_submenu_item` **(** :ref:`String` name, :ref:`PopupMenu` submenu **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_translation_parser_plugin` **(** :ref:`EditorTranslationParserPlugin` parser **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_undo_redo_inspector_hook_callback` **(** :ref:`Callable` callable **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PopupMenu` | :ref:`get_export_as_menu` **(** **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_plugin_version` **(** **)** |const| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ScriptCreateDialog` | :ref:`get_script_create_dialog` **(** **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`EditorUndoRedoManager` | :ref:`get_undo_redo` **(** **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`hide_bottom_panel` **(** **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`make_bottom_panel_item_visible` **(** :ref:`Control` item **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`queue_save_layout` **(** **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_autoload_singleton` **(** :ref:`String` name **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_control_from_bottom_panel` **(** :ref:`Control` control **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_control_from_container` **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_control_from_docks` **(** :ref:`Control` control **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_custom_type` **(** :ref:`String` type **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_debugger_plugin` **(** :ref:`EditorDebuggerPlugin` script **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_export_plugin` **(** :ref:`EditorExportPlugin` plugin **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_inspector_plugin` **(** :ref:`EditorInspectorPlugin` plugin **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_node_3d_gizmo_plugin` **(** :ref:`EditorNode3DGizmoPlugin` plugin **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_resource_conversion_plugin` **(** :ref:`EditorResourceConversionPlugin` plugin **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_scene_format_importer_plugin` **(** :ref:`EditorSceneFormatImporter` scene_format_importer **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_scene_post_import_plugin` **(** :ref:`EditorScenePostImportPlugin` scene_import_plugin **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_tool_menu_item` **(** :ref:`String` name **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_translation_parser_plugin` **(** :ref:`EditorTranslationParserPlugin` parser **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_undo_redo_inspector_hook_callback` **(** :ref:`Callable` callable **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_force_draw_over_forwarding_enabled` **(** **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_input_event_forwarding_always_enabled` **(** **)** | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`update_overlays` **(** **)** |const| | - +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_changes`\ (\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_build`\ (\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_clear`\ (\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_disable_plugin`\ (\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_edit`\ (\ object\: :ref:`Object`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_enable_plugin`\ (\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_forward_3d_draw_over_viewport`\ (\ viewport_control\: :ref:`Control`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_forward_3d_force_draw_over_viewport`\ (\ viewport_control\: :ref:`Control`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_forward_3d_gui_input`\ (\ viewport_camera\: :ref:`Camera3D`, event\: :ref:`InputEvent`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_forward_canvas_draw_over_viewport`\ (\ viewport_control\: :ref:`Control`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_forward_canvas_force_draw_over_viewport`\ (\ viewport_control\: :ref:`Control`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_forward_canvas_gui_input`\ (\ event\: :ref:`InputEvent`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_breakpoints`\ (\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`_get_plugin_icon`\ (\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_plugin_name`\ (\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_state`\ (\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_unsaved_status`\ (\ for_scene\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_get_window_layout`\ (\ configuration\: :ref:`ConfigFile`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_handles`\ (\ object\: :ref:`Object`\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_main_screen`\ (\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_make_visible`\ (\ visible\: :ref:`bool`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_save_external_data`\ (\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_state`\ (\ state\: :ref:`Dictionary`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_window_layout`\ (\ configuration\: :ref:`ConfigFile`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_autoload_singleton`\ (\ name\: :ref:`String`, path\: :ref:`String`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Button` | :ref:`add_control_to_bottom_panel`\ (\ control\: :ref:`Control`, title\: :ref:`String`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_control_to_container`\ (\ container\: :ref:`CustomControlContainer`, control\: :ref:`Control`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_control_to_dock`\ (\ slot\: :ref:`DockSlot`, control\: :ref:`Control`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_custom_type`\ (\ type\: :ref:`String`, base\: :ref:`String`, script\: :ref:`Script`, icon\: :ref:`Texture2D`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_debugger_plugin`\ (\ script\: :ref:`EditorDebuggerPlugin`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_export_plugin`\ (\ plugin\: :ref:`EditorExportPlugin`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_import_plugin`\ (\ importer\: :ref:`EditorImportPlugin`, first_priority\: :ref:`bool` = false\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_inspector_plugin`\ (\ plugin\: :ref:`EditorInspectorPlugin`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_node_3d_gizmo_plugin`\ (\ plugin\: :ref:`EditorNode3DGizmoPlugin`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_resource_conversion_plugin`\ (\ plugin\: :ref:`EditorResourceConversionPlugin`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_scene_format_importer_plugin`\ (\ scene_format_importer\: :ref:`EditorSceneFormatImporter`, first_priority\: :ref:`bool` = false\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_scene_post_import_plugin`\ (\ scene_import_plugin\: :ref:`EditorScenePostImportPlugin`, first_priority\: :ref:`bool` = false\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_tool_menu_item`\ (\ name\: :ref:`String`, callable\: :ref:`Callable`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_tool_submenu_item`\ (\ name\: :ref:`String`, submenu\: :ref:`PopupMenu`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_translation_parser_plugin`\ (\ parser\: :ref:`EditorTranslationParserPlugin`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_undo_redo_inspector_hook_callback`\ (\ callable\: :ref:`Callable`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`EditorInterface` | :ref:`get_editor_interface`\ (\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PopupMenu` | :ref:`get_export_as_menu`\ (\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_plugin_version`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ScriptCreateDialog` | :ref:`get_script_create_dialog`\ (\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`EditorUndoRedoManager` | :ref:`get_undo_redo`\ (\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`hide_bottom_panel`\ (\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`make_bottom_panel_item_visible`\ (\ item\: :ref:`Control`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`queue_save_layout`\ (\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_autoload_singleton`\ (\ name\: :ref:`String`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_control_from_bottom_panel`\ (\ control\: :ref:`Control`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_control_from_container`\ (\ container\: :ref:`CustomControlContainer`, control\: :ref:`Control`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_control_from_docks`\ (\ control\: :ref:`Control`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_custom_type`\ (\ type\: :ref:`String`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_debugger_plugin`\ (\ script\: :ref:`EditorDebuggerPlugin`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_export_plugin`\ (\ plugin\: :ref:`EditorExportPlugin`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_import_plugin`\ (\ importer\: :ref:`EditorImportPlugin`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_inspector_plugin`\ (\ plugin\: :ref:`EditorInspectorPlugin`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_node_3d_gizmo_plugin`\ (\ plugin\: :ref:`EditorNode3DGizmoPlugin`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_resource_conversion_plugin`\ (\ plugin\: :ref:`EditorResourceConversionPlugin`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_scene_format_importer_plugin`\ (\ scene_format_importer\: :ref:`EditorSceneFormatImporter`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_scene_post_import_plugin`\ (\ scene_import_plugin\: :ref:`EditorScenePostImportPlugin`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_tool_menu_item`\ (\ name\: :ref:`String`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_translation_parser_plugin`\ (\ parser\: :ref:`EditorTranslationParserPlugin`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_undo_redo_inspector_hook_callback`\ (\ callable\: :ref:`Callable`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_force_draw_over_forwarding_enabled`\ (\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_input_event_forwarding_always_enabled`\ (\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`update_overlays`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -189,7 +189,7 @@ Signals .. rst-class:: classref-signal -**main_screen_changed** **(** :ref:`String` screen_name **)** +**main_screen_changed**\ (\ screen_name\: :ref:`String`\ ) Emitted when user changes the workspace (**2D**, **3D**, **Script**, **AssetLib**). Also works with custom screens defined by plugins. @@ -201,7 +201,7 @@ Emitted when user changes the workspace (**2D**, **3D**, **Script**, **AssetLib* .. rst-class:: classref-signal -**project_settings_changed** **(** **)** +**project_settings_changed**\ (\ ) **Deprecated:** Use :ref:`ProjectSettings.settings_changed` instead. @@ -215,7 +215,7 @@ Emitted when any project setting has changed. .. rst-class:: classref-signal -**resource_saved** **(** :ref:`Resource` resource **)** +**resource_saved**\ (\ resource\: :ref:`Resource`\ ) Emitted when the given ``resource`` was saved on disc. See also :ref:`scene_saved`. @@ -227,7 +227,7 @@ Emitted when the given ``resource`` was saved on disc. See also :ref:`scene_save .. rst-class:: classref-signal -**scene_changed** **(** :ref:`Node` scene_root **)** +**scene_changed**\ (\ scene_root\: :ref:`Node`\ ) Emitted when the scene is changed in the editor. The argument will return the root node of the scene that has just become active. If this scene is new and empty, the argument will be ``null``. @@ -239,7 +239,7 @@ Emitted when the scene is changed in the editor. The argument will return the ro .. rst-class:: classref-signal -**scene_closed** **(** :ref:`String` filepath **)** +**scene_closed**\ (\ filepath\: :ref:`String`\ ) Emitted when user closes a scene. The argument is a file path to the closed scene. @@ -251,7 +251,7 @@ Emitted when user closes a scene. The argument is a file path to the closed scen .. rst-class:: classref-signal -**scene_saved** **(** :ref:`String` filepath **)** +**scene_saved**\ (\ filepath\: :ref:`String`\ ) Emitted when a scene was saved on disc. The argument is a file path to the saved scene. See also :ref:`resource_saved`. @@ -495,7 +495,7 @@ Method Descriptions .. rst-class:: classref-method -void **_apply_changes** **(** **)** |virtual| +|void| **_apply_changes**\ (\ ) |virtual| This method is called when the editor is about to save the project, switch to another tab, etc. It asks the plugin to apply any pending state changes to ensure consistency. @@ -509,7 +509,7 @@ This is used, for example, in shader editors to let the plugin know that it must .. rst-class:: classref-method -:ref:`bool` **_build** **(** **)** |virtual| +:ref:`bool` **_build**\ (\ ) |virtual| This method is called when the editor is about to run the project. The plugin can then perform required operations before the project runs. @@ -523,7 +523,7 @@ This method must return a boolean. If this method returns ``false``, the project .. rst-class:: classref-method -void **_clear** **(** **)** |virtual| +|void| **_clear**\ (\ ) |virtual| Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node from the wrong scene. @@ -535,7 +535,7 @@ Clear all the state and reset the object being edited to zero. This ensures your .. rst-class:: classref-method -void **_disable_plugin** **(** **)** |virtual| +|void| **_disable_plugin**\ (\ ) |virtual| Called by the engine when the user disables the **EditorPlugin** in the Plugin tab of the project settings window. @@ -547,7 +547,7 @@ Called by the engine when the user disables the **EditorPlugin** in the Plugin t .. rst-class:: classref-method -void **_edit** **(** :ref:`Object` object **)** |virtual| +|void| **_edit**\ (\ object\: :ref:`Object`\ ) |virtual| This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object. @@ -561,7 +561,7 @@ This function is used for plugins that edit specific object types (nodes or reso .. rst-class:: classref-method -void **_enable_plugin** **(** **)** |virtual| +|void| **_enable_plugin**\ (\ ) |virtual| Called by the engine when the user enables the **EditorPlugin** in the Plugin tab of the project settings window. @@ -573,7 +573,7 @@ Called by the engine when the user enables the **EditorPlugin** in the Plugin ta .. rst-class:: classref-method -void **_forward_3d_draw_over_viewport** **(** :ref:`Control` viewport_control **)** |virtual| +|void| **_forward_3d_draw_over_viewport**\ (\ viewport_control\: :ref:`Control`\ ) |virtual| Called by the engine when the 3D editor's viewport is updated. Use the ``overlay`` :ref:`Control` for drawing. You can update the viewport manually by calling :ref:`update_overlays`. @@ -622,7 +622,7 @@ Called by the engine when the 3D editor's viewport is updated. Use the ``overlay .. rst-class:: classref-method -void **_forward_3d_force_draw_over_viewport** **(** :ref:`Control` viewport_control **)** |virtual| +|void| **_forward_3d_force_draw_over_viewport**\ (\ viewport_control\: :ref:`Control`\ ) |virtual| This method is the same as :ref:`_forward_3d_draw_over_viewport`, except it draws on top of everything. Useful when you need an extra layer that shows over anything else. @@ -636,7 +636,7 @@ You need to enable calling of this method by using :ref:`set_force_draw_over_for .. rst-class:: classref-method -:ref:`int` **_forward_3d_gui_input** **(** :ref:`Camera3D` viewport_camera, :ref:`InputEvent` event **)** |virtual| +:ref:`int` **_forward_3d_gui_input**\ (\ viewport_camera\: :ref:`Camera3D`, event\: :ref:`InputEvent`\ ) |virtual| Called when there is a root node in the current edited scene, :ref:`_handles` is implemented, and an :ref:`InputEvent` happens in the 3D viewport. The return value decides whether the :ref:`InputEvent` is consumed or forwarded to other **EditorPlugin**\ s. See :ref:`AfterGUIInput` for options. @@ -692,7 +692,7 @@ Must ``return EditorPlugin.AFTER_GUI_INPUT_PASS`` in order to forward the :ref:` .. rst-class:: classref-method -void **_forward_canvas_draw_over_viewport** **(** :ref:`Control` viewport_control **)** |virtual| +|void| **_forward_canvas_draw_over_viewport**\ (\ viewport_control\: :ref:`Control`\ ) |virtual| Called by the engine when the 2D editor's viewport is updated. Use the ``overlay`` :ref:`Control` for drawing. You can update the viewport manually by calling :ref:`update_overlays`. @@ -741,7 +741,7 @@ Called by the engine when the 2D editor's viewport is updated. Use the ``overlay .. rst-class:: classref-method -void **_forward_canvas_force_draw_over_viewport** **(** :ref:`Control` viewport_control **)** |virtual| +|void| **_forward_canvas_force_draw_over_viewport**\ (\ viewport_control\: :ref:`Control`\ ) |virtual| This method is the same as :ref:`_forward_canvas_draw_over_viewport`, except it draws on top of everything. Useful when you need an extra layer that shows over anything else. @@ -755,7 +755,7 @@ You need to enable calling of this method by using :ref:`set_force_draw_over_for .. rst-class:: classref-method -:ref:`bool` **_forward_canvas_gui_input** **(** :ref:`InputEvent` event **)** |virtual| +:ref:`bool` **_forward_canvas_gui_input**\ (\ event\: :ref:`InputEvent`\ ) |virtual| Called when there is a root node in the current edited scene, :ref:`_handles` is implemented and an :ref:`InputEvent` happens in the 2D viewport. Intercepts the :ref:`InputEvent`, if ``return true`` **EditorPlugin** consumes the ``event``, otherwise forwards ``event`` to other Editor classes. @@ -817,7 +817,7 @@ Must ``return false`` in order to forward the :ref:`InputEvent .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_breakpoints** **(** **)** |virtual| |const| +:ref:`PackedStringArray` **_get_breakpoints**\ (\ ) |virtual| |const| This is for editors that edit script-based objects. You can return a list of breakpoints in the format (``script:line``), for example: ``res://path_to_script.gd:25``. @@ -829,7 +829,7 @@ This is for editors that edit script-based objects. You can return a list of bre .. rst-class:: classref-method -:ref:`Texture2D` **_get_plugin_icon** **(** **)** |virtual| |const| +:ref:`Texture2D` **_get_plugin_icon**\ (\ ) |virtual| |const| Override this method in your plugin to return a :ref:`Texture2D` in order to give it an icon. @@ -868,7 +868,7 @@ Ideally, the plugin icon should be white with a transparent background and 16x16 .. rst-class:: classref-method -:ref:`String` **_get_plugin_name** **(** **)** |virtual| |const| +:ref:`String` **_get_plugin_name**\ (\ ) |virtual| |const| Override this method in your plugin to provide the name of the plugin when displayed in the Godot editor. @@ -882,7 +882,7 @@ For main screen plugins, this appears at the top of the screen, to the right of .. rst-class:: classref-method -:ref:`Dictionary` **_get_state** **(** **)** |virtual| |const| +:ref:`Dictionary` **_get_state**\ (\ ) |virtual| |const| Override this method to provide a state data you want to be saved, like view position, grid settings, folding, etc. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns). This data is automatically saved for each scene in an ``editstate`` file in the editor metadata folder. If you want to store global (scene-independent) editor data for your plugin, you can use :ref:`_get_window_layout` instead. @@ -906,7 +906,7 @@ Use :ref:`_set_state` to restore y .. rst-class:: classref-method -:ref:`String` **_get_unsaved_status** **(** :ref:`String` for_scene **)** |virtual| |const| +:ref:`String` **_get_unsaved_status**\ (\ for_scene\: :ref:`String`\ ) |virtual| |const| Override this method to provide a custom message that lists unsaved changes. The editor will call this method when exiting or when closing a scene, and display the returned string in a confirmation dialog. Return empty string if the plugin has no unsaved changes. @@ -944,7 +944,7 @@ If the plugin has no scene-specific changes, you can ignore the calls when closi .. rst-class:: classref-method -void **_get_window_layout** **(** :ref:`ConfigFile` configuration **)** |virtual| +|void| **_get_window_layout**\ (\ configuration\: :ref:`ConfigFile`\ ) |virtual| Override this method to provide the GUI layout of the plugin or any other data you want to be stored. This is used to save the project's editor layout when :ref:`queue_save_layout` is called or the editor layout was changed (for example changing the position of a dock). The data is stored in the ``editor_layout.cfg`` file in the editor metadata directory. @@ -964,7 +964,7 @@ Use :ref:`_set_window_layout` **_handles** **(** :ref:`Object` object **)** |virtual| |const| +:ref:`bool` **_handles**\ (\ object\: :ref:`Object`\ ) |virtual| |const| Implement this function if your plugin edits a specific type of object (Resource or Node). If you return ``true``, then you will get the functions :ref:`_edit` and :ref:`_make_visible` called when the editor requests them. If you have declared the methods :ref:`_forward_canvas_gui_input` and :ref:`_forward_3d_gui_input` these will be called too. @@ -978,7 +978,7 @@ Implement this function if your plugin edits a specific type of object (Resource .. rst-class:: classref-method -:ref:`bool` **_has_main_screen** **(** **)** |virtual| |const| +:ref:`bool` **_has_main_screen**\ (\ ) |virtual| |const| Returns ``true`` if this is a main screen editor plugin (it goes in the workspace selector together with **2D**, **3D**, **Script** and **AssetLib**). @@ -1015,7 +1015,7 @@ Use :ref:`_get_plugin_name` .. rst-class:: classref-method -void **_make_visible** **(** :ref:`bool` visible **)** |virtual| +|void| **_make_visible**\ (\ visible\: :ref:`bool`\ ) |virtual| This function will be called when the editor is requested to become visible. It is used for plugins that edit a specific object type. @@ -1029,7 +1029,7 @@ Remember that you have to manage the visibility of all your editor controls manu .. rst-class:: classref-method -void **_save_external_data** **(** **)** |virtual| +|void| **_save_external_data**\ (\ ) |virtual| This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources. @@ -1041,7 +1041,7 @@ This method is called after the editor saves the project or when it's closed. It .. rst-class:: classref-method -void **_set_state** **(** :ref:`Dictionary` state **)** |virtual| +|void| **_set_state**\ (\ state\: :ref:`Dictionary`\ ) |virtual| Restore the state saved by :ref:`_get_state`. This method is called when the current scene tab is changed in the editor. @@ -1061,7 +1061,7 @@ Restore the state saved by :ref:`_get_state` configuration **)** |virtual| +|void| **_set_window_layout**\ (\ configuration\: :ref:`ConfigFile`\ ) |virtual| Restore the plugin GUI layout and data saved by :ref:`_get_window_layout`. This method is called for every plugin on editor startup. Use the provided ``configuration`` file to read your saved data. @@ -1079,7 +1079,7 @@ Restore the plugin GUI layout and data saved by :ref:`_get_window_layout` name, :ref:`String` path **)** +|void| **add_autoload_singleton**\ (\ name\: :ref:`String`, path\: :ref:`String`\ ) Adds a script at ``path`` to the Autoload list as ``name``. @@ -1091,7 +1091,7 @@ Adds a script at ``path`` to the Autoload list as ``name``. .. rst-class:: classref-method -:ref:`Button` **add_control_to_bottom_panel** **(** :ref:`Control` control, :ref:`String` title **)** +:ref:`Button` **add_control_to_bottom_panel**\ (\ control\: :ref:`Control`, title\: :ref:`String`\ ) Adds a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with :ref:`remove_control_from_bottom_panel` and free it with :ref:`Node.queue_free`. @@ -1103,7 +1103,7 @@ Adds a control to the bottom panel (together with Output, Debug, Animation, etc) .. rst-class:: classref-method -void **add_control_to_container** **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** +|void| **add_control_to_container**\ (\ container\: :ref:`CustomControlContainer`, control\: :ref:`Control`\ ) Adds a custom control to a container (see :ref:`CustomControlContainer`). There are many locations where custom controls can be added in the editor UI. @@ -1119,7 +1119,7 @@ When your plugin is deactivated, make sure to remove your custom control with :r .. rst-class:: classref-method -void **add_control_to_dock** **(** :ref:`DockSlot` slot, :ref:`Control` control **)** +|void| **add_control_to_dock**\ (\ slot\: :ref:`DockSlot`, control\: :ref:`Control`\ ) Adds the control to a specific dock slot (see :ref:`DockSlot` for options). @@ -1135,7 +1135,7 @@ When your plugin is deactivated, make sure to remove your custom control with :r .. rst-class:: classref-method -void **add_custom_type** **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture2D` icon **)** +|void| **add_custom_type**\ (\ type\: :ref:`String`, base\: :ref:`String`, script\: :ref:`Script`, icon\: :ref:`Texture2D`\ ) Adds a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed. @@ -1157,7 +1157,7 @@ During run-time, this will be a simple object with a script so this function doe .. rst-class:: classref-method -void **add_debugger_plugin** **(** :ref:`EditorDebuggerPlugin` script **)** +|void| **add_debugger_plugin**\ (\ script\: :ref:`EditorDebuggerPlugin`\ ) Adds a :ref:`Script` as debugger plugin to the Debugger. The script must extend :ref:`EditorDebuggerPlugin`. @@ -1169,7 +1169,7 @@ Adds a :ref:`Script` as debugger plugin to the Debugger. The scrip .. rst-class:: classref-method -void **add_export_plugin** **(** :ref:`EditorExportPlugin` plugin **)** +|void| **add_export_plugin**\ (\ plugin\: :ref:`EditorExportPlugin`\ ) Registers a new :ref:`EditorExportPlugin`. Export plugins are used to perform tasks when the project is being exported. @@ -1183,7 +1183,7 @@ See :ref:`add_inspector_plugin` .. rst-class:: classref-method -void **add_import_plugin** **(** :ref:`EditorImportPlugin` importer, :ref:`bool` first_priority=false **)** +|void| **add_import_plugin**\ (\ importer\: :ref:`EditorImportPlugin`, first_priority\: :ref:`bool` = false\ ) Registers a new :ref:`EditorImportPlugin`. Import plugins are used to import custom and unsupported assets as a custom :ref:`Resource` type. @@ -1201,7 +1201,7 @@ See :ref:`add_inspector_plugin` .. rst-class:: classref-method -void **add_inspector_plugin** **(** :ref:`EditorInspectorPlugin` plugin **)** +|void| **add_inspector_plugin**\ (\ plugin\: :ref:`EditorInspectorPlugin`\ ) Registers a new :ref:`EditorInspectorPlugin`. Inspector plugins are used to extend :ref:`EditorInspector` and provide custom configuration tools for your object's properties. @@ -1231,7 +1231,7 @@ Registers a new :ref:`EditorInspectorPlugin`. Inspe .. rst-class:: classref-method -void **add_node_3d_gizmo_plugin** **(** :ref:`EditorNode3DGizmoPlugin` plugin **)** +|void| **add_node_3d_gizmo_plugin**\ (\ plugin\: :ref:`EditorNode3DGizmoPlugin`\ ) Registers a new :ref:`EditorNode3DGizmoPlugin`. Gizmo plugins are used to add custom gizmos to the 3D preview viewport for a :ref:`Node3D`. @@ -1245,7 +1245,7 @@ See :ref:`add_inspector_plugin` .. rst-class:: classref-method -void **add_resource_conversion_plugin** **(** :ref:`EditorResourceConversionPlugin` plugin **)** +|void| **add_resource_conversion_plugin**\ (\ plugin\: :ref:`EditorResourceConversionPlugin`\ ) Registers a new :ref:`EditorResourceConversionPlugin`. Resource conversion plugins are used to add custom resource converters to the editor inspector. @@ -1259,7 +1259,7 @@ See :ref:`EditorResourceConversionPlugin` .. rst-class:: classref-method -void **add_scene_format_importer_plugin** **(** :ref:`EditorSceneFormatImporter` scene_format_importer, :ref:`bool` first_priority=false **)** +|void| **add_scene_format_importer_plugin**\ (\ scene_format_importer\: :ref:`EditorSceneFormatImporter`, first_priority\: :ref:`bool` = false\ ) Registers a new :ref:`EditorSceneFormatImporter`. Scene importers are used to import custom 3D asset formats as scenes. @@ -1273,7 +1273,7 @@ If ``first_priority`` is ``true``, the new import plugin is inserted first in th .. rst-class:: classref-method -void **add_scene_post_import_plugin** **(** :ref:`EditorScenePostImportPlugin` scene_import_plugin, :ref:`bool` first_priority=false **)** +|void| **add_scene_post_import_plugin**\ (\ scene_import_plugin\: :ref:`EditorScenePostImportPlugin`, first_priority\: :ref:`bool` = false\ ) Add a :ref:`EditorScenePostImportPlugin`. These plugins allow customizing the import process of 3D assets by adding new options to the import dialogs. @@ -1287,7 +1287,7 @@ If ``first_priority`` is ``true``, the new import plugin is inserted first in th .. rst-class:: classref-method -void **add_tool_menu_item** **(** :ref:`String` name, :ref:`Callable` callable **)** +|void| **add_tool_menu_item**\ (\ name\: :ref:`String`, callable\: :ref:`Callable`\ ) Adds a custom menu item to **Project > Tools** named ``name``. When clicked, the provided ``callable`` will be called. @@ -1299,7 +1299,7 @@ Adds a custom menu item to **Project > Tools** named ``name``. When clicked, the .. rst-class:: classref-method -void **add_tool_submenu_item** **(** :ref:`String` name, :ref:`PopupMenu` submenu **)** +|void| **add_tool_submenu_item**\ (\ name\: :ref:`String`, submenu\: :ref:`PopupMenu`\ ) Adds a custom :ref:`PopupMenu` submenu under **Project > Tools >** ``name``. Use :ref:`remove_tool_menu_item` on plugin clean up to remove the menu. @@ -1311,7 +1311,7 @@ Adds a custom :ref:`PopupMenu` submenu under **Project > Tools .. rst-class:: classref-method -void **add_translation_parser_plugin** **(** :ref:`EditorTranslationParserPlugin` parser **)** +|void| **add_translation_parser_plugin**\ (\ parser\: :ref:`EditorTranslationParserPlugin`\ ) Registers a custom translation parser plugin for extracting translatable strings from custom files. @@ -1323,7 +1323,7 @@ Registers a custom translation parser plugin for extracting translatable strings .. rst-class:: classref-method -void **add_undo_redo_inspector_hook_callback** **(** :ref:`Callable` callable **)** +|void| **add_undo_redo_inspector_hook_callback**\ (\ callable\: :ref:`Callable`\ ) Hooks a callback into the undo/redo action creation when a property is modified in the inspector. This allows, for example, to save other properties that may be lost when a given property is modified. @@ -1337,7 +1337,7 @@ The callback should have 4 arguments: :ref:`Object` ``undo_redo``, .. rst-class:: classref-method -:ref:`EditorInterface` **get_editor_interface** **(** **)** +:ref:`EditorInterface` **get_editor_interface**\ (\ ) **Deprecated:** :ref:`EditorInterface` is a global singleton and can be accessed directly by its name. @@ -1351,7 +1351,7 @@ Returns the :ref:`EditorInterface` singleton instance. .. rst-class:: classref-method -:ref:`PopupMenu` **get_export_as_menu** **(** **)** +:ref:`PopupMenu` **get_export_as_menu**\ (\ ) Returns the :ref:`PopupMenu` under **Scene > Export As...**. @@ -1363,7 +1363,7 @@ Returns the :ref:`PopupMenu` under **Scene > Export As...**. .. rst-class:: classref-method -:ref:`String` **get_plugin_version** **(** **)** |const| +:ref:`String` **get_plugin_version**\ (\ ) |const| Provide the version of the plugin declared in the ``plugin.cfg`` config file. @@ -1375,7 +1375,7 @@ Provide the version of the plugin declared in the ``plugin.cfg`` config file. .. rst-class:: classref-method -:ref:`ScriptCreateDialog` **get_script_create_dialog** **(** **)** +:ref:`ScriptCreateDialog` **get_script_create_dialog**\ (\ ) Gets the Editor's dialog used for making scripts. @@ -1391,7 +1391,7 @@ Gets the Editor's dialog used for making scripts. .. rst-class:: classref-method -:ref:`EditorUndoRedoManager` **get_undo_redo** **(** **)** +:ref:`EditorUndoRedoManager` **get_undo_redo**\ (\ ) Gets the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it. @@ -1403,7 +1403,7 @@ Gets the undo/redo object. Most actions in the editor can be undoable, so use th .. rst-class:: classref-method -void **hide_bottom_panel** **(** **)** +|void| **hide_bottom_panel**\ (\ ) Minimizes the bottom panel. @@ -1415,7 +1415,7 @@ Minimizes the bottom panel. .. rst-class:: classref-method -void **make_bottom_panel_item_visible** **(** :ref:`Control` item **)** +|void| **make_bottom_panel_item_visible**\ (\ item\: :ref:`Control`\ ) Makes a specific item in the bottom panel visible. @@ -1427,7 +1427,7 @@ Makes a specific item in the bottom panel visible. .. rst-class:: classref-method -void **queue_save_layout** **(** **)** +|void| **queue_save_layout**\ (\ ) Queue save the project's editor layout. @@ -1439,7 +1439,7 @@ Queue save the project's editor layout. .. rst-class:: classref-method -void **remove_autoload_singleton** **(** :ref:`String` name **)** +|void| **remove_autoload_singleton**\ (\ name\: :ref:`String`\ ) Removes an Autoload ``name`` from the list. @@ -1451,7 +1451,7 @@ Removes an Autoload ``name`` from the list. .. rst-class:: classref-method -void **remove_control_from_bottom_panel** **(** :ref:`Control` control **)** +|void| **remove_control_from_bottom_panel**\ (\ control\: :ref:`Control`\ ) Removes the control from the bottom panel. You have to manually :ref:`Node.queue_free` the control. @@ -1463,7 +1463,7 @@ Removes the control from the bottom panel. You have to manually :ref:`Node.queue .. rst-class:: classref-method -void **remove_control_from_container** **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** +|void| **remove_control_from_container**\ (\ container\: :ref:`CustomControlContainer`, control\: :ref:`Control`\ ) Removes the control from the specified container. You have to manually :ref:`Node.queue_free` the control. @@ -1475,7 +1475,7 @@ Removes the control from the specified container. You have to manually :ref:`Nod .. rst-class:: classref-method -void **remove_control_from_docks** **(** :ref:`Control` control **)** +|void| **remove_control_from_docks**\ (\ control\: :ref:`Control`\ ) Removes the control from the dock. You have to manually :ref:`Node.queue_free` the control. @@ -1487,7 +1487,7 @@ Removes the control from the dock. You have to manually :ref:`Node.queue_free` type **)** +|void| **remove_custom_type**\ (\ type\: :ref:`String`\ ) Removes a custom type added by :ref:`add_custom_type`. @@ -1499,7 +1499,7 @@ Removes a custom type added by :ref:`add_custom_type` script **)** +|void| **remove_debugger_plugin**\ (\ script\: :ref:`EditorDebuggerPlugin`\ ) Removes the debugger plugin with given script from the Debugger. @@ -1511,7 +1511,7 @@ Removes the debugger plugin with given script from the Debugger. .. rst-class:: classref-method -void **remove_export_plugin** **(** :ref:`EditorExportPlugin` plugin **)** +|void| **remove_export_plugin**\ (\ plugin\: :ref:`EditorExportPlugin`\ ) Removes an export plugin registered by :ref:`add_export_plugin`. @@ -1523,7 +1523,7 @@ Removes an export plugin registered by :ref:`add_export_plugin` importer **)** +|void| **remove_import_plugin**\ (\ importer\: :ref:`EditorImportPlugin`\ ) Removes an import plugin registered by :ref:`add_import_plugin`. @@ -1535,7 +1535,7 @@ Removes an import plugin registered by :ref:`add_import_plugin` plugin **)** +|void| **remove_inspector_plugin**\ (\ plugin\: :ref:`EditorInspectorPlugin`\ ) Removes an inspector plugin registered by :ref:`add_import_plugin` @@ -1547,7 +1547,7 @@ Removes an inspector plugin registered by :ref:`add_import_plugin` plugin **)** +|void| **remove_node_3d_gizmo_plugin**\ (\ plugin\: :ref:`EditorNode3DGizmoPlugin`\ ) Removes a gizmo plugin registered by :ref:`add_node_3d_gizmo_plugin`. @@ -1559,7 +1559,7 @@ Removes a gizmo plugin registered by :ref:`add_node_3d_gizmo_plugin` plugin **)** +|void| **remove_resource_conversion_plugin**\ (\ plugin\: :ref:`EditorResourceConversionPlugin`\ ) Removes a resource conversion plugin registered by :ref:`add_resource_conversion_plugin`. @@ -1571,7 +1571,7 @@ Removes a resource conversion plugin registered by :ref:`add_resource_conversion .. rst-class:: classref-method -void **remove_scene_format_importer_plugin** **(** :ref:`EditorSceneFormatImporter` scene_format_importer **)** +|void| **remove_scene_format_importer_plugin**\ (\ scene_format_importer\: :ref:`EditorSceneFormatImporter`\ ) Removes a scene format importer registered by :ref:`add_scene_format_importer_plugin`. @@ -1583,7 +1583,7 @@ Removes a scene format importer registered by :ref:`add_scene_format_importer_pl .. rst-class:: classref-method -void **remove_scene_post_import_plugin** **(** :ref:`EditorScenePostImportPlugin` scene_import_plugin **)** +|void| **remove_scene_post_import_plugin**\ (\ scene_import_plugin\: :ref:`EditorScenePostImportPlugin`\ ) Remove the :ref:`EditorScenePostImportPlugin`, added with :ref:`add_scene_post_import_plugin`. @@ -1595,7 +1595,7 @@ Remove the :ref:`EditorScenePostImportPlugin` .. rst-class:: classref-method -void **remove_tool_menu_item** **(** :ref:`String` name **)** +|void| **remove_tool_menu_item**\ (\ name\: :ref:`String`\ ) Removes a menu ``name`` from **Project > Tools**. @@ -1607,7 +1607,7 @@ Removes a menu ``name`` from **Project > Tools**. .. rst-class:: classref-method -void **remove_translation_parser_plugin** **(** :ref:`EditorTranslationParserPlugin` parser **)** +|void| **remove_translation_parser_plugin**\ (\ parser\: :ref:`EditorTranslationParserPlugin`\ ) Removes a custom translation parser plugin registered by :ref:`add_translation_parser_plugin`. @@ -1619,7 +1619,7 @@ Removes a custom translation parser plugin registered by :ref:`add_translation_p .. rst-class:: classref-method -void **remove_undo_redo_inspector_hook_callback** **(** :ref:`Callable` callable **)** +|void| **remove_undo_redo_inspector_hook_callback**\ (\ callable\: :ref:`Callable`\ ) Removes a callback previously added by :ref:`add_undo_redo_inspector_hook_callback`. @@ -1631,7 +1631,7 @@ Removes a callback previously added by :ref:`add_undo_redo_inspector_hook_callba .. rst-class:: classref-method -void **set_force_draw_over_forwarding_enabled** **(** **)** +|void| **set_force_draw_over_forwarding_enabled**\ (\ ) Enables calling of :ref:`_forward_canvas_force_draw_over_viewport` for the 2D editor and :ref:`_forward_3d_force_draw_over_viewport` for the 3D editor when their viewports are updated. You need to call this method only once and it will work permanently for this plugin. @@ -1643,7 +1643,7 @@ Enables calling of :ref:`_forward_canvas_force_draw_over_viewport`. It might be especially usable if your plugin will want to use raycast in the scene. @@ -1655,7 +1655,7 @@ Use this method if you always want to receive inputs from 3D view screen inside .. rst-class:: classref-method -:ref:`int` **update_overlays** **(** **)** |const| +:ref:`int` **update_overlays**\ (\ ) |const| Updates the overlays of the 2D and 3D editor viewport. Causes methods :ref:`_forward_canvas_draw_over_viewport`, :ref:`_forward_canvas_force_draw_over_viewport`, :ref:`_forward_3d_draw_over_viewport` and :ref:`_forward_3d_force_draw_over_viewport` to be called. @@ -1666,3 +1666,4 @@ Updates the overlays of the 2D and 3D editor viewport. Causes methods :ref:`_for .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index b13bfa3a641..bd1e984007a 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -29,23 +29,21 @@ Properties .. table:: :widths: auto - +-----------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`checkable` | ``false`` | - +-----------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`checked` | ``false`` | - +-----------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`String` | :ref:`configuration_warning` | ``""`` | - +-----------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`deletable` | ``false`` | - +-----------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`draw_warning` | ``false`` | - +-----------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`keying` | ``false`` | - +-----------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`String` | :ref:`label` | ``""`` | - +-----------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`read_only` | ``false`` | - +-----------------------------+-----------------------------------------------------------------------------------+-----------+ + +-----------------------------+-----------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`checkable` | ``false`` | + +-----------------------------+-----------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`checked` | ``false`` | + +-----------------------------+-----------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`deletable` | ``false`` | + +-----------------------------+-----------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`draw_warning` | ``false`` | + +-----------------------------+-----------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`keying` | ``false`` | + +-----------------------------+-----------------------------------------------------------------+-----------+ + | :ref:`String` | :ref:`label` | ``""`` | + +-----------------------------+-----------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`read_only` | ``false`` | + +-----------------------------+-----------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group @@ -55,23 +53,23 @@ Methods .. table:: :widths: auto - +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_read_only` **(** :ref:`bool` read_only **)** |virtual| | - +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_update_property` **(** **)** |virtual| | - +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_focusable` **(** :ref:`Control` control **)** | - +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`emit_changed` **(** :ref:`StringName` property, :ref:`Variant` value, :ref:`StringName` field=&"", :ref:`bool` changing=false **)** | - +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_edited_object` **(** **)** | - +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_edited_property` **(** **)** |const| | - +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bottom_editor` **(** :ref:`Control` editor **)** | - +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`update_property` **(** **)** | - +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_read_only`\ (\ read_only\: :ref:`bool`\ ) |virtual| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_update_property`\ (\ ) |virtual| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_focusable`\ (\ control\: :ref:`Control`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`emit_changed`\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`, field\: :ref:`StringName` = &"", changing\: :ref:`bool` = false\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_edited_object`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_edited_property`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bottom_editor`\ (\ editor\: :ref:`Control`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update_property`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -86,7 +84,7 @@ Signals .. rst-class:: classref-signal -**multiple_properties_changed** **(** :ref:`PackedStringArray` properties, :ref:`Array` value **)** +**multiple_properties_changed**\ (\ properties\: :ref:`PackedStringArray`, value\: :ref:`Array`\ ) Emit it if you want multiple properties modified at the same time. Do not use if added via :ref:`EditorInspectorPlugin._parse_property`. @@ -98,7 +96,7 @@ Emit it if you want multiple properties modified at the same time. Do not use if .. rst-class:: classref-signal -**object_id_selected** **(** :ref:`StringName` property, :ref:`int` id **)** +**object_id_selected**\ (\ property\: :ref:`StringName`, id\: :ref:`int`\ ) Used by sub-inspectors. Emit it if what was selected was an Object ID. @@ -110,7 +108,7 @@ Used by sub-inspectors. Emit it if what was selected was an Object ID. .. rst-class:: classref-signal -**property_can_revert_changed** **(** :ref:`StringName` property, :ref:`bool` can_revert **)** +**property_can_revert_changed**\ (\ property\: :ref:`StringName`, can_revert\: :ref:`bool`\ ) Emitted when the revertability (i.e., whether it has a non-default value and thus is displayed with a revert icon) of a property has changed. @@ -122,7 +120,7 @@ Emitted when the revertability (i.e., whether it has a non-default value and thu .. rst-class:: classref-signal -**property_changed** **(** :ref:`StringName` property, :ref:`Variant` value, :ref:`StringName` field, :ref:`bool` changing **)** +**property_changed**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`, field\: :ref:`StringName`, changing\: :ref:`bool`\ ) Do not emit this manually, use the :ref:`emit_changed` method instead. @@ -134,7 +132,7 @@ Do not emit this manually, use the :ref:`emit_changed` property, :ref:`bool` checked **)** +**property_checked**\ (\ property\: :ref:`StringName`, checked\: :ref:`bool`\ ) Emitted when a property was checked. Used internally. @@ -146,7 +144,7 @@ Emitted when a property was checked. Used internally. .. rst-class:: classref-signal -**property_deleted** **(** :ref:`StringName` property **)** +**property_deleted**\ (\ property\: :ref:`StringName`\ ) Emitted when a property was deleted. Used internally. @@ -158,7 +156,7 @@ Emitted when a property was deleted. Used internally. .. rst-class:: classref-signal -**property_keyed** **(** :ref:`StringName` property **)** +**property_keyed**\ (\ property\: :ref:`StringName`\ ) Emit it if you want to add this value as an animation key (check for keying being enabled first). @@ -170,7 +168,7 @@ Emit it if you want to add this value as an animation key (check for keying bein .. rst-class:: classref-signal -**property_keyed_with_value** **(** :ref:`StringName` property, :ref:`Variant` value **)** +**property_keyed_with_value**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) Emit it if you want to key a property with a single value. @@ -182,7 +180,7 @@ Emit it if you want to key a property with a single value. .. rst-class:: classref-signal -**property_pinned** **(** :ref:`StringName` property, :ref:`bool` pinned **)** +**property_pinned**\ (\ property\: :ref:`StringName`, pinned\: :ref:`bool`\ ) Emit it if you want to mark (or unmark) the value of a property for being saved regardless of being equal to the default value. @@ -196,7 +194,7 @@ The default value is the one the property will get when the node is just instant .. rst-class:: classref-signal -**resource_selected** **(** :ref:`String` path, :ref:`Resource` resource **)** +**resource_selected**\ (\ path\: :ref:`String`, resource\: :ref:`Resource`\ ) If you want a sub-resource to be edited, emit this signal with the resource. @@ -208,7 +206,7 @@ If you want a sub-resource to be edited, emit this signal with the resource. .. rst-class:: classref-signal -**selected** **(** :ref:`String` path, :ref:`int` focusable_idx **)** +**selected**\ (\ path\: :ref:`String`, focusable_idx\: :ref:`int`\ ) Emitted when selected. Used internally. @@ -229,8 +227,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_checkable** **(** :ref:`bool` value **)** -- :ref:`bool` **is_checkable** **(** **)** +- |void| **set_checkable**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_checkable**\ (\ ) Used by the inspector, set to ``true`` when the property is checkable. @@ -246,8 +244,8 @@ Used by the inspector, set to ``true`` when the property is checkable. .. rst-class:: classref-property-setget -- void **set_checked** **(** :ref:`bool` value **)** -- :ref:`bool` **is_checked** **(** **)** +- |void| **set_checked**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_checked**\ (\ ) Used by the inspector, set to ``true`` when the property is checked. @@ -255,23 +253,6 @@ Used by the inspector, set to ``true`` when the property is checked. ---- -.. _class_EditorProperty_property_configuration_warning: - -.. rst-class:: classref-property - -:ref:`String` **configuration_warning** = ``""`` - -.. rst-class:: classref-property-setget - -- void **set_configuration_warning** **(** :ref:`String` value **)** -- :ref:`String` **get_configuration_warning** **(** **)** - -Used by the inspector, set to show a configuration warning on the property. - -.. rst-class:: classref-item-separator - ----- - .. _class_EditorProperty_property_deletable: .. rst-class:: classref-property @@ -280,8 +261,8 @@ Used by the inspector, set to show a configuration warning on the property. .. rst-class:: classref-property-setget -- void **set_deletable** **(** :ref:`bool` value **)** -- :ref:`bool` **is_deletable** **(** **)** +- |void| **set_deletable**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_deletable**\ (\ ) Used by the inspector, set to ``true`` when the property can be deleted by the user. @@ -297,8 +278,8 @@ Used by the inspector, set to ``true`` when the property can be deleted by the u .. rst-class:: classref-property-setget -- void **set_draw_warning** **(** :ref:`bool` value **)** -- :ref:`bool` **is_draw_warning** **(** **)** +- |void| **set_draw_warning**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_draw_warning**\ (\ ) Used by the inspector, set to ``true`` when the property is drawn with the editor theme's warning color. This is used for editable children's properties. @@ -314,8 +295,8 @@ Used by the inspector, set to ``true`` when the property is drawn with the edito .. rst-class:: classref-property-setget -- void **set_keying** **(** :ref:`bool` value **)** -- :ref:`bool` **is_keying** **(** **)** +- |void| **set_keying**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_keying**\ (\ ) Used by the inspector, set to ``true`` when the property can add keys for animation. @@ -331,8 +312,8 @@ Used by the inspector, set to ``true`` when the property can add keys for animat .. rst-class:: classref-property-setget -- void **set_label** **(** :ref:`String` value **)** -- :ref:`String` **get_label** **(** **)** +- |void| **set_label**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_label**\ (\ ) Set this property to change the label (if you want to show one). @@ -348,8 +329,8 @@ Set this property to change the label (if you want to show one). .. rst-class:: classref-property-setget -- void **set_read_only** **(** :ref:`bool` value **)** -- :ref:`bool` **is_read_only** **(** **)** +- |void| **set_read_only**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_read_only**\ (\ ) Used by the inspector, set to ``true`` when the property is read-only. @@ -366,7 +347,7 @@ Method Descriptions .. rst-class:: classref-method -void **_set_read_only** **(** :ref:`bool` read_only **)** |virtual| +|void| **_set_read_only**\ (\ read_only\: :ref:`bool`\ ) |virtual| Called when the read-only status of the property is changed. It may be used to change custom controls into a read-only or modifiable state. @@ -378,7 +359,7 @@ Called when the read-only status of the property is changed. It may be used to c .. rst-class:: classref-method -void **_update_property** **(** **)** |virtual| +|void| **_update_property**\ (\ ) |virtual| When this virtual function is called, you must update your editor. @@ -390,7 +371,7 @@ When this virtual function is called, you must update your editor. .. rst-class:: classref-method -void **add_focusable** **(** :ref:`Control` control **)** +|void| **add_focusable**\ (\ control\: :ref:`Control`\ ) If any of the controls added can gain keyboard focus, add it here. This ensures that focus will be restored if the inspector is refreshed. @@ -402,7 +383,7 @@ If any of the controls added can gain keyboard focus, add it here. This ensures .. rst-class:: classref-method -void **emit_changed** **(** :ref:`StringName` property, :ref:`Variant` value, :ref:`StringName` field=&"", :ref:`bool` changing=false **)** +|void| **emit_changed**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`, field\: :ref:`StringName` = &"", changing\: :ref:`bool` = false\ ) If one or several properties have changed, this must be called. ``field`` is used in case your editor can modify fields separately (as an example, Vector3.x). The ``changing`` argument avoids the editor requesting this property to be refreshed (leave as ``false`` if unsure). @@ -414,7 +395,7 @@ If one or several properties have changed, this must be called. ``field`` is use .. rst-class:: classref-method -:ref:`Object` **get_edited_object** **(** **)** +:ref:`Object` **get_edited_object**\ (\ ) Gets the edited object. @@ -426,7 +407,7 @@ Gets the edited object. .. rst-class:: classref-method -:ref:`StringName` **get_edited_property** **(** **)** |const| +:ref:`StringName` **get_edited_property**\ (\ ) |const| Gets the edited property. If your editor is for a single property (added via :ref:`EditorInspectorPlugin._parse_property`), then this will return the property. @@ -438,7 +419,7 @@ Gets the edited property. If your editor is for a single property (added via :re .. rst-class:: classref-method -void **set_bottom_editor** **(** :ref:`Control` editor **)** +|void| **set_bottom_editor**\ (\ editor\: :ref:`Control`\ ) Puts the ``editor`` control below the property label. The control must be previously added using :ref:`Node.add_child`. @@ -450,7 +431,7 @@ Puts the ``editor`` control below the property label. The control must be previo .. rst-class:: classref-method -void **update_property** **(** **)** +|void| **update_property**\ (\ ) Forces refresh of the property display. @@ -461,3 +442,4 @@ Forces refresh of the property display. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorresourceconversionplugin.rst b/classes/class_editorresourceconversionplugin.rst index 1e92dd2db54..fe0a2193859 100644 --- a/classes/class_editorresourceconversionplugin.rst +++ b/classes/class_editorresourceconversionplugin.rst @@ -53,13 +53,13 @@ Methods .. table:: :widths: auto - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`_convert` **(** :ref:`Resource` resource **)** |virtual| |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_converts_to` **(** **)** |virtual| |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_handles` **(** :ref:`Resource` resource **)** |virtual| |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`_convert`\ (\ resource\: :ref:`Resource`\ ) |virtual| |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_converts_to`\ (\ ) |virtual| |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_handles`\ (\ resource\: :ref:`Resource`\ ) |virtual| |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -74,7 +74,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Resource` **_convert** **(** :ref:`Resource` resource **)** |virtual| |const| +:ref:`Resource` **_convert**\ (\ resource\: :ref:`Resource`\ ) |virtual| |const| Takes an input :ref:`Resource` and converts it to the type given in :ref:`_converts_to`. The returned :ref:`Resource` is the result of the conversion, and the input :ref:`Resource` remains unchanged. @@ -86,7 +86,7 @@ Takes an input :ref:`Resource` and converts it to the type given .. rst-class:: classref-method -:ref:`String` **_converts_to** **(** **)** |virtual| |const| +:ref:`String` **_converts_to**\ (\ ) |virtual| |const| Returns the class name of the target type of :ref:`Resource` that this plugin converts source resources to. @@ -98,7 +98,7 @@ Returns the class name of the target type of :ref:`Resource` tha .. rst-class:: classref-method -:ref:`bool` **_handles** **(** :ref:`Resource` resource **)** |virtual| |const| +:ref:`bool` **_handles**\ (\ resource\: :ref:`Resource`\ ) |virtual| |const| Called to determine whether a particular :ref:`Resource` can be converted to the target resource type by this plugin. @@ -109,3 +109,4 @@ Called to determine whether a particular :ref:`Resource` can be .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorresourcepicker.rst b/classes/class_editorresourcepicker.rst index 5dd997b6a5e..07fc27240e2 100644 --- a/classes/class_editorresourcepicker.rst +++ b/classes/class_editorresourcepicker.rst @@ -51,15 +51,15 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_handle_menu_selected` **(** :ref:`int` id **)** |virtual| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_create_options` **(** :ref:`Object` menu_node **)** |virtual| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_allowed_types` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_toggle_pressed` **(** :ref:`bool` pressed **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_handle_menu_selected`\ (\ id\: :ref:`int`\ ) |virtual| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_create_options`\ (\ menu_node\: :ref:`Object`\ ) |virtual| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_allowed_types`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_toggle_pressed`\ (\ pressed\: :ref:`bool`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -74,7 +74,7 @@ Signals .. rst-class:: classref-signal -**resource_changed** **(** :ref:`Resource` resource **)** +**resource_changed**\ (\ resource\: :ref:`Resource`\ ) Emitted when the value of the edited resource was changed. @@ -86,7 +86,7 @@ Emitted when the value of the edited resource was changed. .. rst-class:: classref-signal -**resource_selected** **(** :ref:`Resource` resource, :ref:`bool` inspect **)** +**resource_selected**\ (\ resource\: :ref:`Resource`, inspect\: :ref:`bool`\ ) Emitted when the resource value was set and user clicked to edit it. When ``inspect`` is ``true``, the signal was caused by the context menu "Edit" or "Inspect" option. @@ -107,8 +107,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_base_type** **(** :ref:`String` value **)** -- :ref:`String` **get_base_type** **(** **)** +- |void| **set_base_type**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_base_type**\ (\ ) The base type of allowed resource types. Can be a comma-separated list of several options. @@ -124,8 +124,8 @@ The base type of allowed resource types. Can be a comma-separated list of severa .. rst-class:: classref-property-setget -- void **set_editable** **(** :ref:`bool` value **)** -- :ref:`bool` **is_editable** **(** **)** +- |void| **set_editable**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_editable**\ (\ ) If ``true``, the value can be selected and edited. @@ -141,8 +141,8 @@ If ``true``, the value can be selected and edited. .. rst-class:: classref-property-setget -- void **set_edited_resource** **(** :ref:`Resource` value **)** -- :ref:`Resource` **get_edited_resource** **(** **)** +- |void| **set_edited_resource**\ (\ value\: :ref:`Resource`\ ) +- :ref:`Resource` **get_edited_resource**\ (\ ) The edited resource value. @@ -158,8 +158,8 @@ The edited resource value. .. rst-class:: classref-property-setget -- void **set_toggle_mode** **(** :ref:`bool` value **)** -- :ref:`bool` **is_toggle_mode** **(** **)** +- |void| **set_toggle_mode**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_toggle_mode**\ (\ ) If ``true``, the main button with the resource preview works in the toggle mode. Use :ref:`set_toggle_pressed` to manually set the state. @@ -176,7 +176,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_handle_menu_selected** **(** :ref:`int` id **)** |virtual| +:ref:`bool` **_handle_menu_selected**\ (\ id\: :ref:`int`\ ) |virtual| This virtual method can be implemented to handle context menu items not handled by default. See :ref:`_set_create_options`. @@ -188,7 +188,7 @@ This virtual method can be implemented to handle context menu items not handled .. rst-class:: classref-method -void **_set_create_options** **(** :ref:`Object` menu_node **)** |virtual| +|void| **_set_create_options**\ (\ menu_node\: :ref:`Object`\ ) |virtual| This virtual method is called when updating the context menu of **EditorResourcePicker**. Implement this method to override the "New ..." items with your own options. ``menu_node`` is a reference to the :ref:`PopupMenu` node. @@ -202,7 +202,7 @@ This virtual method is called when updating the context menu of **EditorResource .. rst-class:: classref-method -:ref:`PackedStringArray` **get_allowed_types** **(** **)** |const| +:ref:`PackedStringArray` **get_allowed_types**\ (\ ) |const| Returns a list of all allowed types and subtypes corresponding to the :ref:`base_type`. If the :ref:`base_type` is empty, an empty list is returned. @@ -214,7 +214,7 @@ Returns a list of all allowed types and subtypes corresponding to the :ref:`base .. rst-class:: classref-method -void **set_toggle_pressed** **(** :ref:`bool` pressed **)** +|void| **set_toggle_pressed**\ (\ pressed\: :ref:`bool`\ ) Sets the toggle mode state for the main button. Works only if :ref:`toggle_mode` is set to ``true``. @@ -225,3 +225,4 @@ Sets the toggle mode state for the main button. Works only if :ref:`toggle_mode< .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorresourcepreview.rst b/classes/class_editorresourcepreview.rst index 71ca8f376e2..0fc53aca50b 100644 --- a/classes/class_editorresourcepreview.rst +++ b/classes/class_editorresourcepreview.rst @@ -31,17 +31,17 @@ Methods .. table:: :widths: auto - +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | - +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`check_for_invalidation` **(** :ref:`String` path **)** | - +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`queue_edited_resource_preview` **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`StringName` receiver_func, :ref:`Variant` userdata **)** | - +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`queue_resource_preview` **(** :ref:`String` path, :ref:`Object` receiver, :ref:`StringName` receiver_func, :ref:`Variant` userdata **)** | - +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | - +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_preview_generator`\ (\ generator\: :ref:`EditorResourcePreviewGenerator`\ ) | + +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`check_for_invalidation`\ (\ path\: :ref:`String`\ ) | + +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`queue_edited_resource_preview`\ (\ resource\: :ref:`Resource`, receiver\: :ref:`Object`, receiver_func\: :ref:`StringName`, userdata\: :ref:`Variant`\ ) | + +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`queue_resource_preview`\ (\ path\: :ref:`String`, receiver\: :ref:`Object`, receiver_func\: :ref:`StringName`, userdata\: :ref:`Variant`\ ) | + +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_preview_generator`\ (\ generator\: :ref:`EditorResourcePreviewGenerator`\ ) | + +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -56,7 +56,7 @@ Signals .. rst-class:: classref-signal -**preview_invalidated** **(** :ref:`String` path **)** +**preview_invalidated**\ (\ path\: :ref:`String`\ ) Emitted if a preview was invalidated (changed). ``path`` corresponds to the path of the preview. @@ -73,7 +73,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** +|void| **add_preview_generator**\ (\ generator\: :ref:`EditorResourcePreviewGenerator`\ ) Create an own, custom preview generator. @@ -85,7 +85,7 @@ Create an own, custom preview generator. .. rst-class:: classref-method -void **check_for_invalidation** **(** :ref:`String` path **)** +|void| **check_for_invalidation**\ (\ path\: :ref:`String`\ ) Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted. @@ -97,7 +97,7 @@ Check if the resource changed, if so, it will be invalidated and the correspondi .. rst-class:: classref-method -void **queue_edited_resource_preview** **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`StringName` receiver_func, :ref:`Variant` userdata **)** +|void| **queue_edited_resource_preview**\ (\ resource\: :ref:`Resource`, receiver\: :ref:`Object`, receiver_func\: :ref:`StringName`, userdata\: :ref:`Variant`\ ) Queue the ``resource`` being edited for preview. Once the preview is ready, the ``receiver``'s ``receiver_func`` will be called. The ``receiver_func`` must take the following four arguments: :ref:`String` path, :ref:`Texture2D` preview, :ref:`Texture2D` thumbnail_preview, :ref:`Variant` userdata. ``userdata`` can be anything, and will be returned when ``receiver_func`` is called. @@ -111,7 +111,7 @@ Queue the ``resource`` being edited for preview. Once the preview is ready, the .. rst-class:: classref-method -void **queue_resource_preview** **(** :ref:`String` path, :ref:`Object` receiver, :ref:`StringName` receiver_func, :ref:`Variant` userdata **)** +|void| **queue_resource_preview**\ (\ path\: :ref:`String`, receiver\: :ref:`Object`, receiver_func\: :ref:`StringName`, userdata\: :ref:`Variant`\ ) Queue a resource file located at ``path`` for preview. Once the preview is ready, the ``receiver``'s ``receiver_func`` will be called. The ``receiver_func`` must take the following four arguments: :ref:`String` path, :ref:`Texture2D` preview, :ref:`Texture2D` thumbnail_preview, :ref:`Variant` userdata. ``userdata`` can be anything, and will be returned when ``receiver_func`` is called. @@ -125,7 +125,7 @@ Queue a resource file located at ``path`` for preview. Once the preview is ready .. rst-class:: classref-method -void **remove_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** +|void| **remove_preview_generator**\ (\ generator\: :ref:`EditorResourcePreviewGenerator`\ ) Removes a custom preview generator. @@ -136,3 +136,4 @@ Removes a custom preview generator. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorresourcepreviewgenerator.rst b/classes/class_editorresourcepreviewgenerator.rst index 88db86c8e57..42178b67ab0 100644 --- a/classes/class_editorresourcepreviewgenerator.rst +++ b/classes/class_editorresourcepreviewgenerator.rst @@ -29,17 +29,17 @@ Methods .. table:: :widths: auto - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_can_generate_small_preview` **(** **)** |virtual| |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`_generate` **(** :ref:`Resource` resource, :ref:`Vector2i` size, :ref:`Dictionary` metadata **)** |virtual| |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`_generate_from_path` **(** :ref:`String` path, :ref:`Vector2i` size, :ref:`Dictionary` metadata **)** |virtual| |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_generate_small_preview_automatically` **(** **)** |virtual| |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_handles` **(** :ref:`String` type **)** |virtual| |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_can_generate_small_preview`\ (\ ) |virtual| |const| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`_generate`\ (\ resource\: :ref:`Resource`, size\: :ref:`Vector2i`, metadata\: :ref:`Dictionary`\ ) |virtual| |const| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`_generate_from_path`\ (\ path\: :ref:`String`, size\: :ref:`Vector2i`, metadata\: :ref:`Dictionary`\ ) |virtual| |const| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_generate_small_preview_automatically`\ (\ ) |virtual| |const| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_handles`\ (\ type\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -54,7 +54,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_can_generate_small_preview** **(** **)** |virtual| |const| +:ref:`bool` **_can_generate_small_preview**\ (\ ) |virtual| |const| If this function returns ``true``, the generator will call :ref:`_generate` or :ref:`_generate_from_path` for small previews as well. @@ -68,7 +68,7 @@ By default, it returns ``false``. .. rst-class:: classref-method -:ref:`Texture2D` **_generate** **(** :ref:`Resource` resource, :ref:`Vector2i` size, :ref:`Dictionary` metadata **)** |virtual| |const| +:ref:`Texture2D` **_generate**\ (\ resource\: :ref:`Resource`, size\: :ref:`Vector2i`, metadata\: :ref:`Dictionary`\ ) |virtual| |const| Generate a preview from a given resource with the specified size. This must always be implemented. @@ -86,7 +86,7 @@ Care must be taken because this function is always called from a thread (not the .. rst-class:: classref-method -:ref:`Texture2D` **_generate_from_path** **(** :ref:`String` path, :ref:`Vector2i` size, :ref:`Dictionary` metadata **)** |virtual| |const| +:ref:`Texture2D` **_generate_from_path**\ (\ path\: :ref:`String`, size\: :ref:`Vector2i`, metadata\: :ref:`Dictionary`\ ) |virtual| |const| Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call :ref:`_generate`. @@ -104,7 +104,7 @@ Care must be taken because this function is always called from a thread (not the .. rst-class:: classref-method -:ref:`bool` **_generate_small_preview_automatically** **(** **)** |virtual| |const| +:ref:`bool` **_generate_small_preview_automatically**\ (\ ) |virtual| |const| If this function returns ``true``, the generator will automatically generate the small previews from the normal preview texture generated by the methods :ref:`_generate` or :ref:`_generate_from_path`. @@ -118,7 +118,7 @@ By default, it returns ``false``. .. rst-class:: classref-method -:ref:`bool` **_handles** **(** :ref:`String` type **)** |virtual| |const| +:ref:`bool` **_handles**\ (\ type\: :ref:`String`\ ) |virtual| |const| Returns ``true`` if your generator supports the resource of type ``type``. @@ -129,3 +129,4 @@ Returns ``true`` if your generator supports the resource of type ``type``. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorresourcetooltipplugin.rst b/classes/class_editorresourcetooltipplugin.rst index 0acf9d46c24..898acf34667 100644 --- a/classes/class_editorresourcetooltipplugin.rst +++ b/classes/class_editorresourcetooltipplugin.rst @@ -31,13 +31,13 @@ Methods .. table:: :widths: auto - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_handles` **(** :ref:`String` type **)** |virtual| |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Control` | :ref:`_make_tooltip_for_path` **(** :ref:`String` path, :ref:`Dictionary` metadata, :ref:`Control` base **)** |virtual| |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`request_thumbnail` **(** :ref:`String` path, :ref:`TextureRect` control **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_handles`\ (\ type\: :ref:`String`\ ) |virtual| |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Control` | :ref:`_make_tooltip_for_path`\ (\ path\: :ref:`String`, metadata\: :ref:`Dictionary`, base\: :ref:`Control`\ ) |virtual| |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`request_thumbnail`\ (\ path\: :ref:`String`, control\: :ref:`TextureRect`\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -52,7 +52,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_handles** **(** :ref:`String` type **)** |virtual| |const| +:ref:`bool` **_handles**\ (\ type\: :ref:`String`\ ) |virtual| |const| Return ``true`` if the plugin is going to handle the given :ref:`Resource` ``type``. @@ -64,7 +64,7 @@ Return ``true`` if the plugin is going to handle the given :ref:`Resource` **_make_tooltip_for_path** **(** :ref:`String` path, :ref:`Dictionary` metadata, :ref:`Control` base **)** |virtual| |const| +:ref:`Control` **_make_tooltip_for_path**\ (\ path\: :ref:`String`, metadata\: :ref:`Dictionary`, base\: :ref:`Control`\ ) |virtual| |const| Create and return a tooltip that will be displayed when the user hovers a resource under the given ``path`` in filesystem dock. @@ -92,7 +92,7 @@ The ``metadata`` dictionary is provided by preview generator (see :ref:`EditorRe .. rst-class:: classref-method -void **request_thumbnail** **(** :ref:`String` path, :ref:`TextureRect` control **)** |const| +|void| **request_thumbnail**\ (\ path\: :ref:`String`, control\: :ref:`TextureRect`\ ) |const| Requests a thumbnail for the given :ref:`TextureRect`. The thumbnail is created asynchronously by :ref:`EditorResourcePreview` and automatically set when available. @@ -103,3 +103,4 @@ Requests a thumbnail for the given :ref:`TextureRect`. The th .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorsceneformatimporter.rst b/classes/class_editorsceneformatimporter.rst index 73b7b0fdf03..854f77145b7 100644 --- a/classes/class_editorsceneformatimporter.rst +++ b/classes/class_editorsceneformatimporter.rst @@ -12,7 +12,7 @@ EditorSceneFormatImporter **Inherits:** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`EditorSceneFormatImporterBlend`, :ref:`EditorSceneFormatImporterFBX`, :ref:`EditorSceneFormatImporterGLTF` +**Inherited By:** :ref:`EditorSceneFormatImporterBlend`, :ref:`EditorSceneFormatImporterFBX2GLTF`, :ref:`EditorSceneFormatImporterGLTF`, :ref:`EditorSceneFormatImporterUFBX` Imports scenes from third-parties' 3D files. @@ -33,17 +33,17 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_extensions` **(** **)** |virtual| |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_import_flags` **(** **)** |virtual| |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_get_import_options` **(** :ref:`String` path **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_option_visibility` **(** :ref:`String` path, :ref:`bool` for_animation, :ref:`String` option **)** |virtual| |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`_import_scene` **(** :ref:`String` path, :ref:`int` flags, :ref:`Dictionary` options **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_extensions`\ (\ ) |virtual| |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_import_flags`\ (\ ) |virtual| |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_get_import_options`\ (\ path\: :ref:`String`\ ) |virtual| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_option_visibility`\ (\ path\: :ref:`String`, for_animation\: :ref:`bool`, option\: :ref:`String`\ ) |virtual| |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`_import_scene`\ (\ path\: :ref:`String`, flags\: :ref:`int`, options\: :ref:`Dictionary`\ ) |virtual| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -151,7 +151,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_extensions** **(** **)** |virtual| |const| +:ref:`PackedStringArray` **_get_extensions**\ (\ ) |virtual| |const| .. container:: contribute @@ -165,7 +165,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_import_flags** **(** **)** |virtual| |const| +:ref:`int` **_get_import_flags**\ (\ ) |virtual| |const| .. container:: contribute @@ -179,7 +179,7 @@ Method Descriptions .. rst-class:: classref-method -void **_get_import_options** **(** :ref:`String` path **)** |virtual| +|void| **_get_import_options**\ (\ path\: :ref:`String`\ ) |virtual| .. container:: contribute @@ -193,7 +193,7 @@ void **_get_import_options** **(** :ref:`String` path **)** |virtu .. rst-class:: classref-method -:ref:`Variant` **_get_option_visibility** **(** :ref:`String` path, :ref:`bool` for_animation, :ref:`String` option **)** |virtual| |const| +:ref:`Variant` **_get_option_visibility**\ (\ path\: :ref:`String`, for_animation\: :ref:`bool`, option\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -207,7 +207,7 @@ void **_get_import_options** **(** :ref:`String` path **)** |virtu .. rst-class:: classref-method -:ref:`Object` **_import_scene** **(** :ref:`String` path, :ref:`int` flags, :ref:`Dictionary` options **)** |virtual| +:ref:`Object` **_import_scene**\ (\ path\: :ref:`String`, flags\: :ref:`int`, options\: :ref:`Dictionary`\ ) |virtual| .. container:: contribute @@ -220,3 +220,4 @@ void **_get_import_options** **(** :ref:`String` path **)** |virtu .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorsceneformatimporterblend.rst b/classes/class_editorsceneformatimporterblend.rst index aa111436f36..8ca766ca3a8 100644 --- a/classes/class_editorsceneformatimporterblend.rst +++ b/classes/class_editorsceneformatimporterblend.rst @@ -36,3 +36,4 @@ Internally, the EditorSceneFormatImporterBlend uses the Blender glTF "Use Origin .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorsceneformatimporterfbx.rst b/classes/class_editorsceneformatimporterfbx2gltf.rst similarity index 73% rename from classes/class_editorsceneformatimporterfbx.rst rename to classes/class_editorsceneformatimporterfbx2gltf.rst index d1ad78a1df3..73d94cf05f7 100644 --- a/classes/class_editorsceneformatimporterfbx.rst +++ b/classes/class_editorsceneformatimporterfbx2gltf.rst @@ -3,12 +3,12 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot 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. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/fbx/doc_classes/EditorSceneFormatImporterFBX2GLTF.xml. -.. _class_EditorSceneFormatImporterFBX: +.. _class_EditorSceneFormatImporterFBX2GLTF: -EditorSceneFormatImporterFBX -============================ +EditorSceneFormatImporterFBX2GLTF +================================= **Inherits:** :ref:`EditorSceneFormatImporter` **<** :ref:`RefCounted` **<** :ref:`Object` @@ -21,9 +21,9 @@ Description Imports Autodesk FBX 3D scenes by way of converting them to glTF 2.0 using the FBX2glTF command line tool. -The location of the FBX2glTF binary is set via the ``filesystem/import/fbx/fbx2gltf_path`` editor setting. +The location of the FBX2glTF binary is set via the :ref:`EditorSettings.filesystem/import/fbx2gltf/fbx2gltf_path` editor setting. -This importer is only used if :ref:`ProjectSettings.filesystem/import/fbx/enabled` is enabled, otherwise ``.fbx`` files present in the project folder are not imported. +This importer is only used if :ref:`ProjectSettings.filesystem/import/fbx2gltf/enabled` is set to ``true``. .. |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.)` @@ -32,3 +32,4 @@ This importer is only used if :ref:`ProjectSettings.filesystem/import/fbx/enable .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorsceneformatimportergltf.rst b/classes/class_editorsceneformatimportergltf.rst index ff958808b8d..abe92291421 100644 --- a/classes/class_editorsceneformatimportergltf.rst +++ b/classes/class_editorsceneformatimportergltf.rst @@ -23,3 +23,4 @@ EditorSceneFormatImporterGLTF .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorsceneformatimporterufbx.rst b/classes/class_editorsceneformatimporterufbx.rst new file mode 100644 index 00000000000..618ecfb9c26 --- /dev/null +++ b/classes/class_editorsceneformatimporterufbx.rst @@ -0,0 +1,33 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot 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/fbx/doc_classes/EditorSceneFormatImporterUFBX.xml. + +.. _class_EditorSceneFormatImporterUFBX: + +EditorSceneFormatImporterUFBX +============================= + +**Experimental:** This class may be changed or removed in future versions. + +**Inherits:** :ref:`EditorSceneFormatImporter` **<** :ref:`RefCounted` **<** :ref:`Object` + +Import FBX files using the ufbx library. + +.. rst-class:: classref-introduction-group + +Description +----------- + +EditorSceneFormatImporterUFBX is designed to load FBX files and supports both binary and ASCII FBX files from version 3000 onward. This class supports various 3D object types like meshes, skins, blend shapes, materials, and rigging information. The class aims for feature parity with the official FBX SDK and supports FBX 7.4 specifications. + +.. |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.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorscenepostimport.rst b/classes/class_editorscenepostimport.rst index 85ef31deb25..a046ed08396 100644 --- a/classes/class_editorscenepostimport.rst +++ b/classes/class_editorscenepostimport.rst @@ -90,11 +90,11 @@ Methods .. table:: :widths: auto - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`_post_import` **(** :ref:`Node` scene **)** |virtual| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_source_file` **(** **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`_post_import`\ (\ scene\: :ref:`Node`\ ) |virtual| | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_source_file`\ (\ ) |const| | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -109,7 +109,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Object` **_post_import** **(** :ref:`Node` scene **)** |virtual| +:ref:`Object` **_post_import**\ (\ scene\: :ref:`Node`\ ) |virtual| Called after the scene was imported. This method must return the modified version of the scene. @@ -121,7 +121,7 @@ Called after the scene was imported. This method must return the modified versio .. rst-class:: classref-method -:ref:`String` **get_source_file** **(** **)** |const| +:ref:`String` **get_source_file**\ (\ ) |const| Returns the source file path which got imported (e.g. ``res://scene.dae``). @@ -132,3 +132,4 @@ Returns the source file path which got imported (e.g. ``res://scene.dae``). .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorscenepostimportplugin.rst b/classes/class_editorscenepostimportplugin.rst index 0e6148ff7a8..c14641d7695 100644 --- a/classes/class_editorscenepostimportplugin.rst +++ b/classes/class_editorscenepostimportplugin.rst @@ -29,29 +29,29 @@ Methods .. table:: :widths: auto - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_get_import_options` **(** :ref:`String` path **)** |virtual| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_get_internal_import_options` **(** :ref:`int` category **)** |virtual| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_internal_option_update_view_required` **(** :ref:`int` category, :ref:`String` option **)** |virtual| |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_internal_option_visibility` **(** :ref:`int` category, :ref:`bool` for_animation, :ref:`String` option **)** |virtual| |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_option_visibility` **(** :ref:`String` path, :ref:`bool` for_animation, :ref:`String` option **)** |virtual| |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_internal_process` **(** :ref:`int` category, :ref:`Node` base_node, :ref:`Node` node, :ref:`Resource` resource **)** |virtual| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_post_process` **(** :ref:`Node` scene **)** |virtual| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_pre_process` **(** :ref:`Node` scene **)** |virtual| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_import_option` **(** :ref:`String` name, :ref:`Variant` value **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_import_option_advanced` **(** :ref:`Variant.Type` type, :ref:`String` name, :ref:`Variant` default_value, :ref:`PropertyHint` hint=0, :ref:`String` hint_string="", :ref:`int` usage_flags=6 **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_option_value` **(** :ref:`StringName` name **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_get_import_options`\ (\ path\: :ref:`String`\ ) |virtual| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_get_internal_import_options`\ (\ category\: :ref:`int`\ ) |virtual| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_internal_option_update_view_required`\ (\ category\: :ref:`int`, option\: :ref:`String`\ ) |virtual| |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_internal_option_visibility`\ (\ category\: :ref:`int`, for_animation\: :ref:`bool`, option\: :ref:`String`\ ) |virtual| |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_option_visibility`\ (\ path\: :ref:`String`, for_animation\: :ref:`bool`, option\: :ref:`String`\ ) |virtual| |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_internal_process`\ (\ category\: :ref:`int`, base_node\: :ref:`Node`, node\: :ref:`Node`, resource\: :ref:`Resource`\ ) |virtual| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_post_process`\ (\ scene\: :ref:`Node`\ ) |virtual| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_pre_process`\ (\ scene\: :ref:`Node`\ ) |virtual| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_import_option`\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_import_option_advanced`\ (\ type\: :ref:`Variant.Type`, name\: :ref:`String`, default_value\: :ref:`Variant`, hint\: :ref:`PropertyHint` = 0, hint_string\: :ref:`String` = "", usage_flags\: :ref:`int` = 6\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_option_value`\ (\ name\: :ref:`StringName`\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -177,7 +177,7 @@ Method Descriptions .. rst-class:: classref-method -void **_get_import_options** **(** :ref:`String` path **)** |virtual| +|void| **_get_import_options**\ (\ path\: :ref:`String`\ ) |virtual| Override to add general import options. These will appear in the main import dock on the editor. Add options via :ref:`add_import_option` and :ref:`add_import_option_advanced`. @@ -189,7 +189,7 @@ Override to add general import options. These will appear in the main import doc .. rst-class:: classref-method -void **_get_internal_import_options** **(** :ref:`int` category **)** |virtual| +|void| **_get_internal_import_options**\ (\ category\: :ref:`int`\ ) |virtual| Override to add internal import options. These will appear in the 3D scene import dialog. Add options via :ref:`add_import_option` and :ref:`add_import_option_advanced`. @@ -201,7 +201,7 @@ Override to add internal import options. These will appear in the 3D scene impor .. rst-class:: classref-method -:ref:`Variant` **_get_internal_option_update_view_required** **(** :ref:`int` category, :ref:`String` option **)** |virtual| |const| +:ref:`Variant` **_get_internal_option_update_view_required**\ (\ category\: :ref:`int`, option\: :ref:`String`\ ) |virtual| |const| Return true whether updating the 3D view of the import dialog needs to be updated if an option has changed. @@ -213,7 +213,7 @@ Return true whether updating the 3D view of the import dialog needs to be update .. rst-class:: classref-method -:ref:`Variant` **_get_internal_option_visibility** **(** :ref:`int` category, :ref:`bool` for_animation, :ref:`String` option **)** |virtual| |const| +:ref:`Variant` **_get_internal_option_visibility**\ (\ category\: :ref:`int`, for_animation\: :ref:`bool`, option\: :ref:`String`\ ) |virtual| |const| Return true or false whether a given option should be visible. Return null to ignore. @@ -225,7 +225,7 @@ Return true or false whether a given option should be visible. Return null to ig .. rst-class:: classref-method -:ref:`Variant` **_get_option_visibility** **(** :ref:`String` path, :ref:`bool` for_animation, :ref:`String` option **)** |virtual| |const| +:ref:`Variant` **_get_option_visibility**\ (\ path\: :ref:`String`, for_animation\: :ref:`bool`, option\: :ref:`String`\ ) |virtual| |const| Return true or false whether a given option should be visible. Return null to ignore. @@ -237,7 +237,7 @@ Return true or false whether a given option should be visible. Return null to ig .. rst-class:: classref-method -void **_internal_process** **(** :ref:`int` category, :ref:`Node` base_node, :ref:`Node` node, :ref:`Resource` resource **)** |virtual| +|void| **_internal_process**\ (\ category\: :ref:`int`, base_node\: :ref:`Node`, node\: :ref:`Node`, resource\: :ref:`Resource`\ ) |virtual| Process a specific node or resource for a given category. @@ -249,7 +249,7 @@ Process a specific node or resource for a given category. .. rst-class:: classref-method -void **_post_process** **(** :ref:`Node` scene **)** |virtual| +|void| **_post_process**\ (\ scene\: :ref:`Node`\ ) |virtual| Post process the scene. This function is called after the final scene has been configured. @@ -261,7 +261,7 @@ Post process the scene. This function is called after the final scene has been c .. rst-class:: classref-method -void **_pre_process** **(** :ref:`Node` scene **)** |virtual| +|void| **_pre_process**\ (\ scene\: :ref:`Node`\ ) |virtual| Pre Process the scene. This function is called right after the scene format loader loaded the scene and no changes have been made. @@ -273,7 +273,7 @@ Pre Process the scene. This function is called right after the scene format load .. rst-class:: classref-method -void **add_import_option** **(** :ref:`String` name, :ref:`Variant` value **)** +|void| **add_import_option**\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) Add a specific import option (name and default value only). This function can only be called from :ref:`_get_import_options` and :ref:`_get_internal_import_options`. @@ -285,7 +285,7 @@ Add a specific import option (name and default value only). This function can on .. rst-class:: classref-method -void **add_import_option_advanced** **(** :ref:`Variant.Type` type, :ref:`String` name, :ref:`Variant` default_value, :ref:`PropertyHint` hint=0, :ref:`String` hint_string="", :ref:`int` usage_flags=6 **)** +|void| **add_import_option_advanced**\ (\ type\: :ref:`Variant.Type`, name\: :ref:`String`, default_value\: :ref:`Variant`, hint\: :ref:`PropertyHint` = 0, hint_string\: :ref:`String` = "", usage_flags\: :ref:`int` = 6\ ) Add a specific import option. This function can only be called from :ref:`_get_import_options` and :ref:`_get_internal_import_options`. @@ -297,7 +297,7 @@ Add a specific import option. This function can only be called from :ref:`_get_i .. rst-class:: classref-method -:ref:`Variant` **get_option_value** **(** :ref:`StringName` name **)** |const| +:ref:`Variant` **get_option_value**\ (\ name\: :ref:`StringName`\ ) |const| Query the value of an option. This function can only be called from those querying visibility, or processing. @@ -308,3 +308,4 @@ Query the value of an option. This function can only be called from those queryi .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index c234e3e11e9..126ebab5a63 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -63,15 +63,15 @@ Methods .. table:: :widths: auto - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------+ - | void | :ref:`_run` **(** **)** |virtual| | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_root_node` **(** :ref:`Node` node **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------+ - | :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** |const| | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`get_scene` **(** **)** |const| | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_run`\ (\ ) |virtual| | + +-----------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_root_node`\ (\ node\: :ref:`Node`\ ) | + +-----------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | :ref:`EditorInterface` | :ref:`get_editor_interface`\ (\ ) |const| | + +-----------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`get_scene`\ (\ ) |const| | + +-----------------------------------------------+-----------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -86,7 +86,7 @@ Method Descriptions .. rst-class:: classref-method -void **_run** **(** **)** |virtual| +|void| **_run**\ (\ ) |virtual| This method is executed by the Editor when **File > Run** is used. @@ -98,7 +98,7 @@ This method is executed by the Editor when **File > Run** is used. .. rst-class:: classref-method -void **add_root_node** **(** :ref:`Node` node **)** +|void| **add_root_node**\ (\ node\: :ref:`Node`\ ) Adds ``node`` as a child of the root node in the editor context. @@ -112,7 +112,7 @@ Adds ``node`` as a child of the root node in the editor context. .. rst-class:: classref-method -:ref:`EditorInterface` **get_editor_interface** **(** **)** |const| +:ref:`EditorInterface` **get_editor_interface**\ (\ ) |const| **Deprecated:** :ref:`EditorInterface` is a global singleton and can be accessed directly by its name. @@ -126,7 +126,7 @@ Returns the :ref:`EditorInterface` singleton instance. .. rst-class:: classref-method -:ref:`Node` **get_scene** **(** **)** |const| +:ref:`Node` **get_scene**\ (\ ) |const| Returns the Editor's currently active scene. @@ -137,3 +137,4 @@ Returns the Editor's currently active scene. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorscriptpicker.rst b/classes/class_editorscriptpicker.rst index 860aff9d366..4564a557a5f 100644 --- a/classes/class_editorscriptpicker.rst +++ b/classes/class_editorscriptpicker.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_script_owner** **(** :ref:`Node` value **)** -- :ref:`Node` **get_script_owner** **(** **)** +- |void| **set_script_owner**\ (\ value\: :ref:`Node`\ ) +- :ref:`Node` **get_script_owner**\ (\ ) The owner :ref:`Node` of the script property that holds the edited resource. @@ -64,3 +64,4 @@ The owner :ref:`Node` of the script property that holds the edited r .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorselection.rst b/classes/class_editorselection.rst index 4d328222480..b5cf07e2ea0 100644 --- a/classes/class_editorselection.rst +++ b/classes/class_editorselection.rst @@ -31,17 +31,17 @@ Methods .. table:: :widths: auto - +---------------------------+--------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_node` **(** :ref:`Node` node **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node[]` | :ref:`get_selected_nodes` **(** **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node[]` | :ref:`get_transformable_selected_nodes` **(** **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_node` **(** :ref:`Node` node **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_node`\ (\ node\: :ref:`Node`\ ) | + +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Node`\] | :ref:`get_selected_nodes`\ (\ ) | + +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Node`\] | :ref:`get_transformable_selected_nodes`\ (\ ) | + +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_node`\ (\ node\: :ref:`Node`\ ) | + +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -56,7 +56,7 @@ Signals .. rst-class:: classref-signal -**selection_changed** **(** **)** +**selection_changed**\ (\ ) Emitted when the selection changes. @@ -73,7 +73,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_node** **(** :ref:`Node` node **)** +|void| **add_node**\ (\ node\: :ref:`Node`\ ) Adds a node to the selection. @@ -87,7 +87,7 @@ Adds a node to the selection. .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clear the selection. @@ -99,7 +99,7 @@ Clear the selection. .. rst-class:: classref-method -:ref:`Node[]` **get_selected_nodes** **(** **)** +:ref:`Array`\[:ref:`Node`\] **get_selected_nodes**\ (\ ) Gets the list of selected nodes. @@ -111,7 +111,7 @@ Gets the list of selected nodes. .. rst-class:: classref-method -:ref:`Node[]` **get_transformable_selected_nodes** **(** **)** +:ref:`Array`\[:ref:`Node`\] **get_transformable_selected_nodes**\ (\ ) Gets the list of selected nodes, optimized for transform operations (i.e. moving them, rotating, etc). This list avoids situations where a node is selected and also child/grandchild. @@ -123,7 +123,7 @@ Gets the list of selected nodes, optimized for transform operations (i.e. moving .. rst-class:: classref-method -void **remove_node** **(** :ref:`Node` node **)** +|void| **remove_node**\ (\ node\: :ref:`Node`\ ) Removes a node from the selection. @@ -134,3 +134,4 @@ Removes a node from the selection. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 75a12fd7946..d0f361addb6 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -58,541 +58,613 @@ Properties .. table:: :widths: auto - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debugger/auto_switch_to_remote_scene_tree` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debugger/profile_native_calls` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`debugger/profiler_frame_history_size` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`debugger/profiler_frame_max_functions` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`debugger/remote_inspect_refresh_interval` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`debugger/remote_scene_tree_refresh_interval` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`docks/filesystem/always_show_folders` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`docks/filesystem/textfile_extensions` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`docks/filesystem/thumbnail_size` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`docks/property_editor/auto_refresh_interval` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`docks/property_editor/subresource_hue_tint` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`docks/scene_tree/auto_expand_to_selected` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`docks/scene_tree/center_node_on_reparent` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`docks/scene_tree/start_create_dialog_fully_expanded` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/2d/bone_color1` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/2d/bone_color2` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/2d/bone_ik_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/2d/bone_outline_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/2d/bone_outline_size` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/2d/bone_selected_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/2d/bone_width` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/2d/grid_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/2d/guides_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/2d/smart_snapping_line_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/2d/use_integer_zoom_by_default` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/2d/viewport_border_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/default_fov` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/default_z_far` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/default_z_near` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/freelook/freelook_activation_modifier` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/freelook/freelook_base_speed` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/freelook/freelook_inertia` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/freelook/freelook_navigation_scheme` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/freelook/freelook_sensitivity` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/3d/freelook/freelook_speed_zoom_link` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/grid_division_level_bias` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/grid_division_level_max` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/grid_division_level_min` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/grid_size` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/3d/grid_xy_plane` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/3d/grid_xz_plane` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/3d/grid_yz_plane` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/3d/navigation/emulate_3_button_mouse` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/3d/navigation/emulate_numpad` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/3d/navigation/invert_x_axis` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/3d/navigation/invert_y_axis` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/navigation/navigation_scheme` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/navigation/orbit_modifier` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/navigation/pan_modifier` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/3d/navigation/warped_mouse_panning` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/navigation/zoom_modifier` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/navigation/zoom_style` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/navigation_feel/orbit_inertia` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/navigation_feel/orbit_sensitivity` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/navigation_feel/translation_inertia` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/3d/navigation_feel/zoom_inertia` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/3d/primary_grid_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/3d/primary_grid_steps` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/3d/secondary_grid_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/3d/selection_box_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/instantiated` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/joint` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/shape` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/animation/autorename_animation_tracks` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/animation/default_create_bezier_tracks` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/animation/default_create_reset_tracks` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/animation/onion_layers_future_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/animation/onion_layers_past_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/grid_map/pick_distance` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/panning/2d_editor_pan_speed` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/panning/2d_editor_panning_scheme` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/panning/animation_editors_panning_scheme` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/panning/simple_panning` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/panning/sub_editors_panning_scheme` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/panning/warped_mouse_panning` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/polygon_editor/point_grab_radius` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/polygon_editor/show_previous_outline` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/shader_editor/behavior/files/restore_shaders_on_load` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editors/tiles_editor/display_grid` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`editors/tiles_editor/grid_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/visual_editors/lines_curvature` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`editors/visual_editors/minimap_opacity` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editors/visual_editors/visual_shader/port_preview_size` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/directories/autoscan_project_path` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/directories/default_project_path` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/external_programs/3d_model_editor` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/external_programs/audio_editor` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/external_programs/raster_image_editor` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/external_programs/terminal_emulator` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/external_programs/terminal_emulator_flags` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/external_programs/vector_image_editor` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`filesystem/file_dialog/display_mode` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`filesystem/file_dialog/show_hidden_files` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`filesystem/file_dialog/thumbnail_size` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/import/blender/blender_path` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`filesystem/import/blender/rpc_port` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`filesystem/import/blender/rpc_server_uptime` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/import/fbx/fbx2gltf_path` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`filesystem/on_save/compress_binary_resources` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`filesystem/on_save/safe_save_on_backup_then_rename` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`filesystem/tools/oidn/oidn_denoise_path` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/accept_dialog_cancel_ok_buttons` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/automatically_open_screenshots` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`interface/editor/code_font` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/code_font_contextual_ligatures` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`interface/editor/code_font_custom_opentype_features` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`interface/editor/code_font_custom_variations` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/code_font_size` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`interface/editor/custom_display_scale` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/debug/enable_pseudolocalization` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/display_scale` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`interface/editor/editor_language` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/editor_screen` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/expand_to_title` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/font_antialiasing` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/font_hinting` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/font_subpixel_positioning` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`interface/editor/low_processor_mode_sleep_usec` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`interface/editor/main_font` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`interface/editor/main_font_bold` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/main_font_size` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/mouse_extra_buttons_navigate_history` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/project_manager_screen` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/save_each_scene_on_quit` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/separate_distraction_mode` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/show_internal_errors_in_toast_notifications` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/show_update_spinner` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/single_window_mode` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/ui_layout_direction` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`interface/editor/unfocused_low_processor_mode_sleep_usec` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/editor/use_embedded_menu` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/editor/vsync_mode` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`interface/inspector/float_drag_speed` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/inspector/max_array_dictionary_items_per_page` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/inspector/show_low_level_opentype_features` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/multi_window/enable` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/multi_window/maximize_window` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/multi_window/restore_windows_on_load` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/scene_tabs/display_close_button` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/scene_tabs/maximum_width` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/scene_tabs/show_script_button` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/scene_tabs/show_thumbnail_on_hover` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`interface/theme/accent_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/theme/additional_spacing` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`interface/theme/base_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/theme/base_spacing` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/theme/border_size` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`interface/theme/contrast` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/theme/corner_radius` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`interface/theme/custom_theme` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/theme/draw_extra_borders` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`interface/theme/icon_and_font_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`interface/theme/icon_saturation` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`interface/theme/preset` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`interface/theme/relationship_line_opacity` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`interface/theme/spacing_preset` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/touchscreen/enable_long_press_as_right_click` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/touchscreen/enable_pan_and_scale_gestures` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/touchscreen/increase_scrollbar_touch_area` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`interface/touchscreen/scale_gizmo_handles` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/connection/network_mode` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`network/debug/remote_host` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/debug/remote_port` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`network/http_proxy/host` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/http_proxy/port` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`network/tls/editor_tls_certificates` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`project_manager/default_renderer` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`project_manager/sorting_order` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`run/auto_save/save_before_running` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`run/output/always_clear_output_on_play` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`run/output/always_close_output_on_stop` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`run/output/always_open_output_on_play` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`run/output/font_size` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`run/platforms/linuxbsd/prefer_wayland` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`run/window_placement/android_window` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`run/window_placement/rect` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`run/window_placement/rect_custom_position` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`run/window_placement/screen` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/caret/caret_blink` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`text_editor/appearance/caret/caret_blink_interval` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/caret/highlight_all_occurrences` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/caret/highlight_current_line` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/appearance/caret/type` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/appearance/guidelines/line_length_guideline_hard_column` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/appearance/guidelines/line_length_guideline_soft_column` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/guidelines/show_line_length_guidelines` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/gutters/highlight_type_safe_lines` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/gutters/line_numbers_zero_padded` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/gutters/show_info_gutter` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/gutters/show_line_numbers` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/appearance/lines/autowrap_mode` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/lines/code_folding` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/appearance/lines/word_wrap` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/appearance/minimap/minimap_width` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/minimap/show_minimap` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/whitespace/draw_spaces` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/appearance/whitespace/draw_tabs` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/appearance/whitespace/line_spacing` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/files/auto_reload_scripts_on_external_change` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/behavior/files/autosave_interval_secs` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/files/convert_indent_on_save` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/files/restore_scripts_on_load` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/files/trim_trailing_whitespace_on_save` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/indent/auto_indent` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/behavior/indent/size` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/behavior/indent/type` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/navigation/drag_and_drop_selection` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/navigation/move_caret_on_right_click` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/navigation/scroll_past_end_of_file` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/navigation/smooth_scrolling` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/behavior/navigation/stay_in_script_editor_on_node_selected` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/behavior/navigation/v_scroll_speed` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/completion/add_type_hints` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/completion/auto_brace_complete` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`text_editor/completion/code_complete_delay` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/completion/code_complete_enabled` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/completion/colorize_suggestions` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/completion/complete_file_paths` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`text_editor/completion/idle_parse_delay` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/completion/put_callhint_tooltip_below_current_line` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/completion/use_single_quotes` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/help/class_reference_examples` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/help/help_font_size` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/help/help_source_font_size` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_editor/help/help_title_font_size` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/help/show_help_index` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/script_list/show_members_overview` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`text_editor/script_list/sort_members_outline_alphabetically` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`text_editor/theme/color_theme` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/background_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/base_type_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/bookmark_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/brace_mismatch_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/breakpoint_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/caret_background_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/caret_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/code_folding_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/comment_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_background_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_existing_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_font_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_scroll_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_scroll_hovered_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_selected_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/control_flow_keyword_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/current_line_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/doc_comment_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/engine_type_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/executing_line_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/folded_code_region_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/function_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/keyword_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/line_length_guideline_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/line_number_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/mark_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/member_variable_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/number_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/safe_line_number_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/search_result_border_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/search_result_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/selection_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/string_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/symbol_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/text_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/text_selected_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/user_type_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`text_editor/theme/highlighting/word_highlighted_color` | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debugger/auto_switch_to_remote_scene_tree` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debugger/profile_native_calls` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`debugger/profiler_frame_history_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`debugger/profiler_frame_max_functions` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`debugger/remote_inspect_refresh_interval` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`debugger/remote_scene_tree_refresh_interval` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`docks/filesystem/always_show_folders` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`docks/filesystem/textfile_extensions` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`docks/filesystem/thumbnail_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`docks/property_editor/auto_refresh_interval` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`docks/property_editor/subresource_hue_tint` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`docks/scene_tree/auto_expand_to_selected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`docks/scene_tree/center_node_on_reparent` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`docks/scene_tree/start_create_dialog_fully_expanded` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/2d/bone_color1` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/2d/bone_color2` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/2d/bone_ik_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/2d/bone_outline_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/2d/bone_outline_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/2d/bone_selected_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/2d/bone_width` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/2d/grid_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/2d/guides_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/2d/smart_snapping_line_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/2d/use_integer_zoom_by_default` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/2d/viewport_border_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/default_fov` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/default_z_far` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/default_z_near` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/freelook/freelook_activation_modifier` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/freelook/freelook_base_speed` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/freelook/freelook_inertia` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/freelook/freelook_navigation_scheme` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/freelook/freelook_sensitivity` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/freelook/freelook_speed_zoom_link` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/grid_division_level_bias` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/grid_division_level_max` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/grid_division_level_min` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/grid_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/grid_xy_plane` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/grid_xz_plane` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/grid_yz_plane` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/navigation/emulate_3_button_mouse` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/navigation/emulate_numpad` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/navigation/invert_x_axis` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/navigation/invert_y_axis` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/navigation/navigation_scheme` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/navigation/orbit_modifier` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/navigation/pan_modifier` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/3d/navigation/warped_mouse_panning` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/navigation/zoom_modifier` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/navigation/zoom_style` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/navigation_feel/orbit_inertia` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/navigation_feel/orbit_sensitivity` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/navigation_feel/translation_inertia` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/3d/navigation_feel/zoom_inertia` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d/primary_grid_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/3d/primary_grid_steps` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d/secondary_grid_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d/selection_box_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/instantiated` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/joint` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d_gizmos/gizmo_colors/shape` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/animation/autorename_animation_tracks` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/animation/default_create_bezier_tracks` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/animation/default_create_reset_tracks` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/animation/onion_layers_future_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/animation/onion_layers_past_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/grid_map/pick_distance` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/panning/2d_editor_pan_speed` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/panning/2d_editor_panning_scheme` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/panning/animation_editors_panning_scheme` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/panning/simple_panning` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/panning/sub_editors_panning_scheme` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/panning/warped_mouse_panning` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/polygon_editor/point_grab_radius` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/polygon_editor/show_previous_outline` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/shader_editor/behavior/files/restore_shaders_on_load` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/tiles_editor/display_grid` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/tiles_editor/grid_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/color_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/conditional_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/input_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/output_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/particle_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/scalar_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/special_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/textures_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/transform_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/utility_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/category_colors/vector_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`editors/visual_editors/color_theme` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/boolean_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/sampler_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/scalar_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/transform_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/vector2_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/vector3_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/visual_editors/connection_colors/vector4_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/visual_editors/grid_pattern` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/visual_editors/lines_curvature` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/visual_editors/minimap_opacity` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/visual_editors/visual_shader/port_preview_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/directories/autoscan_project_path` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/directories/default_project_path` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/external_programs/3d_model_editor` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/external_programs/audio_editor` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/external_programs/raster_image_editor` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/external_programs/terminal_emulator` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/external_programs/terminal_emulator_flags` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/external_programs/vector_image_editor` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`filesystem/file_dialog/display_mode` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`filesystem/file_dialog/show_hidden_files` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`filesystem/file_dialog/thumbnail_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/import/blender/blender_path` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`filesystem/import/blender/rpc_port` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`filesystem/import/blender/rpc_server_uptime` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/import/fbx2gltf/fbx2gltf_path` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`filesystem/on_save/compress_binary_resources` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`filesystem/on_save/safe_save_on_backup_then_rename` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/tools/oidn/oidn_denoise_path` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/accept_dialog_cancel_ok_buttons` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/automatically_open_screenshots` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`interface/editor/code_font` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/code_font_contextual_ligatures` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`interface/editor/code_font_custom_opentype_features` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`interface/editor/code_font_custom_variations` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/code_font_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`interface/editor/custom_display_scale` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/debug/enable_pseudolocalization` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/display_scale` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`interface/editor/editor_language` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/editor_screen` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/expand_to_title` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/font_antialiasing` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/font_hinting` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/font_subpixel_positioning` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/localize_settings` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/low_processor_mode_sleep_usec` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`interface/editor/main_font` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`interface/editor/main_font_bold` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/main_font_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/mouse_extra_buttons_navigate_history` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/project_manager_screen` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/save_each_scene_on_quit` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/save_on_focus_loss` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/separate_distraction_mode` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/show_internal_errors_in_toast_notifications` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/show_update_spinner` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/single_window_mode` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/ui_layout_direction` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/unfocused_low_processor_mode_sleep_usec` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/update_continuously` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/editor/use_embedded_menu` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/vsync_mode` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/inspector/auto_unfold_foreign_scenes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/inspector/default_color_picker_mode` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/inspector/default_color_picker_shape` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`interface/inspector/default_float_step` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/inspector/default_property_name_style` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/inspector/disable_folding` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`interface/inspector/float_drag_speed` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/inspector/horizontal_vector2_editing` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/inspector/horizontal_vector_types_editing` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/inspector/max_array_dictionary_items_per_page` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/inspector/open_resources_in_current_inspector` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`interface/inspector/resources_to_open_in_new_inspector` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/inspector/show_low_level_opentype_features` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/multi_window/enable` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/multi_window/maximize_window` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/multi_window/restore_windows_on_load` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/scene_tabs/display_close_button` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/scene_tabs/maximum_width` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/scene_tabs/restore_scenes_on_load` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/scene_tabs/show_script_button` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/scene_tabs/show_thumbnail_on_hover` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`interface/theme/accent_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/theme/additional_spacing` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`interface/theme/base_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/theme/base_spacing` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/theme/border_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`interface/theme/contrast` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/theme/corner_radius` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`interface/theme/custom_theme` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/theme/draw_extra_borders` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/theme/follow_system_theme` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/theme/icon_and_font_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`interface/theme/icon_saturation` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`interface/theme/preset` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`interface/theme/relationship_line_opacity` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`interface/theme/spacing_preset` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/theme/use_system_accent_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/touchscreen/enable_long_press_as_right_click` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/touchscreen/enable_pan_and_scale_gestures` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/touchscreen/increase_scrollbar_touch_area` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`interface/touchscreen/scale_gizmo_handles` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/connection/network_mode` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`network/debug/remote_host` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/debug/remote_port` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`network/http_proxy/host` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/http_proxy/port` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`network/tls/editor_tls_certificates` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`project_manager/default_renderer` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`project_manager/sorting_order` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`run/auto_save/save_before_running` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`run/output/always_clear_output_on_play` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`run/output/always_close_output_on_stop` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`run/output/always_open_output_on_play` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`run/output/font_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`run/platforms/linuxbsd/prefer_wayland` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`run/window_placement/android_window` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`run/window_placement/rect` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`run/window_placement/rect_custom_position` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`run/window_placement/screen` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/caret/caret_blink` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`text_editor/appearance/caret/caret_blink_interval` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/caret/highlight_all_occurrences` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/caret/highlight_current_line` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/appearance/caret/type` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/appearance/guidelines/line_length_guideline_hard_column` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/appearance/guidelines/line_length_guideline_soft_column` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/guidelines/show_line_length_guidelines` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/gutters/highlight_type_safe_lines` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/gutters/line_numbers_zero_padded` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/gutters/show_info_gutter` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/gutters/show_line_numbers` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/appearance/lines/autowrap_mode` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/lines/code_folding` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/appearance/lines/word_wrap` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/appearance/minimap/minimap_width` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/minimap/show_minimap` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/whitespace/draw_spaces` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/appearance/whitespace/draw_tabs` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/appearance/whitespace/line_spacing` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/files/auto_reload_scripts_on_external_change` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/behavior/files/autosave_interval_secs` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/files/convert_indent_on_save` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/files/restore_scripts_on_load` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/files/trim_trailing_whitespace_on_save` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/indent/auto_indent` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/behavior/indent/size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/behavior/indent/type` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/navigation/drag_and_drop_selection` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/navigation/move_caret_on_right_click` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/navigation/scroll_past_end_of_file` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/navigation/smooth_scrolling` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/navigation/stay_in_script_editor_on_node_selected` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/behavior/navigation/v_scroll_speed` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/completion/add_type_hints` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/completion/auto_brace_complete` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`text_editor/completion/code_complete_delay` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/completion/code_complete_enabled` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/completion/colorize_suggestions` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/completion/complete_file_paths` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`text_editor/completion/idle_parse_delay` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/completion/put_callhint_tooltip_below_current_line` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/completion/use_single_quotes` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/help/class_reference_examples` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/help/help_font_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/help/help_source_font_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_editor/help/help_title_font_size` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/help/show_help_index` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/script_list/show_members_overview` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/script_list/sort_members_outline_alphabetically` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`text_editor/theme/color_theme` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/background_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/base_type_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/bookmark_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/brace_mismatch_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/breakpoint_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/caret_background_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/caret_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/code_folding_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/comment_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_background_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_existing_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_font_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_scroll_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_scroll_hovered_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/completion_selected_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/control_flow_keyword_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/current_line_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/doc_comment_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/engine_type_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/executing_line_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/folded_code_region_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/function_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/keyword_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/line_length_guideline_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/line_number_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/mark_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/member_variable_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/number_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/safe_line_number_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/search_result_border_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/search_result_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/selection_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/string_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/symbol_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/text_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/text_selected_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/user_type_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/word_highlighted_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -602,39 +674,39 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_property_info` **(** :ref:`Dictionary` info **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`check_changed_settings_in_group` **(** :ref:`String` setting_prefix **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`erase` **(** :ref:`String` property **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_changed_settings` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_favorites` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_project_metadata` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_recent_dirs` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_setting` **(** :ref:`String` name **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`mark_setting_changed` **(** :ref:`String` setting **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_builtin_action_override` **(** :ref:`String` name, :ref:`InputEvent[]` actions_list **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_favorites` **(** :ref:`PackedStringArray` dirs **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_initial_value` **(** :ref:`StringName` name, :ref:`Variant` value, :ref:`bool` update_current **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_project_metadata` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` data **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_recent_dirs` **(** :ref:`PackedStringArray` dirs **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_setting` **(** :ref:`String` name, :ref:`Variant` value **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_property_info`\ (\ info\: :ref:`Dictionary`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`check_changed_settings_in_group`\ (\ setting_prefix\: :ref:`String`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`erase`\ (\ property\: :ref:`String`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_changed_settings`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_favorites`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_project_metadata`\ (\ section\: :ref:`String`, key\: :ref:`String`, default\: :ref:`Variant` = null\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_recent_dirs`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_setting`\ (\ name\: :ref:`String`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_setting`\ (\ name\: :ref:`String`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`mark_setting_changed`\ (\ setting\: :ref:`String`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_builtin_action_override`\ (\ name\: :ref:`String`, actions_list\: :ref:`Array`\[:ref:`InputEvent`\]\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_favorites`\ (\ dirs\: :ref:`PackedStringArray`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_initial_value`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`, update_current\: :ref:`bool`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_project_metadata`\ (\ section\: :ref:`String`, key\: :ref:`String`, data\: :ref:`Variant`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_recent_dirs`\ (\ dirs\: :ref:`PackedStringArray`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_setting`\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -649,7 +721,7 @@ Signals .. rst-class:: classref-signal -**settings_changed** **(** **)** +**settings_changed**\ (\ ) Emitted after any editor setting has changed. @@ -1685,6 +1757,246 @@ The color to use for the TileMap editor's grid. ---- +.. _class_EditorSettings_property_editors/visual_editors/category_colors/color_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/visual_editors/category_colors/color_color** + +The color of a graph node's header when it belongs to the "Color" category. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/category_colors/conditional_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/visual_editors/category_colors/conditional_color** + +The color of a graph node's header when it belongs to the "Conditional" category. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/category_colors/input_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/visual_editors/category_colors/input_color** + +The color of a graph node's header when it belongs to the "Input" category. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/category_colors/output_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/visual_editors/category_colors/output_color** + +The color of a graph node's header when it belongs to the "Output" category. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/category_colors/particle_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/visual_editors/category_colors/particle_color** + +The color of a graph node's header when it belongs to the "Particle" category. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/category_colors/scalar_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/visual_editors/category_colors/scalar_color** + +The color of a graph node's header when it belongs to the "Scalar" category. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/category_colors/special_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/visual_editors/category_colors/special_color** + +The color of a graph node's header when it belongs to the "Special" category. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/category_colors/textures_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/visual_editors/category_colors/textures_color** + +The color of a graph node's header when it belongs to the "Textures" category. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/category_colors/transform_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/visual_editors/category_colors/transform_color** + +The color of a graph node's header when it belongs to the "Transform" category. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/category_colors/utility_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/visual_editors/category_colors/utility_color** + +The color of a graph node's header when it belongs to the "Utility" category. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/category_colors/vector_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/visual_editors/category_colors/vector_color** + +The color of a graph node's header when it belongs to the "Vector" category. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/color_theme: + +.. rst-class:: classref-property + +:ref:`String` **editors/visual_editors/color_theme** + +The color theme to use in the visual shader editor. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/connection_colors/boolean_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/visual_editors/connection_colors/boolean_color** + +The color of a port/connection of boolean type. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/connection_colors/sampler_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/visual_editors/connection_colors/sampler_color** + +The color of a port/connection of sampler type. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/connection_colors/scalar_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/visual_editors/connection_colors/scalar_color** + +The color of a port/connection of scalar type (float, int, unsigned int). + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/connection_colors/transform_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/visual_editors/connection_colors/transform_color** + +The color of a port/connection of transform type. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/connection_colors/vector2_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/visual_editors/connection_colors/vector2_color** + +The color of a port/connection of Vector2 type. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/connection_colors/vector3_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/visual_editors/connection_colors/vector3_color** + +The color of a port/connection of Vector3 type. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/connection_colors/vector4_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/visual_editors/connection_colors/vector4_color** + +The color of a port/connection of Vector4 type. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/visual_editors/grid_pattern: + +.. rst-class:: classref-property + +:ref:`int` **editors/visual_editors/grid_pattern** + +The pattern used for the background grid. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_editors/visual_editors/lines_curvature: .. rst-class:: classref-property @@ -1919,15 +2231,15 @@ This prevents Godot from having to create a new process for each import within t ---- -.. _class_EditorSettings_property_filesystem/import/fbx/fbx2gltf_path: +.. _class_EditorSettings_property_filesystem/import/fbx2gltf/fbx2gltf_path: .. rst-class:: classref-property -:ref:`String` **filesystem/import/fbx/fbx2gltf_path** +:ref:`String` **filesystem/import/fbx2gltf/fbx2gltf_path** The path to the FBX2glTF executable used for converting Autodesk FBX 3D scene files ``.fbx`` to glTF 2.0 format during import. -To enable this feature for your specific project, use :ref:`ProjectSettings.filesystem/import/fbx/enabled`. +To enable this feature for your specific project, use :ref:`ProjectSettings.filesystem/import/fbx2gltf/enabled`. .. rst-class:: classref-item-separator @@ -2197,14 +2509,30 @@ The subpixel positioning mode to use when rendering editor font glyphs. This aff ---- +.. _class_EditorSettings_property_interface/editor/localize_settings: + +.. rst-class:: classref-property + +:ref:`bool` **interface/editor/localize_settings** + +If ``true``, setting names in the Editor Settings are localized when possible. This is disabled by default, since localization can make it difficult to look up setting names online. + +\ **Note:** This setting does not control property name localization in the inspector. To show translated property names in the inspector, set :ref:`interface/inspector/default_property_name_style` to **Localized**. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/editor/low_processor_mode_sleep_usec: .. rst-class:: classref-property -:ref:`float` **interface/editor/low_processor_mode_sleep_usec** +:ref:`int` **interface/editor/low_processor_mode_sleep_usec** The amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU/GPU usage, which can improve battery life on laptops. However, higher values will result in a less responsive editor. The default value is set to allow for maximum smoothness on monitors up to 144 Hz. See also :ref:`interface/editor/unfocused_low_processor_mode_sleep_usec`. +\ **Note:** This setting is ignored if :ref:`interface/editor/update_continuously` is ``true``, as enabling that setting disables low-processor mode. + .. rst-class:: classref-item-separator ---- @@ -2281,6 +2609,18 @@ If ``false``, the editor will save all scenes when confirming the **Save** actio ---- +.. _class_EditorSettings_property_interface/editor/save_on_focus_loss: + +.. rst-class:: classref-property + +:ref:`bool` **interface/editor/save_on_focus_loss** + +If ``true``, scenes and scripts are saved when the editor loses focus. Depending on the work flow, this behavior can be less intrusive than :ref:`text_editor/behavior/files/autosave_interval_secs` or remembering to save manually. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/editor/separate_distraction_mode: .. rst-class:: classref-property @@ -2319,6 +2659,8 @@ Consider enabling this if you are developing editor plugins to ensure they only The default **Auto** value will only enable this if the editor was compiled with the ``dev_build=yes`` SCons option (the default is ``dev_build=no``). +\ **Note:** If :ref:`interface/editor/update_continuously` is ``true``, the spinner icon displays in red. + .. rst-class:: classref-item-separator ---- @@ -2353,10 +2695,26 @@ Editor UI default layout direction. .. rst-class:: classref-property -:ref:`float` **interface/editor/unfocused_low_processor_mode_sleep_usec** +:ref:`int` **interface/editor/unfocused_low_processor_mode_sleep_usec** When the editor window is unfocused, the amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU/GPU usage, which can improve battery life on laptops (in addition to improving the running project's performance if the editor has to redraw continuously). However, higher values will result in a less responsive editor. The default value is set to limit the editor to 20 FPS when the editor window is unfocused. See also :ref:`interface/editor/low_processor_mode_sleep_usec`. +\ **Note:** This setting is ignored if :ref:`interface/editor/update_continuously` is ``true``, as enabling that setting disables low-processor mode. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_interface/editor/update_continuously: + +.. rst-class:: classref-property + +:ref:`bool` **interface/editor/update_continuously** + +If ``true``, redraws the editor every frame even if nothing has changed on screen. When this setting is enabled, the update spinner displays in red (see :ref:`interface/editor/show_update_spinner`). + +\ **Warning:** This greatly increases CPU and GPU utilization, leading to increased power usage. This should only be enabled for troubleshooting purposes. + .. rst-class:: classref-item-separator ---- @@ -2391,6 +2749,86 @@ Depending on the platform and used renderer, the engine will fall back to **Enab ---- +.. _class_EditorSettings_property_interface/inspector/auto_unfold_foreign_scenes: + +.. rst-class:: classref-property + +:ref:`bool` **interface/inspector/auto_unfold_foreign_scenes** + +If ``true``, automatically expands property groups in the Inspector dock when opening a scene that hasn't been opened previously. If ``false``, all groups remain collapsed by default. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_interface/inspector/default_color_picker_mode: + +.. rst-class:: classref-property + +:ref:`int` **interface/inspector/default_color_picker_mode** + +The default color picker mode to use when opening :ref:`ColorPicker`\ s in the editor. This mode can be temporarily adjusted on the color picker itself. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_interface/inspector/default_color_picker_shape: + +.. rst-class:: classref-property + +:ref:`int` **interface/inspector/default_color_picker_shape** + +The default color picker shape to use when opening :ref:`ColorPicker`\ s in the editor. This shape can be temporarily adjusted on the color picker itself. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_interface/inspector/default_float_step: + +.. rst-class:: classref-property + +:ref:`float` **interface/inspector/default_float_step** + +The floating-point precision to use for properties that don't define an explicit precision step. Lower values allow entering more precise values. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_interface/inspector/default_property_name_style: + +.. rst-class:: classref-property + +:ref:`int` **interface/inspector/default_property_name_style** + +The property name style to display in the inspector. + +- **Raw:** Displays properties as they are defined in the script (typically in ``snake_case`` for GDScript and ``PascalCase`` for C#). + +- **Capitalized:** Displays properties using :ref:`String.capitalize`. + +- **Localized:** Displays the localized string for the current editor language if a translation is available for the given property. If no translation is available, falls back to **Capitalized**. + +\ **Note:** This setting does not control editor setting name display. To display translated editor setting names, enable :ref:`interface/editor/localize_settings` instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_interface/inspector/disable_folding: + +.. rst-class:: classref-property + +:ref:`bool` **interface/inspector/disable_folding** + +If ``true``, forces all property groups to be expanded in the Inspector dock and prevents collapsing them. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/inspector/float_drag_speed: .. rst-class:: classref-property @@ -2403,6 +2841,30 @@ Base speed for increasing/decreasing float values by dragging them in the inspec ---- +.. _class_EditorSettings_property_interface/inspector/horizontal_vector2_editing: + +.. rst-class:: classref-property + +:ref:`bool` **interface/inspector/horizontal_vector2_editing** + +If ``true``, :ref:`Vector2` and :ref:`Vector2i` properties are shown on a single line in the inspector instead of two lines. This is overall more compact, but it can be harder to view and edit large values without expanding the inspector horizontally. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_interface/inspector/horizontal_vector_types_editing: + +.. rst-class:: classref-property + +:ref:`bool` **interface/inspector/horizontal_vector_types_editing** + +If ``true``, :ref:`Vector3`, :ref:`Vector3i`, :ref:`Vector4`, :ref:`Vector4i`, :ref:`Rect2`, :ref:`Rect2i`, :ref:`Plane`, and :ref:`Quaternion` properties are shown on a single line in the inspector instead of multiple lines. This is overall more compact, but it can be harder to view and edit large values without expanding the inspector horizontally. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/inspector/max_array_dictionary_items_per_page: .. rst-class:: classref-property @@ -2415,6 +2877,30 @@ The number of :ref:`Array` or :ref:`Dictionary` i ---- +.. _class_EditorSettings_property_interface/inspector/open_resources_in_current_inspector: + +.. rst-class:: classref-property + +:ref:`bool` **interface/inspector/open_resources_in_current_inspector** + +If ``true``, subresources can be edited in the current inspector view. If the resource type is defined in :ref:`interface/inspector/resources_to_open_in_new_inspector` or if this setting is ``false``, attempting to edit a subresource always opens a new inspector view. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_interface/inspector/resources_to_open_in_new_inspector: + +.. rst-class:: classref-property + +:ref:`PackedStringArray` **interface/inspector/resources_to_open_in_new_inspector** + +List of resources that should always be opened in a new inspector view, even if :ref:`interface/inspector/open_resources_in_current_inspector` is ``true``. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/inspector/show_low_level_opentype_features: .. rst-class:: classref-property @@ -2493,6 +2979,20 @@ The maximum width of each scene tab at the top editor (in pixels). ---- +.. _class_EditorSettings_property_interface/scene_tabs/restore_scenes_on_load: + +.. rst-class:: classref-property + +:ref:`bool` **interface/scene_tabs/restore_scenes_on_load** + +If ``true``, when a project is loaded, restores scenes that were opened on the last editor session. + +\ **Note:** With many opened scenes, the editor may take longer to become usable. If starting the editor quickly is necessary, consider setting this to ``false``. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/scene_tabs/show_script_button: .. rst-class:: classref-property @@ -2627,6 +3127,18 @@ If ``true``, draws additional borders around interactive UI elements in the edit ---- +.. _class_EditorSettings_property_interface/theme/follow_system_theme: + +.. rst-class:: classref-property + +:ref:`bool` **interface/theme/follow_system_theme** + +If ``true``, the editor theme preset will attempt to automatically match the system theme. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/theme/icon_and_font_color: .. rst-class:: classref-property @@ -2695,6 +3207,20 @@ The editor theme spacing preset to use. See also :ref:`interface/theme/base_spac ---- +.. _class_EditorSettings_property_interface/theme/use_system_accent_color: + +.. rst-class:: classref-property + +:ref:`bool` **interface/theme/use_system_accent_color** + +If ``true``, set accent color based on system settings. + +\ **Note:** This setting is only effective on Windows and MacOS. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/touchscreen/enable_long_press_as_right_click: .. rst-class:: classref-property @@ -4072,7 +4598,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_property_info** **(** :ref:`Dictionary` info **)** +|void| **add_property_info**\ (\ info\: :ref:`Dictionary`\ ) Adds a custom property info to a property. The dictionary must contain: @@ -4126,7 +4652,7 @@ Adds a custom property info to a property. The dictionary must contain: .. rst-class:: classref-method -:ref:`bool` **check_changed_settings_in_group** **(** :ref:`String` setting_prefix **)** |const| +:ref:`bool` **check_changed_settings_in_group**\ (\ setting_prefix\: :ref:`String`\ ) |const| Checks if any settings with the prefix ``setting_prefix`` exist in the set of changed settings. See also :ref:`get_changed_settings`. @@ -4138,7 +4664,7 @@ Checks if any settings with the prefix ``setting_prefix`` exist in the set of ch .. rst-class:: classref-method -void **erase** **(** :ref:`String` property **)** +|void| **erase**\ (\ property\: :ref:`String`\ ) Erases the setting whose name is specified by ``property``. @@ -4150,7 +4676,7 @@ Erases the setting whose name is specified by ``property``. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_changed_settings** **(** **)** |const| +:ref:`PackedStringArray` **get_changed_settings**\ (\ ) |const| Gets an array of the settings which have been changed since the last save. Note that internally ``changed_settings`` is cleared after a successful save, so generally the most appropriate place to use this method is when processing :ref:`NOTIFICATION_EDITOR_SETTINGS_CHANGED`. @@ -4162,7 +4688,7 @@ Gets an array of the settings which have been changed since the last save. Note .. rst-class:: classref-method -:ref:`PackedStringArray` **get_favorites** **(** **)** |const| +:ref:`PackedStringArray` **get_favorites**\ (\ ) |const| Returns the list of favorite files and directories for this project. @@ -4174,7 +4700,7 @@ Returns the list of favorite files and directories for this project. .. rst-class:: classref-method -:ref:`Variant` **get_project_metadata** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** |const| +:ref:`Variant` **get_project_metadata**\ (\ section\: :ref:`String`, key\: :ref:`String`, default\: :ref:`Variant` = null\ ) |const| Returns project-specific metadata for the ``section`` and ``key`` specified. If the metadata doesn't exist, ``default`` will be returned instead. See also :ref:`set_project_metadata`. @@ -4186,7 +4712,7 @@ Returns project-specific metadata for the ``section`` and ``key`` specified. If .. rst-class:: classref-method -:ref:`PackedStringArray` **get_recent_dirs** **(** **)** |const| +:ref:`PackedStringArray` **get_recent_dirs**\ (\ ) |const| Returns the list of recently visited folders in the file dialog for this project. @@ -4198,7 +4724,7 @@ Returns the list of recently visited folders in the file dialog for this project .. rst-class:: classref-method -:ref:`Variant` **get_setting** **(** :ref:`String` name **)** |const| +:ref:`Variant` **get_setting**\ (\ name\: :ref:`String`\ ) |const| Returns the value of the setting specified by ``name``. This is equivalent to using :ref:`Object.get` on the EditorSettings instance. @@ -4210,7 +4736,7 @@ Returns the value of the setting specified by ``name``. This is equivalent to us .. rst-class:: classref-method -:ref:`bool` **has_setting** **(** :ref:`String` name **)** |const| +:ref:`bool` **has_setting**\ (\ name\: :ref:`String`\ ) |const| Returns ``true`` if the setting specified by ``name`` exists, ``false`` otherwise. @@ -4222,7 +4748,7 @@ Returns ``true`` if the setting specified by ``name`` exists, ``false`` otherwis .. rst-class:: classref-method -void **mark_setting_changed** **(** :ref:`String` setting **)** +|void| **mark_setting_changed**\ (\ setting\: :ref:`String`\ ) Marks the passed editor setting as being changed, see :ref:`get_changed_settings`. Only settings which exist (see :ref:`has_setting`) will be accepted. @@ -4234,7 +4760,7 @@ Marks the passed editor setting as being changed, see :ref:`get_changed_settings .. rst-class:: classref-method -void **set_builtin_action_override** **(** :ref:`String` name, :ref:`InputEvent[]` actions_list **)** +|void| **set_builtin_action_override**\ (\ name\: :ref:`String`, actions_list\: :ref:`Array`\[:ref:`InputEvent`\]\ ) Overrides the built-in editor action ``name`` with the input actions defined in ``actions_list``. @@ -4246,7 +4772,7 @@ Overrides the built-in editor action ``name`` with the input actions defined in .. rst-class:: classref-method -void **set_favorites** **(** :ref:`PackedStringArray` dirs **)** +|void| **set_favorites**\ (\ dirs\: :ref:`PackedStringArray`\ ) Sets the list of favorite files and directories for this project. @@ -4258,7 +4784,7 @@ Sets the list of favorite files and directories for this project. .. rst-class:: classref-method -void **set_initial_value** **(** :ref:`StringName` name, :ref:`Variant` value, :ref:`bool` update_current **)** +|void| **set_initial_value**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`, update_current\: :ref:`bool`\ ) Sets the initial value of the setting specified by ``name`` to ``value``. This is used to provide a value for the Revert button in the Editor Settings. If ``update_current`` is true, the current value of the setting will be set to ``value`` as well. @@ -4270,7 +4796,7 @@ Sets the initial value of the setting specified by ``name`` to ``value``. This i .. rst-class:: classref-method -void **set_project_metadata** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` data **)** +|void| **set_project_metadata**\ (\ section\: :ref:`String`, key\: :ref:`String`, data\: :ref:`Variant`\ ) Sets project-specific metadata with the ``section``, ``key`` and ``data`` specified. This metadata is stored outside the project folder and therefore won't be checked into version control. See also :ref:`get_project_metadata`. @@ -4282,7 +4808,7 @@ Sets project-specific metadata with the ``section``, ``key`` and ``data`` specif .. rst-class:: classref-method -void **set_recent_dirs** **(** :ref:`PackedStringArray` dirs **)** +|void| **set_recent_dirs**\ (\ dirs\: :ref:`PackedStringArray`\ ) Sets the list of recently visited folders in the file dialog for this project. @@ -4294,7 +4820,7 @@ Sets the list of recently visited folders in the file dialog for this project. .. rst-class:: classref-method -void **set_setting** **(** :ref:`String` name, :ref:`Variant` value **)** +|void| **set_setting**\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) Sets the ``value`` of the setting specified by ``name``. This is equivalent to using :ref:`Object.set` on the EditorSettings instance. @@ -4305,3 +4831,4 @@ Sets the ``value`` of the setting specified by ``name``. This is equivalent to u .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorspinslider.rst b/classes/class_editorspinslider.rst index 050cbe67cba..cf26e883cff 100644 --- a/classes/class_editorspinslider.rst +++ b/classes/class_editorspinslider.rst @@ -42,7 +42,7 @@ Properties +--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`read_only` | ``false`` | +--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`SizeFlags`\> | size_flags_vertical | ``1`` (overrides :ref:`Control`) | + | |bitfield|\[:ref:`SizeFlags`\] | size_flags_vertical | ``1`` (overrides :ref:`Control`) | +--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`float` | step | ``1.0`` (overrides :ref:`Range`) | +--------------------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ @@ -62,7 +62,7 @@ Signals .. rst-class:: classref-signal -**grabbed** **(** **)** +**grabbed**\ (\ ) Emitted when the spinner/slider is grabbed. @@ -74,7 +74,7 @@ Emitted when the spinner/slider is grabbed. .. rst-class:: classref-signal -**ungrabbed** **(** **)** +**ungrabbed**\ (\ ) Emitted when the spinner/slider is ungrabbed. @@ -86,7 +86,7 @@ Emitted when the spinner/slider is ungrabbed. .. rst-class:: classref-signal -**value_focus_entered** **(** **)** +**value_focus_entered**\ (\ ) Emitted when the value form gains focus. @@ -98,7 +98,7 @@ Emitted when the value form gains focus. .. rst-class:: classref-signal -**value_focus_exited** **(** **)** +**value_focus_exited**\ (\ ) Emitted when the value form loses focus. @@ -119,8 +119,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_flat** **(** :ref:`bool` value **)** -- :ref:`bool` **is_flat** **(** **)** +- |void| **set_flat**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_flat**\ (\ ) If ``true``, the slider will not draw background. @@ -136,8 +136,8 @@ If ``true``, the slider will not draw background. .. rst-class:: classref-property-setget -- void **set_hide_slider** **(** :ref:`bool` value **)** -- :ref:`bool` **is_hiding_slider** **(** **)** +- |void| **set_hide_slider**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_hiding_slider**\ (\ ) If ``true``, the slider and up/down arrows are hidden. @@ -153,8 +153,8 @@ If ``true``, the slider and up/down arrows are hidden. .. rst-class:: classref-property-setget -- void **set_label** **(** :ref:`String` value **)** -- :ref:`String` **get_label** **(** **)** +- |void| **set_label**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_label**\ (\ ) The text that displays to the left of the value. @@ -170,8 +170,8 @@ The text that displays to the left of the value. .. rst-class:: classref-property-setget -- void **set_read_only** **(** :ref:`bool` value **)** -- :ref:`bool` **is_read_only** **(** **)** +- |void| **set_read_only**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_read_only**\ (\ ) If ``true``, the slider can't be interacted with. @@ -187,8 +187,8 @@ If ``true``, the slider can't be interacted with. .. rst-class:: classref-property-setget -- void **set_suffix** **(** :ref:`String` value **)** -- :ref:`String` **get_suffix** **(** **)** +- |void| **set_suffix**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_suffix**\ (\ ) The suffix to display after the value (in a faded color). This should generally be a plural word. You may have to use an abbreviation if the suffix is too long to be displayed. @@ -199,3 +199,4 @@ The suffix to display after the value (in a faded color). This should generally .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorsyntaxhighlighter.rst b/classes/class_editorsyntaxhighlighter.rst index 4ac44786dea..eb22b01838e 100644 --- a/classes/class_editorsyntaxhighlighter.rst +++ b/classes/class_editorsyntaxhighlighter.rst @@ -31,11 +31,11 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_name` **(** **)** |virtual| |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_supported_languages` **(** **)** |virtual| |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_name`\ (\ ) |virtual| |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_supported_languages`\ (\ ) |virtual| |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -50,7 +50,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **_get_name** **(** **)** |virtual| |const| +:ref:`String` **_get_name**\ (\ ) |virtual| |const| Virtual method which can be overridden to return the syntax highlighter name. @@ -62,7 +62,7 @@ Virtual method which can be overridden to return the syntax highlighter name. .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_supported_languages** **(** **)** |virtual| |const| +:ref:`PackedStringArray` **_get_supported_languages**\ (\ ) |virtual| |const| Virtual method which can be overridden to return the supported language names. @@ -73,3 +73,4 @@ Virtual method which can be overridden to return the supported language names. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editortranslationparserplugin.rst b/classes/class_editortranslationparserplugin.rst index 0b612e108af..6c19cd8a0f2 100644 --- a/classes/class_editortranslationparserplugin.rst +++ b/classes/class_editortranslationparserplugin.rst @@ -143,11 +143,11 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_recognized_extensions` **(** **)** |virtual| |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_parse_file` **(** :ref:`String` path, :ref:`String[]` msgids, :ref:`Array[]` msgids_context_plural **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_recognized_extensions`\ (\ ) |virtual| |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_parse_file`\ (\ path\: :ref:`String`, msgids\: :ref:`Array`\[:ref:`String`\], msgids_context_plural\: :ref:`Array`\[:ref:`Array`\]\ ) |virtual| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -162,7 +162,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_recognized_extensions** **(** **)** |virtual| |const| +:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ ) |virtual| |const| Gets the list of file extensions to associate with this parser, e.g. ``["csv"]``. @@ -174,7 +174,7 @@ Gets the list of file extensions to associate with this parser, e.g. ``["csv"]`` .. rst-class:: classref-method -void **_parse_file** **(** :ref:`String` path, :ref:`String[]` msgids, :ref:`Array[]` msgids_context_plural **)** |virtual| +|void| **_parse_file**\ (\ path\: :ref:`String`, msgids\: :ref:`Array`\[:ref:`String`\], msgids_context_plural\: :ref:`Array`\[:ref:`Array`\]\ ) |virtual| Override this method to define a custom parsing logic to extract the translatable strings. @@ -185,3 +185,4 @@ Override this method to define a custom parsing logic to extract the translatabl .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorundoredomanager.rst b/classes/class_editorundoredomanager.rst index 9b57fe36c6a..d4da5840926 100644 --- a/classes/class_editorundoredomanager.rst +++ b/classes/class_editorundoredomanager.rst @@ -43,29 +43,29 @@ Methods .. table:: :widths: auto - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_do_method` **(** :ref:`Object` object, :ref:`StringName` method, ... **)** |vararg| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_do_property` **(** :ref:`Object` object, :ref:`StringName` property, :ref:`Variant` value **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_do_reference` **(** :ref:`Object` object **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_undo_method` **(** :ref:`Object` object, :ref:`StringName` method, ... **)** |vararg| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_undo_property` **(** :ref:`Object` object, :ref:`StringName` property, :ref:`Variant` value **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_undo_reference` **(** :ref:`Object` object **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`commit_action` **(** :ref:`bool` execute=true **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_action` **(** :ref:`String` name, :ref:`MergeMode` merge_mode=0, :ref:`Object` custom_context=null, :ref:`bool` backward_undo_ops=false **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`UndoRedo` | :ref:`get_history_undo_redo` **(** :ref:`int` id **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_object_history_id` **(** :ref:`Object` object **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_committing_action` **(** **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_do_method`\ (\ object\: :ref:`Object`, method\: :ref:`StringName`, ...\ ) |vararg| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_do_property`\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_do_reference`\ (\ object\: :ref:`Object`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_undo_method`\ (\ object\: :ref:`Object`, method\: :ref:`StringName`, ...\ ) |vararg| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_undo_property`\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_undo_reference`\ (\ object\: :ref:`Object`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`commit_action`\ (\ execute\: :ref:`bool` = true\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_action`\ (\ name\: :ref:`String`, merge_mode\: :ref:`MergeMode` = 0, custom_context\: :ref:`Object` = null, backward_undo_ops\: :ref:`bool` = false\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`UndoRedo` | :ref:`get_history_undo_redo`\ (\ id\: :ref:`int`\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_object_history_id`\ (\ object\: :ref:`Object`\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_committing_action`\ (\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -80,7 +80,7 @@ Signals .. rst-class:: classref-signal -**history_changed** **(** **)** +**history_changed**\ (\ ) Emitted when the list of actions in any history has changed, either when an action is committed or a history is cleared. @@ -92,7 +92,7 @@ Emitted when the list of actions in any history has changed, either when an acti .. rst-class:: classref-signal -**version_changed** **(** **)** +**version_changed**\ (\ ) Emitted when the version of any history has changed as a result of undo or redo call. @@ -148,7 +148,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_do_method** **(** :ref:`Object` object, :ref:`StringName` method, ... **)** |vararg| +|void| **add_do_method**\ (\ object\: :ref:`Object`, method\: :ref:`StringName`, ...\ ) |vararg| Register a method that will be called when the action is committed (i.e. the "do" action). @@ -162,7 +162,7 @@ If this is the first operation, the ``object`` will be used to deduce target und .. rst-class:: classref-method -void **add_do_property** **(** :ref:`Object` object, :ref:`StringName` property, :ref:`Variant` value **)** +|void| **add_do_property**\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) Register a property value change for "do". @@ -176,7 +176,7 @@ If this is the first operation, the ``object`` will be used to deduce target und .. rst-class:: classref-method -void **add_do_reference** **(** :ref:`Object` object **)** +|void| **add_do_reference**\ (\ object\: :ref:`Object`\ ) Register a reference for "do" that will be erased if the "do" history is lost. This is useful mostly for new nodes created for the "do" call. Do not use for resources. @@ -188,7 +188,7 @@ Register a reference for "do" that will be erased if the "do" history is lost. T .. rst-class:: classref-method -void **add_undo_method** **(** :ref:`Object` object, :ref:`StringName` method, ... **)** |vararg| +|void| **add_undo_method**\ (\ object\: :ref:`Object`, method\: :ref:`StringName`, ...\ ) |vararg| Register a method that will be called when the action is undone (i.e. the "undo" action). @@ -202,7 +202,7 @@ If this is the first operation, the ``object`` will be used to deduce target und .. rst-class:: classref-method -void **add_undo_property** **(** :ref:`Object` object, :ref:`StringName` property, :ref:`Variant` value **)** +|void| **add_undo_property**\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) Register a property value change for "undo". @@ -216,7 +216,7 @@ If this is the first operation, the ``object`` will be used to deduce target und .. rst-class:: classref-method -void **add_undo_reference** **(** :ref:`Object` object **)** +|void| **add_undo_reference**\ (\ object\: :ref:`Object`\ ) Register a reference for "undo" that will be erased if the "undo" history is lost. This is useful mostly for nodes removed with the "do" call (not the "undo" call!). @@ -228,7 +228,7 @@ Register a reference for "undo" that will be erased if the "undo" history is los .. rst-class:: classref-method -void **commit_action** **(** :ref:`bool` execute=true **)** +|void| **commit_action**\ (\ execute\: :ref:`bool` = true\ ) Commit the action. If ``execute`` is true (default), all "do" methods/properties are called/set when this function is called. @@ -240,7 +240,7 @@ Commit the action. If ``execute`` is true (default), all "do" methods/properties .. rst-class:: classref-method -void **create_action** **(** :ref:`String` name, :ref:`MergeMode` merge_mode=0, :ref:`Object` custom_context=null, :ref:`bool` backward_undo_ops=false **)** +|void| **create_action**\ (\ name\: :ref:`String`, merge_mode\: :ref:`MergeMode` = 0, custom_context\: :ref:`Object` = null, backward_undo_ops\: :ref:`bool` = false\ ) Create a new action. After this is called, do all your calls to :ref:`add_do_method`, :ref:`add_undo_method`, :ref:`add_do_property`, and :ref:`add_undo_property`, then commit the action with :ref:`commit_action`. @@ -258,7 +258,7 @@ The way undo operation are ordered in actions is dictated by ``backward_undo_ops .. rst-class:: classref-method -:ref:`UndoRedo` **get_history_undo_redo** **(** :ref:`int` id **)** |const| +:ref:`UndoRedo` **get_history_undo_redo**\ (\ id\: :ref:`int`\ ) |const| Returns the :ref:`UndoRedo` object associated with the given history ``id``. @@ -274,7 +274,7 @@ Best used with :ref:`get_object_history_id` **get_object_history_id** **(** :ref:`Object` object **)** |const| +:ref:`int` **get_object_history_id**\ (\ object\: :ref:`Object`\ ) |const| Returns the history ID deduced from the given ``object``. It can be used with :ref:`get_history_undo_redo`. @@ -286,7 +286,7 @@ Returns the history ID deduced from the given ``object``. It can be used with :r .. rst-class:: classref-method -:ref:`bool` **is_committing_action** **(** **)** |const| +:ref:`bool` **is_committing_action**\ (\ ) |const| Returns ``true`` if the **EditorUndoRedoManager** is currently committing the action, i.e. running its "do" method or property change (see :ref:`commit_action`). @@ -297,3 +297,4 @@ Returns ``true`` if the **EditorUndoRedoManager** is currently committing the ac .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_editorvcsinterface.rst b/classes/class_editorvcsinterface.rst index ff8c1e467c2..ab1eaaeb93f 100644 --- a/classes/class_editorvcsinterface.rst +++ b/classes/class_editorvcsinterface.rst @@ -36,69 +36,69 @@ Methods .. table:: :widths: auto - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_checkout_branch` **(** :ref:`String` branch_name **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_commit` **(** :ref:`String` msg **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_create_branch` **(** :ref:`String` branch_name **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_create_remote` **(** :ref:`String` remote_name, :ref:`String` remote_url **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_discard_file` **(** :ref:`String` file_path **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_fetch` **(** :ref:`String` remote **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String[]` | :ref:`_get_branch_list` **(** **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_current_branch_name` **(** **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`_get_diff` **(** :ref:`String` identifier, :ref:`int` area **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`_get_line_diff` **(** :ref:`String` file_path, :ref:`String` text **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`_get_modified_files_data` **(** **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`_get_previous_commits` **(** :ref:`int` max_commits **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String[]` | :ref:`_get_remotes` **(** **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_vcs_name` **(** **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_initialize` **(** :ref:`String` project_path **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_pull` **(** :ref:`String` remote **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_push` **(** :ref:`String` remote, :ref:`bool` force **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_remove_branch` **(** :ref:`String` branch_name **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_remove_remote` **(** :ref:`String` remote_name **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_credentials` **(** :ref:`String` username, :ref:`String` password, :ref:`String` ssh_public_key_path, :ref:`String` ssh_private_key_path, :ref:`String` ssh_passphrase **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shut_down` **(** **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_stage_file` **(** :ref:`String` file_path **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_unstage_file` **(** :ref:`String` file_path **)** |virtual| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`add_diff_hunks_into_diff_file` **(** :ref:`Dictionary` diff_file, :ref:`Dictionary[]` diff_hunks **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`add_line_diffs_into_diff_hunk` **(** :ref:`Dictionary` diff_hunk, :ref:`Dictionary[]` line_diffs **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`create_commit` **(** :ref:`String` msg, :ref:`String` author, :ref:`String` id, :ref:`int` unix_timestamp, :ref:`int` offset_minutes **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`create_diff_file` **(** :ref:`String` new_file, :ref:`String` old_file **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`create_diff_hunk` **(** :ref:`int` old_start, :ref:`int` new_start, :ref:`int` old_lines, :ref:`int` new_lines **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`create_diff_line` **(** :ref:`int` new_line_no, :ref:`int` old_line_no, :ref:`String` content, :ref:`String` status **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`create_status_file` **(** :ref:`String` file_path, :ref:`ChangeType` change_type, :ref:`TreeArea` area **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`popup_error` **(** :ref:`String` msg **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_checkout_branch`\ (\ branch_name\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_commit`\ (\ msg\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_create_branch`\ (\ branch_name\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_create_remote`\ (\ remote_name\: :ref:`String`, remote_url\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_discard_file`\ (\ file_path\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_fetch`\ (\ remote\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`String`\] | :ref:`_get_branch_list`\ (\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_current_branch_name`\ (\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_diff`\ (\ identifier\: :ref:`String`, area\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_line_diff`\ (\ file_path\: :ref:`String`, text\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_modified_files_data`\ (\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_previous_commits`\ (\ max_commits\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`String`\] | :ref:`_get_remotes`\ (\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_vcs_name`\ (\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_initialize`\ (\ project_path\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_pull`\ (\ remote\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_push`\ (\ remote\: :ref:`String`, force\: :ref:`bool`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_remove_branch`\ (\ branch_name\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_remove_remote`\ (\ remote_name\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_credentials`\ (\ username\: :ref:`String`, password\: :ref:`String`, ssh_public_key_path\: :ref:`String`, ssh_private_key_path\: :ref:`String`, ssh_passphrase\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shut_down`\ (\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_stage_file`\ (\ file_path\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_unstage_file`\ (\ file_path\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`add_diff_hunks_into_diff_file`\ (\ diff_file\: :ref:`Dictionary`, diff_hunks\: :ref:`Array`\[:ref:`Dictionary`\]\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`add_line_diffs_into_diff_hunk`\ (\ diff_hunk\: :ref:`Dictionary`, line_diffs\: :ref:`Array`\[:ref:`Dictionary`\]\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`create_commit`\ (\ msg\: :ref:`String`, author\: :ref:`String`, id\: :ref:`String`, unix_timestamp\: :ref:`int`, offset_minutes\: :ref:`int`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`create_diff_file`\ (\ new_file\: :ref:`String`, old_file\: :ref:`String`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`create_diff_hunk`\ (\ old_start\: :ref:`int`, new_start\: :ref:`int`, old_lines\: :ref:`int`, new_lines\: :ref:`int`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`create_diff_line`\ (\ new_line_no\: :ref:`int`, old_line_no\: :ref:`int`, content\: :ref:`String`, status\: :ref:`String`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`create_status_file`\ (\ file_path\: :ref:`String`, change_type\: :ref:`ChangeType`, area\: :ref:`TreeArea`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_error`\ (\ msg\: :ref:`String`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -210,7 +210,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_checkout_branch** **(** :ref:`String` branch_name **)** |virtual| +:ref:`bool` **_checkout_branch**\ (\ branch_name\: :ref:`String`\ ) |virtual| Checks out a ``branch_name`` in the VCS. @@ -222,7 +222,7 @@ Checks out a ``branch_name`` in the VCS. .. rst-class:: classref-method -void **_commit** **(** :ref:`String` msg **)** |virtual| +|void| **_commit**\ (\ msg\: :ref:`String`\ ) |virtual| Commits the currently staged changes and applies the commit ``msg`` to the resulting commit. @@ -234,7 +234,7 @@ Commits the currently staged changes and applies the commit ``msg`` to the resul .. rst-class:: classref-method -void **_create_branch** **(** :ref:`String` branch_name **)** |virtual| +|void| **_create_branch**\ (\ branch_name\: :ref:`String`\ ) |virtual| Creates a new branch named ``branch_name`` in the VCS. @@ -246,7 +246,7 @@ Creates a new branch named ``branch_name`` in the VCS. .. rst-class:: classref-method -void **_create_remote** **(** :ref:`String` remote_name, :ref:`String` remote_url **)** |virtual| +|void| **_create_remote**\ (\ remote_name\: :ref:`String`, remote_url\: :ref:`String`\ ) |virtual| Creates a new remote destination with name ``remote_name`` and points it to ``remote_url``. This can be an HTTPS remote or an SSH remote. @@ -258,7 +258,7 @@ Creates a new remote destination with name ``remote_name`` and points it to ``re .. rst-class:: classref-method -void **_discard_file** **(** :ref:`String` file_path **)** |virtual| +|void| **_discard_file**\ (\ file_path\: :ref:`String`\ ) |virtual| Discards the changes made in a file present at ``file_path``. @@ -270,7 +270,7 @@ Discards the changes made in a file present at ``file_path``. .. rst-class:: classref-method -void **_fetch** **(** :ref:`String` remote **)** |virtual| +|void| **_fetch**\ (\ remote\: :ref:`String`\ ) |virtual| Fetches new changes from the ``remote``, but doesn't write changes to the current working directory. Equivalent to ``git fetch``. @@ -282,7 +282,7 @@ Fetches new changes from the ``remote``, but doesn't write changes to the curren .. rst-class:: classref-method -:ref:`String[]` **_get_branch_list** **(** **)** |virtual| +:ref:`Array`\[:ref:`String`\] **_get_branch_list**\ (\ ) |virtual| Gets an instance of an :ref:`Array` of :ref:`String`\ s containing available branch names in the VCS. @@ -294,7 +294,7 @@ Gets an instance of an :ref:`Array` of :ref:`String`\ .. rst-class:: classref-method -:ref:`String` **_get_current_branch_name** **(** **)** |virtual| +:ref:`String` **_get_current_branch_name**\ (\ ) |virtual| Gets the current branch name defined in the VCS. @@ -306,7 +306,7 @@ Gets the current branch name defined in the VCS. .. rst-class:: classref-method -:ref:`Dictionary[]` **_get_diff** **(** :ref:`String` identifier, :ref:`int` area **)** |virtual| +:ref:`Array`\[:ref:`Dictionary`\] **_get_diff**\ (\ identifier\: :ref:`String`, area\: :ref:`int`\ ) |virtual| Returns an array of :ref:`Dictionary` items (see :ref:`create_diff_file`, :ref:`create_diff_hunk`, :ref:`create_diff_line`, :ref:`add_line_diffs_into_diff_hunk` and :ref:`add_diff_hunks_into_diff_file`), each containing information about a diff. If ``identifier`` is a file path, returns a file diff, and if it is a commit identifier, then returns a commit diff. @@ -318,7 +318,7 @@ Returns an array of :ref:`Dictionary` items (see :ref:`create_ .. rst-class:: classref-method -:ref:`Dictionary[]` **_get_line_diff** **(** :ref:`String` file_path, :ref:`String` text **)** |virtual| +:ref:`Array`\[:ref:`Dictionary`\] **_get_line_diff**\ (\ file_path\: :ref:`String`, text\: :ref:`String`\ ) |virtual| Returns an :ref:`Array` of :ref:`Dictionary` items (see :ref:`create_diff_hunk`), each containing a line diff between a file at ``file_path`` and the ``text`` which is passed in. @@ -330,7 +330,7 @@ Returns an :ref:`Array` of :ref:`Dictionary` item .. rst-class:: classref-method -:ref:`Dictionary[]` **_get_modified_files_data** **(** **)** |virtual| +:ref:`Array`\[:ref:`Dictionary`\] **_get_modified_files_data**\ (\ ) |virtual| Returns an :ref:`Array` of :ref:`Dictionary` items (see :ref:`create_status_file`), each containing the status data of every modified file in the project folder. @@ -342,7 +342,7 @@ Returns an :ref:`Array` of :ref:`Dictionary` item .. rst-class:: classref-method -:ref:`Dictionary[]` **_get_previous_commits** **(** :ref:`int` max_commits **)** |virtual| +:ref:`Array`\[:ref:`Dictionary`\] **_get_previous_commits**\ (\ max_commits\: :ref:`int`\ ) |virtual| Returns an :ref:`Array` of :ref:`Dictionary` items (see :ref:`create_commit`), each containing the data for a past commit. @@ -354,7 +354,7 @@ Returns an :ref:`Array` of :ref:`Dictionary` item .. rst-class:: classref-method -:ref:`String[]` **_get_remotes** **(** **)** |virtual| +:ref:`Array`\[:ref:`String`\] **_get_remotes**\ (\ ) |virtual| Returns an :ref:`Array` of :ref:`String`\ s, each containing the name of a remote configured in the VCS. @@ -366,7 +366,7 @@ Returns an :ref:`Array` of :ref:`String`\ s, each con .. rst-class:: classref-method -:ref:`String` **_get_vcs_name** **(** **)** |virtual| +:ref:`String` **_get_vcs_name**\ (\ ) |virtual| Returns the name of the underlying VCS provider. @@ -378,7 +378,7 @@ Returns the name of the underlying VCS provider. .. rst-class:: classref-method -:ref:`bool` **_initialize** **(** :ref:`String` project_path **)** |virtual| +:ref:`bool` **_initialize**\ (\ project_path\: :ref:`String`\ ) |virtual| Initializes the VCS plugin when called from the editor. Returns whether or not the plugin was successfully initialized. A VCS project is initialized at ``project_path``. @@ -390,7 +390,7 @@ Initializes the VCS plugin when called from the editor. Returns whether or not t .. rst-class:: classref-method -void **_pull** **(** :ref:`String` remote **)** |virtual| +|void| **_pull**\ (\ remote\: :ref:`String`\ ) |virtual| Pulls changes from the remote. This can give rise to merge conflicts. @@ -402,7 +402,7 @@ Pulls changes from the remote. This can give rise to merge conflicts. .. rst-class:: classref-method -void **_push** **(** :ref:`String` remote, :ref:`bool` force **)** |virtual| +|void| **_push**\ (\ remote\: :ref:`String`, force\: :ref:`bool`\ ) |virtual| Pushes changes to the ``remote``. If ``force`` is ``true``, a force push will override the change history already present on the remote. @@ -414,7 +414,7 @@ Pushes changes to the ``remote``. If ``force`` is ``true``, a force push will ov .. rst-class:: classref-method -void **_remove_branch** **(** :ref:`String` branch_name **)** |virtual| +|void| **_remove_branch**\ (\ branch_name\: :ref:`String`\ ) |virtual| Remove a branch from the local VCS. @@ -426,7 +426,7 @@ Remove a branch from the local VCS. .. rst-class:: classref-method -void **_remove_remote** **(** :ref:`String` remote_name **)** |virtual| +|void| **_remove_remote**\ (\ remote_name\: :ref:`String`\ ) |virtual| Remove a remote from the local VCS. @@ -438,7 +438,7 @@ Remove a remote from the local VCS. .. rst-class:: classref-method -void **_set_credentials** **(** :ref:`String` username, :ref:`String` password, :ref:`String` ssh_public_key_path, :ref:`String` ssh_private_key_path, :ref:`String` ssh_passphrase **)** |virtual| +|void| **_set_credentials**\ (\ username\: :ref:`String`, password\: :ref:`String`, ssh_public_key_path\: :ref:`String`, ssh_private_key_path\: :ref:`String`, ssh_passphrase\: :ref:`String`\ ) |virtual| Set user credentials in the underlying VCS. ``username`` and ``password`` are used only during HTTPS authentication unless not already mentioned in the remote URL. ``ssh_public_key_path``, ``ssh_private_key_path``, and ``ssh_passphrase`` are only used during SSH authentication. @@ -450,7 +450,7 @@ Set user credentials in the underlying VCS. ``username`` and ``password`` are us .. rst-class:: classref-method -:ref:`bool` **_shut_down** **(** **)** |virtual| +:ref:`bool` **_shut_down**\ (\ ) |virtual| Shuts down VCS plugin instance. Called when the user either closes the editor or shuts down the VCS plugin through the editor UI. @@ -462,7 +462,7 @@ Shuts down VCS plugin instance. Called when the user either closes the editor or .. rst-class:: classref-method -void **_stage_file** **(** :ref:`String` file_path **)** |virtual| +|void| **_stage_file**\ (\ file_path\: :ref:`String`\ ) |virtual| Stages the file present at ``file_path`` to the staged area. @@ -474,7 +474,7 @@ Stages the file present at ``file_path`` to the staged area. .. rst-class:: classref-method -void **_unstage_file** **(** :ref:`String` file_path **)** |virtual| +|void| **_unstage_file**\ (\ file_path\: :ref:`String`\ ) |virtual| Unstages the file present at ``file_path`` from the staged area to the unstaged area. @@ -486,7 +486,7 @@ Unstages the file present at ``file_path`` from the staged area to the unstaged .. rst-class:: classref-method -:ref:`Dictionary` **add_diff_hunks_into_diff_file** **(** :ref:`Dictionary` diff_file, :ref:`Dictionary[]` diff_hunks **)** +:ref:`Dictionary` **add_diff_hunks_into_diff_file**\ (\ diff_file\: :ref:`Dictionary`, diff_hunks\: :ref:`Array`\[:ref:`Dictionary`\]\ ) Helper function to add an array of ``diff_hunks`` into a ``diff_file``. @@ -498,7 +498,7 @@ Helper function to add an array of ``diff_hunks`` into a ``diff_file``. .. rst-class:: classref-method -:ref:`Dictionary` **add_line_diffs_into_diff_hunk** **(** :ref:`Dictionary` diff_hunk, :ref:`Dictionary[]` line_diffs **)** +:ref:`Dictionary` **add_line_diffs_into_diff_hunk**\ (\ diff_hunk\: :ref:`Dictionary`, line_diffs\: :ref:`Array`\[:ref:`Dictionary`\]\ ) Helper function to add an array of ``line_diffs`` into a ``diff_hunk``. @@ -510,7 +510,7 @@ Helper function to add an array of ``line_diffs`` into a ``diff_hunk``. .. rst-class:: classref-method -:ref:`Dictionary` **create_commit** **(** :ref:`String` msg, :ref:`String` author, :ref:`String` id, :ref:`int` unix_timestamp, :ref:`int` offset_minutes **)** +:ref:`Dictionary` **create_commit**\ (\ msg\: :ref:`String`, author\: :ref:`String`, id\: :ref:`String`, unix_timestamp\: :ref:`int`, offset_minutes\: :ref:`int`\ ) Helper function to create a commit :ref:`Dictionary` item. ``msg`` is the commit message of the commit. ``author`` is a single human-readable string containing all the author's details, e.g. the email and name configured in the VCS. ``id`` is the identifier of the commit, in whichever format your VCS may provide an identifier to commits. ``unix_timestamp`` is the UTC Unix timestamp of when the commit was created. ``offset_minutes`` is the timezone offset in minutes, recorded from the system timezone where the commit was created. @@ -522,7 +522,7 @@ Helper function to create a commit :ref:`Dictionary` item. ``m .. rst-class:: classref-method -:ref:`Dictionary` **create_diff_file** **(** :ref:`String` new_file, :ref:`String` old_file **)** +:ref:`Dictionary` **create_diff_file**\ (\ new_file\: :ref:`String`, old_file\: :ref:`String`\ ) Helper function to create a :ref:`Dictionary` for storing old and new diff file paths. @@ -534,7 +534,7 @@ Helper function to create a :ref:`Dictionary` for storing old .. rst-class:: classref-method -:ref:`Dictionary` **create_diff_hunk** **(** :ref:`int` old_start, :ref:`int` new_start, :ref:`int` old_lines, :ref:`int` new_lines **)** +:ref:`Dictionary` **create_diff_hunk**\ (\ old_start\: :ref:`int`, new_start\: :ref:`int`, old_lines\: :ref:`int`, new_lines\: :ref:`int`\ ) Helper function to create a :ref:`Dictionary` for storing diff hunk data. ``old_start`` is the starting line number in old file. ``new_start`` is the starting line number in new file. ``old_lines`` is the number of lines in the old file. ``new_lines`` is the number of lines in the new file. @@ -546,7 +546,7 @@ Helper function to create a :ref:`Dictionary` for storing diff .. rst-class:: classref-method -:ref:`Dictionary` **create_diff_line** **(** :ref:`int` new_line_no, :ref:`int` old_line_no, :ref:`String` content, :ref:`String` status **)** +:ref:`Dictionary` **create_diff_line**\ (\ new_line_no\: :ref:`int`, old_line_no\: :ref:`int`, content\: :ref:`String`, status\: :ref:`String`\ ) Helper function to create a :ref:`Dictionary` for storing a line diff. ``new_line_no`` is the line number in the new file (can be ``-1`` if the line is deleted). ``old_line_no`` is the line number in the old file (can be ``-1`` if the line is added). ``content`` is the diff text. ``status`` is a single character string which stores the line origin. @@ -558,7 +558,7 @@ Helper function to create a :ref:`Dictionary` for storing a li .. rst-class:: classref-method -:ref:`Dictionary` **create_status_file** **(** :ref:`String` file_path, :ref:`ChangeType` change_type, :ref:`TreeArea` area **)** +:ref:`Dictionary` **create_status_file**\ (\ file_path\: :ref:`String`, change_type\: :ref:`ChangeType`, area\: :ref:`TreeArea`\ ) Helper function to create a :ref:`Dictionary` used by editor to read the status of a file. @@ -570,7 +570,7 @@ Helper function to create a :ref:`Dictionary` used by editor t .. rst-class:: classref-method -void **popup_error** **(** :ref:`String` msg **)** +|void| **popup_error**\ (\ msg\: :ref:`String`\ ) Pops up an error message in the editor which is shown as coming from the underlying VCS. Use this to show VCS specific error messages. @@ -581,3 +581,4 @@ Pops up an error message in the editor which is shown as coming from the underly .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_encodedobjectasid.rst b/classes/class_encodedobjectasid.rst index 662dd39d5eb..bf4872b2506 100644 --- a/classes/class_encodedobjectasid.rst +++ b/classes/class_encodedobjectasid.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_object_id** **(** :ref:`int` value **)** -- :ref:`int` **get_object_id** **(** **)** +- |void| **set_object_id**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_object_id**\ (\ ) The :ref:`Object` identifier stored in this **EncodedObjectAsID** instance. The object instance can be retrieved with :ref:`@GlobalScope.instance_from_id`. @@ -64,3 +64,4 @@ The :ref:`Object` identifier stored in this **EncodedObjectAsID** .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_enetconnection.rst b/classes/class_enetconnection.rst index aab015037a7..ae3a2b0be06 100644 --- a/classes/class_enetconnection.rst +++ b/classes/class_enetconnection.rst @@ -36,43 +36,43 @@ Methods .. table:: :widths: auto - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`bandwidth_limit` **(** :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`broadcast` **(** :ref:`int` channel, :ref:`PackedByteArray` packet, :ref:`int` flags **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`channel_limit` **(** :ref:`int` limit **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`compress` **(** :ref:`CompressionMode` mode **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ENetPacketPeer` | :ref:`connect_to_host` **(** :ref:`String` address, :ref:`int` port, :ref:`int` channels=0, :ref:`int` data=0 **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`create_host` **(** :ref:`int` max_peers=32, :ref:`int` max_channels=0, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`create_host_bound` **(** :ref:`String` bind_address, :ref:`int` bind_port, :ref:`int` max_peers=32, :ref:`int` max_channels=0, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`destroy` **(** **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`dtls_client_setup` **(** :ref:`String` hostname, :ref:`TLSOptions` client_options=null **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`dtls_server_setup` **(** :ref:`TLSOptions` server_options **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`flush` **(** **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_local_port` **(** **)** |const| | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_max_channels` **(** **)** |const| | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ENetPacketPeer[]` | :ref:`get_peers` **(** **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`pop_statistic` **(** :ref:`HostStatistic` statistic **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`refuse_new_connections` **(** :ref:`bool` refuse **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`service` **(** :ref:`int` timeout=0 **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`socket_send` **(** :ref:`String` destination_address, :ref:`int` destination_port, :ref:`PackedByteArray` packet **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bandwidth_limit`\ (\ in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`broadcast`\ (\ channel\: :ref:`int`, packet\: :ref:`PackedByteArray`, flags\: :ref:`int`\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`channel_limit`\ (\ limit\: :ref:`int`\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`compress`\ (\ mode\: :ref:`CompressionMode`\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ENetPacketPeer` | :ref:`connect_to_host`\ (\ address\: :ref:`String`, port\: :ref:`int`, channels\: :ref:`int` = 0, data\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`create_host`\ (\ max_peers\: :ref:`int` = 32, max_channels\: :ref:`int` = 0, in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`create_host_bound`\ (\ bind_address\: :ref:`String`, bind_port\: :ref:`int`, max_peers\: :ref:`int` = 32, max_channels\: :ref:`int` = 0, in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`destroy`\ (\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`dtls_client_setup`\ (\ hostname\: :ref:`String`, client_options\: :ref:`TLSOptions` = null\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`dtls_server_setup`\ (\ server_options\: :ref:`TLSOptions`\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`flush`\ (\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_local_port`\ (\ ) |const| | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_max_channels`\ (\ ) |const| | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`ENetPacketPeer`\] | :ref:`get_peers`\ (\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`pop_statistic`\ (\ statistic\: :ref:`HostStatistic`\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`refuse_new_connections`\ (\ refuse\: :ref:`bool`\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`service`\ (\ timeout\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`socket_send`\ (\ destination_address\: :ref:`String`, destination_port\: :ref:`int`, packet\: :ref:`PackedByteArray`\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -234,7 +234,7 @@ Method Descriptions .. rst-class:: classref-method -void **bandwidth_limit** **(** :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** +|void| **bandwidth_limit**\ (\ in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0\ ) Adjusts the bandwidth limits of a host. @@ -246,7 +246,7 @@ Adjusts the bandwidth limits of a host. .. rst-class:: classref-method -void **broadcast** **(** :ref:`int` channel, :ref:`PackedByteArray` packet, :ref:`int` flags **)** +|void| **broadcast**\ (\ channel\: :ref:`int`, packet\: :ref:`PackedByteArray`, flags\: :ref:`int`\ ) Queues a ``packet`` to be sent to all peers associated with the host over the specified ``channel``. See :ref:`ENetPacketPeer` ``FLAG_*`` constants for available packet flags. @@ -258,7 +258,7 @@ Queues a ``packet`` to be sent to all peers associated with the host over the sp .. rst-class:: classref-method -void **channel_limit** **(** :ref:`int` limit **)** +|void| **channel_limit**\ (\ limit\: :ref:`int`\ ) Limits the maximum allowed channels of future incoming connections. @@ -270,7 +270,7 @@ Limits the maximum allowed channels of future incoming connections. .. rst-class:: classref-method -void **compress** **(** :ref:`CompressionMode` mode **)** +|void| **compress**\ (\ mode\: :ref:`CompressionMode`\ ) Sets the compression method used for network packets. These have different tradeoffs of compression speed versus bandwidth, you may need to test which one works best for your use case if you use compression at all. @@ -286,7 +286,7 @@ Sets the compression method used for network packets. These have different trade .. rst-class:: classref-method -:ref:`ENetPacketPeer` **connect_to_host** **(** :ref:`String` address, :ref:`int` port, :ref:`int` channels=0, :ref:`int` data=0 **)** +:ref:`ENetPacketPeer` **connect_to_host**\ (\ address\: :ref:`String`, port\: :ref:`int`, channels\: :ref:`int` = 0, data\: :ref:`int` = 0\ ) Initiates a connection to a foreign ``address`` using the specified ``port`` and allocating the requested ``channels``. Optional ``data`` can be passed during connection in the form of a 32 bit integer. @@ -300,7 +300,7 @@ Initiates a connection to a foreign ``address`` using the specified ``port`` and .. rst-class:: classref-method -:ref:`Error` **create_host** **(** :ref:`int` max_peers=32, :ref:`int` max_channels=0, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** +:ref:`Error` **create_host**\ (\ max_peers\: :ref:`int` = 32, max_channels\: :ref:`int` = 0, in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0\ ) Create an ENetHost that will allow up to ``max_peers`` connected peers, each allocating up to ``max_channels`` channels, optionally limiting bandwidth to ``in_bandwidth`` and ``out_bandwidth``. @@ -312,7 +312,7 @@ Create an ENetHost that will allow up to ``max_peers`` connected peers, each all .. rst-class:: classref-method -:ref:`Error` **create_host_bound** **(** :ref:`String` bind_address, :ref:`int` bind_port, :ref:`int` max_peers=32, :ref:`int` max_channels=0, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** +:ref:`Error` **create_host_bound**\ (\ bind_address\: :ref:`String`, bind_port\: :ref:`int`, max_peers\: :ref:`int` = 32, max_channels\: :ref:`int` = 0, in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0\ ) Create an ENetHost like :ref:`create_host` which is also bound to the given ``bind_address`` and ``bind_port``. @@ -324,7 +324,7 @@ Create an ENetHost like :ref:`create_host` **dtls_client_setup** **(** :ref:`String` hostname, :ref:`TLSOptions` client_options=null **)** +:ref:`Error` **dtls_client_setup**\ (\ hostname\: :ref:`String`, client_options\: :ref:`TLSOptions` = null\ ) Configure this ENetHost to use the custom Godot extension allowing DTLS encryption for ENet clients. Call this before :ref:`connect_to_host` to have ENet connect using DTLS validating the server certificate against ``hostname``. You can pass the optional ``client_options`` parameter to customize the trusted certification authorities, or disable the common name verification. See :ref:`TLSOptions.client` and :ref:`TLSOptions.client_unsafe`. @@ -348,7 +348,7 @@ Configure this ENetHost to use the custom Godot extension allowing DTLS encrypti .. rst-class:: classref-method -:ref:`Error` **dtls_server_setup** **(** :ref:`TLSOptions` server_options **)** +:ref:`Error` **dtls_server_setup**\ (\ server_options\: :ref:`TLSOptions`\ ) Configure this ENetHost to use the custom Godot extension allowing DTLS encryption for ENet servers. Call this right after :ref:`create_host_bound` to have ENet expect peers to connect using DTLS. See :ref:`TLSOptions.server`. @@ -360,7 +360,7 @@ Configure this ENetHost to use the custom Godot extension allowing DTLS encrypti .. rst-class:: classref-method -void **flush** **(** **)** +|void| **flush**\ (\ ) Sends any queued packets on the host specified to its designated peers. @@ -372,7 +372,7 @@ Sends any queued packets on the host specified to its designated peers. .. rst-class:: classref-method -:ref:`int` **get_local_port** **(** **)** |const| +:ref:`int` **get_local_port**\ (\ ) |const| Returns the local port to which this peer is bound. @@ -384,7 +384,7 @@ Returns the local port to which this peer is bound. .. rst-class:: classref-method -:ref:`int` **get_max_channels** **(** **)** |const| +:ref:`int` **get_max_channels**\ (\ ) |const| Returns the maximum number of channels allowed for connected peers. @@ -396,7 +396,7 @@ Returns the maximum number of channels allowed for connected peers. .. rst-class:: classref-method -:ref:`ENetPacketPeer[]` **get_peers** **(** **)** +:ref:`Array`\[:ref:`ENetPacketPeer`\] **get_peers**\ (\ ) Returns the list of peers associated with this host. @@ -410,7 +410,7 @@ Returns the list of peers associated with this host. .. rst-class:: classref-method -:ref:`float` **pop_statistic** **(** :ref:`HostStatistic` statistic **)** +:ref:`float` **pop_statistic**\ (\ statistic\: :ref:`HostStatistic`\ ) Returns and resets host statistics. See :ref:`HostStatistic` for more info. @@ -422,7 +422,7 @@ Returns and resets host statistics. See :ref:`HostStatistic` refuse **)** +|void| **refuse_new_connections**\ (\ refuse\: :ref:`bool`\ ) Configures the DTLS server to automatically drop new connections. @@ -436,7 +436,7 @@ Configures the DTLS server to automatically drop new connections. .. rst-class:: classref-method -:ref:`Array` **service** **(** :ref:`int` timeout=0 **)** +:ref:`Array` **service**\ (\ timeout\: :ref:`int` = 0\ ) Waits for events on the host specified and shuttles packets between the host and its peers. The returned :ref:`Array` will have 4 elements. An :ref:`EventType`, the :ref:`ENetPacketPeer` which generated the event, the event associated data (if any), the event associated channel (if any). If the generated event is :ref:`EVENT_RECEIVE`, the received packet will be queued to the associated :ref:`ENetPacketPeer`. @@ -450,7 +450,7 @@ Call this function regularly to handle connections, disconnections, and to recei .. rst-class:: classref-method -void **socket_send** **(** :ref:`String` destination_address, :ref:`int` destination_port, :ref:`PackedByteArray` packet **)** +|void| **socket_send**\ (\ destination_address\: :ref:`String`, destination_port\: :ref:`int`, packet\: :ref:`PackedByteArray`\ ) Sends a ``packet`` toward a destination from the address and port currently bound by this ENetConnection instance. @@ -465,3 +465,4 @@ This requires forward knowledge of a prospective client's address and communicat .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_enetmultiplayerpeer.rst b/classes/class_enetmultiplayerpeer.rst index 15d016ede4b..2c539c06a16 100644 --- a/classes/class_enetmultiplayerpeer.rst +++ b/classes/class_enetmultiplayerpeer.rst @@ -52,19 +52,19 @@ Methods .. table:: :widths: auto - +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`add_mesh_peer` **(** :ref:`int` peer_id, :ref:`ENetConnection` host **)** | - +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`create_client` **(** :ref:`String` address, :ref:`int` port, :ref:`int` channel_count=0, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0, :ref:`int` local_port=0 **)** | - +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`create_mesh` **(** :ref:`int` unique_id **)** | - +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`create_server` **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` max_channels=0, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** | - +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ENetPacketPeer` | :ref:`get_peer` **(** :ref:`int` id **)** |const| | - +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bind_ip` **(** :ref:`String` ip **)** | - +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`add_mesh_peer`\ (\ peer_id\: :ref:`int`, host\: :ref:`ENetConnection`\ ) | + +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`create_client`\ (\ address\: :ref:`String`, port\: :ref:`int`, channel_count\: :ref:`int` = 0, in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0, local_port\: :ref:`int` = 0\ ) | + +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`create_mesh`\ (\ unique_id\: :ref:`int`\ ) | + +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`create_server`\ (\ port\: :ref:`int`, max_clients\: :ref:`int` = 32, max_channels\: :ref:`int` = 0, in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0\ ) | + +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ENetPacketPeer` | :ref:`get_peer`\ (\ id\: :ref:`int`\ ) |const| | + +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bind_ip`\ (\ ip\: :ref:`String`\ ) | + +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -83,7 +83,7 @@ Property Descriptions .. rst-class:: classref-property-setget -- :ref:`ENetConnection` **get_host** **(** **)** +- :ref:`ENetConnection` **get_host**\ (\ ) The underlying :ref:`ENetConnection` created after :ref:`create_client` and :ref:`create_server`. @@ -100,7 +100,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **add_mesh_peer** **(** :ref:`int` peer_id, :ref:`ENetConnection` host **)** +:ref:`Error` **add_mesh_peer**\ (\ peer_id\: :ref:`int`, host\: :ref:`ENetConnection`\ ) Add a new remote peer with the given ``peer_id`` connected to the given ``host``. @@ -114,7 +114,7 @@ Add a new remote peer with the given ``peer_id`` connected to the given ``host`` .. rst-class:: classref-method -:ref:`Error` **create_client** **(** :ref:`String` address, :ref:`int` port, :ref:`int` channel_count=0, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0, :ref:`int` local_port=0 **)** +:ref:`Error` **create_client**\ (\ address\: :ref:`String`, port\: :ref:`int`, channel_count\: :ref:`int` = 0, in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0, local_port\: :ref:`int` = 0\ ) Create client that connects to a server at ``address`` using specified ``port``. The given address needs to be either a fully qualified domain name (e.g. ``"www.example.com"``) or an IP address in IPv4 or IPv6 format (e.g. ``"192.168.1.1"``). The ``port`` is the port the server is listening on. The ``channel_count`` parameter can be used to specify the number of ENet channels allocated for the connection. The ``in_bandwidth`` and ``out_bandwidth`` parameters can be used to limit the incoming and outgoing bandwidth to the given number of bytes per second. The default of 0 means unlimited bandwidth. Note that ENet will strategically drop packets on specific sides of a connection between peers to ensure the peer's bandwidth is not overwhelmed. The bandwidth parameters also determine the window size of a connection which limits the amount of reliable packets that may be in transit at any given time. Returns :ref:`@GlobalScope.OK` if a client was created, :ref:`@GlobalScope.ERR_ALREADY_IN_USE` if this ENetMultiplayerPeer instance already has an open connection (in which case you need to call :ref:`MultiplayerPeer.close` first) or :ref:`@GlobalScope.ERR_CANT_CREATE` if the client could not be created. If ``local_port`` is specified, the client will also listen to the given port; this is useful for some NAT traversal techniques. @@ -126,7 +126,7 @@ Create client that connects to a server at ``address`` using specified ``port``. .. rst-class:: classref-method -:ref:`Error` **create_mesh** **(** :ref:`int` unique_id **)** +:ref:`Error` **create_mesh**\ (\ unique_id\: :ref:`int`\ ) Initialize this :ref:`MultiplayerPeer` in mesh mode. The provided ``unique_id`` will be used as the local peer network unique ID once assigned as the :ref:`MultiplayerAPI.multiplayer_peer`. In the mesh configuration you will need to set up each new peer manually using :ref:`ENetConnection` before calling :ref:`add_mesh_peer`. While this technique is more advanced, it allows for better control over the connection process (e.g. when dealing with NAT punch-through) and for better distribution of the network load (which would otherwise be more taxing on the server). @@ -138,7 +138,7 @@ Initialize this :ref:`MultiplayerPeer` in mesh mode. The .. rst-class:: classref-method -:ref:`Error` **create_server** **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` max_channels=0, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** +:ref:`Error` **create_server**\ (\ port\: :ref:`int`, max_clients\: :ref:`int` = 32, max_channels\: :ref:`int` = 0, in_bandwidth\: :ref:`int` = 0, out_bandwidth\: :ref:`int` = 0\ ) Create server that listens to connections via ``port``. The port needs to be an available, unused port between 0 and 65535. Note that ports below 1024 are privileged and may require elevated permissions depending on the platform. To change the interface the server listens on, use :ref:`set_bind_ip`. The default IP is the wildcard ``"*"``, which listens on all available interfaces. ``max_clients`` is the maximum number of clients that are allowed at once, any number up to 4095 may be used, although the achievable number of simultaneous clients may be far lower and depends on the application. For additional details on the bandwidth parameters, see :ref:`create_client`. Returns :ref:`@GlobalScope.OK` if a server was created, :ref:`@GlobalScope.ERR_ALREADY_IN_USE` if this ENetMultiplayerPeer instance already has an open connection (in which case you need to call :ref:`MultiplayerPeer.close` first) or :ref:`@GlobalScope.ERR_CANT_CREATE` if the server could not be created. @@ -150,7 +150,7 @@ Create server that listens to connections via ``port``. The port needs to be an .. rst-class:: classref-method -:ref:`ENetPacketPeer` **get_peer** **(** :ref:`int` id **)** |const| +:ref:`ENetPacketPeer` **get_peer**\ (\ id\: :ref:`int`\ ) |const| Returns the :ref:`ENetPacketPeer` associated to the given ``id``. @@ -162,7 +162,7 @@ Returns the :ref:`ENetPacketPeer` associated to the given .. rst-class:: classref-method -void **set_bind_ip** **(** :ref:`String` ip **)** +|void| **set_bind_ip**\ (\ ip\: :ref:`String`\ ) The IP used when creating a server. This is set to the wildcard ``"*"`` by default, which binds to all available interfaces. The given IP needs to be in IPv4 or IPv6 address format, for example: ``"192.168.1.1"``. @@ -173,3 +173,4 @@ The IP used when creating a server. This is set to the wildcard ``"*"`` by defau .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_enetpacketpeer.rst b/classes/class_enetpacketpeer.rst index 78755e1f9ca..d07b79c2f92 100644 --- a/classes/class_enetpacketpeer.rst +++ b/classes/class_enetpacketpeer.rst @@ -40,37 +40,37 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_channels` **(** **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_remote_address` **(** **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_remote_port` **(** **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PeerState` | :ref:`get_state` **(** **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_statistic` **(** :ref:`PeerStatistic` statistic **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_active` **(** **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`peer_disconnect` **(** :ref:`int` data=0 **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`peer_disconnect_later` **(** :ref:`int` data=0 **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`peer_disconnect_now` **(** :ref:`int` data=0 **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`ping` **(** **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`ping_interval` **(** :ref:`int` ping_interval **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reset` **(** **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`send` **(** :ref:`int` channel, :ref:`PackedByteArray` packet, :ref:`int` flags **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_timeout` **(** :ref:`int` timeout, :ref:`int` timeout_min, :ref:`int` timeout_max **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`throttle_configure` **(** :ref:`int` interval, :ref:`int` acceleration, :ref:`int` deceleration **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_channels`\ (\ ) |const| | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_remote_address`\ (\ ) |const| | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_remote_port`\ (\ ) |const| | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PeerState` | :ref:`get_state`\ (\ ) |const| | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_statistic`\ (\ statistic\: :ref:`PeerStatistic`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_active`\ (\ ) |const| | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`peer_disconnect`\ (\ data\: :ref:`int` = 0\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`peer_disconnect_later`\ (\ data\: :ref:`int` = 0\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`peer_disconnect_now`\ (\ data\: :ref:`int` = 0\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`ping`\ (\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`ping_interval`\ (\ ping_interval\: :ref:`int`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reset`\ (\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`send`\ (\ channel\: :ref:`int`, packet\: :ref:`PackedByteArray`, flags\: :ref:`int`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_timeout`\ (\ timeout\: :ref:`int`, timeout_min\: :ref:`int`, timeout_max\: :ref:`int`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`throttle_configure`\ (\ interval\: :ref:`int`, acceleration\: :ref:`int`, deceleration\: :ref:`int`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -351,7 +351,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_channels** **(** **)** |const| +:ref:`int` **get_channels**\ (\ ) |const| Returns the number of channels allocated for communication with peer. @@ -363,7 +363,7 @@ Returns the number of channels allocated for communication with peer. .. rst-class:: classref-method -:ref:`String` **get_remote_address** **(** **)** |const| +:ref:`String` **get_remote_address**\ (\ ) |const| Returns the IP address of this peer. @@ -375,7 +375,7 @@ Returns the IP address of this peer. .. rst-class:: classref-method -:ref:`int` **get_remote_port** **(** **)** |const| +:ref:`int` **get_remote_port**\ (\ ) |const| Returns the remote port of this peer. @@ -387,7 +387,7 @@ Returns the remote port of this peer. .. rst-class:: classref-method -:ref:`PeerState` **get_state** **(** **)** |const| +:ref:`PeerState` **get_state**\ (\ ) |const| Returns the current peer state. See :ref:`PeerState`. @@ -399,7 +399,7 @@ Returns the current peer state. See :ref:`PeerState` **get_statistic** **(** :ref:`PeerStatistic` statistic **)** +:ref:`float` **get_statistic**\ (\ statistic\: :ref:`PeerStatistic`\ ) Returns the requested ``statistic`` for this peer. See :ref:`PeerStatistic`. @@ -411,7 +411,7 @@ Returns the requested ``statistic`` for this peer. See :ref:`PeerStatistic` **is_active** **(** **)** |const| +:ref:`bool` **is_active**\ (\ ) |const| Returns ``true`` if the peer is currently active (i.e. the associated :ref:`ENetConnection` is still valid). @@ -423,7 +423,7 @@ Returns ``true`` if the peer is currently active (i.e. the associated :ref:`ENet .. rst-class:: classref-method -void **peer_disconnect** **(** :ref:`int` data=0 **)** +|void| **peer_disconnect**\ (\ data\: :ref:`int` = 0\ ) Request a disconnection from a peer. An :ref:`ENetConnection.EVENT_DISCONNECT` will be generated during :ref:`ENetConnection.service` once the disconnection is complete. @@ -435,7 +435,7 @@ Request a disconnection from a peer. An :ref:`ENetConnection.EVENT_DISCONNECT` data=0 **)** +|void| **peer_disconnect_later**\ (\ data\: :ref:`int` = 0\ ) Request a disconnection from a peer, but only after all queued outgoing packets are sent. An :ref:`ENetConnection.EVENT_DISCONNECT` will be generated during :ref:`ENetConnection.service` once the disconnection is complete. @@ -447,7 +447,7 @@ Request a disconnection from a peer, but only after all queued outgoing packets .. rst-class:: classref-method -void **peer_disconnect_now** **(** :ref:`int` data=0 **)** +|void| **peer_disconnect_now**\ (\ data\: :ref:`int` = 0\ ) Force an immediate disconnection from a peer. No :ref:`ENetConnection.EVENT_DISCONNECT` will be generated. The foreign peer is not guaranteed to receive the disconnect notification, and is reset immediately upon return from this function. @@ -459,7 +459,7 @@ Force an immediate disconnection from a peer. No :ref:`ENetConnection.EVENT_DISC .. rst-class:: classref-method -void **ping** **(** **)** +|void| **ping**\ (\ ) Sends a ping request to a peer. ENet automatically pings all connected peers at regular intervals, however, this function may be called to ensure more frequent ping requests. @@ -471,7 +471,7 @@ Sends a ping request to a peer. ENet automatically pings all connected peers at .. rst-class:: classref-method -void **ping_interval** **(** :ref:`int` ping_interval **)** +|void| **ping_interval**\ (\ ping_interval\: :ref:`int`\ ) Sets the ``ping_interval`` in milliseconds at which pings will be sent to a peer. Pings are used both to monitor the liveness of the connection and also to dynamically adjust the throttle during periods of low traffic so that the throttle has reasonable responsiveness during traffic spikes. The default ping interval is ``500`` milliseconds. @@ -483,7 +483,7 @@ Sets the ``ping_interval`` in milliseconds at which pings will be sent to a peer .. rst-class:: classref-method -void **reset** **(** **)** +|void| **reset**\ (\ ) Forcefully disconnects a peer. The foreign host represented by the peer is not notified of the disconnection and will timeout on its connection to the local host. @@ -495,7 +495,7 @@ Forcefully disconnects a peer. The foreign host represented by the peer is not n .. rst-class:: classref-method -:ref:`Error` **send** **(** :ref:`int` channel, :ref:`PackedByteArray` packet, :ref:`int` flags **)** +:ref:`Error` **send**\ (\ channel\: :ref:`int`, packet\: :ref:`PackedByteArray`, flags\: :ref:`int`\ ) Queues a ``packet`` to be sent over the specified ``channel``. See ``FLAG_*`` constants for available packet flags. @@ -507,7 +507,7 @@ Queues a ``packet`` to be sent over the specified ``channel``. See ``FLAG_*`` co .. rst-class:: classref-method -void **set_timeout** **(** :ref:`int` timeout, :ref:`int` timeout_min, :ref:`int` timeout_max **)** +|void| **set_timeout**\ (\ timeout\: :ref:`int`, timeout_min\: :ref:`int`, timeout_max\: :ref:`int`\ ) Sets the timeout parameters for a peer. The timeout parameters control how and when a peer will timeout from a failure to acknowledge reliable traffic. Timeout values are expressed in milliseconds. @@ -521,7 +521,7 @@ The ``timeout`` is a factor that, multiplied by a value based on the average rou .. rst-class:: classref-method -void **throttle_configure** **(** :ref:`int` interval, :ref:`int` acceleration, :ref:`int` deceleration **)** +|void| **throttle_configure**\ (\ interval\: :ref:`int`, acceleration\: :ref:`int`, deceleration\: :ref:`int`\ ) Configures throttle parameter for a peer. @@ -540,3 +540,4 @@ Intermediate values for the throttle represent intermediate probabilities betwee .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 25660895a2a..057b909b091 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -51,57 +51,57 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_architecture_name` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_author_info` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`get_copyright_info` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_donor_info` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_frames_drawn` **(** **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_frames_per_second` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_license_info` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_license_text` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`MainLoop` | :ref:`get_main_loop` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_physics_frames` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_physics_interpolation_fraction` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_process_frames` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ScriptLanguage` | :ref:`get_script_language` **(** :ref:`int` index **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_script_language_count` **(** **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_singleton` **(** :ref:`StringName` name **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_singleton_list` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_version_info` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_write_movie_path` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_singleton` **(** :ref:`StringName` name **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_editor_hint` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_in_physics_frame` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`register_script_language` **(** :ref:`ScriptLanguage` language **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`register_singleton` **(** :ref:`StringName` name, :ref:`Object` instance **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`unregister_script_language` **(** :ref:`ScriptLanguage` language **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`unregister_singleton` **(** :ref:`StringName` name **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_architecture_name`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_author_info`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_copyright_info`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_donor_info`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_frames_drawn`\ (\ ) | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_frames_per_second`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_license_info`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_license_text`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`MainLoop` | :ref:`get_main_loop`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_physics_frames`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_physics_interpolation_fraction`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_process_frames`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ScriptLanguage` | :ref:`get_script_language`\ (\ index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_script_language_count`\ (\ ) | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_singleton`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_singleton_list`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_version_info`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_write_movie_path`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_singleton`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_editor_hint`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_in_physics_frame`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`register_script_language`\ (\ language\: :ref:`ScriptLanguage`\ ) | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_singleton`\ (\ name\: :ref:`StringName`, instance\: :ref:`Object`\ ) | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`unregister_script_language`\ (\ language\: :ref:`ScriptLanguage`\ ) | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unregister_singleton`\ (\ name\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -120,8 +120,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_max_fps** **(** :ref:`int` value **)** -- :ref:`int` **get_max_fps** **(** **)** +- |void| **set_max_fps**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_fps**\ (\ ) The maximum number of frames per second that can be rendered. A value of ``0`` means "no limit". The actual number of frames per second may still be below this value if the CPU or GPU cannot keep up with the project logic and rendering. @@ -147,8 +147,8 @@ See also :ref:`physics_ticks_per_second` value **)** -- :ref:`int` **get_max_physics_steps_per_frame** **(** **)** +- |void| **set_max_physics_steps_per_frame**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_physics_steps_per_frame**\ (\ ) Controls the maximum number of physics steps that can be simulated each rendered frame. The default value is tuned to avoid "spiral of death" situations where expensive physics simulations trigger more expensive simulations indefinitely. However, the game will appear to slow down if the rendering FPS is less than ``1 / max_physics_steps_per_frame`` of :ref:`physics_ticks_per_second`. This occurs even if ``delta`` is consistently used in physics calculations. To avoid this, increase :ref:`max_physics_steps_per_frame` if you have increased :ref:`physics_ticks_per_second` significantly above its default value. @@ -164,8 +164,8 @@ Controls the maximum number of physics steps that can be simulated each rendered .. rst-class:: classref-property-setget -- void **set_physics_jitter_fix** **(** :ref:`float` value **)** -- :ref:`float` **get_physics_jitter_fix** **(** **)** +- |void| **set_physics_jitter_fix**\ (\ value\: :ref:`float`\ ) +- :ref:`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 good enough for most; values above 2 could cause the game to react to dropped frames with a noticeable delay and are not recommended. @@ -183,8 +183,8 @@ Controls how much physics ticks are synchronized with real time. For 0 or less, .. rst-class:: classref-property-setget -- void **set_physics_ticks_per_second** **(** :ref:`int` value **)** -- :ref:`int` **get_physics_ticks_per_second** **(** **)** +- |void| **set_physics_ticks_per_second**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_physics_ticks_per_second**\ (\ ) The number of fixed iterations per second. This controls how often physics simulation and :ref:`Node._physics_process` methods are run. This value should generally always be set to ``60`` or above, as Godot doesn't interpolate the physics step. As a result, values lower than ``60`` will look stuttery. This value can be increased to make input more reactive or work around collision tunneling issues, but keep in mind doing so will increase CPU usage. See also :ref:`max_fps` and :ref:`ProjectSettings.physics/common/physics_ticks_per_second`. @@ -202,8 +202,8 @@ The number of fixed iterations per second. This controls how often physics simul .. rst-class:: classref-property-setget -- void **set_print_error_messages** **(** :ref:`bool` value **)** -- :ref:`bool` **is_printing_error_messages** **(** **)** +- |void| **set_print_error_messages**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_printing_error_messages**\ (\ ) If ``false``, stops printing error and warning messages to the console and editor Output log. This can be used to hide error and warning messages during unit test suite runs. This property is equivalent to the :ref:`ProjectSettings.application/run/disable_stderr` project setting. @@ -223,8 +223,8 @@ If ``false``, stops printing error and warning messages to the console and edito .. rst-class:: classref-property-setget -- void **set_time_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_time_scale** **(** **)** +- |void| **set_time_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_time_scale**\ (\ ) Controls how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed. This also affects :ref:`Timer` and :ref:`SceneTreeTimer` (see :ref:`SceneTree.create_timer` for how to control this). @@ -245,7 +245,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **get_architecture_name** **(** **)** |const| +:ref:`String` **get_architecture_name**\ (\ ) |const| Returns the name of the CPU architecture the Godot binary was built for. Possible return values are ``x86_64``, ``x86_32``, ``arm64``, ``arm32``, ``rv64``, ``riscv``, ``ppc64``, ``ppc``, ``wasm64`` and ``wasm32``. @@ -280,7 +280,7 @@ To detect whether the current CPU architecture is 64-bit, you can use the fact t .. rst-class:: classref-method -:ref:`Dictionary` **get_author_info** **(** **)** |const| +:ref:`Dictionary` **get_author_info**\ (\ ) |const| Returns engine author information in a Dictionary. @@ -300,7 +300,7 @@ Returns engine author information in a Dictionary. .. rst-class:: classref-method -:ref:`Dictionary[]` **get_copyright_info** **(** **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_copyright_info**\ (\ ) |const| Returns an Array of copyright information Dictionaries. @@ -316,7 +316,7 @@ Returns an Array of copyright information Dictionaries. .. rst-class:: classref-method -:ref:`Dictionary` **get_donor_info** **(** **)** |const| +:ref:`Dictionary` **get_donor_info**\ (\ ) |const| Returns a Dictionary of Arrays of donor names. @@ -330,7 +330,7 @@ Returns a Dictionary of Arrays of donor names. .. rst-class:: classref-method -:ref:`int` **get_frames_drawn** **(** **)** +:ref:`int` **get_frames_drawn**\ (\ ) Returns the total number of frames drawn. On headless platforms, or if the render loop is disabled with ``--disable-render-loop`` via command line, :ref:`get_frames_drawn` always returns ``0``. See :ref:`get_process_frames`. @@ -342,7 +342,7 @@ Returns the total number of frames drawn. On headless platforms, or if the rende .. rst-class:: classref-method -:ref:`float` **get_frames_per_second** **(** **)** |const| +:ref:`float` **get_frames_per_second**\ (\ ) |const| Returns the frames per second of the running game. @@ -354,7 +354,7 @@ Returns the frames per second of the running game. .. rst-class:: classref-method -:ref:`Dictionary` **get_license_info** **(** **)** |const| +:ref:`Dictionary` **get_license_info**\ (\ ) |const| Returns Dictionary of licenses used by Godot and included third party components. @@ -366,7 +366,7 @@ Returns Dictionary of licenses used by Godot and included third party components .. rst-class:: classref-method -:ref:`String` **get_license_text** **(** **)** |const| +:ref:`String` **get_license_text**\ (\ ) |const| Returns Godot license text. @@ -378,7 +378,7 @@ Returns Godot license text. .. rst-class:: classref-method -:ref:`MainLoop` **get_main_loop** **(** **)** |const| +:ref:`MainLoop` **get_main_loop**\ (\ ) |const| Returns the main loop object (see :ref:`MainLoop` and :ref:`SceneTree`). @@ -390,7 +390,7 @@ Returns the main loop object (see :ref:`MainLoop` and :ref:`Scen .. rst-class:: classref-method -:ref:`int` **get_physics_frames** **(** **)** |const| +:ref:`int` **get_physics_frames**\ (\ ) |const| Returns the total number of frames passed since engine initialization which is advanced on each **physics frame**. See also :ref:`get_process_frames`. @@ -427,7 +427,7 @@ Returns the total number of frames passed since engine initialization which is a .. rst-class:: classref-method -:ref:`float` **get_physics_interpolation_fraction** **(** **)** |const| +:ref:`float` **get_physics_interpolation_fraction**\ (\ ) |const| Returns the fraction through the current physics tick we are at the time of rendering the frame. This can be used to implement fixed timestep interpolation. @@ -439,7 +439,7 @@ Returns the fraction through the current physics tick we are at the time of rend .. rst-class:: classref-method -:ref:`int` **get_process_frames** **(** **)** |const| +:ref:`int` **get_process_frames**\ (\ ) |const| Returns the total number of frames passed since engine initialization which is advanced on each **process frame**, regardless of whether the render loop is enabled. See also :ref:`get_frames_drawn` and :ref:`get_physics_frames`. @@ -476,7 +476,7 @@ Returns the total number of frames passed since engine initialization which is a .. rst-class:: classref-method -:ref:`ScriptLanguage` **get_script_language** **(** :ref:`int` index **)** |const| +:ref:`ScriptLanguage` **get_script_language**\ (\ index\: :ref:`int`\ ) |const| Returns an instance of a :ref:`ScriptLanguage` with the given index. @@ -488,7 +488,7 @@ Returns an instance of a :ref:`ScriptLanguage` with the gi .. rst-class:: classref-method -:ref:`int` **get_script_language_count** **(** **)** +:ref:`int` **get_script_language_count**\ (\ ) Returns the number of available script languages. Use with :ref:`get_script_language`. @@ -500,7 +500,7 @@ Returns the number of available script languages. Use with :ref:`get_script_lang .. rst-class:: classref-method -:ref:`Object` **get_singleton** **(** :ref:`StringName` name **)** |const| +:ref:`Object` **get_singleton**\ (\ name\: :ref:`StringName`\ ) |const| Returns a global singleton with given ``name``. Often used for plugins, e.g. GodotPayments. @@ -512,7 +512,7 @@ Returns a global singleton with given ``name``. Often used for plugins, e.g. God .. rst-class:: classref-method -:ref:`PackedStringArray` **get_singleton_list** **(** **)** |const| +:ref:`PackedStringArray` **get_singleton_list**\ (\ ) |const| Returns a list of available global singletons. @@ -524,7 +524,7 @@ Returns a list of available global singletons. .. rst-class:: classref-method -:ref:`Dictionary` **get_version_info** **(** **)** |const| +:ref:`Dictionary` **get_version_info**\ (\ ) |const| Returns the current engine version information in a Dictionary. @@ -577,7 +577,7 @@ The ``hex`` value is encoded as follows, from left to right: one byte for the ma .. rst-class:: classref-method -:ref:`String` **get_write_movie_path** **(** **)** |const| +:ref:`String` **get_write_movie_path**\ (\ ) |const| Returns the path to the :ref:`MovieWriter`'s output file, or an empty string if the engine wasn't started in Movie Maker mode. This path can be absolute or relative depending on how the user specified it. @@ -589,7 +589,7 @@ Returns the path to the :ref:`MovieWriter`'s output file, or .. rst-class:: classref-method -:ref:`bool` **has_singleton** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_singleton**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if a singleton with given ``name`` exists in global scope. @@ -601,7 +601,7 @@ Returns ``true`` if a singleton with given ``name`` exists in global scope. .. rst-class:: classref-method -:ref:`bool` **is_editor_hint** **(** **)** |const| +:ref:`bool` **is_editor_hint**\ (\ ) |const| Returns ``true`` if the script is currently running inside the editor, ``false`` otherwise. This is useful for ``@tool`` scripts to conditionally draw editor helpers, or prevent accidentally running "game" code that would affect the scene state while in the editor: @@ -636,7 +636,7 @@ See :doc:`Running code in the editor <../tutorials/plugins/running_code_in_the_e .. rst-class:: classref-method -:ref:`bool` **is_in_physics_frame** **(** **)** |const| +:ref:`bool` **is_in_physics_frame**\ (\ ) |const| Returns ``true`` if the game is inside the fixed process and physics phase of the game loop. @@ -648,7 +648,7 @@ Returns ``true`` if the game is inside the fixed process and physics phase of th .. rst-class:: classref-method -:ref:`Error` **register_script_language** **(** :ref:`ScriptLanguage` language **)** +:ref:`Error` **register_script_language**\ (\ language\: :ref:`ScriptLanguage`\ ) Registers a :ref:`ScriptLanguage` instance to be available with ``ScriptServer``. @@ -668,7 +668,7 @@ Returns: .. rst-class:: classref-method -void **register_singleton** **(** :ref:`StringName` name, :ref:`Object` instance **)** +|void| **register_singleton**\ (\ name\: :ref:`StringName`, instance\: :ref:`Object`\ ) Registers the given object as a singleton, globally available under ``name``. @@ -680,7 +680,7 @@ Registers the given object as a singleton, globally available under ``name``. .. rst-class:: classref-method -:ref:`Error` **unregister_script_language** **(** :ref:`ScriptLanguage` language **)** +:ref:`Error` **unregister_script_language**\ (\ language\: :ref:`ScriptLanguage`\ ) Unregisters the :ref:`ScriptLanguage` instance from ``ScriptServer``. @@ -698,7 +698,7 @@ Returns: .. rst-class:: classref-method -void **unregister_singleton** **(** :ref:`StringName` name **)** +|void| **unregister_singleton**\ (\ name\: :ref:`StringName`\ ) Unregisters the singleton registered under ``name``. The singleton object is not freed. Only works with user-defined singletons created with :ref:`register_singleton`. @@ -709,3 +709,4 @@ Unregisters the singleton registered under ``name``. The singleton object is not .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_enginedebugger.rst b/classes/class_enginedebugger.rst index f0c828bbde0..b84ffd6afce 100644 --- a/classes/class_enginedebugger.rst +++ b/classes/class_enginedebugger.rst @@ -29,29 +29,29 @@ Methods .. table:: :widths: auto - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_capture` **(** :ref:`StringName` name **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_profiler` **(** :ref:`StringName` name **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_active` **(** **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_profiling` **(** :ref:`StringName` name **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`profiler_add_frame_data` **(** :ref:`StringName` name, :ref:`Array` data **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`profiler_enable` **(** :ref:`StringName` name, :ref:`bool` enable, :ref:`Array` arguments=[] **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`register_message_capture` **(** :ref:`StringName` name, :ref:`Callable` callable **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`register_profiler` **(** :ref:`StringName` name, :ref:`EngineProfiler` profiler **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`send_message` **(** :ref:`String` message, :ref:`Array` data **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`unregister_message_capture` **(** :ref:`StringName` name **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`unregister_profiler` **(** :ref:`StringName` name **)** | - +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_capture`\ (\ name\: :ref:`StringName`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_profiler`\ (\ name\: :ref:`StringName`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_active`\ (\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_profiling`\ (\ name\: :ref:`StringName`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`profiler_add_frame_data`\ (\ name\: :ref:`StringName`, data\: :ref:`Array`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`profiler_enable`\ (\ name\: :ref:`StringName`, enable\: :ref:`bool`, arguments\: :ref:`Array` = []\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_message_capture`\ (\ name\: :ref:`StringName`, callable\: :ref:`Callable`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_profiler`\ (\ name\: :ref:`StringName`, profiler\: :ref:`EngineProfiler`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`send_message`\ (\ message\: :ref:`String`, data\: :ref:`Array`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unregister_message_capture`\ (\ name\: :ref:`StringName`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unregister_profiler`\ (\ name\: :ref:`StringName`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -66,7 +66,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **has_capture** **(** :ref:`StringName` name **)** +:ref:`bool` **has_capture**\ (\ name\: :ref:`StringName`\ ) Returns ``true`` if a capture with the given name is present otherwise ``false``. @@ -78,7 +78,7 @@ Returns ``true`` if a capture with the given name is present otherwise ``false`` .. rst-class:: classref-method -:ref:`bool` **has_profiler** **(** :ref:`StringName` name **)** +:ref:`bool` **has_profiler**\ (\ name\: :ref:`StringName`\ ) Returns ``true`` if a profiler with the given name is present otherwise ``false``. @@ -90,7 +90,7 @@ Returns ``true`` if a profiler with the given name is present otherwise ``false` .. rst-class:: classref-method -:ref:`bool` **is_active** **(** **)** +:ref:`bool` **is_active**\ (\ ) Returns ``true`` if the debugger is active otherwise ``false``. @@ -102,7 +102,7 @@ Returns ``true`` if the debugger is active otherwise ``false``. .. rst-class:: classref-method -:ref:`bool` **is_profiling** **(** :ref:`StringName` name **)** +:ref:`bool` **is_profiling**\ (\ name\: :ref:`StringName`\ ) Returns ``true`` if a profiler with the given name is present and active otherwise ``false``. @@ -114,7 +114,7 @@ Returns ``true`` if a profiler with the given name is present and active otherwi .. rst-class:: classref-method -void **profiler_add_frame_data** **(** :ref:`StringName` name, :ref:`Array` data **)** +|void| **profiler_add_frame_data**\ (\ name\: :ref:`StringName`, data\: :ref:`Array`\ ) Calls the ``add`` callable of the profiler with given ``name`` and ``data``. @@ -126,7 +126,7 @@ Calls the ``add`` callable of the profiler with given ``name`` and ``data``. .. rst-class:: classref-method -void **profiler_enable** **(** :ref:`StringName` name, :ref:`bool` enable, :ref:`Array` arguments=[] **)** +|void| **profiler_enable**\ (\ name\: :ref:`StringName`, enable\: :ref:`bool`, arguments\: :ref:`Array` = []\ ) Calls the ``toggle`` callable of the profiler with given ``name`` and ``arguments``. Enables/Disables the same profiler depending on ``enable`` argument. @@ -138,7 +138,7 @@ Calls the ``toggle`` callable of the profiler with given ``name`` and ``argument .. rst-class:: classref-method -void **register_message_capture** **(** :ref:`StringName` name, :ref:`Callable` callable **)** +|void| **register_message_capture**\ (\ name\: :ref:`StringName`, callable\: :ref:`Callable`\ ) Registers a message capture with given ``name``. If ``name`` is "my_message" then messages starting with "my_message:" will be called with the given callable. @@ -152,7 +152,7 @@ Callable must accept a message string and a data array as argument. If the messa .. rst-class:: classref-method -void **register_profiler** **(** :ref:`StringName` name, :ref:`EngineProfiler` profiler **)** +|void| **register_profiler**\ (\ name\: :ref:`StringName`, profiler\: :ref:`EngineProfiler`\ ) Registers a profiler with the given ``name``. See :ref:`EngineProfiler` for more information. @@ -164,7 +164,7 @@ Registers a profiler with the given ``name``. See :ref:`EngineProfiler` message, :ref:`Array` data **)** +|void| **send_message**\ (\ message\: :ref:`String`, data\: :ref:`Array`\ ) Sends a message with given ``message`` and ``data`` array. @@ -176,7 +176,7 @@ Sends a message with given ``message`` and ``data`` array. .. rst-class:: classref-method -void **unregister_message_capture** **(** :ref:`StringName` name **)** +|void| **unregister_message_capture**\ (\ name\: :ref:`StringName`\ ) Unregisters the message capture with given ``name``. @@ -188,7 +188,7 @@ Unregisters the message capture with given ``name``. .. rst-class:: classref-method -void **unregister_profiler** **(** :ref:`StringName` name **)** +|void| **unregister_profiler**\ (\ name\: :ref:`StringName`\ ) Unregisters a profiler with given ``name``. @@ -199,3 +199,4 @@ Unregisters a profiler with given ``name``. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_engineprofiler.rst b/classes/class_engineprofiler.rst index 1ce9f9d198b..ad7f5802639 100644 --- a/classes/class_engineprofiler.rst +++ b/classes/class_engineprofiler.rst @@ -31,13 +31,13 @@ Methods .. table:: :widths: auto - +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_add_frame` **(** :ref:`Array` data **)** |virtual| | - +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_tick` **(** :ref:`float` frame_time, :ref:`float` process_time, :ref:`float` physics_time, :ref:`float` physics_frame_time **)** |virtual| | - +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_toggle` **(** :ref:`bool` enable, :ref:`Array` options **)** |virtual| | - +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_add_frame`\ (\ data\: :ref:`Array`\ ) |virtual| | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_tick`\ (\ frame_time\: :ref:`float`, process_time\: :ref:`float`, physics_time\: :ref:`float`, physics_frame_time\: :ref:`float`\ ) |virtual| | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_toggle`\ (\ enable\: :ref:`bool`, options\: :ref:`Array`\ ) |virtual| | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -52,7 +52,7 @@ Method Descriptions .. rst-class:: classref-method -void **_add_frame** **(** :ref:`Array` data **)** |virtual| +|void| **_add_frame**\ (\ data\: :ref:`Array`\ ) |virtual| Called when data is added to profiler using :ref:`EngineDebugger.profiler_add_frame_data`. @@ -64,7 +64,7 @@ Called when data is added to profiler using :ref:`EngineDebugger.profiler_add_fr .. rst-class:: classref-method -void **_tick** **(** :ref:`float` frame_time, :ref:`float` process_time, :ref:`float` physics_time, :ref:`float` physics_frame_time **)** |virtual| +|void| **_tick**\ (\ frame_time\: :ref:`float`, process_time\: :ref:`float`, physics_time\: :ref:`float`, physics_frame_time\: :ref:`float`\ ) |virtual| Called once every engine iteration when the profiler is active with information about the current frame. All time values are in seconds. Lower values represent faster processing times and are therefore considered better. @@ -76,7 +76,7 @@ Called once every engine iteration when the profiler is active with information .. rst-class:: classref-method -void **_toggle** **(** :ref:`bool` enable, :ref:`Array` options **)** |virtual| +|void| **_toggle**\ (\ enable\: :ref:`bool`, options\: :ref:`Array`\ ) |virtual| Called when the profiler is enabled/disabled, along with a set of ``options``. @@ -87,3 +87,4 @@ Called when the profiler is enabled/disabled, along with a set of ``options``. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 57d3b4eae6e..a6a00030597 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -87,6 +87,12 @@ Properties +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`float` | :ref:`fog_density` | ``0.01`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`float` | :ref:`fog_depth_begin` | ``10.0`` | + +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`float` | :ref:`fog_depth_curve` | ``1.0`` | + +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`float` | :ref:`fog_depth_end` | ``100.0`` | + +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`bool` | :ref:`fog_enabled` | ``false`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`float` | :ref:`fog_height` | ``0.0`` | @@ -97,6 +103,8 @@ Properties +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`float` | :ref:`fog_light_energy` | ``1.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`FogMode` | :ref:`fog_mode` | ``0`` | + +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`float` | :ref:`fog_sky_affect` | ``1.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`float` | :ref:`fog_sun_scatter` | ``0.0`` | @@ -250,11 +258,11 @@ Methods .. table:: :widths: auto - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_glow_level` **(** :ref:`int` idx **)** |const| | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_glow_level` **(** :ref:`int` idx, :ref:`float` intensity **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_glow_level`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_glow_level`\ (\ idx\: :ref:`int`, intensity\: :ref:`float`\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -501,6 +509,32 @@ Mixes the glow with the underlying color to avoid increasing brightness as much ---- +.. _enum_Environment_FogMode: + +.. rst-class:: classref-enumeration + +enum **FogMode**: + +.. _class_Environment_constant_FOG_MODE_EXPONENTIAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`FogMode` **FOG_MODE_EXPONENTIAL** = ``0`` + +Use a physically-based fog model defined primarily by fog density. + +.. _class_Environment_constant_FOG_MODE_DEPTH: + +.. rst-class:: classref-enumeration-constant + +:ref:`FogMode` **FOG_MODE_DEPTH** = ``1`` + +Use a simple fog model defined by start and end positions and a custom curve. While not physically accurate, this model can be useful when you need more artistic control. + +.. rst-class:: classref-item-separator + +---- + .. _enum_Environment_SDFGIYScale: .. rst-class:: classref-enumeration @@ -548,8 +582,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_adjustment_brightness** **(** :ref:`float` value **)** -- :ref:`float` **get_adjustment_brightness** **(** **)** +- |void| **set_adjustment_brightness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_adjustment_brightness**\ (\ ) The global brightness value of the rendered scene. Effective only if :ref:`adjustment_enabled` is ``true``. @@ -565,8 +599,8 @@ The global brightness value of the rendered scene. Effective only if :ref:`adjus .. rst-class:: classref-property-setget -- void **set_adjustment_color_correction** **(** :ref:`Texture` value **)** -- :ref:`Texture` **get_adjustment_color_correction** **(** **)** +- |void| **set_adjustment_color_correction**\ (\ value\: :ref:`Texture`\ ) +- :ref:`Texture` **get_adjustment_color_correction**\ (\ ) The :ref:`Texture2D` or :ref:`Texture3D` lookup table (LUT) to use for the built-in post-process color grading. Can use a :ref:`GradientTexture1D` for a 1-dimensional LUT, or a :ref:`Texture3D` for a more complex LUT. Effective only if :ref:`adjustment_enabled` is ``true``. @@ -582,8 +616,8 @@ The :ref:`Texture2D` or :ref:`Texture3D` looku .. rst-class:: classref-property-setget -- void **set_adjustment_contrast** **(** :ref:`float` value **)** -- :ref:`float` **get_adjustment_contrast** **(** **)** +- |void| **set_adjustment_contrast**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_adjustment_contrast**\ (\ ) The global contrast value of the rendered scene (default value is 1). Effective only if :ref:`adjustment_enabled` is ``true``. @@ -599,8 +633,8 @@ The global contrast value of the rendered scene (default value is 1). Effective .. rst-class:: classref-property-setget -- void **set_adjustment_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_adjustment_enabled** **(** **)** +- |void| **set_adjustment_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_adjustment_enabled**\ (\ ) If ``true``, enables the ``adjustment_*`` properties provided by this resource. If ``false``, modifications to the ``adjustment_*`` properties will have no effect on the rendered scene. @@ -618,8 +652,8 @@ If ``true``, enables the ``adjustment_*`` properties provided by this resource. .. rst-class:: classref-property-setget -- void **set_adjustment_saturation** **(** :ref:`float` value **)** -- :ref:`float` **get_adjustment_saturation** **(** **)** +- |void| **set_adjustment_saturation**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_adjustment_saturation**\ (\ ) The global color saturation value of the rendered scene (default value is 1). Effective only if :ref:`adjustment_enabled` is ``true``. @@ -635,8 +669,8 @@ The global color saturation value of the rendered scene (default value is 1). Ef .. rst-class:: classref-property-setget -- void **set_ambient_light_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_ambient_light_color** **(** **)** +- |void| **set_ambient_light_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_ambient_light_color**\ (\ ) The ambient light's :ref:`Color`. Only effective if :ref:`ambient_light_sky_contribution` is lower than ``1.0`` (exclusive). @@ -652,8 +686,8 @@ The ambient light's :ref:`Color`. Only effective if :ref:`ambient_l .. rst-class:: classref-property-setget -- void **set_ambient_light_energy** **(** :ref:`float` value **)** -- :ref:`float` **get_ambient_light_energy** **(** **)** +- |void| **set_ambient_light_energy**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ambient_light_energy**\ (\ ) The ambient light's energy. The higher the value, the stronger the light. Only effective if :ref:`ambient_light_sky_contribution` is lower than ``1.0`` (exclusive). @@ -669,8 +703,8 @@ The ambient light's energy. The higher the value, the stronger the light. Only e .. rst-class:: classref-property-setget -- void **set_ambient_light_sky_contribution** **(** :ref:`float` value **)** -- :ref:`float` **get_ambient_light_sky_contribution** **(** **)** +- |void| **set_ambient_light_sky_contribution**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ambient_light_sky_contribution**\ (\ ) Defines the amount of light that the sky brings on the scene. A value of ``0.0`` means that the sky's light emission has no effect on the scene illumination, thus all ambient illumination is provided by the ambient light. On the contrary, a value of ``1.0`` means that *all* the light that affects the scene is provided by the sky, thus the ambient light parameter has no effect on the scene. @@ -688,8 +722,8 @@ Defines the amount of light that the sky brings on the scene. A value of ``0.0`` .. rst-class:: classref-property-setget -- void **set_ambient_source** **(** :ref:`AmbientSource` value **)** -- :ref:`AmbientSource` **get_ambient_source** **(** **)** +- |void| **set_ambient_source**\ (\ value\: :ref:`AmbientSource`\ ) +- :ref:`AmbientSource` **get_ambient_source**\ (\ ) The ambient light source to use for rendering materials and global illumination. @@ -705,8 +739,8 @@ The ambient light source to use for rendering materials and global illumination. .. rst-class:: classref-property-setget -- void **set_camera_feed_id** **(** :ref:`int` value **)** -- :ref:`int` **get_camera_feed_id** **(** **)** +- |void| **set_camera_feed_id**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_camera_feed_id**\ (\ ) The ID of the camera feed to show in the background. @@ -722,8 +756,8 @@ The ID of the camera feed to show in the background. .. rst-class:: classref-property-setget -- void **set_canvas_max_layer** **(** :ref:`int` value **)** -- :ref:`int` **get_canvas_max_layer** **(** **)** +- |void| **set_canvas_max_layer**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_canvas_max_layer**\ (\ ) The maximum layer ID to display. Only effective when using the :ref:`BG_CANVAS` background mode. @@ -739,8 +773,8 @@ The maximum layer ID to display. Only effective when using the :ref:`BG_CANVAS` value **)** -- :ref:`Color` **get_bg_color** **(** **)** +- |void| **set_bg_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_bg_color**\ (\ ) The :ref:`Color` displayed for clear areas of the scene. Only effective when using the :ref:`BG_COLOR` background mode. @@ -756,8 +790,8 @@ The :ref:`Color` displayed for clear areas of the scene. Only effec .. rst-class:: classref-property-setget -- void **set_bg_energy_multiplier** **(** :ref:`float` value **)** -- :ref:`float` **get_bg_energy_multiplier** **(** **)** +- |void| **set_bg_energy_multiplier**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_bg_energy_multiplier**\ (\ ) Multiplier for background energy. Increase to make background brighter, decrease to make background dimmer. @@ -773,8 +807,8 @@ Multiplier for background energy. Increase to make background brighter, decrease .. rst-class:: classref-property-setget -- void **set_bg_intensity** **(** :ref:`float` value **)** -- :ref:`float` **get_bg_intensity** **(** **)** +- |void| **set_bg_intensity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_bg_intensity**\ (\ ) Luminance of background measured in nits (candela per square meter). Only used when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units` is enabled. The default value is roughly equivalent to the sky at midday. @@ -790,8 +824,8 @@ Luminance of background measured in nits (candela per square meter). Only used w .. rst-class:: classref-property-setget -- void **set_background** **(** :ref:`BGMode` value **)** -- :ref:`BGMode` **get_background** **(** **)** +- |void| **set_background**\ (\ value\: :ref:`BGMode`\ ) +- :ref:`BGMode` **get_background**\ (\ ) The background mode. See :ref:`BGMode` for possible values. @@ -807,8 +841,8 @@ The background mode. See :ref:`BGMode` for possible val .. rst-class:: classref-property-setget -- void **set_fog_aerial_perspective** **(** :ref:`float` value **)** -- :ref:`float` **get_fog_aerial_perspective** **(** **)** +- |void| **set_fog_aerial_perspective**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fog_aerial_perspective**\ (\ ) If set above ``0.0`` (exclusive), blends between the fog's color and the color of the background :ref:`Sky`. This has a small performance cost when set above ``0.0``. Must have :ref:`background_mode` set to :ref:`BG_SKY`. @@ -826,10 +860,65 @@ This is useful to simulate `aerial perspective ` value **)** -- :ref:`float` **get_fog_density** **(** **)** +- |void| **set_fog_density**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fog_density**\ (\ ) + +The fog density to be used. This is demonstrated in different ways depending on the :ref:`fog_mode` mode chosen: + +\ **Exponential Fog Mode:** Higher values result in denser fog. The fog rendering is exponential like in real life. + +\ **Depth Fog mode:** The maximum intensity of the deep fog, effect will appear in the distance (relative to the camera). At ``1.0`` the fog will fully obscure the scene, at ``0.0`` the fog will not be visible. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Environment_property_fog_depth_begin: + +.. rst-class:: classref-property + +:ref:`float` **fog_depth_begin** = ``10.0`` + +.. rst-class:: classref-property-setget + +- |void| **set_fog_depth_begin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fog_depth_begin**\ (\ ) -The *exponential* fog density to use. Higher values result in a more dense fog. Fog rendering is exponential as in real life. +The fog's depth starting distance from the camera. Only available when :ref:`fog_mode` is set to :ref:`FOG_MODE_DEPTH`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Environment_property_fog_depth_curve: + +.. rst-class:: classref-property + +:ref:`float` **fog_depth_curve** = ``1.0`` + +.. rst-class:: classref-property-setget + +- |void| **set_fog_depth_curve**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fog_depth_curve**\ (\ ) + +The fog depth's intensity curve. A number of presets are available in the Inspector by right-clicking the curve. Only available when :ref:`fog_mode` is set to :ref:`FOG_MODE_DEPTH`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Environment_property_fog_depth_end: + +.. rst-class:: classref-property + +:ref:`float` **fog_depth_end** = ``100.0`` + +.. rst-class:: classref-property-setget + +- |void| **set_fog_depth_end**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fog_depth_end**\ (\ ) + +The fog's depth end distance from the camera. If this value is set to ``0``, it will be equal to the current camera's :ref:`Camera3D.far` value. Only available when :ref:`fog_mode` is set to :ref:`FOG_MODE_DEPTH`. .. rst-class:: classref-item-separator @@ -843,8 +932,8 @@ The *exponential* fog density to use. Higher values result in a more dense fog. .. rst-class:: classref-property-setget -- void **set_fog_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_fog_enabled** **(** **)** +- |void| **set_fog_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_fog_enabled**\ (\ ) If ``true``, fog effects are enabled. @@ -860,8 +949,8 @@ If ``true``, fog effects are enabled. .. rst-class:: classref-property-setget -- void **set_fog_height** **(** :ref:`float` value **)** -- :ref:`float` **get_fog_height** **(** **)** +- |void| **set_fog_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fog_height**\ (\ ) The height at which the height fog effect begins. @@ -877,8 +966,8 @@ The height at which the height fog effect begins. .. rst-class:: classref-property-setget -- void **set_fog_height_density** **(** :ref:`float` value **)** -- :ref:`float` **get_fog_height_density** **(** **)** +- |void| **set_fog_height_density**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fog_height_density**\ (\ ) The density used to increase fog as height decreases. To make fog increase as height increases, use a negative value. @@ -894,8 +983,8 @@ The density used to increase fog as height decreases. To make fog increase as he .. rst-class:: classref-property-setget -- void **set_fog_light_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_fog_light_color** **(** **)** +- |void| **set_fog_light_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_fog_light_color**\ (\ ) The fog's color. @@ -911,8 +1000,8 @@ The fog's color. .. rst-class:: classref-property-setget -- void **set_fog_light_energy** **(** :ref:`float` value **)** -- :ref:`float` **get_fog_light_energy** **(** **)** +- |void| **set_fog_light_energy**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fog_light_energy**\ (\ ) The fog's brightness. Higher values result in brighter fog. @@ -920,6 +1009,23 @@ The fog's brightness. Higher values result in brighter fog. ---- +.. _class_Environment_property_fog_mode: + +.. rst-class:: classref-property + +:ref:`FogMode` **fog_mode** = ``0`` + +.. rst-class:: classref-property-setget + +- |void| **set_fog_mode**\ (\ value\: :ref:`FogMode`\ ) +- :ref:`FogMode` **get_fog_mode**\ (\ ) + +The fog mode. See :ref:`FogMode` for possible values. + +.. rst-class:: classref-item-separator + +---- + .. _class_Environment_property_fog_sky_affect: .. rst-class:: classref-property @@ -928,8 +1034,8 @@ The fog's brightness. Higher values result in brighter fog. .. rst-class:: classref-property-setget -- void **set_fog_sky_affect** **(** :ref:`float` value **)** -- :ref:`float` **get_fog_sky_affect** **(** **)** +- |void| **set_fog_sky_affect**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fog_sky_affect**\ (\ ) The factor to use when affecting the sky with non-volumetric fog. ``1.0`` means that fog can fully obscure the sky. Lower values reduce the impact of fog on sky rendering, with ``0.0`` not affecting sky rendering at all. @@ -947,8 +1053,8 @@ The factor to use when affecting the sky with non-volumetric fog. ``1.0`` means .. rst-class:: classref-property-setget -- void **set_fog_sun_scatter** **(** :ref:`float` value **)** -- :ref:`float` **get_fog_sun_scatter** **(** **)** +- |void| **set_fog_sun_scatter**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fog_sun_scatter**\ (\ ) If set above ``0.0``, renders the scene's directional light(s) in the fog color depending on the view angle. This can be used to give the impression that the sun is "piercing" through the fog. @@ -964,8 +1070,8 @@ If set above ``0.0``, renders the scene's directional light(s) in the fog color .. rst-class:: classref-property-setget -- void **set_glow_blend_mode** **(** :ref:`GlowBlendMode` value **)** -- :ref:`GlowBlendMode` **get_glow_blend_mode** **(** **)** +- |void| **set_glow_blend_mode**\ (\ value\: :ref:`GlowBlendMode`\ ) +- :ref:`GlowBlendMode` **get_glow_blend_mode**\ (\ ) The glow blending mode. @@ -981,8 +1087,8 @@ The glow blending mode. .. rst-class:: classref-property-setget -- void **set_glow_bloom** **(** :ref:`float` value **)** -- :ref:`float` **get_glow_bloom** **(** **)** +- |void| **set_glow_bloom**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_glow_bloom**\ (\ ) The bloom's intensity. If set to a value higher than ``0``, this will make glow visible in areas darker than the :ref:`glow_hdr_threshold`. @@ -998,8 +1104,8 @@ The bloom's intensity. If set to a value higher than ``0``, this will make glow .. rst-class:: classref-property-setget -- void **set_glow_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_glow_enabled** **(** **)** +- |void| **set_glow_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_glow_enabled**\ (\ ) If ``true``, the glow effect is enabled. @@ -1017,8 +1123,8 @@ If ``true``, the glow effect is enabled. .. rst-class:: classref-property-setget -- void **set_glow_hdr_luminance_cap** **(** :ref:`float` value **)** -- :ref:`float` **get_glow_hdr_luminance_cap** **(** **)** +- |void| **set_glow_hdr_luminance_cap**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_glow_hdr_luminance_cap**\ (\ ) The higher threshold of the HDR glow. Areas brighter than this threshold will be clamped for the purposes of the glow effect. @@ -1034,8 +1140,8 @@ The higher threshold of the HDR glow. Areas brighter than this threshold will be .. rst-class:: classref-property-setget -- void **set_glow_hdr_bleed_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_glow_hdr_bleed_scale** **(** **)** +- |void| **set_glow_hdr_bleed_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_glow_hdr_bleed_scale**\ (\ ) The bleed scale of the HDR glow. @@ -1051,8 +1157,8 @@ The bleed scale of the HDR glow. .. rst-class:: classref-property-setget -- void **set_glow_hdr_bleed_threshold** **(** :ref:`float` value **)** -- :ref:`float` **get_glow_hdr_bleed_threshold** **(** **)** +- |void| **set_glow_hdr_bleed_threshold**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_glow_hdr_bleed_threshold**\ (\ ) The lower threshold of the HDR glow. When using the Mobile rendering method (which only supports a lower dynamic range up to ``2.0``), this may need to be below ``1.0`` for glow to be visible. A value of ``0.9`` works well in this case. This value also needs to be decreased below ``1.0`` when using glow in 2D, as 2D rendering is performed in SDR. @@ -1068,8 +1174,8 @@ The lower threshold of the HDR glow. When using the Mobile rendering method (whi .. rst-class:: classref-property-setget -- void **set_glow_intensity** **(** :ref:`float` value **)** -- :ref:`float` **get_glow_intensity** **(** **)** +- |void| **set_glow_intensity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_glow_intensity**\ (\ ) The overall brightness multiplier of the glow effect. When using the Mobile rendering method (which only supports a lower dynamic range up to ``2.0``), this should be increased to ``1.5`` to compensate. @@ -1085,8 +1191,8 @@ The overall brightness multiplier of the glow effect. When using the Mobile rend .. rst-class:: classref-property-setget -- void **set_glow_level** **(** :ref:`int` idx, :ref:`float` intensity **)** -- :ref:`float` **get_glow_level** **(** :ref:`int` idx **)** |const| +- |void| **set_glow_level**\ (\ idx\: :ref:`int`, intensity\: :ref:`float`\ ) +- :ref:`float` **get_glow_level**\ (\ idx\: :ref:`int`\ ) |const| The intensity of the 1st level of glow. This is the most "local" level (least blurry). @@ -1102,8 +1208,8 @@ The intensity of the 1st level of glow. This is the most "local" level (least bl .. rst-class:: classref-property-setget -- void **set_glow_level** **(** :ref:`int` idx, :ref:`float` intensity **)** -- :ref:`float` **get_glow_level** **(** :ref:`int` idx **)** |const| +- |void| **set_glow_level**\ (\ idx\: :ref:`int`, intensity\: :ref:`float`\ ) +- :ref:`float` **get_glow_level**\ (\ idx\: :ref:`int`\ ) |const| The intensity of the 2nd level of glow. @@ -1119,8 +1225,8 @@ The intensity of the 2nd level of glow. .. rst-class:: classref-property-setget -- void **set_glow_level** **(** :ref:`int` idx, :ref:`float` intensity **)** -- :ref:`float` **get_glow_level** **(** :ref:`int` idx **)** |const| +- |void| **set_glow_level**\ (\ idx\: :ref:`int`, intensity\: :ref:`float`\ ) +- :ref:`float` **get_glow_level**\ (\ idx\: :ref:`int`\ ) |const| The intensity of the 3rd level of glow. @@ -1136,8 +1242,8 @@ The intensity of the 3rd level of glow. .. rst-class:: classref-property-setget -- void **set_glow_level** **(** :ref:`int` idx, :ref:`float` intensity **)** -- :ref:`float` **get_glow_level** **(** :ref:`int` idx **)** |const| +- |void| **set_glow_level**\ (\ idx\: :ref:`int`, intensity\: :ref:`float`\ ) +- :ref:`float` **get_glow_level**\ (\ idx\: :ref:`int`\ ) |const| The intensity of the 4th level of glow. @@ -1153,8 +1259,8 @@ The intensity of the 4th level of glow. .. rst-class:: classref-property-setget -- void **set_glow_level** **(** :ref:`int` idx, :ref:`float` intensity **)** -- :ref:`float` **get_glow_level** **(** :ref:`int` idx **)** |const| +- |void| **set_glow_level**\ (\ idx\: :ref:`int`, intensity\: :ref:`float`\ ) +- :ref:`float` **get_glow_level**\ (\ idx\: :ref:`int`\ ) |const| The intensity of the 5th level of glow. @@ -1170,8 +1276,8 @@ The intensity of the 5th level of glow. .. rst-class:: classref-property-setget -- void **set_glow_level** **(** :ref:`int` idx, :ref:`float` intensity **)** -- :ref:`float` **get_glow_level** **(** :ref:`int` idx **)** |const| +- |void| **set_glow_level**\ (\ idx\: :ref:`int`, intensity\: :ref:`float`\ ) +- :ref:`float` **get_glow_level**\ (\ idx\: :ref:`int`\ ) |const| The intensity of the 6th level of glow. @@ -1187,8 +1293,8 @@ The intensity of the 6th level of glow. .. rst-class:: classref-property-setget -- void **set_glow_level** **(** :ref:`int` idx, :ref:`float` intensity **)** -- :ref:`float` **get_glow_level** **(** :ref:`int` idx **)** |const| +- |void| **set_glow_level**\ (\ idx\: :ref:`int`, intensity\: :ref:`float`\ ) +- :ref:`float` **get_glow_level**\ (\ idx\: :ref:`int`\ ) |const| The intensity of the 7th level of glow. This is the most "global" level (blurriest). @@ -1204,8 +1310,8 @@ The intensity of the 7th level of glow. This is the most "global" level (blurrie .. rst-class:: classref-property-setget -- void **set_glow_map** **(** :ref:`Texture` value **)** -- :ref:`Texture` **get_glow_map** **(** **)** +- |void| **set_glow_map**\ (\ value\: :ref:`Texture`\ ) +- :ref:`Texture` **get_glow_map**\ (\ ) The texture that should be used as a glow map to *multiply* the resulting glow color according to :ref:`glow_map_strength`. This can be used to create a "lens dirt" effect. The texture's RGB color channels are used for modulation, but the alpha channel is ignored. @@ -1223,8 +1329,8 @@ The texture that should be used as a glow map to *multiply* the resulting glow c .. rst-class:: classref-property-setget -- void **set_glow_map_strength** **(** :ref:`float` value **)** -- :ref:`float` **get_glow_map_strength** **(** **)** +- |void| **set_glow_map_strength**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_glow_map_strength**\ (\ ) How strong of an impact the :ref:`glow_map` should have on the overall glow effect. A strength of ``0.0`` means the glow map has no effect on the overall glow effect. A strength of ``1.0`` means the glow has a full effect on the overall glow effect (and can turn off glow entirely in specific areas of the screen if the glow map has black areas). @@ -1240,8 +1346,8 @@ How strong of an impact the :ref:`glow_map` .. rst-class:: classref-property-setget -- void **set_glow_mix** **(** :ref:`float` value **)** -- :ref:`float` **get_glow_mix** **(** **)** +- |void| **set_glow_mix**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_glow_mix**\ (\ ) When using the :ref:`GLOW_BLEND_MODE_MIX` :ref:`glow_blend_mode`, this controls how much the source image is blended with the glow layer. A value of ``0.0`` makes the glow rendering invisible, while a value of ``1.0`` is equivalent to :ref:`GLOW_BLEND_MODE_REPLACE`. @@ -1257,8 +1363,8 @@ When using the :ref:`GLOW_BLEND_MODE_MIX` value **)** -- :ref:`bool` **is_glow_normalized** **(** **)** +- |void| **set_glow_normalized**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_glow_normalized**\ (\ ) If ``true``, glow levels will be normalized so that summed together their intensities equal ``1.0``. @@ -1274,8 +1380,8 @@ If ``true``, glow levels will be normalized so that summed together their intens .. rst-class:: classref-property-setget -- void **set_glow_strength** **(** :ref:`float` value **)** -- :ref:`float` **get_glow_strength** **(** **)** +- |void| **set_glow_strength**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_glow_strength**\ (\ ) The strength of the glow effect. This applies as the glow is blurred across the screen and increases the distance and intensity of the blur. When using the Mobile rendering method, this should be increased to compensate for the lower dynamic range. @@ -1291,8 +1397,8 @@ The strength of the glow effect. This applies as the glow is blurred across the .. rst-class:: classref-property-setget -- void **set_reflection_source** **(** :ref:`ReflectionSource` value **)** -- :ref:`ReflectionSource` **get_reflection_source** **(** **)** +- |void| **set_reflection_source**\ (\ value\: :ref:`ReflectionSource`\ ) +- :ref:`ReflectionSource` **get_reflection_source**\ (\ ) The reflected (specular) light source. @@ -1308,8 +1414,8 @@ The reflected (specular) light source. .. rst-class:: classref-property-setget -- void **set_sdfgi_bounce_feedback** **(** :ref:`float` value **)** -- :ref:`float` **get_sdfgi_bounce_feedback** **(** **)** +- |void| **set_sdfgi_bounce_feedback**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_sdfgi_bounce_feedback**\ (\ ) The energy multiplier applied to light every time it bounces from a surface when using SDFGI. Values greater than ``0.0`` will simulate multiple bounces, resulting in a more realistic appearance. Increasing :ref:`sdfgi_bounce_feedback` generally has no performance impact. See also :ref:`sdfgi_energy`. @@ -1329,8 +1435,8 @@ The energy multiplier applied to light every time it bounces from a surface when .. rst-class:: classref-property-setget -- void **set_sdfgi_cascade0_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_sdfgi_cascade0_distance** **(** **)** +- |void| **set_sdfgi_cascade0_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_sdfgi_cascade0_distance**\ (\ ) **Note:** This property is linked to :ref:`sdfgi_min_cell_size` and :ref:`sdfgi_max_distance`. Changing its value will automatically change those properties as well. @@ -1346,8 +1452,8 @@ The energy multiplier applied to light every time it bounces from a surface when .. rst-class:: classref-property-setget -- void **set_sdfgi_cascades** **(** :ref:`int` value **)** -- :ref:`int` **get_sdfgi_cascades** **(** **)** +- |void| **set_sdfgi_cascades**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_sdfgi_cascades**\ (\ ) The number of cascades to use for SDFGI (between 1 and 8). A higher number of cascades allows displaying SDFGI further away while preserving detail up close, at the cost of performance. When using SDFGI on small-scale levels, :ref:`sdfgi_cascades` can often be decreased between ``1`` and ``4`` to improve performance. @@ -1363,8 +1469,8 @@ The number of cascades to use for SDFGI (between 1 and 8). A higher number of ca .. rst-class:: classref-property-setget -- void **set_sdfgi_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_sdfgi_enabled** **(** **)** +- |void| **set_sdfgi_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_sdfgi_enabled**\ (\ ) If ``true``, enables signed distance field global illumination for meshes that have their :ref:`GeometryInstance3D.gi_mode` set to :ref:`GeometryInstance3D.GI_MODE_STATIC`. SDFGI is a real-time global illumination technique that works well with procedurally generated and user-built levels, including in situations where geometry is created during gameplay. The signed distance field is automatically generated around the camera as it moves. Dynamic lights are supported, but dynamic occluders and emissive surfaces are not. @@ -1386,8 +1492,8 @@ If ``true``, enables signed distance field global illumination for meshes that h .. rst-class:: classref-property-setget -- void **set_sdfgi_energy** **(** :ref:`float` value **)** -- :ref:`float` **get_sdfgi_energy** **(** **)** +- |void| **set_sdfgi_energy**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_sdfgi_energy**\ (\ ) The energy multiplier to use for SDFGI. Higher values will result in brighter indirect lighting and reflections. See also :ref:`sdfgi_bounce_feedback`. @@ -1403,8 +1509,8 @@ The energy multiplier to use for SDFGI. Higher values will result in brighter in .. rst-class:: classref-property-setget -- void **set_sdfgi_max_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_sdfgi_max_distance** **(** **)** +- |void| **set_sdfgi_max_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_sdfgi_max_distance**\ (\ ) The maximum distance at which SDFGI is visible. Beyond this distance, environment lighting or other sources of GI such as :ref:`ReflectionProbe` will be used as a fallback. @@ -1422,8 +1528,8 @@ The maximum distance at which SDFGI is visible. Beyond this distance, environmen .. rst-class:: classref-property-setget -- void **set_sdfgi_min_cell_size** **(** :ref:`float` value **)** -- :ref:`float` **get_sdfgi_min_cell_size** **(** **)** +- |void| **set_sdfgi_min_cell_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_sdfgi_min_cell_size**\ (\ ) The cell size to use for the closest SDFGI cascade (in 3D units). Lower values allow SDFGI to be more precise up close, at the cost of making SDFGI updates more demanding. This can cause stuttering when the camera moves fast. Higher values allow SDFGI to cover more ground, while also reducing the performance impact of SDFGI updates. @@ -1441,8 +1547,8 @@ The cell size to use for the closest SDFGI cascade (in 3D units). Lower values a .. rst-class:: classref-property-setget -- void **set_sdfgi_normal_bias** **(** :ref:`float` value **)** -- :ref:`float` **get_sdfgi_normal_bias** **(** **)** +- |void| **set_sdfgi_normal_bias**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_sdfgi_normal_bias**\ (\ ) The normal bias to use for SDFGI probes. Increasing this value can reduce visible streaking artifacts on sloped surfaces, at the cost of increased light leaking. @@ -1458,8 +1564,8 @@ The normal bias to use for SDFGI probes. Increasing this value can reduce visibl .. rst-class:: classref-property-setget -- void **set_sdfgi_probe_bias** **(** :ref:`float` value **)** -- :ref:`float` **get_sdfgi_probe_bias** **(** **)** +- |void| **set_sdfgi_probe_bias**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_sdfgi_probe_bias**\ (\ ) The constant bias to use for SDFGI probes. Increasing this value can reduce visible streaking artifacts on sloped surfaces, at the cost of increased light leaking. @@ -1475,8 +1581,8 @@ The constant bias to use for SDFGI probes. Increasing this value can reduce visi .. rst-class:: classref-property-setget -- void **set_sdfgi_read_sky_light** **(** :ref:`bool` value **)** -- :ref:`bool` **is_sdfgi_reading_sky_light** **(** **)** +- |void| **set_sdfgi_read_sky_light**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_sdfgi_reading_sky_light**\ (\ ) If ``true``, SDFGI takes the environment lighting into account. This should be set to ``false`` for interior scenes. @@ -1492,8 +1598,8 @@ If ``true``, SDFGI takes the environment lighting into account. This should be s .. rst-class:: classref-property-setget -- void **set_sdfgi_use_occlusion** **(** :ref:`bool` value **)** -- :ref:`bool` **is_sdfgi_using_occlusion** **(** **)** +- |void| **set_sdfgi_use_occlusion**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_sdfgi_using_occlusion**\ (\ ) If ``true``, SDFGI uses an occlusion detection approach to reduce light leaking. Occlusion may however introduce dark blotches in certain spots, which may be undesired in mostly outdoor scenes. :ref:`sdfgi_use_occlusion` has a performance impact and should only be enabled when needed. @@ -1509,8 +1615,8 @@ If ``true``, SDFGI uses an occlusion detection approach to reduce light leaking. .. rst-class:: classref-property-setget -- void **set_sdfgi_y_scale** **(** :ref:`SDFGIYScale` value **)** -- :ref:`SDFGIYScale` **get_sdfgi_y_scale** **(** **)** +- |void| **set_sdfgi_y_scale**\ (\ value\: :ref:`SDFGIYScale`\ ) +- :ref:`SDFGIYScale` **get_sdfgi_y_scale**\ (\ ) The Y scale to use for SDFGI cells. Lower values will result in SDFGI cells being packed together more closely on the Y axis. This is used to balance between quality and covering a lot of vertical ground. :ref:`sdfgi_y_scale` should be set depending on how vertical your scene is (and how fast your camera may move on the Y axis). @@ -1526,8 +1632,8 @@ The Y scale to use for SDFGI cells. Lower values will result in SDFGI cells bein .. rst-class:: classref-property-setget -- void **set_sky** **(** :ref:`Sky` value **)** -- :ref:`Sky` **get_sky** **(** **)** +- |void| **set_sky**\ (\ value\: :ref:`Sky`\ ) +- :ref:`Sky` **get_sky**\ (\ ) The :ref:`Sky` resource used for this **Environment**. @@ -1543,8 +1649,8 @@ The :ref:`Sky` resource used for this **Environment**. .. rst-class:: classref-property-setget -- void **set_sky_custom_fov** **(** :ref:`float` value **)** -- :ref:`float` **get_sky_custom_fov** **(** **)** +- |void| **set_sky_custom_fov**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_sky_custom_fov**\ (\ ) If set to a value greater than ``0.0``, overrides the field of view to use for sky rendering. If set to ``0.0``, the same FOV as the current :ref:`Camera3D` is used for sky rendering. @@ -1560,8 +1666,8 @@ If set to a value greater than ``0.0``, overrides the field of view to use for s .. rst-class:: classref-property-setget -- void **set_sky_rotation** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_sky_rotation** **(** **)** +- |void| **set_sky_rotation**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_sky_rotation**\ (\ ) The rotation to use for sky rendering. @@ -1577,8 +1683,8 @@ The rotation to use for sky rendering. .. rst-class:: classref-property-setget -- void **set_ssao_ao_channel_affect** **(** :ref:`float` value **)** -- :ref:`float` **get_ssao_ao_channel_affect** **(** **)** +- |void| **set_ssao_ao_channel_affect**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ssao_ao_channel_affect**\ (\ ) The screen-space ambient occlusion intensity on materials that have an AO texture defined. Values higher than ``0`` will make the SSAO effect visible in areas darkened by AO textures. @@ -1594,8 +1700,8 @@ The screen-space ambient occlusion intensity on materials that have an AO textur .. rst-class:: classref-property-setget -- void **set_ssao_detail** **(** :ref:`float` value **)** -- :ref:`float` **get_ssao_detail** **(** **)** +- |void| **set_ssao_detail**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ssao_detail**\ (\ ) Sets the strength of the additional level of detail for the screen-space ambient occlusion effect. A high value makes the detail pass more prominent, but it may contribute to aliasing in your final image. @@ -1611,8 +1717,8 @@ Sets the strength of the additional level of detail for the screen-space ambient .. rst-class:: classref-property-setget -- void **set_ssao_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_ssao_enabled** **(** **)** +- |void| **set_ssao_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_ssao_enabled**\ (\ ) If ``true``, the screen-space ambient occlusion effect is enabled. This darkens objects' corners and cavities to simulate ambient light not reaching the entire object as in real life. This works well for small, dynamic objects, but baked lighting or ambient occlusion textures will do a better job at displaying ambient occlusion on large static objects. Godot uses a form of SSAO called Adaptive Screen Space Ambient Occlusion which is itself a form of Horizon Based Ambient Occlusion. @@ -1630,8 +1736,8 @@ If ``true``, the screen-space ambient occlusion effect is enabled. This darkens .. rst-class:: classref-property-setget -- void **set_ssao_horizon** **(** :ref:`float` value **)** -- :ref:`float` **get_ssao_horizon** **(** **)** +- |void| **set_ssao_horizon**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ssao_horizon**\ (\ ) The threshold for considering whether a given point on a surface is occluded or not represented as an angle from the horizon mapped into the ``0.0-1.0`` range. A value of ``1.0`` results in no occlusion. @@ -1647,8 +1753,8 @@ The threshold for considering whether a given point on a surface is occluded or .. rst-class:: classref-property-setget -- void **set_ssao_intensity** **(** :ref:`float` value **)** -- :ref:`float` **get_ssao_intensity** **(** **)** +- |void| **set_ssao_intensity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ssao_intensity**\ (\ ) The primary screen-space ambient occlusion intensity. Acts as a multiplier for the screen-space ambient occlusion effect. A higher value results in darker occlusion. @@ -1664,8 +1770,8 @@ The primary screen-space ambient occlusion intensity. Acts as a multiplier for t .. rst-class:: classref-property-setget -- void **set_ssao_direct_light_affect** **(** :ref:`float` value **)** -- :ref:`float` **get_ssao_direct_light_affect** **(** **)** +- |void| **set_ssao_direct_light_affect**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ssao_direct_light_affect**\ (\ ) The screen-space ambient occlusion intensity in direct light. In real life, ambient occlusion only applies to indirect light, which means its effects can't be seen in direct light. Values higher than ``0`` will make the SSAO effect visible in direct light. @@ -1681,8 +1787,8 @@ The screen-space ambient occlusion intensity in direct light. In real life, ambi .. rst-class:: classref-property-setget -- void **set_ssao_power** **(** :ref:`float` value **)** -- :ref:`float` **get_ssao_power** **(** **)** +- |void| **set_ssao_power**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ssao_power**\ (\ ) The distribution of occlusion. A higher value results in darker occlusion, similar to :ref:`ssao_intensity`, but with a sharper falloff. @@ -1698,8 +1804,8 @@ The distribution of occlusion. A higher value results in darker occlusion, simil .. rst-class:: classref-property-setget -- void **set_ssao_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_ssao_radius** **(** **)** +- |void| **set_ssao_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ssao_radius**\ (\ ) The distance at which objects can occlude each other when calculating screen-space ambient occlusion. Higher values will result in occlusion over a greater distance at the cost of performance and quality. @@ -1715,8 +1821,8 @@ The distance at which objects can occlude each other when calculating screen-spa .. rst-class:: classref-property-setget -- void **set_ssao_sharpness** **(** :ref:`float` value **)** -- :ref:`float` **get_ssao_sharpness** **(** **)** +- |void| **set_ssao_sharpness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ssao_sharpness**\ (\ ) The amount that the screen-space ambient occlusion effect is allowed to blur over the edges of objects. Setting too high will result in aliasing around the edges of objects. Setting too low will make object edges appear blurry. @@ -1732,8 +1838,8 @@ The amount that the screen-space ambient occlusion effect is allowed to blur ove .. rst-class:: classref-property-setget -- void **set_ssil_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_ssil_enabled** **(** **)** +- |void| **set_ssil_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_ssil_enabled**\ (\ ) If ``true``, the screen-space indirect lighting effect is enabled. Screen space indirect lighting is a form of indirect lighting that allows diffuse light to bounce between nearby objects. Screen-space indirect lighting works very similarly to screen-space ambient occlusion, in that it only affects a limited range. It is intended to be used along with a form of proper global illumination like SDFGI or :ref:`VoxelGI`. Screen-space indirect lighting is not affected by individual light's :ref:`Light3D.light_indirect_energy`. @@ -1751,8 +1857,8 @@ If ``true``, the screen-space indirect lighting effect is enabled. Screen space .. rst-class:: classref-property-setget -- void **set_ssil_intensity** **(** :ref:`float` value **)** -- :ref:`float` **get_ssil_intensity** **(** **)** +- |void| **set_ssil_intensity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ssil_intensity**\ (\ ) The brightness multiplier for the screen-space indirect lighting effect. A higher value will result in brighter light. @@ -1768,8 +1874,8 @@ The brightness multiplier for the screen-space indirect lighting effect. A highe .. rst-class:: classref-property-setget -- void **set_ssil_normal_rejection** **(** :ref:`float` value **)** -- :ref:`float` **get_ssil_normal_rejection** **(** **)** +- |void| **set_ssil_normal_rejection**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ssil_normal_rejection**\ (\ ) Amount of normal rejection used when calculating screen-space indirect lighting. Normal rejection uses the normal of a given sample point to reject samples that are facing away from the current pixel. Normal rejection is necessary to avoid light leaking when only one side of an object is illuminated. However, normal rejection can be disabled if light leaking is desirable, such as when the scene mostly contains emissive objects that emit light from faces that cannot be seen from the camera. @@ -1785,8 +1891,8 @@ Amount of normal rejection used when calculating screen-space indirect lighting. .. rst-class:: classref-property-setget -- void **set_ssil_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_ssil_radius** **(** **)** +- |void| **set_ssil_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ssil_radius**\ (\ ) The distance that bounced lighting can travel when using the screen space indirect lighting effect. A larger value will result in light bouncing further in a scene, but may result in under-sampling artifacts which look like long spikes surrounding light sources. @@ -1802,8 +1908,8 @@ The distance that bounced lighting can travel when using the screen space indire .. rst-class:: classref-property-setget -- void **set_ssil_sharpness** **(** :ref:`float` value **)** -- :ref:`float` **get_ssil_sharpness** **(** **)** +- |void| **set_ssil_sharpness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ssil_sharpness**\ (\ ) The amount that the screen-space indirect lighting effect is allowed to blur over the edges of objects. Setting too high will result in aliasing around the edges of objects. Setting too low will make object edges appear blurry. @@ -1819,8 +1925,8 @@ The amount that the screen-space indirect lighting effect is allowed to blur ove .. rst-class:: classref-property-setget -- void **set_ssr_depth_tolerance** **(** :ref:`float` value **)** -- :ref:`float` **get_ssr_depth_tolerance** **(** **)** +- |void| **set_ssr_depth_tolerance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ssr_depth_tolerance**\ (\ ) The depth tolerance for screen-space reflections. @@ -1836,8 +1942,8 @@ The depth tolerance for screen-space reflections. .. rst-class:: classref-property-setget -- void **set_ssr_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_ssr_enabled** **(** **)** +- |void| **set_ssr_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_ssr_enabled**\ (\ ) If ``true``, screen-space reflections are enabled. Screen-space reflections are more accurate than reflections from :ref:`VoxelGI`\ s or :ref:`ReflectionProbe`\ s, but are slower and can't reflect surfaces occluded by others. @@ -1855,8 +1961,8 @@ If ``true``, screen-space reflections are enabled. Screen-space reflections are .. rst-class:: classref-property-setget -- void **set_ssr_fade_in** **(** :ref:`float` value **)** -- :ref:`float` **get_ssr_fade_in** **(** **)** +- |void| **set_ssr_fade_in**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ssr_fade_in**\ (\ ) The fade-in distance for screen-space reflections. Affects the area from the reflected material to the screen-space reflection. Only positive values are valid (negative values will be clamped to ``0.0``). @@ -1872,8 +1978,8 @@ The fade-in distance for screen-space reflections. Affects the area from the ref .. rst-class:: classref-property-setget -- void **set_ssr_fade_out** **(** :ref:`float` value **)** -- :ref:`float` **get_ssr_fade_out** **(** **)** +- |void| **set_ssr_fade_out**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ssr_fade_out**\ (\ ) The fade-out distance for screen-space reflections. Affects the area from the screen-space reflection to the "global" reflection. Only positive values are valid (negative values will be clamped to ``0.0``). @@ -1889,8 +1995,8 @@ The fade-out distance for screen-space reflections. Affects the area from the sc .. rst-class:: classref-property-setget -- void **set_ssr_max_steps** **(** :ref:`int` value **)** -- :ref:`int` **get_ssr_max_steps** **(** **)** +- |void| **set_ssr_max_steps**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_ssr_max_steps**\ (\ ) The maximum number of steps for screen-space reflections. Higher values are slower. @@ -1906,8 +2012,8 @@ The maximum number of steps for screen-space reflections. Higher values are slow .. rst-class:: classref-property-setget -- void **set_tonemap_exposure** **(** :ref:`float` value **)** -- :ref:`float` **get_tonemap_exposure** **(** **)** +- |void| **set_tonemap_exposure**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_tonemap_exposure**\ (\ ) The default exposure used for tonemapping. Higher values result in a brighter image. See also :ref:`tonemap_white`. @@ -1923,8 +2029,8 @@ The default exposure used for tonemapping. Higher values result in a brighter im .. rst-class:: classref-property-setget -- void **set_tonemapper** **(** :ref:`ToneMapper` value **)** -- :ref:`ToneMapper` **get_tonemapper** **(** **)** +- |void| **set_tonemapper**\ (\ value\: :ref:`ToneMapper`\ ) +- :ref:`ToneMapper` **get_tonemapper**\ (\ ) The tonemapping mode to use. Tonemapping is the process that "converts" HDR values to be suitable for rendering on a LDR display. (Godot doesn't support rendering on HDR displays yet.) @@ -1940,8 +2046,8 @@ The tonemapping mode to use. Tonemapping is the process that "converts" HDR valu .. rst-class:: classref-property-setget -- void **set_tonemap_white** **(** :ref:`float` value **)** -- :ref:`float` **get_tonemap_white** **(** **)** +- |void| **set_tonemap_white**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_tonemap_white**\ (\ ) The white reference value for tonemapping (also called "whitepoint"). Higher values can make highlights look less blown out, and will also slightly darken the whole scene as a result. Only effective if the :ref:`tonemap_mode` isn't set to :ref:`TONE_MAPPER_LINEAR`. See also :ref:`tonemap_exposure`. @@ -1957,8 +2063,8 @@ The white reference value for tonemapping (also called "whitepoint"). Higher val .. rst-class:: classref-property-setget -- void **set_volumetric_fog_albedo** **(** :ref:`Color` value **)** -- :ref:`Color` **get_volumetric_fog_albedo** **(** **)** +- |void| **set_volumetric_fog_albedo**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_volumetric_fog_albedo**\ (\ ) The :ref:`Color` of the volumetric fog when interacting with lights. Mist and fog have an albedo close to ``Color(1, 1, 1, 1)`` while smoke has a darker albedo. @@ -1974,8 +2080,8 @@ The :ref:`Color` of the volumetric fog when interacting with lights .. rst-class:: classref-property-setget -- void **set_volumetric_fog_ambient_inject** **(** :ref:`float` value **)** -- :ref:`float` **get_volumetric_fog_ambient_inject** **(** **)** +- |void| **set_volumetric_fog_ambient_inject**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_volumetric_fog_ambient_inject**\ (\ ) Scales the strength of ambient light used in the volumetric fog. A value of ``0.0`` means that ambient light will not impact the volumetric fog. :ref:`volumetric_fog_ambient_inject` has a small performance cost when set above ``0.0``. @@ -1993,8 +2099,8 @@ Scales the strength of ambient light used in the volumetric fog. A value of ``0. .. rst-class:: classref-property-setget -- void **set_volumetric_fog_anisotropy** **(** :ref:`float` value **)** -- :ref:`float` **get_volumetric_fog_anisotropy** **(** **)** +- |void| **set_volumetric_fog_anisotropy**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_volumetric_fog_anisotropy**\ (\ ) The direction of scattered light as it goes through the volumetric fog. A value close to ``1.0`` means almost all light is scattered forward. A value close to ``0.0`` means light is scattered equally in all directions. A value close to ``-1.0`` means light is scattered mostly backward. Fog and mist scatter light slightly forward, while smoke scatters light equally in all directions. @@ -2010,8 +2116,8 @@ The direction of scattered light as it goes through the volumetric fog. A value .. rst-class:: classref-property-setget -- void **set_volumetric_fog_density** **(** :ref:`float` value **)** -- :ref:`float` **get_volumetric_fog_density** **(** **)** +- |void| **set_volumetric_fog_density**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_volumetric_fog_density**\ (\ ) The base *exponential* density of the volumetric fog. Set this to the lowest density you want to have globally. :ref:`FogVolume`\ s can be used to add to or subtract from this density in specific areas. Fog rendering is exponential as in real life. @@ -2031,8 +2137,8 @@ To make volumetric fog work as a volumetric *lighting* solution, set :ref:`volum .. rst-class:: classref-property-setget -- void **set_volumetric_fog_detail_spread** **(** :ref:`float` value **)** -- :ref:`float` **get_volumetric_fog_detail_spread** **(** **)** +- |void| **set_volumetric_fog_detail_spread**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_volumetric_fog_detail_spread**\ (\ ) The distribution of size down the length of the froxel buffer. A higher value compresses the froxels closer to the camera and places more detail closer to the camera. @@ -2048,8 +2154,8 @@ The distribution of size down the length of the froxel buffer. A higher value co .. rst-class:: classref-property-setget -- void **set_volumetric_fog_emission** **(** :ref:`Color` value **)** -- :ref:`Color` **get_volumetric_fog_emission** **(** **)** +- |void| **set_volumetric_fog_emission**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_volumetric_fog_emission**\ (\ ) The emitted light from the volumetric fog. Even with emission, volumetric fog will not cast light onto other surfaces. Emission is useful to establish an ambient color. As the volumetric fog effect uses single-scattering only, fog tends to need a little bit of emission to soften the harsh shadows. @@ -2065,8 +2171,8 @@ The emitted light from the volumetric fog. Even with emission, volumetric fog wi .. rst-class:: classref-property-setget -- void **set_volumetric_fog_emission_energy** **(** :ref:`float` value **)** -- :ref:`float` **get_volumetric_fog_emission_energy** **(** **)** +- |void| **set_volumetric_fog_emission_energy**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_volumetric_fog_emission_energy**\ (\ ) The brightness of the emitted light from the volumetric fog. @@ -2082,8 +2188,8 @@ The brightness of the emitted light from the volumetric fog. .. rst-class:: classref-property-setget -- void **set_volumetric_fog_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_volumetric_fog_enabled** **(** **)** +- |void| **set_volumetric_fog_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_volumetric_fog_enabled**\ (\ ) Enables the volumetric fog effect. Volumetric fog uses a screen-aligned froxel buffer to calculate accurate volumetric scattering in the short to medium range. Volumetric fog interacts with :ref:`FogVolume`\ s and lights to calculate localized and global fog. Volumetric fog uses a PBR single-scattering model based on extinction, scattering, and emission which it exposes to users as density, albedo, and emission. @@ -2101,8 +2207,8 @@ Enables the volumetric fog effect. Volumetric fog uses a screen-aligned froxel b .. rst-class:: classref-property-setget -- void **set_volumetric_fog_gi_inject** **(** :ref:`float` value **)** -- :ref:`float` **get_volumetric_fog_gi_inject** **(** **)** +- |void| **set_volumetric_fog_gi_inject**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_volumetric_fog_gi_inject**\ (\ ) Scales the strength of Global Illumination used in the volumetric fog's albedo color. A value of ``0.0`` means that Global Illumination will not impact the volumetric fog. :ref:`volumetric_fog_gi_inject` has a small performance cost when set above ``0.0``. @@ -2122,8 +2228,8 @@ Scales the strength of Global Illumination used in the volumetric fog's albedo c .. rst-class:: classref-property-setget -- void **set_volumetric_fog_length** **(** :ref:`float` value **)** -- :ref:`float` **get_volumetric_fog_length** **(** **)** +- |void| **set_volumetric_fog_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_volumetric_fog_length**\ (\ ) The distance over which the volumetric fog is computed. Increase to compute fog over a greater range, decrease to add more detail when a long range is not needed. For best quality fog, keep this as low as possible. See also :ref:`ProjectSettings.rendering/environment/volumetric_fog/volume_depth`. @@ -2139,8 +2245,8 @@ The distance over which the volumetric fog is computed. Increase to compute fog .. rst-class:: classref-property-setget -- void **set_volumetric_fog_sky_affect** **(** :ref:`float` value **)** -- :ref:`float` **get_volumetric_fog_sky_affect** **(** **)** +- |void| **set_volumetric_fog_sky_affect**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_volumetric_fog_sky_affect**\ (\ ) The factor to use when affecting the sky with volumetric fog. ``1.0`` means that volumetric fog can fully obscure the sky. Lower values reduce the impact of volumetric fog on sky rendering, with ``0.0`` not affecting sky rendering at all. @@ -2158,8 +2264,8 @@ The factor to use when affecting the sky with volumetric fog. ``1.0`` means that .. rst-class:: classref-property-setget -- void **set_volumetric_fog_temporal_reprojection_amount** **(** :ref:`float` value **)** -- :ref:`float` **get_volumetric_fog_temporal_reprojection_amount** **(** **)** +- |void| **set_volumetric_fog_temporal_reprojection_amount**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_volumetric_fog_temporal_reprojection_amount**\ (\ ) The amount by which to blend the last frame with the current frame. A higher number results in smoother volumetric fog, but makes "ghosting" much worse. A lower value reduces ghosting but can result in the per-frame temporal jitter becoming visible. @@ -2175,8 +2281,8 @@ The amount by which to blend the last frame with the current frame. A higher num .. rst-class:: classref-property-setget -- void **set_volumetric_fog_temporal_reprojection_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_volumetric_fog_temporal_reprojection_enabled** **(** **)** +- |void| **set_volumetric_fog_temporal_reprojection_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_volumetric_fog_temporal_reprojection_enabled**\ (\ ) Enables temporal reprojection in the volumetric fog. Temporal reprojection blends the current frame's volumetric fog with the last frame's volumetric fog to smooth out jagged edges. The performance cost is minimal; however, it leads to moving :ref:`FogVolume`\ s and :ref:`Light3D`\ s "ghosting" and leaving a trail behind them. When temporal reprojection is enabled, try to avoid moving :ref:`FogVolume`\ s or :ref:`Light3D`\ s too fast. Short-lived dynamic lighting effects should have :ref:`Light3D.light_volumetric_fog_energy` set to ``0.0`` to avoid ghosting. @@ -2193,7 +2299,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_glow_level** **(** :ref:`int` idx **)** |const| +:ref:`float` **get_glow_level**\ (\ idx\: :ref:`int`\ ) |const| Returns the intensity of the glow level ``idx``. @@ -2205,7 +2311,7 @@ Returns the intensity of the glow level ``idx``. .. rst-class:: classref-method -void **set_glow_level** **(** :ref:`int` idx, :ref:`float` intensity **)** +|void| **set_glow_level**\ (\ idx\: :ref:`int`, intensity\: :ref:`float`\ ) Sets the intensity of the glow level ``idx``. A value above ``0.0`` enables the level. Each level relies on the previous level. This means that enabling higher glow levels will slow down the glow effect rendering, even if previous levels aren't enabled. @@ -2216,3 +2322,4 @@ Sets the intensity of the glow level ``idx``. A value above ``0.0`` enables the .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_expression.rst b/classes/class_expression.rst index 1345418df1a..fc326170bbb 100644 --- a/classes/class_expression.rst +++ b/classes/class_expression.rst @@ -85,15 +85,15 @@ Methods .. table:: :widths: auto - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`execute` **(** :ref:`Array` inputs=[], :ref:`Object` base_instance=null, :ref:`bool` show_error=true, :ref:`bool` const_calls_only=false **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_error_text` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_execute_failed` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`parse` **(** :ref:`String` expression, :ref:`PackedStringArray` input_names=PackedStringArray() **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`execute`\ (\ inputs\: :ref:`Array` = [], base_instance\: :ref:`Object` = null, show_error\: :ref:`bool` = true, const_calls_only\: :ref:`bool` = false\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_error_text`\ (\ ) |const| | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_execute_failed`\ (\ ) |const| | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`parse`\ (\ expression\: :ref:`String`, input_names\: :ref:`PackedStringArray` = PackedStringArray()\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -108,7 +108,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **execute** **(** :ref:`Array` inputs=[], :ref:`Object` base_instance=null, :ref:`bool` show_error=true, :ref:`bool` const_calls_only=false **)** +:ref:`Variant` **execute**\ (\ inputs\: :ref:`Array` = [], base_instance\: :ref:`Object` = null, show_error\: :ref:`bool` = true, const_calls_only\: :ref:`bool` = false\ ) Executes the expression that was previously parsed by :ref:`parse` and returns the result. Before you use the returned object, you should check if the method failed by calling :ref:`has_execute_failed`. @@ -122,7 +122,7 @@ If you defined input variables in :ref:`parse`, y .. rst-class:: classref-method -:ref:`String` **get_error_text** **(** **)** |const| +:ref:`String` **get_error_text**\ (\ ) |const| Returns the error text if :ref:`parse` or :ref:`execute` has failed. @@ -134,7 +134,7 @@ Returns the error text if :ref:`parse` or :ref:`e .. rst-class:: classref-method -:ref:`bool` **has_execute_failed** **(** **)** |const| +:ref:`bool` **has_execute_failed**\ (\ ) |const| Returns ``true`` if :ref:`execute` has failed. @@ -146,7 +146,7 @@ Returns ``true`` if :ref:`execute` has failed. .. rst-class:: classref-method -:ref:`Error` **parse** **(** :ref:`String` expression, :ref:`PackedStringArray` input_names=PackedStringArray() **)** +:ref:`Error` **parse**\ (\ expression\: :ref:`String`, input_names\: :ref:`PackedStringArray` = PackedStringArray()\ ) Parses the expression and returns an :ref:`Error` code. @@ -159,3 +159,4 @@ You can optionally specify names of variables that may appear in the expression .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_fastnoiselite.rst b/classes/class_fastnoiselite.rst index 6a85375f3fe..fc858d64a9e 100644 --- a/classes/class_fastnoiselite.rst +++ b/classes/class_fastnoiselite.rst @@ -375,8 +375,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_cellular_distance_function** **(** :ref:`CellularDistanceFunction` value **)** -- :ref:`CellularDistanceFunction` **get_cellular_distance_function** **(** **)** +- |void| **set_cellular_distance_function**\ (\ value\: :ref:`CellularDistanceFunction`\ ) +- :ref:`CellularDistanceFunction` **get_cellular_distance_function**\ (\ ) Determines how the distance to the nearest/second-nearest point is computed. See :ref:`CellularDistanceFunction` for options. @@ -392,8 +392,8 @@ Determines how the distance to the nearest/second-nearest point is computed. See .. rst-class:: classref-property-setget -- void **set_cellular_jitter** **(** :ref:`float` value **)** -- :ref:`float` **get_cellular_jitter** **(** **)** +- |void| **set_cellular_jitter**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_cellular_jitter**\ (\ ) Maximum distance a point can move off of its grid position. Set to ``0`` for an even grid. @@ -409,8 +409,8 @@ Maximum distance a point can move off of its grid position. Set to ``0`` for an .. rst-class:: classref-property-setget -- void **set_cellular_return_type** **(** :ref:`CellularReturnType` value **)** -- :ref:`CellularReturnType` **get_cellular_return_type** **(** **)** +- |void| **set_cellular_return_type**\ (\ value\: :ref:`CellularReturnType`\ ) +- :ref:`CellularReturnType` **get_cellular_return_type**\ (\ ) Return type from cellular noise calculations. See :ref:`CellularReturnType`. @@ -426,8 +426,8 @@ Return type from cellular noise calculations. See :ref:`CellularReturnType` value **)** -- :ref:`float` **get_domain_warp_amplitude** **(** **)** +- |void| **set_domain_warp_amplitude**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_domain_warp_amplitude**\ (\ ) Sets the maximum warp distance from the origin. @@ -443,8 +443,8 @@ Sets the maximum warp distance from the origin. .. rst-class:: classref-property-setget -- void **set_domain_warp_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_domain_warp_enabled** **(** **)** +- |void| **set_domain_warp_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_domain_warp_enabled**\ (\ ) If enabled, another FastNoiseLite instance is used to warp the space, resulting in a distortion of the noise. @@ -460,8 +460,8 @@ If enabled, another FastNoiseLite instance is used to warp the space, resulting .. rst-class:: classref-property-setget -- void **set_domain_warp_fractal_gain** **(** :ref:`float` value **)** -- :ref:`float` **get_domain_warp_fractal_gain** **(** **)** +- |void| **set_domain_warp_fractal_gain**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_domain_warp_fractal_gain**\ (\ ) Determines the strength of each subsequent layer of the noise which is used to warp the space. @@ -479,8 +479,8 @@ A low value places more emphasis on the lower frequency base layers, while a hig .. rst-class:: classref-property-setget -- void **set_domain_warp_fractal_lacunarity** **(** :ref:`float` value **)** -- :ref:`float` **get_domain_warp_fractal_lacunarity** **(** **)** +- |void| **set_domain_warp_fractal_lacunarity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_domain_warp_fractal_lacunarity**\ (\ ) Octave lacunarity of the fractal noise which warps the space. Increasing this value results in higher octaves producing noise with finer details and a rougher appearance. @@ -496,8 +496,8 @@ Octave lacunarity of the fractal noise which warps the space. Increasing this va .. rst-class:: classref-property-setget -- void **set_domain_warp_fractal_octaves** **(** :ref:`int` value **)** -- :ref:`int` **get_domain_warp_fractal_octaves** **(** **)** +- |void| **set_domain_warp_fractal_octaves**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_domain_warp_fractal_octaves**\ (\ ) The number of noise layers that are sampled to get the final value for the fractal noise which warps the space. @@ -513,8 +513,8 @@ The number of noise layers that are sampled to get the final value for the fract .. rst-class:: classref-property-setget -- void **set_domain_warp_fractal_type** **(** :ref:`DomainWarpFractalType` value **)** -- :ref:`DomainWarpFractalType` **get_domain_warp_fractal_type** **(** **)** +- |void| **set_domain_warp_fractal_type**\ (\ value\: :ref:`DomainWarpFractalType`\ ) +- :ref:`DomainWarpFractalType` **get_domain_warp_fractal_type**\ (\ ) The method for combining octaves into a fractal which is used to warp the space. See :ref:`DomainWarpFractalType`. @@ -530,8 +530,8 @@ The method for combining octaves into a fractal which is used to warp the space. .. rst-class:: classref-property-setget -- void **set_domain_warp_frequency** **(** :ref:`float` value **)** -- :ref:`float` **get_domain_warp_frequency** **(** **)** +- |void| **set_domain_warp_frequency**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_domain_warp_frequency**\ (\ ) Frequency of the noise which warps the space. Low frequency results in smooth noise while high frequency results in rougher, more granular noise. @@ -547,8 +547,8 @@ Frequency of the noise which warps the space. Low frequency results in smooth no .. rst-class:: classref-property-setget -- void **set_domain_warp_type** **(** :ref:`DomainWarpType` value **)** -- :ref:`DomainWarpType` **get_domain_warp_type** **(** **)** +- |void| **set_domain_warp_type**\ (\ value\: :ref:`DomainWarpType`\ ) +- :ref:`DomainWarpType` **get_domain_warp_type**\ (\ ) Sets the warp algorithm. See :ref:`DomainWarpType`. @@ -564,8 +564,8 @@ Sets the warp algorithm. See :ref:`DomainWarpType` value **)** -- :ref:`float` **get_fractal_gain** **(** **)** +- |void| **set_fractal_gain**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fractal_gain**\ (\ ) Determines the strength of each subsequent layer of noise in fractal noise. @@ -583,8 +583,8 @@ A low value places more emphasis on the lower frequency base layers, while a hig .. rst-class:: classref-property-setget -- void **set_fractal_lacunarity** **(** :ref:`float` value **)** -- :ref:`float` **get_fractal_lacunarity** **(** **)** +- |void| **set_fractal_lacunarity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fractal_lacunarity**\ (\ ) Frequency multiplier between subsequent octaves. Increasing this value results in higher octaves producing noise with finer details and a rougher appearance. @@ -600,8 +600,8 @@ Frequency multiplier between subsequent octaves. Increasing this value results i .. rst-class:: classref-property-setget -- void **set_fractal_octaves** **(** :ref:`int` value **)** -- :ref:`int` **get_fractal_octaves** **(** **)** +- |void| **set_fractal_octaves**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_fractal_octaves**\ (\ ) The number of noise layers that are sampled to get the final value for fractal noise types. @@ -617,8 +617,8 @@ The number of noise layers that are sampled to get the final value for fractal n .. rst-class:: classref-property-setget -- void **set_fractal_ping_pong_strength** **(** :ref:`float` value **)** -- :ref:`float` **get_fractal_ping_pong_strength** **(** **)** +- |void| **set_fractal_ping_pong_strength**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fractal_ping_pong_strength**\ (\ ) Sets the strength of the fractal ping pong type. @@ -634,8 +634,8 @@ Sets the strength of the fractal ping pong type. .. rst-class:: classref-property-setget -- void **set_fractal_type** **(** :ref:`FractalType` value **)** -- :ref:`FractalType` **get_fractal_type** **(** **)** +- |void| **set_fractal_type**\ (\ value\: :ref:`FractalType`\ ) +- :ref:`FractalType` **get_fractal_type**\ (\ ) The method for combining octaves into a fractal. See :ref:`FractalType`. @@ -651,8 +651,8 @@ The method for combining octaves into a fractal. See :ref:`FractalType` value **)** -- :ref:`float` **get_fractal_weighted_strength** **(** **)** +- |void| **set_fractal_weighted_strength**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fractal_weighted_strength**\ (\ ) Higher weighting means higher octaves have less impact if lower octaves have a large impact. @@ -668,8 +668,8 @@ Higher weighting means higher octaves have less impact if lower octaves have a l .. rst-class:: classref-property-setget -- void **set_frequency** **(** :ref:`float` value **)** -- :ref:`float` **get_frequency** **(** **)** +- |void| **set_frequency**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_frequency**\ (\ ) The frequency for all noise types. Low frequency results in smooth noise while high frequency results in rougher, more granular noise. @@ -685,8 +685,8 @@ The frequency for all noise types. Low frequency results in smooth noise while h .. rst-class:: classref-property-setget -- void **set_noise_type** **(** :ref:`NoiseType` value **)** -- :ref:`NoiseType` **get_noise_type** **(** **)** +- |void| **set_noise_type**\ (\ value\: :ref:`NoiseType`\ ) +- :ref:`NoiseType` **get_noise_type**\ (\ ) The noise algorithm used. See :ref:`NoiseType`. @@ -702,8 +702,8 @@ The noise algorithm used. See :ref:`NoiseType`. .. rst-class:: classref-property-setget -- void **set_offset** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_offset** **(** **)** +- |void| **set_offset**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_offset**\ (\ ) Translate the noise input coordinates by the given :ref:`Vector3`. @@ -719,8 +719,8 @@ Translate the noise input coordinates by the given :ref:`Vector3` .. rst-class:: classref-property-setget -- void **set_seed** **(** :ref:`int` value **)** -- :ref:`int` **get_seed** **(** **)** +- |void| **set_seed**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_seed**\ (\ ) The random number seed for all noise types. @@ -731,3 +731,4 @@ The random number seed for all noise types. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_fbxdocument.rst b/classes/class_fbxdocument.rst new file mode 100644 index 00000000000..0861a63ba51 --- /dev/null +++ b/classes/class_fbxdocument.rst @@ -0,0 +1,35 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot 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/fbx/doc_classes/FBXDocument.xml. + +.. _class_FBXDocument: + +FBXDocument +=========== + +**Experimental:** This class may be changed or removed in future versions. + +**Inherits:** :ref:`GLTFDocument` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +Handles FBX documents. + +.. rst-class:: classref-introduction-group + +Description +----------- + +The FBXDocument handles FBX documents. It provides methods to append data from buffers or files, generate scenes, and register/unregister document extensions. + +When exporting FBX from Blender, use the "FBX Units Scale" option. The "FBX Units Scale" option sets the correct scale factor and avoids manual adjustments when re-importing into Blender, such as through glTF export. + +.. |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.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_fbxstate.rst b/classes/class_fbxstate.rst new file mode 100644 index 00000000000..dd20b0778f2 --- /dev/null +++ b/classes/class_fbxstate.rst @@ -0,0 +1,65 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot 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/fbx/doc_classes/FBXState.xml. + +.. _class_FBXState: + +FBXState +======== + +**Experimental:** This class may be changed or removed in future versions. + +**Inherits:** :ref:`GLTFState` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +.. rst-class:: classref-introduction-group + +Description +----------- + +The FBXState handles the state data imported from FBX files. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------+-----------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`allow_geometry_helper_nodes` | ``false`` | + +-------------------------+-----------------------------------------------------------------------------------------+-----------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_FBXState_property_allow_geometry_helper_nodes: + +.. rst-class:: classref-property + +:ref:`bool` **allow_geometry_helper_nodes** = ``false`` + +.. rst-class:: classref-property-setget + +- |void| **set_allow_geometry_helper_nodes**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_allow_geometry_helper_nodes**\ (\ ) + +If ``true``, the import process used auxiliary nodes called geometry helper nodes. These nodes help preserve the pivots and transformations of the original 3D model during import. + +.. |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.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_fileaccess.rst b/classes/class_fileaccess.rst index 2e00a7bc5b5..76bfba3f4c0 100644 --- a/classes/class_fileaccess.rst +++ b/classes/class_fileaccess.rst @@ -93,115 +93,115 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`close` **(** **)** | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`eof_reached` **(** **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** |static| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`flush` **(** **)** | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_8` **(** **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_16` **(** **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_32` **(** **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_64` **(** **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_as_text` **(** :ref:`bool` skip_cr=false **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`get_buffer` **(** :ref:`int` length **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_csv_line` **(** :ref:`String` delim="," **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_double` **(** **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`get_error` **(** **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`get_file_as_bytes` **(** :ref:`String` path **)** |static| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_file_as_string` **(** :ref:`String` path **)** |static| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_float` **(** **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_hidden_attribute` **(** :ref:`String` file **)** |static| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_length` **(** **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_line` **(** **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_md5` **(** :ref:`String` path **)** |static| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_modified_time` **(** :ref:`String` file **)** |static| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`get_open_error` **(** **)** |static| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_pascal_string` **(** **)** | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_path` **(** **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_path_absolute` **(** **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_position` **(** **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_read_only_attribute` **(** :ref:`String` file **)** |static| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_real` **(** **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_sha256` **(** :ref:`String` path **)** |static| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`UnixPermissionFlags`\> | :ref:`get_unix_permissions` **(** :ref:`String` file **)** |static| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_var` **(** :ref:`bool` allow_objects=false **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_open` **(** **)** |const| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`FileAccess` | :ref:`open` **(** :ref:`String` path, :ref:`ModeFlags` flags **)** |static| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`FileAccess` | :ref:`open_compressed` **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`CompressionMode` compression_mode=0 **)** |static| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`FileAccess` | :ref:`open_encrypted` **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`PackedByteArray` key **)** |static| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`FileAccess` | :ref:`open_encrypted_with_pass` **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`String` pass **)** |static| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`seek` **(** :ref:`int` position **)** | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`seek_end` **(** :ref:`int` position=0 **)** | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`set_hidden_attribute` **(** :ref:`String` file, :ref:`bool` hidden **)** |static| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`set_read_only_attribute` **(** :ref:`String` file, :ref:`bool` ro **)** |static| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`set_unix_permissions` **(** :ref:`String` file, |bitfield|\<:ref:`UnixPermissionFlags`\> permissions **)** |static| | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`store_8` **(** :ref:`int` value **)** | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`store_16` **(** :ref:`int` value **)** | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`store_32` **(** :ref:`int` value **)** | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`store_64` **(** :ref:`int` value **)** | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`store_buffer` **(** :ref:`PackedByteArray` buffer **)** | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`store_csv_line` **(** :ref:`PackedStringArray` values, :ref:`String` delim="," **)** | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`store_double` **(** :ref:`float` value **)** | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`store_float` **(** :ref:`float` value **)** | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`store_line` **(** :ref:`String` line **)** | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`store_pascal_string` **(** :ref:`String` string **)** | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`store_real` **(** :ref:`float` value **)** | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`store_string` **(** :ref:`String` string **)** | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`store_var` **(** :ref:`Variant` value, :ref:`bool` full_objects=false **)** | - +-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`close`\ (\ ) | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`eof_reached`\ (\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`file_exists`\ (\ path\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`flush`\ (\ ) | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_8`\ (\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_16`\ (\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_32`\ (\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_64`\ (\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_as_text`\ (\ skip_cr\: :ref:`bool` = false\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`get_buffer`\ (\ length\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_csv_line`\ (\ delim\: :ref:`String` = ","\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_double`\ (\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`get_error`\ (\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`get_file_as_bytes`\ (\ path\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_file_as_string`\ (\ path\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_float`\ (\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_hidden_attribute`\ (\ file\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_length`\ (\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_line`\ (\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_md5`\ (\ path\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_modified_time`\ (\ file\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`get_open_error`\ (\ ) |static| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_pascal_string`\ (\ ) | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_path`\ (\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_path_absolute`\ (\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_position`\ (\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_read_only_attribute`\ (\ file\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_real`\ (\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_sha256`\ (\ path\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`UnixPermissionFlags`\] | :ref:`get_unix_permissions`\ (\ file\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_var`\ (\ allow_objects\: :ref:`bool` = false\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_open`\ (\ ) |const| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FileAccess` | :ref:`open`\ (\ path\: :ref:`String`, flags\: :ref:`ModeFlags`\ ) |static| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FileAccess` | :ref:`open_compressed`\ (\ path\: :ref:`String`, mode_flags\: :ref:`ModeFlags`, compression_mode\: :ref:`CompressionMode` = 0\ ) |static| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FileAccess` | :ref:`open_encrypted`\ (\ path\: :ref:`String`, mode_flags\: :ref:`ModeFlags`, key\: :ref:`PackedByteArray`\ ) |static| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FileAccess` | :ref:`open_encrypted_with_pass`\ (\ path\: :ref:`String`, mode_flags\: :ref:`ModeFlags`, pass\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`seek`\ (\ position\: :ref:`int`\ ) | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`seek_end`\ (\ position\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`set_hidden_attribute`\ (\ file\: :ref:`String`, hidden\: :ref:`bool`\ ) |static| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`set_read_only_attribute`\ (\ file\: :ref:`String`, ro\: :ref:`bool`\ ) |static| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`set_unix_permissions`\ (\ file\: :ref:`String`, permissions\: |bitfield|\[:ref:`UnixPermissionFlags`\]\ ) |static| | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`store_8`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`store_16`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`store_32`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`store_64`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`store_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`store_csv_line`\ (\ values\: :ref:`PackedStringArray`, delim\: :ref:`String` = ","\ ) | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`store_double`\ (\ value\: :ref:`float`\ ) | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`store_float`\ (\ value\: :ref:`float`\ ) | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`store_line`\ (\ line\: :ref:`String`\ ) | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`store_pascal_string`\ (\ string\: :ref:`String`\ ) | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`store_real`\ (\ value\: :ref:`float`\ ) | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`store_string`\ (\ string\: :ref:`String`\ ) | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`store_var`\ (\ value\: :ref:`Variant`, full_objects\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -423,8 +423,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_big_endian** **(** :ref:`bool` value **)** -- :ref:`bool` **is_big_endian** **(** **)** +- |void| **set_big_endian**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_big_endian**\ (\ ) If ``true``, the file is read with big-endian `endianness `__. If ``false``, the file is read with little-endian endianness. If in doubt, leave this to ``false`` as most files are written with little-endian endianness. @@ -445,7 +445,7 @@ Method Descriptions .. rst-class:: classref-method -void **close** **(** **)** +|void| **close**\ (\ ) Closes the currently opened file and prevents subsequent read/write operations. Use :ref:`flush` to persist the data to disk without closing the file. @@ -459,7 +459,7 @@ Closes the currently opened file and prevents subsequent read/write operations. .. rst-class:: classref-method -:ref:`bool` **eof_reached** **(** **)** |const| +:ref:`bool` **eof_reached**\ (\ ) |const| Returns ``true`` if the file cursor has already read past the end of the file. @@ -490,7 +490,7 @@ Returns ``true`` if the file cursor has already read past the end of the file. .. rst-class:: classref-method -:ref:`bool` **file_exists** **(** :ref:`String` path **)** |static| +:ref:`bool` **file_exists**\ (\ path\: :ref:`String`\ ) |static| Returns ``true`` if the file exists in the given path. @@ -506,7 +506,7 @@ For a non-static, relative equivalent, use :ref:`DirAccess.file_exists` manually before closing a file. Still, calling :ref:`flush` can be used to ensure the data is safe even if the project crashes instead of being closed gracefully. @@ -520,7 +520,7 @@ Writes the file's buffer to disk. Flushing is automatically performed when the f .. rst-class:: classref-method -:ref:`int` **get_8** **(** **)** |const| +:ref:`int` **get_8**\ (\ ) |const| Returns the next 8 bits from the file as an integer. See :ref:`store_8` for details on what values can be stored and retrieved this way. @@ -532,7 +532,7 @@ Returns the next 8 bits from the file as an integer. See :ref:`store_8` **get_16** **(** **)** |const| +:ref:`int` **get_16**\ (\ ) |const| Returns the next 16 bits from the file as an integer. See :ref:`store_16` for details on what values can be stored and retrieved this way. @@ -544,7 +544,7 @@ Returns the next 16 bits from the file as an integer. See :ref:`store_16` **get_32** **(** **)** |const| +:ref:`int` **get_32**\ (\ ) |const| Returns the next 32 bits from the file as an integer. See :ref:`store_32` for details on what values can be stored and retrieved this way. @@ -556,7 +556,7 @@ Returns the next 32 bits from the file as an integer. See :ref:`store_32` **get_64** **(** **)** |const| +:ref:`int` **get_64**\ (\ ) |const| Returns the next 64 bits from the file as an integer. See :ref:`store_64` for details on what values can be stored and retrieved this way. @@ -568,7 +568,7 @@ Returns the next 64 bits from the file as an integer. See :ref:`store_64` **get_as_text** **(** :ref:`bool` skip_cr=false **)** |const| +:ref:`String` **get_as_text**\ (\ skip_cr\: :ref:`bool` = false\ ) |const| Returns the whole file as a :ref:`String`. Text is interpreted as being UTF-8 encoded. @@ -582,7 +582,7 @@ If ``skip_cr`` is ``true``, carriage return characters (``\r``, CR) will be igno .. rst-class:: classref-method -:ref:`PackedByteArray` **get_buffer** **(** :ref:`int` length **)** |const| +:ref:`PackedByteArray` **get_buffer**\ (\ length\: :ref:`int`\ ) |const| Returns next ``length`` bytes of the file as a :ref:`PackedByteArray`. @@ -594,7 +594,7 @@ Returns next ``length`` bytes of the file as a :ref:`PackedByteArray` **get_csv_line** **(** :ref:`String` delim="," **)** |const| +:ref:`PackedStringArray` **get_csv_line**\ (\ delim\: :ref:`String` = ","\ ) |const| Returns the next value of the file in CSV (Comma-Separated Values) format. You can pass a different delimiter ``delim`` to use other than the default ``","`` (comma). This delimiter must be one-character long, and cannot be a double quotation mark. @@ -618,7 +618,7 @@ Note how the second line can omit the enclosing quotes as it does not include th .. rst-class:: classref-method -:ref:`float` **get_double** **(** **)** |const| +:ref:`float` **get_double**\ (\ ) |const| Returns the next 64 bits from the file as a floating-point number. @@ -630,7 +630,7 @@ Returns the next 64 bits from the file as a floating-point number. .. rst-class:: classref-method -:ref:`Error` **get_error** **(** **)** |const| +:ref:`Error` **get_error**\ (\ ) |const| Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE_*`` constants from :ref:`Error`. @@ -642,7 +642,7 @@ Returns the last error that happened when trying to perform operations. Compare .. rst-class:: classref-method -:ref:`PackedByteArray` **get_file_as_bytes** **(** :ref:`String` path **)** |static| +:ref:`PackedByteArray` **get_file_as_bytes**\ (\ path\: :ref:`String`\ ) |static| Returns the whole ``path`` file contents as a :ref:`PackedByteArray` without any decoding. @@ -656,7 +656,7 @@ Returns an empty :ref:`PackedByteArray` if an error occur .. rst-class:: classref-method -:ref:`String` **get_file_as_string** **(** :ref:`String` path **)** |static| +:ref:`String` **get_file_as_string**\ (\ path\: :ref:`String`\ ) |static| Returns the whole ``path`` file contents as a :ref:`String`. Text is interpreted as being UTF-8 encoded. @@ -670,7 +670,7 @@ Returns an empty :ref:`String` if an error occurred while opening .. rst-class:: classref-method -:ref:`float` **get_float** **(** **)** |const| +:ref:`float` **get_float**\ (\ ) |const| Returns the next 32 bits from the file as a floating-point number. @@ -682,7 +682,7 @@ Returns the next 32 bits from the file as a floating-point number. .. rst-class:: classref-method -:ref:`bool` **get_hidden_attribute** **(** :ref:`String` file **)** |static| +:ref:`bool` **get_hidden_attribute**\ (\ file\: :ref:`String`\ ) |static| Returns ``true``, if file ``hidden`` attribute is set. @@ -696,7 +696,7 @@ Returns ``true``, if file ``hidden`` attribute is set. .. rst-class:: classref-method -:ref:`int` **get_length** **(** **)** |const| +:ref:`int` **get_length**\ (\ ) |const| Returns the size of the file in bytes. @@ -708,7 +708,7 @@ Returns the size of the file in bytes. .. rst-class:: classref-method -:ref:`String` **get_line** **(** **)** |const| +:ref:`String` **get_line**\ (\ ) |const| Returns the next line of the file as a :ref:`String`. @@ -722,7 +722,7 @@ Text is interpreted as being UTF-8 encoded. .. rst-class:: classref-method -:ref:`String` **get_md5** **(** :ref:`String` path **)** |static| +:ref:`String` **get_md5**\ (\ path\: :ref:`String`\ ) |static| Returns an MD5 String representing the file at the given path or an empty :ref:`String` on failure. @@ -734,7 +734,7 @@ Returns an MD5 String representing the file at the given path or an empty :ref:` .. rst-class:: classref-method -:ref:`int` **get_modified_time** **(** :ref:`String` file **)** |static| +:ref:`int` **get_modified_time**\ (\ file\: :ref:`String`\ ) |static| Returns the last time the ``file`` was modified in Unix timestamp format, or ``0`` on error. This Unix timestamp can be converted to another format using the :ref:`Time` singleton. @@ -746,7 +746,7 @@ Returns the last time the ``file`` was modified in Unix timestamp format, or ``0 .. rst-class:: classref-method -:ref:`Error` **get_open_error** **(** **)** |static| +:ref:`Error` **get_open_error**\ (\ ) |static| Returns the result of the last :ref:`open` call in the current thread. @@ -758,7 +758,7 @@ Returns the result of the last :ref:`open` call in .. rst-class:: classref-method -:ref:`String` **get_pascal_string** **(** **)** +:ref:`String` **get_pascal_string**\ (\ ) Returns a :ref:`String` saved in Pascal format from the file. @@ -772,7 +772,7 @@ Text is interpreted as being UTF-8 encoded. .. rst-class:: classref-method -:ref:`String` **get_path** **(** **)** |const| +:ref:`String` **get_path**\ (\ ) |const| Returns the path as a :ref:`String` for the current open file. @@ -784,7 +784,7 @@ Returns the path as a :ref:`String` for the current open file. .. rst-class:: classref-method -:ref:`String` **get_path_absolute** **(** **)** |const| +:ref:`String` **get_path_absolute**\ (\ ) |const| Returns the absolute path as a :ref:`String` for the current open file. @@ -796,7 +796,7 @@ Returns the absolute path as a :ref:`String` for the current open .. rst-class:: classref-method -:ref:`int` **get_position** **(** **)** |const| +:ref:`int` **get_position**\ (\ ) |const| Returns the file cursor's position. @@ -808,7 +808,7 @@ Returns the file cursor's position. .. rst-class:: classref-method -:ref:`bool` **get_read_only_attribute** **(** :ref:`String` file **)** |static| +:ref:`bool` **get_read_only_attribute**\ (\ file\: :ref:`String`\ ) |static| Returns ``true``, if file ``read only`` attribute is set. @@ -822,7 +822,7 @@ Returns ``true``, if file ``read only`` attribute is set. .. rst-class:: classref-method -:ref:`float` **get_real** **(** **)** |const| +:ref:`float` **get_real**\ (\ ) |const| Returns the next bits from the file as a floating-point number. @@ -834,7 +834,7 @@ Returns the next bits from the file as a floating-point number. .. rst-class:: classref-method -:ref:`String` **get_sha256** **(** :ref:`String` path **)** |static| +:ref:`String` **get_sha256**\ (\ path\: :ref:`String`\ ) |static| Returns a SHA-256 :ref:`String` representing the file at the given path or an empty :ref:`String` on failure. @@ -846,7 +846,7 @@ Returns a SHA-256 :ref:`String` representing the file at the given .. rst-class:: classref-method -|bitfield|\<:ref:`UnixPermissionFlags`\> **get_unix_permissions** **(** :ref:`String` file **)** |static| +|bitfield|\[:ref:`UnixPermissionFlags`\] **get_unix_permissions**\ (\ file\: :ref:`String`\ ) |static| Returns file UNIX permissions. @@ -860,7 +860,7 @@ Returns file UNIX permissions. .. rst-class:: classref-method -:ref:`Variant` **get_var** **(** :ref:`bool` allow_objects=false **)** |const| +:ref:`Variant` **get_var**\ (\ allow_objects\: :ref:`bool` = false\ ) |const| Returns the next :ref:`Variant` value from the file. If ``allow_objects`` is ``true``, decoding objects is allowed. @@ -876,7 +876,7 @@ Internally, this uses the same decoding mechanism as the :ref:`@GlobalScope.byte .. rst-class:: classref-method -:ref:`bool` **is_open** **(** **)** |const| +:ref:`bool` **is_open**\ (\ ) |const| Returns ``true`` if the file is currently opened. @@ -888,7 +888,7 @@ Returns ``true`` if the file is currently opened. .. rst-class:: classref-method -:ref:`FileAccess` **open** **(** :ref:`String` path, :ref:`ModeFlags` flags **)** |static| +:ref:`FileAccess` **open**\ (\ path\: :ref:`String`, flags\: :ref:`ModeFlags`\ ) |static| Creates a new **FileAccess** object and opens the file for writing or reading, depending on the flags. @@ -902,7 +902,7 @@ Returns ``null`` if opening the file failed. You can use :ref:`get_open_error` **open_compressed** **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`CompressionMode` compression_mode=0 **)** |static| +:ref:`FileAccess` **open_compressed**\ (\ path\: :ref:`String`, mode_flags\: :ref:`ModeFlags`, compression_mode\: :ref:`CompressionMode` = 0\ ) |static| Creates a new **FileAccess** object and opens a compressed file for reading or writing. @@ -918,7 +918,7 @@ Returns ``null`` if opening the file failed. You can use :ref:`get_open_error` **open_encrypted** **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`PackedByteArray` key **)** |static| +:ref:`FileAccess` **open_encrypted**\ (\ path\: :ref:`String`, mode_flags\: :ref:`ModeFlags`, key\: :ref:`PackedByteArray`\ ) |static| Creates a new **FileAccess** object and opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. @@ -934,7 +934,7 @@ Returns ``null`` if opening the file failed. You can use :ref:`get_open_error` **open_encrypted_with_pass** **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`String` pass **)** |static| +:ref:`FileAccess` **open_encrypted_with_pass**\ (\ path\: :ref:`String`, mode_flags\: :ref:`ModeFlags`, pass\: :ref:`String`\ ) |static| Creates a new **FileAccess** object and opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it. @@ -948,7 +948,7 @@ Returns ``null`` if opening the file failed. You can use :ref:`get_open_error` position **)** +|void| **seek**\ (\ position\: :ref:`int`\ ) Changes the file reading/writing cursor to the specified position (in bytes from the beginning of the file). @@ -960,7 +960,7 @@ Changes the file reading/writing cursor to the specified position (in bytes from .. rst-class:: classref-method -void **seek_end** **(** :ref:`int` position=0 **)** +|void| **seek_end**\ (\ position\: :ref:`int` = 0\ ) Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). @@ -974,7 +974,7 @@ Changes the file reading/writing cursor to the specified position (in bytes from .. rst-class:: classref-method -:ref:`Error` **set_hidden_attribute** **(** :ref:`String` file, :ref:`bool` hidden **)** |static| +:ref:`Error` **set_hidden_attribute**\ (\ file\: :ref:`String`, hidden\: :ref:`bool`\ ) |static| Sets file **hidden** attribute. @@ -988,7 +988,7 @@ Sets file **hidden** attribute. .. rst-class:: classref-method -:ref:`Error` **set_read_only_attribute** **(** :ref:`String` file, :ref:`bool` ro **)** |static| +:ref:`Error` **set_read_only_attribute**\ (\ file\: :ref:`String`, ro\: :ref:`bool`\ ) |static| Sets file **read only** attribute. @@ -1002,7 +1002,7 @@ Sets file **read only** attribute. .. rst-class:: classref-method -:ref:`Error` **set_unix_permissions** **(** :ref:`String` file, |bitfield|\<:ref:`UnixPermissionFlags`\> permissions **)** |static| +:ref:`Error` **set_unix_permissions**\ (\ file\: :ref:`String`, permissions\: |bitfield|\[:ref:`UnixPermissionFlags`\]\ ) |static| Sets file UNIX permissions. @@ -1016,7 +1016,7 @@ Sets file UNIX permissions. .. rst-class:: classref-method -void **store_8** **(** :ref:`int` value **)** +|void| **store_8**\ (\ value\: :ref:`int`\ ) Stores an integer as 8 bits in the file. @@ -1032,7 +1032,7 @@ To store a signed integer, use :ref:`store_64` .. rst-class:: classref-method -void **store_16** **(** :ref:`int` value **)** +|void| **store_16**\ (\ value\: :ref:`int`\ ) Stores an integer as 16 bits in the file. @@ -1085,7 +1085,7 @@ To store a signed integer, use :ref:`store_64` .. rst-class:: classref-method -void **store_32** **(** :ref:`int` value **)** +|void| **store_32**\ (\ value\: :ref:`int`\ ) Stores an integer as 32 bits in the file. @@ -1101,7 +1101,7 @@ To store a signed integer, use :ref:`store_64` .. rst-class:: classref-method -void **store_64** **(** :ref:`int` value **)** +|void| **store_64**\ (\ value\: :ref:`int`\ ) Stores an integer as 64 bits in the file. @@ -1115,7 +1115,7 @@ Stores an integer as 64 bits in the file. .. rst-class:: classref-method -void **store_buffer** **(** :ref:`PackedByteArray` buffer **)** +|void| **store_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) Stores the given array of bytes in the file. @@ -1127,7 +1127,7 @@ Stores the given array of bytes in the file. .. rst-class:: classref-method -void **store_csv_line** **(** :ref:`PackedStringArray` values, :ref:`String` delim="," **)** +|void| **store_csv_line**\ (\ values\: :ref:`PackedStringArray`, delim\: :ref:`String` = ","\ ) Store the given :ref:`PackedStringArray` in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter ``delim`` to use other than the default ``","`` (comma). This delimiter must be one-character long. @@ -1141,7 +1141,7 @@ Text will be encoded as UTF-8. .. rst-class:: classref-method -void **store_double** **(** :ref:`float` value **)** +|void| **store_double**\ (\ value\: :ref:`float`\ ) Stores a floating-point number as 64 bits in the file. @@ -1153,7 +1153,7 @@ Stores a floating-point number as 64 bits in the file. .. rst-class:: classref-method -void **store_float** **(** :ref:`float` value **)** +|void| **store_float**\ (\ value\: :ref:`float`\ ) Stores a floating-point number as 32 bits in the file. @@ -1165,7 +1165,7 @@ Stores a floating-point number as 32 bits in the file. .. rst-class:: classref-method -void **store_line** **(** :ref:`String` line **)** +|void| **store_line**\ (\ line\: :ref:`String`\ ) Appends ``line`` to the file followed by a line return character (``\n``), encoding the text as UTF-8. @@ -1177,7 +1177,7 @@ Appends ``line`` to the file followed by a line return character (``\n``), encod .. rst-class:: classref-method -void **store_pascal_string** **(** :ref:`String` string **)** +|void| **store_pascal_string**\ (\ string\: :ref:`String`\ ) Stores the given :ref:`String` as a line in the file in Pascal format (i.e. also store the length of the string). @@ -1191,7 +1191,7 @@ Text will be encoded as UTF-8. .. rst-class:: classref-method -void **store_real** **(** :ref:`float` value **)** +|void| **store_real**\ (\ value\: :ref:`float`\ ) Stores a floating-point number in the file. @@ -1203,7 +1203,7 @@ Stores a floating-point number in the file. .. rst-class:: classref-method -void **store_string** **(** :ref:`String` string **)** +|void| **store_string**\ (\ string\: :ref:`String`\ ) Appends ``string`` to the file without a line return, encoding the text as UTF-8. @@ -1217,7 +1217,7 @@ Appends ``string`` to the file without a line return, encoding the text as UTF-8 .. rst-class:: classref-method -void **store_var** **(** :ref:`Variant` value, :ref:`bool` full_objects=false **)** +|void| **store_var**\ (\ value\: :ref:`Variant`, full_objects\: :ref:`bool` = false\ ) Stores any Variant value in the file. If ``full_objects`` is ``true``, encoding objects is allowed (and can potentially include code). @@ -1232,3 +1232,4 @@ Internally, this uses the same encoding mechanism as the :ref:`@GlobalScope.var_ .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 1bad9f7be2d..43d3ae16a48 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -65,35 +65,35 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_filter` **(** :ref:`String` filter, :ref:`String` description="" **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_option` **(** :ref:`String` name, :ref:`PackedStringArray` values, :ref:`int` index **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_filters` **(** **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`deselect_all` **(** **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_option_default` **(** :ref:`int` option **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_option_name` **(** :ref:`int` option **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_option_values` **(** :ref:`int` option **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_selected_options` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`invalidate` **(** **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_option_default` **(** :ref:`int` option, :ref:`int` index **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_option_name` **(** :ref:`int` option, :ref:`String` name **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_option_values` **(** :ref:`int` option, :ref:`PackedStringArray` values **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_filter`\ (\ filter\: :ref:`String`, description\: :ref:`String` = ""\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_option`\ (\ name\: :ref:`String`, values\: :ref:`PackedStringArray`, index\: :ref:`int`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_filters`\ (\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`deselect_all`\ (\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`LineEdit` | :ref:`get_line_edit`\ (\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_option_default`\ (\ option\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_option_name`\ (\ option\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_option_values`\ (\ option\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_selected_options`\ (\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`VBoxContainer` | :ref:`get_vbox`\ (\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`invalidate`\ (\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_option_default`\ (\ option\: :ref:`int`, index\: :ref:`int`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_option_name`\ (\ option\: :ref:`int`, name\: :ref:`String`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_option_values`\ (\ option\: :ref:`int`, values\: :ref:`PackedStringArray`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -138,7 +138,7 @@ Signals .. rst-class:: classref-signal -**dir_selected** **(** :ref:`String` dir **)** +**dir_selected**\ (\ dir\: :ref:`String`\ ) Emitted when the user selects a directory. @@ -150,7 +150,7 @@ Emitted when the user selects a directory. .. rst-class:: classref-signal -**file_selected** **(** :ref:`String` path **)** +**file_selected**\ (\ path\: :ref:`String`\ ) Emitted when the user selects a file by double-clicking it or pressing the **OK** button. @@ -162,7 +162,7 @@ Emitted when the user selects a file by double-clicking it or pressing the **OK* .. rst-class:: classref-signal -**files_selected** **(** :ref:`PackedStringArray` paths **)** +**files_selected**\ (\ paths\: :ref:`PackedStringArray`\ ) Emitted when the user selects multiple files. @@ -272,8 +272,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_access** **(** :ref:`Access` value **)** -- :ref:`Access` **get_access** **(** **)** +- |void| **set_access**\ (\ value\: :ref:`Access`\ ) +- :ref:`Access` **get_access**\ (\ ) The file system access scope. See :ref:`Access` constants. @@ -291,8 +291,8 @@ The file system access scope. See :ref:`Access` constant .. rst-class:: classref-property-setget -- void **set_current_dir** **(** :ref:`String` value **)** -- :ref:`String` **get_current_dir** **(** **)** +- |void| **set_current_dir**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_current_dir**\ (\ ) The current working directory of the file dialog. @@ -308,8 +308,8 @@ The current working directory of the file dialog. .. rst-class:: classref-property-setget -- void **set_current_file** **(** :ref:`String` value **)** -- :ref:`String` **get_current_file** **(** **)** +- |void| **set_current_file**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_current_file**\ (\ ) The currently selected file of the file dialog. @@ -325,8 +325,8 @@ The currently selected file of the file dialog. .. rst-class:: classref-property-setget -- void **set_current_path** **(** :ref:`String` value **)** -- :ref:`String` **get_current_path** **(** **)** +- |void| **set_current_path**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_current_path**\ (\ ) The currently selected file path of the file dialog. @@ -342,8 +342,8 @@ The currently selected file path of the file dialog. .. rst-class:: classref-property-setget -- void **set_file_mode** **(** :ref:`FileMode` value **)** -- :ref:`FileMode` **get_file_mode** **(** **)** +- |void| **set_file_mode**\ (\ value\: :ref:`FileMode`\ ) +- :ref:`FileMode` **get_file_mode**\ (\ ) The dialog's open or save mode, which affects the selection behavior. See :ref:`FileMode`. @@ -359,8 +359,8 @@ The dialog's open or save mode, which affects the selection behavior. See :ref:` .. rst-class:: classref-property-setget -- void **set_filters** **(** :ref:`PackedStringArray` value **)** -- :ref:`PackedStringArray` **get_filters** **(** **)** +- |void| **set_filters**\ (\ value\: :ref:`PackedStringArray`\ ) +- :ref:`PackedStringArray` **get_filters**\ (\ ) The available file type filters. For example, this shows only ``.png`` and ``.gd`` files: ``set_filters(PackedStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))``. Multiple file types can also be specified in a single filter. ``"*.png, *.jpg, *.jpeg ; Supported Images"`` will show both PNG and JPEG files when selected. @@ -376,8 +376,8 @@ The available file type filters. For example, this shows only ``.png`` and ``.gd .. rst-class:: classref-property-setget -- void **set_mode_overrides_title** **(** :ref:`bool` value **)** -- :ref:`bool` **is_mode_overriding_title** **(** **)** +- |void| **set_mode_overrides_title**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_mode_overriding_title**\ (\ ) If ``true``, changing the :ref:`file_mode` property will set the window title accordingly (e.g. setting :ref:`file_mode` to :ref:`FILE_MODE_OPEN_FILE` will change the window title to "Open a File"). @@ -393,8 +393,8 @@ If ``true``, changing the :ref:`file_mode` .. rst-class:: classref-property-setget -- void **set_option_count** **(** :ref:`int` value **)** -- :ref:`int` **get_option_count** **(** **)** +- |void| **set_option_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_option_count**\ (\ ) The number of additional :ref:`OptionButton`\ s and :ref:`CheckBox`\ es in the dialog. @@ -410,8 +410,8 @@ The number of additional :ref:`OptionButton`\ s and :ref:`Ch .. rst-class:: classref-property-setget -- void **set_root_subfolder** **(** :ref:`String` value **)** -- :ref:`String` **get_root_subfolder** **(** **)** +- |void| **set_root_subfolder**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_root_subfolder**\ (\ ) If non-empty, the given sub-folder will be "root" of this **FileDialog**, i.e. user won't be able to go to its parent directory. @@ -427,8 +427,8 @@ If non-empty, the given sub-folder will be "root" of this **FileDialog**, i.e. u .. rst-class:: classref-property-setget -- void **set_show_hidden_files** **(** :ref:`bool` value **)** -- :ref:`bool` **is_showing_hidden_files** **(** **)** +- |void| **set_show_hidden_files**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_showing_hidden_files**\ (\ ) If ``true``, the dialog will show hidden files. @@ -444,8 +444,8 @@ If ``true``, the dialog will show hidden files. .. rst-class:: classref-property-setget -- void **set_use_native_dialog** **(** :ref:`bool` value **)** -- :ref:`bool` **get_use_native_dialog** **(** **)** +- |void| **set_use_native_dialog**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_native_dialog**\ (\ ) If ``true``, :ref:`access` is set to :ref:`ACCESS_FILESYSTEM`, and it is supported by the current :ref:`DisplayServer`, OS native dialog will be used instead of custom one. @@ -464,7 +464,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_filter** **(** :ref:`String` filter, :ref:`String` description="" **)** +|void| **add_filter**\ (\ filter\: :ref:`String`, description\: :ref:`String` = ""\ ) Adds a comma-delimited file name ``filter`` option to the **FileDialog** with an optional ``description``, which restricts what files can be picked. @@ -480,7 +480,7 @@ For example, a ``filter`` of ``"*.png, *.jpg"`` and a ``description`` of ``"Imag .. rst-class:: classref-method -void **add_option** **(** :ref:`String` name, :ref:`PackedStringArray` values, :ref:`int` index **)** +|void| **add_option**\ (\ name\: :ref:`String`, values\: :ref:`PackedStringArray`, index\: :ref:`int`\ ) Adds an additional :ref:`OptionButton` to the file dialog. If ``values`` is empty, a :ref:`CheckBox` is added instead. @@ -492,7 +492,7 @@ Adds an additional :ref:`OptionButton` to the file dialog. I .. rst-class:: classref-method -void **clear_filters** **(** **)** +|void| **clear_filters**\ (\ ) Clear all the added filters in the dialog. @@ -504,7 +504,7 @@ Clear all the added filters in the dialog. .. rst-class:: classref-method -void **deselect_all** **(** **)** +|void| **deselect_all**\ (\ ) Clear all currently selected items in the dialog. @@ -516,7 +516,7 @@ Clear all currently selected items in the dialog. .. rst-class:: classref-method -:ref:`LineEdit` **get_line_edit** **(** **)** +:ref:`LineEdit` **get_line_edit**\ (\ ) Returns the LineEdit for the selected file. @@ -530,7 +530,7 @@ Returns the LineEdit for the selected file. .. rst-class:: classref-method -:ref:`int` **get_option_default** **(** :ref:`int` option **)** |const| +:ref:`int` **get_option_default**\ (\ option\: :ref:`int`\ ) |const| Returns the default value index of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. @@ -542,7 +542,7 @@ Returns the default value index of the :ref:`OptionButton` o .. rst-class:: classref-method -:ref:`String` **get_option_name** **(** :ref:`int` option **)** |const| +:ref:`String` **get_option_name**\ (\ option\: :ref:`int`\ ) |const| Returns the name of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. @@ -554,7 +554,7 @@ Returns the name of the :ref:`OptionButton` or :ref:`CheckBo .. rst-class:: classref-method -:ref:`PackedStringArray` **get_option_values** **(** :ref:`int` option **)** |const| +:ref:`PackedStringArray` **get_option_values**\ (\ option\: :ref:`int`\ ) |const| Returns an array of values of the :ref:`OptionButton` with index ``option``. @@ -566,7 +566,7 @@ Returns an array of values of the :ref:`OptionButton` with i .. rst-class:: classref-method -:ref:`Dictionary` **get_selected_options** **(** **)** |const| +:ref:`Dictionary` **get_selected_options**\ (\ ) |const| Returns a :ref:`Dictionary` with the selected values of the additional :ref:`OptionButton`\ s and/or :ref:`CheckBox`\ es. :ref:`Dictionary` keys are names and values are selected value indices. @@ -578,7 +578,7 @@ Returns a :ref:`Dictionary` with the selected values of the ad .. rst-class:: classref-method -:ref:`VBoxContainer` **get_vbox** **(** **)** +:ref:`VBoxContainer` **get_vbox**\ (\ ) Returns the vertical box container of the dialog, custom controls can be added to it. @@ -592,7 +592,7 @@ Returns the vertical box container of the dialog, custom controls can be added t .. rst-class:: classref-method -void **invalidate** **(** **)** +|void| **invalidate**\ (\ ) Invalidate and update the current dialog content list. @@ -604,7 +604,7 @@ Invalidate and update the current dialog content list. .. rst-class:: classref-method -void **set_option_default** **(** :ref:`int` option, :ref:`int` index **)** +|void| **set_option_default**\ (\ option\: :ref:`int`, index\: :ref:`int`\ ) Sets the default value index of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. @@ -616,7 +616,7 @@ Sets the default value index of the :ref:`OptionButton` or : .. rst-class:: classref-method -void **set_option_name** **(** :ref:`int` option, :ref:`String` name **)** +|void| **set_option_name**\ (\ option\: :ref:`int`, name\: :ref:`String`\ ) Sets the name of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. @@ -628,7 +628,7 @@ Sets the name of the :ref:`OptionButton` or :ref:`CheckBox` option, :ref:`PackedStringArray` values **)** +|void| **set_option_values**\ (\ option\: :ref:`int`, values\: :ref:`PackedStringArray`\ ) Sets the option values of the :ref:`OptionButton` with index ``option``. @@ -764,3 +764,4 @@ Custom icon for the toggle hidden button. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_filesystemdock.rst b/classes/class_filesystemdock.rst index 2f9f4f8d32a..073d0dab2cc 100644 --- a/classes/class_filesystemdock.rst +++ b/classes/class_filesystemdock.rst @@ -31,13 +31,13 @@ Methods .. table:: :widths: auto - +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_resource_tooltip_plugin` **(** :ref:`EditorResourceTooltipPlugin` plugin **)** | - +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`navigate_to_path` **(** :ref:`String` path **)** | - +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_resource_tooltip_plugin` **(** :ref:`EditorResourceTooltipPlugin` plugin **)** | - +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_resource_tooltip_plugin`\ (\ plugin\: :ref:`EditorResourceTooltipPlugin`\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`navigate_to_path`\ (\ path\: :ref:`String`\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_resource_tooltip_plugin`\ (\ plugin\: :ref:`EditorResourceTooltipPlugin`\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -52,7 +52,7 @@ Signals .. rst-class:: classref-signal -**display_mode_changed** **(** **)** +**display_mode_changed**\ (\ ) Emitted when the user switches file display mode or split mode. @@ -64,7 +64,7 @@ Emitted when the user switches file display mode or split mode. .. rst-class:: classref-signal -**file_removed** **(** :ref:`String` file **)** +**file_removed**\ (\ file\: :ref:`String`\ ) Emitted when the given ``file`` was removed. @@ -76,7 +76,7 @@ Emitted when the given ``file`` was removed. .. rst-class:: classref-signal -**files_moved** **(** :ref:`String` old_file, :ref:`String` new_file **)** +**files_moved**\ (\ old_file\: :ref:`String`, new_file\: :ref:`String`\ ) Emitted when a file is moved from ``old_file`` path to ``new_file`` path. @@ -88,7 +88,7 @@ Emitted when a file is moved from ``old_file`` path to ``new_file`` path. .. rst-class:: classref-signal -**folder_moved** **(** :ref:`String` old_folder, :ref:`String` new_folder **)** +**folder_moved**\ (\ old_folder\: :ref:`String`, new_folder\: :ref:`String`\ ) Emitted when a folder is moved from ``old_folder`` path to ``new_folder`` path. @@ -100,7 +100,7 @@ Emitted when a folder is moved from ``old_folder`` path to ``new_folder`` path. .. rst-class:: classref-signal -**folder_removed** **(** :ref:`String` folder **)** +**folder_removed**\ (\ folder\: :ref:`String`\ ) Emitted when the given ``folder`` was removed. @@ -112,7 +112,7 @@ Emitted when the given ``folder`` was removed. .. rst-class:: classref-signal -**inherit** **(** :ref:`String` file **)** +**inherit**\ (\ file\: :ref:`String`\ ) Emitted when a new scene is created that inherits the scene at ``file`` path. @@ -124,7 +124,7 @@ Emitted when a new scene is created that inherits the scene at ``file`` path. .. rst-class:: classref-signal -**instantiate** **(** :ref:`PackedStringArray` files **)** +**instantiate**\ (\ files\: :ref:`PackedStringArray`\ ) Emitted when the given scenes are being instantiated in the editor. @@ -136,7 +136,7 @@ Emitted when the given scenes are being instantiated in the editor. .. rst-class:: classref-signal -**resource_removed** **(** :ref:`Resource` resource **)** +**resource_removed**\ (\ resource\: :ref:`Resource`\ ) Emitted when an external ``resource`` had its file removed. @@ -153,7 +153,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_resource_tooltip_plugin** **(** :ref:`EditorResourceTooltipPlugin` plugin **)** +|void| **add_resource_tooltip_plugin**\ (\ plugin\: :ref:`EditorResourceTooltipPlugin`\ ) Registers a new :ref:`EditorResourceTooltipPlugin`. @@ -165,7 +165,7 @@ Registers a new :ref:`EditorResourceTooltipPlugin` path **)** +|void| **navigate_to_path**\ (\ path\: :ref:`String`\ ) Sets the given ``path`` as currently selected, ensuring that the selected file/directory is visible. @@ -177,7 +177,7 @@ Sets the given ``path`` as currently selected, ensuring that the selected file/d .. rst-class:: classref-method -void **remove_resource_tooltip_plugin** **(** :ref:`EditorResourceTooltipPlugin` plugin **)** +|void| **remove_resource_tooltip_plugin**\ (\ plugin\: :ref:`EditorResourceTooltipPlugin`\ ) Removes an :ref:`EditorResourceTooltipPlugin`. Fails if the plugin wasn't previously added. @@ -188,3 +188,4 @@ Removes an :ref:`EditorResourceTooltipPlugin` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_float.rst b/classes/class_float.rst index cce7f598703..a4e8d64d2d0 100644 --- a/classes/class_float.rst +++ b/classes/class_float.rst @@ -40,17 +40,17 @@ Constructors .. table:: :widths: auto - +---------------------------+------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`float` **(** **)** | - +---------------------------+------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`float` **(** :ref:`float` from **)** | - +---------------------------+------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`float` **(** :ref:`String` from **)** | - +---------------------------+------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`float` **(** :ref:`bool` from **)** | - +---------------------------+------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`float` **(** :ref:`int` from **)** | - +---------------------------+------------------------------------------------------------------------------------------+ + +---------------------------+---------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`float`\ (\ ) | + +---------------------------+---------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`float`\ (\ from\: :ref:`float`\ ) | + +---------------------------+---------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`float`\ (\ from\: :ref:`String`\ ) | + +---------------------------+---------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`float`\ (\ from\: :ref:`bool`\ ) | + +---------------------------+---------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`float`\ (\ from\: :ref:`int`\ ) | + +---------------------------+---------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -60,71 +60,71 @@ Operators .. table:: :widths: auto - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`float` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`int` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`operator *` **(** :ref:`Color` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`operator *` **(** :ref:`Quaternion` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator *` **(** :ref:`Vector2` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator *` **(** :ref:`Vector2i` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator *` **(** :ref:`Vector3` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator *` **(** :ref:`Vector3i` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`operator *` **(** :ref:`Vector4` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`operator *` **(** :ref:`Vector4i` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator *` **(** :ref:`float` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator *` **(** :ref:`int` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator **` **(** :ref:`float` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator **` **(** :ref:`int` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator +` **(** :ref:`float` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator +` **(** :ref:`int` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator -` **(** :ref:`float` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator -` **(** :ref:`int` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator /` **(** :ref:`float` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator /` **(** :ref:`int` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<` **(** :ref:`float` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<` **(** :ref:`int` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<=` **(** :ref:`float` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<=` **(** :ref:`int` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`float` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`int` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >` **(** :ref:`float` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >` **(** :ref:`int` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >=` **(** :ref:`float` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >=` **(** :ref:`int` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator unary+` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator unary-` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`operator *`\ (\ right\: :ref:`Color`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`operator *`\ (\ right\: :ref:`Quaternion`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator *`\ (\ right\: :ref:`Vector2`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator *`\ (\ right\: :ref:`Vector2i`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator *`\ (\ right\: :ref:`Vector3`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator *`\ (\ right\: :ref:`Vector3i`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator *`\ (\ right\: :ref:`Vector4`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator *`\ (\ right\: :ref:`Vector4i`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator *`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator *`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator **`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator **`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator +`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator +`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator -`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator -`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator /`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator /`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<=`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<=`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >=`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >=`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator unary+`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator unary-`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -139,7 +139,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`float` **float** **(** **)** +:ref:`float` **float**\ (\ ) Constructs a default-initialized **float** set to ``0.0``. @@ -149,7 +149,7 @@ Constructs a default-initialized **float** set to ``0.0``. .. rst-class:: classref-constructor -:ref:`float` **float** **(** :ref:`float` from **)** +:ref:`float` **float**\ (\ from\: :ref:`float`\ ) Constructs a **float** as a copy of the given **float**. @@ -159,7 +159,7 @@ Constructs a **float** as a copy of the given **float**. .. rst-class:: classref-constructor -:ref:`float` **float** **(** :ref:`String` from **)** +:ref:`float` **float**\ (\ from\: :ref:`String`\ ) Converts a :ref:`String` to a **float**, following the same rules as :ref:`String.to_float`. @@ -169,7 +169,7 @@ Converts a :ref:`String` to a **float**, following the same rules .. rst-class:: classref-constructor -:ref:`float` **float** **(** :ref:`bool` from **)** +:ref:`float` **float**\ (\ from\: :ref:`bool`\ ) Cast a :ref:`bool` value to a floating-point value, ``float(true)`` will be equal to 1.0 and ``float(false)`` will be equal to 0.0. @@ -179,7 +179,7 @@ Cast a :ref:`bool` value to a floating-point value, ``float(true)`` .. rst-class:: classref-constructor -:ref:`float` **float** **(** :ref:`int` from **)** +:ref:`float` **float**\ (\ from\: :ref:`int`\ ) Cast an :ref:`int` value to a floating-point value, ``float(1)`` will be equal to ``1.0``. @@ -196,7 +196,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`float` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`float`\ ) Returns ``true`` if two floats are different from each other. @@ -210,7 +210,7 @@ Returns ``true`` if two floats are different from each other. .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`int` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`int`\ ) Returns ``true`` if the integer has different value than the float. @@ -222,7 +222,7 @@ Returns ``true`` if the integer has different value than the float. .. rst-class:: classref-operator -:ref:`Color` **operator *** **(** :ref:`Color` right **)** +:ref:`Color` **operator ***\ (\ right\: :ref:`Color`\ ) Multiplies each component of the :ref:`Color`, including the alpha, by the given **float**. @@ -238,7 +238,7 @@ Multiplies each component of the :ref:`Color`, including the alpha, .. rst-class:: classref-operator -:ref:`Quaternion` **operator *** **(** :ref:`Quaternion` right **)** +:ref:`Quaternion` **operator ***\ (\ right\: :ref:`Quaternion`\ ) Multiplies each component of the :ref:`Quaternion` by the given **float**. This operation is not meaningful on its own, but it can be used as a part of a larger expression. @@ -250,7 +250,7 @@ Multiplies each component of the :ref:`Quaternion` by the give .. rst-class:: classref-operator -:ref:`Vector2` **operator *** **(** :ref:`Vector2` right **)** +:ref:`Vector2` **operator ***\ (\ right\: :ref:`Vector2`\ ) Multiplies each component of the :ref:`Vector2` by the given **float**. @@ -266,7 +266,7 @@ Multiplies each component of the :ref:`Vector2` by the given **fl .. rst-class:: classref-operator -:ref:`Vector2` **operator *** **(** :ref:`Vector2i` right **)** +:ref:`Vector2` **operator ***\ (\ right\: :ref:`Vector2i`\ ) Multiplies each component of the :ref:`Vector2i` by the given **float**. Returns a :ref:`Vector2`. @@ -282,7 +282,7 @@ Multiplies each component of the :ref:`Vector2i` by the given ** .. rst-class:: classref-operator -:ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3`\ ) Multiplies each component of the :ref:`Vector3` by the given **float**. @@ -294,7 +294,7 @@ Multiplies each component of the :ref:`Vector3` by the given **fl .. rst-class:: classref-operator -:ref:`Vector3` **operator *** **(** :ref:`Vector3i` right **)** +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3i`\ ) Multiplies each component of the :ref:`Vector3i` by the given **float**. Returns a :ref:`Vector3`. @@ -310,7 +310,7 @@ Multiplies each component of the :ref:`Vector3i` by the given ** .. rst-class:: classref-operator -:ref:`Vector4` **operator *** **(** :ref:`Vector4` right **)** +:ref:`Vector4` **operator ***\ (\ right\: :ref:`Vector4`\ ) Multiplies each component of the :ref:`Vector4` by the given **float**. @@ -322,7 +322,7 @@ Multiplies each component of the :ref:`Vector4` by the given **fl .. rst-class:: classref-operator -:ref:`Vector4` **operator *** **(** :ref:`Vector4i` right **)** +:ref:`Vector4` **operator ***\ (\ right\: :ref:`Vector4i`\ ) Multiplies each component of the :ref:`Vector4i` by the given **float**. Returns a :ref:`Vector4`. @@ -338,7 +338,7 @@ Multiplies each component of the :ref:`Vector4i` by the given ** .. rst-class:: classref-operator -:ref:`float` **operator *** **(** :ref:`float` right **)** +:ref:`float` **operator ***\ (\ right\: :ref:`float`\ ) Multiplies two **float**\ s. @@ -350,7 +350,7 @@ Multiplies two **float**\ s. .. rst-class:: classref-operator -:ref:`float` **operator *** **(** :ref:`int` right **)** +:ref:`float` **operator ***\ (\ right\: :ref:`int`\ ) Multiplies a **float** and an :ref:`int`. The result is a **float**. @@ -362,7 +362,7 @@ Multiplies a **float** and an :ref:`int`. The result is a **float**. .. rst-class:: classref-operator -:ref:`float` **operator **** **(** :ref:`float` right **)** +:ref:`float` **operator ****\ (\ right\: :ref:`float`\ ) Raises a **float** to a power of a **float**. @@ -378,7 +378,7 @@ Raises a **float** to a power of a **float**. .. rst-class:: classref-operator -:ref:`float` **operator **** **(** :ref:`int` right **)** +:ref:`float` **operator ****\ (\ right\: :ref:`int`\ ) Raises a **float** to a power of an :ref:`int`. The result is a **float**. @@ -394,7 +394,7 @@ Raises a **float** to a power of an :ref:`int`. The result is a **flo .. rst-class:: classref-operator -:ref:`float` **operator +** **(** :ref:`float` right **)** +:ref:`float` **operator +**\ (\ right\: :ref:`float`\ ) Adds two floats. @@ -406,7 +406,7 @@ Adds two floats. .. rst-class:: classref-operator -:ref:`float` **operator +** **(** :ref:`int` right **)** +:ref:`float` **operator +**\ (\ right\: :ref:`int`\ ) Adds a **float** and an :ref:`int`. The result is a **float**. @@ -418,7 +418,7 @@ Adds a **float** and an :ref:`int`. The result is a **float**. .. rst-class:: classref-operator -:ref:`float` **operator -** **(** :ref:`float` right **)** +:ref:`float` **operator -**\ (\ right\: :ref:`float`\ ) Subtracts a float from a float. @@ -430,7 +430,7 @@ Subtracts a float from a float. .. rst-class:: classref-operator -:ref:`float` **operator -** **(** :ref:`int` right **)** +:ref:`float` **operator -**\ (\ right\: :ref:`int`\ ) Subtracts an :ref:`int` from a **float**. The result is a **float**. @@ -442,7 +442,7 @@ Subtracts an :ref:`int` from a **float**. The result is a **float**. .. rst-class:: classref-operator -:ref:`float` **operator /** **(** :ref:`float` right **)** +:ref:`float` **operator /**\ (\ right\: :ref:`float`\ ) Divides two floats. @@ -454,7 +454,7 @@ Divides two floats. .. rst-class:: classref-operator -:ref:`float` **operator /** **(** :ref:`int` right **)** +:ref:`float` **operator /**\ (\ right\: :ref:`int`\ ) Divides a **float** by an :ref:`int`. The result is a **float**. @@ -466,7 +466,7 @@ Divides a **float** by an :ref:`int`. The result is a **float**. .. rst-class:: classref-operator -:ref:`bool` **operator <** **(** :ref:`float` right **)** +:ref:`bool` **operator <**\ (\ right\: :ref:`float`\ ) Returns ``true`` if the left float is less than the right one. @@ -480,7 +480,7 @@ Returns ``true`` if the left float is less than the right one. .. rst-class:: classref-operator -:ref:`bool` **operator <** **(** :ref:`int` right **)** +:ref:`bool` **operator <**\ (\ right\: :ref:`int`\ ) Returns ``true`` if this **float** is less than the given :ref:`int`. @@ -492,7 +492,7 @@ Returns ``true`` if this **float** is less than the given :ref:`int`. .. rst-class:: classref-operator -:ref:`bool` **operator <=** **(** :ref:`float` right **)** +:ref:`bool` **operator <=**\ (\ right\: :ref:`float`\ ) Returns ``true`` if the left float is less than or equal to the right one. @@ -506,7 +506,7 @@ Returns ``true`` if the left float is less than or equal to the right one. .. rst-class:: classref-operator -:ref:`bool` **operator <=** **(** :ref:`int` right **)** +:ref:`bool` **operator <=**\ (\ right\: :ref:`int`\ ) Returns ``true`` if this **float** is less than or equal to the given :ref:`int`. @@ -518,7 +518,7 @@ Returns ``true`` if this **float** is less than or equal to the given :ref:`int< .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`float` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`float`\ ) Returns ``true`` if both floats are exactly equal. @@ -534,7 +534,7 @@ Returns ``true`` if both floats are exactly equal. .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`int` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`int`\ ) Returns ``true`` if the **float** and the given :ref:`int` are equal. @@ -546,7 +546,7 @@ Returns ``true`` if the **float** and the given :ref:`int` are equal. .. rst-class:: classref-operator -:ref:`bool` **operator >** **(** :ref:`float` right **)** +:ref:`bool` **operator >**\ (\ right\: :ref:`float`\ ) Returns ``true`` if the left float is greater than the right one. @@ -560,7 +560,7 @@ Returns ``true`` if the left float is greater than the right one. .. rst-class:: classref-operator -:ref:`bool` **operator >** **(** :ref:`int` right **)** +:ref:`bool` **operator >**\ (\ right\: :ref:`int`\ ) Returns ``true`` if this **float** is greater than the given :ref:`int`. @@ -572,7 +572,7 @@ Returns ``true`` if this **float** is greater than the given :ref:`int` **operator >=** **(** :ref:`float` right **)** +:ref:`bool` **operator >=**\ (\ right\: :ref:`float`\ ) Returns ``true`` if the left float is greater than or equal to the right one. @@ -586,7 +586,7 @@ Returns ``true`` if the left float is greater than or equal to the right one. .. rst-class:: classref-operator -:ref:`bool` **operator >=** **(** :ref:`int` right **)** +:ref:`bool` **operator >=**\ (\ right\: :ref:`int`\ ) Returns ``true`` if this **float** is greater than or equal to the given :ref:`int`. @@ -598,7 +598,7 @@ Returns ``true`` if this **float** is greater than or equal to the given :ref:`i .. rst-class:: classref-operator -:ref:`float` **operator unary+** **(** **)** +:ref:`float` **operator unary+**\ (\ ) Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -610,7 +610,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`float` **operator unary-** **(** **)** +:ref:`float` **operator unary-**\ (\ ) Returns the negative value of the **float**. If positive, turns the number negative. If negative, turns the number positive. With floats, the number zero can be either positive or negative. @@ -621,3 +621,4 @@ Returns the negative value of the **float**. If positive, turns the number negat .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_flowcontainer.rst b/classes/class_flowcontainer.rst index 48f466ba9a2..a85dff0b970 100644 --- a/classes/class_flowcontainer.rst +++ b/classes/class_flowcontainer.rst @@ -54,9 +54,9 @@ Methods .. table:: :widths: auto - +-----------------------+--------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_count` **(** **)** |const| | - +-----------------------+--------------------------------------------------------------------------------------+ + +-----------------------+--------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_count`\ (\ ) |const| | + +-----------------------+--------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -128,8 +128,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_alignment** **(** :ref:`AlignmentMode` value **)** -- :ref:`AlignmentMode` **get_alignment** **(** **)** +- |void| **set_alignment**\ (\ value\: :ref:`AlignmentMode`\ ) +- :ref:`AlignmentMode` **get_alignment**\ (\ ) The alignment of the container's children (must be one of :ref:`ALIGNMENT_BEGIN`, :ref:`ALIGNMENT_CENTER`, or :ref:`ALIGNMENT_END`). @@ -145,8 +145,8 @@ The alignment of the container's children (must be one of :ref:`ALIGNMENT_BEGIN< .. rst-class:: classref-property-setget -- void **set_reverse_fill** **(** :ref:`bool` value **)** -- :ref:`bool` **is_reverse_fill** **(** **)** +- |void| **set_reverse_fill**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_reverse_fill**\ (\ ) If ``true``, reverses fill direction. Horizontal **FlowContainer**\ s will fill rows bottom to top, vertical **FlowContainer**\ s will fill columns right to left. @@ -164,8 +164,8 @@ When using a vertical **FlowContainer** with a right to left :ref:`Control.layou .. rst-class:: classref-property-setget -- void **set_vertical** **(** :ref:`bool` value **)** -- :ref:`bool` **is_vertical** **(** **)** +- |void| **set_vertical**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_vertical**\ (\ ) If ``true``, the **FlowContainer** will arrange its children vertically, rather than horizontally. @@ -184,7 +184,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_line_count** **(** **)** |const| +:ref:`int` **get_line_count**\ (\ ) |const| Returns the current line count. @@ -224,3 +224,4 @@ The vertical separation of children nodes. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_fogmaterial.rst b/classes/class_fogmaterial.rst index 973c1840f91..e06589036fc 100644 --- a/classes/class_fogmaterial.rst +++ b/classes/class_fogmaterial.rst @@ -62,8 +62,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_albedo** **(** :ref:`Color` value **)** -- :ref:`Color` **get_albedo** **(** **)** +- |void| **set_albedo**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_albedo**\ (\ ) The single-scattering :ref:`Color` of the :ref:`FogVolume`. Internally, :ref:`albedo` is converted into single-scattering, which is additively blended with other :ref:`FogVolume`\ s and the :ref:`Environment.volumetric_fog_albedo`. @@ -79,8 +79,8 @@ The single-scattering :ref:`Color` of the :ref:`FogVolume` value **)** -- :ref:`float` **get_density** **(** **)** +- |void| **set_density**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_density**\ (\ ) The density of the :ref:`FogVolume`. Denser objects are more opaque, but may suffer from under-sampling artifacts that look like stripes. Negative values can be used to subtract fog from other :ref:`FogVolume`\ s or global volumetric fog. @@ -98,8 +98,8 @@ The density of the :ref:`FogVolume`. Denser objects are more op .. rst-class:: classref-property-setget -- void **set_density_texture** **(** :ref:`Texture3D` value **)** -- :ref:`Texture3D` **get_density_texture** **(** **)** +- |void| **set_density_texture**\ (\ value\: :ref:`Texture3D`\ ) +- :ref:`Texture3D` **get_density_texture**\ (\ ) The 3D texture that is used to scale the :ref:`density` of the :ref:`FogVolume`. This can be used to vary fog density within the :ref:`FogVolume` with any kind of static pattern. For animated effects, consider using a custom :doc:`fog shader <../tutorials/shaders/shader_reference/fog_shader>`. @@ -115,8 +115,8 @@ The 3D texture that is used to scale the :ref:`density` value **)** -- :ref:`float` **get_edge_fade** **(** **)** +- |void| **set_edge_fade**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_edge_fade**\ (\ ) The hardness of the edges of the :ref:`FogVolume`. A higher value will result in softer edges, while a lower value will result in harder edges. @@ -132,8 +132,8 @@ The hardness of the edges of the :ref:`FogVolume`. A higher val .. rst-class:: classref-property-setget -- void **set_emission** **(** :ref:`Color` value **)** -- :ref:`Color` **get_emission** **(** **)** +- |void| **set_emission**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_emission**\ (\ ) The :ref:`Color` of the light emitted by the :ref:`FogVolume`. Emitted light will not cast light or shadows on other objects, but can be useful for modulating the :ref:`Color` of the :ref:`FogVolume` independently from light sources. @@ -149,8 +149,8 @@ The :ref:`Color` of the light emitted by the :ref:`FogVolume` value **)** -- :ref:`float` **get_height_falloff** **(** **)** +- |void| **set_height_falloff**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_height_falloff**\ (\ ) The rate by which the height-based fog decreases in density as height increases in world space. A high falloff will result in a sharp transition, while a low falloff will result in a smoother transition. A value of ``0.0`` results in uniform-density fog. The height threshold is determined by the height of the associated :ref:`FogVolume`. @@ -161,3 +161,4 @@ The rate by which the height-based fog decreases in density as height increases .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_fogvolume.rst b/classes/class_fogvolume.rst index 4cf4edc9ffe..6ba884b39b2 100644 --- a/classes/class_fogvolume.rst +++ b/classes/class_fogvolume.rst @@ -65,8 +65,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_material** **(** :ref:`Material` value **)** -- :ref:`Material` **get_material** **(** **)** +- |void| **set_material**\ (\ value\: :ref:`Material`\ ) +- :ref:`Material` **get_material**\ (\ ) The :ref:`Material` used by the **FogVolume**. Can be either a built-in :ref:`FogMaterial` or a custom :ref:`ShaderMaterial`. @@ -82,8 +82,8 @@ The :ref:`Material` used by the **FogVolume**. Can be either a b .. rst-class:: classref-property-setget -- void **set_shape** **(** :ref:`FogVolumeShape` value **)** -- :ref:`FogVolumeShape` **get_shape** **(** **)** +- |void| **set_shape**\ (\ value\: :ref:`FogVolumeShape`\ ) +- :ref:`FogVolumeShape` **get_shape**\ (\ ) The shape of the **FogVolume**. This can be set to either :ref:`RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID`, :ref:`RenderingServer.FOG_VOLUME_SHAPE_CONE`, :ref:`RenderingServer.FOG_VOLUME_SHAPE_CYLINDER`, :ref:`RenderingServer.FOG_VOLUME_SHAPE_BOX` or :ref:`RenderingServer.FOG_VOLUME_SHAPE_WORLD`. @@ -99,8 +99,8 @@ The shape of the **FogVolume**. This can be set to either :ref:`RenderingServer. .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_size**\ (\ ) The size of the **FogVolume** when :ref:`shape` is :ref:`RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID`, :ref:`RenderingServer.FOG_VOLUME_SHAPE_CONE`, :ref:`RenderingServer.FOG_VOLUME_SHAPE_CYLINDER` or :ref:`RenderingServer.FOG_VOLUME_SHAPE_BOX`. @@ -115,3 +115,4 @@ The size of the **FogVolume** when :ref:`shape` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_font.rst b/classes/class_font.rst index 438729615d5..7a827228051 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -31,9 +31,9 @@ Properties .. table:: :widths: auto - +---------------------------+-------------------------------------------------+--------+ - | :ref:`Font[]` | :ref:`fallbacks` | ``[]`` | - +---------------------------+-------------------------------------------------+--------+ + +------------------------------------------------------+-------------------------------------------------+--------+ + | :ref:`Array`\[:ref:`Font`\] | :ref:`fallbacks` | ``[]`` | + +------------------------------------------------------+-------------------------------------------------+--------+ .. rst-class:: classref-reftable-group @@ -43,71 +43,71 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`draw_char` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`int` char, :ref:`int` font_size, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`draw_char_outline` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`int` char, :ref:`int` font_size, :ref:`int` size=-1, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_multiline_string` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, :ref:`int` max_lines=-1, :ref:`Color` modulate=Color(1, 1, 1, 1), |bitfield|\<:ref:`LineBreakFlag`\> brk_flags=3, |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_multiline_string_outline` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, :ref:`int` max_lines=-1, :ref:`int` size=1, :ref:`Color` modulate=Color(1, 1, 1, 1), |bitfield|\<:ref:`LineBreakFlag`\> brk_flags=3, |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_string` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, :ref:`Color` modulate=Color(1, 1, 1, 1), |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_string_outline` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, :ref:`int` size=1, :ref:`Color` modulate=Color(1, 1, 1, 1), |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`find_variation` **(** :ref:`Dictionary` variation_coordinates, :ref:`int` face_index=0, :ref:`float` strength=0.0, :ref:`Transform2D` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`int` spacing_top=0, :ref:`int` spacing_bottom=0, :ref:`int` spacing_space=0, :ref:`int` spacing_glyph=0, :ref:`float` baseline_offset=0.0 **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_ascent` **(** :ref:`int` font_size=16 **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` font_size **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_descent` **(** :ref:`int` font_size=16 **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_face_count` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_font_name` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_font_stretch` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`FontStyle`\> | :ref:`get_font_style` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_font_style_name` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_font_weight` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_height` **(** :ref:`int` font_size=16 **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_multiline_string_size` **(** :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, :ref:`int` max_lines=-1, |bitfield|\<:ref:`LineBreakFlag`\> brk_flags=3, |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_opentype_features` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_ot_name_strings` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`get_rids` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_spacing` **(** :ref:`SpacingType` spacing **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_string_size` **(** :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_supported_chars` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_supported_feature_list` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_supported_variation_list` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_underline_position` **(** :ref:`int` font_size=16 **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_underline_thickness` **(** :ref:`int` font_size=16 **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_char` **(** :ref:`int` char **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_language_supported` **(** :ref:`String` language **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_script_supported` **(** :ref:`String` script **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cache_capacity` **(** :ref:`int` single_line, :ref:`int` multi_line **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`draw_char`\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, char\: :ref:`int`, font_size\: :ref:`int`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`draw_char_outline`\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, char\: :ref:`int`, font_size\: :ref:`int`, size\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_multiline_string`\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_multiline_string_outline`\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_string`\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_string_outline`\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`find_variation`\ (\ variation_coordinates\: :ref:`Dictionary`, face_index\: :ref:`int` = 0, strength\: :ref:`float` = 0.0, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), spacing_top\: :ref:`int` = 0, spacing_bottom\: :ref:`int` = 0, spacing_space\: :ref:`int` = 0, spacing_glyph\: :ref:`int` = 0, baseline_offset\: :ref:`float` = 0.0\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_ascent`\ (\ font_size\: :ref:`int` = 16\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_char_size`\ (\ char\: :ref:`int`, font_size\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_descent`\ (\ font_size\: :ref:`int` = 16\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_face_count`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_font_name`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_font_stretch`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`FontStyle`\] | :ref:`get_font_style`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_font_style_name`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_font_weight`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_height`\ (\ font_size\: :ref:`int` = 16\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_multiline_string_size`\ (\ text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_opentype_features`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_ot_name_strings`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`get_rids`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_spacing`\ (\ spacing\: :ref:`SpacingType`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_string_size`\ (\ text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_supported_chars`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_supported_feature_list`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_supported_variation_list`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_underline_position`\ (\ font_size\: :ref:`int` = 16\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_underline_thickness`\ (\ font_size\: :ref:`int` = 16\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_char`\ (\ char\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_language_supported`\ (\ language\: :ref:`String`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_script_supported`\ (\ script\: :ref:`String`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cache_capacity`\ (\ single_line\: :ref:`int`, multi_line\: :ref:`int`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -122,12 +122,12 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Font[]` **fallbacks** = ``[]`` +:ref:`Array`\[:ref:`Font`\] **fallbacks** = ``[]`` .. rst-class:: classref-property-setget -- void **set_fallbacks** **(** :ref:`Font[]` value **)** -- :ref:`Font[]` **get_fallbacks** **(** **)** +- |void| **set_fallbacks**\ (\ value\: :ref:`Array`\[:ref:`Font`\]\ ) +- :ref:`Array`\[:ref:`Font`\] **get_fallbacks**\ (\ ) Array of fallback **Font**\ s to use as a substitute if a glyph is not found in this current **Font**. @@ -146,7 +146,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **draw_char** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`int` char, :ref:`int` font_size, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** |const| +:ref:`float` **draw_char**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, char\: :ref:`int`, font_size\: :ref:`int`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| Draw a single Unicode character ``char`` into a canvas item using the font, at a given position, with ``modulate`` color. ``pos`` specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. @@ -160,7 +160,7 @@ Draw a single Unicode character ``char`` into a canvas item using the font, at a .. rst-class:: classref-method -:ref:`float` **draw_char_outline** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`int` char, :ref:`int` font_size, :ref:`int` size=-1, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** |const| +:ref:`float` **draw_char_outline**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, char\: :ref:`int`, font_size\: :ref:`int`, size\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| Draw a single Unicode character ``char`` outline into a canvas item using the font, at a given position, with ``modulate`` color and ``size`` outline size. ``pos`` specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. @@ -174,7 +174,7 @@ Draw a single Unicode character ``char`` outline into a canvas item using the fo .. rst-class:: classref-method -void **draw_multiline_string** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, :ref:`int` max_lines=-1, :ref:`Color` modulate=Color(1, 1, 1, 1), |bitfield|\<:ref:`LineBreakFlag`\> brk_flags=3, |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| +|void| **draw_multiline_string**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| Breaks ``text`` into lines using rules specified by ``brk_flags`` and draws it into a canvas item using the font, at a given position, with ``modulate`` color, optionally clipping the width and aligning horizontally. ``pos`` specifies the baseline of the first line, not the top. To draw from the top, *ascent* must be added to the Y axis. @@ -188,7 +188,7 @@ See also :ref:`CanvasItem.draw_multiline_string` canvas_item, :ref:`Vector2` pos, :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, :ref:`int` max_lines=-1, :ref:`int` size=1, :ref:`Color` modulate=Color(1, 1, 1, 1), |bitfield|\<:ref:`LineBreakFlag`\> brk_flags=3, |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| +|void| **draw_multiline_string_outline**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| Breaks ``text`` to the lines using rules specified by ``brk_flags`` and draws text outline into a canvas item using the font, at a given position, with ``modulate`` color and ``size`` outline size, optionally clipping the width and aligning horizontally. ``pos`` specifies the baseline of the first line, not the top. To draw from the top, *ascent* must be added to the Y axis. @@ -202,7 +202,7 @@ See also :ref:`CanvasItem.draw_multiline_string_outline` canvas_item, :ref:`Vector2` pos, :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, :ref:`Color` modulate=Color(1, 1, 1, 1), |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| +|void| **draw_string**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| Draw ``text`` into a canvas item using the font, at a given position, with ``modulate`` color, optionally clipping the width and aligning horizontally. ``pos`` specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. @@ -216,7 +216,7 @@ See also :ref:`CanvasItem.draw_string`. .. rst-class:: classref-method -void **draw_string_outline** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, :ref:`int` size=1, :ref:`Color` modulate=Color(1, 1, 1, 1), |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| +|void| **draw_string_outline**\ (\ canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| Draw ``text`` outline into a canvas item using the font, at a given position, with ``modulate`` color and ``size`` outline size, optionally clipping the width and aligning horizontally. ``pos`` specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. @@ -230,7 +230,7 @@ See also :ref:`CanvasItem.draw_string_outline` **find_variation** **(** :ref:`Dictionary` variation_coordinates, :ref:`int` face_index=0, :ref:`float` strength=0.0, :ref:`Transform2D` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`int` spacing_top=0, :ref:`int` spacing_bottom=0, :ref:`int` spacing_space=0, :ref:`int` spacing_glyph=0, :ref:`float` baseline_offset=0.0 **)** |const| +:ref:`RID` **find_variation**\ (\ variation_coordinates\: :ref:`Dictionary`, face_index\: :ref:`int` = 0, strength\: :ref:`float` = 0.0, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), spacing_top\: :ref:`int` = 0, spacing_bottom\: :ref:`int` = 0, spacing_space\: :ref:`int` = 0, spacing_glyph\: :ref:`int` = 0, baseline_offset\: :ref:`float` = 0.0\ ) |const| Returns :ref:`TextServer` RID of the font cache for specific variation. @@ -242,7 +242,7 @@ Returns :ref:`TextServer` RID of the font cache for specific v .. rst-class:: classref-method -:ref:`float` **get_ascent** **(** :ref:`int` font_size=16 **)** |const| +:ref:`float` **get_ascent**\ (\ font_size\: :ref:`int` = 16\ ) |const| Returns the average font ascent (number of pixels above the baseline). @@ -256,9 +256,9 @@ Returns the average font ascent (number of pixels above the baseline). .. rst-class:: classref-method -:ref:`Vector2` **get_char_size** **(** :ref:`int` char, :ref:`int` font_size **)** |const| +:ref:`Vector2` **get_char_size**\ (\ char\: :ref:`int`, font_size\: :ref:`int`\ ) |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` or :ref:`TextLine` instead. The height returned is the font height (see also :ref:`get_height`) and has no relation to the glyph height. @@ -270,7 +270,7 @@ Returns the size of a character, optionally taking kerning into account if the n .. rst-class:: classref-method -:ref:`float` **get_descent** **(** :ref:`int` font_size=16 **)** |const| +:ref:`float` **get_descent**\ (\ font_size\: :ref:`int` = 16\ ) |const| Returns the average font descent (number of pixels below the baseline). @@ -284,7 +284,7 @@ Returns the average font descent (number of pixels below the baseline). .. rst-class:: classref-method -:ref:`int` **get_face_count** **(** **)** |const| +:ref:`int` **get_face_count**\ (\ ) |const| Returns number of faces in the TrueType / OpenType collection. @@ -296,7 +296,7 @@ Returns number of faces in the TrueType / OpenType collection. .. rst-class:: classref-method -:ref:`String` **get_font_name** **(** **)** |const| +:ref:`String` **get_font_name**\ (\ ) |const| Returns font family name. @@ -308,7 +308,7 @@ Returns font family name. .. rst-class:: classref-method -:ref:`int` **get_font_stretch** **(** **)** |const| +:ref:`int` **get_font_stretch**\ (\ ) |const| Returns font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``. @@ -320,7 +320,7 @@ Returns font stretch amount, compared to a normal width. A percentage value betw .. rst-class:: classref-method -|bitfield|\<:ref:`FontStyle`\> **get_font_style** **(** **)** |const| +|bitfield|\[:ref:`FontStyle`\] **get_font_style**\ (\ ) |const| Returns font style flags, see :ref:`FontStyle`. @@ -332,7 +332,7 @@ Returns font style flags, see :ref:`FontStyle`. .. rst-class:: classref-method -:ref:`String` **get_font_style_name** **(** **)** |const| +:ref:`String` **get_font_style_name**\ (\ ) |const| Returns font style name. @@ -344,7 +344,7 @@ Returns font style name. .. rst-class:: classref-method -:ref:`int` **get_font_weight** **(** **)** |const| +:ref:`int` **get_font_weight**\ (\ ) |const| Returns weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``. @@ -356,7 +356,7 @@ Returns weight (boldness) of the font. A value in the ``100...999`` range, norma .. rst-class:: classref-method -:ref:`float` **get_height** **(** :ref:`int` font_size=16 **)** |const| +:ref:`float` **get_height**\ (\ font_size\: :ref:`int` = 16\ ) |const| Returns the total average font height (ascent plus descent) in pixels. @@ -370,7 +370,7 @@ Returns the total average font height (ascent plus descent) in pixels. .. rst-class:: classref-method -:ref:`Vector2` **get_multiline_string_size** **(** :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, :ref:`int` max_lines=-1, |bitfield|\<:ref:`LineBreakFlag`\> brk_flags=3, |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| +:ref:`Vector2` **get_multiline_string_size**\ (\ text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| Returns the size of a bounding box of a string broken into the lines, taking kerning and advance into account. @@ -384,7 +384,7 @@ See also :ref:`draw_multiline_string`. .. rst-class:: classref-method -:ref:`Dictionary` **get_opentype_features** **(** **)** |const| +:ref:`Dictionary` **get_opentype_features**\ (\ ) |const| Returns a set of OpenType feature tags. More info: `OpenType feature tags `__. @@ -396,7 +396,7 @@ Returns a set of OpenType feature tags. More info: `OpenType feature tags ` **get_ot_name_strings** **(** **)** |const| +:ref:`Dictionary` **get_ot_name_strings**\ (\ ) |const| Returns :ref:`Dictionary` with OpenType font name strings (localized font names, version, description, license information, sample text, etc.). @@ -408,7 +408,7 @@ Returns :ref:`Dictionary` with OpenType font name strings (loc .. rst-class:: classref-method -:ref:`RID[]` **get_rids** **(** **)** |const| +:ref:`Array`\[:ref:`RID`\] **get_rids**\ (\ ) |const| Returns :ref:`Array` of valid **Font** :ref:`RID`\ s, which can be passed to the :ref:`TextServer` methods. @@ -420,7 +420,7 @@ Returns :ref:`Array` of valid **Font** :ref:`RID`\ s, wh .. rst-class:: classref-method -:ref:`int` **get_spacing** **(** :ref:`SpacingType` spacing **)** |const| +:ref:`int` **get_spacing**\ (\ spacing\: :ref:`SpacingType`\ ) |const| Returns the spacing for the given ``type`` (see :ref:`SpacingType`). @@ -432,7 +432,7 @@ Returns the spacing for the given ``type`` (see :ref:`SpacingType` **get_string_size** **(** :ref:`String` text, :ref:`HorizontalAlignment` alignment=0, :ref:`float` width=-1, :ref:`int` font_size=16, |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3, :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** |const| +:ref:`Vector2` **get_string_size**\ (\ text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) |const| Returns the size of a bounding box of a single-line string, taking kerning, advance and subpixel positioning into account. See also :ref:`get_multiline_string_size` and :ref:`draw_string`. @@ -464,7 +464,7 @@ For example, to get the string size as displayed by a single-line Label, use: .. rst-class:: classref-method -:ref:`String` **get_supported_chars** **(** **)** |const| +:ref:`String` **get_supported_chars**\ (\ ) |const| Returns a string containing all the characters available in the font. @@ -478,7 +478,7 @@ If a given character is included in more than one font data source, it appears o .. rst-class:: classref-method -:ref:`Dictionary` **get_supported_feature_list** **(** **)** |const| +:ref:`Dictionary` **get_supported_feature_list**\ (\ ) |const| Returns list of OpenType features supported by font. @@ -490,7 +490,7 @@ Returns list of OpenType features supported by font. .. rst-class:: classref-method -:ref:`Dictionary` **get_supported_variation_list** **(** **)** |const| +:ref:`Dictionary` **get_supported_variation_list**\ (\ ) |const| Returns list of supported `variation coordinates `__, each coordinate is returned as ``tag: Vector3i(min_value,max_value,default_value)``. @@ -518,7 +518,7 @@ To print available variation axes of a variable font: .. rst-class:: classref-method -:ref:`float` **get_underline_position** **(** :ref:`int` font_size=16 **)** |const| +:ref:`float` **get_underline_position**\ (\ font_size\: :ref:`int` = 16\ ) |const| Returns average pixel offset of the underline below the baseline. @@ -532,7 +532,7 @@ Returns average pixel offset of the underline below the baseline. .. rst-class:: classref-method -:ref:`float` **get_underline_thickness** **(** :ref:`int` font_size=16 **)** |const| +:ref:`float` **get_underline_thickness**\ (\ font_size\: :ref:`int` = 16\ ) |const| Returns average thickness of the underline. @@ -546,7 +546,7 @@ Returns average thickness of the underline. .. rst-class:: classref-method -:ref:`bool` **has_char** **(** :ref:`int` char **)** |const| +:ref:`bool` **has_char**\ (\ char\: :ref:`int`\ ) |const| Returns ``true`` if a Unicode ``char`` is available in the font. @@ -558,7 +558,7 @@ Returns ``true`` if a Unicode ``char`` is available in the font. .. rst-class:: classref-method -:ref:`bool` **is_language_supported** **(** :ref:`String` language **)** |const| +:ref:`bool` **is_language_supported**\ (\ language\: :ref:`String`\ ) |const| Returns ``true``, if font supports given language (`ISO 639 `__ code). @@ -570,7 +570,7 @@ Returns ``true``, if font supports given language (`ISO 639 ` **is_script_supported** **(** :ref:`String` script **)** |const| +:ref:`bool` **is_script_supported**\ (\ script\: :ref:`String`\ ) |const| Returns ``true``, if font supports given script (`ISO 15924 `__ code). @@ -582,7 +582,7 @@ Returns ``true``, if font supports given script (`ISO 15924 ` single_line, :ref:`int` multi_line **)** +|void| **set_cache_capacity**\ (\ single_line\: :ref:`int`, multi_line\: :ref:`int`\ ) Sets LRU cache capacity for ``draw_*`` methods. @@ -593,3 +593,4 @@ Sets LRU cache capacity for ``draw_*`` methods. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_fontfile.rst b/classes/class_fontfile.rst index be350d31a50..2865ec0ed1a 100644 --- a/classes/class_fontfile.rst +++ b/classes/class_fontfile.rst @@ -86,7 +86,7 @@ Properties +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`font_stretch` | ``100`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ - | |bitfield|\<:ref:`FontStyle`\> | :ref:`font_style` | ``0`` | + | |bitfield|\[:ref:`FontStyle`\] | :ref:`font_style` | ``0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`font_weight` | ``400`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ @@ -119,141 +119,141 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_cache` **(** **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_glyphs` **(** :ref:`int` cache_index, :ref:`Vector2i` size **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_kerning_map` **(** :ref:`int` cache_index, :ref:`int` size **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_size_cache` **(** :ref:`int` cache_index **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_textures` **(** :ref:`int` cache_index, :ref:`Vector2i` size **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_cache_ascent` **(** :ref:`int` cache_index, :ref:`int` size **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_cache_count` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_cache_descent` **(** :ref:`int` cache_index, :ref:`int` size **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_cache_scale` **(** :ref:`int` cache_index, :ref:`int` size **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_cache_underline_position` **(** :ref:`int` cache_index, :ref:`int` size **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_cache_underline_thickness` **(** :ref:`int` cache_index, :ref:`int` size **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_char_from_glyph_index` **(** :ref:`int` size, :ref:`int` glyph_index **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_embolden` **(** :ref:`int` cache_index **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_extra_baseline_offset` **(** :ref:`int` cache_index **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_extra_spacing` **(** :ref:`int` cache_index, :ref:`SpacingType` spacing **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_face_index` **(** :ref:`int` cache_index **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_glyph_advance` **(** :ref:`int` cache_index, :ref:`int` size, :ref:`int` glyph **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_glyph_index` **(** :ref:`int` size, :ref:`int` char, :ref:`int` variation_selector **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_glyph_list` **(** :ref:`int` cache_index, :ref:`Vector2i` size **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_glyph_offset` **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_glyph_size` **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_glyph_texture_idx` **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_glyph_uv_rect` **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_kerning` **(** :ref:`int` cache_index, :ref:`int` size, :ref:`Vector2i` glyph_pair **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i[]` | :ref:`get_kerning_list` **(** :ref:`int` cache_index, :ref:`int` size **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_language_support_override` **(** :ref:`String` language **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_language_support_overrides` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_script_support_override` **(** :ref:`String` script **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_script_support_overrides` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i[]` | :ref:`get_size_cache_list` **(** :ref:`int` cache_index **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_texture_count` **(** :ref:`int` cache_index, :ref:`Vector2i` size **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`get_texture_image` **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` texture_index **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_texture_offsets` **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` texture_index **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_transform` **(** :ref:`int` cache_index **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_variation_coordinates` **(** :ref:`int` cache_index **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load_bitmap_font` **(** :ref:`String` path **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load_dynamic_font` **(** :ref:`String` path **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_cache` **(** :ref:`int` cache_index **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_glyph` **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` glyph **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_kerning` **(** :ref:`int` cache_index, :ref:`int` size, :ref:`Vector2i` glyph_pair **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_language_support_override` **(** :ref:`String` language **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_script_support_override` **(** :ref:`String` script **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_size_cache` **(** :ref:`int` cache_index, :ref:`Vector2i` size **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_texture` **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` texture_index **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`render_glyph` **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` index **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`render_range` **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` start, :ref:`int` end **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cache_ascent` **(** :ref:`int` cache_index, :ref:`int` size, :ref:`float` ascent **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cache_descent` **(** :ref:`int` cache_index, :ref:`int` size, :ref:`float` descent **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cache_scale` **(** :ref:`int` cache_index, :ref:`int` size, :ref:`float` scale **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cache_underline_position` **(** :ref:`int` cache_index, :ref:`int` size, :ref:`float` underline_position **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cache_underline_thickness` **(** :ref:`int` cache_index, :ref:`int` size, :ref:`float` underline_thickness **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_embolden` **(** :ref:`int` cache_index, :ref:`float` strength **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_extra_baseline_offset` **(** :ref:`int` cache_index, :ref:`float` baseline_offset **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_extra_spacing` **(** :ref:`int` cache_index, :ref:`SpacingType` spacing, :ref:`int` value **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_face_index` **(** :ref:`int` cache_index, :ref:`int` face_index **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_glyph_advance` **(** :ref:`int` cache_index, :ref:`int` size, :ref:`int` glyph, :ref:`Vector2` advance **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_glyph_offset` **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Vector2` offset **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_glyph_size` **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Vector2` gl_size **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_glyph_texture_idx` **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`int` texture_idx **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_glyph_uv_rect` **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Rect2` uv_rect **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_kerning` **(** :ref:`int` cache_index, :ref:`int` size, :ref:`Vector2i` glyph_pair, :ref:`Vector2` kerning **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_language_support_override` **(** :ref:`String` language, :ref:`bool` supported **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_script_support_override` **(** :ref:`String` script, :ref:`bool` supported **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_texture_image` **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`Image` image **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_texture_offsets` **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`PackedInt32Array` offset **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_transform` **(** :ref:`int` cache_index, :ref:`Transform2D` transform **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_variation_coordinates` **(** :ref:`int` cache_index, :ref:`Dictionary` variation_coordinates **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_cache`\ (\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_glyphs`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_kerning_map`\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_size_cache`\ (\ cache_index\: :ref:`int`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_textures`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_cache_ascent`\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_cache_count`\ (\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_cache_descent`\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_cache_scale`\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_cache_underline_position`\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_cache_underline_thickness`\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_char_from_glyph_index`\ (\ size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_embolden`\ (\ cache_index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_extra_baseline_offset`\ (\ cache_index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_extra_spacing`\ (\ cache_index\: :ref:`int`, spacing\: :ref:`SpacingType`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_face_index`\ (\ cache_index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_glyph_advance`\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_glyph_index`\ (\ size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_glyph_list`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_glyph_offset`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_glyph_size`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_glyph_texture_idx`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_glyph_uv_rect`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_kerning`\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`get_kerning_list`\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_language_support_override`\ (\ language\: :ref:`String`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_language_support_overrides`\ (\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_script_support_override`\ (\ script\: :ref:`String`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_script_support_overrides`\ (\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`get_size_cache_list`\ (\ cache_index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_texture_count`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`get_texture_image`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_texture_offsets`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_transform`\ (\ cache_index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_variation_coordinates`\ (\ cache_index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_bitmap_font`\ (\ path\: :ref:`String`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_dynamic_font`\ (\ path\: :ref:`String`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_cache`\ (\ cache_index\: :ref:`int`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_glyph`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_kerning`\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_language_support_override`\ (\ language\: :ref:`String`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_script_support_override`\ (\ script\: :ref:`String`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_size_cache`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_texture`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`render_glyph`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, index\: :ref:`int`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`render_range`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, start\: :ref:`int`, end\: :ref:`int`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cache_ascent`\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, ascent\: :ref:`float`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cache_descent`\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, descent\: :ref:`float`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cache_scale`\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, scale\: :ref:`float`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cache_underline_position`\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cache_underline_thickness`\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_embolden`\ (\ cache_index\: :ref:`int`, strength\: :ref:`float`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_extra_baseline_offset`\ (\ cache_index\: :ref:`int`, baseline_offset\: :ref:`float`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_extra_spacing`\ (\ cache_index\: :ref:`int`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_face_index`\ (\ cache_index\: :ref:`int`, face_index\: :ref:`int`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_glyph_advance`\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_glyph_offset`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_glyph_size`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_glyph_texture_idx`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_glyph_uv_rect`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_kerning`\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`, kerning\: :ref:`Vector2`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_language_support_override`\ (\ language\: :ref:`String`, supported\: :ref:`bool`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_script_support_override`\ (\ script\: :ref:`String`, supported\: :ref:`bool`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_texture_image`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_texture_offsets`\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, offset\: :ref:`PackedInt32Array`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_transform`\ (\ cache_index\: :ref:`int`, transform\: :ref:`Transform2D`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_variation_coordinates`\ (\ cache_index\: :ref:`int`, variation_coordinates\: :ref:`Dictionary`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -272,8 +272,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_allow_system_fallback** **(** :ref:`bool` value **)** -- :ref:`bool` **is_allow_system_fallback** **(** **)** +- |void| **set_allow_system_fallback**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_allow_system_fallback**\ (\ ) If set to ``true``, system fonts can be automatically used as fallbacks. @@ -289,8 +289,8 @@ If set to ``true``, system fonts can be automatically used as fallbacks. .. rst-class:: classref-property-setget -- void **set_antialiasing** **(** :ref:`FontAntialiasing` value **)** -- :ref:`FontAntialiasing` **get_antialiasing** **(** **)** +- |void| **set_antialiasing**\ (\ value\: :ref:`FontAntialiasing`\ ) +- :ref:`FontAntialiasing` **get_antialiasing**\ (\ ) Font anti-aliasing mode. @@ -306,8 +306,8 @@ Font anti-aliasing mode. .. rst-class:: classref-property-setget -- void **set_data** **(** :ref:`PackedByteArray` value **)** -- :ref:`PackedByteArray` **get_data** **(** **)** +- |void| **set_data**\ (\ value\: :ref:`PackedByteArray`\ ) +- :ref:`PackedByteArray` **get_data**\ (\ ) Contents of the dynamic font source file. @@ -323,8 +323,8 @@ Contents of the dynamic font source file. .. rst-class:: classref-property-setget -- void **set_fixed_size** **(** :ref:`int` value **)** -- :ref:`int` **get_fixed_size** **(** **)** +- |void| **set_fixed_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_fixed_size**\ (\ ) Font size, used only for the bitmap fonts. @@ -340,8 +340,8 @@ Font size, used only for the bitmap fonts. .. rst-class:: classref-property-setget -- void **set_fixed_size_scale_mode** **(** :ref:`FixedSizeScaleMode` value **)** -- :ref:`FixedSizeScaleMode` **get_fixed_size_scale_mode** **(** **)** +- |void| **set_fixed_size_scale_mode**\ (\ value\: :ref:`FixedSizeScaleMode`\ ) +- :ref:`FixedSizeScaleMode` **get_fixed_size_scale_mode**\ (\ ) Scaling mode, used only for the bitmap fonts with :ref:`fixed_size` greater than zero. @@ -357,8 +357,8 @@ Scaling mode, used only for the bitmap fonts with :ref:`fixed_size` value **)** -- :ref:`String` **get_font_name** **(** **)** +- |void| **set_font_name**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_font_name**\ (\ ) Font family name. @@ -374,8 +374,8 @@ Font family name. .. rst-class:: classref-property-setget -- void **set_font_stretch** **(** :ref:`int` value **)** -- :ref:`int` **get_font_stretch** **(** **)** +- |void| **set_font_stretch**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_font_stretch**\ (\ ) Font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``. @@ -387,12 +387,12 @@ Font stretch amount, compared to a normal width. A percentage value between ``50 .. rst-class:: classref-property -|bitfield|\<:ref:`FontStyle`\> **font_style** = ``0`` +|bitfield|\[:ref:`FontStyle`\] **font_style** = ``0`` .. rst-class:: classref-property-setget -- void **set_font_style** **(** |bitfield|\<:ref:`FontStyle`\> value **)** -- |bitfield|\<:ref:`FontStyle`\> **get_font_style** **(** **)** +- |void| **set_font_style**\ (\ value\: |bitfield|\[:ref:`FontStyle`\]\ ) +- |bitfield|\[:ref:`FontStyle`\] **get_font_style**\ (\ ) Font style flags, see :ref:`FontStyle`. @@ -408,8 +408,8 @@ Font style flags, see :ref:`FontStyle`. .. rst-class:: classref-property-setget -- void **set_font_weight** **(** :ref:`int` value **)** -- :ref:`int` **get_font_weight** **(** **)** +- |void| **set_font_weight**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_font_weight**\ (\ ) Weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``. @@ -425,8 +425,8 @@ Weight (boldness) of the font. A value in the ``100...999`` range, normal font w .. rst-class:: classref-property-setget -- void **set_force_autohinter** **(** :ref:`bool` value **)** -- :ref:`bool` **is_force_autohinter** **(** **)** +- |void| **set_force_autohinter**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_force_autohinter**\ (\ ) If set to ``true``, auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only (MSDF fonts don't support hinting). @@ -442,8 +442,8 @@ If set to ``true``, auto-hinting is supported and preferred over font built-in h .. rst-class:: classref-property-setget -- void **set_generate_mipmaps** **(** :ref:`bool` value **)** -- :ref:`bool` **get_generate_mipmaps** **(** **)** +- |void| **set_generate_mipmaps**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_generate_mipmaps**\ (\ ) If set to ``true``, generate mipmaps for the font textures. @@ -459,8 +459,8 @@ If set to ``true``, generate mipmaps for the font textures. .. rst-class:: classref-property-setget -- void **set_hinting** **(** :ref:`Hinting` value **)** -- :ref:`Hinting` **get_hinting** **(** **)** +- |void| **set_hinting**\ (\ value\: :ref:`Hinting`\ ) +- :ref:`Hinting` **get_hinting**\ (\ ) Font hinting mode. Used by dynamic fonts only. @@ -476,8 +476,8 @@ Font hinting mode. Used by dynamic fonts only. .. rst-class:: classref-property-setget -- void **set_msdf_pixel_range** **(** :ref:`int` value **)** -- :ref:`int` **get_msdf_pixel_range** **(** **)** +- |void| **set_msdf_pixel_range**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_msdf_pixel_range**\ (\ ) The width of the range around the shape between the minimum and maximum representable signed distance. If using font outlines, :ref:`msdf_pixel_range` must be set to at least *twice* the size of the largest font outline. The default :ref:`msdf_pixel_range` value of ``16`` allows outline sizes up to ``8`` to look correct. @@ -493,8 +493,8 @@ The width of the range around the shape between the minimum and maximum represen .. rst-class:: classref-property-setget -- void **set_msdf_size** **(** :ref:`int` value **)** -- :ref:`int` **get_msdf_size** **(** **)** +- |void| **set_msdf_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_msdf_size**\ (\ ) Source font size used to generate MSDF textures. Higher values allow for more precision, but are slower to render and require more memory. Only increase this value if you notice a visible lack of precision in glyph rendering. @@ -510,8 +510,8 @@ Source font size used to generate MSDF textures. Higher values allow for more pr .. rst-class:: classref-property-setget -- void **set_multichannel_signed_distance_field** **(** :ref:`bool` value **)** -- :ref:`bool` **is_multichannel_signed_distance_field** **(** **)** +- |void| **set_multichannel_signed_distance_field**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_multichannel_signed_distance_field**\ (\ ) If set to ``true``, glyphs of all sizes are rendered using single multichannel signed distance field (MSDF) generated from the dynamic font vector data. Since this approach does not rely on rasterizing the font every time its size changes, this allows for resizing the font in real-time without any performance penalty. Text will also not look grainy for :ref:`Control`\ s that are scaled down (or for :ref:`Label3D`\ s viewed from a long distance). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes. @@ -531,8 +531,8 @@ If set to ``true``, glyphs of all sizes are rendered using single multichannel s .. rst-class:: classref-property-setget -- void **set_opentype_feature_overrides** **(** :ref:`Dictionary` value **)** -- :ref:`Dictionary` **get_opentype_feature_overrides** **(** **)** +- |void| **set_opentype_feature_overrides**\ (\ value\: :ref:`Dictionary`\ ) +- :ref:`Dictionary` **get_opentype_feature_overrides**\ (\ ) Font OpenType feature set override. @@ -548,8 +548,8 @@ Font OpenType feature set override. .. rst-class:: classref-property-setget -- void **set_oversampling** **(** :ref:`float` value **)** -- :ref:`float` **get_oversampling** **(** **)** +- |void| **set_oversampling**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_oversampling**\ (\ ) Font oversampling factor. If set to ``0.0``, the global oversampling factor is used instead. Used by dynamic fonts only (MSDF fonts ignore oversampling). @@ -565,8 +565,8 @@ Font oversampling factor. If set to ``0.0``, the global oversampling factor is u .. rst-class:: classref-property-setget -- void **set_font_style_name** **(** :ref:`String` value **)** -- :ref:`String` **get_font_style_name** **(** **)** +- |void| **set_font_style_name**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_font_style_name**\ (\ ) Font style name. @@ -582,8 +582,8 @@ Font style name. .. rst-class:: classref-property-setget -- void **set_subpixel_positioning** **(** :ref:`SubpixelPositioning` value **)** -- :ref:`SubpixelPositioning` **get_subpixel_positioning** **(** **)** +- |void| **set_subpixel_positioning**\ (\ value\: :ref:`SubpixelPositioning`\ ) +- :ref:`SubpixelPositioning` **get_subpixel_positioning**\ (\ ) Font glyph subpixel positioning mode. Subpixel positioning provides shaper text and better kerning for smaller font sizes, at the cost of higher memory usage and lower font rasterization speed. Use :ref:`TextServer.SUBPIXEL_POSITIONING_AUTO` to automatically enable it based on the font size. @@ -600,7 +600,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear_cache** **(** **)** +|void| **clear_cache**\ (\ ) Removes all font cache entries. @@ -612,7 +612,7 @@ Removes all font cache entries. .. rst-class:: classref-method -void **clear_glyphs** **(** :ref:`int` cache_index, :ref:`Vector2i` size **)** +|void| **clear_glyphs**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) Removes all rendered glyphs information from the cache entry. @@ -626,7 +626,7 @@ Removes all rendered glyphs information from the cache entry. .. rst-class:: classref-method -void **clear_kerning_map** **(** :ref:`int` cache_index, :ref:`int` size **)** +|void| **clear_kerning_map**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) Removes all kerning overrides. @@ -638,7 +638,7 @@ Removes all kerning overrides. .. rst-class:: classref-method -void **clear_size_cache** **(** :ref:`int` cache_index **)** +|void| **clear_size_cache**\ (\ cache_index\: :ref:`int`\ ) Removes all font sizes from the cache entry @@ -650,7 +650,7 @@ Removes all font sizes from the cache entry .. rst-class:: classref-method -void **clear_textures** **(** :ref:`int` cache_index, :ref:`Vector2i` size **)** +|void| **clear_textures**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) Removes all textures from font cache entry. @@ -664,7 +664,7 @@ Removes all textures from font cache entry. .. rst-class:: classref-method -:ref:`float` **get_cache_ascent** **(** :ref:`int` cache_index, :ref:`int` size **)** |const| +:ref:`float` **get_cache_ascent**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| Returns the font ascent (number of pixels above the baseline). @@ -676,7 +676,7 @@ Returns the font ascent (number of pixels above the baseline). .. rst-class:: classref-method -:ref:`int` **get_cache_count** **(** **)** |const| +:ref:`int` **get_cache_count**\ (\ ) |const| Returns number of the font cache entries. @@ -688,7 +688,7 @@ Returns number of the font cache entries. .. rst-class:: classref-method -:ref:`float` **get_cache_descent** **(** :ref:`int` cache_index, :ref:`int` size **)** |const| +:ref:`float` **get_cache_descent**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| Returns the font descent (number of pixels below the baseline). @@ -700,7 +700,7 @@ Returns the font descent (number of pixels below the baseline). .. rst-class:: classref-method -:ref:`float` **get_cache_scale** **(** :ref:`int` cache_index, :ref:`int` size **)** |const| +:ref:`float` **get_cache_scale**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| Returns scaling factor of the color bitmap font. @@ -712,7 +712,7 @@ Returns scaling factor of the color bitmap font. .. rst-class:: classref-method -:ref:`float` **get_cache_underline_position** **(** :ref:`int` cache_index, :ref:`int` size **)** |const| +:ref:`float` **get_cache_underline_position**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| Returns pixel offset of the underline below the baseline. @@ -724,7 +724,7 @@ Returns pixel offset of the underline below the baseline. .. rst-class:: classref-method -:ref:`float` **get_cache_underline_thickness** **(** :ref:`int` cache_index, :ref:`int` size **)** |const| +:ref:`float` **get_cache_underline_thickness**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| Returns thickness of the underline in pixels. @@ -736,7 +736,7 @@ Returns thickness of the underline in pixels. .. rst-class:: classref-method -:ref:`int` **get_char_from_glyph_index** **(** :ref:`int` size, :ref:`int` glyph_index **)** |const| +:ref:`int` **get_char_from_glyph_index**\ (\ size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |const| Returns character code associated with ``glyph_index``, or ``0`` if ``glyph_index`` is invalid. See :ref:`get_glyph_index`. @@ -748,7 +748,7 @@ Returns character code associated with ``glyph_index``, or ``0`` if ``glyph_inde .. rst-class:: classref-method -:ref:`float` **get_embolden** **(** :ref:`int` cache_index **)** |const| +:ref:`float` **get_embolden**\ (\ cache_index\: :ref:`int`\ ) |const| Returns embolden strength, if is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. @@ -760,7 +760,7 @@ Returns embolden strength, if is not equal to zero, emboldens the font outlines. .. rst-class:: classref-method -:ref:`float` **get_extra_baseline_offset** **(** :ref:`int` cache_index **)** |const| +:ref:`float` **get_extra_baseline_offset**\ (\ cache_index\: :ref:`int`\ ) |const| Returns extra baseline offset (as a fraction of font height). @@ -772,7 +772,7 @@ Returns extra baseline offset (as a fraction of font height). .. rst-class:: classref-method -:ref:`int` **get_extra_spacing** **(** :ref:`int` cache_index, :ref:`SpacingType` spacing **)** |const| +:ref:`int` **get_extra_spacing**\ (\ cache_index\: :ref:`int`, spacing\: :ref:`SpacingType`\ ) |const| Returns spacing for ``spacing`` (see :ref:`SpacingType`) in pixels (not relative to the font size). @@ -784,7 +784,7 @@ Returns spacing for ``spacing`` (see :ref:`SpacingType` **get_face_index** **(** :ref:`int` cache_index **)** |const| +:ref:`int` **get_face_index**\ (\ cache_index\: :ref:`int`\ ) |const| Returns an active face index in the TrueType / OpenType collection. @@ -796,7 +796,7 @@ Returns an active face index in the TrueType / OpenType collection. .. rst-class:: classref-method -:ref:`Vector2` **get_glyph_advance** **(** :ref:`int` cache_index, :ref:`int` size, :ref:`int` glyph **)** |const| +:ref:`Vector2` **get_glyph_advance**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |const| Returns glyph advance (offset of the next glyph). @@ -810,7 +810,7 @@ Returns glyph advance (offset of the next glyph). .. rst-class:: classref-method -:ref:`int` **get_glyph_index** **(** :ref:`int` size, :ref:`int` char, :ref:`int` variation_selector **)** |const| +:ref:`int` **get_glyph_index**\ (\ size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |const| Returns the glyph index of a ``char``, optionally modified by the ``variation_selector``. @@ -822,7 +822,7 @@ Returns the glyph index of a ``char``, optionally modified by the ``variation_se .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_glyph_list** **(** :ref:`int` cache_index, :ref:`Vector2i` size **)** |const| +:ref:`PackedInt32Array` **get_glyph_list**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) |const| Returns list of rendered glyphs in the cache entry. @@ -834,7 +834,7 @@ Returns list of rendered glyphs in the cache entry. .. rst-class:: classref-method -:ref:`Vector2` **get_glyph_offset** **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| +:ref:`Vector2` **get_glyph_offset**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| Returns glyph offset from the baseline. @@ -846,7 +846,7 @@ Returns glyph offset from the baseline. .. rst-class:: classref-method -:ref:`Vector2` **get_glyph_size** **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| +:ref:`Vector2` **get_glyph_size**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| Returns glyph size. @@ -858,7 +858,7 @@ Returns glyph size. .. rst-class:: classref-method -:ref:`int` **get_glyph_texture_idx** **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| +:ref:`int` **get_glyph_texture_idx**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| Returns index of the cache texture containing the glyph. @@ -870,7 +870,7 @@ Returns index of the cache texture containing the glyph. .. rst-class:: classref-method -:ref:`Rect2` **get_glyph_uv_rect** **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| +:ref:`Rect2` **get_glyph_uv_rect**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| Returns rectangle in the cache texture containing the glyph. @@ -882,7 +882,7 @@ Returns rectangle in the cache texture containing the glyph. .. rst-class:: classref-method -:ref:`Vector2` **get_kerning** **(** :ref:`int` cache_index, :ref:`int` size, :ref:`Vector2i` glyph_pair **)** |const| +:ref:`Vector2` **get_kerning**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |const| Returns kerning for the pair of glyphs. @@ -894,7 +894,7 @@ Returns kerning for the pair of glyphs. .. rst-class:: classref-method -:ref:`Vector2i[]` **get_kerning_list** **(** :ref:`int` cache_index, :ref:`int` size **)** |const| +:ref:`Array`\[:ref:`Vector2i`\] **get_kerning_list**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`\ ) |const| Returns list of the kerning overrides. @@ -906,7 +906,7 @@ Returns list of the kerning overrides. .. rst-class:: classref-method -:ref:`bool` **get_language_support_override** **(** :ref:`String` language **)** |const| +:ref:`bool` **get_language_support_override**\ (\ language\: :ref:`String`\ ) |const| Returns ``true`` if support override is enabled for the ``language``. @@ -918,7 +918,7 @@ Returns ``true`` if support override is enabled for the ``language``. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_language_support_overrides** **(** **)** |const| +:ref:`PackedStringArray` **get_language_support_overrides**\ (\ ) |const| Returns list of language support overrides. @@ -930,7 +930,7 @@ Returns list of language support overrides. .. rst-class:: classref-method -:ref:`bool` **get_script_support_override** **(** :ref:`String` script **)** |const| +:ref:`bool` **get_script_support_override**\ (\ script\: :ref:`String`\ ) |const| Returns ``true`` if support override is enabled for the ``script``. @@ -942,7 +942,7 @@ Returns ``true`` if support override is enabled for the ``script``. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_script_support_overrides** **(** **)** |const| +:ref:`PackedStringArray` **get_script_support_overrides**\ (\ ) |const| Returns list of script support overrides. @@ -954,7 +954,7 @@ Returns list of script support overrides. .. rst-class:: classref-method -:ref:`Vector2i[]` **get_size_cache_list** **(** :ref:`int` cache_index **)** |const| +:ref:`Array`\[:ref:`Vector2i`\] **get_size_cache_list**\ (\ cache_index\: :ref:`int`\ ) |const| Returns list of the font sizes in the cache. Each size is :ref:`Vector2i` with font size and outline size. @@ -966,7 +966,7 @@ Returns list of the font sizes in the cache. Each size is :ref:`Vector2i` **get_texture_count** **(** :ref:`int` cache_index, :ref:`Vector2i` size **)** |const| +:ref:`int` **get_texture_count**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) |const| Returns number of textures used by font cache entry. @@ -978,7 +978,7 @@ Returns number of textures used by font cache entry. .. rst-class:: classref-method -:ref:`Image` **get_texture_image** **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` texture_index **)** |const| +:ref:`Image` **get_texture_image**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| Returns a copy of the font cache texture image. @@ -990,7 +990,7 @@ Returns a copy of the font cache texture image. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_texture_offsets** **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` texture_index **)** |const| +:ref:`PackedInt32Array` **get_texture_offsets**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| Returns a copy of the array containing glyph packing data. @@ -1002,7 +1002,7 @@ Returns a copy of the array containing glyph packing data. .. rst-class:: classref-method -:ref:`Transform2D` **get_transform** **(** :ref:`int` cache_index **)** |const| +:ref:`Transform2D` **get_transform**\ (\ cache_index\: :ref:`int`\ ) |const| Returns 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs. @@ -1014,7 +1014,7 @@ Returns 2D transform, applied to the font outlines, can be used for slanting, fl .. rst-class:: classref-method -:ref:`Dictionary` **get_variation_coordinates** **(** :ref:`int` cache_index **)** |const| +:ref:`Dictionary` **get_variation_coordinates**\ (\ cache_index\: :ref:`int`\ ) |const| Returns variation coordinates for the specified font cache entry. See :ref:`Font.get_supported_variation_list` for more info. @@ -1026,7 +1026,7 @@ Returns variation coordinates for the specified font cache entry. See :ref:`Font .. rst-class:: classref-method -:ref:`Error` **load_bitmap_font** **(** :ref:`String` path **)** +:ref:`Error` **load_bitmap_font**\ (\ path\: :ref:`String`\ ) Loads an AngelCode BMFont (.fnt, .font) bitmap font from file ``path``. @@ -1040,7 +1040,7 @@ Loads an AngelCode BMFont (.fnt, .font) bitmap font from file ``path``. .. rst-class:: classref-method -:ref:`Error` **load_dynamic_font** **(** :ref:`String` path **)** +:ref:`Error` **load_dynamic_font**\ (\ path\: :ref:`String`\ ) Loads a TrueType (.ttf), OpenType (.otf), WOFF (.woff), WOFF2 (.woff2) or Type 1 (.pfb, .pfm) dynamic font from file ``path``. @@ -1054,7 +1054,7 @@ Loads a TrueType (.ttf), OpenType (.otf), WOFF (.woff), WOFF2 (.woff2) or Type 1 .. rst-class:: classref-method -void **remove_cache** **(** :ref:`int` cache_index **)** +|void| **remove_cache**\ (\ cache_index\: :ref:`int`\ ) Removes specified font cache entry. @@ -1066,7 +1066,7 @@ Removes specified font cache entry. .. rst-class:: classref-method -void **remove_glyph** **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` glyph **)** +|void| **remove_glyph**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) Removes specified rendered glyph information from the cache entry. @@ -1080,7 +1080,7 @@ Removes specified rendered glyph information from the cache entry. .. rst-class:: classref-method -void **remove_kerning** **(** :ref:`int` cache_index, :ref:`int` size, :ref:`Vector2i` glyph_pair **)** +|void| **remove_kerning**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) Removes kerning override for the pair of glyphs. @@ -1092,7 +1092,7 @@ Removes kerning override for the pair of glyphs. .. rst-class:: classref-method -void **remove_language_support_override** **(** :ref:`String` language **)** +|void| **remove_language_support_override**\ (\ language\: :ref:`String`\ ) Remove language support override. @@ -1104,7 +1104,7 @@ Remove language support override. .. rst-class:: classref-method -void **remove_script_support_override** **(** :ref:`String` script **)** +|void| **remove_script_support_override**\ (\ script\: :ref:`String`\ ) Removes script support override. @@ -1116,7 +1116,7 @@ Removes script support override. .. rst-class:: classref-method -void **remove_size_cache** **(** :ref:`int` cache_index, :ref:`Vector2i` size **)** +|void| **remove_size_cache**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`\ ) Removes specified font size from the cache entry. @@ -1128,7 +1128,7 @@ Removes specified font size from the cache entry. .. rst-class:: classref-method -void **remove_texture** **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` texture_index **)** +|void| **remove_texture**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) Removes specified texture from the cache entry. @@ -1142,7 +1142,7 @@ Removes specified texture from the cache entry. .. rst-class:: classref-method -void **render_glyph** **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` index **)** +|void| **render_glyph**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, index\: :ref:`int`\ ) Renders specified glyph to the font cache texture. @@ -1154,7 +1154,7 @@ Renders specified glyph to the font cache texture. .. rst-class:: classref-method -void **render_range** **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` start, :ref:`int` end **)** +|void| **render_range**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, start\: :ref:`int`, end\: :ref:`int`\ ) Renders the range of characters to the font cache texture. @@ -1166,7 +1166,7 @@ Renders the range of characters to the font cache texture. .. rst-class:: classref-method -void **set_cache_ascent** **(** :ref:`int` cache_index, :ref:`int` size, :ref:`float` ascent **)** +|void| **set_cache_ascent**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, ascent\: :ref:`float`\ ) Sets the font ascent (number of pixels above the baseline). @@ -1178,7 +1178,7 @@ Sets the font ascent (number of pixels above the baseline). .. rst-class:: classref-method -void **set_cache_descent** **(** :ref:`int` cache_index, :ref:`int` size, :ref:`float` descent **)** +|void| **set_cache_descent**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, descent\: :ref:`float`\ ) Sets the font descent (number of pixels below the baseline). @@ -1190,7 +1190,7 @@ Sets the font descent (number of pixels below the baseline). .. rst-class:: classref-method -void **set_cache_scale** **(** :ref:`int` cache_index, :ref:`int` size, :ref:`float` scale **)** +|void| **set_cache_scale**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, scale\: :ref:`float`\ ) Sets scaling factor of the color bitmap font. @@ -1202,7 +1202,7 @@ Sets scaling factor of the color bitmap font. .. rst-class:: classref-method -void **set_cache_underline_position** **(** :ref:`int` cache_index, :ref:`int` size, :ref:`float` underline_position **)** +|void| **set_cache_underline_position**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) Sets pixel offset of the underline below the baseline. @@ -1214,7 +1214,7 @@ Sets pixel offset of the underline below the baseline. .. rst-class:: classref-method -void **set_cache_underline_thickness** **(** :ref:`int` cache_index, :ref:`int` size, :ref:`float` underline_thickness **)** +|void| **set_cache_underline_thickness**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) Sets thickness of the underline in pixels. @@ -1226,7 +1226,7 @@ Sets thickness of the underline in pixels. .. rst-class:: classref-method -void **set_embolden** **(** :ref:`int` cache_index, :ref:`float` strength **)** +|void| **set_embolden**\ (\ cache_index\: :ref:`int`, strength\: :ref:`float`\ ) Sets embolden strength, if is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. @@ -1238,7 +1238,7 @@ Sets embolden strength, if is not equal to zero, emboldens the font outlines. Ne .. rst-class:: classref-method -void **set_extra_baseline_offset** **(** :ref:`int` cache_index, :ref:`float` baseline_offset **)** +|void| **set_extra_baseline_offset**\ (\ cache_index\: :ref:`int`, baseline_offset\: :ref:`float`\ ) Sets extra baseline offset (as a fraction of font height). @@ -1250,7 +1250,7 @@ Sets extra baseline offset (as a fraction of font height). .. rst-class:: classref-method -void **set_extra_spacing** **(** :ref:`int` cache_index, :ref:`SpacingType` spacing, :ref:`int` value **)** +|void| **set_extra_spacing**\ (\ cache_index\: :ref:`int`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) Sets the spacing for ``spacing`` (see :ref:`SpacingType`) to ``value`` in pixels (not relative to the font size). @@ -1262,7 +1262,7 @@ Sets the spacing for ``spacing`` (see :ref:`SpacingType` cache_index, :ref:`int` face_index **)** +|void| **set_face_index**\ (\ cache_index\: :ref:`int`, face_index\: :ref:`int`\ ) Sets an active face index in the TrueType / OpenType collection. @@ -1274,7 +1274,7 @@ Sets an active face index in the TrueType / OpenType collection. .. rst-class:: classref-method -void **set_glyph_advance** **(** :ref:`int` cache_index, :ref:`int` size, :ref:`int` glyph, :ref:`Vector2` advance **)** +|void| **set_glyph_advance**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) Sets glyph advance (offset of the next glyph). @@ -1288,7 +1288,7 @@ Sets glyph advance (offset of the next glyph). .. rst-class:: classref-method -void **set_glyph_offset** **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Vector2` offset **)** +|void| **set_glyph_offset**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) Sets glyph offset from the baseline. @@ -1300,7 +1300,7 @@ Sets glyph offset from the baseline. .. rst-class:: classref-method -void **set_glyph_size** **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Vector2` gl_size **)** +|void| **set_glyph_size**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) Sets glyph size. @@ -1312,7 +1312,7 @@ Sets glyph size. .. rst-class:: classref-method -void **set_glyph_texture_idx** **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`int` texture_idx **)** +|void| **set_glyph_texture_idx**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) Sets index of the cache texture containing the glyph. @@ -1324,7 +1324,7 @@ Sets index of the cache texture containing the glyph. .. rst-class:: classref-method -void **set_glyph_uv_rect** **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Rect2` uv_rect **)** +|void| **set_glyph_uv_rect**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) Sets rectangle in the cache texture containing the glyph. @@ -1336,7 +1336,7 @@ Sets rectangle in the cache texture containing the glyph. .. rst-class:: classref-method -void **set_kerning** **(** :ref:`int` cache_index, :ref:`int` size, :ref:`Vector2i` glyph_pair, :ref:`Vector2` kerning **)** +|void| **set_kerning**\ (\ cache_index\: :ref:`int`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`, kerning\: :ref:`Vector2`\ ) Sets kerning for the pair of glyphs. @@ -1348,7 +1348,7 @@ Sets kerning for the pair of glyphs. .. rst-class:: classref-method -void **set_language_support_override** **(** :ref:`String` language, :ref:`bool` supported **)** +|void| **set_language_support_override**\ (\ language\: :ref:`String`, supported\: :ref:`bool`\ ) Adds override for :ref:`Font.is_language_supported`. @@ -1360,7 +1360,7 @@ Adds override for :ref:`Font.is_language_supported` script, :ref:`bool` supported **)** +|void| **set_script_support_override**\ (\ script\: :ref:`String`, supported\: :ref:`bool`\ ) Adds override for :ref:`Font.is_script_supported`. @@ -1372,7 +1372,7 @@ Adds override for :ref:`Font.is_script_supported` cache_index, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`Image` image **)** +|void| **set_texture_image**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) Sets font cache texture image. @@ -1384,7 +1384,7 @@ Sets font cache texture image. .. rst-class:: classref-method -void **set_texture_offsets** **(** :ref:`int` cache_index, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`PackedInt32Array` offset **)** +|void| **set_texture_offsets**\ (\ cache_index\: :ref:`int`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, offset\: :ref:`PackedInt32Array`\ ) Sets array containing glyph packing data. @@ -1396,7 +1396,7 @@ Sets array containing glyph packing data. .. rst-class:: classref-method -void **set_transform** **(** :ref:`int` cache_index, :ref:`Transform2D` transform **)** +|void| **set_transform**\ (\ cache_index\: :ref:`int`, transform\: :ref:`Transform2D`\ ) Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs. @@ -1408,7 +1408,7 @@ Sets 2D transform, applied to the font outlines, can be used for slanting, flipp .. rst-class:: classref-method -void **set_variation_coordinates** **(** :ref:`int` cache_index, :ref:`Dictionary` variation_coordinates **)** +|void| **set_variation_coordinates**\ (\ cache_index\: :ref:`int`, variation_coordinates\: :ref:`Dictionary`\ ) Sets variation coordinates for the specified font cache entry. See :ref:`Font.get_supported_variation_list` for more info. @@ -1419,3 +1419,4 @@ Sets variation coordinates for the specified font cache entry. See :ref:`Font.ge .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_fontvariation.rst b/classes/class_fontvariation.rst index 023f5d3b47b..224e9d10417 100644 --- a/classes/class_fontvariation.rst +++ b/classes/class_fontvariation.rst @@ -93,9 +93,9 @@ Methods .. table:: :widths: auto - +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_spacing` **(** :ref:`SpacingType` spacing, :ref:`int` value **)** | - +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_spacing`\ (\ spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) | + +--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -114,8 +114,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_base_font** **(** :ref:`Font` value **)** -- :ref:`Font` **get_base_font** **(** **)** +- |void| **set_base_font**\ (\ value\: :ref:`Font`\ ) +- :ref:`Font` **get_base_font**\ (\ ) Base font used to create a variation. If not set, default :ref:`Theme` font is used. @@ -131,8 +131,8 @@ Base font used to create a variation. If not set, default :ref:`Theme` value **)** -- :ref:`float` **get_baseline_offset** **(** **)** +- |void| **set_baseline_offset**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_baseline_offset**\ (\ ) Extra baseline offset (as a fraction of font height). @@ -148,8 +148,8 @@ Extra baseline offset (as a fraction of font height). .. rst-class:: classref-property-setget -- void **set_opentype_features** **(** :ref:`Dictionary` value **)** -- :ref:`Dictionary` **get_opentype_features** **(** **)** +- |void| **set_opentype_features**\ (\ value\: :ref:`Dictionary`\ ) +- :ref:`Dictionary` **get_opentype_features**\ (\ ) A set of OpenType feature tags. More info: `OpenType feature tags `__. @@ -165,8 +165,8 @@ A set of OpenType feature tags. More info: `OpenType feature tags ` spacing, :ref:`int` value **)** -- :ref:`int` **get_spacing** **(** **)** +- |void| **set_spacing**\ (\ spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) +- :ref:`int` **get_spacing**\ (\ ) Extra spacing at the bottom of the line in pixels. @@ -182,8 +182,8 @@ Extra spacing at the bottom of the line in pixels. .. rst-class:: classref-property-setget -- void **set_spacing** **(** :ref:`SpacingType` spacing, :ref:`int` value **)** -- :ref:`int` **get_spacing** **(** **)** +- |void| **set_spacing**\ (\ spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) +- :ref:`int` **get_spacing**\ (\ ) Extra spacing between graphical glyphs. @@ -199,8 +199,8 @@ Extra spacing between graphical glyphs. .. rst-class:: classref-property-setget -- void **set_spacing** **(** :ref:`SpacingType` spacing, :ref:`int` value **)** -- :ref:`int` **get_spacing** **(** **)** +- |void| **set_spacing**\ (\ spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) +- :ref:`int` **get_spacing**\ (\ ) Extra width of the space glyphs. @@ -216,8 +216,8 @@ Extra width of the space glyphs. .. rst-class:: classref-property-setget -- void **set_spacing** **(** :ref:`SpacingType` spacing, :ref:`int` value **)** -- :ref:`int` **get_spacing** **(** **)** +- |void| **set_spacing**\ (\ spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) +- :ref:`int` **get_spacing**\ (\ ) Extra spacing at the top of the line in pixels. @@ -233,8 +233,8 @@ Extra spacing at the top of the line in pixels. .. rst-class:: classref-property-setget -- void **set_variation_embolden** **(** :ref:`float` value **)** -- :ref:`float` **get_variation_embolden** **(** **)** +- |void| **set_variation_embolden**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_variation_embolden**\ (\ ) If is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. @@ -252,8 +252,8 @@ If is not equal to zero, emboldens the font outlines. Negative values reduce the .. rst-class:: classref-property-setget -- void **set_variation_face_index** **(** :ref:`int` value **)** -- :ref:`int` **get_variation_face_index** **(** **)** +- |void| **set_variation_face_index**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_variation_face_index**\ (\ ) Active face index in the TrueType / OpenType collection file. @@ -269,8 +269,8 @@ Active face index in the TrueType / OpenType collection file. .. rst-class:: classref-property-setget -- void **set_variation_opentype** **(** :ref:`Dictionary` value **)** -- :ref:`Dictionary` **get_variation_opentype** **(** **)** +- |void| **set_variation_opentype**\ (\ value\: :ref:`Dictionary`\ ) +- :ref:`Dictionary` **get_variation_opentype**\ (\ ) Font OpenType variation coordinates. More info: `OpenType variation tags `__. @@ -290,8 +290,8 @@ Font OpenType variation coordinates. More info: `OpenType variation tags ` value **)** -- :ref:`Transform2D` **get_variation_transform** **(** **)** +- |void| **set_variation_transform**\ (\ value\: :ref:`Transform2D`\ ) +- :ref:`Transform2D` **get_variation_transform**\ (\ ) 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs. @@ -310,7 +310,7 @@ Method Descriptions .. rst-class:: classref-method -void **set_spacing** **(** :ref:`SpacingType` spacing, :ref:`int` value **)** +|void| **set_spacing**\ (\ spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) Sets the spacing for ``spacing`` (see :ref:`SpacingType`) to ``value`` in pixels (not relative to the font size). @@ -321,3 +321,4 @@ Sets the spacing for ``spacing`` (see :ref:`SpacingType` + +Framebuffer cache manager for Rendering Device based renderers. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Framebuffer cache manager for Rendering Device based renderers. Provides a way to create a framebuffer and reuse it in subsequent calls for as long as the used textures exists. Framebuffers will automatically be cleaned up when dependent objects are freed. + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_cache_multipass`\ (\ textures\: :ref:`Array`\[:ref:`RID`\], passes\: :ref:`Array`\[:ref:`RDFramebufferPass`\], views\: :ref:`int`\ ) |static| | + +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_FramebufferCacheRD_method_get_cache_multipass: + +.. rst-class:: classref-method + +:ref:`RID` **get_cache_multipass**\ (\ textures\: :ref:`Array`\[:ref:`RID`\], passes\: :ref:`Array`\[:ref:`RDFramebufferPass`\], views\: :ref:`int`\ ) |static| + +Creates, or obtains a cached, framebuffer. ``textures`` lists textures accessed. ``passes`` defines the subpasses and texture allocation, if left empty a single pass is created and textures are allocated depending on their usage flags. ``views`` defines the number of views used when rendering. + +.. |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.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gdextension.rst b/classes/class_gdextension.rst index 958a439bf19..f98cf4850a1 100644 --- a/classes/class_gdextension.rst +++ b/classes/class_gdextension.rst @@ -40,11 +40,11 @@ Methods .. table:: :widths: auto - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`InitializationLevel` | :ref:`get_minimum_library_initialization_level` **(** **)** |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_library_open` **(** **)** |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`InitializationLevel` | :ref:`get_minimum_library_initialization_level`\ (\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_library_open`\ (\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -106,7 +106,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`InitializationLevel` **get_minimum_library_initialization_level** **(** **)** |const| +:ref:`InitializationLevel` **get_minimum_library_initialization_level**\ (\ ) |const| Returns the lowest level required for this extension to be properly initialized (see the :ref:`InitializationLevel` enum). @@ -118,7 +118,7 @@ Returns the lowest level required for this extension to be properly initialized .. rst-class:: classref-method -:ref:`bool` **is_library_open** **(** **)** |const| +:ref:`bool` **is_library_open**\ (\ ) |const| Returns ``true`` if this extension's library has been opened. @@ -129,3 +129,4 @@ Returns ``true`` if this extension's library has been opened. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gdextensionmanager.rst b/classes/class_gdextensionmanager.rst index a8f748f6fc2..904fd10a068 100644 --- a/classes/class_gdextensionmanager.rst +++ b/classes/class_gdextensionmanager.rst @@ -40,19 +40,19 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GDExtension` | :ref:`get_extension` **(** :ref:`String` path **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_loaded_extensions` **(** **)** |const| | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_extension_loaded` **(** :ref:`String` path **)** |const| | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`LoadStatus` | :ref:`load_extension` **(** :ref:`String` path **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`LoadStatus` | :ref:`reload_extension` **(** :ref:`String` path **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`LoadStatus` | :ref:`unload_extension` **(** :ref:`String` path **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GDExtension` | :ref:`get_extension`\ (\ path\: :ref:`String`\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_loaded_extensions`\ (\ ) |const| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_extension_loaded`\ (\ path\: :ref:`String`\ ) |const| | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`LoadStatus` | :ref:`load_extension`\ (\ path\: :ref:`String`\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`LoadStatus` | :ref:`reload_extension`\ (\ path\: :ref:`String`\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`LoadStatus` | :ref:`unload_extension`\ (\ path\: :ref:`String`\ ) | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -67,7 +67,7 @@ Signals .. rst-class:: classref-signal -**extensions_reloaded** **(** **)** +**extensions_reloaded**\ (\ ) Emitted after the editor has finished reloading one or more extensions. @@ -139,7 +139,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`GDExtension` **get_extension** **(** :ref:`String` path **)** +:ref:`GDExtension` **get_extension**\ (\ path\: :ref:`String`\ ) Returns the :ref:`GDExtension` at the given file ``path``, or ``null`` if it has not been loaded or does not exist. @@ -151,7 +151,7 @@ Returns the :ref:`GDExtension` at the given file ``path``, or .. rst-class:: classref-method -:ref:`PackedStringArray` **get_loaded_extensions** **(** **)** |const| +:ref:`PackedStringArray` **get_loaded_extensions**\ (\ ) |const| Returns the file paths of all currently loaded extensions. @@ -163,7 +163,7 @@ Returns the file paths of all currently loaded extensions. .. rst-class:: classref-method -:ref:`bool` **is_extension_loaded** **(** :ref:`String` path **)** |const| +:ref:`bool` **is_extension_loaded**\ (\ path\: :ref:`String`\ ) |const| Returns ``true`` if the extension at the given file ``path`` has already been loaded successfully. See also :ref:`get_loaded_extensions`. @@ -175,7 +175,7 @@ Returns ``true`` if the extension at the given file ``path`` has already been lo .. rst-class:: classref-method -:ref:`LoadStatus` **load_extension** **(** :ref:`String` path **)** +:ref:`LoadStatus` **load_extension**\ (\ path\: :ref:`String`\ ) Loads an extension by absolute file path. The ``path`` needs to point to a valid :ref:`GDExtension`. Returns :ref:`LOAD_STATUS_OK` if successful. @@ -187,7 +187,7 @@ Loads an extension by absolute file path. The ``path`` needs to point to a valid .. rst-class:: classref-method -:ref:`LoadStatus` **reload_extension** **(** :ref:`String` path **)** +:ref:`LoadStatus` **reload_extension**\ (\ path\: :ref:`String`\ ) Reloads the extension at the given file path. The ``path`` needs to point to a valid :ref:`GDExtension`, otherwise this method may return either :ref:`LOAD_STATUS_NOT_LOADED` or :ref:`LOAD_STATUS_FAILED`. @@ -201,7 +201,7 @@ Reloads the extension at the given file path. The ``path`` needs to point to a v .. rst-class:: classref-method -:ref:`LoadStatus` **unload_extension** **(** :ref:`String` path **)** +:ref:`LoadStatus` **unload_extension**\ (\ path\: :ref:`String`\ ) Unloads an extension by file path. The ``path`` needs to point to an already loaded :ref:`GDExtension`, otherwise this method returns :ref:`LOAD_STATUS_NOT_LOADED`. @@ -212,3 +212,4 @@ Unloads an extension by file path. The ``path`` needs to point to an already loa .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index e40c0ea8360..81947a285d9 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -40,9 +40,9 @@ Methods .. table:: :widths: auto - +-------------------------------+----------------------------------------------------------------+ - | :ref:`Variant` | :ref:`new` **(** ... **)** |vararg| | - +-------------------------------+----------------------------------------------------------------+ + +-------------------------------+-----------------------------------------------------------+ + | :ref:`Variant` | :ref:`new`\ (\ ...\ ) |vararg| | + +-------------------------------+-----------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -57,7 +57,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **new** **(** ... **)** |vararg| +:ref:`Variant` **new**\ (\ ...\ ) |vararg| Returns a new instance of the script. @@ -76,3 +76,4 @@ For example: .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_generic6dofjoint3d.rst b/classes/class_generic6dofjoint3d.rst index c76c75d5c16..e8d7e1e1208 100644 --- a/classes/class_generic6dofjoint3d.rst +++ b/classes/class_generic6dofjoint3d.rst @@ -209,31 +209,31 @@ Methods .. table:: :widths: auto - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_flag_x` **(** :ref:`Flag` flag **)** |const| | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_flag_y` **(** :ref:`Flag` flag **)** |const| | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_flag_z` **(** :ref:`Flag` flag **)** |const| | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_param_x` **(** :ref:`Param` param **)** |const| | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_param_y` **(** :ref:`Param` param **)** |const| | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_param_z` **(** :ref:`Param` param **)** |const| | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_flag_x` **(** :ref:`Flag` flag, :ref:`bool` value **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_flag_y` **(** :ref:`Flag` flag, :ref:`bool` value **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_flag_z` **(** :ref:`Flag` flag, :ref:`bool` value **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_param_x` **(** :ref:`Param` param, :ref:`float` value **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_param_y` **(** :ref:`Param` param, :ref:`float` value **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_param_z` **(** :ref:`Param` param, :ref:`float` value **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_flag_x`\ (\ flag\: :ref:`Flag`\ ) |const| | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_flag_y`\ (\ flag\: :ref:`Flag`\ ) |const| | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_flag_z`\ (\ flag\: :ref:`Flag`\ ) |const| | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_param_x`\ (\ param\: :ref:`Param`\ ) |const| | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_param_y`\ (\ param\: :ref:`Param`\ ) |const| | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_param_z`\ (\ param\: :ref:`Param`\ ) |const| | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_flag_x`\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_flag_y`\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_flag_z`\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_param_x`\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_param_y`\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_param_z`\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -549,8 +549,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| The amount of rotational damping across the X axis. @@ -568,8 +568,8 @@ The lower, the longer an impulse from one side takes to travel to the other side .. rst-class:: classref-property-setget -- void **set_flag_x** **(** :ref:`Flag` flag, :ref:`bool` value **)** -- :ref:`bool` **get_flag_x** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag_x**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +- :ref:`bool` **get_flag_x**\ (\ flag\: :ref:`Flag`\ ) |const| If ``true``, rotation across the X axis is limited. @@ -585,8 +585,8 @@ If ``true``, rotation across the X axis is limited. .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| When rotating across the X axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. @@ -602,8 +602,8 @@ When rotating across the X axis, this error tolerance factor defines how much th .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| The maximum amount of force that can occur, when rotating around the X axis. @@ -619,8 +619,8 @@ The maximum amount of force that can occur, when rotating around the X axis. .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| The minimum rotation in negative direction to break loose and rotate around the X axis. @@ -636,8 +636,8 @@ The minimum rotation in negative direction to break loose and rotate around the .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| The amount of rotational restitution across the X axis. The lower, the more restitution occurs. @@ -653,8 +653,8 @@ The amount of rotational restitution across the X axis. The lower, the more rest .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| The speed of all rotations across the X axis. @@ -670,8 +670,8 @@ The speed of all rotations across the X axis. .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| The minimum rotation in positive direction to break loose and rotate around the X axis. @@ -687,8 +687,8 @@ The minimum rotation in positive direction to break loose and rotate around the .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| The amount of rotational damping across the Y axis. The lower, the more damping occurs. @@ -704,8 +704,8 @@ The amount of rotational damping across the Y axis. The lower, the more damping .. rst-class:: classref-property-setget -- void **set_flag_y** **(** :ref:`Flag` flag, :ref:`bool` value **)** -- :ref:`bool` **get_flag_y** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag_y**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +- :ref:`bool` **get_flag_y**\ (\ flag\: :ref:`Flag`\ ) |const| If ``true``, rotation across the Y axis is limited. @@ -721,8 +721,8 @@ If ``true``, rotation across the Y axis is limited. .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| When rotating across the Y axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. @@ -738,8 +738,8 @@ When rotating across the Y axis, this error tolerance factor defines how much th .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| The maximum amount of force that can occur, when rotating around the Y axis. @@ -755,8 +755,8 @@ The maximum amount of force that can occur, when rotating around the Y axis. .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| The minimum rotation in negative direction to break loose and rotate around the Y axis. @@ -772,8 +772,8 @@ The minimum rotation in negative direction to break loose and rotate around the .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| The amount of rotational restitution across the Y axis. The lower, the more restitution occurs. @@ -789,8 +789,8 @@ The amount of rotational restitution across the Y axis. The lower, the more rest .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| The speed of all rotations across the Y axis. @@ -806,8 +806,8 @@ The speed of all rotations across the Y axis. .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| The minimum rotation in positive direction to break loose and rotate around the Y axis. @@ -823,8 +823,8 @@ The minimum rotation in positive direction to break loose and rotate around the .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| The amount of rotational damping across the Z axis. The lower, the more damping occurs. @@ -840,8 +840,8 @@ The amount of rotational damping across the Z axis. The lower, the more damping .. rst-class:: classref-property-setget -- void **set_flag_z** **(** :ref:`Flag` flag, :ref:`bool` value **)** -- :ref:`bool` **get_flag_z** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag_z**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +- :ref:`bool` **get_flag_z**\ (\ flag\: :ref:`Flag`\ ) |const| If ``true``, rotation across the Z axis is limited. @@ -857,8 +857,8 @@ If ``true``, rotation across the Z axis is limited. .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| When rotating across the Z axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. @@ -874,8 +874,8 @@ When rotating across the Z axis, this error tolerance factor defines how much th .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| The maximum amount of force that can occur, when rotating around the Z axis. @@ -891,8 +891,8 @@ The maximum amount of force that can occur, when rotating around the Z axis. .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| The minimum rotation in negative direction to break loose and rotate around the Z axis. @@ -908,8 +908,8 @@ The minimum rotation in negative direction to break loose and rotate around the .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| The amount of rotational restitution across the Z axis. The lower, the more restitution occurs. @@ -925,8 +925,8 @@ The amount of rotational restitution across the Z axis. The lower, the more rest .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| The speed of all rotations across the Z axis. @@ -942,8 +942,8 @@ The speed of all rotations across the Z axis. .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| The minimum rotation in positive direction to break loose and rotate around the Z axis. @@ -959,8 +959,8 @@ The minimum rotation in positive direction to break loose and rotate around the .. rst-class:: classref-property-setget -- void **set_flag_x** **(** :ref:`Flag` flag, :ref:`bool` value **)** -- :ref:`bool` **get_flag_x** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag_x**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +- :ref:`bool` **get_flag_x**\ (\ flag\: :ref:`Flag`\ ) |const| If ``true``, a rotating motor at the X axis is enabled. @@ -976,8 +976,8 @@ If ``true``, a rotating motor at the X axis is enabled. .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| Maximum acceleration for the motor at the X axis. @@ -993,8 +993,8 @@ Maximum acceleration for the motor at the X axis. .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| Target speed for the motor at the X axis. @@ -1010,8 +1010,8 @@ Target speed for the motor at the X axis. .. rst-class:: classref-property-setget -- void **set_flag_y** **(** :ref:`Flag` flag, :ref:`bool` value **)** -- :ref:`bool` **get_flag_y** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag_y**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +- :ref:`bool` **get_flag_y**\ (\ flag\: :ref:`Flag`\ ) |const| If ``true``, a rotating motor at the Y axis is enabled. @@ -1027,8 +1027,8 @@ If ``true``, a rotating motor at the Y axis is enabled. .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| Maximum acceleration for the motor at the Y axis. @@ -1044,8 +1044,8 @@ Maximum acceleration for the motor at the Y axis. .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| Target speed for the motor at the Y axis. @@ -1061,8 +1061,8 @@ Target speed for the motor at the Y axis. .. rst-class:: classref-property-setget -- void **set_flag_z** **(** :ref:`Flag` flag, :ref:`bool` value **)** -- :ref:`bool` **get_flag_z** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag_z**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +- :ref:`bool` **get_flag_z**\ (\ flag\: :ref:`Flag`\ ) |const| If ``true``, a rotating motor at the Z axis is enabled. @@ -1078,8 +1078,8 @@ If ``true``, a rotating motor at the Z axis is enabled. .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| Maximum acceleration for the motor at the Z axis. @@ -1095,8 +1095,8 @@ Maximum acceleration for the motor at the Z axis. .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| Target speed for the motor at the Z axis. @@ -1112,8 +1112,8 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -1131,8 +1131,8 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property-setget -- void **set_flag_x** **(** :ref:`Flag` flag, :ref:`bool` value **)** -- :ref:`bool` **get_flag_x** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag_x**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +- :ref:`bool` **get_flag_x**\ (\ flag\: :ref:`Flag`\ ) |const| .. container:: contribute @@ -1150,8 +1150,8 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -1169,8 +1169,8 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -1188,8 +1188,8 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -1207,8 +1207,8 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property-setget -- void **set_flag_y** **(** :ref:`Flag` flag, :ref:`bool` value **)** -- :ref:`bool` **get_flag_y** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag_y**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +- :ref:`bool` **get_flag_y**\ (\ flag\: :ref:`Flag`\ ) |const| .. container:: contribute @@ -1226,8 +1226,8 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -1245,8 +1245,8 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -1264,8 +1264,8 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -1283,8 +1283,8 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property-setget -- void **set_flag_z** **(** :ref:`Flag` flag, :ref:`bool` value **)** -- :ref:`bool` **get_flag_z** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag_z**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +- :ref:`bool` **get_flag_z**\ (\ flag\: :ref:`Flag`\ ) |const| .. container:: contribute @@ -1302,8 +1302,8 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -1321,8 +1321,8 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -1340,8 +1340,8 @@ Target speed for the motor at the Z axis. .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| The amount of damping that happens at the X motion. @@ -1357,8 +1357,8 @@ The amount of damping that happens at the X motion. .. rst-class:: classref-property-setget -- void **set_flag_x** **(** :ref:`Flag` flag, :ref:`bool` value **)** -- :ref:`bool` **get_flag_x** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag_x**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +- :ref:`bool` **get_flag_x**\ (\ flag\: :ref:`Flag`\ ) |const| If ``true``, the linear motion across the X axis is limited. @@ -1374,8 +1374,8 @@ If ``true``, the linear motion across the X axis is limited. .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| The minimum difference between the pivot points' X axis. @@ -1391,8 +1391,8 @@ The minimum difference between the pivot points' X axis. .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| The amount of restitution on the X axis movement. The lower, the more momentum gets lost. @@ -1408,8 +1408,8 @@ The amount of restitution on the X axis movement. The lower, the more momentum g .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| A factor applied to the movement across the X axis. The lower, the slower the movement. @@ -1425,8 +1425,8 @@ A factor applied to the movement across the X axis. The lower, the slower the mo .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| The maximum difference between the pivot points' X axis. @@ -1442,8 +1442,8 @@ The maximum difference between the pivot points' X axis. .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| The amount of damping that happens at the Y motion. @@ -1459,8 +1459,8 @@ The amount of damping that happens at the Y motion. .. rst-class:: classref-property-setget -- void **set_flag_y** **(** :ref:`Flag` flag, :ref:`bool` value **)** -- :ref:`bool` **get_flag_y** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag_y**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +- :ref:`bool` **get_flag_y**\ (\ flag\: :ref:`Flag`\ ) |const| If ``true``, the linear motion across the Y axis is limited. @@ -1476,8 +1476,8 @@ If ``true``, the linear motion across the Y axis is limited. .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| The minimum difference between the pivot points' Y axis. @@ -1493,8 +1493,8 @@ The minimum difference between the pivot points' Y axis. .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| The amount of restitution on the Y axis movement. The lower, the more momentum gets lost. @@ -1510,8 +1510,8 @@ The amount of restitution on the Y axis movement. The lower, the more momentum g .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| A factor applied to the movement across the Y axis. The lower, the slower the movement. @@ -1527,8 +1527,8 @@ A factor applied to the movement across the Y axis. The lower, the slower the mo .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| The maximum difference between the pivot points' Y axis. @@ -1544,8 +1544,8 @@ The maximum difference between the pivot points' Y axis. .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| The amount of damping that happens at the Z motion. @@ -1561,8 +1561,8 @@ The amount of damping that happens at the Z motion. .. rst-class:: classref-property-setget -- void **set_flag_z** **(** :ref:`Flag` flag, :ref:`bool` value **)** -- :ref:`bool` **get_flag_z** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag_z**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +- :ref:`bool` **get_flag_z**\ (\ flag\: :ref:`Flag`\ ) |const| If ``true``, the linear motion across the Z axis is limited. @@ -1578,8 +1578,8 @@ If ``true``, the linear motion across the Z axis is limited. .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| The minimum difference between the pivot points' Z axis. @@ -1595,8 +1595,8 @@ The minimum difference between the pivot points' Z axis. .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| The amount of restitution on the Z axis movement. The lower, the more momentum gets lost. @@ -1612,8 +1612,8 @@ The amount of restitution on the Z axis movement. The lower, the more momentum g .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| A factor applied to the movement across the Z axis. The lower, the slower the movement. @@ -1629,8 +1629,8 @@ A factor applied to the movement across the Z axis. The lower, the slower the mo .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| The maximum difference between the pivot points' Z axis. @@ -1646,8 +1646,8 @@ The maximum difference between the pivot points' Z axis. .. rst-class:: classref-property-setget -- void **set_flag_x** **(** :ref:`Flag` flag, :ref:`bool` value **)** -- :ref:`bool` **get_flag_x** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag_x**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +- :ref:`bool` **get_flag_x**\ (\ flag\: :ref:`Flag`\ ) |const| If ``true``, then there is a linear motor on the X axis. It will attempt to reach the target velocity while staying within the force limits. @@ -1663,8 +1663,8 @@ If ``true``, then there is a linear motor on the X axis. It will attempt to reac .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| The maximum force the linear motor can apply on the X axis while trying to reach the target velocity. @@ -1680,8 +1680,8 @@ The maximum force the linear motor can apply on the X axis while trying to reach .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| The speed that the linear motor will attempt to reach on the X axis. @@ -1697,8 +1697,8 @@ The speed that the linear motor will attempt to reach on the X axis. .. rst-class:: classref-property-setget -- void **set_flag_y** **(** :ref:`Flag` flag, :ref:`bool` value **)** -- :ref:`bool` **get_flag_y** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag_y**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +- :ref:`bool` **get_flag_y**\ (\ flag\: :ref:`Flag`\ ) |const| If ``true``, then there is a linear motor on the Y axis. It will attempt to reach the target velocity while staying within the force limits. @@ -1714,8 +1714,8 @@ If ``true``, then there is a linear motor on the Y axis. It will attempt to reac .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| The maximum force the linear motor can apply on the Y axis while trying to reach the target velocity. @@ -1731,8 +1731,8 @@ The maximum force the linear motor can apply on the Y axis while trying to reach .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| The speed that the linear motor will attempt to reach on the Y axis. @@ -1748,8 +1748,8 @@ The speed that the linear motor will attempt to reach on the Y axis. .. rst-class:: classref-property-setget -- void **set_flag_z** **(** :ref:`Flag` flag, :ref:`bool` value **)** -- :ref:`bool` **get_flag_z** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag_z**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +- :ref:`bool` **get_flag_z**\ (\ flag\: :ref:`Flag`\ ) |const| If ``true``, then there is a linear motor on the Z axis. It will attempt to reach the target velocity while staying within the force limits. @@ -1765,8 +1765,8 @@ If ``true``, then there is a linear motor on the Z axis. It will attempt to reac .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| The maximum force the linear motor can apply on the Z axis while trying to reach the target velocity. @@ -1782,8 +1782,8 @@ The maximum force the linear motor can apply on the Z axis while trying to reach .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| The speed that the linear motor will attempt to reach on the Z axis. @@ -1799,8 +1799,8 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -1818,8 +1818,8 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property-setget -- void **set_flag_x** **(** :ref:`Flag` flag, :ref:`bool` value **)** -- :ref:`bool` **get_flag_x** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag_x**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +- :ref:`bool` **get_flag_x**\ (\ flag\: :ref:`Flag`\ ) |const| .. container:: contribute @@ -1837,8 +1837,8 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -1856,8 +1856,8 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property-setget -- void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +- |void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -1875,8 +1875,8 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -1894,8 +1894,8 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property-setget -- void **set_flag_y** **(** :ref:`Flag` flag, :ref:`bool` value **)** -- :ref:`bool` **get_flag_y** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag_y**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +- :ref:`bool` **get_flag_y**\ (\ flag\: :ref:`Flag`\ ) |const| .. container:: contribute @@ -1913,8 +1913,8 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -1932,8 +1932,8 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property-setget -- void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +- |void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -1951,8 +1951,8 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -1970,8 +1970,8 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property-setget -- void **set_flag_z** **(** :ref:`Flag` flag, :ref:`bool` value **)** -- :ref:`bool` **get_flag_z** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag_z**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) +- :ref:`bool` **get_flag_z**\ (\ flag\: :ref:`Flag`\ ) |const| .. container:: contribute @@ -1989,8 +1989,8 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -2008,8 +2008,8 @@ The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-property-setget -- void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +- |void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -2028,7 +2028,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_flag_x** **(** :ref:`Flag` flag **)** |const| +:ref:`bool` **get_flag_x**\ (\ flag\: :ref:`Flag`\ ) |const| .. container:: contribute @@ -2042,7 +2042,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_flag_y** **(** :ref:`Flag` flag **)** |const| +:ref:`bool` **get_flag_y**\ (\ flag\: :ref:`Flag`\ ) |const| .. container:: contribute @@ -2056,7 +2056,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_flag_z** **(** :ref:`Flag` flag **)** |const| +:ref:`bool` **get_flag_z**\ (\ flag\: :ref:`Flag`\ ) |const| .. container:: contribute @@ -2070,7 +2070,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +:ref:`float` **get_param_x**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -2084,7 +2084,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +:ref:`float` **get_param_y**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -2098,7 +2098,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +:ref:`float` **get_param_z**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -2112,7 +2112,7 @@ Method Descriptions .. rst-class:: classref-method -void **set_flag_x** **(** :ref:`Flag` flag, :ref:`bool` value **)** +|void| **set_flag_x**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) .. container:: contribute @@ -2126,7 +2126,7 @@ void **set_flag_x** **(** :ref:`Flag` flag, :ref:` .. rst-class:: classref-method -void **set_flag_y** **(** :ref:`Flag` flag, :ref:`bool` value **)** +|void| **set_flag_y**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) .. container:: contribute @@ -2140,7 +2140,7 @@ void **set_flag_y** **(** :ref:`Flag` flag, :ref:` .. rst-class:: classref-method -void **set_flag_z** **(** :ref:`Flag` flag, :ref:`bool` value **)** +|void| **set_flag_z**\ (\ flag\: :ref:`Flag`, value\: :ref:`bool`\ ) .. container:: contribute @@ -2154,7 +2154,7 @@ void **set_flag_z** **(** :ref:`Flag` flag, :ref:` .. rst-class:: classref-method -void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** +|void| **set_param_x**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) .. container:: contribute @@ -2168,7 +2168,7 @@ void **set_param_x** **(** :ref:`Param` param, :r .. rst-class:: classref-method -void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** +|void| **set_param_y**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) .. container:: contribute @@ -2182,7 +2182,7 @@ void **set_param_y** **(** :ref:`Param` param, :r .. rst-class:: classref-method -void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** +|void| **set_param_z**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) .. container:: contribute @@ -2195,3 +2195,4 @@ void **set_param_z** **(** :ref:`Param` param, :r .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_geometry2d.rst b/classes/class_geometry2d.rst index c7c2604d68c..9be7b9ca6ad 100644 --- a/classes/class_geometry2d.rst +++ b/classes/class_geometry2d.rst @@ -29,53 +29,53 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array[]` | :ref:`clip_polygons` **(** :ref:`PackedVector2Array` polygon_a, :ref:`PackedVector2Array` polygon_b **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array[]` | :ref:`clip_polyline_with_polygon` **(** :ref:`PackedVector2Array` polyline, :ref:`PackedVector2Array` polygon **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`convex_hull` **(** :ref:`PackedVector2Array` points **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array[]` | :ref:`decompose_polygon_in_convex` **(** :ref:`PackedVector2Array` polygon **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array[]` | :ref:`exclude_polygons` **(** :ref:`PackedVector2Array` polygon_a, :ref:`PackedVector2Array` polygon_b **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_closest_point_to_segment_uncapped` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`get_closest_points_between_segments` **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array[]` | :ref:`intersect_polygons` **(** :ref:`PackedVector2Array` polygon_a, :ref:`PackedVector2Array` polygon_b **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array[]` | :ref:`intersect_polyline_with_polygon` **(** :ref:`PackedVector2Array` polyline, :ref:`PackedVector2Array` polygon **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_point_in_circle` **(** :ref:`Vector2` point, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_point_in_polygon` **(** :ref:`Vector2` point, :ref:`PackedVector2Array` polygon **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_polygon_clockwise` **(** :ref:`PackedVector2Array` polygon **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`line_intersects_line` **(** :ref:`Vector2` from_a, :ref:`Vector2` dir_a, :ref:`Vector2` from_b, :ref:`Vector2` dir_b **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`make_atlas` **(** :ref:`PackedVector2Array` sizes **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array[]` | :ref:`merge_polygons` **(** :ref:`PackedVector2Array` polygon_a, :ref:`PackedVector2Array` polygon_b **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array[]` | :ref:`offset_polygon` **(** :ref:`PackedVector2Array` polygon, :ref:`float` delta, :ref:`PolyJoinType` join_type=0 **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array[]` | :ref:`offset_polyline` **(** :ref:`PackedVector2Array` polyline, :ref:`float` delta, :ref:`PolyJoinType` join_type=0, :ref:`PolyEndType` end_type=3 **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`point_is_inside_triangle` **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** |const| | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`segment_intersects_circle` **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`segment_intersects_segment` **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`triangulate_delaunay` **(** :ref:`PackedVector2Array` points **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`triangulate_polygon` **(** :ref:`PackedVector2Array` polygon **)** | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`PackedVector2Array`\] | :ref:`clip_polygons`\ (\ polygon_a\: :ref:`PackedVector2Array`, polygon_b\: :ref:`PackedVector2Array`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`PackedVector2Array`\] | :ref:`clip_polyline_with_polygon`\ (\ polyline\: :ref:`PackedVector2Array`, polygon\: :ref:`PackedVector2Array`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`convex_hull`\ (\ points\: :ref:`PackedVector2Array`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`PackedVector2Array`\] | :ref:`decompose_polygon_in_convex`\ (\ polygon\: :ref:`PackedVector2Array`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`PackedVector2Array`\] | :ref:`exclude_polygons`\ (\ polygon_a\: :ref:`PackedVector2Array`, polygon_b\: :ref:`PackedVector2Array`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_closest_point_to_segment`\ (\ point\: :ref:`Vector2`, s1\: :ref:`Vector2`, s2\: :ref:`Vector2`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_closest_point_to_segment_uncapped`\ (\ point\: :ref:`Vector2`, s1\: :ref:`Vector2`, s2\: :ref:`Vector2`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`get_closest_points_between_segments`\ (\ p1\: :ref:`Vector2`, q1\: :ref:`Vector2`, p2\: :ref:`Vector2`, q2\: :ref:`Vector2`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`PackedVector2Array`\] | :ref:`intersect_polygons`\ (\ polygon_a\: :ref:`PackedVector2Array`, polygon_b\: :ref:`PackedVector2Array`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`PackedVector2Array`\] | :ref:`intersect_polyline_with_polygon`\ (\ polyline\: :ref:`PackedVector2Array`, polygon\: :ref:`PackedVector2Array`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_point_in_circle`\ (\ point\: :ref:`Vector2`, circle_position\: :ref:`Vector2`, circle_radius\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_point_in_polygon`\ (\ point\: :ref:`Vector2`, polygon\: :ref:`PackedVector2Array`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_polygon_clockwise`\ (\ polygon\: :ref:`PackedVector2Array`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`line_intersects_line`\ (\ from_a\: :ref:`Vector2`, dir_a\: :ref:`Vector2`, from_b\: :ref:`Vector2`, dir_b\: :ref:`Vector2`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`make_atlas`\ (\ sizes\: :ref:`PackedVector2Array`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`PackedVector2Array`\] | :ref:`merge_polygons`\ (\ polygon_a\: :ref:`PackedVector2Array`, polygon_b\: :ref:`PackedVector2Array`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`PackedVector2Array`\] | :ref:`offset_polygon`\ (\ polygon\: :ref:`PackedVector2Array`, delta\: :ref:`float`, join_type\: :ref:`PolyJoinType` = 0\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`PackedVector2Array`\] | :ref:`offset_polyline`\ (\ polyline\: :ref:`PackedVector2Array`, delta\: :ref:`float`, join_type\: :ref:`PolyJoinType` = 0, end_type\: :ref:`PolyEndType` = 3\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`point_is_inside_triangle`\ (\ point\: :ref:`Vector2`, a\: :ref:`Vector2`, b\: :ref:`Vector2`, c\: :ref:`Vector2`\ ) |const| | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`segment_intersects_circle`\ (\ segment_from\: :ref:`Vector2`, segment_to\: :ref:`Vector2`, circle_position\: :ref:`Vector2`, circle_radius\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`segment_intersects_segment`\ (\ from_a\: :ref:`Vector2`, to_a\: :ref:`Vector2`, from_b\: :ref:`Vector2`, to_b\: :ref:`Vector2`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`triangulate_delaunay`\ (\ points\: :ref:`PackedVector2Array`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`triangulate_polygon`\ (\ polygon\: :ref:`PackedVector2Array`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -221,7 +221,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedVector2Array[]` **clip_polygons** **(** :ref:`PackedVector2Array` polygon_a, :ref:`PackedVector2Array` polygon_b **)** +:ref:`Array`\[:ref:`PackedVector2Array`\] **clip_polygons**\ (\ polygon_a\: :ref:`PackedVector2Array`, polygon_b\: :ref:`PackedVector2Array`\ ) Clips ``polygon_a`` against ``polygon_b`` and returns an array of clipped polygons. This performs :ref:`OPERATION_DIFFERENCE` between polygons. Returns an empty array if ``polygon_b`` completely overlaps ``polygon_a``. @@ -235,7 +235,7 @@ If ``polygon_b`` is enclosed by ``polygon_a``, returns an outer polygon (boundar .. rst-class:: classref-method -:ref:`PackedVector2Array[]` **clip_polyline_with_polygon** **(** :ref:`PackedVector2Array` polyline, :ref:`PackedVector2Array` polygon **)** +:ref:`Array`\[:ref:`PackedVector2Array`\] **clip_polyline_with_polygon**\ (\ polyline\: :ref:`PackedVector2Array`, polygon\: :ref:`PackedVector2Array`\ ) Clips ``polyline`` against ``polygon`` and returns an array of clipped polylines. This performs :ref:`OPERATION_DIFFERENCE` between the polyline and the polygon. This operation can be thought of as cutting a line with a closed shape. @@ -247,7 +247,7 @@ Clips ``polyline`` against ``polygon`` and returns an array of clipped polylines .. rst-class:: classref-method -:ref:`PackedVector2Array` **convex_hull** **(** :ref:`PackedVector2Array` points **)** +:ref:`PackedVector2Array` **convex_hull**\ (\ points\: :ref:`PackedVector2Array`\ ) Given an array of :ref:`Vector2`\ s, returns the convex hull as a list of points in counterclockwise order. The last point is the same as the first one. @@ -259,7 +259,7 @@ Given an array of :ref:`Vector2`\ s, returns the convex hull as a .. rst-class:: classref-method -:ref:`PackedVector2Array[]` **decompose_polygon_in_convex** **(** :ref:`PackedVector2Array` polygon **)** +:ref:`Array`\[:ref:`PackedVector2Array`\] **decompose_polygon_in_convex**\ (\ polygon\: :ref:`PackedVector2Array`\ ) Decomposes the ``polygon`` into multiple convex hulls and returns an array of :ref:`PackedVector2Array`. @@ -271,7 +271,7 @@ Decomposes the ``polygon`` into multiple convex hulls and returns an array of :r .. rst-class:: classref-method -:ref:`PackedVector2Array[]` **exclude_polygons** **(** :ref:`PackedVector2Array` polygon_a, :ref:`PackedVector2Array` polygon_b **)** +:ref:`Array`\[:ref:`PackedVector2Array`\] **exclude_polygons**\ (\ polygon_a\: :ref:`PackedVector2Array`, polygon_b\: :ref:`PackedVector2Array`\ ) Mutually excludes common area defined by intersection of ``polygon_a`` and ``polygon_b`` (see :ref:`intersect_polygons`) and returns an array of excluded polygons. This performs :ref:`OPERATION_XOR` between polygons. In other words, returns all but common area between polygons. @@ -285,7 +285,7 @@ The operation may result in an outer polygon (boundary) and inner polygon (hole) .. rst-class:: classref-method -:ref:`Vector2` **get_closest_point_to_segment** **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** +:ref:`Vector2` **get_closest_point_to_segment**\ (\ point\: :ref:`Vector2`, s1\: :ref:`Vector2`, s2\: :ref:`Vector2`\ ) Returns the 2D point on the 2D segment (``s1``, ``s2``) that is closest to ``point``. The returned point will always be inside the specified segment. @@ -297,7 +297,7 @@ Returns the 2D point on the 2D segment (``s1``, ``s2``) that is closest to ``poi .. rst-class:: classref-method -:ref:`Vector2` **get_closest_point_to_segment_uncapped** **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** +:ref:`Vector2` **get_closest_point_to_segment_uncapped**\ (\ point\: :ref:`Vector2`, s1\: :ref:`Vector2`, s2\: :ref:`Vector2`\ ) Returns the 2D point on the 2D line defined by (``s1``, ``s2``) that is closest to ``point``. The returned point can be inside the segment (``s1``, ``s2``) or outside of it, i.e. somewhere on the line extending from the segment. @@ -309,7 +309,7 @@ Returns the 2D point on the 2D line defined by (``s1``, ``s2``) that is closest .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_closest_points_between_segments** **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** +:ref:`PackedVector2Array` **get_closest_points_between_segments**\ (\ p1\: :ref:`Vector2`, q1\: :ref:`Vector2`, p2\: :ref:`Vector2`, q2\: :ref:`Vector2`\ ) Given the two 2D segments (``p1``, ``q1``) and (``p2``, ``q2``), finds those two points on the two segments that are closest to each other. Returns a :ref:`PackedVector2Array` that contains this point on (``p1``, ``q1``) as well the accompanying point on (``p2``, ``q2``). @@ -321,7 +321,7 @@ Given the two 2D segments (``p1``, ``q1``) and (``p2``, ``q2``), finds those two .. rst-class:: classref-method -:ref:`PackedVector2Array[]` **intersect_polygons** **(** :ref:`PackedVector2Array` polygon_a, :ref:`PackedVector2Array` polygon_b **)** +:ref:`Array`\[:ref:`PackedVector2Array`\] **intersect_polygons**\ (\ polygon_a\: :ref:`PackedVector2Array`, polygon_b\: :ref:`PackedVector2Array`\ ) Intersects ``polygon_a`` with ``polygon_b`` and returns an array of intersected polygons. This performs :ref:`OPERATION_INTERSECTION` between polygons. In other words, returns common area shared by polygons. Returns an empty array if no intersection occurs. @@ -335,7 +335,7 @@ The operation may result in an outer polygon (boundary) and inner polygon (hole) .. rst-class:: classref-method -:ref:`PackedVector2Array[]` **intersect_polyline_with_polygon** **(** :ref:`PackedVector2Array` polyline, :ref:`PackedVector2Array` polygon **)** +:ref:`Array`\[:ref:`PackedVector2Array`\] **intersect_polyline_with_polygon**\ (\ polyline\: :ref:`PackedVector2Array`, polygon\: :ref:`PackedVector2Array`\ ) Intersects ``polyline`` with ``polygon`` and returns an array of intersected polylines. This performs :ref:`OPERATION_INTERSECTION` between the polyline and the polygon. This operation can be thought of as chopping a line with a closed shape. @@ -347,7 +347,7 @@ Intersects ``polyline`` with ``polygon`` and returns an array of intersected pol .. rst-class:: classref-method -:ref:`bool` **is_point_in_circle** **(** :ref:`Vector2` point, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** +:ref:`bool` **is_point_in_circle**\ (\ point\: :ref:`Vector2`, circle_position\: :ref:`Vector2`, circle_radius\: :ref:`float`\ ) Returns ``true`` if ``point`` is inside the circle or if it's located exactly *on* the circle's boundary, otherwise returns ``false``. @@ -359,7 +359,7 @@ Returns ``true`` if ``point`` is inside the circle or if it's located exactly *o .. rst-class:: classref-method -:ref:`bool` **is_point_in_polygon** **(** :ref:`Vector2` point, :ref:`PackedVector2Array` polygon **)** +:ref:`bool` **is_point_in_polygon**\ (\ point\: :ref:`Vector2`, polygon\: :ref:`PackedVector2Array`\ ) Returns ``true`` if ``point`` is inside ``polygon`` or if it's located exactly *on* polygon's boundary, otherwise returns ``false``. @@ -371,7 +371,7 @@ Returns ``true`` if ``point`` is inside ``polygon`` or if it's located exactly * .. rst-class:: classref-method -:ref:`bool` **is_polygon_clockwise** **(** :ref:`PackedVector2Array` polygon **)** +:ref:`bool` **is_polygon_clockwise**\ (\ polygon\: :ref:`PackedVector2Array`\ ) Returns ``true`` if ``polygon``'s vertices are ordered in clockwise order, otherwise returns ``false``. @@ -383,7 +383,7 @@ Returns ``true`` if ``polygon``'s vertices are ordered in clockwise order, other .. rst-class:: classref-method -:ref:`Variant` **line_intersects_line** **(** :ref:`Vector2` from_a, :ref:`Vector2` dir_a, :ref:`Vector2` from_b, :ref:`Vector2` dir_b **)** +:ref:`Variant` **line_intersects_line**\ (\ from_a\: :ref:`Vector2`, dir_a\: :ref:`Vector2`, from_b\: :ref:`Vector2`, dir_b\: :ref:`Vector2`\ ) Checks if the two lines (``from_a``, ``dir_a``) and (``from_b``, ``dir_b``) intersect. If yes, return the point of intersection as :ref:`Vector2`. If no intersection takes place, returns ``null``. @@ -397,7 +397,7 @@ Checks if the two lines (``from_a``, ``dir_a``) and (``from_b``, ``dir_b``) inte .. rst-class:: classref-method -:ref:`Dictionary` **make_atlas** **(** :ref:`PackedVector2Array` sizes **)** +:ref:`Dictionary` **make_atlas**\ (\ sizes\: :ref:`PackedVector2Array`\ ) Given an array of :ref:`Vector2`\ s representing tiles, builds an atlas. The returned dictionary has two keys: ``points`` is a :ref:`PackedVector2Array` that specifies the positions of each tile, ``size`` contains the overall size of the whole atlas as :ref:`Vector2i`. @@ -409,7 +409,7 @@ Given an array of :ref:`Vector2`\ s representing tiles, builds an .. rst-class:: classref-method -:ref:`PackedVector2Array[]` **merge_polygons** **(** :ref:`PackedVector2Array` polygon_a, :ref:`PackedVector2Array` polygon_b **)** +:ref:`Array`\[:ref:`PackedVector2Array`\] **merge_polygons**\ (\ polygon_a\: :ref:`PackedVector2Array`, polygon_b\: :ref:`PackedVector2Array`\ ) Merges (combines) ``polygon_a`` and ``polygon_b`` and returns an array of merged polygons. This performs :ref:`OPERATION_UNION` between polygons. @@ -423,7 +423,7 @@ The operation may result in an outer polygon (boundary) and multiple inner polyg .. rst-class:: classref-method -:ref:`PackedVector2Array[]` **offset_polygon** **(** :ref:`PackedVector2Array` polygon, :ref:`float` delta, :ref:`PolyJoinType` join_type=0 **)** +:ref:`Array`\[:ref:`PackedVector2Array`\] **offset_polygon**\ (\ polygon\: :ref:`PackedVector2Array`, delta\: :ref:`float`, join_type\: :ref:`PolyJoinType` = 0\ ) Inflates or deflates ``polygon`` by ``delta`` units (pixels). If ``delta`` is positive, makes the polygon grow outward. If ``delta`` is negative, shrinks the polygon inward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. Returns an empty array if ``delta`` is negative and the absolute value of it approximately exceeds the minimum bounding rectangle dimensions of the polygon. @@ -460,7 +460,7 @@ The operation may result in an outer polygon (boundary) and inner polygon (hole) .. rst-class:: classref-method -:ref:`PackedVector2Array[]` **offset_polyline** **(** :ref:`PackedVector2Array` polyline, :ref:`float` delta, :ref:`PolyJoinType` join_type=0, :ref:`PolyEndType` end_type=3 **)** +:ref:`Array`\[:ref:`PackedVector2Array`\] **offset_polyline**\ (\ polyline\: :ref:`PackedVector2Array`, delta\: :ref:`float`, join_type\: :ref:`PolyJoinType` = 0, end_type\: :ref:`PolyEndType` = 3\ ) Inflates or deflates ``polyline`` by ``delta`` units (pixels), producing polygons. If ``delta`` is positive, makes the polyline grow outward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. If ``delta`` is negative, returns an empty array. @@ -478,7 +478,7 @@ The operation may result in an outer polygon (boundary) and inner polygon (hole) .. rst-class:: classref-method -:ref:`bool` **point_is_inside_triangle** **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** |const| +:ref:`bool` **point_is_inside_triangle**\ (\ point\: :ref:`Vector2`, a\: :ref:`Vector2`, b\: :ref:`Vector2`, c\: :ref:`Vector2`\ ) |const| Returns if ``point`` is inside the triangle specified by ``a``, ``b`` and ``c``. @@ -490,7 +490,7 @@ Returns if ``point`` is inside the triangle specified by ``a``, ``b`` and ``c``. .. rst-class:: classref-method -:ref:`float` **segment_intersects_circle** **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** +:ref:`float` **segment_intersects_circle**\ (\ segment_from\: :ref:`Vector2`, segment_to\: :ref:`Vector2`, circle_position\: :ref:`Vector2`, circle_radius\: :ref:`float`\ ) Given the 2D segment (``segment_from``, ``segment_to``), returns the position on the segment (as a number between 0 and 1) at which the segment hits the circle that is located at position ``circle_position`` and has radius ``circle_radius``. If the segment does not intersect the circle, -1 is returned (this is also the case if the line extending the segment would intersect the circle, but the segment does not). @@ -502,7 +502,7 @@ Given the 2D segment (``segment_from``, ``segment_to``), returns the position on .. rst-class:: classref-method -:ref:`Variant` **segment_intersects_segment** **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** +:ref:`Variant` **segment_intersects_segment**\ (\ from_a\: :ref:`Vector2`, to_a\: :ref:`Vector2`, from_b\: :ref:`Vector2`, to_b\: :ref:`Vector2`\ ) Checks if the two segments (``from_a``, ``to_a``) and (``from_b``, ``to_b``) intersect. If yes, return the point of intersection as :ref:`Vector2`. If no intersection takes place, returns ``null``. @@ -514,7 +514,7 @@ Checks if the two segments (``from_a``, ``to_a``) and (``from_b``, ``to_b``) int .. rst-class:: classref-method -:ref:`PackedInt32Array` **triangulate_delaunay** **(** :ref:`PackedVector2Array` points **)** +:ref:`PackedInt32Array` **triangulate_delaunay**\ (\ points\: :ref:`PackedVector2Array`\ ) Triangulates the area specified by discrete set of ``points`` such that no point is inside the circumcircle of any resulting triangle. Returns a :ref:`PackedInt32Array` where each triangle consists of three consecutive point indices into ``points`` (i.e. the returned array will have ``n * 3`` elements, with ``n`` being the number of found triangles). If the triangulation did not succeed, an empty :ref:`PackedInt32Array` is returned. @@ -526,7 +526,7 @@ Triangulates the area specified by discrete set of ``points`` such that no point .. rst-class:: classref-method -:ref:`PackedInt32Array` **triangulate_polygon** **(** :ref:`PackedVector2Array` polygon **)** +:ref:`PackedInt32Array` **triangulate_polygon**\ (\ polygon\: :ref:`PackedVector2Array`\ ) Triangulates the polygon specified by the points in ``polygon``. Returns a :ref:`PackedInt32Array` where each triangle consists of three consecutive point indices into ``polygon`` (i.e. the returned array will have ``n * 3`` elements, with ``n`` being the number of found triangles). Output triangles will always be counter clockwise, and the contour will be flipped if it's clockwise. If the triangulation did not succeed, an empty :ref:`PackedInt32Array` is returned. @@ -537,3 +537,4 @@ Triangulates the polygon specified by the points in ``polygon``. Returns a :ref: .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_geometry3d.rst b/classes/class_geometry3d.rst index 111cf738fab..cd5ae95c1d1 100644 --- a/classes/class_geometry3d.rst +++ b/classes/class_geometry3d.rst @@ -29,37 +29,37 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Plane[]` | :ref:`build_box_planes` **(** :ref:`Vector3` extents **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Plane[]` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, Vector3.Axis axis=2 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Plane[]` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, Vector3.Axis axis=2 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`clip_polygon` **(** :ref:`PackedVector3Array` points, :ref:`Plane` plane **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`compute_convex_mesh_points` **(** :ref:`Plane[]` planes **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_closest_point_to_segment_uncapped` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`get_closest_points_between_segments` **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_triangle_barycentric_coords` **(** :ref:`Vector3` point, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`ray_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`segment_intersects_convex` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Plane[]` planes **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`segment_intersects_cylinder` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`segment_intersects_sphere` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`segment_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`tetrahedralize_delaunay` **(** :ref:`PackedVector3Array` points **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Plane`\] | :ref:`build_box_planes`\ (\ extents\: :ref:`Vector3`\ ) | + +--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Plane`\] | :ref:`build_capsule_planes`\ (\ radius\: :ref:`float`, height\: :ref:`float`, sides\: :ref:`int`, lats\: :ref:`int`, axis\: Vector3.Axis = 2\ ) | + +--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Plane`\] | :ref:`build_cylinder_planes`\ (\ radius\: :ref:`float`, height\: :ref:`float`, sides\: :ref:`int`, axis\: Vector3.Axis = 2\ ) | + +--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`clip_polygon`\ (\ points\: :ref:`PackedVector3Array`, plane\: :ref:`Plane`\ ) | + +--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`compute_convex_mesh_points`\ (\ planes\: :ref:`Array`\[:ref:`Plane`\]\ ) | + +--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_closest_point_to_segment`\ (\ point\: :ref:`Vector3`, s1\: :ref:`Vector3`, s2\: :ref:`Vector3`\ ) | + +--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_closest_point_to_segment_uncapped`\ (\ point\: :ref:`Vector3`, s1\: :ref:`Vector3`, s2\: :ref:`Vector3`\ ) | + +--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`get_closest_points_between_segments`\ (\ p1\: :ref:`Vector3`, p2\: :ref:`Vector3`, q1\: :ref:`Vector3`, q2\: :ref:`Vector3`\ ) | + +--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_triangle_barycentric_coords`\ (\ point\: :ref:`Vector3`, a\: :ref:`Vector3`, b\: :ref:`Vector3`, c\: :ref:`Vector3`\ ) | + +--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`ray_intersects_triangle`\ (\ from\: :ref:`Vector3`, dir\: :ref:`Vector3`, a\: :ref:`Vector3`, b\: :ref:`Vector3`, c\: :ref:`Vector3`\ ) | + +--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`segment_intersects_convex`\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, planes\: :ref:`Array`\[:ref:`Plane`\]\ ) | + +--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`segment_intersects_cylinder`\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, height\: :ref:`float`, radius\: :ref:`float`\ ) | + +--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`segment_intersects_sphere`\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, sphere_position\: :ref:`Vector3`, sphere_radius\: :ref:`float`\ ) | + +--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`segment_intersects_triangle`\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, a\: :ref:`Vector3`, b\: :ref:`Vector3`, c\: :ref:`Vector3`\ ) | + +--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`tetrahedralize_delaunay`\ (\ points\: :ref:`PackedVector3Array`\ ) | + +--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -74,7 +74,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Plane[]` **build_box_planes** **(** :ref:`Vector3` extents **)** +:ref:`Array`\[:ref:`Plane`\] **build_box_planes**\ (\ extents\: :ref:`Vector3`\ ) Returns an array with 6 :ref:`Plane`\ s that describe the sides of a box centered at the origin. The box size is defined by ``extents``, which represents one (positive) corner of the box (i.e. half its actual size). @@ -86,7 +86,7 @@ Returns an array with 6 :ref:`Plane`\ s that describe the sides of .. rst-class:: classref-method -:ref:`Plane[]` **build_capsule_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, Vector3.Axis axis=2 **)** +:ref:`Array`\[:ref:`Plane`\] **build_capsule_planes**\ (\ radius\: :ref:`float`, height\: :ref:`float`, sides\: :ref:`int`, lats\: :ref:`int`, axis\: Vector3.Axis = 2\ ) Returns an array of :ref:`Plane`\ s closely bounding a faceted capsule centered at the origin with radius ``radius`` and height ``height``. The parameter ``sides`` defines how many planes will be generated for the side part of the capsule, whereas ``lats`` gives the number of latitudinal steps at the bottom and top of the capsule. The parameter ``axis`` describes the axis along which the capsule is oriented (0 for X, 1 for Y, 2 for Z). @@ -98,7 +98,7 @@ Returns an array of :ref:`Plane`\ s closely bounding a faceted caps .. rst-class:: classref-method -:ref:`Plane[]` **build_cylinder_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, Vector3.Axis axis=2 **)** +:ref:`Array`\[:ref:`Plane`\] **build_cylinder_planes**\ (\ radius\: :ref:`float`, height\: :ref:`float`, sides\: :ref:`int`, axis\: Vector3.Axis = 2\ ) Returns an array of :ref:`Plane`\ s closely bounding a faceted cylinder centered at the origin with radius ``radius`` and height ``height``. The parameter ``sides`` defines how many planes will be generated for the round part of the cylinder. The parameter ``axis`` describes the axis along which the cylinder is oriented (0 for X, 1 for Y, 2 for Z). @@ -110,7 +110,7 @@ Returns an array of :ref:`Plane`\ s closely bounding a faceted cyli .. rst-class:: classref-method -:ref:`PackedVector3Array` **clip_polygon** **(** :ref:`PackedVector3Array` points, :ref:`Plane` plane **)** +:ref:`PackedVector3Array` **clip_polygon**\ (\ points\: :ref:`PackedVector3Array`, plane\: :ref:`Plane`\ ) Clips the polygon defined by the points in ``points`` against the ``plane`` and returns the points of the clipped polygon. @@ -122,7 +122,7 @@ Clips the polygon defined by the points in ``points`` against the ``plane`` and .. rst-class:: classref-method -:ref:`PackedVector3Array` **compute_convex_mesh_points** **(** :ref:`Plane[]` planes **)** +:ref:`PackedVector3Array` **compute_convex_mesh_points**\ (\ planes\: :ref:`Array`\[:ref:`Plane`\]\ ) Calculates and returns all the vertex points of a convex shape defined by an array of ``planes``. @@ -134,7 +134,7 @@ Calculates and returns all the vertex points of a convex shape defined by an arr .. rst-class:: classref-method -:ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** +:ref:`Vector3` **get_closest_point_to_segment**\ (\ point\: :ref:`Vector3`, s1\: :ref:`Vector3`, s2\: :ref:`Vector3`\ ) Returns the 3D point on the 3D segment (``s1``, ``s2``) that is closest to ``point``. The returned point will always be inside the specified segment. @@ -146,7 +146,7 @@ Returns the 3D point on the 3D segment (``s1``, ``s2``) that is closest to ``poi .. rst-class:: classref-method -:ref:`Vector3` **get_closest_point_to_segment_uncapped** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** +:ref:`Vector3` **get_closest_point_to_segment_uncapped**\ (\ point\: :ref:`Vector3`, s1\: :ref:`Vector3`, s2\: :ref:`Vector3`\ ) Returns the 3D point on the 3D line defined by (``s1``, ``s2``) that is closest to ``point``. The returned point can be inside the segment (``s1``, ``s2``) or outside of it, i.e. somewhere on the line extending from the segment. @@ -158,7 +158,7 @@ Returns the 3D point on the 3D line defined by (``s1``, ``s2``) that is closest .. rst-class:: classref-method -:ref:`PackedVector3Array` **get_closest_points_between_segments** **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** +:ref:`PackedVector3Array` **get_closest_points_between_segments**\ (\ p1\: :ref:`Vector3`, p2\: :ref:`Vector3`, q1\: :ref:`Vector3`, q2\: :ref:`Vector3`\ ) Given the two 3D segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two points on the two segments that are closest to each other. Returns a :ref:`PackedVector3Array` that contains this point on (``p1``, ``p2``) as well the accompanying point on (``q1``, ``q2``). @@ -170,7 +170,7 @@ Given the two 3D segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two .. rst-class:: classref-method -:ref:`Vector3` **get_triangle_barycentric_coords** **(** :ref:`Vector3` point, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** +:ref:`Vector3` **get_triangle_barycentric_coords**\ (\ point\: :ref:`Vector3`, a\: :ref:`Vector3`, b\: :ref:`Vector3`, c\: :ref:`Vector3`\ ) Returns a :ref:`Vector3` containing weights based on how close a 3D position (``point``) is to a triangle's different vertices (``a``, ``b`` and ``c``). This is useful for interpolating between the data of different vertices in a triangle. One example use case is using this to smoothly rotate over a mesh instead of relying solely on face normals. @@ -184,7 +184,7 @@ Returns a :ref:`Vector3` containing weights based on how close a .. rst-class:: classref-method -:ref:`Variant` **ray_intersects_triangle** **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** +:ref:`Variant` **ray_intersects_triangle**\ (\ from\: :ref:`Vector3`, dir\: :ref:`Vector3`, a\: :ref:`Vector3`, b\: :ref:`Vector3`, c\: :ref:`Vector3`\ ) Tests if the 3D ray starting at ``from`` with the direction of ``dir`` intersects the triangle specified by ``a``, ``b`` and ``c``. If yes, returns the point of intersection as :ref:`Vector3`. If no intersection takes place, returns ``null``. @@ -196,7 +196,7 @@ Tests if the 3D ray starting at ``from`` with the direction of ``dir`` intersect .. rst-class:: classref-method -:ref:`PackedVector3Array` **segment_intersects_convex** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Plane[]` planes **)** +:ref:`PackedVector3Array` **segment_intersects_convex**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, planes\: :ref:`Array`\[:ref:`Plane`\]\ ) Given a convex hull defined though the :ref:`Plane`\ s in the array ``planes``, tests if the segment (``from``, ``to``) intersects with that hull. If an intersection is found, returns a :ref:`PackedVector3Array` containing the point the intersection and the hull's normal. Otherwise, returns an empty array. @@ -208,7 +208,7 @@ Given a convex hull defined though the :ref:`Plane`\ s in the array .. rst-class:: classref-method -:ref:`PackedVector3Array` **segment_intersects_cylinder** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** +:ref:`PackedVector3Array` **segment_intersects_cylinder**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, height\: :ref:`float`, radius\: :ref:`float`\ ) Checks if the segment (``from``, ``to``) intersects the cylinder with height ``height`` that is centered at the origin and has radius ``radius``. If no, returns an empty :ref:`PackedVector3Array`. If an intersection takes place, the returned array contains the point of intersection and the cylinder's normal at the point of intersection. @@ -220,7 +220,7 @@ Checks if the segment (``from``, ``to``) intersects the cylinder with height ``h .. rst-class:: classref-method -:ref:`PackedVector3Array` **segment_intersects_sphere** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** +:ref:`PackedVector3Array` **segment_intersects_sphere**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, sphere_position\: :ref:`Vector3`, sphere_radius\: :ref:`float`\ ) Checks if the segment (``from``, ``to``) intersects the sphere that is located at ``sphere_position`` and has radius ``sphere_radius``. If no, returns an empty :ref:`PackedVector3Array`. If yes, returns a :ref:`PackedVector3Array` containing the point of intersection and the sphere's normal at the point of intersection. @@ -232,7 +232,7 @@ Checks if the segment (``from``, ``to``) intersects the sphere that is located a .. rst-class:: classref-method -:ref:`Variant` **segment_intersects_triangle** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** +:ref:`Variant` **segment_intersects_triangle**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, a\: :ref:`Vector3`, b\: :ref:`Vector3`, c\: :ref:`Vector3`\ ) Tests if the segment (``from``, ``to``) intersects the triangle ``a``, ``b``, ``c``. If yes, returns the point of intersection as :ref:`Vector3`. If no intersection takes place, returns ``null``. @@ -244,7 +244,7 @@ Tests if the segment (``from``, ``to``) intersects the triangle ``a``, ``b``, `` .. rst-class:: classref-method -:ref:`PackedInt32Array` **tetrahedralize_delaunay** **(** :ref:`PackedVector3Array` points **)** +:ref:`PackedInt32Array` **tetrahedralize_delaunay**\ (\ points\: :ref:`PackedVector3Array`\ ) Tetrahedralizes the volume specified by a discrete set of ``points`` in 3D space, ensuring that no point lies within the circumsphere of any resulting tetrahedron. The method returns a :ref:`PackedInt32Array` where each tetrahedron consists of four consecutive point indices into the ``points`` array (resulting in an array with ``n * 4`` elements, where ``n`` is the number of tetrahedra found). If the tetrahedralization is unsuccessful, an empty :ref:`PackedInt32Array` is returned. @@ -255,3 +255,4 @@ Tetrahedralizes the volume specified by a discrete set of ``points`` in 3D space .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_geometryinstance3d.rst b/classes/class_geometryinstance3d.rst index b4cc84eb457..5a175c58079 100644 --- a/classes/class_geometryinstance3d.rst +++ b/classes/class_geometryinstance3d.rst @@ -78,11 +78,11 @@ Methods .. table:: :widths: auto - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_instance_shader_parameter` **(** :ref:`StringName` name **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_instance_shader_parameter` **(** :ref:`StringName` name, :ref:`Variant` value **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_instance_shader_parameter`\ (\ name\: :ref:`StringName`\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_instance_shader_parameter`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -272,8 +272,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_cast_shadows_setting** **(** :ref:`ShadowCastingSetting` value **)** -- :ref:`ShadowCastingSetting` **get_cast_shadows_setting** **(** **)** +- |void| **set_cast_shadows_setting**\ (\ value\: :ref:`ShadowCastingSetting`\ ) +- :ref:`ShadowCastingSetting` **get_cast_shadows_setting**\ (\ ) The selected shadow casting flag. See :ref:`ShadowCastingSetting` for possible values. @@ -289,8 +289,8 @@ The selected shadow casting flag. See :ref:`ShadowCastingSetting` value **)** -- :ref:`AABB` **get_custom_aabb** **(** **)** +- |void| **set_custom_aabb**\ (\ value\: :ref:`AABB`\ ) +- :ref:`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` recalculation that happens when a skeleton is used with a :ref:`MeshInstance3D` or to have precise control over the :ref:`MeshInstance3D`'s bounding box. To use the default AABB, set value to an :ref:`AABB` with all fields set to ``0.0``. To avoid frustum culling, set :ref:`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` on the **GeometryInstance3D**'s :ref:`RID`. @@ -306,8 +306,8 @@ Overrides the bounding box of this node with a custom one. This can be used to a .. rst-class:: classref-property-setget -- void **set_extra_cull_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_extra_cull_margin** **(** **)** +- |void| **set_extra_cull_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_extra_cull_margin**\ (\ ) The extra distance added to the GeometryInstance3D's bounding box (:ref:`AABB`) to increase its cull box. @@ -323,8 +323,8 @@ The extra distance added to the GeometryInstance3D's bounding box (:ref:`AABB` value **)** -- :ref:`LightmapScale` **get_lightmap_scale** **(** **)** +- |void| **set_lightmap_scale**\ (\ value\: :ref:`LightmapScale`\ ) +- :ref:`LightmapScale` **get_lightmap_scale**\ (\ ) The texel density to use for lightmapping in :ref:`LightmapGI`. Greater scale values provide higher resolution in the lightmap, which can result in sharper shadows for lights that have both direct and indirect light baked. However, greater scale values will also increase the space taken by the mesh in the lightmap texture, which increases the memory, storage, and bake time requirements. When using a single mesh at different scales, consider adjusting this value to keep the lightmap texel density consistent across meshes. @@ -340,8 +340,8 @@ The texel density to use for lightmapping in :ref:`LightmapGI` .. rst-class:: classref-property-setget -- void **set_gi_mode** **(** :ref:`GIMode` value **)** -- :ref:`GIMode` **get_gi_mode** **(** **)** +- |void| **set_gi_mode**\ (\ value\: :ref:`GIMode`\ ) +- :ref:`GIMode` **get_gi_mode**\ (\ ) The global illumination mode to use for the whole geometry. To avoid inconsistent results, use a mode that matches the purpose of the mesh during gameplay (static/dynamic). @@ -359,8 +359,8 @@ The global illumination mode to use for the whole geometry. To avoid inconsisten .. rst-class:: classref-property-setget -- void **set_ignore_occlusion_culling** **(** :ref:`bool` value **)** -- :ref:`bool` **is_ignoring_occlusion_culling** **(** **)** +- |void| **set_ignore_occlusion_culling**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_ignoring_occlusion_culling**\ (\ ) If ``true``, disables occlusion culling for this instance. Useful for gizmos that must be rendered even when occlusion culling is in use. @@ -378,8 +378,8 @@ If ``true``, disables occlusion culling for this instance. Useful for gizmos tha .. rst-class:: classref-property-setget -- void **set_lod_bias** **(** :ref:`float` value **)** -- :ref:`float` **get_lod_bias** **(** **)** +- |void| **set_lod_bias**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_lod_bias**\ (\ ) Changes how quickly the mesh transitions to a lower level of detail. A value of 0 will force the mesh to its lowest level of detail, a value of 1 will use the default settings, and larger values will keep the mesh in a higher level of detail at farther distances. @@ -397,8 +397,8 @@ Useful for testing level of detail transitions in the editor. .. rst-class:: classref-property-setget -- void **set_material_overlay** **(** :ref:`Material` value **)** -- :ref:`Material` **get_material_overlay** **(** **)** +- |void| **set_material_overlay**\ (\ value\: :ref:`Material`\ ) +- :ref:`Material` **get_material_overlay**\ (\ ) The material overlay for the whole geometry. @@ -416,8 +416,8 @@ If a material is assigned to this property, it will be rendered on top of any ot .. rst-class:: classref-property-setget -- void **set_material_override** **(** :ref:`Material` value **)** -- :ref:`Material` **get_material_override** **(** **)** +- |void| **set_material_override**\ (\ value\: :ref:`Material`\ ) +- :ref:`Material` **get_material_override**\ (\ ) The material override for the whole geometry. @@ -435,8 +435,8 @@ If a material is assigned to this property, it will be used instead of any mater .. rst-class:: classref-property-setget -- void **set_transparency** **(** :ref:`float` value **)** -- :ref:`float` **get_transparency** **(** **)** +- |void| **set_transparency**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_transparency**\ (\ ) The transparency applied to the whole geometry (as a multiplier of the materials' existing transparency). ``0.0`` is fully opaque, while ``1.0`` is fully transparent. Values greater than ``0.0`` (exclusive) will force the geometry's materials to go through the transparent pipeline, which is slower to render and can exhibit rendering issues due to incorrect transparency sorting. However, unlike using a transparent material, setting :ref:`transparency` to a value greater than ``0.0`` (exclusive) will *not* disable shadow rendering. @@ -456,8 +456,8 @@ In spatial shaders, ``1.0 - transparency`` is set as the default value of the `` .. rst-class:: classref-property-setget -- void **set_visibility_range_begin** **(** :ref:`float` value **)** -- :ref:`float` **get_visibility_range_begin** **(** **)** +- |void| **set_visibility_range_begin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_visibility_range_begin**\ (\ ) Starting distance from which the GeometryInstance3D will be visible, taking :ref:`visibility_range_begin_margin` into account as well. The default value of 0 is used to disable the range check. @@ -473,8 +473,8 @@ Starting distance from which the GeometryInstance3D will be visible, taking :ref .. rst-class:: classref-property-setget -- void **set_visibility_range_begin_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_visibility_range_begin_margin** **(** **)** +- |void| **set_visibility_range_begin_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_visibility_range_begin_margin**\ (\ ) Margin for the :ref:`visibility_range_begin` threshold. The GeometryInstance3D will only change its visibility state when it goes over or under the :ref:`visibility_range_begin` threshold by this amount. @@ -492,8 +492,8 @@ If :ref:`visibility_range_fade_mode` value **)** -- :ref:`float` **get_visibility_range_end** **(** **)** +- |void| **set_visibility_range_end**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_visibility_range_end**\ (\ ) Distance from which the GeometryInstance3D will be hidden, taking :ref:`visibility_range_end_margin` into account as well. The default value of 0 is used to disable the range check. @@ -509,8 +509,8 @@ Distance from which the GeometryInstance3D will be hidden, taking :ref:`visibili .. rst-class:: classref-property-setget -- void **set_visibility_range_end_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_visibility_range_end_margin** **(** **)** +- |void| **set_visibility_range_end_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_visibility_range_end_margin**\ (\ ) Margin for the :ref:`visibility_range_end` threshold. The GeometryInstance3D will only change its visibility state when it goes over or under the :ref:`visibility_range_end` threshold by this amount. @@ -528,8 +528,8 @@ If :ref:`visibility_range_fade_mode` value **)** -- :ref:`VisibilityRangeFadeMode` **get_visibility_range_fade_mode** **(** **)** +- |void| **set_visibility_range_fade_mode**\ (\ value\: :ref:`VisibilityRangeFadeMode`\ ) +- :ref:`VisibilityRangeFadeMode` **get_visibility_range_fade_mode**\ (\ ) Controls which instances will be faded when approaching the limits of the visibility range. See :ref:`VisibilityRangeFadeMode` for possible values. @@ -546,7 +546,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **get_instance_shader_parameter** **(** :ref:`StringName` name **)** |const| +:ref:`Variant` **get_instance_shader_parameter**\ (\ name\: :ref:`StringName`\ ) |const| Get the value of a shader parameter as set on this instance. @@ -558,7 +558,7 @@ Get the value of a shader parameter as set on this instance. .. rst-class:: classref-method -void **set_instance_shader_parameter** **(** :ref:`StringName` name, :ref:`Variant` value **)** +|void| **set_instance_shader_parameter**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) Set the value of a shader uniform for this instance only (`per-instance uniform <../tutorials/shaders/shader_reference/shading_language.html#per-instance-uniforms>`__). See also :ref:`ShaderMaterial.set_shader_parameter` to assign a uniform on all instances using the same :ref:`ShaderMaterial`. @@ -575,3 +575,4 @@ Set the value of a shader uniform for this instance only (`per-instance uniform .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gltfaccessor.rst b/classes/class_gltfaccessor.rst index c5bfc290b16..fc6cc0952d9 100644 --- a/classes/class_gltfaccessor.rst +++ b/classes/class_gltfaccessor.rst @@ -87,8 +87,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_buffer_view** **(** :ref:`int` value **)** -- :ref:`int` **get_buffer_view** **(** **)** +- |void| **set_buffer_view**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_buffer_view**\ (\ ) The index of the buffer view this accessor is referencing. If ``-1``, this accessor is not referencing any buffer view. @@ -104,8 +104,8 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property-setget -- void **set_byte_offset** **(** :ref:`int` value **)** -- :ref:`int` **get_byte_offset** **(** **)** +- |void| **set_byte_offset**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_byte_offset**\ (\ ) .. container:: contribute @@ -123,8 +123,8 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property-setget -- void **set_component_type** **(** :ref:`int` value **)** -- :ref:`int` **get_component_type** **(** **)** +- |void| **set_component_type**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_component_type**\ (\ ) .. container:: contribute @@ -142,8 +142,8 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property-setget -- void **set_count** **(** :ref:`int` value **)** -- :ref:`int` **get_count** **(** **)** +- |void| **set_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_count**\ (\ ) .. container:: contribute @@ -161,8 +161,8 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property-setget -- void **set_max** **(** :ref:`PackedFloat64Array` value **)** -- :ref:`PackedFloat64Array` **get_max** **(** **)** +- |void| **set_max**\ (\ value\: :ref:`PackedFloat64Array`\ ) +- :ref:`PackedFloat64Array` **get_max**\ (\ ) .. container:: contribute @@ -180,8 +180,8 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property-setget -- void **set_min** **(** :ref:`PackedFloat64Array` value **)** -- :ref:`PackedFloat64Array` **get_min** **(** **)** +- |void| **set_min**\ (\ value\: :ref:`PackedFloat64Array`\ ) +- :ref:`PackedFloat64Array` **get_min**\ (\ ) .. container:: contribute @@ -199,8 +199,8 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property-setget -- void **set_normalized** **(** :ref:`bool` value **)** -- :ref:`bool` **get_normalized** **(** **)** +- |void| **set_normalized**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_normalized**\ (\ ) .. container:: contribute @@ -218,8 +218,8 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property-setget -- void **set_sparse_count** **(** :ref:`int` value **)** -- :ref:`int` **get_sparse_count** **(** **)** +- |void| **set_sparse_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_sparse_count**\ (\ ) .. container:: contribute @@ -237,8 +237,8 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property-setget -- void **set_sparse_indices_buffer_view** **(** :ref:`int` value **)** -- :ref:`int` **get_sparse_indices_buffer_view** **(** **)** +- |void| **set_sparse_indices_buffer_view**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_sparse_indices_buffer_view**\ (\ ) .. container:: contribute @@ -256,8 +256,8 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property-setget -- void **set_sparse_indices_byte_offset** **(** :ref:`int` value **)** -- :ref:`int` **get_sparse_indices_byte_offset** **(** **)** +- |void| **set_sparse_indices_byte_offset**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_sparse_indices_byte_offset**\ (\ ) .. container:: contribute @@ -275,8 +275,8 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property-setget -- void **set_sparse_indices_component_type** **(** :ref:`int` value **)** -- :ref:`int` **get_sparse_indices_component_type** **(** **)** +- |void| **set_sparse_indices_component_type**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_sparse_indices_component_type**\ (\ ) .. container:: contribute @@ -294,8 +294,8 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property-setget -- void **set_sparse_values_buffer_view** **(** :ref:`int` value **)** -- :ref:`int` **get_sparse_values_buffer_view** **(** **)** +- |void| **set_sparse_values_buffer_view**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_sparse_values_buffer_view**\ (\ ) .. container:: contribute @@ -313,8 +313,8 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property-setget -- void **set_sparse_values_byte_offset** **(** :ref:`int` value **)** -- :ref:`int` **get_sparse_values_byte_offset** **(** **)** +- |void| **set_sparse_values_byte_offset**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_sparse_values_byte_offset**\ (\ ) .. container:: contribute @@ -332,8 +332,8 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. rst-class:: classref-property-setget -- void **set_type** **(** :ref:`int` value **)** -- :ref:`int` **get_type** **(** **)** +- |void| **set_type**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_type**\ (\ ) .. container:: contribute @@ -346,3 +346,4 @@ The index of the buffer view this accessor is referencing. If ``-1``, this acces .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gltfanimation.rst b/classes/class_gltfanimation.rst index 7959e1f2a35..8a47f1aa5bd 100644 --- a/classes/class_gltfanimation.rst +++ b/classes/class_gltfanimation.rst @@ -31,9 +31,25 @@ Properties .. table:: :widths: auto - +-------------------------+------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`loop` | ``false`` | - +-------------------------+------------------------------------------------+-----------+ + +-----------------------------+------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`loop` | ``false`` | + +-----------------------------+------------------------------------------------------------------+-----------+ + | :ref:`String` | :ref:`original_name` | ``""`` | + +-----------------------------+------------------------------------------------------------------+-----------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_additional_data`\ (\ extension_name\: :ref:`StringName`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_additional_data`\ (\ extension_name\: :ref:`StringName`, additional_data\: :ref:`Variant`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -52,13 +68,63 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_loop** **(** :ref:`bool` value **)** -- :ref:`bool` **get_loop** **(** **)** +- |void| **set_loop**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_loop**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFAnimation_property_original_name: + +.. rst-class:: classref-property + +:ref:`String` **original_name** = ``""`` + +.. rst-class:: classref-property-setget + +- |void| **set_original_name**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_original_name**\ (\ ) + +The original name of the animation. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_GLTFAnimation_method_get_additional_data: + +.. rst-class:: classref-method + +:ref:`Variant` **get_additional_data**\ (\ extension_name\: :ref:`StringName`\ ) + +Gets additional arbitrary data in this **GLTFAnimation** instance. This can be used to keep per-node state data in :ref:`GLTFDocumentExtension` classes, which is important because they are stateless. + +The argument should be the :ref:`GLTFDocumentExtension` name (does not have to match the extension name in the GLTF file), and the return value can be anything you set. If nothing was set, the return value is null. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFAnimation_method_set_additional_data: + +.. rst-class:: classref-method + +|void| **set_additional_data**\ (\ extension_name\: :ref:`StringName`, additional_data\: :ref:`Variant`\ ) + +Sets additional arbitrary data in this **GLTFAnimation** instance. This can be used to keep per-node state data in :ref:`GLTFDocumentExtension` classes, which is important because they are stateless. + +The first argument should be the :ref:`GLTFDocumentExtension` name (does not have to match the extension name in the GLTF file), and the second argument can be anything you want. + .. |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.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` @@ -66,3 +132,4 @@ Property Descriptions .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gltfbufferview.rst b/classes/class_gltfbufferview.rst index 154e3d3f10b..0025cd3f51b 100644 --- a/classes/class_gltfbufferview.rst +++ b/classes/class_gltfbufferview.rst @@ -60,9 +60,9 @@ Methods .. table:: :widths: auto - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`load_buffer_view_data` **(** :ref:`GLTFState` state **)** |const| | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`load_buffer_view_data`\ (\ state\: :ref:`GLTFState`\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -81,8 +81,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_buffer** **(** :ref:`int` value **)** -- :ref:`int` **get_buffer** **(** **)** +- |void| **set_buffer**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_buffer**\ (\ ) The index of the buffer this buffer view is referencing. If ``-1``, this buffer view is not referencing any buffer. @@ -98,8 +98,8 @@ The index of the buffer this buffer view is referencing. If ``-1``, this buffer .. rst-class:: classref-property-setget -- void **set_byte_length** **(** :ref:`int` value **)** -- :ref:`int` **get_byte_length** **(** **)** +- |void| **set_byte_length**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_byte_length**\ (\ ) The length, in bytes, of this buffer view. If ``0``, this buffer view is empty. @@ -115,8 +115,8 @@ The length, in bytes, of this buffer view. If ``0``, this buffer view is empty. .. rst-class:: classref-property-setget -- void **set_byte_offset** **(** :ref:`int` value **)** -- :ref:`int` **get_byte_offset** **(** **)** +- |void| **set_byte_offset**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_byte_offset**\ (\ ) The offset, in bytes, from the start of the buffer to the start of this buffer view. @@ -132,8 +132,8 @@ The offset, in bytes, from the start of the buffer to the start of this buffer v .. rst-class:: classref-property-setget -- void **set_byte_stride** **(** :ref:`int` value **)** -- :ref:`int` **get_byte_stride** **(** **)** +- |void| **set_byte_stride**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_byte_stride**\ (\ ) The stride, in bytes, between interleaved data. If ``-1``, this buffer view is not interleaved. @@ -149,8 +149,8 @@ The stride, in bytes, between interleaved data. If ``-1``, this buffer view is n .. rst-class:: classref-property-setget -- void **set_indices** **(** :ref:`bool` value **)** -- :ref:`bool` **get_indices** **(** **)** +- |void| **set_indices**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_indices**\ (\ ) True if the GLTFBufferView's OpenGL GPU buffer type is an ``ELEMENT_ARRAY_BUFFER`` used for vertex indices (integer constant ``34963``). False if the buffer type is ``ARRAY_BUFFER`` used for vertex attributes (integer constant ``34962``) or when any other value. See `Buffers, BufferViews, and Accessors `__ for possible values. This property is set but never used, setting this property will do nothing. @@ -167,7 +167,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedByteArray` **load_buffer_view_data** **(** :ref:`GLTFState` state **)** |const| +:ref:`PackedByteArray` **load_buffer_view_data**\ (\ state\: :ref:`GLTFState`\ ) |const| Loads the buffer view data from the buffer referenced by this buffer view in the given :ref:`GLTFState`. Interleaved data with a byte stride is not yet supported by this method. The data is returned as a :ref:`PackedByteArray`. @@ -178,3 +178,4 @@ Loads the buffer view data from the buffer referenced by this buffer view in the .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gltfcamera.rst b/classes/class_gltfcamera.rst index ec53168547f..8251f6215bf 100644 --- a/classes/class_gltfcamera.rst +++ b/classes/class_gltfcamera.rst @@ -60,15 +60,15 @@ Methods .. table:: :widths: auto - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GLTFCamera` | :ref:`from_dictionary` **(** :ref:`Dictionary` dictionary **)** |static| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GLTFCamera` | :ref:`from_node` **(** :ref:`Camera3D` camera_node **)** |static| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`to_dictionary` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Camera3D` | :ref:`to_node` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GLTFCamera` | :ref:`from_dictionary`\ (\ dictionary\: :ref:`Dictionary`\ ) |static| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GLTFCamera` | :ref:`from_node`\ (\ camera_node\: :ref:`Camera3D`\ ) |static| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`to_dictionary`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Camera3D` | :ref:`to_node`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -87,8 +87,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_depth_far** **(** :ref:`float` value **)** -- :ref:`float` **get_depth_far** **(** **)** +- |void| **set_depth_far**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_depth_far**\ (\ ) The distance to the far culling boundary for this camera relative to its local Z axis, in meters. This maps to GLTF's ``zfar`` property. @@ -104,8 +104,8 @@ The distance to the far culling boundary for this camera relative to its local Z .. rst-class:: classref-property-setget -- void **set_depth_near** **(** :ref:`float` value **)** -- :ref:`float` **get_depth_near** **(** **)** +- |void| **set_depth_near**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_depth_near**\ (\ ) The distance to the near culling boundary for this camera relative to its local Z axis, in meters. This maps to GLTF's ``znear`` property. @@ -121,8 +121,8 @@ The distance to the near culling boundary for this camera relative to its local .. rst-class:: classref-property-setget -- void **set_fov** **(** :ref:`float` value **)** -- :ref:`float` **get_fov** **(** **)** +- |void| **set_fov**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fov**\ (\ ) The FOV of the camera. This class and GLTF define the camera FOV in radians, while Godot uses degrees. This maps to GLTF's ``yfov`` property. This value is only used for perspective cameras, when :ref:`perspective` is true. @@ -138,8 +138,8 @@ The FOV of the camera. This class and GLTF define the camera FOV in radians, whi .. rst-class:: classref-property-setget -- void **set_perspective** **(** :ref:`bool` value **)** -- :ref:`bool` **get_perspective** **(** **)** +- |void| **set_perspective**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_perspective**\ (\ ) Whether or not the camera is in perspective mode. If false, the camera is in orthographic/orthogonal mode. This maps to GLTF's camera ``type`` property. See :ref:`Camera3D.projection` and the GLTF spec for more information. @@ -155,8 +155,8 @@ Whether or not the camera is in perspective mode. If false, the camera is in ort .. rst-class:: classref-property-setget -- void **set_size_mag** **(** :ref:`float` value **)** -- :ref:`float` **get_size_mag** **(** **)** +- |void| **set_size_mag**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_size_mag**\ (\ ) The size of the camera. This class and GLTF define the camera size magnitude as a radius in meters, while Godot defines it as a diameter in meters. This maps to GLTF's ``ymag`` property. This value is only used for orthographic/orthogonal cameras, when :ref:`perspective` is false. @@ -173,7 +173,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`GLTFCamera` **from_dictionary** **(** :ref:`Dictionary` dictionary **)** |static| +:ref:`GLTFCamera` **from_dictionary**\ (\ dictionary\: :ref:`Dictionary`\ ) |static| Creates a new GLTFCamera instance by parsing the given :ref:`Dictionary`. @@ -185,7 +185,7 @@ Creates a new GLTFCamera instance by parsing the given :ref:`Dictionary` **from_node** **(** :ref:`Camera3D` camera_node **)** |static| +:ref:`GLTFCamera` **from_node**\ (\ camera_node\: :ref:`Camera3D`\ ) |static| Create a new GLTFCamera instance from the given Godot :ref:`Camera3D` node. @@ -197,7 +197,7 @@ Create a new GLTFCamera instance from the given Godot :ref:`Camera3D` **to_dictionary** **(** **)** |const| +:ref:`Dictionary` **to_dictionary**\ (\ ) |const| Serializes this GLTFCamera instance into a :ref:`Dictionary`. @@ -209,7 +209,7 @@ Serializes this GLTFCamera instance into a :ref:`Dictionary`. .. rst-class:: classref-method -:ref:`Camera3D` **to_node** **(** **)** |const| +:ref:`Camera3D` **to_node**\ (\ ) |const| Converts this GLTFCamera instance into a Godot :ref:`Camera3D` node. @@ -220,3 +220,4 @@ Converts this GLTFCamera instance into a Godot :ref:`Camera3D` n .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gltfdocument.rst b/classes/class_gltfdocument.rst index 917505eb724..42251b280c4 100644 --- a/classes/class_gltfdocument.rst +++ b/classes/class_gltfdocument.rst @@ -12,6 +12,8 @@ GLTFDocument **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +**Inherited By:** :ref:`FBXDocument` + Class for importing and exporting glTF files in and out of Godot. .. rst-class:: classref-introduction-group @@ -60,23 +62,23 @@ Methods .. table:: :widths: auto - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`append_from_buffer` **(** :ref:`PackedByteArray` bytes, :ref:`String` base_path, :ref:`GLTFState` state, :ref:`int` flags=0 **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`append_from_file` **(** :ref:`String` path, :ref:`GLTFState` state, :ref:`int` flags=0, :ref:`String` base_path="" **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`append_from_scene` **(** :ref:`Node` node, :ref:`GLTFState` state, :ref:`int` flags=0 **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`generate_buffer` **(** :ref:`GLTFState` state **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`generate_scene` **(** :ref:`GLTFState` state, :ref:`float` bake_fps=30, :ref:`bool` trimming=false, :ref:`bool` remove_immutable_tracks=true **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`register_gltf_document_extension` **(** :ref:`GLTFDocumentExtension` extension, :ref:`bool` first_priority=false **)** |static| | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`unregister_gltf_document_extension` **(** :ref:`GLTFDocumentExtension` extension **)** |static| | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`write_to_filesystem` **(** :ref:`GLTFState` state, :ref:`String` path **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`append_from_buffer`\ (\ bytes\: :ref:`PackedByteArray`, base_path\: :ref:`String`, state\: :ref:`GLTFState`, flags\: :ref:`int` = 0\ ) | + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`append_from_file`\ (\ path\: :ref:`String`, state\: :ref:`GLTFState`, flags\: :ref:`int` = 0, base_path\: :ref:`String` = ""\ ) | + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`append_from_scene`\ (\ node\: :ref:`Node`, state\: :ref:`GLTFState`, flags\: :ref:`int` = 0\ ) | + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`generate_buffer`\ (\ state\: :ref:`GLTFState`\ ) | + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`generate_scene`\ (\ state\: :ref:`GLTFState`, bake_fps\: :ref:`float` = 30, trimming\: :ref:`bool` = false, remove_immutable_tracks\: :ref:`bool` = true\ ) | + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_gltf_document_extension`\ (\ extension\: :ref:`GLTFDocumentExtension`, first_priority\: :ref:`bool` = false\ ) |static| | + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unregister_gltf_document_extension`\ (\ extension\: :ref:`GLTFDocumentExtension`\ ) |static| | + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`write_to_filesystem`\ (\ state\: :ref:`GLTFState`, path\: :ref:`String`\ ) | + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -134,8 +136,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_image_format** **(** :ref:`String` value **)** -- :ref:`String` **get_image_format** **(** **)** +- |void| **set_image_format**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_image_format**\ (\ ) The user-friendly name of the export image format. This is used when exporting the GLTF file, including writing to a file and writing to a byte array. @@ -153,8 +155,8 @@ By default, Godot allows the following options: "None", "PNG", "JPEG", "Lossless .. rst-class:: classref-property-setget -- void **set_lossy_quality** **(** :ref:`float` value **)** -- :ref:`float` **get_lossy_quality** **(** **)** +- |void| **set_lossy_quality**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_lossy_quality**\ (\ ) If :ref:`image_format` is a lossy image format, this determines the lossy quality of the image. On a range of ``0.0`` to ``1.0``, where ``0.0`` is the lowest quality and ``1.0`` is the highest quality. A lossy quality of ``1.0`` is not the same as lossless. @@ -170,8 +172,8 @@ If :ref:`image_format` is a lossy imag .. rst-class:: classref-property-setget -- void **set_root_node_mode** **(** :ref:`RootNodeMode` value **)** -- :ref:`RootNodeMode` **get_root_node_mode** **(** **)** +- |void| **set_root_node_mode**\ (\ value\: :ref:`RootNodeMode`\ ) +- :ref:`RootNodeMode` **get_root_node_mode**\ (\ ) How to process the root node during export. See :ref:`RootNodeMode` for details. The default and recommended value is :ref:`ROOT_NODE_MODE_SINGLE_ROOT`. @@ -190,7 +192,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **append_from_buffer** **(** :ref:`PackedByteArray` bytes, :ref:`String` base_path, :ref:`GLTFState` state, :ref:`int` flags=0 **)** +:ref:`Error` **append_from_buffer**\ (\ bytes\: :ref:`PackedByteArray`, base_path\: :ref:`String`, state\: :ref:`GLTFState`, flags\: :ref:`int` = 0\ ) Takes a :ref:`PackedByteArray` defining a GLTF and imports the data to the given :ref:`GLTFState` object through the ``state`` parameter. @@ -204,7 +206,7 @@ Takes a :ref:`PackedByteArray` defining a GLTF and import .. rst-class:: classref-method -:ref:`Error` **append_from_file** **(** :ref:`String` path, :ref:`GLTFState` state, :ref:`int` flags=0, :ref:`String` base_path="" **)** +:ref:`Error` **append_from_file**\ (\ path\: :ref:`String`, state\: :ref:`GLTFState`, flags\: :ref:`int` = 0, base_path\: :ref:`String` = ""\ ) Takes a path to a GLTF file and imports the data at that file path to the given :ref:`GLTFState` object through the ``state`` parameter. @@ -218,7 +220,7 @@ Takes a path to a GLTF file and imports the data at that file path to the given .. rst-class:: classref-method -:ref:`Error` **append_from_scene** **(** :ref:`Node` node, :ref:`GLTFState` state, :ref:`int` flags=0 **)** +:ref:`Error` **append_from_scene**\ (\ node\: :ref:`Node`, state\: :ref:`GLTFState`, flags\: :ref:`int` = 0\ ) Takes a Godot Engine scene node and exports it and its descendants to the given :ref:`GLTFState` object through the ``state`` parameter. @@ -230,7 +232,7 @@ Takes a Godot Engine scene node and exports it and its descendants to the given .. rst-class:: classref-method -:ref:`PackedByteArray` **generate_buffer** **(** :ref:`GLTFState` state **)** +:ref:`PackedByteArray` **generate_buffer**\ (\ state\: :ref:`GLTFState`\ ) Takes a :ref:`GLTFState` object through the ``state`` parameter and returns a GLTF :ref:`PackedByteArray`. @@ -242,7 +244,7 @@ Takes a :ref:`GLTFState` object through the ``state`` parameter .. rst-class:: classref-method -:ref:`Node` **generate_scene** **(** :ref:`GLTFState` state, :ref:`float` bake_fps=30, :ref:`bool` trimming=false, :ref:`bool` remove_immutable_tracks=true **)** +:ref:`Node` **generate_scene**\ (\ state\: :ref:`GLTFState`, bake_fps\: :ref:`float` = 30, trimming\: :ref:`bool` = false, remove_immutable_tracks\: :ref:`bool` = true\ ) Takes a :ref:`GLTFState` object through the ``state`` parameter and returns a Godot Engine scene node. @@ -254,7 +256,7 @@ Takes a :ref:`GLTFState` object through the ``state`` parameter .. rst-class:: classref-method -void **register_gltf_document_extension** **(** :ref:`GLTFDocumentExtension` extension, :ref:`bool` first_priority=false **)** |static| +|void| **register_gltf_document_extension**\ (\ extension\: :ref:`GLTFDocumentExtension`, first_priority\: :ref:`bool` = false\ ) |static| Registers the given :ref:`GLTFDocumentExtension` instance with GLTFDocument. If ``first_priority`` is true, this extension will be run first. Otherwise, it will be run last. @@ -268,7 +270,7 @@ Registers the given :ref:`GLTFDocumentExtension` in .. rst-class:: classref-method -void **unregister_gltf_document_extension** **(** :ref:`GLTFDocumentExtension` extension **)** |static| +|void| **unregister_gltf_document_extension**\ (\ extension\: :ref:`GLTFDocumentExtension`\ ) |static| Unregisters the given :ref:`GLTFDocumentExtension` instance. @@ -280,7 +282,7 @@ Unregisters the given :ref:`GLTFDocumentExtension` .. rst-class:: classref-method -:ref:`Error` **write_to_filesystem** **(** :ref:`GLTFState` state, :ref:`String` path **)** +:ref:`Error` **write_to_filesystem**\ (\ state\: :ref:`GLTFState`, path\: :ref:`String`\ ) Takes a :ref:`GLTFState` object through the ``state`` parameter and writes a glTF file to the filesystem. @@ -293,3 +295,4 @@ Takes a :ref:`GLTFState` object through the ``state`` parameter .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gltfdocumentextension.rst b/classes/class_gltfdocumentextension.rst index c05a4386230..3669a2f6b76 100644 --- a/classes/class_gltfdocumentextension.rst +++ b/classes/class_gltfdocumentextension.rst @@ -42,45 +42,45 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_convert_scene_node` **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Node` scene_node **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_export_node` **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Dictionary` json, :ref:`Node` node **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_export_post` **(** :ref:`GLTFState` state **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_export_preflight` **(** :ref:`GLTFState` state, :ref:`Node` root **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_export_preserialize` **(** :ref:`GLTFState` state **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node3D` | :ref:`_generate_scene_node` **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Node` scene_parent **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_image_file_extension` **(** **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_saveable_image_formats` **(** **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_supported_extensions` **(** **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_import_node` **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Dictionary` json, :ref:`Node` node **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_import_post` **(** :ref:`GLTFState` state, :ref:`Node` root **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_import_post_parse` **(** :ref:`GLTFState` state **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_import_preflight` **(** :ref:`GLTFState` state, :ref:`PackedStringArray` extensions **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_parse_image_data` **(** :ref:`GLTFState` state, :ref:`PackedByteArray` image_data, :ref:`String` mime_type, :ref:`Image` ret_image **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_parse_node_extensions` **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Dictionary` extensions **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_parse_texture_json` **(** :ref:`GLTFState` state, :ref:`Dictionary` texture_json, :ref:`GLTFTexture` ret_gltf_texture **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_save_image_at_path` **(** :ref:`GLTFState` state, :ref:`Image` image, :ref:`String` file_path, :ref:`String` image_format, :ref:`float` lossy_quality **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`_serialize_image_to_bytes` **(** :ref:`GLTFState` state, :ref:`Image` image, :ref:`Dictionary` image_dict, :ref:`String` image_format, :ref:`float` lossy_quality **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_serialize_texture_json` **(** :ref:`GLTFState` state, :ref:`Dictionary` texture_json, :ref:`GLTFTexture` gltf_texture, :ref:`String` image_format **)** |virtual| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_convert_scene_node`\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, scene_node\: :ref:`Node`\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_export_node`\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, json\: :ref:`Dictionary`, node\: :ref:`Node`\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_export_post`\ (\ state\: :ref:`GLTFState`\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_export_preflight`\ (\ state\: :ref:`GLTFState`, root\: :ref:`Node`\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_export_preserialize`\ (\ state\: :ref:`GLTFState`\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node3D` | :ref:`_generate_scene_node`\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, scene_parent\: :ref:`Node`\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_image_file_extension`\ (\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_saveable_image_formats`\ (\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_supported_extensions`\ (\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_import_node`\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, json\: :ref:`Dictionary`, node\: :ref:`Node`\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_import_post`\ (\ state\: :ref:`GLTFState`, root\: :ref:`Node`\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_import_post_parse`\ (\ state\: :ref:`GLTFState`\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_import_preflight`\ (\ state\: :ref:`GLTFState`, extensions\: :ref:`PackedStringArray`\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_parse_image_data`\ (\ state\: :ref:`GLTFState`, image_data\: :ref:`PackedByteArray`, mime_type\: :ref:`String`, ret_image\: :ref:`Image`\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_parse_node_extensions`\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, extensions\: :ref:`Dictionary`\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_parse_texture_json`\ (\ state\: :ref:`GLTFState`, texture_json\: :ref:`Dictionary`, ret_gltf_texture\: :ref:`GLTFTexture`\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_save_image_at_path`\ (\ state\: :ref:`GLTFState`, image\: :ref:`Image`, file_path\: :ref:`String`, image_format\: :ref:`String`, lossy_quality\: :ref:`float`\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`_serialize_image_to_bytes`\ (\ state\: :ref:`GLTFState`, image\: :ref:`Image`, image_dict\: :ref:`Dictionary`, image_format\: :ref:`String`, lossy_quality\: :ref:`float`\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_serialize_texture_json`\ (\ state\: :ref:`GLTFState`, texture_json\: :ref:`Dictionary`, gltf_texture\: :ref:`GLTFTexture`, image_format\: :ref:`String`\ ) |virtual| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -95,7 +95,7 @@ Method Descriptions .. rst-class:: classref-method -void **_convert_scene_node** **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Node` scene_node **)** |virtual| +|void| **_convert_scene_node**\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, scene_node\: :ref:`Node`\ ) |virtual| Part of the export process. This method is run after :ref:`_export_preflight` and before :ref:`_export_preserialize`. @@ -109,7 +109,7 @@ Runs when converting the data from a Godot scene node. This method can be used t .. rst-class:: classref-method -:ref:`Error` **_export_node** **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Dictionary` json, :ref:`Node` node **)** |virtual| +:ref:`Error` **_export_node**\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, json\: :ref:`Dictionary`, node\: :ref:`Node`\ ) |virtual| Part of the export process. This method is run after :ref:`_get_saveable_image_formats` and before :ref:`_export_post`. If this **GLTFDocumentExtension** is used for exporting images, this runs after :ref:`_serialize_texture_json`. @@ -123,7 +123,7 @@ This method can be used to modify the final JSON of each node. Data should be pr .. rst-class:: classref-method -:ref:`Error` **_export_post** **(** :ref:`GLTFState` state **)** |virtual| +:ref:`Error` **_export_post**\ (\ state\: :ref:`GLTFState`\ ) |virtual| Part of the export process. This method is run last, after all other parts of the export process. @@ -137,7 +137,7 @@ This method can be used to modify the final JSON of the generated GLTF file. .. rst-class:: classref-method -:ref:`Error` **_export_preflight** **(** :ref:`GLTFState` state, :ref:`Node` root **)** |virtual| +:ref:`Error` **_export_preflight**\ (\ state\: :ref:`GLTFState`, root\: :ref:`Node`\ ) |virtual| Part of the export process. This method is run first, before all other parts of the export process. @@ -151,7 +151,7 @@ The return value is used to determine if this **GLTFDocumentExtension** instance .. rst-class:: classref-method -:ref:`Error` **_export_preserialize** **(** :ref:`GLTFState` state **)** |virtual| +:ref:`Error` **_export_preserialize**\ (\ state\: :ref:`GLTFState`\ ) |virtual| Part of the export process. This method is run after :ref:`_convert_scene_node` and before :ref:`_get_saveable_image_formats`. @@ -165,7 +165,7 @@ This method can be used to alter the state before performing serialization. It r .. rst-class:: classref-method -:ref:`Node3D` **_generate_scene_node** **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Node` scene_parent **)** |virtual| +:ref:`Node3D` **_generate_scene_node**\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, scene_parent\: :ref:`Node`\ ) |virtual| Part of the import process. This method is run after :ref:`_import_post_parse` and before :ref:`_import_node`. @@ -181,7 +181,7 @@ Runs when generating a Godot scene node from a GLTFNode. The returned node will .. rst-class:: classref-method -:ref:`String` **_get_image_file_extension** **(** **)** |virtual| +:ref:`String` **_get_image_file_extension**\ (\ ) |virtual| Returns the file extension to use for saving image data into, for example, ``".png"``. If defined, when this extension is used to handle images, and the images are saved to a separate file, the image bytes will be copied to a file with this extension. If this is set, there should be a :ref:`ResourceImporter` class able to import the file. If not defined or empty, Godot will save the image into a PNG file. @@ -193,7 +193,7 @@ Returns the file extension to use for saving image data into, for example, ``".p .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_saveable_image_formats** **(** **)** |virtual| +:ref:`PackedStringArray` **_get_saveable_image_formats**\ (\ ) |virtual| Part of the export process. This method is run after :ref:`_convert_scene_node` and before :ref:`_export_node`. @@ -207,7 +207,7 @@ Returns an array of the image formats that can be saved/exported by this extensi .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_supported_extensions** **(** **)** |virtual| +:ref:`PackedStringArray` **_get_supported_extensions**\ (\ ) |virtual| Part of the import process. This method is run after :ref:`_import_preflight` and before :ref:`_parse_node_extensions`. @@ -221,7 +221,7 @@ Returns an array of the GLTF extensions supported by this GLTFDocumentExtension .. rst-class:: classref-method -:ref:`Error` **_import_node** **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Dictionary` json, :ref:`Node` node **)** |virtual| +:ref:`Error` **_import_node**\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, json\: :ref:`Dictionary`, node\: :ref:`Node`\ ) |virtual| Part of the import process. This method is run after :ref:`_generate_scene_node` and before :ref:`_import_post`. @@ -235,7 +235,7 @@ This method can be used to make modifications to each of the generated Godot sce .. rst-class:: classref-method -:ref:`Error` **_import_post** **(** :ref:`GLTFState` state, :ref:`Node` root **)** |virtual| +:ref:`Error` **_import_post**\ (\ state\: :ref:`GLTFState`, root\: :ref:`Node`\ ) |virtual| Part of the import process. This method is run last, after all other parts of the import process. @@ -249,7 +249,7 @@ This method can be used to modify the final Godot scene generated by the import .. rst-class:: classref-method -:ref:`Error` **_import_post_parse** **(** :ref:`GLTFState` state **)** |virtual| +:ref:`Error` **_import_post_parse**\ (\ state\: :ref:`GLTFState`\ ) |virtual| Part of the import process. This method is run after :ref:`_parse_node_extensions` and before :ref:`_generate_scene_node`. @@ -263,7 +263,7 @@ This method can be used to modify any of the data imported so far after parsing, .. rst-class:: classref-method -:ref:`Error` **_import_preflight** **(** :ref:`GLTFState` state, :ref:`PackedStringArray` extensions **)** |virtual| +:ref:`Error` **_import_preflight**\ (\ state\: :ref:`GLTFState`, extensions\: :ref:`PackedStringArray`\ ) |virtual| Part of the import process. This method is run first, before all other parts of the import process. @@ -277,7 +277,7 @@ The return value is used to determine if this **GLTFDocumentExtension** instance .. rst-class:: classref-method -:ref:`Error` **_parse_image_data** **(** :ref:`GLTFState` state, :ref:`PackedByteArray` image_data, :ref:`String` mime_type, :ref:`Image` ret_image **)** |virtual| +:ref:`Error` **_parse_image_data**\ (\ state\: :ref:`GLTFState`, image_data\: :ref:`PackedByteArray`, mime_type\: :ref:`String`, ret_image\: :ref:`Image`\ ) |virtual| Part of the import process. This method is run after :ref:`_parse_node_extensions` and before :ref:`_parse_texture_json`. @@ -291,7 +291,7 @@ Runs when parsing image data from a GLTF file. The data could be sourced from a .. rst-class:: classref-method -:ref:`Error` **_parse_node_extensions** **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Dictionary` extensions **)** |virtual| +:ref:`Error` **_parse_node_extensions**\ (\ state\: :ref:`GLTFState`, gltf_node\: :ref:`GLTFNode`, extensions\: :ref:`Dictionary`\ ) |virtual| Part of the import process. This method is run after :ref:`_get_supported_extensions` and before :ref:`_import_post_parse`. @@ -305,7 +305,7 @@ Runs when parsing the node extensions of a GLTFNode. This method can be used to .. rst-class:: classref-method -:ref:`Error` **_parse_texture_json** **(** :ref:`GLTFState` state, :ref:`Dictionary` texture_json, :ref:`GLTFTexture` ret_gltf_texture **)** |virtual| +:ref:`Error` **_parse_texture_json**\ (\ state\: :ref:`GLTFState`, texture_json\: :ref:`Dictionary`, ret_gltf_texture\: :ref:`GLTFTexture`\ ) |virtual| Part of the import process. This method is run after :ref:`_parse_image_data` and before :ref:`_generate_scene_node`. @@ -319,7 +319,7 @@ Runs when parsing the texture JSON from the GLTF textures array. This can be use .. rst-class:: classref-method -:ref:`Error` **_save_image_at_path** **(** :ref:`GLTFState` state, :ref:`Image` image, :ref:`String` file_path, :ref:`String` image_format, :ref:`float` lossy_quality **)** |virtual| +:ref:`Error` **_save_image_at_path**\ (\ state\: :ref:`GLTFState`, image\: :ref:`Image`, file_path\: :ref:`String`, image_format\: :ref:`String`, lossy_quality\: :ref:`float`\ ) |virtual| Part of the export process. This method is run after :ref:`_get_saveable_image_formats` and before :ref:`_serialize_texture_json`. @@ -333,7 +333,7 @@ This method is run when saving images separately from the GLTF file. When images .. rst-class:: classref-method -:ref:`PackedByteArray` **_serialize_image_to_bytes** **(** :ref:`GLTFState` state, :ref:`Image` image, :ref:`Dictionary` image_dict, :ref:`String` image_format, :ref:`float` lossy_quality **)** |virtual| +:ref:`PackedByteArray` **_serialize_image_to_bytes**\ (\ state\: :ref:`GLTFState`, image\: :ref:`Image`, image_dict\: :ref:`Dictionary`, image_format\: :ref:`String`, lossy_quality\: :ref:`float`\ ) |virtual| Part of the export process. This method is run after :ref:`_get_saveable_image_formats` and before :ref:`_serialize_texture_json`. @@ -349,7 +349,7 @@ This method must set the image MIME type in the ``image_dict`` with the ``"mimeT .. rst-class:: classref-method -:ref:`Error` **_serialize_texture_json** **(** :ref:`GLTFState` state, :ref:`Dictionary` texture_json, :ref:`GLTFTexture` gltf_texture, :ref:`String` image_format **)** |virtual| +:ref:`Error` **_serialize_texture_json**\ (\ state\: :ref:`GLTFState`, texture_json\: :ref:`Dictionary`, gltf_texture\: :ref:`GLTFTexture`, image_format\: :ref:`String`\ ) |virtual| Part of the export process. This method is run after :ref:`_save_image_at_path` or :ref:`_serialize_image_to_bytes`, and before :ref:`_export_node`. Note that this method only runs when this **GLTFDocumentExtension** is selected as the image exporter. @@ -362,3 +362,4 @@ This method can be used to set up the extensions for the texture JSON by editing .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gltfdocumentextensionconvertimportermesh.rst b/classes/class_gltfdocumentextensionconvertimportermesh.rst index 08e01476bf6..4df51759a0a 100644 --- a/classes/class_gltfdocumentextensionconvertimportermesh.rst +++ b/classes/class_gltfdocumentextensionconvertimportermesh.rst @@ -30,3 +30,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gltflight.rst b/classes/class_gltflight.rst index a8bed0c99a0..b9aa8c29542 100644 --- a/classes/class_gltflight.rst +++ b/classes/class_gltflight.rst @@ -60,15 +60,19 @@ Methods .. table:: :widths: auto - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GLTFLight` | :ref:`from_dictionary` **(** :ref:`Dictionary` dictionary **)** |static| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GLTFLight` | :ref:`from_node` **(** :ref:`Light3D` light_node **)** |static| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`to_dictionary` **(** **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Light3D` | :ref:`to_node` **(** **)** |const| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GLTFLight` | :ref:`from_dictionary`\ (\ dictionary\: :ref:`Dictionary`\ ) |static| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GLTFLight` | :ref:`from_node`\ (\ light_node\: :ref:`Light3D`\ ) |static| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_additional_data`\ (\ extension_name\: :ref:`StringName`\ ) | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_additional_data`\ (\ extension_name\: :ref:`StringName`, additional_data\: :ref:`Variant`\ ) | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`to_dictionary`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Light3D` | :ref:`to_node`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -87,8 +91,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_color** **(** **)** +- |void| **set_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_color**\ (\ ) The :ref:`Color` of the light. Defaults to white. A black color causes the light to have no effect. @@ -104,8 +108,8 @@ The :ref:`Color` of the light. Defaults to white. A black color cau .. rst-class:: classref-property-setget -- void **set_inner_cone_angle** **(** :ref:`float` value **)** -- :ref:`float` **get_inner_cone_angle** **(** **)** +- |void| **set_inner_cone_angle**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_inner_cone_angle**\ (\ ) The inner angle of the cone in a spotlight. Must be less than or equal to the outer cone angle. @@ -123,8 +127,8 @@ Within this angle, the light is at full brightness. Between the inner and outer .. rst-class:: classref-property-setget -- void **set_intensity** **(** :ref:`float` value **)** -- :ref:`float` **get_intensity** **(** **)** +- |void| **set_intensity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_intensity**\ (\ ) The intensity of the light. This is expressed in candelas (lumens per steradian) for point and spot lights, and lux (lumens per m²) for directional lights. When creating a Godot light, this value is converted to a unitless multiplier. @@ -140,8 +144,8 @@ The intensity of the light. This is expressed in candelas (lumens per steradian) .. rst-class:: classref-property-setget -- void **set_light_type** **(** :ref:`String` value **)** -- :ref:`String` **get_light_type** **(** **)** +- |void| **set_light_type**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_light_type**\ (\ ) The type of the light. The values accepted by Godot are "point", "spot", and "directional", which correspond to Godot's :ref:`OmniLight3D`, :ref:`SpotLight3D`, and :ref:`DirectionalLight3D` respectively. @@ -157,8 +161,8 @@ The type of the light. The values accepted by Godot are "point", "spot", and "di .. rst-class:: classref-property-setget -- void **set_outer_cone_angle** **(** :ref:`float` value **)** -- :ref:`float` **get_outer_cone_angle** **(** **)** +- |void| **set_outer_cone_angle**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_outer_cone_angle**\ (\ ) The outer angle of the cone in a spotlight. Must be greater than or equal to the inner angle. @@ -176,8 +180,8 @@ At this angle, the light drops off to zero brightness. Between the inner and out .. rst-class:: classref-property-setget -- void **set_range** **(** :ref:`float` value **)** -- :ref:`float` **get_range** **(** **)** +- |void| **set_range**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_range**\ (\ ) The range of the light, beyond which the light has no effect. GLTF lights with no range defined behave like physical lights (which have infinite range). When creating a Godot light, the range is clamped to 4096. @@ -194,7 +198,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`GLTFLight` **from_dictionary** **(** :ref:`Dictionary` dictionary **)** |static| +:ref:`GLTFLight` **from_dictionary**\ (\ dictionary\: :ref:`Dictionary`\ ) |static| Creates a new GLTFLight instance by parsing the given :ref:`Dictionary`. @@ -206,7 +210,7 @@ Creates a new GLTFLight instance by parsing the given :ref:`Dictionary` **from_node** **(** :ref:`Light3D` light_node **)** |static| +:ref:`GLTFLight` **from_node**\ (\ light_node\: :ref:`Light3D`\ ) |static| Create a new GLTFLight instance from the given Godot :ref:`Light3D` node. @@ -214,11 +218,39 @@ Create a new GLTFLight instance from the given Godot :ref:`Light3D` **get_additional_data**\ (\ extension_name\: :ref:`StringName`\ ) + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFLight_method_set_additional_data: + +.. rst-class:: classref-method + +|void| **set_additional_data**\ (\ extension_name\: :ref:`StringName`, additional_data\: :ref:`Variant`\ ) + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_GLTFLight_method_to_dictionary: .. rst-class:: classref-method -:ref:`Dictionary` **to_dictionary** **(** **)** |const| +:ref:`Dictionary` **to_dictionary**\ (\ ) |const| Serializes this GLTFLight instance into a :ref:`Dictionary`. @@ -230,7 +262,7 @@ Serializes this GLTFLight instance into a :ref:`Dictionary`. .. rst-class:: classref-method -:ref:`Light3D` **to_node** **(** **)** |const| +:ref:`Light3D` **to_node**\ (\ ) |const| Converts this GLTFLight instance into a Godot :ref:`Light3D` node. @@ -241,3 +273,4 @@ Converts this GLTFLight instance into a Godot :ref:`Light3D` node .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gltfmesh.rst b/classes/class_gltfmesh.rst index 5829f630c11..be8ceb29559 100644 --- a/classes/class_gltfmesh.rst +++ b/classes/class_gltfmesh.rst @@ -12,9 +12,14 @@ GLTFMesh **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -.. container:: contribute +GLTFMesh represents an GLTF mesh. - There is currently no description for this class. Please help us by :ref:`contributing one `! +.. rst-class:: classref-introduction-group + +Description +----------- + +GLTFMesh handles 3D mesh data imported from GLTF files. It includes properties for blend channels, blend weights, instance materials, and the mesh itself. .. rst-class:: classref-introduction-group @@ -31,13 +36,29 @@ Properties .. table:: :widths: auto - +-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------+ - | :ref:`PackedFloat32Array` | :ref:`blend_weights` | ``PackedFloat32Array()`` | - +-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------+ - | :ref:`Material[]` | :ref:`instance_materials` | ``[]`` | - +-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------+ - | :ref:`ImporterMesh` | :ref:`mesh` | | - +-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------+ + +--------------------------------------------------------------+-----------------------------------------------------------------------+--------------------------+ + | :ref:`PackedFloat32Array` | :ref:`blend_weights` | ``PackedFloat32Array()`` | + +--------------------------------------------------------------+-----------------------------------------------------------------------+--------------------------+ + | :ref:`Array`\[:ref:`Material`\] | :ref:`instance_materials` | ``[]`` | + +--------------------------------------------------------------+-----------------------------------------------------------------------+--------------------------+ + | :ref:`ImporterMesh` | :ref:`mesh` | | + +--------------------------------------------------------------+-----------------------------------------------------------------------+--------------------------+ + | :ref:`String` | :ref:`original_name` | ``""`` | + +--------------------------------------------------------------+-----------------------------------------------------------------------+--------------------------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_additional_data`\ (\ extension_name\: :ref:`StringName`\ ) | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_additional_data`\ (\ extension_name\: :ref:`StringName`, additional_data\: :ref:`Variant`\ ) | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -56,12 +77,10 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_blend_weights** **(** :ref:`PackedFloat32Array` value **)** -- :ref:`PackedFloat32Array` **get_blend_weights** **(** **)** - -.. container:: contribute +- |void| **set_blend_weights**\ (\ value\: :ref:`PackedFloat32Array`\ ) +- :ref:`PackedFloat32Array` **get_blend_weights**\ (\ ) - There is currently no description for this property. Please help us by :ref:`contributing one `! +An array of floats representing the blend weights of the mesh. .. rst-class:: classref-item-separator @@ -71,16 +90,14 @@ Property Descriptions .. rst-class:: classref-property -:ref:`Material[]` **instance_materials** = ``[]`` +:ref:`Array`\[:ref:`Material`\] **instance_materials** = ``[]`` .. rst-class:: classref-property-setget -- void **set_instance_materials** **(** :ref:`Material[]` value **)** -- :ref:`Material[]` **get_instance_materials** **(** **)** +- |void| **set_instance_materials**\ (\ value\: :ref:`Array`\[:ref:`Material`\]\ ) +- :ref:`Array`\[:ref:`Material`\] **get_instance_materials**\ (\ ) -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +An array of Material objects representing the materials used in the mesh. .. rst-class:: classref-item-separator @@ -94,12 +111,60 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_mesh** **(** :ref:`ImporterMesh` value **)** -- :ref:`ImporterMesh` **get_mesh** **(** **)** +- |void| **set_mesh**\ (\ value\: :ref:`ImporterMesh`\ ) +- :ref:`ImporterMesh` **get_mesh**\ (\ ) + +The :ref:`ImporterMesh` object representing the mesh itself. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFMesh_property_original_name: + +.. rst-class:: classref-property + +:ref:`String` **original_name** = ``""`` + +.. rst-class:: classref-property-setget + +- |void| **set_original_name**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_original_name**\ (\ ) + +The original name of the mesh. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_GLTFMesh_method_get_additional_data: + +.. rst-class:: classref-method + +:ref:`Variant` **get_additional_data**\ (\ extension_name\: :ref:`StringName`\ ) + +Gets additional arbitrary data in this **GLTFMesh** instance. This can be used to keep per-node state data in :ref:`GLTFDocumentExtension` classes, which is important because they are stateless. + +The argument should be the :ref:`GLTFDocumentExtension` name (does not have to match the extension name in the GLTF file), and the return value can be anything you set. If nothing was set, the return value is null. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFMesh_method_set_additional_data: + +.. rst-class:: classref-method + +|void| **set_additional_data**\ (\ extension_name\: :ref:`StringName`, additional_data\: :ref:`Variant`\ ) -.. container:: contribute +Sets additional arbitrary data in this **GLTFMesh** instance. This can be used to keep per-node state data in :ref:`GLTFDocumentExtension` classes, which is important because they are stateless. - There is currently no description for this property. Please help us by :ref:`contributing one `! +The first argument should be the :ref:`GLTFDocumentExtension` name (does not have to match the extension name in the GLTF file), and the second argument can be anything you want. .. |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.)` @@ -108,3 +173,4 @@ Property Descriptions .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gltfnode.rst b/classes/class_gltfnode.rst index 396bb8e18b8..3c0967b3061 100644 --- a/classes/class_gltfnode.rst +++ b/classes/class_gltfnode.rst @@ -40,31 +40,33 @@ Properties .. table:: :widths: auto - +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+ - | :ref:`int` | :ref:`camera` | ``-1`` | - +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`children` | ``PackedInt32Array()`` | - +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+ - | :ref:`int` | :ref:`height` | ``-1`` | - +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+ - | :ref:`int` | :ref:`light` | ``-1`` | - +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+ - | :ref:`int` | :ref:`mesh` | ``-1`` | - +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+ - | :ref:`int` | :ref:`parent` | ``-1`` | - +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+ - | :ref:`Vector3` | :ref:`position` | ``Vector3(0, 0, 0)`` | - +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+ - | :ref:`Quaternion` | :ref:`rotation` | ``Quaternion(0, 0, 0, 1)`` | - +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+ - | :ref:`Vector3` | :ref:`scale` | ``Vector3(1, 1, 1)`` | - +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+ - | :ref:`int` | :ref:`skeleton` | ``-1`` | - +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+ - | :ref:`int` | :ref:`skin` | ``-1`` | - +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+ - | :ref:`Transform3D` | :ref:`xform` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | - +-------------------------------------------------+---------------------------------------------------+-----------------------------------------------------+ + +-------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`int` | :ref:`camera` | ``-1`` | + +-------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`children` | ``PackedInt32Array()`` | + +-------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`int` | :ref:`height` | ``-1`` | + +-------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`int` | :ref:`light` | ``-1`` | + +-------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`int` | :ref:`mesh` | ``-1`` | + +-------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`String` | :ref:`original_name` | ``""`` | + +-------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`int` | :ref:`parent` | ``-1`` | + +-------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Vector3` | :ref:`position` | ``Vector3(0, 0, 0)`` | + +-------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Quaternion` | :ref:`rotation` | ``Quaternion(0, 0, 0, 1)`` | + +-------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Vector3` | :ref:`scale` | ``Vector3(1, 1, 1)`` | + +-------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`int` | :ref:`skeleton` | ``-1`` | + +-------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`int` | :ref:`skin` | ``-1`` | + +-------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Transform3D` | :ref:`xform` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | + +-------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -74,11 +76,11 @@ Methods .. table:: :widths: auto - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_additional_data` **(** :ref:`StringName` extension_name **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_additional_data` **(** :ref:`StringName` extension_name, :ref:`Variant` additional_data **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_additional_data`\ (\ extension_name\: :ref:`StringName`\ ) | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_additional_data`\ (\ extension_name\: :ref:`StringName`, additional_data\: :ref:`Variant`\ ) | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -97,8 +99,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_camera** **(** :ref:`int` value **)** -- :ref:`int` **get_camera** **(** **)** +- |void| **set_camera**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_camera**\ (\ ) If this GLTF node is a camera, the index of the :ref:`GLTFCamera` in the :ref:`GLTFState` that describes the camera's properties. If -1, this node is not a camera. @@ -114,8 +116,8 @@ If this GLTF node is a camera, the index of the :ref:`GLTFCamera` value **)** -- :ref:`PackedInt32Array` **get_children** **(** **)** +- |void| **set_children**\ (\ value\: :ref:`PackedInt32Array`\ ) +- :ref:`PackedInt32Array` **get_children**\ (\ ) The indices of the children nodes in the :ref:`GLTFState`. If this GLTF node has no children, this will be an empty array. @@ -131,8 +133,8 @@ The indices of the children nodes in the :ref:`GLTFState`. If t .. rst-class:: classref-property-setget -- void **set_height** **(** :ref:`int` value **)** -- :ref:`int` **get_height** **(** **)** +- |void| **set_height**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_height**\ (\ ) How deep into the node hierarchy this node is. A root node will have a height of 0, its children will have a height of 1, and so on. If -1, the height has not been calculated. @@ -148,8 +150,8 @@ How deep into the node hierarchy this node is. A root node will have a height of .. rst-class:: classref-property-setget -- void **set_light** **(** :ref:`int` value **)** -- :ref:`int` **get_light** **(** **)** +- |void| **set_light**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_light**\ (\ ) If this GLTF node is a light, the index of the :ref:`GLTFLight` in the :ref:`GLTFState` that describes the light's properties. If -1, this node is not a light. @@ -165,8 +167,8 @@ If this GLTF node is a light, the index of the :ref:`GLTFLight` .. rst-class:: classref-property-setget -- void **set_mesh** **(** :ref:`int` value **)** -- :ref:`int` **get_mesh** **(** **)** +- |void| **set_mesh**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_mesh**\ (\ ) If this GLTF node is a mesh, the index of the :ref:`GLTFMesh` in the :ref:`GLTFState` that describes the mesh's properties. If -1, this node is not a mesh. @@ -174,6 +176,23 @@ If this GLTF node is a mesh, the index of the :ref:`GLTFMesh` in ---- +.. _class_GLTFNode_property_original_name: + +.. rst-class:: classref-property + +:ref:`String` **original_name** = ``""`` + +.. rst-class:: classref-property-setget + +- |void| **set_original_name**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_original_name**\ (\ ) + +The original name of the node. + +.. rst-class:: classref-item-separator + +---- + .. _class_GLTFNode_property_parent: .. rst-class:: classref-property @@ -182,8 +201,8 @@ If this GLTF node is a mesh, the index of the :ref:`GLTFMesh` in .. rst-class:: classref-property-setget -- void **set_parent** **(** :ref:`int` value **)** -- :ref:`int` **get_parent** **(** **)** +- |void| **set_parent**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_parent**\ (\ ) The index of the parent node in the :ref:`GLTFState`. If -1, this node is a root node. @@ -199,8 +218,8 @@ The index of the parent node in the :ref:`GLTFState`. If -1, th .. rst-class:: classref-property-setget -- void **set_position** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_position** **(** **)** +- |void| **set_position**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_position**\ (\ ) The position of the GLTF node relative to its parent. @@ -216,8 +235,8 @@ The position of the GLTF node relative to its parent. .. rst-class:: classref-property-setget -- void **set_rotation** **(** :ref:`Quaternion` value **)** -- :ref:`Quaternion` **get_rotation** **(** **)** +- |void| **set_rotation**\ (\ value\: :ref:`Quaternion`\ ) +- :ref:`Quaternion` **get_rotation**\ (\ ) The rotation of the GLTF node relative to its parent. @@ -233,8 +252,8 @@ The rotation of the GLTF node relative to its parent. .. rst-class:: classref-property-setget -- void **set_scale** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_scale** **(** **)** +- |void| **set_scale**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_scale**\ (\ ) The scale of the GLTF node relative to its parent. @@ -250,8 +269,8 @@ The scale of the GLTF node relative to its parent. .. rst-class:: classref-property-setget -- void **set_skeleton** **(** :ref:`int` value **)** -- :ref:`int` **get_skeleton** **(** **)** +- |void| **set_skeleton**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_skeleton**\ (\ ) If this GLTF node has a skeleton, the index of the :ref:`GLTFSkeleton` in the :ref:`GLTFState` that describes the skeleton's properties. If -1, this node does not have a skeleton. @@ -267,8 +286,8 @@ If this GLTF node has a skeleton, the index of the :ref:`GLTFSkeleton` value **)** -- :ref:`int` **get_skin** **(** **)** +- |void| **set_skin**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_skin**\ (\ ) If this GLTF node has a skin, the index of the :ref:`GLTFSkin` in the :ref:`GLTFState` that describes the skin's properties. If -1, this node does not have a skin. @@ -284,8 +303,8 @@ If this GLTF node has a skin, the index of the :ref:`GLTFSkin` i .. rst-class:: classref-property-setget -- void **set_xform** **(** :ref:`Transform3D` value **)** -- :ref:`Transform3D` **get_xform** **(** **)** +- |void| **set_xform**\ (\ value\: :ref:`Transform3D`\ ) +- :ref:`Transform3D` **get_xform**\ (\ ) The transform of the GLTF node relative to its parent. This property is usually unused since the position, rotation, and scale properties are preferred. @@ -302,7 +321,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **get_additional_data** **(** :ref:`StringName` extension_name **)** +:ref:`Variant` **get_additional_data**\ (\ extension_name\: :ref:`StringName`\ ) Gets additional arbitrary data in this **GLTFNode** instance. This can be used to keep per-node state data in :ref:`GLTFDocumentExtension` classes, which is important because they are stateless. @@ -316,7 +335,7 @@ The argument should be the :ref:`GLTFDocumentExtension` extension_name, :ref:`Variant` additional_data **)** +|void| **set_additional_data**\ (\ extension_name\: :ref:`StringName`, additional_data\: :ref:`Variant`\ ) Sets additional arbitrary data in this **GLTFNode** instance. This can be used to keep per-node state data in :ref:`GLTFDocumentExtension` classes, which is important because they are stateless. @@ -329,3 +348,4 @@ The first argument should be the :ref:`GLTFDocumentExtension` | :ref:`from_dictionary` **(** :ref:`Dictionary` dictionary **)** |static| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GLTFPhysicsBody` | :ref:`from_node` **(** :ref:`CollisionObject3D` body_node **)** |static| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`to_dictionary` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`CollisionObject3D` | :ref:`to_node` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GLTFPhysicsBody` | :ref:`from_dictionary`\ (\ dictionary\: :ref:`Dictionary`\ ) |static| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GLTFPhysicsBody` | :ref:`from_node`\ (\ body_node\: :ref:`CollisionObject3D`\ ) |static| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`to_dictionary`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CollisionObject3D` | :ref:`to_node`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -91,8 +91,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_angular_velocity** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_angular_velocity** **(** **)** +- |void| **set_angular_velocity**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_angular_velocity**\ (\ ) The angular velocity of the physics body, in radians per second. This is only used when the body type is "rigid" or "vehicle". @@ -108,8 +108,8 @@ The angular velocity of the physics body, in radians per second. This is only us .. rst-class:: classref-property-setget -- void **set_body_type** **(** :ref:`String` value **)** -- :ref:`String` **get_body_type** **(** **)** +- |void| **set_body_type**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_body_type**\ (\ ) The type of the body. When importing, this controls what type of :ref:`CollisionObject3D` node Godot should generate. Valid values are "static", "animatable", "character", "rigid", "vehicle", and "trigger". When exporting, this will be squashed down to one of "static", "kinematic", or "dynamic" motion types, or the "trigger" property. @@ -125,8 +125,8 @@ The type of the body. When importing, this controls what type of :ref:`Collision .. rst-class:: classref-property-setget -- void **set_center_of_mass** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_center_of_mass** **(** **)** +- |void| **set_center_of_mass**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_center_of_mass**\ (\ ) The center of mass of the body, in meters. This is in local space relative to the body. By default, the center of the mass is the body's origin. @@ -142,8 +142,8 @@ The center of mass of the body, in meters. This is in local space relative to th .. rst-class:: classref-property-setget -- void **set_inertia_diagonal** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_inertia_diagonal** **(** **)** +- |void| **set_inertia_diagonal**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_inertia_diagonal**\ (\ ) The inertia strength of the physics body, in kilogram meter squared (kg⋅m²). This represents the inertia around the principle axes, the diagonal of the inertia tensor matrix. This is only used when the body type is "rigid" or "vehicle". @@ -161,8 +161,8 @@ When converted to a Godot :ref:`RigidBody3D` node, if this va .. rst-class:: classref-property-setget -- void **set_inertia_orientation** **(** :ref:`Quaternion` value **)** -- :ref:`Quaternion` **get_inertia_orientation** **(** **)** +- |void| **set_inertia_orientation**\ (\ value\: :ref:`Quaternion`\ ) +- :ref:`Quaternion` **get_inertia_orientation**\ (\ ) The inertia orientation of the physics body. This defines the rotation of the inertia's principle axes relative to the object's local axes. This is only used when the body type is "rigid" or "vehicle" and :ref:`inertia_diagonal` is set to a non-zero value. @@ -178,8 +178,8 @@ The inertia orientation of the physics body. This defines the rotation of the in .. rst-class:: classref-property-setget -- void **set_inertia_tensor** **(** :ref:`Basis` value **)** -- :ref:`Basis` **get_inertia_tensor** **(** **)** +- |void| **set_inertia_tensor**\ (\ value\: :ref:`Basis`\ ) +- :ref:`Basis` **get_inertia_tensor**\ (\ ) **Deprecated:** This property may be changed or removed in future versions. @@ -199,8 +199,8 @@ When converted to a Godot :ref:`RigidBody3D` node, if this va .. rst-class:: classref-property-setget -- void **set_linear_velocity** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_linear_velocity** **(** **)** +- |void| **set_linear_velocity**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_linear_velocity**\ (\ ) The linear velocity of the physics body, in meters per second. This is only used when the body type is "rigid" or "vehicle". @@ -216,8 +216,8 @@ The linear velocity of the physics body, in meters per second. This is only used .. rst-class:: classref-property-setget -- void **set_mass** **(** :ref:`float` value **)** -- :ref:`float` **get_mass** **(** **)** +- |void| **set_mass**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_mass**\ (\ ) The mass of the physics body, in kilograms. This is only used when the body type is "rigid" or "vehicle". @@ -234,7 +234,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`GLTFPhysicsBody` **from_dictionary** **(** :ref:`Dictionary` dictionary **)** |static| +:ref:`GLTFPhysicsBody` **from_dictionary**\ (\ dictionary\: :ref:`Dictionary`\ ) |static| Creates a new GLTFPhysicsBody instance by parsing the given :ref:`Dictionary` in the ``OMI_physics_body`` GLTF extension format. @@ -246,7 +246,7 @@ Creates a new GLTFPhysicsBody instance by parsing the given :ref:`Dictionary` **from_node** **(** :ref:`CollisionObject3D` body_node **)** |static| +:ref:`GLTFPhysicsBody` **from_node**\ (\ body_node\: :ref:`CollisionObject3D`\ ) |static| Create a new GLTFPhysicsBody instance from the given Godot :ref:`CollisionObject3D` node. @@ -258,7 +258,7 @@ Create a new GLTFPhysicsBody instance from the given Godot :ref:`CollisionObject .. rst-class:: classref-method -:ref:`Dictionary` **to_dictionary** **(** **)** |const| +:ref:`Dictionary` **to_dictionary**\ (\ ) |const| Serializes this GLTFPhysicsBody instance into a :ref:`Dictionary`. It will be in the format expected by the ``OMI_physics_body`` GLTF extension. @@ -270,7 +270,7 @@ Serializes this GLTFPhysicsBody instance into a :ref:`Dictionary` **to_node** **(** **)** |const| +:ref:`CollisionObject3D` **to_node**\ (\ ) |const| Converts this GLTFPhysicsBody instance into a Godot :ref:`CollisionObject3D` node. @@ -281,3 +281,4 @@ Converts this GLTFPhysicsBody instance into a Godot :ref:`CollisionObject3D` | :ref:`from_dictionary` **(** :ref:`Dictionary` dictionary **)** |static| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GLTFPhysicsShape` | :ref:`from_node` **(** :ref:`CollisionShape3D` shape_node **)** |static| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`to_dictionary` **(** **)** |const| | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`CollisionShape3D` | :ref:`to_node` **(** :ref:`bool` cache_shapes=false **)** | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GLTFPhysicsShape` | :ref:`from_dictionary`\ (\ dictionary\: :ref:`Dictionary`\ ) |static| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GLTFPhysicsShape` | :ref:`from_node`\ (\ shape_node\: :ref:`CollisionShape3D`\ ) |static| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`to_dictionary`\ (\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CollisionShape3D` | :ref:`to_node`\ (\ cache_shapes\: :ref:`bool` = false\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -91,8 +91,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_height** **(** :ref:`float` value **)** -- :ref:`float` **get_height** **(** **)** +- |void| **set_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_height**\ (\ ) The height of the shape, in meters. This is only used when the shape type is "capsule" or "cylinder". This value should not be negative, and for "capsule" it should be at least twice the radius. @@ -108,8 +108,8 @@ The height of the shape, in meters. This is only used when the shape type is "ca .. rst-class:: classref-property-setget -- void **set_importer_mesh** **(** :ref:`ImporterMesh` value **)** -- :ref:`ImporterMesh` **get_importer_mesh** **(** **)** +- |void| **set_importer_mesh**\ (\ value\: :ref:`ImporterMesh`\ ) +- :ref:`ImporterMesh` **get_importer_mesh**\ (\ ) The :ref:`ImporterMesh` resource of the shape. This is only used when the shape type is "hull" (convex hull) or "trimesh" (concave trimesh). @@ -125,8 +125,8 @@ The :ref:`ImporterMesh` resource of the shape. This is only .. rst-class:: classref-property-setget -- void **set_is_trigger** **(** :ref:`bool` value **)** -- :ref:`bool` **get_is_trigger** **(** **)** +- |void| **set_is_trigger**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_is_trigger**\ (\ ) If ``true``, indicates that this shape is a trigger. For Godot, this means that the shape should be a child of an Area3D node. @@ -144,8 +144,8 @@ This is the only variable not used in the :ref:`to_node` value **)** -- :ref:`int` **get_mesh_index** **(** **)** +- |void| **set_mesh_index**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_mesh_index**\ (\ ) The index of the shape's mesh in the GLTF file. This is only used when the shape type is "hull" (convex hull) or "trimesh" (concave trimesh). @@ -161,8 +161,8 @@ The index of the shape's mesh in the GLTF file. This is only used when the shape .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) The radius of the shape, in meters. This is only used when the shape type is "capsule", "cylinder", or "sphere". This value should not be negative. @@ -178,8 +178,8 @@ The radius of the shape, in meters. This is only used when the shape type is "ca .. rst-class:: classref-property-setget -- void **set_shape_type** **(** :ref:`String` value **)** -- :ref:`String` **get_shape_type** **(** **)** +- |void| **set_shape_type**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_shape_type**\ (\ ) The type of shape this shape represents. Valid values are "box", "capsule", "cylinder", "sphere", "hull", and "trimesh". @@ -195,8 +195,8 @@ The type of shape this shape represents. Valid values are "box", "capsule", "cyl .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_size**\ (\ ) The size of the shape, in meters. This is only used when the shape type is "box", and it represents the "diameter" of the box. This value should not be negative. @@ -213,7 +213,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`GLTFPhysicsShape` **from_dictionary** **(** :ref:`Dictionary` dictionary **)** |static| +:ref:`GLTFPhysicsShape` **from_dictionary**\ (\ dictionary\: :ref:`Dictionary`\ ) |static| Creates a new GLTFPhysicsShape instance by parsing the given :ref:`Dictionary`. @@ -225,7 +225,7 @@ Creates a new GLTFPhysicsShape instance by parsing the given :ref:`Dictionary` **from_node** **(** :ref:`CollisionShape3D` shape_node **)** |static| +:ref:`GLTFPhysicsShape` **from_node**\ (\ shape_node\: :ref:`CollisionShape3D`\ ) |static| Create a new GLTFPhysicsShape instance from the given Godot :ref:`CollisionShape3D` node. @@ -237,7 +237,7 @@ Create a new GLTFPhysicsShape instance from the given Godot :ref:`CollisionShape .. rst-class:: classref-method -:ref:`Dictionary` **to_dictionary** **(** **)** |const| +:ref:`Dictionary` **to_dictionary**\ (\ ) |const| Serializes this GLTFPhysicsShape instance into a :ref:`Dictionary` in the format defined by ``OMI_physics_shape``. @@ -249,7 +249,7 @@ Serializes this GLTFPhysicsShape instance into a :ref:`Dictionary` **to_node** **(** :ref:`bool` cache_shapes=false **)** +:ref:`CollisionShape3D` **to_node**\ (\ cache_shapes\: :ref:`bool` = false\ ) Converts this GLTFPhysicsShape instance into a Godot :ref:`CollisionShape3D` node. @@ -260,3 +260,4 @@ Converts this GLTFPhysicsShape instance into a Godot :ref:`CollisionShape3D` | :ref:`get_bone_attachment` **(** :ref:`int` idx **)** | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_bone_attachment_count` **(** **)** | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_godot_bone_node` **(** **)** | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Skeleton3D` | :ref:`get_godot_skeleton` **(** **)** | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String[]` | :ref:`get_unique_names` **(** **)** | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_godot_bone_node` **(** :ref:`Dictionary` godot_bone_node **)** | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_unique_names` **(** :ref:`String[]` unique_names **)** | - +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`BoneAttachment3D` | :ref:`get_bone_attachment`\ (\ idx\: :ref:`int`\ ) | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_bone_attachment_count`\ (\ ) | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_godot_bone_node`\ (\ ) | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Skeleton3D` | :ref:`get_godot_skeleton`\ (\ ) | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`String`\] | :ref:`get_unique_names`\ (\ ) | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_godot_bone_node`\ (\ godot_bone_node\: :ref:`Dictionary`\ ) | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_unique_names`\ (\ unique_names\: :ref:`Array`\[:ref:`String`\]\ ) | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -78,8 +78,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_joints** **(** :ref:`PackedInt32Array` value **)** -- :ref:`PackedInt32Array` **get_joints** **(** **)** +- |void| **set_joints**\ (\ value\: :ref:`PackedInt32Array`\ ) +- :ref:`PackedInt32Array` **get_joints**\ (\ ) .. container:: contribute @@ -97,8 +97,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_roots** **(** :ref:`PackedInt32Array` value **)** -- :ref:`PackedInt32Array` **get_roots** **(** **)** +- |void| **set_roots**\ (\ value\: :ref:`PackedInt32Array`\ ) +- :ref:`PackedInt32Array` **get_roots**\ (\ ) .. container:: contribute @@ -117,7 +117,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`BoneAttachment3D` **get_bone_attachment** **(** :ref:`int` idx **)** +:ref:`BoneAttachment3D` **get_bone_attachment**\ (\ idx\: :ref:`int`\ ) .. container:: contribute @@ -131,7 +131,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_bone_attachment_count** **(** **)** +:ref:`int` **get_bone_attachment_count**\ (\ ) .. container:: contribute @@ -145,7 +145,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary` **get_godot_bone_node** **(** **)** +:ref:`Dictionary` **get_godot_bone_node**\ (\ ) Returns a :ref:`Dictionary` that maps skeleton bone indices to the indices of GLTF nodes. This property is unused during import, and only set during export. In a GLTF file, a bone is a node, so Godot converts skeleton bones to GLTF nodes. @@ -157,7 +157,7 @@ Returns a :ref:`Dictionary` that maps skeleton bone indices to .. rst-class:: classref-method -:ref:`Skeleton3D` **get_godot_skeleton** **(** **)** +:ref:`Skeleton3D` **get_godot_skeleton**\ (\ ) .. container:: contribute @@ -171,7 +171,7 @@ Returns a :ref:`Dictionary` that maps skeleton bone indices to .. rst-class:: classref-method -:ref:`String[]` **get_unique_names** **(** **)** +:ref:`Array`\[:ref:`String`\] **get_unique_names**\ (\ ) .. container:: contribute @@ -185,7 +185,7 @@ Returns a :ref:`Dictionary` that maps skeleton bone indices to .. rst-class:: classref-method -void **set_godot_bone_node** **(** :ref:`Dictionary` godot_bone_node **)** +|void| **set_godot_bone_node**\ (\ godot_bone_node\: :ref:`Dictionary`\ ) Sets a :ref:`Dictionary` that maps skeleton bone indices to the indices of GLTF nodes. This property is unused during import, and only set during export. In a GLTF file, a bone is a node, so Godot converts skeleton bones to GLTF nodes. @@ -197,7 +197,7 @@ Sets a :ref:`Dictionary` that maps skeleton bone indices to th .. rst-class:: classref-method -void **set_unique_names** **(** :ref:`String[]` unique_names **)** +|void| **set_unique_names**\ (\ unique_names\: :ref:`Array`\[:ref:`String`\]\ ) .. container:: contribute @@ -210,3 +210,4 @@ void **set_unique_names** **(** :ref:`String[]` unique_names **)** .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gltfskin.rst b/classes/class_gltfskin.rst index 78424c80d62..e9c04e14fa2 100644 --- a/classes/class_gltfskin.rst +++ b/classes/class_gltfskin.rst @@ -55,19 +55,19 @@ Methods .. table:: :widths: auto - +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D[]` | :ref:`get_inverse_binds` **(** **)** | - +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_joint_i_to_bone_i` **(** **)** | - +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_joint_i_to_name` **(** **)** | - +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_inverse_binds` **(** :ref:`Transform3D[]` inverse_binds **)** | - +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_joint_i_to_bone_i` **(** :ref:`Dictionary` joint_i_to_bone_i **)** | - +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_joint_i_to_name` **(** :ref:`Dictionary` joint_i_to_name **)** | - +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Transform3D`\] | :ref:`get_inverse_binds`\ (\ ) | + +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_joint_i_to_bone_i`\ (\ ) | + +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_joint_i_to_name`\ (\ ) | + +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_inverse_binds`\ (\ inverse_binds\: :ref:`Array`\[:ref:`Transform3D`\]\ ) | + +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_i_to_bone_i`\ (\ joint_i_to_bone_i\: :ref:`Dictionary`\ ) | + +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_i_to_name`\ (\ joint_i_to_name\: :ref:`Dictionary`\ ) | + +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -86,8 +86,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_godot_skin** **(** :ref:`Skin` value **)** -- :ref:`Skin` **get_godot_skin** **(** **)** +- |void| **set_godot_skin**\ (\ value\: :ref:`Skin`\ ) +- :ref:`Skin` **get_godot_skin**\ (\ ) .. container:: contribute @@ -105,8 +105,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_joints** **(** :ref:`PackedInt32Array` value **)** -- :ref:`PackedInt32Array` **get_joints** **(** **)** +- |void| **set_joints**\ (\ value\: :ref:`PackedInt32Array`\ ) +- :ref:`PackedInt32Array` **get_joints**\ (\ ) .. container:: contribute @@ -124,8 +124,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_joints_original** **(** :ref:`PackedInt32Array` value **)** -- :ref:`PackedInt32Array` **get_joints_original** **(** **)** +- |void| **set_joints_original**\ (\ value\: :ref:`PackedInt32Array`\ ) +- :ref:`PackedInt32Array` **get_joints_original**\ (\ ) .. container:: contribute @@ -143,8 +143,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_non_joints** **(** :ref:`PackedInt32Array` value **)** -- :ref:`PackedInt32Array` **get_non_joints** **(** **)** +- |void| **set_non_joints**\ (\ value\: :ref:`PackedInt32Array`\ ) +- :ref:`PackedInt32Array` **get_non_joints**\ (\ ) .. container:: contribute @@ -162,8 +162,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_roots** **(** :ref:`PackedInt32Array` value **)** -- :ref:`PackedInt32Array` **get_roots** **(** **)** +- |void| **set_roots**\ (\ value\: :ref:`PackedInt32Array`\ ) +- :ref:`PackedInt32Array` **get_roots**\ (\ ) .. container:: contribute @@ -181,8 +181,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_skeleton** **(** :ref:`int` value **)** -- :ref:`int` **get_skeleton** **(** **)** +- |void| **set_skeleton**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_skeleton**\ (\ ) .. container:: contribute @@ -200,8 +200,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_skin_root** **(** :ref:`int` value **)** -- :ref:`int` **get_skin_root** **(** **)** +- |void| **set_skin_root**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_skin_root**\ (\ ) .. container:: contribute @@ -220,7 +220,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Transform3D[]` **get_inverse_binds** **(** **)** +:ref:`Array`\[:ref:`Transform3D`\] **get_inverse_binds**\ (\ ) .. container:: contribute @@ -234,7 +234,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary` **get_joint_i_to_bone_i** **(** **)** +:ref:`Dictionary` **get_joint_i_to_bone_i**\ (\ ) .. container:: contribute @@ -248,7 +248,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary` **get_joint_i_to_name** **(** **)** +:ref:`Dictionary` **get_joint_i_to_name**\ (\ ) .. container:: contribute @@ -262,7 +262,7 @@ Method Descriptions .. rst-class:: classref-method -void **set_inverse_binds** **(** :ref:`Transform3D[]` inverse_binds **)** +|void| **set_inverse_binds**\ (\ inverse_binds\: :ref:`Array`\[:ref:`Transform3D`\]\ ) .. container:: contribute @@ -276,7 +276,7 @@ void **set_inverse_binds** **(** :ref:`Transform3D[]` inverse .. rst-class:: classref-method -void **set_joint_i_to_bone_i** **(** :ref:`Dictionary` joint_i_to_bone_i **)** +|void| **set_joint_i_to_bone_i**\ (\ joint_i_to_bone_i\: :ref:`Dictionary`\ ) .. container:: contribute @@ -290,7 +290,7 @@ void **set_joint_i_to_bone_i** **(** :ref:`Dictionary` joint_i .. rst-class:: classref-method -void **set_joint_i_to_name** **(** :ref:`Dictionary` joint_i_to_name **)** +|void| **set_joint_i_to_name**\ (\ joint_i_to_name\: :ref:`Dictionary`\ ) .. container:: contribute @@ -303,3 +303,4 @@ void **set_joint_i_to_name** **(** :ref:`Dictionary` joint_i_t .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gltfspecgloss.rst b/classes/class_gltfspecgloss.rst index 4b632f34899..cd22b6517e8 100644 --- a/classes/class_gltfspecgloss.rst +++ b/classes/class_gltfspecgloss.rst @@ -67,8 +67,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_diffuse_factor** **(** :ref:`Color` value **)** -- :ref:`Color` **get_diffuse_factor** **(** **)** +- |void| **set_diffuse_factor**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_diffuse_factor**\ (\ ) The reflected diffuse factor of the material. @@ -84,8 +84,8 @@ The reflected diffuse factor of the material. .. rst-class:: classref-property-setget -- void **set_diffuse_img** **(** :ref:`Image` value **)** -- :ref:`Image` **get_diffuse_img** **(** **)** +- |void| **set_diffuse_img**\ (\ value\: :ref:`Image`\ ) +- :ref:`Image` **get_diffuse_img**\ (\ ) The diffuse texture. @@ -101,8 +101,8 @@ The diffuse texture. .. rst-class:: classref-property-setget -- void **set_gloss_factor** **(** :ref:`float` value **)** -- :ref:`float` **get_gloss_factor** **(** **)** +- |void| **set_gloss_factor**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_gloss_factor**\ (\ ) The glossiness or smoothness of the material. @@ -118,8 +118,8 @@ The glossiness or smoothness of the material. .. rst-class:: classref-property-setget -- void **set_spec_gloss_img** **(** :ref:`Image` value **)** -- :ref:`Image` **get_spec_gloss_img** **(** **)** +- |void| **set_spec_gloss_img**\ (\ value\: :ref:`Image`\ ) +- :ref:`Image` **get_spec_gloss_img**\ (\ ) The specular-glossiness texture. @@ -135,8 +135,8 @@ The specular-glossiness texture. .. rst-class:: classref-property-setget -- void **set_specular_factor** **(** :ref:`Color` value **)** -- :ref:`Color` **get_specular_factor** **(** **)** +- |void| **set_specular_factor**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_specular_factor**\ (\ ) The specular RGB color of the material. The alpha channel is unused. @@ -147,3 +147,4 @@ The specular RGB color of the material. The alpha channel is unused. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gltfstate.rst b/classes/class_gltfstate.rst index d79dbaf5efe..84ec5848c32 100644 --- a/classes/class_gltfstate.rst +++ b/classes/class_gltfstate.rst @@ -12,6 +12,8 @@ GLTFState **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +**Inherited By:** :ref:`FBXState` + Represents all data of a GLTF file. .. rst-class:: classref-introduction-group @@ -40,31 +42,31 @@ Properties .. table:: :widths: auto - +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+ - | :ref:`String` | :ref:`base_path` | ``""`` | - +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+ - | :ref:`PackedByteArray[]` | :ref:`buffers` | ``[]`` | - +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+ - | :ref:`String` | :ref:`copyright` | ``""`` | - +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+ - | :ref:`bool` | :ref:`create_animations` | ``true`` | - +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+ - | :ref:`String` | :ref:`filename` | ``""`` | - +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+ - | :ref:`PackedByteArray` | :ref:`glb_data` | ``PackedByteArray()`` | - +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+ - | :ref:`Dictionary` | :ref:`json` | ``{}`` | - +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+ - | :ref:`int` | :ref:`major_version` | ``0`` | - +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+ - | :ref:`int` | :ref:`minor_version` | ``0`` | - +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+ - | :ref:`PackedInt32Array` | :ref:`root_nodes` | ``PackedInt32Array()`` | - +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+ - | :ref:`String` | :ref:`scene_name` | ``""`` | - +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+ - | :ref:`bool` | :ref:`use_named_skin_binds` | ``false`` | - +-------------------------------------------------+----------------------------------------------------------------------------+------------------------+ + +----------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+ + | :ref:`String` | :ref:`base_path` | ``""`` | + +----------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+ + | :ref:`Array`\[:ref:`PackedByteArray`\] | :ref:`buffers` | ``[]`` | + +----------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+ + | :ref:`String` | :ref:`copyright` | ``""`` | + +----------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+ + | :ref:`bool` | :ref:`create_animations` | ``true`` | + +----------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+ + | :ref:`String` | :ref:`filename` | ``""`` | + +----------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+ + | :ref:`PackedByteArray` | :ref:`glb_data` | ``PackedByteArray()`` | + +----------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+ + | :ref:`Dictionary` | :ref:`json` | ``{}`` | + +----------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+ + | :ref:`int` | :ref:`major_version` | ``0`` | + +----------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+ + | :ref:`int` | :ref:`minor_version` | ``0`` | + +----------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+ + | :ref:`PackedInt32Array` | :ref:`root_nodes` | ``PackedInt32Array()`` | + +----------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+ + | :ref:`String` | :ref:`scene_name` | ``""`` | + +----------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+ + | :ref:`bool` | :ref:`use_named_skin_binds` | ``false`` | + +----------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+ .. rst-class:: classref-reftable-group @@ -74,87 +76,87 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_used_extension` **(** :ref:`String` extension_name, :ref:`bool` required **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`append_data_to_buffers` **(** :ref:`PackedByteArray` data, :ref:`bool` deduplication **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GLTFAccessor[]` | :ref:`get_accessors` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_additional_data` **(** :ref:`StringName` extension_name **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AnimationPlayer` | :ref:`get_animation_player` **(** :ref:`int` idx **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_animation_players_count` **(** :ref:`int` idx **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GLTFAnimation[]` | :ref:`get_animations` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GLTFBufferView[]` | :ref:`get_buffer_views` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GLTFCamera[]` | :ref:`get_cameras` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_handle_binary_image` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D[]` | :ref:`get_images` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GLTFLight[]` | :ref:`get_lights` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Material[]` | :ref:`get_materials` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GLTFMesh[]` | :ref:`get_meshes` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_node_index` **(** :ref:`Node` scene_node **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GLTFNode[]` | :ref:`get_nodes` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`get_scene_node` **(** :ref:`int` idx **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GLTFSkeleton[]` | :ref:`get_skeletons` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GLTFSkin[]` | :ref:`get_skins` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GLTFTextureSampler[]` | :ref:`get_texture_samplers` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GLTFTexture[]` | :ref:`get_textures` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String[]` | :ref:`get_unique_animation_names` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String[]` | :ref:`get_unique_names` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_accessors` **(** :ref:`GLTFAccessor[]` accessors **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_additional_data` **(** :ref:`StringName` extension_name, :ref:`Variant` additional_data **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_animations` **(** :ref:`GLTFAnimation[]` animations **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_buffer_views` **(** :ref:`GLTFBufferView[]` buffer_views **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cameras` **(** :ref:`GLTFCamera[]` cameras **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_handle_binary_image` **(** :ref:`int` method **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_images` **(** :ref:`Texture2D[]` images **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_lights` **(** :ref:`GLTFLight[]` lights **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_materials` **(** :ref:`Material[]` materials **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_meshes` **(** :ref:`GLTFMesh[]` meshes **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_nodes` **(** :ref:`GLTFNode[]` nodes **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_skeletons` **(** :ref:`GLTFSkeleton[]` skeletons **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_skins` **(** :ref:`GLTFSkin[]` skins **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_texture_samplers` **(** :ref:`GLTFTextureSampler[]` texture_samplers **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_textures` **(** :ref:`GLTFTexture[]` textures **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_unique_animation_names` **(** :ref:`String[]` unique_animation_names **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_unique_names` **(** :ref:`String[]` unique_names **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_used_extension`\ (\ extension_name\: :ref:`String`, required\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`append_data_to_buffers`\ (\ data\: :ref:`PackedByteArray`, deduplication\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`GLTFAccessor`\] | :ref:`get_accessors`\ (\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_additional_data`\ (\ extension_name\: :ref:`StringName`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AnimationPlayer` | :ref:`get_animation_player`\ (\ idx\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_animation_players_count`\ (\ idx\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`GLTFAnimation`\] | :ref:`get_animations`\ (\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`GLTFBufferView`\] | :ref:`get_buffer_views`\ (\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`GLTFCamera`\] | :ref:`get_cameras`\ (\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_handle_binary_image`\ (\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Texture2D`\] | :ref:`get_images`\ (\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`GLTFLight`\] | :ref:`get_lights`\ (\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Material`\] | :ref:`get_materials`\ (\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`GLTFMesh`\] | :ref:`get_meshes`\ (\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_node_index`\ (\ scene_node\: :ref:`Node`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`GLTFNode`\] | :ref:`get_nodes`\ (\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`get_scene_node`\ (\ idx\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`GLTFSkeleton`\] | :ref:`get_skeletons`\ (\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`GLTFSkin`\] | :ref:`get_skins`\ (\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`GLTFTextureSampler`\] | :ref:`get_texture_samplers`\ (\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`GLTFTexture`\] | :ref:`get_textures`\ (\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`String`\] | :ref:`get_unique_animation_names`\ (\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`String`\] | :ref:`get_unique_names`\ (\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_accessors`\ (\ accessors\: :ref:`Array`\[:ref:`GLTFAccessor`\]\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_additional_data`\ (\ extension_name\: :ref:`StringName`, additional_data\: :ref:`Variant`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_animations`\ (\ animations\: :ref:`Array`\[:ref:`GLTFAnimation`\]\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_buffer_views`\ (\ buffer_views\: :ref:`Array`\[:ref:`GLTFBufferView`\]\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cameras`\ (\ cameras\: :ref:`Array`\[:ref:`GLTFCamera`\]\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_handle_binary_image`\ (\ method\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_images`\ (\ images\: :ref:`Array`\[:ref:`Texture2D`\]\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_lights`\ (\ lights\: :ref:`Array`\[:ref:`GLTFLight`\]\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_materials`\ (\ materials\: :ref:`Array`\[:ref:`Material`\]\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_meshes`\ (\ meshes\: :ref:`Array`\[:ref:`GLTFMesh`\]\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_nodes`\ (\ nodes\: :ref:`Array`\[:ref:`GLTFNode`\]\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_skeletons`\ (\ skeletons\: :ref:`Array`\[:ref:`GLTFSkeleton`\]\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_skins`\ (\ skins\: :ref:`Array`\[:ref:`GLTFSkin`\]\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_texture_samplers`\ (\ texture_samplers\: :ref:`Array`\[:ref:`GLTFTextureSampler`\]\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_textures`\ (\ textures\: :ref:`Array`\[:ref:`GLTFTexture`\]\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_unique_animation_names`\ (\ unique_animation_names\: :ref:`Array`\[:ref:`String`\]\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_unique_names`\ (\ unique_names\: :ref:`Array`\[:ref:`String`\]\ ) | + +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -214,8 +216,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_base_path** **(** :ref:`String` value **)** -- :ref:`String` **get_base_path** **(** **)** +- |void| **set_base_path**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_base_path**\ (\ ) The folder path associated with this GLTF data. This is used to find other files the GLTF file references, like images or binary buffers. This will be set during import when appending from a file, and will be set during export when writing to a file. @@ -227,12 +229,12 @@ The folder path associated with this GLTF data. This is used to find other files .. rst-class:: classref-property -:ref:`PackedByteArray[]` **buffers** = ``[]`` +:ref:`Array`\[:ref:`PackedByteArray`\] **buffers** = ``[]`` .. rst-class:: classref-property-setget -- void **set_buffers** **(** :ref:`PackedByteArray[]` value **)** -- :ref:`PackedByteArray[]` **get_buffers** **(** **)** +- |void| **set_buffers**\ (\ value\: :ref:`Array`\[:ref:`PackedByteArray`\]\ ) +- :ref:`Array`\[:ref:`PackedByteArray`\] **get_buffers**\ (\ ) .. container:: contribute @@ -250,8 +252,8 @@ The folder path associated with this GLTF data. This is used to find other files .. rst-class:: classref-property-setget -- void **set_copyright** **(** :ref:`String` value **)** -- :ref:`String` **get_copyright** **(** **)** +- |void| **set_copyright**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_copyright**\ (\ ) The copyright string in the asset header of the GLTF file. This is set during import if present and export if non-empty. See the GLTF asset header documentation for more information. @@ -267,8 +269,8 @@ The copyright string in the asset header of the GLTF file. This is set during im .. rst-class:: classref-property-setget -- void **set_create_animations** **(** :ref:`bool` value **)** -- :ref:`bool` **get_create_animations** **(** **)** +- |void| **set_create_animations**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_create_animations**\ (\ ) .. container:: contribute @@ -286,8 +288,8 @@ The copyright string in the asset header of the GLTF file. This is set during im .. rst-class:: classref-property-setget -- void **set_filename** **(** :ref:`String` value **)** -- :ref:`String` **get_filename** **(** **)** +- |void| **set_filename**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_filename**\ (\ ) The file name associated with this GLTF data. If it ends with ``.gltf``, this is text-based GLTF, otherwise this is binary GLB. This will be set during import when appending from a file, and will be set during export when writing to a file. If writing to a buffer, this will be an empty string. @@ -303,8 +305,8 @@ The file name associated with this GLTF data. If it ends with ``.gltf``, this is .. rst-class:: classref-property-setget -- void **set_glb_data** **(** :ref:`PackedByteArray` value **)** -- :ref:`PackedByteArray` **get_glb_data** **(** **)** +- |void| **set_glb_data**\ (\ value\: :ref:`PackedByteArray`\ ) +- :ref:`PackedByteArray` **get_glb_data**\ (\ ) .. container:: contribute @@ -322,8 +324,8 @@ The file name associated with this GLTF data. If it ends with ``.gltf``, this is .. rst-class:: classref-property-setget -- void **set_json** **(** :ref:`Dictionary` value **)** -- :ref:`Dictionary` **get_json** **(** **)** +- |void| **set_json**\ (\ value\: :ref:`Dictionary`\ ) +- :ref:`Dictionary` **get_json**\ (\ ) .. container:: contribute @@ -341,8 +343,8 @@ The file name associated with this GLTF data. If it ends with ``.gltf``, this is .. rst-class:: classref-property-setget -- void **set_major_version** **(** :ref:`int` value **)** -- :ref:`int` **get_major_version** **(** **)** +- |void| **set_major_version**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_major_version**\ (\ ) .. container:: contribute @@ -360,8 +362,8 @@ The file name associated with this GLTF data. If it ends with ``.gltf``, this is .. rst-class:: classref-property-setget -- void **set_minor_version** **(** :ref:`int` value **)** -- :ref:`int` **get_minor_version** **(** **)** +- |void| **set_minor_version**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_minor_version**\ (\ ) .. container:: contribute @@ -379,8 +381,8 @@ The file name associated with this GLTF data. If it ends with ``.gltf``, this is .. rst-class:: classref-property-setget -- void **set_root_nodes** **(** :ref:`PackedInt32Array` value **)** -- :ref:`PackedInt32Array` **get_root_nodes** **(** **)** +- |void| **set_root_nodes**\ (\ value\: :ref:`PackedInt32Array`\ ) +- :ref:`PackedInt32Array` **get_root_nodes**\ (\ ) The root nodes of the GLTF file. Typically, a GLTF file will only have one scene, and therefore one root node. However, a GLTF file may have multiple scenes and therefore multiple root nodes, which will be generated as siblings of each other and as children of the root node of the generated Godot scene. @@ -396,8 +398,8 @@ The root nodes of the GLTF file. Typically, a GLTF file will only have one scene .. rst-class:: classref-property-setget -- void **set_scene_name** **(** :ref:`String` value **)** -- :ref:`String` **get_scene_name** **(** **)** +- |void| **set_scene_name**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_scene_name**\ (\ ) The name of the scene. When importing, if not specified, this will be the file name. When exporting, if specified, the scene name will be saved to the GLTF file. @@ -413,8 +415,8 @@ The name of the scene. When importing, if not specified, this will be the file n .. rst-class:: classref-property-setget -- void **set_use_named_skin_binds** **(** :ref:`bool` value **)** -- :ref:`bool` **get_use_named_skin_binds** **(** **)** +- |void| **set_use_named_skin_binds**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_named_skin_binds**\ (\ ) .. container:: contribute @@ -433,7 +435,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_used_extension** **(** :ref:`String` extension_name, :ref:`bool` required **)** +|void| **add_used_extension**\ (\ extension_name\: :ref:`String`, required\: :ref:`bool`\ ) Appends an extension to the list of extensions used by this GLTF file during serialization. If ``required`` is true, the extension will also be added to the list of required extensions. Do not run this in :ref:`GLTFDocumentExtension._export_post`, as that stage is too late to add extensions. The final list is sorted alphabetically. @@ -445,7 +447,7 @@ Appends an extension to the list of extensions used by this GLTF file during ser .. rst-class:: classref-method -:ref:`int` **append_data_to_buffers** **(** :ref:`PackedByteArray` data, :ref:`bool` deduplication **)** +:ref:`int` **append_data_to_buffers**\ (\ data\: :ref:`PackedByteArray`, deduplication\: :ref:`bool`\ ) Appends the given byte array data to the buffers and creates a :ref:`GLTFBufferView` for it. The index of the destination :ref:`GLTFBufferView` is returned. If ``deduplication`` is true, the buffers will first be searched for duplicate data, otherwise new bytes will always be appended. @@ -457,7 +459,7 @@ Appends the given byte array data to the buffers and creates a :ref:`GLTFBufferV .. rst-class:: classref-method -:ref:`GLTFAccessor[]` **get_accessors** **(** **)** +:ref:`Array`\[:ref:`GLTFAccessor`\] **get_accessors**\ (\ ) .. container:: contribute @@ -471,7 +473,7 @@ Appends the given byte array data to the buffers and creates a :ref:`GLTFBufferV .. rst-class:: classref-method -:ref:`Variant` **get_additional_data** **(** :ref:`StringName` extension_name **)** +:ref:`Variant` **get_additional_data**\ (\ extension_name\: :ref:`StringName`\ ) Gets additional arbitrary data in this **GLTFState** instance. This can be used to keep per-file state data in :ref:`GLTFDocumentExtension` classes, which is important because they are stateless. @@ -485,7 +487,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_animation_player** **(** :ref:`int` idx **)** +:ref:`AnimationPlayer` **get_animation_player**\ (\ idx\: :ref:`int`\ ) Returns the :ref:`AnimationPlayer` node with the given index. These nodes are only used during the export process when converting Godot :ref:`AnimationPlayer` nodes to GLTF animations. @@ -497,7 +499,7 @@ Returns the :ref:`AnimationPlayer` node with the given in .. rst-class:: classref-method -:ref:`int` **get_animation_players_count** **(** :ref:`int` idx **)** +:ref:`int` **get_animation_players_count**\ (\ idx\: :ref:`int`\ ) Returns the number of :ref:`AnimationPlayer` nodes in this **GLTFState**. These nodes are only used during the export process when converting Godot :ref:`AnimationPlayer` nodes to GLTF animations. @@ -509,7 +511,7 @@ Returns the number of :ref:`AnimationPlayer` nodes in thi .. rst-class:: classref-method -:ref:`GLTFAnimation[]` **get_animations** **(** **)** +:ref:`Array`\[:ref:`GLTFAnimation`\] **get_animations**\ (\ ) Returns an array of all :ref:`GLTFAnimation`\ s in the GLTF file. When importing, these will be generated as animations in an :ref:`AnimationPlayer` node. When exporting, these will be generated from Godot :ref:`AnimationPlayer` nodes. @@ -521,7 +523,7 @@ Returns an array of all :ref:`GLTFAnimation`\ s in the GLTF .. rst-class:: classref-method -:ref:`GLTFBufferView[]` **get_buffer_views** **(** **)** +:ref:`Array`\[:ref:`GLTFBufferView`\] **get_buffer_views**\ (\ ) .. container:: contribute @@ -535,7 +537,7 @@ Returns an array of all :ref:`GLTFAnimation`\ s in the GLTF .. rst-class:: classref-method -:ref:`GLTFCamera[]` **get_cameras** **(** **)** +:ref:`Array`\[:ref:`GLTFCamera`\] **get_cameras**\ (\ ) Returns an array of all :ref:`GLTFCamera`\ s in the GLTF file. These are the cameras that the :ref:`GLTFNode.camera` index refers to. @@ -547,7 +549,7 @@ Returns an array of all :ref:`GLTFCamera`\ s in the GLTF file. .. rst-class:: classref-method -:ref:`int` **get_handle_binary_image** **(** **)** +:ref:`int` **get_handle_binary_image**\ (\ ) .. container:: contribute @@ -561,7 +563,7 @@ Returns an array of all :ref:`GLTFCamera`\ s in the GLTF file. .. rst-class:: classref-method -:ref:`Texture2D[]` **get_images** **(** **)** +:ref:`Array`\[:ref:`Texture2D`\] **get_images**\ (\ ) Gets the images of the GLTF file as an array of :ref:`Texture2D`\ s. These are the images that the :ref:`GLTFTexture.src_image` index refers to. @@ -573,7 +575,7 @@ Gets the images of the GLTF file as an array of :ref:`Texture2D .. rst-class:: classref-method -:ref:`GLTFLight[]` **get_lights** **(** **)** +:ref:`Array`\[:ref:`GLTFLight`\] **get_lights**\ (\ ) Returns an array of all :ref:`GLTFLight`\ s in the GLTF file. These are the lights that the :ref:`GLTFNode.light` index refers to. @@ -585,7 +587,7 @@ Returns an array of all :ref:`GLTFLight`\ s in the GLTF file. T .. rst-class:: classref-method -:ref:`Material[]` **get_materials** **(** **)** +:ref:`Array`\[:ref:`Material`\] **get_materials**\ (\ ) .. container:: contribute @@ -599,7 +601,7 @@ Returns an array of all :ref:`GLTFLight`\ s in the GLTF file. T .. rst-class:: classref-method -:ref:`GLTFMesh[]` **get_meshes** **(** **)** +:ref:`Array`\[:ref:`GLTFMesh`\] **get_meshes**\ (\ ) Returns an array of all :ref:`GLTFMesh`\ es in the GLTF file. These are the meshes that the :ref:`GLTFNode.mesh` index refers to. @@ -611,7 +613,7 @@ Returns an array of all :ref:`GLTFMesh`\ es in the GLTF file. Th .. rst-class:: classref-method -:ref:`int` **get_node_index** **(** :ref:`Node` scene_node **)** +:ref:`int` **get_node_index**\ (\ scene_node\: :ref:`Node`\ ) Returns the index of the :ref:`GLTFNode` corresponding to this Godot scene node. This is the inverse of :ref:`get_scene_node`. Useful during the export process. @@ -625,7 +627,7 @@ Returns the index of the :ref:`GLTFNode` corresponding to this G .. rst-class:: classref-method -:ref:`GLTFNode[]` **get_nodes** **(** **)** +:ref:`Array`\[:ref:`GLTFNode`\] **get_nodes**\ (\ ) Returns an array of all :ref:`GLTFNode`\ s in the GLTF file. These are the nodes that :ref:`GLTFNode.children` and :ref:`root_nodes` refer to. This includes nodes that may not be generated in the Godot scene, or nodes that may generate multiple Godot scene nodes. @@ -637,7 +639,7 @@ Returns an array of all :ref:`GLTFNode`\ s in the GLTF file. The .. rst-class:: classref-method -:ref:`Node` **get_scene_node** **(** :ref:`int` idx **)** +:ref:`Node` **get_scene_node**\ (\ idx\: :ref:`int`\ ) Returns the Godot scene node that corresponds to the same index as the :ref:`GLTFNode` it was generated from. This is the inverse of :ref:`get_node_index`. Useful during the import process. @@ -651,7 +653,7 @@ Returns the Godot scene node that corresponds to the same index as the :ref:`GLT .. rst-class:: classref-method -:ref:`GLTFSkeleton[]` **get_skeletons** **(** **)** +:ref:`Array`\[:ref:`GLTFSkeleton`\] **get_skeletons**\ (\ ) Returns an array of all :ref:`GLTFSkeleton`\ s in the GLTF file. These are the skeletons that the :ref:`GLTFNode.skeleton` index refers to. @@ -663,7 +665,7 @@ Returns an array of all :ref:`GLTFSkeleton`\ s in the GLTF f .. rst-class:: classref-method -:ref:`GLTFSkin[]` **get_skins** **(** **)** +:ref:`Array`\[:ref:`GLTFSkin`\] **get_skins**\ (\ ) Returns an array of all :ref:`GLTFSkin`\ s in the GLTF file. These are the skins that the :ref:`GLTFNode.skin` index refers to. @@ -675,7 +677,7 @@ Returns an array of all :ref:`GLTFSkin`\ s in the GLTF file. The .. rst-class:: classref-method -:ref:`GLTFTextureSampler[]` **get_texture_samplers** **(** **)** +:ref:`Array`\[:ref:`GLTFTextureSampler`\] **get_texture_samplers**\ (\ ) Retrieves the array of texture samplers that are used by the textures contained in the GLTF. @@ -687,7 +689,7 @@ Retrieves the array of texture samplers that are used by the textures contained .. rst-class:: classref-method -:ref:`GLTFTexture[]` **get_textures** **(** **)** +:ref:`Array`\[:ref:`GLTFTexture`\] **get_textures**\ (\ ) .. container:: contribute @@ -701,7 +703,7 @@ Retrieves the array of texture samplers that are used by the textures contained .. rst-class:: classref-method -:ref:`String[]` **get_unique_animation_names** **(** **)** +:ref:`Array`\[:ref:`String`\] **get_unique_animation_names**\ (\ ) Returns an array of unique animation names. This is only used during the import process. @@ -713,7 +715,7 @@ Returns an array of unique animation names. This is only used during the import .. rst-class:: classref-method -:ref:`String[]` **get_unique_names** **(** **)** +:ref:`Array`\[:ref:`String`\] **get_unique_names**\ (\ ) Returns an array of unique node names. This is used in both the import process and export process. @@ -725,7 +727,7 @@ Returns an array of unique node names. This is used in both the import process a .. rst-class:: classref-method -void **set_accessors** **(** :ref:`GLTFAccessor[]` accessors **)** +|void| **set_accessors**\ (\ accessors\: :ref:`Array`\[:ref:`GLTFAccessor`\]\ ) .. container:: contribute @@ -739,7 +741,7 @@ void **set_accessors** **(** :ref:`GLTFAccessor[]` accessors .. rst-class:: classref-method -void **set_additional_data** **(** :ref:`StringName` extension_name, :ref:`Variant` additional_data **)** +|void| **set_additional_data**\ (\ extension_name\: :ref:`StringName`, additional_data\: :ref:`Variant`\ ) Sets additional arbitrary data in this **GLTFState** instance. This can be used to keep per-file state data in :ref:`GLTFDocumentExtension` classes, which is important because they are stateless. @@ -753,7 +755,7 @@ The first argument should be the :ref:`GLTFDocumentExtension` animations **)** +|void| **set_animations**\ (\ animations\: :ref:`Array`\[:ref:`GLTFAnimation`\]\ ) Sets the :ref:`GLTFAnimation`\ s in the state. When importing, these will be generated as animations in an :ref:`AnimationPlayer` node. When exporting, these will be generated from Godot :ref:`AnimationPlayer` nodes. @@ -765,7 +767,7 @@ Sets the :ref:`GLTFAnimation`\ s in the state. When importi .. rst-class:: classref-method -void **set_buffer_views** **(** :ref:`GLTFBufferView[]` buffer_views **)** +|void| **set_buffer_views**\ (\ buffer_views\: :ref:`Array`\[:ref:`GLTFBufferView`\]\ ) .. container:: contribute @@ -779,7 +781,7 @@ void **set_buffer_views** **(** :ref:`GLTFBufferView[]` bu .. rst-class:: classref-method -void **set_cameras** **(** :ref:`GLTFCamera[]` cameras **)** +|void| **set_cameras**\ (\ cameras\: :ref:`Array`\[:ref:`GLTFCamera`\]\ ) Sets the :ref:`GLTFCamera`\ s in the state. These are the cameras that the :ref:`GLTFNode.camera` index refers to. @@ -791,7 +793,7 @@ Sets the :ref:`GLTFCamera`\ s in the state. These are the came .. rst-class:: classref-method -void **set_handle_binary_image** **(** :ref:`int` method **)** +|void| **set_handle_binary_image**\ (\ method\: :ref:`int`\ ) .. container:: contribute @@ -805,7 +807,7 @@ void **set_handle_binary_image** **(** :ref:`int` method **)** .. rst-class:: classref-method -void **set_images** **(** :ref:`Texture2D[]` images **)** +|void| **set_images**\ (\ images\: :ref:`Array`\[:ref:`Texture2D`\]\ ) Sets the images in the state stored as an array of :ref:`Texture2D`\ s. This can be used during export. These are the images that the :ref:`GLTFTexture.src_image` index refers to. @@ -817,7 +819,7 @@ Sets the images in the state stored as an array of :ref:`Texture2D` lights **)** +|void| **set_lights**\ (\ lights\: :ref:`Array`\[:ref:`GLTFLight`\]\ ) Sets the :ref:`GLTFLight`\ s in the state. These are the lights that the :ref:`GLTFNode.light` index refers to. @@ -829,7 +831,7 @@ Sets the :ref:`GLTFLight`\ s in the state. These are the lights .. rst-class:: classref-method -void **set_materials** **(** :ref:`Material[]` materials **)** +|void| **set_materials**\ (\ materials\: :ref:`Array`\[:ref:`Material`\]\ ) .. container:: contribute @@ -843,7 +845,7 @@ void **set_materials** **(** :ref:`Material[]` materials **)** .. rst-class:: classref-method -void **set_meshes** **(** :ref:`GLTFMesh[]` meshes **)** +|void| **set_meshes**\ (\ meshes\: :ref:`Array`\[:ref:`GLTFMesh`\]\ ) Sets the :ref:`GLTFMesh`\ es in the state. These are the meshes that the :ref:`GLTFNode.mesh` index refers to. @@ -855,7 +857,7 @@ Sets the :ref:`GLTFMesh`\ es in the state. These are the meshes .. rst-class:: classref-method -void **set_nodes** **(** :ref:`GLTFNode[]` nodes **)** +|void| **set_nodes**\ (\ nodes\: :ref:`Array`\[:ref:`GLTFNode`\]\ ) Sets the :ref:`GLTFNode`\ s in the state. These are the nodes that :ref:`GLTFNode.children` and :ref:`root_nodes` refer to. Some of the nodes set here may not be generated in the Godot scene, or may generate multiple Godot scene nodes. @@ -867,7 +869,7 @@ Sets the :ref:`GLTFNode`\ s in the state. These are the nodes th .. rst-class:: classref-method -void **set_skeletons** **(** :ref:`GLTFSkeleton[]` skeletons **)** +|void| **set_skeletons**\ (\ skeletons\: :ref:`Array`\[:ref:`GLTFSkeleton`\]\ ) Sets the :ref:`GLTFSkeleton`\ s in the state. These are the skeletons that the :ref:`GLTFNode.skeleton` index refers to. @@ -879,7 +881,7 @@ Sets the :ref:`GLTFSkeleton`\ s in the state. These are the .. rst-class:: classref-method -void **set_skins** **(** :ref:`GLTFSkin[]` skins **)** +|void| **set_skins**\ (\ skins\: :ref:`Array`\[:ref:`GLTFSkin`\]\ ) Sets the :ref:`GLTFSkin`\ s in the state. These are the skins that the :ref:`GLTFNode.skin` index refers to. @@ -891,7 +893,7 @@ Sets the :ref:`GLTFSkin`\ s in the state. These are the skins th .. rst-class:: classref-method -void **set_texture_samplers** **(** :ref:`GLTFTextureSampler[]` texture_samplers **)** +|void| **set_texture_samplers**\ (\ texture_samplers\: :ref:`Array`\[:ref:`GLTFTextureSampler`\]\ ) Sets the array of texture samplers that are used by the textures contained in the GLTF. @@ -903,7 +905,7 @@ Sets the array of texture samplers that are used by the textures contained in th .. rst-class:: classref-method -void **set_textures** **(** :ref:`GLTFTexture[]` textures **)** +|void| **set_textures**\ (\ textures\: :ref:`Array`\[:ref:`GLTFTexture`\]\ ) .. container:: contribute @@ -917,7 +919,7 @@ void **set_textures** **(** :ref:`GLTFTexture[]` textures **) .. rst-class:: classref-method -void **set_unique_animation_names** **(** :ref:`String[]` unique_animation_names **)** +|void| **set_unique_animation_names**\ (\ unique_animation_names\: :ref:`Array`\[:ref:`String`\]\ ) Sets the unique animation names in the state. This is only used during the import process. @@ -929,7 +931,7 @@ Sets the unique animation names in the state. This is only used during the impor .. rst-class:: classref-method -void **set_unique_names** **(** :ref:`String[]` unique_names **)** +|void| **set_unique_names**\ (\ unique_names\: :ref:`Array`\[:ref:`String`\]\ ) Sets the unique node names in the state. This is used in both the import process and export process. @@ -940,3 +942,4 @@ Sets the unique node names in the state. This is used in both the import process .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gltftexture.rst b/classes/class_gltftexture.rst index ce77f726ff5..bf9609441fe 100644 --- a/classes/class_gltftexture.rst +++ b/classes/class_gltftexture.rst @@ -12,9 +12,7 @@ GLTFTexture **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -.. container:: contribute - - There is currently no description for this class. Please help us by :ref:`contributing one `! +GLTFTexture represents a texture in an GLTF file. .. rst-class:: classref-introduction-group @@ -54,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_sampler** **(** :ref:`int` value **)** -- :ref:`int` **get_sampler** **(** **)** +- |void| **set_sampler**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_sampler**\ (\ ) ID of the texture sampler to use when sampling the image. If -1, then the default texture sampler is used (linear filtering, and repeat wrapping in both axes). @@ -71,8 +69,8 @@ ID of the texture sampler to use when sampling the image. If -1, then the defaul .. rst-class:: classref-property-setget -- void **set_src_image** **(** :ref:`int` value **)** -- :ref:`int` **get_src_image** **(** **)** +- |void| **set_src_image**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_src_image**\ (\ ) The index of the image associated with this texture, see :ref:`GLTFState.get_images`. If -1, then this texture does not have an image assigned. @@ -83,3 +81,4 @@ The index of the image associated with this texture, see :ref:`GLTFState.get_ima .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gltftexturesampler.rst b/classes/class_gltftexturesampler.rst index 9808ea3140d..f8f5081d7fa 100644 --- a/classes/class_gltftexturesampler.rst +++ b/classes/class_gltftexturesampler.rst @@ -63,8 +63,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_mag_filter** **(** :ref:`int` value **)** -- :ref:`int` **get_mag_filter** **(** **)** +- |void| **set_mag_filter**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_mag_filter**\ (\ ) Texture's magnification filter, used when texture appears larger on screen than the source image. @@ -80,8 +80,8 @@ Texture's magnification filter, used when texture appears larger on screen than .. rst-class:: classref-property-setget -- void **set_min_filter** **(** :ref:`int` value **)** -- :ref:`int` **get_min_filter** **(** **)** +- |void| **set_min_filter**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_min_filter**\ (\ ) Texture's minification filter, used when the texture appears smaller on screen than the source image. @@ -97,8 +97,8 @@ Texture's minification filter, used when the texture appears smaller on screen t .. rst-class:: classref-property-setget -- void **set_wrap_s** **(** :ref:`int` value **)** -- :ref:`int` **get_wrap_s** **(** **)** +- |void| **set_wrap_s**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_wrap_s**\ (\ ) Wrapping mode to use for S-axis (horizontal) texture coordinates. @@ -114,8 +114,8 @@ Wrapping mode to use for S-axis (horizontal) texture coordinates. .. rst-class:: classref-property-setget -- void **set_wrap_t** **(** :ref:`int` value **)** -- :ref:`int` **get_wrap_t** **(** **)** +- |void| **set_wrap_t**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_wrap_t**\ (\ ) Wrapping mode to use for T-axis (vertical) texture coordinates. @@ -126,3 +126,4 @@ Wrapping mode to use for T-axis (vertical) texture coordinates. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_godotsharp.rst b/classes/class_godotsharp.rst index a47a343df0e..35b23938761 100644 --- a/classes/class_godotsharp.rst +++ b/classes/class_godotsharp.rst @@ -31,9 +31,9 @@ Methods .. table:: :widths: auto - +-------------------------+-------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_runtime_initialized` **(** **)** | - +-------------------------+-------------------------------------------------------------------------------------------+ + +-------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_runtime_initialized`\ (\ ) | + +-------------------------+-------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -48,7 +48,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_runtime_initialized** **(** **)** +:ref:`bool` **is_runtime_initialized**\ (\ ) Returns ``true`` if the .NET runtime is initialized, ``false`` otherwise. @@ -59,3 +59,4 @@ Returns ``true`` if the .NET runtime is initialized, ``false`` otherwise. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gpuparticles2d.rst b/classes/class_gpuparticles2d.rst index b1f43904827..356c86bc5f7 100644 --- a/classes/class_gpuparticles2d.rst +++ b/classes/class_gpuparticles2d.rst @@ -102,15 +102,15 @@ Methods .. table:: :widths: auto - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`capture_rect` **(** **)** |const| | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`convert_from_particles` **(** :ref:`Node` particles **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`emit_particle` **(** :ref:`Transform2D` xform, :ref:`Vector2` velocity, :ref:`Color` color, :ref:`Color` custom, :ref:`int` flags **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`restart` **(** **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`capture_rect`\ (\ ) |const| | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`convert_from_particles`\ (\ particles\: :ref:`Node`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`emit_particle`\ (\ xform\: :ref:`Transform2D`, velocity\: :ref:`Vector2`, color\: :ref:`Color`, custom\: :ref:`Color`, flags\: :ref:`int`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`restart`\ (\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -125,7 +125,7 @@ Signals .. rst-class:: classref-signal -**finished** **(** **)** +**finished**\ (\ ) Emitted when all active particles have finished processing. When :ref:`one_shot` is disabled, particles will process continuously, so this is never emitted. @@ -237,8 +237,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_amount** **(** :ref:`int` value **)** -- :ref:`int` **get_amount** **(** **)** +- |void| **set_amount**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_amount**\ (\ ) The number of particles to emit in one emission cycle. The effective emission rate is ``(amount * amount_ratio) / lifetime`` particles per second. Higher values will increase GPU requirements, even if not all particles are visible at a given time or if :ref:`amount_ratio` is decreased. @@ -256,8 +256,8 @@ The number of particles to emit in one emission cycle. The effective emission ra .. rst-class:: classref-property-setget -- void **set_amount_ratio** **(** :ref:`float` value **)** -- :ref:`float` **get_amount_ratio** **(** **)** +- |void| **set_amount_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_amount_ratio**\ (\ ) The ratio of particles that should actually be emitted. If set to a value lower than ``1.0``, this will set the amount of emitted particles throughout the lifetime to ``amount * amount_ratio``. Unlike changing :ref:`amount`, changing :ref:`amount_ratio` while emitting does not affect already-emitted particles and doesn't cause the particle system to restart. :ref:`amount_ratio` can be used to create effects that make the number of emitted particles vary over time. @@ -275,8 +275,8 @@ The ratio of particles that should actually be emitted. If set to a value lower .. rst-class:: classref-property-setget -- void **set_collision_base_size** **(** :ref:`float` value **)** -- :ref:`float` **get_collision_base_size** **(** **)** +- |void| **set_collision_base_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_collision_base_size**\ (\ ) Multiplier for particle's collision radius. ``1.0`` corresponds to the size of the sprite. If particles appear to sink into the ground when colliding, increase this value. If particles appear to float when colliding, decrease this value. Only effective if :ref:`ParticleProcessMaterial.collision_mode` is :ref:`ParticleProcessMaterial.COLLISION_RIGID` or :ref:`ParticleProcessMaterial.COLLISION_HIDE_ON_CONTACT`. @@ -294,8 +294,8 @@ Multiplier for particle's collision radius. ``1.0`` corresponds to the size of t .. rst-class:: classref-property-setget -- void **set_draw_order** **(** :ref:`DrawOrder` value **)** -- :ref:`DrawOrder` **get_draw_order** **(** **)** +- |void| **set_draw_order**\ (\ value\: :ref:`DrawOrder`\ ) +- :ref:`DrawOrder` **get_draw_order**\ (\ ) Particle draw order. Uses :ref:`DrawOrder` values. @@ -311,8 +311,8 @@ Particle draw order. Uses :ref:`DrawOrder` values .. rst-class:: classref-property-setget -- void **set_emitting** **(** :ref:`bool` value **)** -- :ref:`bool` **is_emitting** **(** **)** +- |void| **set_emitting**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_emitting**\ (\ ) If ``true``, particles are being emitted. :ref:`emitting` can be used to start and stop particles from emitting. However, if :ref:`one_shot` is ``true`` setting :ref:`emitting` to ``true`` will not restart the emission cycle until after all active particles finish processing. You can use the :ref:`finished` signal to be notified once all active particles finish processing. @@ -328,8 +328,8 @@ If ``true``, particles are being emitted. :ref:`emitting` value **)** -- :ref:`float` **get_explosiveness_ratio** **(** **)** +- |void| **set_explosiveness_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_explosiveness_ratio**\ (\ ) How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. @@ -345,8 +345,8 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t .. rst-class:: classref-property-setget -- void **set_fixed_fps** **(** :ref:`int` value **)** -- :ref:`int` **get_fixed_fps** **(** **)** +- |void| **set_fixed_fps**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_fixed_fps**\ (\ ) The particle system's frame rate is fixed to a value. For example, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. @@ -362,8 +362,8 @@ The particle system's frame rate is fixed to a value. For example, changing the .. rst-class:: classref-property-setget -- void **set_fractional_delta** **(** :ref:`bool` value **)** -- :ref:`bool` **get_fractional_delta** **(** **)** +- |void| **set_fractional_delta**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_fractional_delta**\ (\ ) If ``true``, results in fractional delta calculation which has a smoother particles display effect. @@ -379,8 +379,8 @@ If ``true``, results in fractional delta calculation which has a smoother partic .. rst-class:: classref-property-setget -- void **set_interp_to_end** **(** :ref:`float` value **)** -- :ref:`float` **get_interp_to_end** **(** **)** +- |void| **set_interp_to_end**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_interp_to_end**\ (\ ) Causes all the particles in this node to interpolate towards the end of their lifetime. @@ -398,8 +398,8 @@ Causes all the particles in this node to interpolate towards the end of their li .. rst-class:: classref-property-setget -- void **set_interpolate** **(** :ref:`bool` value **)** -- :ref:`bool` **get_interpolate** **(** **)** +- |void| **set_interpolate**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_interpolate**\ (\ ) Enables particle interpolation, which makes the particle movement smoother when their :ref:`fixed_fps` is lower than the screen refresh rate. @@ -415,8 +415,8 @@ Enables particle interpolation, which makes the particle movement smoother when .. rst-class:: classref-property-setget -- void **set_lifetime** **(** :ref:`float` value **)** -- :ref:`float` **get_lifetime** **(** **)** +- |void| **set_lifetime**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_lifetime**\ (\ ) The amount of time each particle will exist (in seconds). The effective emission rate is ``(amount * amount_ratio) / lifetime`` particles per second. @@ -432,8 +432,8 @@ The amount of time each particle will exist (in seconds). The effective emission .. rst-class:: classref-property-setget -- void **set_use_local_coordinates** **(** :ref:`bool` value **)** -- :ref:`bool` **get_use_local_coordinates** **(** **)** +- |void| **set_use_local_coordinates**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_local_coordinates**\ (\ ) If ``true``, particles use the parent node's coordinate space (known as local coordinates). This will cause particles to move and rotate along the **GPUParticles2D** node (and its parents) when it is moved or rotated. If ``false``, particles use global coordinates; they will not move or rotate along the **GPUParticles2D** node (and its parents) when it is moved or rotated. @@ -449,8 +449,8 @@ If ``true``, particles use the parent node's coordinate space (known as local co .. rst-class:: classref-property-setget -- void **set_one_shot** **(** :ref:`bool` value **)** -- :ref:`bool` **get_one_shot** **(** **)** +- |void| **set_one_shot**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_one_shot**\ (\ ) If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. @@ -466,8 +466,8 @@ If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emi .. rst-class:: classref-property-setget -- void **set_pre_process_time** **(** :ref:`float` value **)** -- :ref:`float` **get_pre_process_time** **(** **)** +- |void| **set_pre_process_time**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pre_process_time**\ (\ ) Particle system starts as if it had already run for this many seconds. @@ -483,8 +483,8 @@ Particle system starts as if it had already run for this many seconds. .. rst-class:: classref-property-setget -- void **set_process_material** **(** :ref:`Material` value **)** -- :ref:`Material` **get_process_material** **(** **)** +- |void| **set_process_material**\ (\ value\: :ref:`Material`\ ) +- :ref:`Material` **get_process_material**\ (\ ) :ref:`Material` for processing particles. Can be a :ref:`ParticleProcessMaterial` or a :ref:`ShaderMaterial`. @@ -500,8 +500,8 @@ Particle system starts as if it had already run for this many seconds. .. rst-class:: classref-property-setget -- void **set_randomness_ratio** **(** :ref:`float` value **)** -- :ref:`float` **get_randomness_ratio** **(** **)** +- |void| **set_randomness_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_randomness_ratio**\ (\ ) Emission lifetime randomness ratio. @@ -517,8 +517,8 @@ Emission lifetime randomness ratio. .. rst-class:: classref-property-setget -- void **set_speed_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_speed_scale** **(** **)** +- |void| **set_speed_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_speed_scale**\ (\ ) Particle system's running speed scaling ratio. A value of ``0`` can be used to pause the particles. @@ -534,8 +534,8 @@ Particle system's running speed scaling ratio. A value of ``0`` can be used to p .. rst-class:: classref-property-setget -- void **set_sub_emitter** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_sub_emitter** **(** **)** +- |void| **set_sub_emitter**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_sub_emitter**\ (\ ) Path to another **GPUParticles2D** node that will be used as a subemitter (see :ref:`ParticleProcessMaterial.sub_emitter_mode`). Subemitters can be used to achieve effects such as fireworks, sparks on collision, bubbles popping into water drops, and more. @@ -553,8 +553,8 @@ Path to another **GPUParticles2D** node that will be used as a subemitter (see : .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ ) Particle texture. If ``null``, particles will be squares with a size of 1×1 pixels. @@ -572,8 +572,8 @@ Particle texture. If ``null``, particles will be squares with a size of 1×1 pix .. rst-class:: classref-property-setget -- void **set_trail_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_trail_enabled** **(** **)** +- |void| **set_trail_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_trail_enabled**\ (\ ) If ``true``, enables particle trails using a mesh skinning system. @@ -591,8 +591,8 @@ If ``true``, enables particle trails using a mesh skinning system. .. rst-class:: classref-property-setget -- void **set_trail_lifetime** **(** :ref:`float` value **)** -- :ref:`float` **get_trail_lifetime** **(** **)** +- |void| **set_trail_lifetime**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_trail_lifetime**\ (\ ) The amount of time the particle's trail should represent (in seconds). Only effective if :ref:`trail_enabled` is ``true``. @@ -608,8 +608,8 @@ The amount of time the particle's trail should represent (in seconds). Only effe .. rst-class:: classref-property-setget -- void **set_trail_section_subdivisions** **(** :ref:`int` value **)** -- :ref:`int` **get_trail_section_subdivisions** **(** **)** +- |void| **set_trail_section_subdivisions**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_trail_section_subdivisions**\ (\ ) The number of subdivisions to use for the particle trail rendering. Higher values can result in smoother trail curves, at the cost of performance due to increased mesh complexity. See also :ref:`trail_sections`. Only effective if :ref:`trail_enabled` is ``true``. @@ -625,8 +625,8 @@ The number of subdivisions to use for the particle trail rendering. Higher value .. rst-class:: classref-property-setget -- void **set_trail_sections** **(** :ref:`int` value **)** -- :ref:`int` **get_trail_sections** **(** **)** +- |void| **set_trail_sections**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_trail_sections**\ (\ ) The number of sections to use for the particle trail rendering. Higher values can result in smoother trail curves, at the cost of performance due to increased mesh complexity. See also :ref:`trail_section_subdivisions`. Only effective if :ref:`trail_enabled` is ``true``. @@ -642,8 +642,8 @@ The number of sections to use for the particle trail rendering. Higher values ca .. rst-class:: classref-property-setget -- void **set_visibility_rect** **(** :ref:`Rect2` value **)** -- :ref:`Rect2` **get_visibility_rect** **(** **)** +- |void| **set_visibility_rect**\ (\ value\: :ref:`Rect2`\ ) +- :ref:`Rect2` **get_visibility_rect**\ (\ ) The :ref:`Rect2` that determines the node's region which needs to be visible on screen for the particle system to be active. @@ -662,7 +662,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Rect2` **capture_rect** **(** **)** |const| +:ref:`Rect2` **capture_rect**\ (\ ) |const| Returns a rectangle containing the positions of all existing particles. @@ -676,7 +676,7 @@ Returns a rectangle containing the positions of all existing particles. .. rst-class:: classref-method -void **convert_from_particles** **(** :ref:`Node` particles **)** +|void| **convert_from_particles**\ (\ particles\: :ref:`Node`\ ) Sets this node's properties to match a given :ref:`CPUParticles2D` node. @@ -688,7 +688,7 @@ Sets this node's properties to match a given :ref:`CPUParticles2D` xform, :ref:`Vector2` velocity, :ref:`Color` color, :ref:`Color` custom, :ref:`int` flags **)** +|void| **emit_particle**\ (\ xform\: :ref:`Transform2D`, velocity\: :ref:`Vector2`, color\: :ref:`Color`, custom\: :ref:`Color`, flags\: :ref:`int`\ ) Emits a single particle. Whether ``xform``, ``velocity``, ``color`` and ``custom`` are applied depends on the value of ``flags``. See :ref:`EmitFlags`. @@ -702,7 +702,7 @@ The default ParticleProcessMaterial will overwrite ``color`` and use the content .. rst-class:: classref-method -void **restart** **(** **)** +|void| **restart**\ (\ ) Restarts all the existing particles. @@ -713,3 +713,4 @@ Restarts all the existing particles. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gpuparticles3d.rst b/classes/class_gpuparticles3d.rst index 4ab0ac4e0e0..0f1922e00d6 100644 --- a/classes/class_gpuparticles3d.rst +++ b/classes/class_gpuparticles3d.rst @@ -108,19 +108,19 @@ Methods .. table:: :widths: auto - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`capture_aabb` **(** **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`convert_from_particles` **(** :ref:`Node` particles **)** | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`emit_particle` **(** :ref:`Transform3D` xform, :ref:`Vector3` velocity, :ref:`Color` color, :ref:`Color` custom, :ref:`int` flags **)** | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Mesh` | :ref:`get_draw_pass_mesh` **(** :ref:`int` pass **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`restart` **(** **)** | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_draw_pass_mesh` **(** :ref:`int` pass, :ref:`Mesh` mesh **)** | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`capture_aabb`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`convert_from_particles`\ (\ particles\: :ref:`Node`\ ) | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`emit_particle`\ (\ xform\: :ref:`Transform3D`, velocity\: :ref:`Vector3`, color\: :ref:`Color`, custom\: :ref:`Color`, flags\: :ref:`int`\ ) | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Mesh` | :ref:`get_draw_pass_mesh`\ (\ pass\: :ref:`int`\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`restart`\ (\ ) | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_draw_pass_mesh`\ (\ pass\: :ref:`int`, mesh\: :ref:`Mesh`\ ) | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -135,7 +135,7 @@ Signals .. rst-class:: classref-signal -**finished** **(** **)** +**finished**\ (\ ) Emitted when all active particles have finished processing. When :ref:`one_shot` is disabled, particles will process continuously, so this is never emitted. @@ -330,8 +330,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_amount** **(** :ref:`int` value **)** -- :ref:`int` **get_amount** **(** **)** +- |void| **set_amount**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_amount**\ (\ ) The number of particles to emit in one emission cycle. The effective emission rate is ``(amount * amount_ratio) / lifetime`` particles per second. Higher values will increase GPU requirements, even if not all particles are visible at a given time or if :ref:`amount_ratio` is decreased. @@ -349,8 +349,8 @@ The number of particles to emit in one emission cycle. The effective emission ra .. rst-class:: classref-property-setget -- void **set_amount_ratio** **(** :ref:`float` value **)** -- :ref:`float` **get_amount_ratio** **(** **)** +- |void| **set_amount_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_amount_ratio**\ (\ ) The ratio of particles that should actually be emitted. If set to a value lower than ``1.0``, this will set the amount of emitted particles throughout the lifetime to ``amount * amount_ratio``. Unlike changing :ref:`amount`, changing :ref:`amount_ratio` while emitting does not affect already-emitted particles and doesn't cause the particle system to restart. :ref:`amount_ratio` can be used to create effects that make the number of emitted particles vary over time. @@ -368,8 +368,8 @@ The ratio of particles that should actually be emitted. If set to a value lower .. rst-class:: classref-property-setget -- void **set_collision_base_size** **(** :ref:`float` value **)** -- :ref:`float` **get_collision_base_size** **(** **)** +- |void| **set_collision_base_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_collision_base_size**\ (\ ) The base diameter for particle collision in meters. If particles appear to sink into the ground when colliding, increase this value. If particles appear to float when colliding, decrease this value. Only effective if :ref:`ParticleProcessMaterial.collision_mode` is :ref:`ParticleProcessMaterial.COLLISION_RIGID` or :ref:`ParticleProcessMaterial.COLLISION_HIDE_ON_CONTACT`. @@ -387,8 +387,8 @@ The base diameter for particle collision in meters. If particles appear to sink .. rst-class:: classref-property-setget -- void **set_draw_order** **(** :ref:`DrawOrder` value **)** -- :ref:`DrawOrder` **get_draw_order** **(** **)** +- |void| **set_draw_order**\ (\ value\: :ref:`DrawOrder`\ ) +- :ref:`DrawOrder` **get_draw_order**\ (\ ) Particle draw order. Uses :ref:`DrawOrder` values. @@ -406,8 +406,8 @@ Particle draw order. Uses :ref:`DrawOrder` values .. rst-class:: classref-property-setget -- void **set_draw_pass_mesh** **(** :ref:`int` pass, :ref:`Mesh` mesh **)** -- :ref:`Mesh` **get_draw_pass_mesh** **(** :ref:`int` pass **)** |const| +- |void| **set_draw_pass_mesh**\ (\ pass\: :ref:`int`, mesh\: :ref:`Mesh`\ ) +- :ref:`Mesh` **get_draw_pass_mesh**\ (\ pass\: :ref:`int`\ ) |const| :ref:`Mesh` that is drawn for the first draw pass. @@ -423,8 +423,8 @@ Particle draw order. Uses :ref:`DrawOrder` values .. rst-class:: classref-property-setget -- void **set_draw_pass_mesh** **(** :ref:`int` pass, :ref:`Mesh` mesh **)** -- :ref:`Mesh` **get_draw_pass_mesh** **(** :ref:`int` pass **)** |const| +- |void| **set_draw_pass_mesh**\ (\ pass\: :ref:`int`, mesh\: :ref:`Mesh`\ ) +- :ref:`Mesh` **get_draw_pass_mesh**\ (\ pass\: :ref:`int`\ ) |const| :ref:`Mesh` that is drawn for the second draw pass. @@ -440,8 +440,8 @@ Particle draw order. Uses :ref:`DrawOrder` values .. rst-class:: classref-property-setget -- void **set_draw_pass_mesh** **(** :ref:`int` pass, :ref:`Mesh` mesh **)** -- :ref:`Mesh` **get_draw_pass_mesh** **(** :ref:`int` pass **)** |const| +- |void| **set_draw_pass_mesh**\ (\ pass\: :ref:`int`, mesh\: :ref:`Mesh`\ ) +- :ref:`Mesh` **get_draw_pass_mesh**\ (\ pass\: :ref:`int`\ ) |const| :ref:`Mesh` that is drawn for the third draw pass. @@ -457,8 +457,8 @@ Particle draw order. Uses :ref:`DrawOrder` values .. rst-class:: classref-property-setget -- void **set_draw_pass_mesh** **(** :ref:`int` pass, :ref:`Mesh` mesh **)** -- :ref:`Mesh` **get_draw_pass_mesh** **(** :ref:`int` pass **)** |const| +- |void| **set_draw_pass_mesh**\ (\ pass\: :ref:`int`, mesh\: :ref:`Mesh`\ ) +- :ref:`Mesh` **get_draw_pass_mesh**\ (\ pass\: :ref:`int`\ ) |const| :ref:`Mesh` that is drawn for the fourth draw pass. @@ -474,8 +474,8 @@ Particle draw order. Uses :ref:`DrawOrder` values .. rst-class:: classref-property-setget -- void **set_draw_passes** **(** :ref:`int` value **)** -- :ref:`int` **get_draw_passes** **(** **)** +- |void| **set_draw_passes**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_draw_passes**\ (\ ) The number of draw passes when rendering particles. @@ -491,8 +491,8 @@ The number of draw passes when rendering particles. .. rst-class:: classref-property-setget -- void **set_skin** **(** :ref:`Skin` value **)** -- :ref:`Skin` **get_skin** **(** **)** +- |void| **set_skin**\ (\ value\: :ref:`Skin`\ ) +- :ref:`Skin` **get_skin**\ (\ ) .. container:: contribute @@ -510,8 +510,8 @@ The number of draw passes when rendering particles. .. rst-class:: classref-property-setget -- void **set_emitting** **(** :ref:`bool` value **)** -- :ref:`bool` **is_emitting** **(** **)** +- |void| **set_emitting**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_emitting**\ (\ ) If ``true``, particles are being emitted. :ref:`emitting` can be used to start and stop particles from emitting. However, if :ref:`one_shot` is ``true`` setting :ref:`emitting` to ``true`` will not restart the emission cycle until after all active particles finish processing. You can use the :ref:`finished` signal to be notified once all active particles finish processing. @@ -527,8 +527,8 @@ If ``true``, particles are being emitted. :ref:`emitting` value **)** -- :ref:`float` **get_explosiveness_ratio** **(** **)** +- |void| **set_explosiveness_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_explosiveness_ratio**\ (\ ) Time ratio between each emission. If ``0``, particles are emitted continuously. If ``1``, all particles are emitted simultaneously. @@ -544,8 +544,8 @@ Time ratio between each emission. If ``0``, particles are emitted continuously. .. rst-class:: classref-property-setget -- void **set_fixed_fps** **(** :ref:`int` value **)** -- :ref:`int` **get_fixed_fps** **(** **)** +- |void| **set_fixed_fps**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_fixed_fps**\ (\ ) The particle system's frame rate is fixed to a value. For example, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. @@ -561,8 +561,8 @@ The particle system's frame rate is fixed to a value. For example, changing the .. rst-class:: classref-property-setget -- void **set_fractional_delta** **(** :ref:`bool` value **)** -- :ref:`bool` **get_fractional_delta** **(** **)** +- |void| **set_fractional_delta**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_fractional_delta**\ (\ ) If ``true``, results in fractional delta calculation which has a smoother particles display effect. @@ -578,8 +578,8 @@ If ``true``, results in fractional delta calculation which has a smoother partic .. rst-class:: classref-property-setget -- void **set_interp_to_end** **(** :ref:`float` value **)** -- :ref:`float` **get_interp_to_end** **(** **)** +- |void| **set_interp_to_end**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_interp_to_end**\ (\ ) Causes all the particles in this node to interpolate towards the end of their lifetime. @@ -597,8 +597,8 @@ Causes all the particles in this node to interpolate towards the end of their li .. rst-class:: classref-property-setget -- void **set_interpolate** **(** :ref:`bool` value **)** -- :ref:`bool` **get_interpolate** **(** **)** +- |void| **set_interpolate**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_interpolate**\ (\ ) Enables particle interpolation, which makes the particle movement smoother when their :ref:`fixed_fps` is lower than the screen refresh rate. @@ -614,8 +614,8 @@ Enables particle interpolation, which makes the particle movement smoother when .. rst-class:: classref-property-setget -- void **set_lifetime** **(** :ref:`float` value **)** -- :ref:`float` **get_lifetime** **(** **)** +- |void| **set_lifetime**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_lifetime**\ (\ ) The amount of time each particle will exist (in seconds). The effective emission rate is ``(amount * amount_ratio) / lifetime`` particles per second. @@ -631,8 +631,8 @@ The amount of time each particle will exist (in seconds). The effective emission .. rst-class:: classref-property-setget -- void **set_use_local_coordinates** **(** :ref:`bool` value **)** -- :ref:`bool` **get_use_local_coordinates** **(** **)** +- |void| **set_use_local_coordinates**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_local_coordinates**\ (\ ) If ``true``, particles use the parent node's coordinate space (known as local coordinates). This will cause particles to move and rotate along the **GPUParticles3D** node (and its parents) when it is moved or rotated. If ``false``, particles use global coordinates; they will not move or rotate along the **GPUParticles3D** node (and its parents) when it is moved or rotated. @@ -648,8 +648,8 @@ If ``true``, particles use the parent node's coordinate space (known as local co .. rst-class:: classref-property-setget -- void **set_one_shot** **(** :ref:`bool` value **)** -- :ref:`bool` **get_one_shot** **(** **)** +- |void| **set_one_shot**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_one_shot**\ (\ ) If ``true``, only the number of particles equal to :ref:`amount` will be emitted. @@ -665,8 +665,8 @@ If ``true``, only the number of particles equal to :ref:`amount` value **)** -- :ref:`float` **get_pre_process_time** **(** **)** +- |void| **set_pre_process_time**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pre_process_time**\ (\ ) Amount of time to preprocess the particles before animation starts. Lets you start the animation some time after particles have started emitting. @@ -682,8 +682,8 @@ Amount of time to preprocess the particles before animation starts. Lets you sta .. rst-class:: classref-property-setget -- void **set_process_material** **(** :ref:`Material` value **)** -- :ref:`Material` **get_process_material** **(** **)** +- |void| **set_process_material**\ (\ value\: :ref:`Material`\ ) +- :ref:`Material` **get_process_material**\ (\ ) :ref:`Material` for processing particles. Can be a :ref:`ParticleProcessMaterial` or a :ref:`ShaderMaterial`. @@ -699,8 +699,8 @@ Amount of time to preprocess the particles before animation starts. Lets you sta .. rst-class:: classref-property-setget -- void **set_randomness_ratio** **(** :ref:`float` value **)** -- :ref:`float` **get_randomness_ratio** **(** **)** +- |void| **set_randomness_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_randomness_ratio**\ (\ ) Emission randomness ratio. @@ -716,8 +716,8 @@ Emission randomness ratio. .. rst-class:: classref-property-setget -- void **set_speed_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_speed_scale** **(** **)** +- |void| **set_speed_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_speed_scale**\ (\ ) Speed scaling ratio. A value of ``0`` can be used to pause the particles. @@ -733,8 +733,8 @@ Speed scaling ratio. A value of ``0`` can be used to pause the particles. .. rst-class:: classref-property-setget -- void **set_sub_emitter** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_sub_emitter** **(** **)** +- |void| **set_sub_emitter**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_sub_emitter**\ (\ ) Path to another **GPUParticles3D** node that will be used as a subemitter (see :ref:`ParticleProcessMaterial.sub_emitter_mode`). Subemitters can be used to achieve effects such as fireworks, sparks on collision, bubbles popping into water drops, and more. @@ -752,8 +752,8 @@ Path to another **GPUParticles3D** node that will be used as a subemitter (see : .. rst-class:: classref-property-setget -- void **set_trail_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_trail_enabled** **(** **)** +- |void| **set_trail_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_trail_enabled**\ (\ ) If ``true``, enables particle trails using a mesh skinning system. Designed to work with :ref:`RibbonTrailMesh` and :ref:`TubeTrailMesh`. @@ -773,8 +773,8 @@ If ``true``, enables particle trails using a mesh skinning system. Designed to w .. rst-class:: classref-property-setget -- void **set_trail_lifetime** **(** :ref:`float` value **)** -- :ref:`float` **get_trail_lifetime** **(** **)** +- |void| **set_trail_lifetime**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_trail_lifetime**\ (\ ) The amount of time the particle's trail should represent (in seconds). Only effective if :ref:`trail_enabled` is ``true``. @@ -790,8 +790,8 @@ The amount of time the particle's trail should represent (in seconds). Only effe .. rst-class:: classref-property-setget -- void **set_transform_align** **(** :ref:`TransformAlign` value **)** -- :ref:`TransformAlign` **get_transform_align** **(** **)** +- |void| **set_transform_align**\ (\ value\: :ref:`TransformAlign`\ ) +- :ref:`TransformAlign` **get_transform_align**\ (\ ) .. container:: contribute @@ -809,8 +809,8 @@ The amount of time the particle's trail should represent (in seconds). Only effe .. rst-class:: classref-property-setget -- void **set_visibility_aabb** **(** :ref:`AABB` value **)** -- :ref:`AABB` **get_visibility_aabb** **(** **)** +- |void| **set_visibility_aabb**\ (\ value\: :ref:`AABB`\ ) +- :ref:`AABB` **get_visibility_aabb**\ (\ ) The :ref:`AABB` that determines the node's region which needs to be visible on screen for the particle system to be active. :ref:`GeometryInstance3D.extra_cull_margin` is added on each of the AABB's axes. Particle collisions and attraction will only occur within this area. @@ -831,7 +831,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AABB` **capture_aabb** **(** **)** |const| +:ref:`AABB` **capture_aabb**\ (\ ) |const| Returns the axis-aligned bounding box that contains all the particles that are active in the current frame. @@ -843,7 +843,7 @@ Returns the axis-aligned bounding box that contains all the particles that are a .. rst-class:: classref-method -void **convert_from_particles** **(** :ref:`Node` particles **)** +|void| **convert_from_particles**\ (\ particles\: :ref:`Node`\ ) Sets this node's properties to match a given :ref:`CPUParticles3D` node. @@ -855,7 +855,7 @@ Sets this node's properties to match a given :ref:`CPUParticles3D` xform, :ref:`Vector3` velocity, :ref:`Color` color, :ref:`Color` custom, :ref:`int` flags **)** +|void| **emit_particle**\ (\ xform\: :ref:`Transform3D`, velocity\: :ref:`Vector3`, color\: :ref:`Color`, custom\: :ref:`Color`, flags\: :ref:`int`\ ) Emits a single particle. Whether ``xform``, ``velocity``, ``color`` and ``custom`` are applied depends on the value of ``flags``. See :ref:`EmitFlags`. @@ -869,7 +869,7 @@ The default ParticleProcessMaterial will overwrite ``color`` and use the content .. rst-class:: classref-method -:ref:`Mesh` **get_draw_pass_mesh** **(** :ref:`int` pass **)** |const| +:ref:`Mesh` **get_draw_pass_mesh**\ (\ pass\: :ref:`int`\ ) |const| Returns the :ref:`Mesh` that is drawn at index ``pass``. @@ -881,7 +881,7 @@ Returns the :ref:`Mesh` that is drawn at index ``pass``. .. rst-class:: classref-method -void **restart** **(** **)** +|void| **restart**\ (\ ) Restarts the particle emission, clearing existing particles. @@ -893,7 +893,7 @@ Restarts the particle emission, clearing existing particles. .. rst-class:: classref-method -void **set_draw_pass_mesh** **(** :ref:`int` pass, :ref:`Mesh` mesh **)** +|void| **set_draw_pass_mesh**\ (\ pass\: :ref:`int`, mesh\: :ref:`Mesh`\ ) Sets the :ref:`Mesh` that is drawn at index ``pass``. @@ -904,3 +904,4 @@ Sets the :ref:`Mesh` that is drawn at index ``pass``. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gpuparticlesattractor3d.rst b/classes/class_gpuparticlesattractor3d.rst index 9a71165c7d4..df1af7032b9 100644 --- a/classes/class_gpuparticlesattractor3d.rst +++ b/classes/class_gpuparticlesattractor3d.rst @@ -64,8 +64,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_attenuation** **(** :ref:`float` value **)** -- :ref:`float` **get_attenuation** **(** **)** +- |void| **set_attenuation**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_attenuation**\ (\ ) The particle attractor's attenuation. Higher values result in more gradual pushing of particles as they come closer to the attractor's origin. Zero or negative values will cause particles to be pushed very fast as soon as the touch the attractor's edges. @@ -81,8 +81,8 @@ The particle attractor's attenuation. Higher values result in more gradual pushi .. rst-class:: classref-property-setget -- void **set_cull_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_cull_mask** **(** **)** +- |void| **set_cull_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_cull_mask**\ (\ ) The particle rendering layers (:ref:`VisualInstance3D.layers`) that will be affected by the attractor. By default, all particles are affected by an attractor. @@ -102,8 +102,8 @@ Particle attraction can also be disabled on a per-process material basis by sett .. rst-class:: classref-property-setget -- void **set_directionality** **(** :ref:`float` value **)** -- :ref:`float` **get_directionality** **(** **)** +- |void| **set_directionality**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_directionality**\ (\ ) Adjusts how directional the attractor is. At ``0.0``, the attractor is not directional at all: it will attract particles towards its center. At ``1.0``, the attractor is fully directional: particles will always be pushed towards local -Z (or +Z if :ref:`strength` is negative). @@ -121,8 +121,8 @@ Adjusts how directional the attractor is. At ``0.0``, the attractor is not direc .. rst-class:: classref-property-setget -- void **set_strength** **(** :ref:`float` value **)** -- :ref:`float` **get_strength** **(** **)** +- |void| **set_strength**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_strength**\ (\ ) Adjusts the strength of the attractor. If :ref:`strength` is negative, particles will be pushed in the opposite direction. Particles will be pushed *away* from the attractor's origin if :ref:`directionality` is ``0.0``, or towards local +Z if :ref:`directionality` is greater than ``0.0``. @@ -133,3 +133,4 @@ Adjusts the strength of the attractor. If :ref:`strength` value **)** -- :ref:`Vector3` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_size**\ (\ ) The attractor box's size in 3D units. @@ -66,3 +66,4 @@ The attractor box's size in 3D units. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gpuparticlesattractorsphere3d.rst b/classes/class_gpuparticlesattractorsphere3d.rst index 23f73482502..a3fc9c17f86 100644 --- a/classes/class_gpuparticlesattractorsphere3d.rst +++ b/classes/class_gpuparticlesattractorsphere3d.rst @@ -54,8 +54,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) The attractor sphere's radius in 3D units. @@ -68,3 +68,4 @@ The attractor sphere's radius in 3D units. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gpuparticlesattractorvectorfield3d.rst b/classes/class_gpuparticlesattractorvectorfield3d.rst index 09e9ac4772d..a222426e411 100644 --- a/classes/class_gpuparticlesattractorvectorfield3d.rst +++ b/classes/class_gpuparticlesattractorvectorfield3d.rst @@ -58,8 +58,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_size**\ (\ ) The size of the vector field box in 3D units. @@ -75,8 +75,8 @@ The size of the vector field box in 3D units. .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`Texture3D` value **)** -- :ref:`Texture3D` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`Texture3D`\ ) +- :ref:`Texture3D` **get_texture**\ (\ ) The 3D texture to be used. Values are linearly interpolated between the texture's pixels. @@ -89,3 +89,4 @@ The 3D texture to be used. Values are linearly interpolated between the texture' .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gpuparticlescollision3d.rst b/classes/class_gpuparticlescollision3d.rst index 10336abf6c2..766aaf81dcb 100644 --- a/classes/class_gpuparticlescollision3d.rst +++ b/classes/class_gpuparticlescollision3d.rst @@ -62,8 +62,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_cull_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_cull_mask** **(** **)** +- |void| **set_cull_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_cull_mask**\ (\ ) The particle rendering layers (:ref:`VisualInstance3D.layers`) that will be affected by the collision shape. By default, all particles that have :ref:`ParticleProcessMaterial.collision_mode` set to :ref:`ParticleProcessMaterial.COLLISION_RIGID` or :ref:`ParticleProcessMaterial.COLLISION_HIDE_ON_CONTACT` will be affected by a collision shape. @@ -78,3 +78,4 @@ Particle attraction can also be disabled on a per-process material basis by sett .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gpuparticlescollisionbox3d.rst b/classes/class_gpuparticlescollisionbox3d.rst index f9edbd50f2d..6c8effd7019 100644 --- a/classes/class_gpuparticlescollisionbox3d.rst +++ b/classes/class_gpuparticlescollisionbox3d.rst @@ -56,8 +56,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_size**\ (\ ) The collision box's size in 3D units. @@ -68,3 +68,4 @@ The collision box's size in 3D units. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gpuparticlescollisionheightfield3d.rst b/classes/class_gpuparticlescollisionheightfield3d.rst index 6ad59791f6a..218f66bb792 100644 --- a/classes/class_gpuparticlescollisionheightfield3d.rst +++ b/classes/class_gpuparticlescollisionheightfield3d.rst @@ -161,8 +161,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_follow_camera_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_follow_camera_enabled** **(** **)** +- |void| **set_follow_camera_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_follow_camera_enabled**\ (\ ) If ``true``, the **GPUParticlesCollisionHeightField3D** will follow the current camera in global space. The **GPUParticlesCollisionHeightField3D** does not need to be a child of the :ref:`Camera3D` node for this to work. @@ -180,8 +180,8 @@ Following the camera has a performance cost, as it will force the heightmap to u .. rst-class:: classref-property-setget -- void **set_resolution** **(** :ref:`Resolution` value **)** -- :ref:`Resolution` **get_resolution** **(** **)** +- |void| **set_resolution**\ (\ value\: :ref:`Resolution`\ ) +- :ref:`Resolution` **get_resolution**\ (\ ) Higher resolutions can represent small details more accurately in large scenes, at the cost of lower performance. If :ref:`update_mode` is :ref:`UPDATE_MODE_ALWAYS`, consider using the lowest resolution possible. @@ -197,8 +197,8 @@ Higher resolutions can represent small details more accurately in large scenes, .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_size**\ (\ ) The collision heightmap's size in 3D units. To improve heightmap quality, :ref:`size` should be set as small as possible while covering the parts of the scene you need. @@ -214,8 +214,8 @@ The collision heightmap's size in 3D units. To improve heightmap quality, :ref:` .. rst-class:: classref-property-setget -- void **set_update_mode** **(** :ref:`UpdateMode` value **)** -- :ref:`UpdateMode` **get_update_mode** **(** **)** +- |void| **set_update_mode**\ (\ value\: :ref:`UpdateMode`\ ) +- :ref:`UpdateMode` **get_update_mode**\ (\ ) The update policy to use for the generated heightmap. @@ -226,3 +226,4 @@ The update policy to use for the generated heightmap. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gpuparticlescollisionsdf3d.rst b/classes/class_gpuparticlescollisionsdf3d.rst index e02af0bdbfa..323e3377017 100644 --- a/classes/class_gpuparticlescollisionsdf3d.rst +++ b/classes/class_gpuparticlescollisionsdf3d.rst @@ -59,11 +59,11 @@ Methods .. table:: :widths: auto - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_bake_mask_value` **(** :ref:`int` layer_number **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bake_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_bake_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bake_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -153,8 +153,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bake_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_bake_mask** **(** **)** +- |void| **set_bake_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_bake_mask**\ (\ ) The visual layers to account for when baking the particle collision SDF. Only :ref:`MeshInstance3D`\ s whose :ref:`VisualInstance3D.layers` match with this :ref:`bake_mask` will be included in the generated particle collision SDF. By default, all objects are taken into account for the particle collision SDF baking. @@ -170,8 +170,8 @@ The visual layers to account for when baking the particle collision SDF. Only :r .. rst-class:: classref-property-setget -- void **set_resolution** **(** :ref:`Resolution` value **)** -- :ref:`Resolution` **get_resolution** **(** **)** +- |void| **set_resolution**\ (\ value\: :ref:`Resolution`\ ) +- :ref:`Resolution` **get_resolution**\ (\ ) The bake resolution to use for the signed distance field :ref:`texture`. The texture must be baked again for changes to the :ref:`resolution` property to be effective. Higher resolutions have a greater performance cost and take more time to bake. Higher resolutions also result in larger baked textures, leading to increased VRAM and storage space requirements. To improve performance and reduce bake times, use the lowest resolution possible for the object you're representing the collision of. @@ -187,8 +187,8 @@ The bake resolution to use for the signed distance field :ref:`texture` value **)** -- :ref:`Vector3` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_size**\ (\ ) The collision SDF's size in 3D units. To improve SDF quality, the :ref:`size` should be set as small as possible while covering the parts of the scene you need. @@ -204,8 +204,8 @@ The collision SDF's size in 3D units. To improve SDF quality, the :ref:`size` value **)** -- :ref:`Texture3D` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`Texture3D`\ ) +- :ref:`Texture3D` **get_texture**\ (\ ) The 3D texture representing the signed distance field. @@ -221,8 +221,8 @@ The 3D texture representing the signed distance field. .. rst-class:: classref-property-setget -- void **set_thickness** **(** :ref:`float` value **)** -- :ref:`float` **get_thickness** **(** **)** +- |void| **set_thickness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_thickness**\ (\ ) The collision shape's thickness. Unlike other particle colliders, **GPUParticlesCollisionSDF3D** is actually hollow on the inside. :ref:`thickness` can be increased to prevent particles from tunneling through the collision shape at high speeds, or when the **GPUParticlesCollisionSDF3D** is moved. @@ -239,7 +239,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_bake_mask_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_bake_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`bake_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -251,7 +251,7 @@ Returns whether or not the specified layer of the :ref:`bake_mask` layer_number, :ref:`bool` value **)** +|void| **set_bake_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`bake_mask`, given a ``layer_number`` between 1 and 32. @@ -262,3 +262,4 @@ Based on ``value``, enables or disables the specified layer in the :ref:`bake_ma .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gpuparticlescollisionsphere3d.rst b/classes/class_gpuparticlescollisionsphere3d.rst index d45e0a5e99c..ca6ceaf7eef 100644 --- a/classes/class_gpuparticlescollisionsphere3d.rst +++ b/classes/class_gpuparticlescollisionsphere3d.rst @@ -56,8 +56,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) The collision sphere's radius in 3D units. @@ -68,3 +68,4 @@ The collision sphere's radius in 3D units. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index 4d2c1255243..e2860adee2d 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -49,25 +49,25 @@ Methods .. table:: :widths: auto - +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_point` **(** :ref:`float` offset, :ref:`Color` color **)** | - +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_color` **(** :ref:`int` point **)** | - +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_offset` **(** :ref:`int` point **)** | - +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_point_count` **(** **)** |const| | - +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_point` **(** :ref:`int` point **)** | - +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reverse` **(** **)** | - +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`sample` **(** :ref:`float` offset **)** | - +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_color` **(** :ref:`int` point, :ref:`Color` color **)** | - +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_offset` **(** :ref:`int` point, :ref:`float` offset **)** | - +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_point`\ (\ offset\: :ref:`float`, color\: :ref:`Color`\ ) | + +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_color`\ (\ point\: :ref:`int`\ ) | + +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_offset`\ (\ point\: :ref:`int`\ ) | + +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_point_count`\ (\ ) |const| | + +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_point`\ (\ point\: :ref:`int`\ ) | + +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`sample`\ (\ offset\: :ref:`float`\ ) | + +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_color`\ (\ point\: :ref:`int`, color\: :ref:`Color`\ ) | + +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_offset`\ (\ point\: :ref:`int`, offset\: :ref:`float`\ ) | + +---------------------------+--------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -159,8 +159,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_colors** **(** :ref:`PackedColorArray` value **)** -- :ref:`PackedColorArray` **get_colors** **(** **)** +- |void| **set_colors**\ (\ value\: :ref:`PackedColorArray`\ ) +- :ref:`PackedColorArray` **get_colors**\ (\ ) Gradient's colors returned as a :ref:`PackedColorArray`. @@ -178,8 +178,8 @@ Gradient's colors returned as a :ref:`PackedColorArray`. .. rst-class:: classref-property-setget -- void **set_interpolation_color_space** **(** :ref:`ColorSpace` value **)** -- :ref:`ColorSpace` **get_interpolation_color_space** **(** **)** +- |void| **set_interpolation_color_space**\ (\ value\: :ref:`ColorSpace`\ ) +- :ref:`ColorSpace` **get_interpolation_color_space**\ (\ ) The color space used to interpolate between points of the gradient. It does not affect the returned colors, which will always be in sRGB space. See :ref:`ColorSpace` for available modes. @@ -197,8 +197,8 @@ The color space used to interpolate between points of the gradient. It does not .. rst-class:: classref-property-setget -- void **set_interpolation_mode** **(** :ref:`InterpolationMode` value **)** -- :ref:`InterpolationMode` **get_interpolation_mode** **(** **)** +- |void| **set_interpolation_mode**\ (\ value\: :ref:`InterpolationMode`\ ) +- :ref:`InterpolationMode` **get_interpolation_mode**\ (\ ) The algorithm used to interpolate between points of the gradient. See :ref:`InterpolationMode` for available modes. @@ -214,8 +214,8 @@ The algorithm used to interpolate between points of the gradient. See :ref:`Inte .. rst-class:: classref-property-setget -- void **set_offsets** **(** :ref:`PackedFloat32Array` value **)** -- :ref:`PackedFloat32Array` **get_offsets** **(** **)** +- |void| **set_offsets**\ (\ value\: :ref:`PackedFloat32Array`\ ) +- :ref:`PackedFloat32Array` **get_offsets**\ (\ ) Gradient's offsets returned as a :ref:`PackedFloat32Array`. @@ -234,7 +234,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_point** **(** :ref:`float` offset, :ref:`Color` color **)** +|void| **add_point**\ (\ offset\: :ref:`float`, color\: :ref:`Color`\ ) Adds the specified color to the gradient, with the specified offset. @@ -246,7 +246,7 @@ Adds the specified color to the gradient, with the specified offset. .. rst-class:: classref-method -:ref:`Color` **get_color** **(** :ref:`int` point **)** +:ref:`Color` **get_color**\ (\ point\: :ref:`int`\ ) Returns the color of the gradient color at index ``point``. @@ -258,7 +258,7 @@ Returns the color of the gradient color at index ``point``. .. rst-class:: classref-method -:ref:`float` **get_offset** **(** :ref:`int` point **)** +:ref:`float` **get_offset**\ (\ point\: :ref:`int`\ ) Returns the offset of the gradient color at index ``point``. @@ -270,7 +270,7 @@ Returns the offset of the gradient color at index ``point``. .. rst-class:: classref-method -:ref:`int` **get_point_count** **(** **)** |const| +:ref:`int` **get_point_count**\ (\ ) |const| Returns the number of colors in the gradient. @@ -282,7 +282,7 @@ Returns the number of colors in the gradient. .. rst-class:: classref-method -void **remove_point** **(** :ref:`int` point **)** +|void| **remove_point**\ (\ point\: :ref:`int`\ ) Removes the color at index ``point``. @@ -294,7 +294,7 @@ Removes the color at index ``point``. .. rst-class:: classref-method -void **reverse** **(** **)** +|void| **reverse**\ (\ ) Reverses/mirrors the gradient. @@ -308,7 +308,7 @@ Reverses/mirrors the gradient. .. rst-class:: classref-method -:ref:`Color` **sample** **(** :ref:`float` offset **)** +:ref:`Color` **sample**\ (\ offset\: :ref:`float`\ ) Returns the interpolated color specified by ``offset``. @@ -320,7 +320,7 @@ Returns the interpolated color specified by ``offset``. .. rst-class:: classref-method -void **set_color** **(** :ref:`int` point, :ref:`Color` color **)** +|void| **set_color**\ (\ point\: :ref:`int`, color\: :ref:`Color`\ ) Sets the color of the gradient color at index ``point``. @@ -332,7 +332,7 @@ Sets the color of the gradient color at index ``point``. .. rst-class:: classref-method -void **set_offset** **(** :ref:`int` point, :ref:`float` offset **)** +|void| **set_offset**\ (\ point\: :ref:`int`, offset\: :ref:`float`\ ) Sets the offset for the gradient color at index ``point``. @@ -343,3 +343,4 @@ Sets the offset for the gradient color at index ``point``. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gradienttexture1d.rst b/classes/class_gradienttexture1d.rst index a3de6fa7816..7359da44360 100644 --- a/classes/class_gradienttexture1d.rst +++ b/classes/class_gradienttexture1d.rst @@ -56,8 +56,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_gradient** **(** :ref:`Gradient` value **)** -- :ref:`Gradient` **get_gradient** **(** **)** +- |void| **set_gradient**\ (\ value\: :ref:`Gradient`\ ) +- :ref:`Gradient` **get_gradient**\ (\ ) The :ref:`Gradient` used to fill the texture. @@ -73,8 +73,8 @@ The :ref:`Gradient` used to fill the texture. .. rst-class:: classref-property-setget -- void **set_use_hdr** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_hdr** **(** **)** +- |void| **set_use_hdr**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_hdr**\ (\ ) If ``true``, the generated texture will support high dynamic range (:ref:`Image.FORMAT_RGBAF` format). This allows for glow effects to work if :ref:`Environment.glow_enabled` is ``true``. If ``false``, the generated texture will use low dynamic range; overbright colors will be clamped (:ref:`Image.FORMAT_RGBA8` format). @@ -90,8 +90,8 @@ If ``true``, the generated texture will support high dynamic range (:ref:`Image. .. rst-class:: classref-property-setget -- void **set_width** **(** :ref:`int` value **)** -- :ref:`int` **get_width** **(** **)** +- |void| **set_width**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_width**\ (\ ) The number of color samples that will be obtained from the :ref:`Gradient`. @@ -102,3 +102,4 @@ The number of color samples that will be obtained from the :ref:`Gradient` value **)** -- :ref:`Fill` **get_fill** **(** **)** +- |void| **set_fill**\ (\ value\: :ref:`Fill`\ ) +- :ref:`Fill` **get_fill**\ (\ ) The gradient fill type, one of the :ref:`Fill` values. The texture is filled by interpolating colors starting from :ref:`fill_from` to :ref:`fill_to` offsets. @@ -156,8 +156,8 @@ The gradient fill type, one of the :ref:`Fill` valu .. rst-class:: classref-property-setget -- void **set_fill_from** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_fill_from** **(** **)** +- |void| **set_fill_from**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_fill_from**\ (\ ) The initial offset used to fill the texture specified in UV coordinates. @@ -173,8 +173,8 @@ The initial offset used to fill the texture specified in UV coordinates. .. rst-class:: classref-property-setget -- void **set_fill_to** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_fill_to** **(** **)** +- |void| **set_fill_to**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_fill_to**\ (\ ) The final offset used to fill the texture specified in UV coordinates. @@ -190,8 +190,8 @@ The final offset used to fill the texture specified in UV coordinates. .. rst-class:: classref-property-setget -- void **set_gradient** **(** :ref:`Gradient` value **)** -- :ref:`Gradient` **get_gradient** **(** **)** +- |void| **set_gradient**\ (\ value\: :ref:`Gradient`\ ) +- :ref:`Gradient` **get_gradient**\ (\ ) The :ref:`Gradient` used to fill the texture. @@ -207,8 +207,8 @@ The :ref:`Gradient` used to fill the texture. .. rst-class:: classref-property-setget -- void **set_height** **(** :ref:`int` value **)** -- :ref:`int` **get_height** **(** **)** +- |void| **set_height**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_height**\ (\ ) The number of vertical color samples that will be obtained from the :ref:`Gradient`, which also represents the texture's height. @@ -224,8 +224,8 @@ The number of vertical color samples that will be obtained from the :ref:`Gradie .. rst-class:: classref-property-setget -- void **set_repeat** **(** :ref:`Repeat` value **)** -- :ref:`Repeat` **get_repeat** **(** **)** +- |void| **set_repeat**\ (\ value\: :ref:`Repeat`\ ) +- :ref:`Repeat` **get_repeat**\ (\ ) The gradient repeat type, one of the :ref:`Repeat` values. The texture is filled starting from :ref:`fill_from` to :ref:`fill_to` offsets by default, but the gradient fill can be repeated to cover the entire texture. @@ -241,8 +241,8 @@ The gradient repeat type, one of the :ref:`Repeat .. rst-class:: classref-property-setget -- void **set_use_hdr** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_hdr** **(** **)** +- |void| **set_use_hdr**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_hdr**\ (\ ) If ``true``, the generated texture will support high dynamic range (:ref:`Image.FORMAT_RGBAF` format). This allows for glow effects to work if :ref:`Environment.glow_enabled` is ``true``. If ``false``, the generated texture will use low dynamic range; overbright colors will be clamped (:ref:`Image.FORMAT_RGBA8` format). @@ -258,8 +258,8 @@ If ``true``, the generated texture will support high dynamic range (:ref:`Image. .. rst-class:: classref-property-setget -- void **set_width** **(** :ref:`int` value **)** -- :ref:`int` **get_width** **(** **)** +- |void| **set_width**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_width**\ (\ ) The number of horizontal color samples that will be obtained from the :ref:`Gradient`, which also represents the texture's width. @@ -270,3 +270,4 @@ The number of horizontal color samples that will be obtained from the :ref:`Grad .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index baba47fd2b0..a6949731304 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -95,55 +95,55 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`_get_connection_line` **(** :ref:`Vector2` from_position, :ref:`Vector2` to_position **)** |virtual| |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_in_input_hotzone` **(** :ref:`Object` in_node, :ref:`int` in_port, :ref:`Vector2` mouse_position **)** |virtual| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_in_output_hotzone` **(** :ref:`Object` in_node, :ref:`int` in_port, :ref:`Vector2` mouse_position **)** |virtual| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_node_hover_valid` **(** :ref:`StringName` from_node, :ref:`int` from_port, :ref:`StringName` to_node, :ref:`int` to_port **)** |virtual| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_valid_left_disconnect_type` **(** :ref:`int` type **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_valid_right_disconnect_type` **(** :ref:`int` type **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`arrange_nodes` **(** **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_connections` **(** **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`connect_node` **(** :ref:`StringName` from_node, :ref:`int` from_port, :ref:`StringName` to_node, :ref:`int` to_port **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`disconnect_node` **(** :ref:`StringName` from_node, :ref:`int` from_port, :ref:`StringName` to_node, :ref:`int` to_port **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`force_connection_drag_end` **(** **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_closest_connection_at_point` **(** :ref:`Vector2` point, :ref:`float` max_distance=4.0 **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`get_connection_line` **(** :ref:`Vector2` from_node, :ref:`Vector2` to_node **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`get_connection_list` **(** **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`get_connections_intersecting_with_rect` **(** :ref:`Rect2` rect **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`HBoxContainer` | :ref:`get_menu_hbox` **(** **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_node_connected` **(** :ref:`StringName` from_node, :ref:`int` from_port, :ref:`StringName` to_node, :ref:`int` to_port **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_valid_left_disconnect_type` **(** :ref:`int` type **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_valid_right_disconnect_type` **(** :ref:`int` type **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_connection_activity` **(** :ref:`StringName` from_node, :ref:`int` from_port, :ref:`StringName` to_node, :ref:`int` to_port, :ref:`float` amount **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_selected` **(** :ref:`Node` node **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`_get_connection_line`\ (\ from_position\: :ref:`Vector2`, to_position\: :ref:`Vector2`\ ) |virtual| |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_in_input_hotzone`\ (\ in_node\: :ref:`Object`, in_port\: :ref:`int`, mouse_position\: :ref:`Vector2`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_in_output_hotzone`\ (\ in_node\: :ref:`Object`, in_port\: :ref:`int`, mouse_position\: :ref:`Vector2`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_node_hover_valid`\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_valid_connection_type`\ (\ from_type\: :ref:`int`, to_type\: :ref:`int`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_valid_left_disconnect_type`\ (\ type\: :ref:`int`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_valid_right_disconnect_type`\ (\ type\: :ref:`int`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`arrange_nodes`\ (\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_connections`\ (\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`connect_node`\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`disconnect_node`\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_connection_drag_end`\ (\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_closest_connection_at_point`\ (\ point\: :ref:`Vector2`, max_distance\: :ref:`float` = 4.0\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`get_connection_line`\ (\ from_node\: :ref:`Vector2`, to_node\: :ref:`Vector2`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_connection_list`\ (\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_connections_intersecting_with_rect`\ (\ rect\: :ref:`Rect2`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`HBoxContainer` | :ref:`get_menu_hbox`\ (\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_node_connected`\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_connection_type`\ (\ from_type\: :ref:`int`, to_type\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_valid_connection_type`\ (\ from_type\: :ref:`int`, to_type\: :ref:`int`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_valid_left_disconnect_type`\ (\ type\: :ref:`int`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_valid_right_disconnect_type`\ (\ type\: :ref:`int`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_connection_activity`\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`, amount\: :ref:`float`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_selected`\ (\ node\: :ref:`Node`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -206,7 +206,7 @@ Signals .. rst-class:: classref-signal -**begin_node_move** **(** **)** +**begin_node_move**\ (\ ) Emitted at the beginning of a :ref:`GraphElement`'s movement. @@ -218,7 +218,7 @@ Emitted at the beginning of a :ref:`GraphElement`'s movement .. rst-class:: classref-signal -**connection_drag_ended** **(** **)** +**connection_drag_ended**\ (\ ) Emitted at the end of a connection drag. @@ -230,7 +230,7 @@ Emitted at the end of a connection drag. .. rst-class:: classref-signal -**connection_drag_started** **(** :ref:`StringName` from_node, :ref:`int` from_port, :ref:`bool` is_output **)** +**connection_drag_started**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, is_output\: :ref:`bool`\ ) Emitted at the beginning of a connection drag. @@ -242,7 +242,7 @@ Emitted at the beginning of a connection drag. .. rst-class:: classref-signal -**connection_from_empty** **(** :ref:`StringName` to_node, :ref:`int` to_port, :ref:`Vector2` release_position **)** +**connection_from_empty**\ (\ to_node\: :ref:`StringName`, to_port\: :ref:`int`, release_position\: :ref:`Vector2`\ ) Emitted when user drags a connection from an input port into the empty space of the graph. @@ -254,7 +254,7 @@ Emitted when user drags a connection from an input port into the empty space of .. rst-class:: classref-signal -**connection_request** **(** :ref:`StringName` from_node, :ref:`int` from_port, :ref:`StringName` to_node, :ref:`int` to_port **)** +**connection_request**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) Emitted to the GraphEdit when the connection between the ``from_port`` of the ``from_node`` :ref:`GraphNode` and the ``to_port`` of the ``to_node`` :ref:`GraphNode` is attempted to be created. @@ -266,7 +266,7 @@ Emitted to the GraphEdit when the connection between the ``from_port`` of the `` .. rst-class:: classref-signal -**connection_to_empty** **(** :ref:`StringName` from_node, :ref:`int` from_port, :ref:`Vector2` release_position **)** +**connection_to_empty**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, release_position\: :ref:`Vector2`\ ) Emitted when user drags a connection from an output port into the empty space of the graph. @@ -278,7 +278,7 @@ Emitted when user drags a connection from an output port into the empty space of .. rst-class:: classref-signal -**copy_nodes_request** **(** **)** +**copy_nodes_request**\ (\ ) Emitted when this **GraphEdit** captures a ``ui_copy`` action (:kbd:`Ctrl + C` by default). In general, this signal indicates that the selected :ref:`GraphElement`\ s should be copied. @@ -290,7 +290,7 @@ Emitted when this **GraphEdit** captures a ``ui_copy`` action (:kbd:`Ctrl + C` b .. rst-class:: classref-signal -**delete_nodes_request** **(** :ref:`StringName[]` nodes **)** +**delete_nodes_request**\ (\ nodes\: :ref:`Array`\[:ref:`StringName`\]\ ) Emitted when this **GraphEdit** captures a ``ui_graph_delete`` action (:kbd:`Delete` by default). @@ -304,7 +304,7 @@ Emitted when this **GraphEdit** captures a ``ui_graph_delete`` action (:kbd:`Del .. rst-class:: classref-signal -**disconnection_request** **(** :ref:`StringName` from_node, :ref:`int` from_port, :ref:`StringName` to_node, :ref:`int` to_port **)** +**disconnection_request**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) Emitted to the GraphEdit when the connection between ``from_port`` of ``from_node`` :ref:`GraphNode` and ``to_port`` of ``to_node`` :ref:`GraphNode` is attempted to be removed. @@ -316,7 +316,7 @@ Emitted to the GraphEdit when the connection between ``from_port`` of ``from_nod .. rst-class:: classref-signal -**duplicate_nodes_request** **(** **)** +**duplicate_nodes_request**\ (\ ) 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`\ s should be duplicated. @@ -328,7 +328,7 @@ Emitted when this **GraphEdit** captures a ``ui_graph_duplicate`` action (:kbd:` .. rst-class:: classref-signal -**end_node_move** **(** **)** +**end_node_move**\ (\ ) Emitted at the end of a :ref:`GraphElement`'s movement. @@ -340,7 +340,7 @@ Emitted at the end of a :ref:`GraphElement`'s movement. .. rst-class:: classref-signal -**node_deselected** **(** :ref:`Node` node **)** +**node_deselected**\ (\ node\: :ref:`Node`\ ) Emitted when the given :ref:`GraphElement` node is deselected. @@ -352,7 +352,7 @@ Emitted when the given :ref:`GraphElement` node is deselecte .. rst-class:: classref-signal -**node_selected** **(** :ref:`Node` node **)** +**node_selected**\ (\ node\: :ref:`Node`\ ) Emitted when the given :ref:`GraphElement` node is selected. @@ -364,7 +364,7 @@ Emitted when the given :ref:`GraphElement` node is selected. .. rst-class:: classref-signal -**paste_nodes_request** **(** **)** +**paste_nodes_request**\ (\ ) Emitted when this **GraphEdit** captures a ``ui_paste`` action (:kbd:`Ctrl + V` by default). In general, this signal indicates that previously copied :ref:`GraphElement`\ s should be pasted. @@ -376,7 +376,7 @@ Emitted when this **GraphEdit** captures a ``ui_paste`` action (:kbd:`Ctrl + V` .. rst-class:: classref-signal -**popup_request** **(** :ref:`Vector2` position **)** +**popup_request**\ (\ position\: :ref:`Vector2`\ ) Emitted when a popup is requested. Happens on right-clicking in the GraphEdit. ``position`` is the position of the mouse pointer when the signal is sent. @@ -388,7 +388,7 @@ Emitted when a popup is requested. Happens on right-clicking in the GraphEdit. ` .. rst-class:: classref-signal -**scroll_offset_changed** **(** :ref:`Vector2` offset **)** +**scroll_offset_changed**\ (\ offset\: :ref:`Vector2`\ ) Emitted when the scroll offset is changed by the user. It will not be emitted when changed in code. @@ -466,8 +466,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_connection_lines_antialiased** **(** :ref:`bool` value **)** -- :ref:`bool` **is_connection_lines_antialiased** **(** **)** +- |void| **set_connection_lines_antialiased**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_connection_lines_antialiased**\ (\ ) If ``true``, the lines between nodes will use antialiasing. @@ -483,8 +483,8 @@ If ``true``, the lines between nodes will use antialiasing. .. rst-class:: classref-property-setget -- void **set_connection_lines_curvature** **(** :ref:`float` value **)** -- :ref:`float` **get_connection_lines_curvature** **(** **)** +- |void| **set_connection_lines_curvature**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_connection_lines_curvature**\ (\ ) The curvature of the lines between the nodes. 0 results in straight lines. @@ -500,8 +500,8 @@ The curvature of the lines between the nodes. 0 results in straight lines. .. rst-class:: classref-property-setget -- void **set_connection_lines_thickness** **(** :ref:`float` value **)** -- :ref:`float` **get_connection_lines_thickness** **(** **)** +- |void| **set_connection_lines_thickness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_connection_lines_thickness**\ (\ ) The thickness of the lines between the nodes. @@ -517,8 +517,8 @@ The thickness of the lines between the nodes. .. rst-class:: classref-property-setget -- void **set_grid_pattern** **(** :ref:`GridPattern` value **)** -- :ref:`GridPattern` **get_grid_pattern** **(** **)** +- |void| **set_grid_pattern**\ (\ value\: :ref:`GridPattern`\ ) +- :ref:`GridPattern` **get_grid_pattern**\ (\ ) The pattern used for drawing the grid. @@ -534,8 +534,8 @@ The pattern used for drawing the grid. .. rst-class:: classref-property-setget -- void **set_minimap_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_minimap_enabled** **(** **)** +- |void| **set_minimap_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_minimap_enabled**\ (\ ) If ``true``, the minimap is visible. @@ -551,8 +551,8 @@ If ``true``, the minimap is visible. .. rst-class:: classref-property-setget -- void **set_minimap_opacity** **(** :ref:`float` value **)** -- :ref:`float` **get_minimap_opacity** **(** **)** +- |void| **set_minimap_opacity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_minimap_opacity**\ (\ ) The opacity of the minimap rectangle. @@ -568,8 +568,8 @@ The opacity of the minimap rectangle. .. rst-class:: classref-property-setget -- void **set_minimap_size** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_minimap_size** **(** **)** +- |void| **set_minimap_size**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_minimap_size**\ (\ ) The size of the minimap rectangle. The map itself is based on the size of the grid area and is scaled to fit this rectangle. @@ -585,8 +585,8 @@ The size of the minimap rectangle. The map itself is based on the size of the gr .. rst-class:: classref-property-setget -- void **set_panning_scheme** **(** :ref:`PanningScheme` value **)** -- :ref:`PanningScheme` **get_panning_scheme** **(** **)** +- |void| **set_panning_scheme**\ (\ value\: :ref:`PanningScheme`\ ) +- :ref:`PanningScheme` **get_panning_scheme**\ (\ ) Defines the control scheme for panning with mouse wheel. @@ -602,8 +602,8 @@ Defines the control scheme for panning with mouse wheel. .. rst-class:: classref-property-setget -- void **set_right_disconnects** **(** :ref:`bool` value **)** -- :ref:`bool` **is_right_disconnects_enabled** **(** **)** +- |void| **set_right_disconnects**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_right_disconnects_enabled**\ (\ ) If ``true``, enables disconnection of existing connections in the GraphEdit by dragging the right end. @@ -619,8 +619,8 @@ If ``true``, enables disconnection of existing connections in the GraphEdit by d .. rst-class:: classref-property-setget -- void **set_scroll_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_scroll_offset** **(** **)** +- |void| **set_scroll_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_scroll_offset**\ (\ ) The scroll offset. @@ -636,8 +636,8 @@ The scroll offset. .. rst-class:: classref-property-setget -- void **set_show_arrange_button** **(** :ref:`bool` value **)** -- :ref:`bool` **is_showing_arrange_button** **(** **)** +- |void| **set_show_arrange_button**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_showing_arrange_button**\ (\ ) If ``true``, the button to automatically arrange graph nodes is visible. @@ -653,8 +653,8 @@ If ``true``, the button to automatically arrange graph nodes is visible. .. rst-class:: classref-property-setget -- void **set_show_grid** **(** :ref:`bool` value **)** -- :ref:`bool` **is_showing_grid** **(** **)** +- |void| **set_show_grid**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_showing_grid**\ (\ ) If ``true``, the grid is visible. @@ -670,8 +670,8 @@ If ``true``, the grid is visible. .. rst-class:: classref-property-setget -- void **set_show_grid_buttons** **(** :ref:`bool` value **)** -- :ref:`bool` **is_showing_grid_buttons** **(** **)** +- |void| **set_show_grid_buttons**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_showing_grid_buttons**\ (\ ) If ``true``, buttons that allow to configure grid and snapping options are visible. @@ -687,8 +687,8 @@ If ``true``, buttons that allow to configure grid and snapping options are visib .. rst-class:: classref-property-setget -- void **set_show_menu** **(** :ref:`bool` value **)** -- :ref:`bool` **is_showing_menu** **(** **)** +- |void| **set_show_menu**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_showing_menu**\ (\ ) If ``true``, the menu toolbar is visible. @@ -704,8 +704,8 @@ If ``true``, the menu toolbar is visible. .. rst-class:: classref-property-setget -- void **set_show_minimap_button** **(** :ref:`bool` value **)** -- :ref:`bool` **is_showing_minimap_button** **(** **)** +- |void| **set_show_minimap_button**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_showing_minimap_button**\ (\ ) If ``true``, the button to toggle the minimap is visible. @@ -721,8 +721,8 @@ If ``true``, the button to toggle the minimap is visible. .. rst-class:: classref-property-setget -- void **set_show_zoom_buttons** **(** :ref:`bool` value **)** -- :ref:`bool` **is_showing_zoom_buttons** **(** **)** +- |void| **set_show_zoom_buttons**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_showing_zoom_buttons**\ (\ ) If ``true``, buttons that allow to change and reset the zoom level are visible. @@ -738,8 +738,8 @@ If ``true``, buttons that allow to change and reset the zoom level are visible. .. rst-class:: classref-property-setget -- void **set_show_zoom_label** **(** :ref:`bool` value **)** -- :ref:`bool` **is_showing_zoom_label** **(** **)** +- |void| **set_show_zoom_label**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_showing_zoom_label**\ (\ ) If ``true``, the label with the current zoom level is visible. The zoom level is displayed in percents. @@ -755,8 +755,8 @@ If ``true``, the label with the current zoom level is visible. The zoom level is .. rst-class:: classref-property-setget -- void **set_snapping_distance** **(** :ref:`int` value **)** -- :ref:`int` **get_snapping_distance** **(** **)** +- |void| **set_snapping_distance**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_snapping_distance**\ (\ ) The snapping distance in pixels, also determines the grid line distance. @@ -772,8 +772,8 @@ The snapping distance in pixels, also determines the grid line distance. .. rst-class:: classref-property-setget -- void **set_snapping_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_snapping_enabled** **(** **)** +- |void| **set_snapping_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_snapping_enabled**\ (\ ) If ``true``, enables snapping. @@ -789,8 +789,8 @@ If ``true``, enables snapping. .. rst-class:: classref-property-setget -- void **set_zoom** **(** :ref:`float` value **)** -- :ref:`float` **get_zoom** **(** **)** +- |void| **set_zoom**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_zoom**\ (\ ) The current zoom value. @@ -806,8 +806,8 @@ The current zoom value. .. rst-class:: classref-property-setget -- void **set_zoom_max** **(** :ref:`float` value **)** -- :ref:`float` **get_zoom_max** **(** **)** +- |void| **set_zoom_max**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_zoom_max**\ (\ ) The upper zoom limit. @@ -823,8 +823,8 @@ The upper zoom limit. .. rst-class:: classref-property-setget -- void **set_zoom_min** **(** :ref:`float` value **)** -- :ref:`float` **get_zoom_min** **(** **)** +- |void| **set_zoom_min**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_zoom_min**\ (\ ) The lower zoom limit. @@ -840,8 +840,8 @@ The lower zoom limit. .. rst-class:: classref-property-setget -- void **set_zoom_step** **(** :ref:`float` value **)** -- :ref:`float` **get_zoom_step** **(** **)** +- |void| **set_zoom_step**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_zoom_step**\ (\ ) The step of each zoom level. @@ -858,7 +858,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedVector2Array` **_get_connection_line** **(** :ref:`Vector2` from_position, :ref:`Vector2` to_position **)** |virtual| |const| +:ref:`PackedVector2Array` **_get_connection_line**\ (\ from_position\: :ref:`Vector2`, to_position\: :ref:`Vector2`\ ) |virtual| |const| Virtual method which can be overridden to customize how connections are drawn. @@ -870,7 +870,7 @@ Virtual method which can be overridden to customize how connections are drawn. .. rst-class:: classref-method -:ref:`bool` **_is_in_input_hotzone** **(** :ref:`Object` in_node, :ref:`int` in_port, :ref:`Vector2` mouse_position **)** |virtual| +:ref:`bool` **_is_in_input_hotzone**\ (\ in_node\: :ref:`Object`, in_port\: :ref:`int`, mouse_position\: :ref:`Vector2`\ ) |virtual| Returns whether the ``mouse_position`` is in the input hot zone. @@ -895,7 +895,7 @@ Below is a sample code to help get started: .. rst-class:: classref-method -:ref:`bool` **_is_in_output_hotzone** **(** :ref:`Object` in_node, :ref:`int` in_port, :ref:`Vector2` mouse_position **)** |virtual| +:ref:`bool` **_is_in_output_hotzone**\ (\ in_node\: :ref:`Object`, in_port\: :ref:`int`, mouse_position\: :ref:`Vector2`\ ) |virtual| Returns whether the ``mouse_position`` is in the output hot zone. For more information on hot zones, see :ref:`_is_in_input_hotzone`. @@ -918,7 +918,7 @@ Below is a sample code to help get started: .. rst-class:: classref-method -:ref:`bool` **_is_node_hover_valid** **(** :ref:`StringName` from_node, :ref:`int` from_port, :ref:`StringName` to_node, :ref:`int` to_port **)** |virtual| +:ref:`bool` **_is_node_hover_valid**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) |virtual| This virtual method can be used to insert additional error detection while the user is dragging a connection over a valid port. @@ -951,7 +951,7 @@ In this example a connection to same node is suppressed: .. rst-class:: classref-method -void **add_valid_connection_type** **(** :ref:`int` from_type, :ref:`int` to_type **)** +|void| **add_valid_connection_type**\ (\ from_type\: :ref:`int`, to_type\: :ref:`int`\ ) Allows the connection between two different port types. The port type is defined individually for the left and the right port of each slot with the :ref:`GraphNode.set_slot` method. @@ -965,7 +965,7 @@ See also :ref:`is_valid_connection_type` type **)** +|void| **add_valid_left_disconnect_type**\ (\ type\: :ref:`int`\ ) Allows to disconnect nodes when dragging from the left port of the :ref:`GraphNode`'s slot if it has the specified type. See also :ref:`remove_valid_left_disconnect_type`. @@ -977,7 +977,7 @@ Allows to disconnect nodes when dragging from the left port of the :ref:`GraphNo .. rst-class:: classref-method -void **add_valid_right_disconnect_type** **(** :ref:`int` type **)** +|void| **add_valid_right_disconnect_type**\ (\ type\: :ref:`int`\ ) Allows to disconnect nodes when dragging from the right port of the :ref:`GraphNode`'s slot if it has the specified type. See also :ref:`remove_valid_right_disconnect_type`. @@ -989,7 +989,7 @@ Allows to disconnect nodes when dragging from the right port of the :ref:`GraphN .. rst-class:: classref-method -void **arrange_nodes** **(** **)** +|void| **arrange_nodes**\ (\ ) Rearranges selected nodes in a layout with minimum crossings between connections and uniform horizontal and vertical gap between nodes. @@ -1001,7 +1001,7 @@ Rearranges selected nodes in a layout with minimum crossings between connections .. rst-class:: classref-method -void **clear_connections** **(** **)** +|void| **clear_connections**\ (\ ) Removes all connections between nodes. @@ -1013,7 +1013,7 @@ Removes all connections between nodes. .. rst-class:: classref-method -:ref:`Error` **connect_node** **(** :ref:`StringName` from_node, :ref:`int` from_port, :ref:`StringName` to_node, :ref:`int` to_port **)** +:ref:`Error` **connect_node**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) Create a connection between the ``from_port`` of the ``from_node`` :ref:`GraphNode` and the ``to_port`` of the ``to_node`` :ref:`GraphNode`. If the connection already exists, no connection is created. @@ -1025,7 +1025,7 @@ Create a connection between the ``from_port`` of the ``from_node`` :ref:`GraphNo .. rst-class:: classref-method -void **disconnect_node** **(** :ref:`StringName` from_node, :ref:`int` from_port, :ref:`StringName` to_node, :ref:`int` to_port **)** +|void| **disconnect_node**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) Removes the connection between the ``from_port`` of the ``from_node`` :ref:`GraphNode` and the ``to_port`` of the ``to_node`` :ref:`GraphNode`. If the connection does not exist, no connection is removed. @@ -1037,7 +1037,7 @@ Removes the connection between the ``from_port`` of the ``from_node`` :ref:`Grap .. rst-class:: classref-method -void **force_connection_drag_end** **(** **)** +|void| **force_connection_drag_end**\ (\ ) Ends the creation of the current connection. In other words, if you are dragging a connection you can use this method to abort the process and remove the line that followed your cursor. @@ -1053,7 +1053,7 @@ This is best used together with :ref:`connection_drag_started` **get_closest_connection_at_point** **(** :ref:`Vector2` point, :ref:`float` max_distance=4.0 **)** |const| +:ref:`Dictionary` **get_closest_connection_at_point**\ (\ point\: :ref:`Vector2`, max_distance\: :ref:`float` = 4.0\ ) |const| Returns the closest connection to the given point in screen space. If no connection is found within ``max_distance`` pixels, an empty :ref:`Dictionary` is returned. @@ -1078,7 +1078,7 @@ For example, getting a connection at a given mouse position can be achieved like .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_connection_line** **(** :ref:`Vector2` from_node, :ref:`Vector2` to_node **)** |const| +:ref:`PackedVector2Array` **get_connection_line**\ (\ from_node\: :ref:`Vector2`, to_node\: :ref:`Vector2`\ ) |const| Returns the points which would make up a connection between ``from_node`` and ``to_node``. @@ -1090,7 +1090,7 @@ Returns the points which would make up a connection between ``from_node`` and `` .. rst-class:: classref-method -:ref:`Dictionary[]` **get_connection_list** **(** **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_connection_list**\ (\ ) |const| Returns an :ref:`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" }``. @@ -1102,7 +1102,7 @@ Returns an :ref:`Array` containing the list of connections. A conne .. rst-class:: classref-method -:ref:`Dictionary[]` **get_connections_intersecting_with_rect** **(** :ref:`Rect2` rect **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_connections_intersecting_with_rect**\ (\ rect\: :ref:`Rect2`\ ) |const| Returns an :ref:`Array` containing the list of connections that intersect with the given :ref:`Rect2`. 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" }``. @@ -1114,7 +1114,7 @@ Returns an :ref:`Array` containing the list of connections that int .. rst-class:: classref-method -:ref:`HBoxContainer` **get_menu_hbox** **(** **)** +:ref:`HBoxContainer` **get_menu_hbox**\ (\ ) Gets the :ref:`HBoxContainer` that contains the zooming and grid snap controls in the top left of the graph. You can use this method to reposition the toolbar or to add your own custom controls to it. @@ -1128,7 +1128,7 @@ Gets the :ref:`HBoxContainer` that contains the zooming and .. rst-class:: classref-method -:ref:`bool` **is_node_connected** **(** :ref:`StringName` from_node, :ref:`int` from_port, :ref:`StringName` to_node, :ref:`int` to_port **)** +:ref:`bool` **is_node_connected**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`\ ) Returns ``true`` if the ``from_port`` of the ``from_node`` :ref:`GraphNode` is connected to the ``to_port`` of the ``to_node`` :ref:`GraphNode`. @@ -1140,7 +1140,7 @@ Returns ``true`` if the ``from_port`` of the ``from_node`` :ref:`GraphNode` **is_valid_connection_type** **(** :ref:`int` from_type, :ref:`int` to_type **)** |const| +:ref:`bool` **is_valid_connection_type**\ (\ from_type\: :ref:`int`, to_type\: :ref:`int`\ ) |const| Returns whether it's possible to make a connection between two different port types. The port type is defined individually for the left and the right port of each slot with the :ref:`GraphNode.set_slot` method. @@ -1154,7 +1154,7 @@ See also :ref:`add_valid_connection_type` from_type, :ref:`int` to_type **)** +|void| **remove_valid_connection_type**\ (\ from_type\: :ref:`int`, to_type\: :ref:`int`\ ) Disallows the connection between two different port types previously allowed by :ref:`add_valid_connection_type`. The port type is defined individually for the left and the right port of each slot with the :ref:`GraphNode.set_slot` method. @@ -1168,7 +1168,7 @@ See also :ref:`is_valid_connection_type` type **)** +|void| **remove_valid_left_disconnect_type**\ (\ type\: :ref:`int`\ ) Disallows to disconnect nodes when dragging from the left port of the :ref:`GraphNode`'s slot if it has the specified type. Use this to disable disconnection previously allowed with :ref:`add_valid_left_disconnect_type`. @@ -1180,7 +1180,7 @@ Disallows to disconnect nodes when dragging from the left port of the :ref:`Grap .. rst-class:: classref-method -void **remove_valid_right_disconnect_type** **(** :ref:`int` type **)** +|void| **remove_valid_right_disconnect_type**\ (\ type\: :ref:`int`\ ) Disallows to disconnect nodes when dragging from the right port of the :ref:`GraphNode`'s slot if it has the specified type. Use this to disable disconnection previously allowed with :ref:`add_valid_right_disconnect_type`. @@ -1192,7 +1192,7 @@ Disallows to disconnect nodes when dragging from the right port of the :ref:`Gra .. rst-class:: classref-method -void **set_connection_activity** **(** :ref:`StringName` from_node, :ref:`int` from_port, :ref:`StringName` to_node, :ref:`int` to_port, :ref:`float` amount **)** +|void| **set_connection_activity**\ (\ from_node\: :ref:`StringName`, from_port\: :ref:`int`, to_node\: :ref:`StringName`, to_port\: :ref:`int`, amount\: :ref:`float`\ ) Sets the coloration of the connection between ``from_node``'s ``from_port`` and ``to_node``'s ``to_port`` with the color provided in the :ref:`activity` theme property. The color is linearly interpolated between the connection color and the activity color using ``amount`` as weight. @@ -1204,7 +1204,7 @@ Sets the coloration of the connection between ``from_node``'s ``from_port`` and .. rst-class:: classref-method -void **set_selected** **(** :ref:`Node` node **)** +|void| **set_selected**\ (\ node\: :ref:`Node`\ ) Sets the specified ``node`` as the one selected. @@ -1450,3 +1450,4 @@ The background drawn under the grid. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_graphelement.rst b/classes/class_graphelement.rst index c571334e1d3..343daae0946 100644 --- a/classes/class_graphelement.rst +++ b/classes/class_graphelement.rst @@ -70,7 +70,7 @@ Signals .. rst-class:: classref-signal -**delete_request** **(** **)** +**delete_request**\ (\ ) Emitted when removing the GraphElement is requested. @@ -82,7 +82,7 @@ Emitted when removing the GraphElement is requested. .. rst-class:: classref-signal -**dragged** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** +**dragged**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`\ ) Emitted when the GraphElement is dragged. @@ -94,7 +94,7 @@ Emitted when the GraphElement is dragged. .. rst-class:: classref-signal -**node_deselected** **(** **)** +**node_deselected**\ (\ ) Emitted when the GraphElement is deselected. @@ -106,7 +106,7 @@ Emitted when the GraphElement is deselected. .. rst-class:: classref-signal -**node_selected** **(** **)** +**node_selected**\ (\ ) Emitted when the GraphElement is selected. @@ -118,7 +118,7 @@ Emitted when the GraphElement is selected. .. rst-class:: classref-signal -**position_offset_changed** **(** **)** +**position_offset_changed**\ (\ ) Emitted when the GraphElement is moved. @@ -130,7 +130,7 @@ Emitted when the GraphElement is moved. .. rst-class:: classref-signal -**raise_request** **(** **)** +**raise_request**\ (\ ) Emitted when displaying the GraphElement over other ones is requested. Happens on focusing (clicking into) the GraphElement. @@ -142,7 +142,7 @@ Emitted when displaying the GraphElement over other ones is requested. Happens o .. rst-class:: classref-signal -**resize_request** **(** :ref:`Vector2` new_minsize **)** +**resize_request**\ (\ new_minsize\: :ref:`Vector2`\ ) Emitted when resizing the GraphElement is requested. Happens on dragging the resizer handle (see :ref:`resizable`). @@ -163,8 +163,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_draggable** **(** :ref:`bool` value **)** -- :ref:`bool` **is_draggable** **(** **)** +- |void| **set_draggable**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_draggable**\ (\ ) If ``true``, the user can drag the GraphElement. @@ -180,8 +180,8 @@ If ``true``, the user can drag the GraphElement. .. rst-class:: classref-property-setget -- void **set_position_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_position_offset** **(** **)** +- |void| **set_position_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_position_offset**\ (\ ) The offset of the GraphElement, relative to the scroll offset of the :ref:`GraphEdit`. @@ -197,8 +197,8 @@ The offset of the GraphElement, relative to the scroll offset of the :ref:`Graph .. rst-class:: classref-property-setget -- void **set_resizable** **(** :ref:`bool` value **)** -- :ref:`bool` **is_resizable** **(** **)** +- |void| **set_resizable**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_resizable**\ (\ ) If ``true``, the user can resize the GraphElement. @@ -216,8 +216,8 @@ If ``true``, the user can resize the GraphElement. .. rst-class:: classref-property-setget -- void **set_selectable** **(** :ref:`bool` value **)** -- :ref:`bool` **is_selectable** **(** **)** +- |void| **set_selectable**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_selectable**\ (\ ) If ``true``, the user can select the GraphElement. @@ -233,8 +233,8 @@ If ``true``, the user can select the GraphElement. .. rst-class:: classref-property-setget -- void **set_selected** **(** :ref:`bool` value **)** -- :ref:`bool` **is_selected** **(** **)** +- |void| **set_selected**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_selected**\ (\ ) If ``true``, the GraphElement is selected. @@ -262,3 +262,4 @@ The icon used for the resizer, visible when :ref:`resizable` **(** :ref:`int` slot_index, :ref:`Vector2i` position, :ref:`bool` left, :ref:`Color` color **)** |virtual| | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_all_slots` **(** **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_slot` **(** :ref:`int` slot_index **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_input_port_color` **(** :ref:`int` port_idx **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_input_port_count` **(** **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_input_port_position` **(** :ref:`int` port_idx **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_input_port_slot` **(** :ref:`int` port_idx **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_input_port_type` **(** :ref:`int` port_idx **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_output_port_color` **(** :ref:`int` port_idx **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_output_port_count` **(** **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_output_port_position` **(** :ref:`int` port_idx **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_output_port_slot` **(** :ref:`int` port_idx **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_output_port_type` **(** :ref:`int` port_idx **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_slot_color_left` **(** :ref:`int` slot_index **)** |const| | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_slot_color_right` **(** :ref:`int` slot_index **)** |const| | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_slot_custom_icon_left` **(** :ref:`int` slot_index **)** |const| | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_slot_custom_icon_right` **(** :ref:`int` slot_index **)** |const| | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_slot_type_left` **(** :ref:`int` slot_index **)** |const| | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_slot_type_right` **(** :ref:`int` slot_index **)** |const| | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`HBoxContainer` | :ref:`get_titlebar_hbox` **(** **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_slot_draw_stylebox` **(** :ref:`int` slot_index **)** |const| | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_slot_enabled_left` **(** :ref:`int` slot_index **)** |const| | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_slot_enabled_right` **(** :ref:`int` slot_index **)** |const| | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_slot` **(** :ref:`int` slot_index, :ref:`bool` enable_left_port, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right_port, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture2D` custom_icon_left=null, :ref:`Texture2D` custom_icon_right=null, :ref:`bool` draw_stylebox=true **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_slot_color_left` **(** :ref:`int` slot_index, :ref:`Color` color **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_slot_color_right` **(** :ref:`int` slot_index, :ref:`Color` color **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_slot_custom_icon_left` **(** :ref:`int` slot_index, :ref:`Texture2D` custom_icon **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_slot_custom_icon_right` **(** :ref:`int` slot_index, :ref:`Texture2D` custom_icon **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_slot_draw_stylebox` **(** :ref:`int` slot_index, :ref:`bool` enable **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_slot_enabled_left` **(** :ref:`int` slot_index, :ref:`bool` enable **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_slot_enabled_right` **(** :ref:`int` slot_index, :ref:`bool` enable **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_slot_type_left` **(** :ref:`int` slot_index, :ref:`int` type **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_slot_type_right` **(** :ref:`int` slot_index, :ref:`int` type **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_draw_port`\ (\ slot_index\: :ref:`int`, position\: :ref:`Vector2i`, left\: :ref:`bool`, color\: :ref:`Color`\ ) |virtual| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_all_slots`\ (\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_slot`\ (\ slot_index\: :ref:`int`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_input_port_color`\ (\ port_idx\: :ref:`int`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_input_port_count`\ (\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_input_port_position`\ (\ port_idx\: :ref:`int`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_input_port_slot`\ (\ port_idx\: :ref:`int`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_input_port_type`\ (\ port_idx\: :ref:`int`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_output_port_color`\ (\ port_idx\: :ref:`int`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_output_port_count`\ (\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_output_port_position`\ (\ port_idx\: :ref:`int`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_output_port_slot`\ (\ port_idx\: :ref:`int`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_output_port_type`\ (\ port_idx\: :ref:`int`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_slot_color_left`\ (\ slot_index\: :ref:`int`\ ) |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_slot_color_right`\ (\ slot_index\: :ref:`int`\ ) |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_slot_custom_icon_left`\ (\ slot_index\: :ref:`int`\ ) |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_slot_custom_icon_right`\ (\ slot_index\: :ref:`int`\ ) |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_slot_type_left`\ (\ slot_index\: :ref:`int`\ ) |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_slot_type_right`\ (\ slot_index\: :ref:`int`\ ) |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`HBoxContainer` | :ref:`get_titlebar_hbox`\ (\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_slot_draw_stylebox`\ (\ slot_index\: :ref:`int`\ ) |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_slot_enabled_left`\ (\ slot_index\: :ref:`int`\ ) |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_slot_enabled_right`\ (\ slot_index\: :ref:`int`\ ) |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_slot`\ (\ slot_index\: :ref:`int`, enable_left_port\: :ref:`bool`, type_left\: :ref:`int`, color_left\: :ref:`Color`, enable_right_port\: :ref:`bool`, type_right\: :ref:`int`, color_right\: :ref:`Color`, custom_icon_left\: :ref:`Texture2D` = null, custom_icon_right\: :ref:`Texture2D` = null, draw_stylebox\: :ref:`bool` = true\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_slot_color_left`\ (\ slot_index\: :ref:`int`, color\: :ref:`Color`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_slot_color_right`\ (\ slot_index\: :ref:`int`, color\: :ref:`Color`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_slot_custom_icon_left`\ (\ slot_index\: :ref:`int`, custom_icon\: :ref:`Texture2D`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_slot_custom_icon_right`\ (\ slot_index\: :ref:`int`, custom_icon\: :ref:`Texture2D`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_slot_draw_stylebox`\ (\ slot_index\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_slot_enabled_left`\ (\ slot_index\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_slot_enabled_right`\ (\ slot_index\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_slot_type_left`\ (\ slot_index\: :ref:`int`, type\: :ref:`int`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_slot_type_right`\ (\ slot_index\: :ref:`int`, type\: :ref:`int`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -160,7 +160,7 @@ Signals .. rst-class:: classref-signal -**slot_updated** **(** :ref:`int` slot_index **)** +**slot_updated**\ (\ slot_index\: :ref:`int`\ ) Emitted when any GraphNode's slot is updated. @@ -181,8 +181,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_title** **(** :ref:`String` value **)** -- :ref:`String` **get_title** **(** **)** +- |void| **set_title**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_title**\ (\ ) The text displayed in the GraphNode's title bar. @@ -199,7 +199,7 @@ Method Descriptions .. rst-class:: classref-method -void **_draw_port** **(** :ref:`int` slot_index, :ref:`Vector2i` position, :ref:`bool` left, :ref:`Color` color **)** |virtual| +|void| **_draw_port**\ (\ slot_index\: :ref:`int`, position\: :ref:`Vector2i`, left\: :ref:`bool`, color\: :ref:`Color`\ ) |virtual| .. container:: contribute @@ -213,7 +213,7 @@ void **_draw_port** **(** :ref:`int` slot_index, :ref:`Vector2i` slot_index **)** +|void| **clear_slot**\ (\ slot_index\: :ref:`int`\ ) Disables the slot with the given ``slot_index``. This will remove the corresponding input and output port from the GraphNode. @@ -237,7 +237,7 @@ Disables the slot with the given ``slot_index``. This will remove the correspond .. rst-class:: classref-method -:ref:`Color` **get_input_port_color** **(** :ref:`int` port_idx **)** +:ref:`Color` **get_input_port_color**\ (\ port_idx\: :ref:`int`\ ) Returns the :ref:`Color` of the input port with the given ``port_idx``. @@ -249,7 +249,7 @@ Returns the :ref:`Color` of the input port with the given ``port_id .. rst-class:: classref-method -:ref:`int` **get_input_port_count** **(** **)** +:ref:`int` **get_input_port_count**\ (\ ) Returns the number of slots with an enabled input port. @@ -261,7 +261,7 @@ Returns the number of slots with an enabled input port. .. rst-class:: classref-method -:ref:`Vector2` **get_input_port_position** **(** :ref:`int` port_idx **)** +:ref:`Vector2` **get_input_port_position**\ (\ port_idx\: :ref:`int`\ ) Returns the position of the input port with the given ``port_idx``. @@ -273,7 +273,7 @@ Returns the position of the input port with the given ``port_idx``. .. rst-class:: classref-method -:ref:`int` **get_input_port_slot** **(** :ref:`int` port_idx **)** +:ref:`int` **get_input_port_slot**\ (\ port_idx\: :ref:`int`\ ) Returns the corresponding slot index of the input port with the given ``port_idx``. @@ -285,7 +285,7 @@ Returns the corresponding slot index of the input port with the given ``port_idx .. rst-class:: classref-method -:ref:`int` **get_input_port_type** **(** :ref:`int` port_idx **)** +:ref:`int` **get_input_port_type**\ (\ port_idx\: :ref:`int`\ ) Returns the type of the input port with the given ``port_idx``. @@ -297,7 +297,7 @@ Returns the type of the input port with the given ``port_idx``. .. rst-class:: classref-method -:ref:`Color` **get_output_port_color** **(** :ref:`int` port_idx **)** +:ref:`Color` **get_output_port_color**\ (\ port_idx\: :ref:`int`\ ) Returns the :ref:`Color` of the output port with the given ``port_idx``. @@ -309,7 +309,7 @@ Returns the :ref:`Color` of the output port with the given ``port_i .. rst-class:: classref-method -:ref:`int` **get_output_port_count** **(** **)** +:ref:`int` **get_output_port_count**\ (\ ) Returns the number of slots with an enabled output port. @@ -321,7 +321,7 @@ Returns the number of slots with an enabled output port. .. rst-class:: classref-method -:ref:`Vector2` **get_output_port_position** **(** :ref:`int` port_idx **)** +:ref:`Vector2` **get_output_port_position**\ (\ port_idx\: :ref:`int`\ ) Returns the position of the output port with the given ``port_idx``. @@ -333,7 +333,7 @@ Returns the position of the output port with the given ``port_idx``. .. rst-class:: classref-method -:ref:`int` **get_output_port_slot** **(** :ref:`int` port_idx **)** +:ref:`int` **get_output_port_slot**\ (\ port_idx\: :ref:`int`\ ) Returns the corresponding slot index of the output port with the given ``port_idx``. @@ -345,7 +345,7 @@ Returns the corresponding slot index of the output port with the given ``port_id .. rst-class:: classref-method -:ref:`int` **get_output_port_type** **(** :ref:`int` port_idx **)** +:ref:`int` **get_output_port_type**\ (\ port_idx\: :ref:`int`\ ) Returns the type of the output port with the given ``port_idx``. @@ -357,7 +357,7 @@ Returns the type of the output port with the given ``port_idx``. .. rst-class:: classref-method -:ref:`Color` **get_slot_color_left** **(** :ref:`int` slot_index **)** |const| +:ref:`Color` **get_slot_color_left**\ (\ slot_index\: :ref:`int`\ ) |const| Returns the left (input) :ref:`Color` of the slot with the given ``slot_index``. @@ -369,7 +369,7 @@ Returns the left (input) :ref:`Color` of the slot with the given `` .. rst-class:: classref-method -:ref:`Color` **get_slot_color_right** **(** :ref:`int` slot_index **)** |const| +:ref:`Color` **get_slot_color_right**\ (\ slot_index\: :ref:`int`\ ) |const| Returns the right (output) :ref:`Color` of the slot with the given ``slot_index``. @@ -381,7 +381,7 @@ Returns the right (output) :ref:`Color` of the slot with the given .. rst-class:: classref-method -:ref:`Texture2D` **get_slot_custom_icon_left** **(** :ref:`int` slot_index **)** |const| +:ref:`Texture2D` **get_slot_custom_icon_left**\ (\ slot_index\: :ref:`int`\ ) |const| Returns the left (input) custom :ref:`Texture2D` of the slot with the given ``slot_index``. @@ -393,7 +393,7 @@ Returns the left (input) custom :ref:`Texture2D` of the slot wi .. rst-class:: classref-method -:ref:`Texture2D` **get_slot_custom_icon_right** **(** :ref:`int` slot_index **)** |const| +:ref:`Texture2D` **get_slot_custom_icon_right**\ (\ slot_index\: :ref:`int`\ ) |const| Returns the right (output) custom :ref:`Texture2D` of the slot with the given ``slot_index``. @@ -405,7 +405,7 @@ Returns the right (output) custom :ref:`Texture2D` of the slot .. rst-class:: classref-method -:ref:`int` **get_slot_type_left** **(** :ref:`int` slot_index **)** |const| +:ref:`int` **get_slot_type_left**\ (\ slot_index\: :ref:`int`\ ) |const| Returns the left (input) type of the slot with the given ``slot_index``. @@ -417,7 +417,7 @@ Returns the left (input) type of the slot with the given ``slot_index``. .. rst-class:: classref-method -:ref:`int` **get_slot_type_right** **(** :ref:`int` slot_index **)** |const| +:ref:`int` **get_slot_type_right**\ (\ slot_index\: :ref:`int`\ ) |const| Returns the right (output) type of the slot with the given ``slot_index``. @@ -429,7 +429,7 @@ Returns the right (output) type of the slot with the given ``slot_index``. .. rst-class:: classref-method -:ref:`HBoxContainer` **get_titlebar_hbox** **(** **)** +:ref:`HBoxContainer` **get_titlebar_hbox**\ (\ ) Returns the :ref:`HBoxContainer` used for the title bar, only containing a :ref:`Label` for displaying the title by default. This can be used to add custom controls to the title bar such as option or close buttons. @@ -441,7 +441,7 @@ Returns the :ref:`HBoxContainer` used for the title bar, on .. rst-class:: classref-method -:ref:`bool` **is_slot_draw_stylebox** **(** :ref:`int` slot_index **)** |const| +:ref:`bool` **is_slot_draw_stylebox**\ (\ slot_index\: :ref:`int`\ ) |const| Returns true if the background :ref:`StyleBox` of the slot with the given ``slot_index`` is drawn. @@ -453,7 +453,7 @@ Returns true if the background :ref:`StyleBox` of the slot with .. rst-class:: classref-method -:ref:`bool` **is_slot_enabled_left** **(** :ref:`int` slot_index **)** |const| +:ref:`bool` **is_slot_enabled_left**\ (\ slot_index\: :ref:`int`\ ) |const| Returns ``true`` if left (input) side of the slot with the given ``slot_index`` is enabled. @@ -465,7 +465,7 @@ Returns ``true`` if left (input) side of the slot with the given ``slot_index`` .. rst-class:: classref-method -:ref:`bool` **is_slot_enabled_right** **(** :ref:`int` slot_index **)** |const| +:ref:`bool` **is_slot_enabled_right**\ (\ slot_index\: :ref:`int`\ ) |const| Returns ``true`` if right (output) side of the slot with the given ``slot_index`` is enabled. @@ -477,7 +477,7 @@ Returns ``true`` if right (output) side of the slot with the given ``slot_index` .. rst-class:: classref-method -void **set_slot** **(** :ref:`int` slot_index, :ref:`bool` enable_left_port, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right_port, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture2D` custom_icon_left=null, :ref:`Texture2D` custom_icon_right=null, :ref:`bool` draw_stylebox=true **)** +|void| **set_slot**\ (\ slot_index\: :ref:`int`, enable_left_port\: :ref:`bool`, type_left\: :ref:`int`, color_left\: :ref:`Color`, enable_right_port\: :ref:`bool`, type_right\: :ref:`int`, color_right\: :ref:`Color`, custom_icon_left\: :ref:`Texture2D` = null, custom_icon_right\: :ref:`Texture2D` = null, draw_stylebox\: :ref:`bool` = true\ ) Sets properties of the slot with the given ``slot_index``. @@ -501,7 +501,7 @@ Individual properties can also be set using one of the ``set_slot_*`` methods. .. rst-class:: classref-method -void **set_slot_color_left** **(** :ref:`int` slot_index, :ref:`Color` color **)** +|void| **set_slot_color_left**\ (\ slot_index\: :ref:`int`, color\: :ref:`Color`\ ) Sets the :ref:`Color` of the left (input) side of the slot with the given ``slot_index`` to ``color``. @@ -513,7 +513,7 @@ Sets the :ref:`Color` of the left (input) side of the slot with the .. rst-class:: classref-method -void **set_slot_color_right** **(** :ref:`int` slot_index, :ref:`Color` color **)** +|void| **set_slot_color_right**\ (\ slot_index\: :ref:`int`, color\: :ref:`Color`\ ) Sets the :ref:`Color` of the right (output) side of the slot with the given ``slot_index`` to ``color``. @@ -525,7 +525,7 @@ Sets the :ref:`Color` of the right (output) side of the slot with t .. rst-class:: classref-method -void **set_slot_custom_icon_left** **(** :ref:`int` slot_index, :ref:`Texture2D` custom_icon **)** +|void| **set_slot_custom_icon_left**\ (\ slot_index\: :ref:`int`, custom_icon\: :ref:`Texture2D`\ ) Sets the custom :ref:`Texture2D` of the left (input) side of the slot with the given ``slot_index`` to ``custom_icon``. @@ -537,7 +537,7 @@ Sets the custom :ref:`Texture2D` of the left (input) side of th .. rst-class:: classref-method -void **set_slot_custom_icon_right** **(** :ref:`int` slot_index, :ref:`Texture2D` custom_icon **)** +|void| **set_slot_custom_icon_right**\ (\ slot_index\: :ref:`int`, custom_icon\: :ref:`Texture2D`\ ) Sets the custom :ref:`Texture2D` of the right (output) side of the slot with the given ``slot_index`` to ``custom_icon``. @@ -549,7 +549,7 @@ Sets the custom :ref:`Texture2D` of the right (output) side of .. rst-class:: classref-method -void **set_slot_draw_stylebox** **(** :ref:`int` slot_index, :ref:`bool` enable **)** +|void| **set_slot_draw_stylebox**\ (\ slot_index\: :ref:`int`, enable\: :ref:`bool`\ ) Toggles the background :ref:`StyleBox` of the slot with the given ``slot_index``. @@ -561,7 +561,7 @@ Toggles the background :ref:`StyleBox` of the slot with the give .. rst-class:: classref-method -void **set_slot_enabled_left** **(** :ref:`int` slot_index, :ref:`bool` enable **)** +|void| **set_slot_enabled_left**\ (\ slot_index\: :ref:`int`, enable\: :ref:`bool`\ ) Toggles the left (input) side of the slot with the given ``slot_index``. If ``enable`` is ``true``, a port will appear on the left side and the slot will be able to be connected from this side. @@ -573,7 +573,7 @@ Toggles the left (input) side of the slot with the given ``slot_index``. If ``en .. rst-class:: classref-method -void **set_slot_enabled_right** **(** :ref:`int` slot_index, :ref:`bool` enable **)** +|void| **set_slot_enabled_right**\ (\ slot_index\: :ref:`int`, enable\: :ref:`bool`\ ) Toggles the right (output) side of the slot with the given ``slot_index``. If ``enable`` is ``true``, a port will appear on the right side and the slot will be able to be connected from this side. @@ -585,7 +585,7 @@ Toggles the right (output) side of the slot with the given ``slot_index``. If `` .. rst-class:: classref-method -void **set_slot_type_left** **(** :ref:`int` slot_index, :ref:`int` type **)** +|void| **set_slot_type_left**\ (\ slot_index\: :ref:`int`, type\: :ref:`int`\ ) Sets the left (input) type of the slot with the given ``slot_index`` to ``type``. If the value is negative, all connections will be disallowed to be created via user inputs. @@ -597,7 +597,7 @@ Sets the left (input) type of the slot with the given ``slot_index`` to ``type`` .. rst-class:: classref-method -void **set_slot_type_right** **(** :ref:`int` slot_index, :ref:`int` type **)** +|void| **set_slot_type_right**\ (\ slot_index\: :ref:`int`, type\: :ref:`int`\ ) Sets the right (output) type of the slot with the given ``slot_index`` to ``type``. If the value is negative, all connections will be disallowed to be created via user inputs. @@ -721,3 +721,4 @@ The :ref:`StyleBox` used for the title bar of the **GraphNode** .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index 5d914852a58..c78644aa1d8 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -75,8 +75,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_columns** **(** :ref:`int` value **)** -- :ref:`int` **get_columns** **(** **)** +- |void| **set_columns**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_columns**\ (\ ) The number of columns in the **GridContainer**. If modified, **GridContainer** reorders its Control-derived children to accommodate the new layout. @@ -116,3 +116,4 @@ The vertical separation of children nodes. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index c64be5ce068..fae6948cc8c 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: tilemap + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -82,53 +85,53 @@ Methods .. table:: :widths: auto - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_baked_meshes` **(** **)** | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_bake_mesh_instance` **(** :ref:`int` idx **)** | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_bake_meshes` **(** **)** | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`get_basis_with_orthogonal_index` **(** :ref:`int` index **)** |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_cell_item` **(** :ref:`Vector3i` position **)** |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`get_cell_item_basis` **(** :ref:`Vector3i` position **)** |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_cell_item_orientation` **(** :ref:`Vector3i` position **)** |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_collision_layer_value` **(** :ref:`int` layer_number **)** |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_collision_mask_value` **(** :ref:`int` layer_number **)** |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_meshes` **(** **)** |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_navigation_map` **(** **)** |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_orthogonal_index_from_basis` **(** :ref:`Basis` basis **)** |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i[]` | :ref:`get_used_cells` **(** **)** |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i[]` | :ref:`get_used_cells_by_item` **(** :ref:`int` item **)** |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`local_to_map` **(** :ref:`Vector3` local_position **)** |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`make_baked_meshes` **(** :ref:`bool` gen_lightmap_uv=false, :ref:`float` lightmap_uv_texel_size=0.1 **)** | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`map_to_local` **(** :ref:`Vector3i` map_position **)** |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cell_item` **(** :ref:`Vector3i` position, :ref:`int` item, :ref:`int` orientation=0 **)** | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_navigation_map` **(** :ref:`RID` navigation_map **)** | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_baked_meshes`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_bake_mesh_instance`\ (\ idx\: :ref:`int`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_bake_meshes`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`get_basis_with_orthogonal_index`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_cell_item`\ (\ position\: :ref:`Vector3i`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`get_cell_item_basis`\ (\ position\: :ref:`Vector3i`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_cell_item_orientation`\ (\ position\: :ref:`Vector3i`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_collision_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_collision_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_meshes`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_navigation_map`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_orthogonal_index_from_basis`\ (\ basis\: :ref:`Basis`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector3i`\] | :ref:`get_used_cells`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector3i`\] | :ref:`get_used_cells_by_item`\ (\ item\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`local_to_map`\ (\ local_position\: :ref:`Vector3`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`make_baked_meshes`\ (\ gen_lightmap_uv\: :ref:`bool` = false, lightmap_uv_texel_size\: :ref:`float` = 0.1\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`map_to_local`\ (\ map_position\: :ref:`Vector3i`\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`resource_changed`\ (\ resource\: :ref:`Resource`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cell_item`\ (\ position\: :ref:`Vector3i`, item\: :ref:`int`, orientation\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_navigation_map`\ (\ navigation_map\: :ref:`RID`\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -143,7 +146,7 @@ Signals .. rst-class:: classref-signal -**cell_size_changed** **(** :ref:`Vector3` cell_size **)** +**cell_size_changed**\ (\ cell_size\: :ref:`Vector3`\ ) Emitted when :ref:`cell_size` changes. @@ -155,7 +158,7 @@ Emitted when :ref:`cell_size` changes. .. rst-class:: classref-signal -**changed** **(** **)** +**changed**\ (\ ) Emitted when the :ref:`MeshLibrary` of this GridMap changes. @@ -193,8 +196,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bake_navigation** **(** :ref:`bool` value **)** -- :ref:`bool` **is_baking_navigation** **(** **)** +- |void| **set_bake_navigation**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_baking_navigation**\ (\ ) If ``true``, this GridMap creates a navigation region for each cell that uses a :ref:`mesh_library` item with a navigation mesh. The created navigation region will use the navigation layers bitmask assigned to the :ref:`MeshLibrary`'s item. @@ -210,8 +213,8 @@ If ``true``, this GridMap creates a navigation region for each cell that uses a .. rst-class:: classref-property-setget -- void **set_center_x** **(** :ref:`bool` value **)** -- :ref:`bool` **get_center_x** **(** **)** +- |void| **set_center_x**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_center_x**\ (\ ) If ``true``, grid items are centered on the X axis. @@ -227,8 +230,8 @@ If ``true``, grid items are centered on the X axis. .. rst-class:: classref-property-setget -- void **set_center_y** **(** :ref:`bool` value **)** -- :ref:`bool` **get_center_y** **(** **)** +- |void| **set_center_y**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_center_y**\ (\ ) If ``true``, grid items are centered on the Y axis. @@ -244,8 +247,8 @@ If ``true``, grid items are centered on the Y axis. .. rst-class:: classref-property-setget -- void **set_center_z** **(** :ref:`bool` value **)** -- :ref:`bool` **get_center_z** **(** **)** +- |void| **set_center_z**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_center_z**\ (\ ) If ``true``, grid items are centered on the Z axis. @@ -261,8 +264,8 @@ If ``true``, grid items are centered on the Z axis. .. rst-class:: classref-property-setget -- void **set_octant_size** **(** :ref:`int` value **)** -- :ref:`int` **get_octant_size** **(** **)** +- |void| **set_octant_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_octant_size**\ (\ ) The size of each octant measured in number of cells. This applies to all three axis. @@ -278,8 +281,8 @@ The size of each octant measured in number of cells. This applies to all three a .. rst-class:: classref-property-setget -- void **set_cell_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_cell_scale** **(** **)** +- |void| **set_cell_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_cell_scale**\ (\ ) The scale of the cell items. @@ -297,8 +300,8 @@ This does not affect the size of the grid cells themselves, only the items in th .. rst-class:: classref-property-setget -- void **set_cell_size** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_cell_size** **(** **)** +- |void| **set_cell_size**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_cell_size**\ (\ ) The dimensions of the grid's cells. @@ -316,8 +319,8 @@ This does not affect the size of the meshes. See :ref:`cell_scale` value **)** -- :ref:`int` **get_collision_layer** **(** **)** +- |void| **set_collision_layer**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_layer**\ (\ ) The physics layers this GridMap is in. @@ -335,8 +338,8 @@ GridMaps act as static bodies, meaning they aren't affected by gravity or other .. rst-class:: classref-property-setget -- void **set_collision_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_mask** **(** **)** +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) The physics layers this GridMap detects collisions in. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information. @@ -352,8 +355,8 @@ The physics layers this GridMap detects collisions in. See `Collision layers and .. rst-class:: classref-property-setget -- void **set_collision_priority** **(** :ref:`float` value **)** -- :ref:`float` **get_collision_priority** **(** **)** +- |void| **set_collision_priority**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_collision_priority**\ (\ ) The priority used to solve colliding when occurring penetration. The higher the priority is, the lower the penetration into the object will be. This can for example be used to prevent the player from breaking through the boundaries of a level. @@ -369,8 +372,8 @@ The priority used to solve colliding when occurring penetration. The higher the .. rst-class:: classref-property-setget -- void **set_mesh_library** **(** :ref:`MeshLibrary` value **)** -- :ref:`MeshLibrary` **get_mesh_library** **(** **)** +- |void| **set_mesh_library**\ (\ value\: :ref:`MeshLibrary`\ ) +- :ref:`MeshLibrary` **get_mesh_library**\ (\ ) The assigned :ref:`MeshLibrary`. @@ -386,8 +389,8 @@ The assigned :ref:`MeshLibrary`. .. rst-class:: classref-property-setget -- void **set_physics_material** **(** :ref:`PhysicsMaterial` value **)** -- :ref:`PhysicsMaterial` **get_physics_material** **(** **)** +- |void| **set_physics_material**\ (\ value\: :ref:`PhysicsMaterial`\ ) +- :ref:`PhysicsMaterial` **get_physics_material**\ (\ ) Overrides the default friction and bounce physics properties for the whole **GridMap**. @@ -404,7 +407,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clear all cells. @@ -416,7 +419,7 @@ Clear all cells. .. rst-class:: classref-method -void **clear_baked_meshes** **(** **)** +|void| **clear_baked_meshes**\ (\ ) Clears all baked meshes. See :ref:`make_baked_meshes`. @@ -428,7 +431,7 @@ Clears all baked meshes. See :ref:`make_baked_meshes` **get_bake_mesh_instance** **(** :ref:`int` idx **)** +:ref:`RID` **get_bake_mesh_instance**\ (\ idx\: :ref:`int`\ ) Returns :ref:`RID` of a baked mesh with the given ``idx``. @@ -440,7 +443,7 @@ Returns :ref:`RID` of a baked mesh with the given ``idx``. .. rst-class:: classref-method -:ref:`Array` **get_bake_meshes** **(** **)** +:ref:`Array` **get_bake_meshes**\ (\ ) Returns an array of :ref:`ArrayMesh`\ es and :ref:`Transform3D` references of all bake meshes that exist within the current GridMap. @@ -452,7 +455,7 @@ Returns an array of :ref:`ArrayMesh`\ es and :ref:`Transform3D< .. rst-class:: classref-method -:ref:`Basis` **get_basis_with_orthogonal_index** **(** :ref:`int` index **)** |const| +:ref:`Basis` **get_basis_with_orthogonal_index**\ (\ index\: :ref:`int`\ ) |const| Returns one of 24 possible rotations that lie along the vectors (x,y,z) with each component being either -1, 0, or 1. For further details, refer to the Godot source code. @@ -464,7 +467,7 @@ Returns one of 24 possible rotations that lie along the vectors (x,y,z) with eac .. rst-class:: classref-method -:ref:`int` **get_cell_item** **(** :ref:`Vector3i` position **)** |const| +:ref:`int` **get_cell_item**\ (\ position\: :ref:`Vector3i`\ ) |const| The :ref:`MeshLibrary` item index located at the given grid coordinates. If the cell is empty, :ref:`INVALID_CELL_ITEM` will be returned. @@ -476,7 +479,7 @@ The :ref:`MeshLibrary` item index located at the given grid c .. rst-class:: classref-method -:ref:`Basis` **get_cell_item_basis** **(** :ref:`Vector3i` position **)** |const| +:ref:`Basis` **get_cell_item_basis**\ (\ position\: :ref:`Vector3i`\ ) |const| Returns the basis that gives the specified cell its orientation. @@ -488,7 +491,7 @@ Returns the basis that gives the specified cell its orientation. .. rst-class:: classref-method -:ref:`int` **get_cell_item_orientation** **(** :ref:`Vector3i` position **)** |const| +:ref:`int` **get_cell_item_orientation**\ (\ position\: :ref:`Vector3i`\ ) |const| The orientation of the cell at the given grid coordinates. ``-1`` is returned if the cell is empty. @@ -500,7 +503,7 @@ The orientation of the cell at the given grid coordinates. ``-1`` is returned if .. rst-class:: classref-method -:ref:`bool` **get_collision_layer_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_collision_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`collision_layer` is enabled, given a ``layer_number`` between 1 and 32. @@ -512,7 +515,7 @@ Returns whether or not the specified layer of the :ref:`collision_layer` **get_collision_mask_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -524,7 +527,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_meshes** **(** **)** |const| +:ref:`Array` **get_meshes**\ (\ ) |const| Returns an array of :ref:`Transform3D` and :ref:`Mesh` references corresponding to the non-empty cells in the grid. The transforms are specified in local space. @@ -536,7 +539,7 @@ Returns an array of :ref:`Transform3D` and :ref:`Mesh` **get_navigation_map** **(** **)** |const| +:ref:`RID` **get_navigation_map**\ (\ ) |const| Returns the :ref:`RID` of the navigation map this GridMap node uses for its cell baked navigation meshes. @@ -550,7 +553,7 @@ This function returns always the map set on the GridMap node and not the map on .. rst-class:: classref-method -:ref:`int` **get_orthogonal_index_from_basis** **(** :ref:`Basis` basis **)** |const| +:ref:`int` **get_orthogonal_index_from_basis**\ (\ basis\: :ref:`Basis`\ ) |const| This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1, 0, or 1, and returns the index (in the range from 0 to 23) of the point best representing the orientation of the object. For further details, refer to the Godot source code. @@ -562,7 +565,7 @@ This function considers a discretization of rotations into 24 points on unit sph .. rst-class:: classref-method -:ref:`Vector3i[]` **get_used_cells** **(** **)** |const| +:ref:`Array`\[:ref:`Vector3i`\] **get_used_cells**\ (\ ) |const| Returns an array of :ref:`Vector3` with the non-empty cell coordinates in the grid map. @@ -574,7 +577,7 @@ Returns an array of :ref:`Vector3` with the non-empty cell coordi .. rst-class:: classref-method -:ref:`Vector3i[]` **get_used_cells_by_item** **(** :ref:`int` item **)** |const| +:ref:`Array`\[:ref:`Vector3i`\] **get_used_cells_by_item**\ (\ item\: :ref:`int`\ ) |const| Returns an array of all cells with the given item index specified in ``item``. @@ -586,7 +589,7 @@ Returns an array of all cells with the given item index specified in ``item``. .. rst-class:: classref-method -:ref:`Vector3i` **local_to_map** **(** :ref:`Vector3` local_position **)** |const| +:ref:`Vector3i` **local_to_map**\ (\ local_position\: :ref:`Vector3`\ ) |const| Returns the map coordinates of the cell containing the given ``local_position``. If ``local_position`` is in global coordinates, consider using :ref:`Node3D.to_local` before passing it to this method. See also :ref:`map_to_local`. @@ -598,7 +601,7 @@ Returns the map coordinates of the cell containing the given ``local_position``. .. rst-class:: classref-method -void **make_baked_meshes** **(** :ref:`bool` gen_lightmap_uv=false, :ref:`float` lightmap_uv_texel_size=0.1 **)** +|void| **make_baked_meshes**\ (\ gen_lightmap_uv\: :ref:`bool` = false, lightmap_uv_texel_size\: :ref:`float` = 0.1\ ) Bakes lightmap data for all meshes in the assigned :ref:`MeshLibrary`. @@ -610,7 +613,7 @@ Bakes lightmap data for all meshes in the assigned :ref:`MeshLibrary` **map_to_local** **(** :ref:`Vector3i` map_position **)** |const| +:ref:`Vector3` **map_to_local**\ (\ map_position\: :ref:`Vector3i`\ ) |const| Returns the position of a grid cell in the GridMap's local coordinate space. To convert the returned value into global coordinates, use :ref:`Node3D.to_global`. See also :ref:`map_to_local`. @@ -622,7 +625,7 @@ Returns the position of a grid cell in the GridMap's local coordinate space. To .. rst-class:: classref-method -void **resource_changed** **(** :ref:`Resource` resource **)** +|void| **resource_changed**\ (\ resource\: :ref:`Resource`\ ) **Deprecated:** Use :ref:`Resource.changed` instead. @@ -636,7 +639,7 @@ This method does nothing. .. rst-class:: classref-method -void **set_cell_item** **(** :ref:`Vector3i` position, :ref:`int` item, :ref:`int` orientation=0 **)** +|void| **set_cell_item**\ (\ position\: :ref:`Vector3i`, item\: :ref:`int`, orientation\: :ref:`int` = 0\ ) Sets the mesh index for the cell referenced by its grid coordinates. @@ -652,7 +655,7 @@ Optionally, the item's orientation can be passed. For valid orientation values, .. rst-class:: classref-method -void **set_collision_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_collision_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`collision_layer`, given a ``layer_number`` between 1 and 32. @@ -664,7 +667,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. rst-class:: classref-method -void **set_collision_mask_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. @@ -676,7 +679,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. rst-class:: classref-method -void **set_navigation_map** **(** :ref:`RID` navigation_map **)** +|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) Sets the :ref:`RID` of the navigation map this GridMap node should use for its cell baked navigation meshes. @@ -687,3 +690,4 @@ Sets the :ref:`RID` of the navigation map this GridMap node should us .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_groovejoint2d.rst b/classes/class_groovejoint2d.rst index 141e85de6ee..1e4e339e1a6 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_initial_offset** **(** :ref:`float` value **)** -- :ref:`float` **get_initial_offset** **(** **)** +- |void| **set_initial_offset**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_initial_offset**\ (\ ) The body B's initial anchor position defined by the joint's origin and a local offset :ref:`initial_offset` along the joint's Y axis (along the groove). @@ -69,8 +69,8 @@ The body B's initial anchor position defined by the joint's origin and a local o .. rst-class:: classref-property-setget -- void **set_length** **(** :ref:`float` value **)** -- :ref:`float` **get_length** **(** **)** +- |void| **set_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_length**\ (\ ) The groove's length. The groove is from the joint's origin towards :ref:`length` along the joint's local Y axis. @@ -81,3 +81,4 @@ The groove's length. The groove is from the joint's origin towards :ref:`length< .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_hashingcontext.rst b/classes/class_hashingcontext.rst index d20520a104a..e6ccd0ba948 100644 --- a/classes/class_hashingcontext.rst +++ b/classes/class_hashingcontext.rst @@ -84,13 +84,13 @@ Methods .. table:: :widths: auto - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`finish` **(** **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`start` **(** :ref:`HashType` type **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`update` **(** :ref:`PackedByteArray` chunk **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`finish`\ (\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`start`\ (\ type\: :ref:`HashType`\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`update`\ (\ chunk\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -144,7 +144,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedByteArray` **finish** **(** **)** +:ref:`PackedByteArray` **finish**\ (\ ) Closes the current context, and return the computed hash. @@ -156,7 +156,7 @@ Closes the current context, and return the computed hash. .. rst-class:: classref-method -:ref:`Error` **start** **(** :ref:`HashType` type **)** +:ref:`Error` **start**\ (\ type\: :ref:`HashType`\ ) Starts a new hash computation of the given ``type`` (e.g. :ref:`HASH_SHA256` to start computation of a SHA-256). @@ -168,7 +168,7 @@ Starts a new hash computation of the given ``type`` (e.g. :ref:`HASH_SHA256` **update** **(** :ref:`PackedByteArray` chunk **)** +:ref:`Error` **update**\ (\ chunk\: :ref:`PackedByteArray`\ ) Updates the computation with the given ``chunk`` of data. @@ -179,3 +179,4 @@ Updates the computation with the given ``chunk`` of data. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_hboxcontainer.rst b/classes/class_hboxcontainer.rst index 7c94048cb44..586e6fcfd6d 100644 --- a/classes/class_hboxcontainer.rst +++ b/classes/class_hboxcontainer.rst @@ -37,3 +37,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_heightmapshape3d.rst b/classes/class_heightmapshape3d.rst index 2e43c5717a6..a6509380429 100644 --- a/classes/class_heightmapshape3d.rst +++ b/classes/class_heightmapshape3d.rst @@ -47,11 +47,11 @@ Methods .. table:: :widths: auto - +---------------------------+-----------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_max_height` **(** **)** |const| | - +---------------------------+-----------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_min_height` **(** **)** |const| | - +---------------------------+-----------------------------------------------------------------------------------------+ + +---------------------------+-----------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_max_height`\ (\ ) |const| | + +---------------------------+-----------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_min_height`\ (\ ) |const| | + +---------------------------+-----------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -70,8 +70,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_map_data** **(** :ref:`PackedFloat32Array` value **)** -- :ref:`PackedFloat32Array` **get_map_data** **(** **)** +- |void| **set_map_data**\ (\ value\: :ref:`PackedFloat32Array`\ ) +- :ref:`PackedFloat32Array` **get_map_data**\ (\ ) Height map data. The array's size must be equal to :ref:`map_width` multiplied by :ref:`map_depth`. @@ -87,8 +87,8 @@ Height map data. The array's size must be equal to :ref:`map_width` value **)** -- :ref:`int` **get_map_depth** **(** **)** +- |void| **set_map_depth**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_map_depth**\ (\ ) Number of vertices in the depth of the height map. Changing this will resize the :ref:`map_data`. @@ -104,8 +104,8 @@ Number of vertices in the depth of the height map. Changing this will resize the .. rst-class:: classref-property-setget -- void **set_map_width** **(** :ref:`int` value **)** -- :ref:`int` **get_map_width** **(** **)** +- |void| **set_map_width**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_map_width**\ (\ ) Number of vertices in the width of the height map. Changing this will resize the :ref:`map_data`. @@ -122,7 +122,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_max_height** **(** **)** |const| +:ref:`float` **get_max_height**\ (\ ) |const| Returns the largest height value found in :ref:`map_data`. Recalculates only when :ref:`map_data` changes. @@ -134,7 +134,7 @@ Returns the largest height value found in :ref:`map_data` **get_min_height** **(** **)** |const| +:ref:`float` **get_min_height**\ (\ ) |const| Returns the smallest height value found in :ref:`map_data`. Recalculates only when :ref:`map_data` changes. @@ -145,3 +145,4 @@ Returns the smallest height value found in :ref:`map_data` | :ref:`get_flag` **(** :ref:`Flag` flag **)** |const| | - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_param` **(** :ref:`Param` param **)** |const| | - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_flag` **(** :ref:`Flag` flag, :ref:`bool` enabled **)** | - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_param` **(** :ref:`Param` param, :ref:`float` value **)** | - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_flag`\ (\ flag\: :ref:`Flag`\ ) |const| | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_param`\ (\ param\: :ref:`Param`\ ) |const| | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_flag`\ (\ flag\: :ref:`Flag`, enabled\: :ref:`bool`\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_param`\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -211,8 +211,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The speed with which the rotation across the axis perpendicular to the hinge gets corrected. @@ -228,8 +228,8 @@ The speed with which the rotation across the axis perpendicular to the hinge get .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flag` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_flag** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flag`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flag`\ ) |const| If ``true``, the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. @@ -245,8 +245,8 @@ If ``true``, the hinges maximum and minimum rotation, defined by :ref:`angular_l .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The minimum rotation. Only active if :ref:`angular_limit/enable` is ``true``. @@ -262,8 +262,8 @@ The minimum rotation. Only active if :ref:`angular_limit/enable` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The lower this value, the more the rotation gets slowed down. @@ -279,8 +279,8 @@ The lower this value, the more the rotation gets slowed down. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -298,8 +298,8 @@ The lower this value, the more the rotation gets slowed down. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The maximum rotation. Only active if :ref:`angular_limit/enable` is ``true``. @@ -315,8 +315,8 @@ The maximum rotation. Only active if :ref:`angular_limit/enable` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_flag** **(** :ref:`Flag` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flag`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flag`\ ) |const| When activated, a motor turns the hinge. @@ -332,8 +332,8 @@ When activated, a motor turns the hinge. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| Maximum acceleration for the motor. @@ -349,8 +349,8 @@ Maximum acceleration for the motor. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| Target speed for the motor. @@ -366,8 +366,8 @@ Target speed for the motor. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The speed with which the two bodies get pulled together when they move in different directions. @@ -384,7 +384,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_flag** **(** :ref:`Flag` flag **)** |const| +:ref:`bool` **get_flag**\ (\ flag\: :ref:`Flag`\ ) |const| Returns the value of the specified flag. @@ -396,7 +396,7 @@ Returns the value of the specified flag. .. rst-class:: classref-method -:ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +:ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| Returns the value of the specified parameter. @@ -408,7 +408,7 @@ Returns the value of the specified parameter. .. rst-class:: classref-method -void **set_flag** **(** :ref:`Flag` flag, :ref:`bool` enabled **)** +|void| **set_flag**\ (\ flag\: :ref:`Flag`, enabled\: :ref:`bool`\ ) If ``true``, enables the specified flag. @@ -420,7 +420,7 @@ If ``true``, enables the specified flag. .. rst-class:: classref-method -void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** +|void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) Sets the value of the specified parameter. @@ -431,3 +431,4 @@ Sets the value of the specified parameter. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_hmaccontext.rst b/classes/class_hmaccontext.rst index 484a5e57540..7fb461bf6be 100644 --- a/classes/class_hmaccontext.rst +++ b/classes/class_hmaccontext.rst @@ -78,13 +78,13 @@ Methods .. table:: :widths: auto - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`finish` **(** **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`start` **(** :ref:`HashType` hash_type, :ref:`PackedByteArray` key **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`update` **(** :ref:`PackedByteArray` data **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`finish`\ (\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`start`\ (\ hash_type\: :ref:`HashType`, key\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`update`\ (\ data\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -99,7 +99,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedByteArray` **finish** **(** **)** +:ref:`PackedByteArray` **finish**\ (\ ) Returns the resulting HMAC. If the HMAC failed, an empty :ref:`PackedByteArray` is returned. @@ -111,7 +111,7 @@ Returns the resulting HMAC. If the HMAC failed, an empty :ref:`PackedByteArray` **start** **(** :ref:`HashType` hash_type, :ref:`PackedByteArray` key **)** +:ref:`Error` **start**\ (\ hash_type\: :ref:`HashType`, key\: :ref:`PackedByteArray`\ ) Initializes the HMACContext. This method cannot be called again on the same HMACContext until :ref:`finish` has been called. @@ -123,7 +123,7 @@ Initializes the HMACContext. This method cannot be called again on the same HMAC .. rst-class:: classref-method -:ref:`Error` **update** **(** :ref:`PackedByteArray` data **)** +:ref:`Error` **update**\ (\ data\: :ref:`PackedByteArray`\ ) Updates the message to be HMACed. This can be called multiple times before :ref:`finish` is called to append ``data`` to the message, but cannot be called until :ref:`start` has been called. @@ -134,3 +134,4 @@ Updates the message to be HMACed. This can be called multiple times before :ref: .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_hscrollbar.rst b/classes/class_hscrollbar.rst index a4193b85b23..d1f90047bca 100644 --- a/classes/class_hscrollbar.rst +++ b/classes/class_hscrollbar.rst @@ -28,3 +28,4 @@ A horizontal scrollbar, typically used to navigate through content that extends .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_hseparator.rst b/classes/class_hseparator.rst index 883c63ad5f0..c560d12609c 100644 --- a/classes/class_hseparator.rst +++ b/classes/class_hseparator.rst @@ -28,3 +28,4 @@ A horizontal separator used for separating other controls that are arranged **ve .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_hslider.rst b/classes/class_hslider.rst index 82c2e03f8d9..88388944b4b 100644 --- a/classes/class_hslider.rst +++ b/classes/class_hslider.rst @@ -28,3 +28,4 @@ A horizontal slider, used to adjust a value by moving a grabber along a horizont .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_hsplitcontainer.rst b/classes/class_hsplitcontainer.rst index bc00d1045fe..a1880d8c248 100644 --- a/classes/class_hsplitcontainer.rst +++ b/classes/class_hsplitcontainer.rst @@ -35,3 +35,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index 2dd27d2f7dc..5c22f7d6a30 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -72,39 +72,39 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`close` **(** **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port=-1, :ref:`TLSOptions` tls_options=null **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_response_body_length` **(** **)** |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_response_code` **(** **)** |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_response_headers` **(** **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_response_headers_as_dictionary` **(** **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Status` | :ref:`get_status` **(** **)** |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_response` **(** **)** |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_response_chunked` **(** **)** |const| | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`poll` **(** **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`query_string_from_dict` **(** :ref:`Dictionary` fields **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`read_response_body_chunk` **(** **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`request` **(** :ref:`Method` method, :ref:`String` url, :ref:`PackedStringArray` headers, :ref:`String` body="" **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`request_raw` **(** :ref:`Method` method, :ref:`String` url, :ref:`PackedStringArray` headers, :ref:`PackedByteArray` body **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_http_proxy` **(** :ref:`String` host, :ref:`int` port **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_https_proxy` **(** :ref:`String` host, :ref:`int` port **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`close`\ (\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`connect_to_host`\ (\ host\: :ref:`String`, port\: :ref:`int` = -1, tls_options\: :ref:`TLSOptions` = null\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_response_body_length`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_response_code`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_response_headers`\ (\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_response_headers_as_dictionary`\ (\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Status` | :ref:`get_status`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_response`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_response_chunked`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`poll`\ (\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`query_string_from_dict`\ (\ fields\: :ref:`Dictionary`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`read_response_body_chunk`\ (\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`request`\ (\ method\: :ref:`Method`, url\: :ref:`String`, headers\: :ref:`PackedStringArray`, body\: :ref:`String` = ""\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`request_raw`\ (\ method\: :ref:`Method`, url\: :ref:`String`, headers\: :ref:`PackedStringArray`, body\: :ref:`PackedByteArray`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_http_proxy`\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_https_proxy`\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -451,7 +451,7 @@ HTTP status code ``304 Not Modified``. A conditional GET or HEAD request has bee :ref:`ResponseCode` **RESPONSE_USE_PROXY** = ``305`` -**Deprecated:** This constant may be changed or removed in future versions. +**Deprecated:** Many clients ignore this response code for security reasons. It is also deprecated by the HTTP standard. HTTP status code ``305 Use Proxy``. @@ -461,7 +461,7 @@ HTTP status code ``305 Use Proxy``. :ref:`ResponseCode` **RESPONSE_SWITCH_PROXY** = ``306`` -**Deprecated:** This constant may be changed or removed in future versions. +**Deprecated:** Many clients ignore this response code for security reasons. It is also deprecated by the HTTP standard. HTTP status code ``306 Switch Proxy``. @@ -810,8 +810,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_blocking_mode** **(** :ref:`bool` value **)** -- :ref:`bool` **is_blocking_mode_enabled** **(** **)** +- |void| **set_blocking_mode**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_blocking_mode_enabled**\ (\ ) If ``true``, execution will block until all data is read from the response. @@ -827,8 +827,8 @@ If ``true``, execution will block until all data is read from the response. .. rst-class:: classref-property-setget -- void **set_connection** **(** :ref:`StreamPeer` value **)** -- :ref:`StreamPeer` **get_connection** **(** **)** +- |void| **set_connection**\ (\ value\: :ref:`StreamPeer`\ ) +- :ref:`StreamPeer` **get_connection**\ (\ ) The connection to use for this client. @@ -844,8 +844,8 @@ The connection to use for this client. .. rst-class:: classref-property-setget -- void **set_read_chunk_size** **(** :ref:`int` value **)** -- :ref:`int` **get_read_chunk_size** **(** **)** +- |void| **set_read_chunk_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_read_chunk_size**\ (\ ) The size of the buffer used and maximum bytes to read per iteration. See :ref:`read_response_body_chunk`. @@ -862,7 +862,7 @@ Method Descriptions .. rst-class:: classref-method -void **close** **(** **)** +|void| **close**\ (\ ) Closes the current connection, allowing reuse of this **HTTPClient**. @@ -874,7 +874,7 @@ Closes the current connection, allowing reuse of this **HTTPClient**. .. rst-class:: classref-method -:ref:`Error` **connect_to_host** **(** :ref:`String` host, :ref:`int` port=-1, :ref:`TLSOptions` tls_options=null **)** +:ref:`Error` **connect_to_host**\ (\ host\: :ref:`String`, port\: :ref:`int` = -1, tls_options\: :ref:`TLSOptions` = null\ ) Connects to a host. This needs to be done before any requests are sent. @@ -888,7 +888,7 @@ If no ``port`` is specified (or ``-1`` is used), it is automatically set to 80 f .. rst-class:: classref-method -:ref:`int` **get_response_body_length** **(** **)** |const| +:ref:`int` **get_response_body_length**\ (\ ) |const| Returns the response's body length. @@ -904,7 +904,7 @@ Returns the response's body length. .. rst-class:: classref-method -:ref:`int` **get_response_code** **(** **)** |const| +:ref:`int` **get_response_code**\ (\ ) |const| Returns the response's HTTP status code. @@ -916,7 +916,7 @@ Returns the response's HTTP status code. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_response_headers** **(** **)** +:ref:`PackedStringArray` **get_response_headers**\ (\ ) Returns the response headers. @@ -928,7 +928,7 @@ Returns the response headers. .. rst-class:: classref-method -:ref:`Dictionary` **get_response_headers_as_dictionary** **(** **)** +:ref:`Dictionary` **get_response_headers_as_dictionary**\ (\ ) Returns all response headers as a Dictionary of structure ``{ "key": "value1; value2" }`` where the case-sensitivity of the keys and values is kept like the server delivers it. A value is a simple String, this string can have more than one value where "; " is used as separator. @@ -949,7 +949,7 @@ Returns all response headers as a Dictionary of structure ``{ "key": "value1; va .. rst-class:: classref-method -:ref:`Status` **get_status** **(** **)** |const| +:ref:`Status` **get_status**\ (\ ) |const| Returns a :ref:`Status` constant. Need to call :ref:`poll` in order to get status updates. @@ -961,7 +961,7 @@ Returns a :ref:`Status` constant. Need to call :ref:`pol .. rst-class:: classref-method -:ref:`bool` **has_response** **(** **)** |const| +:ref:`bool` **has_response**\ (\ ) |const| If ``true``, this **HTTPClient** has a response available. @@ -973,7 +973,7 @@ If ``true``, this **HTTPClient** has a response available. .. rst-class:: classref-method -:ref:`bool` **is_response_chunked** **(** **)** |const| +:ref:`bool` **is_response_chunked**\ (\ ) |const| If ``true``, this **HTTPClient** has a response that is chunked. @@ -985,7 +985,7 @@ If ``true``, this **HTTPClient** has a response that is chunked. .. rst-class:: classref-method -:ref:`Error` **poll** **(** **)** +:ref:`Error` **poll**\ (\ ) This needs to be called in order to have any request processed. Check results with :ref:`get_status`. @@ -997,7 +997,7 @@ This needs to be called in order to have any request processed. Check results wi .. rst-class:: classref-method -:ref:`String` **query_string_from_dict** **(** :ref:`Dictionary` fields **)** +:ref:`String` **query_string_from_dict**\ (\ fields\: :ref:`Dictionary`\ ) Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.: @@ -1050,7 +1050,7 @@ Furthermore, if a key has a ``null`` value, only the key itself is added, withou .. rst-class:: classref-method -:ref:`PackedByteArray` **read_response_body_chunk** **(** **)** +:ref:`PackedByteArray` **read_response_body_chunk**\ (\ ) Reads one chunk from the response. @@ -1062,7 +1062,7 @@ Reads one chunk from the response. .. rst-class:: classref-method -:ref:`Error` **request** **(** :ref:`Method` method, :ref:`String` url, :ref:`PackedStringArray` headers, :ref:`String` body="" **)** +:ref:`Error` **request**\ (\ method\: :ref:`Method`, url\: :ref:`String`, headers\: :ref:`PackedStringArray`, body\: :ref:`String` = ""\ ) Sends a request to the connected host. @@ -1101,7 +1101,7 @@ To create a POST request with query strings to push to the server, do: .. rst-class:: classref-method -:ref:`Error` **request_raw** **(** :ref:`Method` method, :ref:`String` url, :ref:`PackedStringArray` headers, :ref:`PackedByteArray` body **)** +:ref:`Error` **request_raw**\ (\ method\: :ref:`Method`, url\: :ref:`String`, headers\: :ref:`PackedStringArray`, body\: :ref:`PackedByteArray`\ ) Sends a raw request to the connected host. @@ -1119,7 +1119,7 @@ Sends the body data raw, as a byte array and does not encode it in any way. .. rst-class:: classref-method -void **set_http_proxy** **(** :ref:`String` host, :ref:`int` port **)** +|void| **set_http_proxy**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) Sets the proxy server for HTTP requests. @@ -1133,7 +1133,7 @@ The proxy server is unset if ``host`` is empty or ``port`` is -1. .. rst-class:: classref-method -void **set_https_proxy** **(** :ref:`String` host, :ref:`int` port **)** +|void| **set_https_proxy**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) Sets the proxy server for HTTPS requests. @@ -1146,3 +1146,4 @@ The proxy server is unset if ``host`` is empty or ``port`` is -1. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index 879ef1766dc..f0ba12c2e65 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -224,25 +224,25 @@ Methods .. table:: :widths: auto - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`cancel_request` **(** **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_body_size` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Status` | :ref:`get_http_client_status` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`request` **(** :ref:`String` url, :ref:`PackedStringArray` custom_headers=PackedStringArray(), :ref:`Method` method=0, :ref:`String` request_data="" **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`request_raw` **(** :ref:`String` url, :ref:`PackedStringArray` custom_headers=PackedStringArray(), :ref:`Method` method=0, :ref:`PackedByteArray` request_data_raw=PackedByteArray() **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_http_proxy` **(** :ref:`String` host, :ref:`int` port **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_https_proxy` **(** :ref:`String` host, :ref:`int` port **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tls_options` **(** :ref:`TLSOptions` client_options **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cancel_request`\ (\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_body_size`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_downloaded_bytes`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Status` | :ref:`get_http_client_status`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`request`\ (\ url\: :ref:`String`, custom_headers\: :ref:`PackedStringArray` = PackedStringArray(), method\: :ref:`Method` = 0, request_data\: :ref:`String` = ""\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`request_raw`\ (\ url\: :ref:`String`, custom_headers\: :ref:`PackedStringArray` = PackedStringArray(), method\: :ref:`Method` = 0, request_data_raw\: :ref:`PackedByteArray` = PackedByteArray()\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_http_proxy`\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_https_proxy`\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tls_options`\ (\ client_options\: :ref:`TLSOptions`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -257,7 +257,7 @@ Signals .. rst-class:: classref-signal -**request_completed** **(** :ref:`int` result, :ref:`int` response_code, :ref:`PackedStringArray` headers, :ref:`PackedByteArray` body **)** +**request_completed**\ (\ result\: :ref:`int`, response_code\: :ref:`int`, headers\: :ref:`PackedStringArray`, body\: :ref:`PackedByteArray`\ ) Emitted when a request is completed. @@ -413,8 +413,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_accept_gzip** **(** :ref:`bool` value **)** -- :ref:`bool` **is_accepting_gzip** **(** **)** +- |void| **set_accept_gzip**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_accepting_gzip**\ (\ ) If ``true``, this header will be added to each request: ``Accept-Encoding: gzip, deflate`` telling servers that it's okay to compress response bodies. @@ -436,8 +436,8 @@ If ``false`` no header will be added, and no decompression will be performed on .. rst-class:: classref-property-setget -- void **set_body_size_limit** **(** :ref:`int` value **)** -- :ref:`int` **get_body_size_limit** **(** **)** +- |void| **set_body_size_limit**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_body_size_limit**\ (\ ) Maximum allowed size for response bodies. If the response body is compressed, this will be used as the maximum allowed size for the decompressed body. @@ -453,8 +453,8 @@ Maximum allowed size for response bodies. If the response body is compressed, th .. rst-class:: classref-property-setget -- void **set_download_chunk_size** **(** :ref:`int` value **)** -- :ref:`int` **get_download_chunk_size** **(** **)** +- |void| **set_download_chunk_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_download_chunk_size**\ (\ ) The size of the buffer used and maximum bytes to read per iteration. See :ref:`HTTPClient.read_chunk_size`. @@ -472,8 +472,8 @@ Set this to a lower value (e.g. 4096 for 4 KiB) when downloading small files to .. rst-class:: classref-property-setget -- void **set_download_file** **(** :ref:`String` value **)** -- :ref:`String` **get_download_file** **(** **)** +- |void| **set_download_file**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_download_file**\ (\ ) The file to download into. Will output any received file into it. @@ -489,8 +489,8 @@ The file to download into. Will output any received file into it. .. rst-class:: classref-property-setget -- void **set_max_redirects** **(** :ref:`int` value **)** -- :ref:`int` **get_max_redirects** **(** **)** +- |void| **set_max_redirects**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_redirects**\ (\ ) Maximum number of allowed redirects. @@ -506,8 +506,8 @@ Maximum number of allowed redirects. .. rst-class:: classref-property-setget -- void **set_timeout** **(** :ref:`float` value **)** -- :ref:`float` **get_timeout** **(** **)** +- |void| **set_timeout**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_timeout**\ (\ ) The duration to wait in seconds before a request times out. If :ref:`timeout` is set to ``0.0`` then the request will never time out. For simple requests, such as communication with a REST API, it is recommended that :ref:`timeout` is set to a value suitable for the server response time (e.g. between ``1.0`` and ``10.0``). This will help prevent unwanted timeouts caused by variation in server response times while still allowing the application to detect when a request has timed out. For larger requests such as file downloads it is suggested the :ref:`timeout` be set to ``0.0``, disabling the timeout functionality. This will help to prevent large transfers from failing due to exceeding the timeout value. @@ -523,8 +523,8 @@ The duration to wait in seconds before a request times out. If :ref:`timeout` value **)** -- :ref:`bool` **is_using_threads** **(** **)** +- |void| **set_use_threads**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_threads**\ (\ ) If ``true``, multithreading is used to improve performance. @@ -541,7 +541,7 @@ Method Descriptions .. rst-class:: classref-method -void **cancel_request** **(** **)** +|void| **cancel_request**\ (\ ) Cancels the current request. @@ -553,7 +553,7 @@ Cancels the current request. .. rst-class:: classref-method -:ref:`int` **get_body_size** **(** **)** |const| +:ref:`int` **get_body_size**\ (\ ) |const| Returns the response body length. @@ -567,7 +567,7 @@ Returns the response body length. .. rst-class:: classref-method -:ref:`int` **get_downloaded_bytes** **(** **)** |const| +:ref:`int` **get_downloaded_bytes**\ (\ ) |const| Returns the number of bytes this HTTPRequest downloaded. @@ -579,7 +579,7 @@ Returns the number of bytes this HTTPRequest downloaded. .. rst-class:: classref-method -:ref:`Status` **get_http_client_status** **(** **)** |const| +:ref:`Status` **get_http_client_status**\ (\ ) |const| Returns the current status of the underlying :ref:`HTTPClient`. See :ref:`Status`. @@ -591,7 +591,7 @@ Returns the current status of the underlying :ref:`HTTPClient` .. rst-class:: classref-method -:ref:`Error` **request** **(** :ref:`String` url, :ref:`PackedStringArray` custom_headers=PackedStringArray(), :ref:`Method` method=0, :ref:`String` request_data="" **)** +:ref:`Error` **request**\ (\ url\: :ref:`String`, custom_headers\: :ref:`PackedStringArray` = PackedStringArray(), method\: :ref:`Method` = 0, request_data\: :ref:`String` = ""\ ) Creates request on the underlying :ref:`HTTPClient`. If there is no configuration errors, it tries to connect using :ref:`HTTPClient.connect_to_host` and passes parameters onto :ref:`HTTPClient.request`. @@ -609,7 +609,7 @@ Returns :ref:`@GlobalScope.OK` if request is suc .. rst-class:: classref-method -:ref:`Error` **request_raw** **(** :ref:`String` url, :ref:`PackedStringArray` custom_headers=PackedStringArray(), :ref:`Method` method=0, :ref:`PackedByteArray` request_data_raw=PackedByteArray() **)** +:ref:`Error` **request_raw**\ (\ url\: :ref:`String`, custom_headers\: :ref:`PackedStringArray` = PackedStringArray(), method\: :ref:`Method` = 0, request_data_raw\: :ref:`PackedByteArray` = PackedByteArray()\ ) Creates request on the underlying :ref:`HTTPClient` using a raw array of bytes for the request body. If there is no configuration errors, it tries to connect using :ref:`HTTPClient.connect_to_host` and passes parameters onto :ref:`HTTPClient.request`. @@ -623,7 +623,7 @@ Returns :ref:`@GlobalScope.OK` if request is suc .. rst-class:: classref-method -void **set_http_proxy** **(** :ref:`String` host, :ref:`int` port **)** +|void| **set_http_proxy**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) Sets the proxy server for HTTP requests. @@ -637,7 +637,7 @@ The proxy server is unset if ``host`` is empty or ``port`` is -1. .. rst-class:: classref-method -void **set_https_proxy** **(** :ref:`String` host, :ref:`int` port **)** +|void| **set_https_proxy**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) Sets the proxy server for HTTPS requests. @@ -651,7 +651,7 @@ The proxy server is unset if ``host`` is empty or ``port`` is -1. .. rst-class:: classref-method -void **set_tls_options** **(** :ref:`TLSOptions` client_options **)** +|void| **set_tls_options**\ (\ client_options\: :ref:`TLSOptions`\ ) Sets the :ref:`TLSOptions` to be used when connecting to an HTTPS server. See :ref:`TLSOptions.client`. @@ -662,3 +662,4 @@ Sets the :ref:`TLSOptions` to be used when connecting to an HT .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_image.rst b/classes/class_image.rst index df3f4342bfd..714fd9ee5d7 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -54,145 +54,145 @@ Methods .. table:: :widths: auto - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`adjust_bcs` **(** :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`blend_rect` **(** :ref:`Image` src, :ref:`Rect2i` src_rect, :ref:`Vector2i` dst **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`blend_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2i` src_rect, :ref:`Vector2i` dst **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`blit_rect` **(** :ref:`Image` src, :ref:`Rect2i` src_rect, :ref:`Vector2i` dst **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`blit_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2i` src_rect, :ref:`Vector2i` dst **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`bump_map_to_normal_map` **(** :ref:`float` bump_scale=1.0 **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_mipmaps` **(** **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`compress` **(** :ref:`CompressMode` mode, :ref:`CompressSource` source=0, :ref:`ASTCFormat` astc_format=0 **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`compress_from_channels` **(** :ref:`CompressMode` mode, :ref:`UsedChannels` channels, :ref:`ASTCFormat` astc_format=0 **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`compute_image_metrics` **(** :ref:`Image` compared_image, :ref:`bool` use_luma **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`convert` **(** :ref:`Format` format **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`copy_from` **(** :ref:`Image` src **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format **)** |static| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`create_from_data` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format, :ref:`PackedByteArray` data **)** |static| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`crop` **(** :ref:`int` width, :ref:`int` height **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`decompress` **(** **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AlphaMode` | :ref:`detect_alpha` **(** **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`UsedChannels` | :ref:`detect_used_channels` **(** :ref:`CompressSource` source=0 **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fill` **(** :ref:`Color` color **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fill_rect` **(** :ref:`Rect2i` rect, :ref:`Color` color **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fix_alpha_edges` **(** **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`flip_x` **(** **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`flip_y` **(** **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`generate_mipmaps` **(** :ref:`bool` renormalize=false **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`get_data` **(** **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Format` | :ref:`get_format` **(** **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_height` **(** **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_mipmap_count` **(** **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_mipmap_offset` **(** :ref:`int` mipmap **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_pixel` **(** :ref:`int` x, :ref:`int` y **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_pixelv` **(** :ref:`Vector2i` point **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`get_region` **(** :ref:`Rect2i` region **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_size` **(** **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`get_used_rect` **(** **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_width` **(** **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_mipmaps` **(** **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_compressed` **(** **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty` **(** **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_invisible` **(** **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load_bmp_from_buffer` **(** :ref:`PackedByteArray` buffer **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`load_from_file` **(** :ref:`String` path **)** |static| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load_jpg_from_buffer` **(** :ref:`PackedByteArray` buffer **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load_ktx_from_buffer` **(** :ref:`PackedByteArray` buffer **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load_png_from_buffer` **(** :ref:`PackedByteArray` buffer **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load_svg_from_buffer` **(** :ref:`PackedByteArray` buffer, :ref:`float` scale=1.0 **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load_svg_from_string` **(** :ref:`String` svg_str, :ref:`float` scale=1.0 **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load_tga_from_buffer` **(** :ref:`PackedByteArray` buffer **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load_webp_from_buffer` **(** :ref:`PackedByteArray` buffer **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`normal_map_to_xy` **(** **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`premultiply_alpha` **(** **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`resize` **(** :ref:`int` width, :ref:`int` height, :ref:`Interpolation` interpolation=1 **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`resize_to_po2` **(** :ref:`bool` square=false, :ref:`Interpolation` interpolation=1 **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`rgbe_to_srgb` **(** **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rotate_90` **(** :ref:`ClockDirection` direction **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rotate_180` **(** **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save_exr` **(** :ref:`String` path, :ref:`bool` grayscale=false **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`save_exr_to_buffer` **(** :ref:`bool` grayscale=false **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save_jpg` **(** :ref:`String` path, :ref:`float` quality=0.75 **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`save_jpg_to_buffer` **(** :ref:`float` quality=0.75 **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save_png` **(** :ref:`String` path **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`save_png_to_buffer` **(** **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save_webp` **(** :ref:`String` path, :ref:`bool` lossy=false, :ref:`float` quality=0.75 **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`save_webp_to_buffer` **(** :ref:`bool` lossy=false, :ref:`float` quality=0.75 **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_data` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format, :ref:`PackedByteArray` data **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_pixel` **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_pixelv` **(** :ref:`Vector2i` point, :ref:`Color` color **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shrink_x2` **(** **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`srgb_to_linear` **(** **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`adjust_bcs`\ (\ brightness\: :ref:`float`, contrast\: :ref:`float`, saturation\: :ref:`float`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`blend_rect`\ (\ src\: :ref:`Image`, src_rect\: :ref:`Rect2i`, dst\: :ref:`Vector2i`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`blend_rect_mask`\ (\ src\: :ref:`Image`, mask\: :ref:`Image`, src_rect\: :ref:`Rect2i`, dst\: :ref:`Vector2i`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`blit_rect`\ (\ src\: :ref:`Image`, src_rect\: :ref:`Rect2i`, dst\: :ref:`Vector2i`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`blit_rect_mask`\ (\ src\: :ref:`Image`, mask\: :ref:`Image`, src_rect\: :ref:`Rect2i`, dst\: :ref:`Vector2i`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bump_map_to_normal_map`\ (\ bump_scale\: :ref:`float` = 1.0\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_mipmaps`\ (\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`compress`\ (\ mode\: :ref:`CompressMode`, source\: :ref:`CompressSource` = 0, astc_format\: :ref:`ASTCFormat` = 0\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`compress_from_channels`\ (\ mode\: :ref:`CompressMode`, channels\: :ref:`UsedChannels`, astc_format\: :ref:`ASTCFormat` = 0\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`compute_image_metrics`\ (\ compared_image\: :ref:`Image`, use_luma\: :ref:`bool`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`convert`\ (\ format\: :ref:`Format`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`copy_from`\ (\ src\: :ref:`Image`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`create`\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`\ ) |static| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`create_from_data`\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`, data\: :ref:`PackedByteArray`\ ) |static| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`crop`\ (\ width\: :ref:`int`, height\: :ref:`int`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`decompress`\ (\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AlphaMode` | :ref:`detect_alpha`\ (\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`UsedChannels` | :ref:`detect_used_channels`\ (\ source\: :ref:`CompressSource` = 0\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ color\: :ref:`Color`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill_rect`\ (\ rect\: :ref:`Rect2i`, color\: :ref:`Color`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fix_alpha_edges`\ (\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`flip_x`\ (\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`flip_y`\ (\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`generate_mipmaps`\ (\ renormalize\: :ref:`bool` = false\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`get_data`\ (\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Format` | :ref:`get_format`\ (\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_height`\ (\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_mipmap_count`\ (\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_mipmap_offset`\ (\ mipmap\: :ref:`int`\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_pixel`\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_pixelv`\ (\ point\: :ref:`Vector2i`\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`get_region`\ (\ region\: :ref:`Rect2i`\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_size`\ (\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`get_used_rect`\ (\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_width`\ (\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_mipmaps`\ (\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_compressed`\ (\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_invisible`\ (\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load`\ (\ path\: :ref:`String`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_bmp_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`load_from_file`\ (\ path\: :ref:`String`\ ) |static| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_jpg_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_ktx_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_png_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_svg_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`, scale\: :ref:`float` = 1.0\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_svg_from_string`\ (\ svg_str\: :ref:`String`, scale\: :ref:`float` = 1.0\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_tga_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_webp_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`normal_map_to_xy`\ (\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`premultiply_alpha`\ (\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`resize`\ (\ width\: :ref:`int`, height\: :ref:`int`, interpolation\: :ref:`Interpolation` = 1\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`resize_to_po2`\ (\ square\: :ref:`bool` = false, interpolation\: :ref:`Interpolation` = 1\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`rgbe_to_srgb`\ (\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rotate_90`\ (\ direction\: :ref:`ClockDirection`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rotate_180`\ (\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save_exr`\ (\ path\: :ref:`String`, grayscale\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`save_exr_to_buffer`\ (\ grayscale\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save_jpg`\ (\ path\: :ref:`String`, quality\: :ref:`float` = 0.75\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`save_jpg_to_buffer`\ (\ quality\: :ref:`float` = 0.75\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save_png`\ (\ path\: :ref:`String`\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`save_png_to_buffer`\ (\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save_webp`\ (\ path\: :ref:`String`, lossy\: :ref:`bool` = false, quality\: :ref:`float` = 0.75\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`save_webp_to_buffer`\ (\ lossy\: :ref:`bool` = false, quality\: :ref:`float` = 0.75\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_data`\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`, data\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_pixel`\ (\ x\: :ref:`int`, y\: :ref:`int`, color\: :ref:`Color`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_pixelv`\ (\ point\: :ref:`Vector2i`, color\: :ref:`Color`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shrink_x2`\ (\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`srgb_to_linear`\ (\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -870,7 +870,7 @@ Method Descriptions .. rst-class:: classref-method -void **adjust_bcs** **(** :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation **)** +|void| **adjust_bcs**\ (\ brightness\: :ref:`float`, contrast\: :ref:`float`, saturation\: :ref:`float`\ ) Adjusts this image's ``brightness``, ``contrast``, and ``saturation`` by the given values. Does not work if the image is compressed (see :ref:`is_compressed`). @@ -882,7 +882,7 @@ Adjusts this image's ``brightness``, ``contrast``, and ``saturation`` by the giv .. rst-class:: classref-method -void **blend_rect** **(** :ref:`Image` src, :ref:`Rect2i` src_rect, :ref:`Vector2i` dst **)** +|void| **blend_rect**\ (\ src\: :ref:`Image`, src_rect\: :ref:`Rect2i`, dst\: :ref:`Vector2i`\ ) Alpha-blends ``src_rect`` from ``src`` image to this image at coordinates ``dst``, clipped accordingly to both image bounds. This image and ``src`` image **must** have the same format. ``src_rect`` with non-positive size is treated as empty. @@ -894,7 +894,7 @@ Alpha-blends ``src_rect`` from ``src`` image to this image at coordinates ``dst` .. rst-class:: classref-method -void **blend_rect_mask** **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2i` src_rect, :ref:`Vector2i` dst **)** +|void| **blend_rect_mask**\ (\ src\: :ref:`Image`, mask\: :ref:`Image`, src_rect\: :ref:`Rect2i`, dst\: :ref:`Vector2i`\ ) Alpha-blends ``src_rect`` from ``src`` image to this image using ``mask`` image at coordinates ``dst``, clipped accordingly to both image bounds. Alpha channels are required for both ``src`` and ``mask``. ``dst`` pixels and ``src`` pixels will blend if the corresponding mask pixel's alpha value is not 0. This image and ``src`` image **must** have the same format. ``src`` image and ``mask`` image **must** have the same size (width and height) but they can have different formats. ``src_rect`` with non-positive size is treated as empty. @@ -906,7 +906,7 @@ Alpha-blends ``src_rect`` from ``src`` image to this image using ``mask`` image .. rst-class:: classref-method -void **blit_rect** **(** :ref:`Image` src, :ref:`Rect2i` src_rect, :ref:`Vector2i` dst **)** +|void| **blit_rect**\ (\ src\: :ref:`Image`, src_rect\: :ref:`Rect2i`, dst\: :ref:`Vector2i`\ ) Copies ``src_rect`` from ``src`` image to this image at coordinates ``dst``, clipped accordingly to both image bounds. This image and ``src`` image **must** have the same format. ``src_rect`` with non-positive size is treated as empty. @@ -918,7 +918,7 @@ Copies ``src_rect`` from ``src`` image to this image at coordinates ``dst``, cli .. rst-class:: classref-method -void **blit_rect_mask** **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2i` src_rect, :ref:`Vector2i` dst **)** +|void| **blit_rect_mask**\ (\ src\: :ref:`Image`, mask\: :ref:`Image`, src_rect\: :ref:`Rect2i`, dst\: :ref:`Vector2i`\ ) Blits ``src_rect`` area from ``src`` image to this image at the coordinates given by ``dst``, clipped accordingly to both image bounds. ``src`` pixel is copied onto ``dst`` if the corresponding ``mask`` pixel's alpha value is not 0. This image and ``src`` image **must** have the same format. ``src`` image and ``mask`` image **must** have the same size (width and height) but they can have different formats. ``src_rect`` with non-positive size is treated as empty. @@ -930,7 +930,7 @@ Blits ``src_rect`` area from ``src`` image to this image at the coordinates give .. rst-class:: classref-method -void **bump_map_to_normal_map** **(** :ref:`float` bump_scale=1.0 **)** +|void| **bump_map_to_normal_map**\ (\ bump_scale\: :ref:`float` = 1.0\ ) Converts a bump map to a normal map. A bump map provides a height offset per-pixel, while a normal map provides a normal direction per pixel. @@ -942,7 +942,7 @@ Converts a bump map to a normal map. A bump map provides a height offset per-pix .. rst-class:: classref-method -void **clear_mipmaps** **(** **)** +|void| **clear_mipmaps**\ (\ ) Removes the image's mipmaps. @@ -954,7 +954,7 @@ Removes the image's mipmaps. .. rst-class:: classref-method -:ref:`Error` **compress** **(** :ref:`CompressMode` mode, :ref:`CompressSource` source=0, :ref:`ASTCFormat` astc_format=0 **)** +:ref:`Error` **compress**\ (\ mode\: :ref:`CompressMode`, source\: :ref:`CompressSource` = 0, astc_format\: :ref:`ASTCFormat` = 0\ ) Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. @@ -970,7 +970,7 @@ For ASTC compression, the ``astc_format`` parameter must be supplied. .. rst-class:: classref-method -:ref:`Error` **compress_from_channels** **(** :ref:`CompressMode` mode, :ref:`UsedChannels` channels, :ref:`ASTCFormat` astc_format=0 **)** +:ref:`Error` **compress_from_channels**\ (\ mode\: :ref:`CompressMode`, channels\: :ref:`UsedChannels`, astc_format\: :ref:`ASTCFormat` = 0\ ) Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. @@ -986,7 +986,7 @@ For ASTC compression, the ``astc_format`` parameter must be supplied. .. rst-class:: classref-method -:ref:`Dictionary` **compute_image_metrics** **(** :ref:`Image` compared_image, :ref:`bool` use_luma **)** +:ref:`Dictionary` **compute_image_metrics**\ (\ compared_image\: :ref:`Image`, use_luma\: :ref:`bool`\ ) Compute image metrics on the current image and the compared image. @@ -1000,7 +1000,7 @@ The dictionary contains ``max``, ``mean``, ``mean_squared``, ``root_mean_squared .. rst-class:: classref-method -void **convert** **(** :ref:`Format` format **)** +|void| **convert**\ (\ format\: :ref:`Format`\ ) Converts the image's format. See :ref:`Format` constants. @@ -1012,7 +1012,7 @@ Converts the image's format. See :ref:`Format` constants. .. rst-class:: classref-method -void **copy_from** **(** :ref:`Image` src **)** +|void| **copy_from**\ (\ src\: :ref:`Image`\ ) Copies ``src`` image to this image. @@ -1024,7 +1024,7 @@ Copies ``src`` image to this image. .. rst-class:: classref-method -:ref:`Image` **create** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format **)** |static| +:ref:`Image` **create**\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`\ ) |static| Creates an empty image of given size and format. See :ref:`Format` constants. If ``use_mipmaps`` is ``true``, then generate mipmaps for this image. See the :ref:`generate_mipmaps`. @@ -1036,7 +1036,7 @@ Creates an empty image of given size and format. See :ref:`Format` **create_from_data** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format, :ref:`PackedByteArray` data **)** |static| +:ref:`Image` **create_from_data**\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`, data\: :ref:`PackedByteArray`\ ) |static| Creates a new image of given size and format. See :ref:`Format` constants. Fills the image with the given raw data. If ``use_mipmaps`` is ``true`` then loads mipmaps for this image from ``data``. See :ref:`generate_mipmaps`. @@ -1048,7 +1048,7 @@ Creates a new image of given size and format. See :ref:`Format` width, :ref:`int` height **)** +|void| **crop**\ (\ width\: :ref:`int`, height\: :ref:`int`\ ) Crops the image to the given ``width`` and ``height``. If the specified size is larger than the current size, the extra area is filled with black pixels. @@ -1060,7 +1060,7 @@ Crops the image to the given ``width`` and ``height``. If the specified size is .. rst-class:: classref-method -:ref:`Error` **decompress** **(** **)** +:ref:`Error` **decompress**\ (\ ) Decompresses the image if it is VRAM compressed in a supported format. Returns :ref:`@GlobalScope.OK` if the format is supported, otherwise :ref:`@GlobalScope.ERR_UNAVAILABLE`. @@ -1074,7 +1074,7 @@ Decompresses the image if it is VRAM compressed in a supported format. Returns : .. rst-class:: classref-method -:ref:`AlphaMode` **detect_alpha** **(** **)** |const| +:ref:`AlphaMode` **detect_alpha**\ (\ ) |const| Returns :ref:`ALPHA_BLEND` if the image has data for alpha values. Returns :ref:`ALPHA_BIT` if all the alpha values are stored in a single bit. Returns :ref:`ALPHA_NONE` if no data for alpha values is found. @@ -1086,7 +1086,7 @@ Returns :ref:`ALPHA_BLEND` if the image has da .. rst-class:: classref-method -:ref:`UsedChannels` **detect_used_channels** **(** :ref:`CompressSource` source=0 **)** |const| +:ref:`UsedChannels` **detect_used_channels**\ (\ source\: :ref:`CompressSource` = 0\ ) |const| Returns the color channels used by this image, as one of the :ref:`UsedChannels` constants. If the image is compressed, the original ``source`` must be specified. @@ -1098,7 +1098,7 @@ Returns the color channels used by this image, as one of the :ref:`UsedChannels< .. rst-class:: classref-method -void **fill** **(** :ref:`Color` color **)** +|void| **fill**\ (\ color\: :ref:`Color`\ ) Fills the image with ``color``. @@ -1110,7 +1110,7 @@ Fills the image with ``color``. .. rst-class:: classref-method -void **fill_rect** **(** :ref:`Rect2i` rect, :ref:`Color` color **)** +|void| **fill_rect**\ (\ rect\: :ref:`Rect2i`, color\: :ref:`Color`\ ) Fills ``rect`` with ``color``. @@ -1122,7 +1122,7 @@ Fills ``rect`` with ``color``. .. rst-class:: classref-method -void **fix_alpha_edges** **(** **)** +|void| **fix_alpha_edges**\ (\ ) Blends low-alpha pixels with nearby pixels. @@ -1134,7 +1134,7 @@ Blends low-alpha pixels with nearby pixels. .. rst-class:: classref-method -void **flip_x** **(** **)** +|void| **flip_x**\ (\ ) Flips the image horizontally. @@ -1146,7 +1146,7 @@ Flips the image horizontally. .. rst-class:: classref-method -void **flip_y** **(** **)** +|void| **flip_y**\ (\ ) Flips the image vertically. @@ -1158,7 +1158,7 @@ Flips the image vertically. .. rst-class:: classref-method -:ref:`Error` **generate_mipmaps** **(** :ref:`bool` renormalize=false **)** +:ref:`Error` **generate_mipmaps**\ (\ renormalize\: :ref:`bool` = false\ ) Generates mipmaps for the image. Mipmaps are precalculated lower-resolution copies of the image that are automatically used if the image needs to be scaled down when rendered. They help improve image quality and performance when rendering. This method returns an error if the image is compressed, in a custom format, or if the image's width/height is ``0``. Enabling ``renormalize`` when generating mipmaps for normal map textures will make sure all resulting vector values are normalized. @@ -1172,7 +1172,7 @@ It is possible to check if the image has mipmaps by calling :ref:`has_mipmaps` **get_data** **(** **)** |const| +:ref:`PackedByteArray` **get_data**\ (\ ) |const| Returns a copy of the image's raw data. @@ -1184,7 +1184,7 @@ Returns a copy of the image's raw data. .. rst-class:: classref-method -:ref:`Format` **get_format** **(** **)** |const| +:ref:`Format` **get_format**\ (\ ) |const| Returns the image's format. See :ref:`Format` constants. @@ -1196,7 +1196,7 @@ Returns the image's format. See :ref:`Format` constants. .. rst-class:: classref-method -:ref:`int` **get_height** **(** **)** |const| +:ref:`int` **get_height**\ (\ ) |const| Returns the image's height. @@ -1208,7 +1208,7 @@ Returns the image's height. .. rst-class:: classref-method -:ref:`int` **get_mipmap_count** **(** **)** |const| +:ref:`int` **get_mipmap_count**\ (\ ) |const| Returns the number of mipmap levels or 0 if the image has no mipmaps. The largest main level image is not counted as a mipmap level by this method, so if you want to include it you can add 1 to this count. @@ -1220,7 +1220,7 @@ Returns the number of mipmap levels or 0 if the image has no mipmaps. The larges .. rst-class:: classref-method -:ref:`int` **get_mipmap_offset** **(** :ref:`int` mipmap **)** |const| +:ref:`int` **get_mipmap_offset**\ (\ mipmap\: :ref:`int`\ ) |const| Returns the offset where the image's mipmap with index ``mipmap`` is stored in the :ref:`data` dictionary. @@ -1232,7 +1232,7 @@ Returns the offset where the image's mipmap with index ``mipmap`` is stored in t .. rst-class:: classref-method -:ref:`Color` **get_pixel** **(** :ref:`int` x, :ref:`int` y **)** |const| +:ref:`Color` **get_pixel**\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) |const| Returns the color of the pixel at ``(x, y)``. @@ -1246,7 +1246,7 @@ This is the same as :ref:`get_pixelv`, but with t .. rst-class:: classref-method -:ref:`Color` **get_pixelv** **(** :ref:`Vector2i` point **)** |const| +:ref:`Color` **get_pixelv**\ (\ point\: :ref:`Vector2i`\ ) |const| Returns the color of the pixel at ``point``. @@ -1260,7 +1260,7 @@ This is the same as :ref:`get_pixel`, but with a : .. rst-class:: classref-method -:ref:`Image` **get_region** **(** :ref:`Rect2i` region **)** |const| +:ref:`Image` **get_region**\ (\ region\: :ref:`Rect2i`\ ) |const| Returns a new **Image** that is a copy of this **Image**'s area specified with ``region``. @@ -1272,7 +1272,7 @@ Returns a new **Image** that is a copy of this **Image**'s area specified with ` .. rst-class:: classref-method -:ref:`Vector2i` **get_size** **(** **)** |const| +:ref:`Vector2i` **get_size**\ (\ ) |const| Returns the image's size (width and height). @@ -1284,7 +1284,7 @@ Returns the image's size (width and height). .. rst-class:: classref-method -:ref:`Rect2i` **get_used_rect** **(** **)** |const| +:ref:`Rect2i` **get_used_rect**\ (\ ) |const| Returns a :ref:`Rect2i` enclosing the visible portion of the image, considering each pixel with a non-zero alpha channel as visible. @@ -1296,7 +1296,7 @@ Returns a :ref:`Rect2i` enclosing the visible portion of the image .. rst-class:: classref-method -:ref:`int` **get_width** **(** **)** |const| +:ref:`int` **get_width**\ (\ ) |const| Returns the image's width. @@ -1308,7 +1308,7 @@ Returns the image's width. .. rst-class:: classref-method -:ref:`bool` **has_mipmaps** **(** **)** |const| +:ref:`bool` **has_mipmaps**\ (\ ) |const| Returns ``true`` if the image has generated mipmaps. @@ -1320,7 +1320,7 @@ Returns ``true`` if the image has generated mipmaps. .. rst-class:: classref-method -:ref:`bool` **is_compressed** **(** **)** |const| +:ref:`bool` **is_compressed**\ (\ ) |const| Returns ``true`` if the image is compressed. @@ -1332,7 +1332,7 @@ Returns ``true`` if the image is compressed. .. rst-class:: classref-method -:ref:`bool` **is_empty** **(** **)** |const| +:ref:`bool` **is_empty**\ (\ ) |const| Returns ``true`` if the image has no data. @@ -1344,7 +1344,7 @@ Returns ``true`` if the image has no data. .. rst-class:: classref-method -:ref:`bool` **is_invisible** **(** **)** |const| +:ref:`bool` **is_invisible**\ (\ ) |const| Returns ``true`` if all the image's pixels have an alpha value of 0. Returns ``false`` if any pixel has an alpha value higher than 0. @@ -1356,7 +1356,7 @@ Returns ``true`` if all the image's pixels have an alpha value of 0. Returns ``f .. rst-class:: classref-method -:ref:`Error` **load** **(** :ref:`String` path **)** +:ref:`Error` **load**\ (\ path\: :ref:`String`\ ) Loads an image from file ``path``. See `Supported image formats <../tutorials/assets_pipeline/importing_images.html#supported-image-formats>`__ for a list of supported image formats and limitations. @@ -1372,7 +1372,7 @@ See also :ref:`ImageTexture` description for usage examples. .. rst-class:: classref-method -:ref:`Error` **load_bmp_from_buffer** **(** :ref:`PackedByteArray` buffer **)** +:ref:`Error` **load_bmp_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) Loads an image from the binary contents of a BMP file. @@ -1388,7 +1388,7 @@ Loads an image from the binary contents of a BMP file. .. rst-class:: classref-method -:ref:`Image` **load_from_file** **(** :ref:`String` path **)** |static| +:ref:`Image` **load_from_file**\ (\ path\: :ref:`String`\ ) |static| Creates a new **Image** and loads data from the specified file. @@ -1400,7 +1400,7 @@ Creates a new **Image** and loads data from the specified file. .. rst-class:: classref-method -:ref:`Error` **load_jpg_from_buffer** **(** :ref:`PackedByteArray` buffer **)** +:ref:`Error` **load_jpg_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) Loads an image from the binary contents of a JPEG file. @@ -1412,7 +1412,7 @@ Loads an image from the binary contents of a JPEG file. .. rst-class:: classref-method -:ref:`Error` **load_ktx_from_buffer** **(** :ref:`PackedByteArray` buffer **)** +:ref:`Error` **load_ktx_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) Loads an image from the binary contents of a `KTX `__ file. Unlike most image formats, KTX can store VRAM-compressed data and embed mipmaps. @@ -1428,7 +1428,7 @@ Loads an image from the binary contents of a `KTX ` **load_png_from_buffer** **(** :ref:`PackedByteArray` buffer **)** +:ref:`Error` **load_png_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) Loads an image from the binary contents of a PNG file. @@ -1440,7 +1440,7 @@ Loads an image from the binary contents of a PNG file. .. rst-class:: classref-method -:ref:`Error` **load_svg_from_buffer** **(** :ref:`PackedByteArray` buffer, :ref:`float` scale=1.0 **)** +:ref:`Error` **load_svg_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`, scale\: :ref:`float` = 1.0\ ) Loads an image from the UTF-8 binary contents of an **uncompressed** SVG file (**.svg**). @@ -1456,7 +1456,7 @@ Loads an image from the UTF-8 binary contents of an **uncompressed** SVG file (* .. rst-class:: classref-method -:ref:`Error` **load_svg_from_string** **(** :ref:`String` svg_str, :ref:`float` scale=1.0 **)** +:ref:`Error` **load_svg_from_string**\ (\ svg_str\: :ref:`String`, scale\: :ref:`float` = 1.0\ ) Loads an image from the string contents of a SVG file (**.svg**). @@ -1470,7 +1470,7 @@ Loads an image from the string contents of a SVG file (**.svg**). .. rst-class:: classref-method -:ref:`Error` **load_tga_from_buffer** **(** :ref:`PackedByteArray` buffer **)** +:ref:`Error` **load_tga_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) Loads an image from the binary contents of a TGA file. @@ -1484,7 +1484,7 @@ Loads an image from the binary contents of a TGA file. .. rst-class:: classref-method -:ref:`Error` **load_webp_from_buffer** **(** :ref:`PackedByteArray` buffer **)** +:ref:`Error` **load_webp_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) Loads an image from the binary contents of a WebP file. @@ -1496,7 +1496,7 @@ Loads an image from the binary contents of a WebP file. .. rst-class:: classref-method -void **normal_map_to_xy** **(** **)** +|void| **normal_map_to_xy**\ (\ ) Converts the image's data to represent coordinates on a 3D plane. This is used when the image represents a normal map. A normal map can add lots of detail to a 3D surface without increasing the polygon count. @@ -1508,7 +1508,7 @@ Converts the image's data to represent coordinates on a 3D plane. This is used w .. rst-class:: classref-method -void **premultiply_alpha** **(** **)** +|void| **premultiply_alpha**\ (\ ) Multiplies color values with alpha values. Resulting color values for a pixel are ``(color * alpha)/256``. See also :ref:`CanvasItemMaterial.blend_mode`. @@ -1520,7 +1520,7 @@ Multiplies color values with alpha values. Resulting color values for a pixel ar .. rst-class:: classref-method -void **resize** **(** :ref:`int` width, :ref:`int` height, :ref:`Interpolation` interpolation=1 **)** +|void| **resize**\ (\ width\: :ref:`int`, height\: :ref:`int`, interpolation\: :ref:`Interpolation` = 1\ ) Resizes the image to the given ``width`` and ``height``. New pixels are calculated using the ``interpolation`` mode defined via :ref:`Interpolation` constants. @@ -1532,7 +1532,7 @@ Resizes the image to the given ``width`` and ``height``. New pixels are calculat .. rst-class:: classref-method -void **resize_to_po2** **(** :ref:`bool` square=false, :ref:`Interpolation` interpolation=1 **)** +|void| **resize_to_po2**\ (\ square\: :ref:`bool` = false, interpolation\: :ref:`Interpolation` = 1\ ) Resizes the image to the nearest power of 2 for the width and height. If ``square`` is ``true`` then set width and height to be the same. New pixels are calculated using the ``interpolation`` mode defined via :ref:`Interpolation` constants. @@ -1544,7 +1544,7 @@ Resizes the image to the nearest power of 2 for the width and height. If ``squar .. rst-class:: classref-method -:ref:`Image` **rgbe_to_srgb** **(** **)** +:ref:`Image` **rgbe_to_srgb**\ (\ ) Converts a standard RGBE (Red Green Blue Exponent) image to an sRGB image. @@ -1556,7 +1556,7 @@ Converts a standard RGBE (Red Green Blue Exponent) image to an sRGB image. .. rst-class:: classref-method -void **rotate_90** **(** :ref:`ClockDirection` direction **)** +|void| **rotate_90**\ (\ direction\: :ref:`ClockDirection`\ ) Rotates the image in the specified ``direction`` by ``90`` degrees. The width and height of the image must be greater than ``1``. If the width and height are not equal, the image will be resized. @@ -1568,7 +1568,7 @@ Rotates the image in the specified ``direction`` by ``90`` degrees. The width an .. rst-class:: classref-method -void **rotate_180** **(** **)** +|void| **rotate_180**\ (\ ) Rotates the image by ``180`` degrees. The width and height of the image must be greater than ``1``. @@ -1580,7 +1580,7 @@ Rotates the image by ``180`` degrees. The width and height of the image must be .. rst-class:: classref-method -:ref:`Error` **save_exr** **(** :ref:`String` path, :ref:`bool` grayscale=false **)** |const| +:ref:`Error` **save_exr**\ (\ path\: :ref:`String`, grayscale\: :ref:`bool` = false\ ) |const| Saves the image as an EXR file to ``path``. If ``grayscale`` is ``true`` and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return :ref:`@GlobalScope.ERR_UNAVAILABLE` if Godot was compiled without the TinyEXR module. @@ -1594,7 +1594,7 @@ Saves the image as an EXR file to ``path``. If ``grayscale`` is ``true`` and the .. rst-class:: classref-method -:ref:`PackedByteArray` **save_exr_to_buffer** **(** :ref:`bool` grayscale=false **)** |const| +:ref:`PackedByteArray` **save_exr_to_buffer**\ (\ grayscale\: :ref:`bool` = false\ ) |const| Saves the image as an EXR file to a byte array. If ``grayscale`` is ``true`` and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return an empty byte array if Godot was compiled without the TinyEXR module. @@ -1608,7 +1608,7 @@ Saves the image as an EXR file to a byte array. If ``grayscale`` is ``true`` and .. rst-class:: classref-method -:ref:`Error` **save_jpg** **(** :ref:`String` path, :ref:`float` quality=0.75 **)** |const| +:ref:`Error` **save_jpg**\ (\ path\: :ref:`String`, quality\: :ref:`float` = 0.75\ ) |const| Saves the image as a JPEG file to ``path`` with the specified ``quality`` between ``0.01`` and ``1.0`` (inclusive). Higher ``quality`` values result in better-looking output at the cost of larger file sizes. Recommended ``quality`` values are between ``0.75`` and ``0.90``. Even at quality ``1.00``, JPEG compression remains lossy. @@ -1622,7 +1622,7 @@ Saves the image as a JPEG file to ``path`` with the specified ``quality`` betwee .. rst-class:: classref-method -:ref:`PackedByteArray` **save_jpg_to_buffer** **(** :ref:`float` quality=0.75 **)** |const| +:ref:`PackedByteArray` **save_jpg_to_buffer**\ (\ quality\: :ref:`float` = 0.75\ ) |const| Saves the image as a JPEG file to a byte array with the specified ``quality`` between ``0.01`` and ``1.0`` (inclusive). Higher ``quality`` values result in better-looking output at the cost of larger byte array sizes (and therefore memory usage). Recommended ``quality`` values are between ``0.75`` and ``0.90``. Even at quality ``1.00``, JPEG compression remains lossy. @@ -1636,7 +1636,7 @@ Saves the image as a JPEG file to a byte array with the specified ``quality`` be .. rst-class:: classref-method -:ref:`Error` **save_png** **(** :ref:`String` path **)** |const| +:ref:`Error` **save_png**\ (\ path\: :ref:`String`\ ) |const| Saves the image as a PNG file to the file at ``path``. @@ -1648,7 +1648,7 @@ Saves the image as a PNG file to the file at ``path``. .. rst-class:: classref-method -:ref:`PackedByteArray` **save_png_to_buffer** **(** **)** |const| +:ref:`PackedByteArray` **save_png_to_buffer**\ (\ ) |const| Saves the image as a PNG file to a byte array. @@ -1660,7 +1660,7 @@ Saves the image as a PNG file to a byte array. .. rst-class:: classref-method -:ref:`Error` **save_webp** **(** :ref:`String` path, :ref:`bool` lossy=false, :ref:`float` quality=0.75 **)** |const| +:ref:`Error` **save_webp**\ (\ path\: :ref:`String`, lossy\: :ref:`bool` = false, quality\: :ref:`float` = 0.75\ ) |const| Saves the image as a WebP (Web Picture) file to the file at ``path``. By default it will save lossless. If ``lossy`` is true, the image will be saved lossy, using the ``quality`` setting between 0.0 and 1.0 (inclusive). Lossless WebP offers more efficient compression than PNG. @@ -1674,7 +1674,7 @@ Saves the image as a WebP (Web Picture) file to the file at ``path``. By default .. rst-class:: classref-method -:ref:`PackedByteArray` **save_webp_to_buffer** **(** :ref:`bool` lossy=false, :ref:`float` quality=0.75 **)** |const| +:ref:`PackedByteArray` **save_webp_to_buffer**\ (\ lossy\: :ref:`bool` = false, quality\: :ref:`float` = 0.75\ ) |const| Saves the image as a WebP (Web Picture) file to a byte array. By default it will save lossless. If ``lossy`` is true, the image will be saved lossy, using the ``quality`` setting between 0.0 and 1.0 (inclusive). Lossless WebP offers more efficient compression than PNG. @@ -1688,7 +1688,7 @@ Saves the image as a WebP (Web Picture) file to a byte array. By default it will .. rst-class:: classref-method -void **set_data** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format, :ref:`PackedByteArray` data **)** +|void| **set_data**\ (\ width\: :ref:`int`, height\: :ref:`int`, use_mipmaps\: :ref:`bool`, format\: :ref:`Format`, data\: :ref:`PackedByteArray`\ ) Overwrites data of an existing **Image**. Non-static equivalent of :ref:`create_from_data`. @@ -1700,7 +1700,7 @@ Overwrites data of an existing **Image**. Non-static equivalent of :ref:`create_ .. rst-class:: classref-method -void **set_pixel** **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** +|void| **set_pixel**\ (\ x\: :ref:`int`, y\: :ref:`int`, color\: :ref:`Color`\ ) Sets the :ref:`Color` of the pixel at ``(x, y)`` to ``color``. @@ -1737,7 +1737,7 @@ This is the same as :ref:`set_pixelv`, but with a .. rst-class:: classref-method -void **set_pixelv** **(** :ref:`Vector2i` point, :ref:`Color` color **)** +|void| **set_pixelv**\ (\ point\: :ref:`Vector2i`, color\: :ref:`Color`\ ) Sets the :ref:`Color` of the pixel at ``point`` to ``color``. @@ -1774,7 +1774,7 @@ This is the same as :ref:`set_pixel`, but with a : .. rst-class:: classref-method -void **shrink_x2** **(** **)** +|void| **shrink_x2**\ (\ ) Shrinks the image by a factor of 2 on each axis (this divides the pixel count by 4). @@ -1786,7 +1786,7 @@ Shrinks the image by a factor of 2 on each axis (this divides the pixel count by .. rst-class:: classref-method -void **srgb_to_linear** **(** **)** +|void| **srgb_to_linear**\ (\ ) Converts the raw data from the sRGB colorspace to a linear scale. @@ -1797,3 +1797,4 @@ Converts the raw data from the sRGB colorspace to a linear scale. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_imageformatloader.rst b/classes/class_imageformatloader.rst index adef52d804a..856ec54a435 100644 --- a/classes/class_imageformatloader.rst +++ b/classes/class_imageformatloader.rst @@ -81,3 +81,4 @@ flags **LoaderFlags**: .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_imageformatloaderextension.rst b/classes/class_imageformatloaderextension.rst index 60143b90efb..2c7fcd0ab42 100644 --- a/classes/class_imageformatloaderextension.rst +++ b/classes/class_imageformatloaderextension.rst @@ -31,15 +31,15 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_recognized_extensions` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_load_image` **(** :ref:`Image` image, :ref:`FileAccess` fileaccess, |bitfield|\<:ref:`LoaderFlags`\> flags, :ref:`float` scale **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_format_loader` **(** **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_format_loader` **(** **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_recognized_extensions`\ (\ ) |virtual| |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_load_image`\ (\ image\: :ref:`Image`, fileaccess\: :ref:`FileAccess`, flags\: |bitfield|\[:ref:`LoaderFlags`\], scale\: :ref:`float`\ ) |virtual| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_format_loader`\ (\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_format_loader`\ (\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -54,7 +54,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_recognized_extensions** **(** **)** |virtual| |const| +:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ ) |virtual| |const| Returns the list of file extensions for this image format. Files with the given extensions will be treated as image file and loaded using this class. @@ -66,7 +66,7 @@ Returns the list of file extensions for this image format. Files with the given .. rst-class:: classref-method -:ref:`Error` **_load_image** **(** :ref:`Image` image, :ref:`FileAccess` fileaccess, |bitfield|\<:ref:`LoaderFlags`\> flags, :ref:`float` scale **)** |virtual| +:ref:`Error` **_load_image**\ (\ image\: :ref:`Image`, fileaccess\: :ref:`FileAccess`, flags\: |bitfield|\[:ref:`LoaderFlags`\], scale\: :ref:`float`\ ) |virtual| Loads the content of ``fileaccess`` into the provided ``image``. @@ -78,7 +78,7 @@ Loads the content of ``fileaccess`` into the provided ``image``. .. rst-class:: classref-method -void **add_format_loader** **(** **)** +|void| **add_format_loader**\ (\ ) Add this format loader to the engine, allowing it to recognize the file extensions returned by :ref:`_get_recognized_extensions`. @@ -90,7 +90,7 @@ Add this format loader to the engine, allowing it to recognize the file extensio .. rst-class:: classref-method -void **remove_format_loader** **(** **)** +|void| **remove_format_loader**\ (\ ) Remove this format loader from the engine. @@ -101,3 +101,4 @@ Remove this format loader from the engine. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index ba21eb26aaa..9dd4a3bbbb5 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -76,17 +76,17 @@ Methods .. table:: :widths: auto - +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ImageTexture` | :ref:`create_from_image` **(** :ref:`Image` image **)** |static| | - +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Format` | :ref:`get_format` **(** **)** |const| | - +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_image` **(** :ref:`Image` image **)** | - +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_size_override` **(** :ref:`Vector2i` size **)** | - +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`update` **(** :ref:`Image` image **)** | - +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ImageTexture` | :ref:`create_from_image`\ (\ image\: :ref:`Image`\ ) |static| | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Format` | :ref:`get_format`\ (\ ) |const| | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_image`\ (\ image\: :ref:`Image`\ ) | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_size_override`\ (\ size\: :ref:`Vector2i`\ ) | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update`\ (\ image\: :ref:`Image`\ ) | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -101,7 +101,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`ImageTexture` **create_from_image** **(** :ref:`Image` image **)** |static| +:ref:`ImageTexture` **create_from_image**\ (\ image\: :ref:`Image`\ ) |static| Creates a new **ImageTexture** and initializes it by allocating and setting the data from an :ref:`Image`. @@ -113,7 +113,7 @@ Creates a new **ImageTexture** and initializes it by allocating and setting the .. rst-class:: classref-method -:ref:`Format` **get_format** **(** **)** |const| +:ref:`Format` **get_format**\ (\ ) |const| Returns the format of the texture, one of :ref:`Format`. @@ -125,7 +125,7 @@ Returns the format of the texture, one of :ref:`Format`. .. rst-class:: classref-method -void **set_image** **(** :ref:`Image` image **)** +|void| **set_image**\ (\ image\: :ref:`Image`\ ) Replaces the texture's data with a new :ref:`Image`. This will re-allocate new memory for the texture. @@ -139,7 +139,7 @@ If you want to update the image, but don't need to change its parameters (format .. rst-class:: classref-method -void **set_size_override** **(** :ref:`Vector2i` size **)** +|void| **set_size_override**\ (\ size\: :ref:`Vector2i`\ ) Resizes the texture to the specified dimensions. @@ -151,7 +151,7 @@ Resizes the texture to the specified dimensions. .. rst-class:: classref-method -void **update** **(** :ref:`Image` image **)** +|void| **update**\ (\ image\: :ref:`Image`\ ) Replaces the texture's data with a new :ref:`Image`. @@ -166,3 +166,4 @@ Use this method over :ref:`set_image` if yo .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_imagetexture3d.rst b/classes/class_imagetexture3d.rst index 9a7f9873c05..1c9521c3dcd 100644 --- a/classes/class_imagetexture3d.rst +++ b/classes/class_imagetexture3d.rst @@ -31,11 +31,11 @@ Methods .. table:: :widths: auto - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`create` **(** :ref:`Format` format, :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`bool` use_mipmaps, :ref:`Image[]` data **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`update` **(** :ref:`Image[]` data **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`create`\ (\ format\: :ref:`Format`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, use_mipmaps\: :ref:`bool`, data\: :ref:`Array`\[:ref:`Image`\]\ ) | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update`\ (\ data\: :ref:`Array`\[:ref:`Image`\]\ ) | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -50,7 +50,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **create** **(** :ref:`Format` format, :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`bool` use_mipmaps, :ref:`Image[]` data **)** +:ref:`Error` **create**\ (\ format\: :ref:`Format`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, use_mipmaps\: :ref:`bool`, data\: :ref:`Array`\[:ref:`Image`\]\ ) Creates the **ImageTexture3D** with specified ``width``, ``height``, and ``depth``. See :ref:`Format` for ``format`` options. If ``use_mipmaps`` is ``true``, then generate mipmaps for the **ImageTexture3D**. @@ -62,7 +62,7 @@ Creates the **ImageTexture3D** with specified ``width``, ``height``, and ``depth .. rst-class:: classref-method -void **update** **(** :ref:`Image[]` data **)** +|void| **update**\ (\ data\: :ref:`Array`\[:ref:`Image`\]\ ) Replaces the texture's existing data with the layers specified in ``data``. The size of ``data`` must match the parameters that were used for :ref:`create`. In other words, the texture cannot be resized or have its format changed by calling :ref:`update`. @@ -73,3 +73,4 @@ Replaces the texture's existing data with the layers specified in ``data``. The .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_imagetexturelayered.rst b/classes/class_imagetexturelayered.rst index e20ce6bd39c..7c186000e21 100644 --- a/classes/class_imagetexturelayered.rst +++ b/classes/class_imagetexturelayered.rst @@ -31,11 +31,11 @@ Methods .. table:: :widths: auto - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`create_from_images` **(** :ref:`Image[]` images **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`update_layer` **(** :ref:`Image` image, :ref:`int` layer **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`create_from_images`\ (\ images\: :ref:`Array`\[:ref:`Image`\]\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update_layer`\ (\ image\: :ref:`Image`, layer\: :ref:`int`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -50,7 +50,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **create_from_images** **(** :ref:`Image[]` images **)** +:ref:`Error` **create_from_images**\ (\ images\: :ref:`Array`\[:ref:`Image`\]\ ) Creates an **ImageTextureLayered** from an array of :ref:`Image`\ s. See :ref:`Image.create` for the expected data format. The first image decides the width, height, image format and mipmapping setting. The other images *must* have the same width, height, image format and mipmapping setting. @@ -64,7 +64,7 @@ Each :ref:`Image` represents one ``layer``. .. rst-class:: classref-method -void **update_layer** **(** :ref:`Image` image, :ref:`int` layer **)** +|void| **update_layer**\ (\ image\: :ref:`Image`, layer\: :ref:`int`\ ) Replaces the existing :ref:`Image` data at the given ``layer`` with this new image. @@ -81,3 +81,4 @@ The update is immediate: it's synchronized with drawing. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_immediatemesh.rst b/classes/class_immediatemesh.rst index 545b2f79765..2b27437601c 100644 --- a/classes/class_immediatemesh.rst +++ b/classes/class_immediatemesh.rst @@ -63,27 +63,27 @@ Methods .. table:: :widths: auto - +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_surfaces` **(** **)** | - +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`surface_add_vertex` **(** :ref:`Vector3` vertex **)** | - +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`surface_add_vertex_2d` **(** :ref:`Vector2` vertex **)** | - +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`surface_begin` **(** :ref:`PrimitiveType` primitive, :ref:`Material` material=null **)** | - +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`surface_end` **(** **)** | - +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`surface_set_color` **(** :ref:`Color` color **)** | - +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`surface_set_normal` **(** :ref:`Vector3` normal **)** | - +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`surface_set_tangent` **(** :ref:`Plane` tangent **)** | - +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`surface_set_uv` **(** :ref:`Vector2` uv **)** | - +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`surface_set_uv2` **(** :ref:`Vector2` uv2 **)** | - +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_surfaces`\ (\ ) | + +--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`surface_add_vertex`\ (\ vertex\: :ref:`Vector3`\ ) | + +--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`surface_add_vertex_2d`\ (\ vertex\: :ref:`Vector2`\ ) | + +--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`surface_begin`\ (\ primitive\: :ref:`PrimitiveType`, material\: :ref:`Material` = null\ ) | + +--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`surface_end`\ (\ ) | + +--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`surface_set_color`\ (\ color\: :ref:`Color`\ ) | + +--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`surface_set_normal`\ (\ normal\: :ref:`Vector3`\ ) | + +--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`surface_set_tangent`\ (\ tangent\: :ref:`Plane`\ ) | + +--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`surface_set_uv`\ (\ uv\: :ref:`Vector2`\ ) | + +--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`surface_set_uv2`\ (\ uv2\: :ref:`Vector2`\ ) | + +--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -98,7 +98,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear_surfaces** **(** **)** +|void| **clear_surfaces**\ (\ ) Clear all surfaces. @@ -110,7 +110,7 @@ Clear all surfaces. .. rst-class:: classref-method -void **surface_add_vertex** **(** :ref:`Vector3` vertex **)** +|void| **surface_add_vertex**\ (\ vertex\: :ref:`Vector3`\ ) Add a 3D vertex using the current attributes previously set. @@ -122,7 +122,7 @@ Add a 3D vertex using the current attributes previously set. .. rst-class:: classref-method -void **surface_add_vertex_2d** **(** :ref:`Vector2` vertex **)** +|void| **surface_add_vertex_2d**\ (\ vertex\: :ref:`Vector2`\ ) Add a 2D vertex using the current attributes previously set. @@ -134,7 +134,7 @@ Add a 2D vertex using the current attributes previously set. .. rst-class:: classref-method -void **surface_begin** **(** :ref:`PrimitiveType` primitive, :ref:`Material` material=null **)** +|void| **surface_begin**\ (\ primitive\: :ref:`PrimitiveType`, material\: :ref:`Material` = null\ ) Begin a new surface. @@ -146,7 +146,7 @@ Begin a new surface. .. rst-class:: classref-method -void **surface_end** **(** **)** +|void| **surface_end**\ (\ ) End and commit current surface. Note that surface being created will not be visible until this function is called. @@ -158,7 +158,7 @@ End and commit current surface. Note that surface being created will not be visi .. rst-class:: classref-method -void **surface_set_color** **(** :ref:`Color` color **)** +|void| **surface_set_color**\ (\ color\: :ref:`Color`\ ) Set the color attribute that will be pushed with the next vertex. @@ -170,7 +170,7 @@ Set the color attribute that will be pushed with the next vertex. .. rst-class:: classref-method -void **surface_set_normal** **(** :ref:`Vector3` normal **)** +|void| **surface_set_normal**\ (\ normal\: :ref:`Vector3`\ ) Set the normal attribute that will be pushed with the next vertex. @@ -182,7 +182,7 @@ Set the normal attribute that will be pushed with the next vertex. .. rst-class:: classref-method -void **surface_set_tangent** **(** :ref:`Plane` tangent **)** +|void| **surface_set_tangent**\ (\ tangent\: :ref:`Plane`\ ) Set the tangent attribute that will be pushed with the next vertex. @@ -194,7 +194,7 @@ Set the tangent attribute that will be pushed with the next vertex. .. rst-class:: classref-method -void **surface_set_uv** **(** :ref:`Vector2` uv **)** +|void| **surface_set_uv**\ (\ uv\: :ref:`Vector2`\ ) Set the UV attribute that will be pushed with the next vertex. @@ -206,7 +206,7 @@ Set the UV attribute that will be pushed with the next vertex. .. rst-class:: classref-method -void **surface_set_uv2** **(** :ref:`Vector2` uv2 **)** +|void| **surface_set_uv2**\ (\ uv2\: :ref:`Vector2`\ ) Set the UV2 attribute that will be pushed with the next vertex. @@ -217,3 +217,4 @@ Set the UV2 attribute that will be pushed with the next vertex. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_importermesh.rst b/classes/class_importermesh.rst index 712bbeede5a..71d118d8518 100644 --- a/classes/class_importermesh.rst +++ b/classes/class_importermesh.rst @@ -43,53 +43,53 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_surface` **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array[]` blend_shapes=[], :ref:`Dictionary` lods={}, :ref:`Material` material=null, :ref:`String` name="", :ref:`int` flags=0 **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`generate_lods` **(** :ref:`float` normal_merge_angle, :ref:`float` normal_split_angle, :ref:`Array` bone_transform_array **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_blend_shape_count` **(** **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`BlendShapeMode` | :ref:`get_blend_shape_mode` **(** **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` blend_shape_idx **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_lightmap_size_hint` **(** **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ArrayMesh` | :ref:`get_mesh` **(** :ref:`ArrayMesh` base_mesh=null **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_surface_arrays` **(** :ref:`int` surface_idx **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_surface_blend_shape_arrays` **(** :ref:`int` surface_idx, :ref:`int` blend_shape_idx **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_surface_count` **(** **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_surface_format` **(** :ref:`int` surface_idx **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_surface_lod_count` **(** :ref:`int` surface_idx **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_surface_lod_indices` **(** :ref:`int` surface_idx, :ref:`int` lod_idx **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_surface_lod_size` **(** :ref:`int` surface_idx, :ref:`int` lod_idx **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Material` | :ref:`get_surface_material` **(** :ref:`int` surface_idx **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_surface_name` **(** :ref:`int` surface_idx **)** |const| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PrimitiveType` | :ref:`get_surface_primitive_type` **(** :ref:`int` surface_idx **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_blend_shape_mode` **(** :ref:`BlendShapeMode` mode **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_lightmap_size_hint` **(** :ref:`Vector2i` size **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_surface_material` **(** :ref:`int` surface_idx, :ref:`Material` material **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_surface_name` **(** :ref:`int` surface_idx, :ref:`String` name **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_blend_shape`\ (\ name\: :ref:`String`\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_surface`\ (\ primitive\: :ref:`PrimitiveType`, arrays\: :ref:`Array`, blend_shapes\: :ref:`Array`\[:ref:`Array`\] = [], lods\: :ref:`Dictionary` = {}, material\: :ref:`Material` = null, name\: :ref:`String` = "", flags\: :ref:`int` = 0\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`generate_lods`\ (\ normal_merge_angle\: :ref:`float`, normal_split_angle\: :ref:`float`, bone_transform_array\: :ref:`Array`\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_blend_shape_count`\ (\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`BlendShapeMode` | :ref:`get_blend_shape_mode`\ (\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_blend_shape_name`\ (\ blend_shape_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_lightmap_size_hint`\ (\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ArrayMesh` | :ref:`get_mesh`\ (\ base_mesh\: :ref:`ArrayMesh` = null\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_surface_arrays`\ (\ surface_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_surface_blend_shape_arrays`\ (\ surface_idx\: :ref:`int`, blend_shape_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_surface_count`\ (\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_surface_format`\ (\ surface_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_surface_lod_count`\ (\ surface_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_surface_lod_indices`\ (\ surface_idx\: :ref:`int`, lod_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_surface_lod_size`\ (\ surface_idx\: :ref:`int`, lod_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Material` | :ref:`get_surface_material`\ (\ surface_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_surface_name`\ (\ surface_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PrimitiveType` | :ref:`get_surface_primitive_type`\ (\ surface_idx\: :ref:`int`\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_blend_shape_mode`\ (\ mode\: :ref:`BlendShapeMode`\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_lightmap_size_hint`\ (\ size\: :ref:`Vector2i`\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_surface_material`\ (\ surface_idx\: :ref:`int`, material\: :ref:`Material`\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_surface_name`\ (\ surface_idx\: :ref:`int`, name\: :ref:`String`\ ) | + +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -123,7 +123,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_blend_shape** **(** :ref:`String` name **)** +|void| **add_blend_shape**\ (\ name\: :ref:`String`\ ) Adds name for a blend shape that will be added with :ref:`add_surface`. Must be called before surface is added. @@ -135,7 +135,7 @@ Adds name for a blend shape that will be added with :ref:`add_surface` primitive, :ref:`Array` arrays, :ref:`Array[]` blend_shapes=[], :ref:`Dictionary` lods={}, :ref:`Material` material=null, :ref:`String` name="", :ref:`int` flags=0 **)** +|void| **add_surface**\ (\ primitive\: :ref:`PrimitiveType`, arrays\: :ref:`Array`, blend_shapes\: :ref:`Array`\[:ref:`Array`\] = [], lods\: :ref:`Dictionary` = {}, material\: :ref:`Material` = null, name\: :ref:`String` = "", flags\: :ref:`int` = 0\ ) Creates a new surface. :ref:`Mesh.get_surface_count` will become the ``surf_idx`` for this new surface. @@ -159,7 +159,7 @@ The ``flags`` argument is the bitwise or of, as required: One value of :ref:`Arr .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Removes all surfaces and blend shapes from this **ImporterMesh**. @@ -171,7 +171,7 @@ Removes all surfaces and blend shapes from this **ImporterMesh**. .. rst-class:: classref-method -void **generate_lods** **(** :ref:`float` normal_merge_angle, :ref:`float` normal_split_angle, :ref:`Array` bone_transform_array **)** +|void| **generate_lods**\ (\ normal_merge_angle\: :ref:`float`, normal_split_angle\: :ref:`float`, bone_transform_array\: :ref:`Array`\ ) Generates all lods for this ImporterMesh. @@ -189,7 +189,7 @@ The number of generated lods can be accessed using :ref:`get_surface_lod_count` **get_blend_shape_count** **(** **)** |const| +:ref:`int` **get_blend_shape_count**\ (\ ) |const| Returns the number of blend shapes that the mesh holds. @@ -201,7 +201,7 @@ Returns the number of blend shapes that the mesh holds. .. rst-class:: classref-method -:ref:`BlendShapeMode` **get_blend_shape_mode** **(** **)** |const| +:ref:`BlendShapeMode` **get_blend_shape_mode**\ (\ ) |const| Returns the blend shape mode for this Mesh. @@ -213,7 +213,7 @@ Returns the blend shape mode for this Mesh. .. rst-class:: classref-method -:ref:`String` **get_blend_shape_name** **(** :ref:`int` blend_shape_idx **)** |const| +:ref:`String` **get_blend_shape_name**\ (\ blend_shape_idx\: :ref:`int`\ ) |const| Returns the name of the blend shape at this index. @@ -225,7 +225,7 @@ Returns the name of the blend shape at this index. .. rst-class:: classref-method -:ref:`Vector2i` **get_lightmap_size_hint** **(** **)** |const| +:ref:`Vector2i` **get_lightmap_size_hint**\ (\ ) |const| Returns the size hint of this mesh for lightmap-unwrapping in UV-space. @@ -237,7 +237,7 @@ Returns the size hint of this mesh for lightmap-unwrapping in UV-space. .. rst-class:: classref-method -:ref:`ArrayMesh` **get_mesh** **(** :ref:`ArrayMesh` base_mesh=null **)** +:ref:`ArrayMesh` **get_mesh**\ (\ base_mesh\: :ref:`ArrayMesh` = null\ ) Returns the mesh data represented by this **ImporterMesh** as a usable :ref:`ArrayMesh`. @@ -253,7 +253,7 @@ If not yet cached and ``base_mesh`` is provided, ``base_mesh`` will be used and .. rst-class:: classref-method -:ref:`Array` **get_surface_arrays** **(** :ref:`int` surface_idx **)** |const| +:ref:`Array` **get_surface_arrays**\ (\ surface_idx\: :ref:`int`\ ) |const| Returns the arrays for the vertices, normals, UVs, etc. that make up the requested surface. See :ref:`add_surface`. @@ -265,7 +265,7 @@ Returns the arrays for the vertices, normals, UVs, etc. that make up the request .. rst-class:: classref-method -:ref:`Array` **get_surface_blend_shape_arrays** **(** :ref:`int` surface_idx, :ref:`int` blend_shape_idx **)** |const| +:ref:`Array` **get_surface_blend_shape_arrays**\ (\ surface_idx\: :ref:`int`, blend_shape_idx\: :ref:`int`\ ) |const| Returns a single set of blend shape arrays for the requested blend shape index for a surface. @@ -277,7 +277,7 @@ Returns a single set of blend shape arrays for the requested blend shape index f .. rst-class:: classref-method -:ref:`int` **get_surface_count** **(** **)** |const| +:ref:`int` **get_surface_count**\ (\ ) |const| Returns the number of surfaces that the mesh holds. @@ -289,7 +289,7 @@ Returns the number of surfaces that the mesh holds. .. rst-class:: classref-method -:ref:`int` **get_surface_format** **(** :ref:`int` surface_idx **)** |const| +:ref:`int` **get_surface_format**\ (\ surface_idx\: :ref:`int`\ ) |const| Returns the format of the surface that the mesh holds. @@ -301,7 +301,7 @@ Returns the format of the surface that the mesh holds. .. rst-class:: classref-method -:ref:`int` **get_surface_lod_count** **(** :ref:`int` surface_idx **)** |const| +:ref:`int` **get_surface_lod_count**\ (\ surface_idx\: :ref:`int`\ ) |const| Returns the number of lods that the mesh holds on a given surface. @@ -313,7 +313,7 @@ Returns the number of lods that the mesh holds on a given surface. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_surface_lod_indices** **(** :ref:`int` surface_idx, :ref:`int` lod_idx **)** |const| +:ref:`PackedInt32Array` **get_surface_lod_indices**\ (\ surface_idx\: :ref:`int`, lod_idx\: :ref:`int`\ ) |const| Returns the index buffer of a lod for a surface. @@ -325,7 +325,7 @@ Returns the index buffer of a lod for a surface. .. rst-class:: classref-method -:ref:`float` **get_surface_lod_size** **(** :ref:`int` surface_idx, :ref:`int` lod_idx **)** |const| +:ref:`float` **get_surface_lod_size**\ (\ surface_idx\: :ref:`int`, lod_idx\: :ref:`int`\ ) |const| Returns the screen ratio which activates a lod for a surface. @@ -337,7 +337,7 @@ Returns the screen ratio which activates a lod for a surface. .. rst-class:: classref-method -:ref:`Material` **get_surface_material** **(** :ref:`int` surface_idx **)** |const| +:ref:`Material` **get_surface_material**\ (\ surface_idx\: :ref:`int`\ ) |const| Returns a :ref:`Material` in a given surface. Surface is rendered using this material. @@ -349,7 +349,7 @@ Returns a :ref:`Material` in a given surface. Surface is rendere .. rst-class:: classref-method -:ref:`String` **get_surface_name** **(** :ref:`int` surface_idx **)** |const| +:ref:`String` **get_surface_name**\ (\ surface_idx\: :ref:`int`\ ) |const| Gets the name assigned to this surface. @@ -361,7 +361,7 @@ Gets the name assigned to this surface. .. rst-class:: classref-method -:ref:`PrimitiveType` **get_surface_primitive_type** **(** :ref:`int` surface_idx **)** +:ref:`PrimitiveType` **get_surface_primitive_type**\ (\ surface_idx\: :ref:`int`\ ) Returns the primitive type of the requested surface (see :ref:`add_surface`). @@ -373,7 +373,7 @@ Returns the primitive type of the requested surface (see :ref:`add_surface` mode **)** +|void| **set_blend_shape_mode**\ (\ mode\: :ref:`BlendShapeMode`\ ) Sets the blend shape mode to one of :ref:`BlendShapeMode`. @@ -385,7 +385,7 @@ Sets the blend shape mode to one of :ref:`BlendShapeMode` size **)** +|void| **set_lightmap_size_hint**\ (\ size\: :ref:`Vector2i`\ ) Sets the size hint of this mesh for lightmap-unwrapping in UV-space. @@ -397,7 +397,7 @@ Sets the size hint of this mesh for lightmap-unwrapping in UV-space. .. rst-class:: classref-method -void **set_surface_material** **(** :ref:`int` surface_idx, :ref:`Material` material **)** +|void| **set_surface_material**\ (\ surface_idx\: :ref:`int`, material\: :ref:`Material`\ ) Sets a :ref:`Material` for a given surface. Surface will be rendered using this material. @@ -409,7 +409,7 @@ Sets a :ref:`Material` for a given surface. Surface will be rend .. rst-class:: classref-method -void **set_surface_name** **(** :ref:`int` surface_idx, :ref:`String` name **)** +|void| **set_surface_name**\ (\ surface_idx\: :ref:`int`, name\: :ref:`String`\ ) Sets a name for a given surface. @@ -420,3 +420,4 @@ Sets a name for a given surface. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_importermeshinstance3d.rst b/classes/class_importermeshinstance3d.rst index b9bfc1d0be5..785f643fde2 100644 --- a/classes/class_importermeshinstance3d.rst +++ b/classes/class_importermeshinstance3d.rst @@ -63,8 +63,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_cast_shadows_setting** **(** :ref:`ShadowCastingSetting` value **)** -- :ref:`ShadowCastingSetting` **get_cast_shadows_setting** **(** **)** +- |void| **set_cast_shadows_setting**\ (\ value\: :ref:`ShadowCastingSetting`\ ) +- :ref:`ShadowCastingSetting` **get_cast_shadows_setting**\ (\ ) .. container:: contribute @@ -82,8 +82,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_layer_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_layer_mask** **(** **)** +- |void| **set_layer_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_layer_mask**\ (\ ) .. container:: contribute @@ -101,8 +101,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_mesh** **(** :ref:`ImporterMesh` value **)** -- :ref:`ImporterMesh` **get_mesh** **(** **)** +- |void| **set_mesh**\ (\ value\: :ref:`ImporterMesh`\ ) +- :ref:`ImporterMesh` **get_mesh**\ (\ ) .. container:: contribute @@ -120,8 +120,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_skeleton_path** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_skeleton_path** **(** **)** +- |void| **set_skeleton_path**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_skeleton_path**\ (\ ) .. container:: contribute @@ -139,8 +139,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_skin** **(** :ref:`Skin` value **)** -- :ref:`Skin` **get_skin** **(** **)** +- |void| **set_skin**\ (\ value\: :ref:`Skin`\ ) +- :ref:`Skin` **get_skin**\ (\ ) .. container:: contribute @@ -158,8 +158,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_visibility_range_begin** **(** :ref:`float` value **)** -- :ref:`float` **get_visibility_range_begin** **(** **)** +- |void| **set_visibility_range_begin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_visibility_range_begin**\ (\ ) .. container:: contribute @@ -177,8 +177,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_visibility_range_begin_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_visibility_range_begin_margin** **(** **)** +- |void| **set_visibility_range_begin_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_visibility_range_begin_margin**\ (\ ) .. container:: contribute @@ -196,8 +196,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_visibility_range_end** **(** :ref:`float` value **)** -- :ref:`float` **get_visibility_range_end** **(** **)** +- |void| **set_visibility_range_end**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_visibility_range_end**\ (\ ) .. container:: contribute @@ -215,8 +215,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_visibility_range_end_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_visibility_range_end_margin** **(** **)** +- |void| **set_visibility_range_end_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_visibility_range_end_margin**\ (\ ) .. container:: contribute @@ -234,8 +234,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_visibility_range_fade_mode** **(** :ref:`VisibilityRangeFadeMode` value **)** -- :ref:`VisibilityRangeFadeMode` **get_visibility_range_fade_mode** **(** **)** +- |void| **set_visibility_range_fade_mode**\ (\ value\: :ref:`VisibilityRangeFadeMode`\ ) +- :ref:`VisibilityRangeFadeMode` **get_visibility_range_fade_mode**\ (\ ) .. container:: contribute @@ -248,3 +248,4 @@ Property Descriptions .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_input.rst b/classes/class_input.rst index 29fb4b54060..3ddf3d2d051 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -60,99 +60,99 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`action_press` **(** :ref:`StringName` action, :ref:`float` strength=1.0 **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`action_release` **(** :ref:`StringName` action **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_joy_mapping` **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`flush_buffered_events` **(** **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_action_raw_strength` **(** :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_action_strength` **(** :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_axis` **(** :ref:`StringName` negative_action, :ref:`StringName` positive_action **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int[]` | :ref:`get_connected_joypads` **(** **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`CursorShape` | :ref:`get_current_cursor_shape` **(** **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_gravity` **(** **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_joy_axis` **(** :ref:`int` device, :ref:`JoyAxis` axis **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_joy_guid` **(** :ref:`int` device **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_joy_info` **(** :ref:`int` device **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_joy_name` **(** :ref:`int` device **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_joy_vibration_duration` **(** :ref:`int` device **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_joy_vibration_strength` **(** :ref:`int` device **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_last_mouse_screen_velocity` **(** **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_last_mouse_velocity` **(** **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`MouseButtonMask`\> | :ref:`get_mouse_button_mask` **(** **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_vector` **(** :ref:`StringName` negative_x, :ref:`StringName` positive_x, :ref:`StringName` negative_y, :ref:`StringName` positive_y, :ref:`float` deadzone=-1.0 **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_action_just_pressed` **(** :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_action_just_released` **(** :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_anything_pressed` **(** **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_joy_button_pressed` **(** :ref:`int` device, :ref:`JoyButton` button **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_joy_known` **(** :ref:`int` device **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_key_label_pressed` **(** :ref:`Key` keycode **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`Key` keycode **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`MouseButton` button **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_physical_key_pressed` **(** :ref:`Key` keycode **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`parse_input_event` **(** :ref:`InputEvent` event **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_accelerometer` **(** :ref:`Vector3` value **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_custom_mouse_cursor` **(** :ref:`Resource` image, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2(0, 0) **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_default_cursor_shape` **(** :ref:`CursorShape` shape=0 **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_gravity` **(** :ref:`Vector3` value **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_gyroscope` **(** :ref:`Vector3` value **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_magnetometer` **(** :ref:`Vector3` value **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`should_ignore_device` **(** :ref:`int` vendor_id, :ref:`int` product_id **)** |const| | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`start_joy_vibration` **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`stop_joy_vibration` **(** :ref:`int` device **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`vibrate_handheld` **(** :ref:`int` duration_ms=500 **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`warp_mouse` **(** :ref:`Vector2` position **)** | - +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`action_press`\ (\ action\: :ref:`StringName`, strength\: :ref:`float` = 1.0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`action_release`\ (\ action\: :ref:`StringName`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_joy_mapping`\ (\ mapping\: :ref:`String`, update_existing\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`flush_buffered_events`\ (\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_accelerometer`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_action_raw_strength`\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_action_strength`\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_axis`\ (\ negative_action\: :ref:`StringName`, positive_action\: :ref:`StringName`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`int`\] | :ref:`get_connected_joypads`\ (\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CursorShape` | :ref:`get_current_cursor_shape`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_gravity`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_gyroscope`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_joy_axis`\ (\ device\: :ref:`int`, axis\: :ref:`JoyAxis`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_joy_guid`\ (\ device\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_joy_info`\ (\ device\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_joy_name`\ (\ device\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_joy_vibration_duration`\ (\ device\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_joy_vibration_strength`\ (\ device\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_last_mouse_screen_velocity`\ (\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_last_mouse_velocity`\ (\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_magnetometer`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`MouseButtonMask`\] | :ref:`get_mouse_button_mask`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_vector`\ (\ negative_x\: :ref:`StringName`, positive_x\: :ref:`StringName`, negative_y\: :ref:`StringName`, positive_y\: :ref:`StringName`, deadzone\: :ref:`float` = -1.0\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_action_just_pressed`\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_action_just_released`\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_action_pressed`\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_anything_pressed`\ (\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_joy_button_pressed`\ (\ device\: :ref:`int`, button\: :ref:`JoyButton`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_joy_known`\ (\ device\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_key_label_pressed`\ (\ keycode\: :ref:`Key`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_key_pressed`\ (\ keycode\: :ref:`Key`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_mouse_button_pressed`\ (\ button\: :ref:`MouseButton`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_physical_key_pressed`\ (\ keycode\: :ref:`Key`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`parse_input_event`\ (\ event\: :ref:`InputEvent`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_joy_mapping`\ (\ guid\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_accelerometer`\ (\ value\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_mouse_cursor`\ (\ image\: :ref:`Resource`, shape\: :ref:`CursorShape` = 0, hotspot\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_default_cursor_shape`\ (\ shape\: :ref:`CursorShape` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gravity`\ (\ value\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gyroscope`\ (\ value\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_magnetometer`\ (\ value\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`should_ignore_device`\ (\ vendor_id\: :ref:`int`, product_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`start_joy_vibration`\ (\ device\: :ref:`int`, weak_magnitude\: :ref:`float`, strong_magnitude\: :ref:`float`, duration\: :ref:`float` = 0\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop_joy_vibration`\ (\ device\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`vibrate_handheld`\ (\ duration_ms\: :ref:`int` = 500\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`warp_mouse`\ (\ position\: :ref:`Vector2`\ ) | + +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -167,7 +167,7 @@ Signals .. rst-class:: classref-signal -**joy_connection_changed** **(** :ref:`int` device, :ref:`bool` connected **)** +**joy_connection_changed**\ (\ device\: :ref:`int`, connected\: :ref:`bool`\ ) Emitted when a joypad device has been connected or disconnected. @@ -393,8 +393,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_emulate_mouse_from_touch** **(** :ref:`bool` value **)** -- :ref:`bool` **is_emulating_mouse_from_touch** **(** **)** +- |void| **set_emulate_mouse_from_touch**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_emulating_mouse_from_touch**\ (\ ) If ``true``, sends mouse input events when tapping or swiping on the touchscreen. See also :ref:`ProjectSettings.input_devices/pointing/emulate_mouse_from_touch`. @@ -410,8 +410,8 @@ If ``true``, sends mouse input events when tapping or swiping on the touchscreen .. rst-class:: classref-property-setget -- void **set_emulate_touch_from_mouse** **(** :ref:`bool` value **)** -- :ref:`bool` **is_emulating_touch_from_mouse** **(** **)** +- |void| **set_emulate_touch_from_mouse**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_emulating_touch_from_mouse**\ (\ ) If ``true``, sends touch input events when clicking or dragging the mouse. See also :ref:`ProjectSettings.input_devices/pointing/emulate_touch_from_mouse`. @@ -427,8 +427,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. See a .. rst-class:: classref-property-setget -- void **set_mouse_mode** **(** :ref:`MouseMode` value **)** -- :ref:`MouseMode` **get_mouse_mode** **(** **)** +- |void| **set_mouse_mode**\ (\ value\: :ref:`MouseMode`\ ) +- :ref:`MouseMode` **get_mouse_mode**\ (\ ) Controls the mouse mode. See :ref:`MouseMode` for more information. @@ -444,8 +444,8 @@ Controls the mouse mode. See :ref:`MouseMode` for more inf .. rst-class:: classref-property-setget -- void **set_use_accumulated_input** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_accumulated_input** **(** **)** +- |void| **set_use_accumulated_input**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_accumulated_input**\ (\ ) If ``true``, similar input events sent by the operating system are accumulated. When input accumulation is enabled, all input events generated during a frame will be merged and emitted when the frame is done rendering. Therefore, this limits the number of input method calls per second to the rendering FPS. @@ -466,7 +466,7 @@ Method Descriptions .. rst-class:: classref-method -void **action_press** **(** :ref:`StringName` action, :ref:`float` strength=1.0 **)** +|void| **action_press**\ (\ action\: :ref:`StringName`, strength\: :ref:`float` = 1.0\ ) This will simulate pressing the specified action. @@ -482,7 +482,7 @@ The strength can be used for non-boolean actions, it's ranged between 0 and 1 re .. rst-class:: classref-method -void **action_release** **(** :ref:`StringName` action **)** +|void| **action_release**\ (\ action\: :ref:`StringName`\ ) If the specified action is already pressed, this will release it. @@ -494,7 +494,7 @@ If the specified action is already pressed, this will release it. .. rst-class:: classref-method -void **add_joy_mapping** **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** +|void| **add_joy_mapping**\ (\ mapping\: :ref:`String`, update_existing\: :ref:`bool` = false\ ) Adds a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. @@ -506,7 +506,7 @@ Adds a new mapping entry (in SDL2 format) to the mapping database. Optionally up .. rst-class:: classref-method -void **flush_buffered_events** **(** **)** +|void| **flush_buffered_events**\ (\ ) Sends all input events which are in the current buffer to the game loop. These events may have been buffered as a result of accumulated input (:ref:`use_accumulated_input`) or agile input flushing (:ref:`ProjectSettings.input_devices/buffering/agile_event_flushing`). @@ -520,7 +520,7 @@ The engine will already do this itself at key execution points (at least once pe .. rst-class:: classref-method -:ref:`Vector3` **get_accelerometer** **(** **)** |const| +:ref:`Vector3` **get_accelerometer**\ (\ ) |const| Returns the acceleration in m/s² of the device's accelerometer sensor, if the device has one. Otherwise, the method returns :ref:`Vector3.ZERO`. @@ -536,7 +536,7 @@ Note this method returns an empty :ref:`Vector3` when running fro .. rst-class:: classref-method -:ref:`float` **get_action_raw_strength** **(** :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| +:ref:`float` **get_action_raw_strength**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| Returns a value between 0 and 1 representing the raw intensity of the given action, ignoring the action's deadzone. In most cases, you should use :ref:`get_action_strength` instead. @@ -550,7 +550,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`float` **get_action_strength** **(** :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| +:ref:`float` **get_action_strength**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| Returns a value between 0 and 1 representing the intensity of the given action. In a joypad, for example, the further away the axis (analog sticks or L2, R2 triggers) is from the dead zone, the closer the value will be to 1. If the action is mapped to a control that has no axis such as the keyboard, the value returned will be 0 or 1. @@ -564,7 +564,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`float` **get_axis** **(** :ref:`StringName` negative_action, :ref:`StringName` positive_action **)** |const| +:ref:`float` **get_axis**\ (\ negative_action\: :ref:`StringName`, positive_action\: :ref:`StringName`\ ) |const| Get axis input by specifying two actions, one negative and one positive. @@ -578,7 +578,7 @@ This is a shorthand for writing ``Input.get_action_strength("positive_action") - .. rst-class:: classref-method -:ref:`int[]` **get_connected_joypads** **(** **)** +:ref:`Array`\[:ref:`int`\] **get_connected_joypads**\ (\ ) Returns an :ref:`Array` containing the device IDs of all currently connected joypads. @@ -590,7 +590,7 @@ Returns an :ref:`Array` containing the device IDs of all currently .. rst-class:: classref-method -:ref:`CursorShape` **get_current_cursor_shape** **(** **)** |const| +:ref:`CursorShape` **get_current_cursor_shape**\ (\ ) |const| Returns the currently assigned cursor shape (see :ref:`CursorShape`). @@ -602,7 +602,7 @@ Returns the currently assigned cursor shape (see :ref:`CursorShape` **get_gravity** **(** **)** |const| +:ref:`Vector3` **get_gravity**\ (\ ) |const| Returns the gravity in m/s² of the device's accelerometer sensor, if the device has one. Otherwise, the method returns :ref:`Vector3.ZERO`. @@ -616,7 +616,7 @@ Returns the gravity in m/s² of the device's accelerometer sensor, if the device .. rst-class:: classref-method -:ref:`Vector3` **get_gyroscope** **(** **)** |const| +:ref:`Vector3` **get_gyroscope**\ (\ ) |const| Returns the rotation rate in rad/s around a device's X, Y, and Z axes of the gyroscope sensor, if the device has one. Otherwise, the method returns :ref:`Vector3.ZERO`. @@ -630,7 +630,7 @@ Returns the rotation rate in rad/s around a device's X, Y, and Z axes of the gyr .. rst-class:: classref-method -:ref:`float` **get_joy_axis** **(** :ref:`int` device, :ref:`JoyAxis` axis **)** |const| +:ref:`float` **get_joy_axis**\ (\ device\: :ref:`int`, axis\: :ref:`JoyAxis`\ ) |const| Returns the current value of the joypad axis at given index (see :ref:`JoyAxis`). @@ -642,7 +642,7 @@ Returns the current value of the joypad axis at given index (see :ref:`JoyAxis` **get_joy_guid** **(** :ref:`int` device **)** |const| +:ref:`String` **get_joy_guid**\ (\ device\: :ref:`int`\ ) |const| Returns a SDL2-compatible device GUID on platforms that use gamepad remapping, e.g. ``030000004c050000c405000000010000``. Returns ``"Default Gamepad"`` otherwise. Godot uses the `SDL2 game controller database `__ to determine gamepad names and mappings based on this GUID. @@ -654,7 +654,7 @@ Returns a SDL2-compatible device GUID on platforms that use gamepad remapping, e .. rst-class:: classref-method -:ref:`Dictionary` **get_joy_info** **(** :ref:`int` device **)** |const| +:ref:`Dictionary` **get_joy_info**\ (\ device\: :ref:`int`\ ) |const| Returns a dictionary with extra platform-specific information about the device, e.g. the raw gamepad name from the OS or the Steam Input index. @@ -680,7 +680,7 @@ On Linux: .. rst-class:: classref-method -:ref:`String` **get_joy_name** **(** :ref:`int` device **)** +:ref:`String` **get_joy_name**\ (\ device\: :ref:`int`\ ) Returns the name of the joypad at the specified device index, e.g. ``PS4 Controller``. Godot uses the `SDL2 game controller database `__ to determine gamepad names. @@ -692,7 +692,7 @@ Returns the name of the joypad at the specified device index, e.g. ``PS4 Control .. rst-class:: classref-method -:ref:`float` **get_joy_vibration_duration** **(** :ref:`int` device **)** +:ref:`float` **get_joy_vibration_duration**\ (\ device\: :ref:`int`\ ) Returns the duration of the current vibration effect in seconds. @@ -704,7 +704,7 @@ Returns the duration of the current vibration effect in seconds. .. rst-class:: classref-method -:ref:`Vector2` **get_joy_vibration_strength** **(** :ref:`int` device **)** +:ref:`Vector2` **get_joy_vibration_strength**\ (\ device\: :ref:`int`\ ) Returns the strength of the joypad vibration: x is the strength of the weak motor, and y is the strength of the strong motor. @@ -716,7 +716,7 @@ Returns the strength of the joypad vibration: x is the strength of the weak moto .. rst-class:: classref-method -:ref:`Vector2` **get_last_mouse_screen_velocity** **(** **)** +:ref:`Vector2` **get_last_mouse_screen_velocity**\ (\ ) Returns the last mouse velocity in screen coordinates. To provide a precise and jitter-free velocity, mouse velocity is only calculated every 0.1s. Therefore, mouse velocity will lag mouse movements. @@ -728,7 +728,7 @@ Returns the last mouse velocity in screen coordinates. To provide a precise and .. rst-class:: classref-method -:ref:`Vector2` **get_last_mouse_velocity** **(** **)** +:ref:`Vector2` **get_last_mouse_velocity**\ (\ ) Returns the last mouse velocity. To provide a precise and jitter-free velocity, mouse velocity is only calculated every 0.1s. Therefore, mouse velocity will lag mouse movements. @@ -740,7 +740,7 @@ Returns the last mouse velocity. To provide a precise and jitter-free velocity, .. rst-class:: classref-method -:ref:`Vector3` **get_magnetometer** **(** **)** |const| +:ref:`Vector3` **get_magnetometer**\ (\ ) |const| Returns the magnetic field strength in micro-Tesla for all axes of the device's magnetometer sensor, if the device has one. Otherwise, the method returns :ref:`Vector3.ZERO`. @@ -754,7 +754,7 @@ Returns the magnetic field strength in micro-Tesla for all axes of the device's .. rst-class:: classref-method -|bitfield|\<:ref:`MouseButtonMask`\> **get_mouse_button_mask** **(** **)** |const| +|bitfield|\[:ref:`MouseButtonMask`\] **get_mouse_button_mask**\ (\ ) |const| Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time, the bits are added together. Equivalent to :ref:`DisplayServer.mouse_get_button_state`. @@ -766,7 +766,7 @@ Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the .. rst-class:: classref-method -:ref:`Vector2` **get_vector** **(** :ref:`StringName` negative_x, :ref:`StringName` positive_x, :ref:`StringName` negative_y, :ref:`StringName` positive_y, :ref:`float` deadzone=-1.0 **)** |const| +:ref:`Vector2` **get_vector**\ (\ negative_x\: :ref:`StringName`, positive_x\: :ref:`StringName`, negative_y\: :ref:`StringName`, positive_y\: :ref:`StringName`, deadzone\: :ref:`float` = -1.0\ ) |const| Gets an input vector by specifying four actions for the positive and negative X and Y axes. @@ -782,7 +782,7 @@ By default, the deadzone is automatically calculated from the average of the act .. rst-class:: classref-method -:ref:`bool` **is_action_just_pressed** **(** :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| +:ref:`bool` **is_action_just_pressed**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| Returns ``true`` when the user has *started* pressing the action event in the current frame or physics tick. It will only return ``true`` on the frame or tick that the user pressed down the button. @@ -804,7 +804,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`bool` **is_action_just_released** **(** :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| +:ref:`bool` **is_action_just_released**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| Returns ``true`` when the user *stops* pressing the action event in the current frame or physics tick. It will only return ``true`` on the frame or tick that the user releases the button. @@ -822,7 +822,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`bool` **is_action_pressed** **(** :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| +:ref:`bool` **is_action_pressed**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| Returns ``true`` if you are pressing the action event. @@ -838,7 +838,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`bool` **is_anything_pressed** **(** **)** |const| +:ref:`bool` **is_anything_pressed**\ (\ ) |const| Returns ``true`` if any action, key, joypad button, or mouse button is being pressed. This will also return ``true`` if any action is simulated via code by calling :ref:`action_press`. @@ -850,7 +850,7 @@ Returns ``true`` if any action, key, joypad button, or mouse button is being pre .. rst-class:: classref-method -:ref:`bool` **is_joy_button_pressed** **(** :ref:`int` device, :ref:`JoyButton` button **)** |const| +:ref:`bool` **is_joy_button_pressed**\ (\ device\: :ref:`int`, button\: :ref:`JoyButton`\ ) |const| Returns ``true`` if you are pressing the joypad button (see :ref:`JoyButton`). @@ -862,7 +862,7 @@ Returns ``true`` if you are pressing the joypad button (see :ref:`JoyButton` **is_joy_known** **(** :ref:`int` device **)** +:ref:`bool` **is_joy_known**\ (\ device\: :ref:`int`\ ) Returns ``true`` if the system knows the specified device. This means that it sets all button and axis indices. Unknown joypads are not expected to match these constants, but you can still retrieve events from them. @@ -874,7 +874,7 @@ Returns ``true`` if the system knows the specified device. This means that it se .. rst-class:: classref-method -:ref:`bool` **is_key_label_pressed** **(** :ref:`Key` keycode **)** |const| +:ref:`bool` **is_key_label_pressed**\ (\ keycode\: :ref:`Key`\ ) |const| Returns ``true`` if you are pressing the key with the ``keycode`` printed on it. You can pass a :ref:`Key` constant or any Unicode character code. @@ -886,7 +886,7 @@ Returns ``true`` if you are pressing the key with the ``keycode`` printed on it. .. rst-class:: classref-method -:ref:`bool` **is_key_pressed** **(** :ref:`Key` keycode **)** |const| +:ref:`bool` **is_key_pressed**\ (\ keycode\: :ref:`Key`\ ) |const| Returns ``true`` if you are pressing the Latin key in the current keyboard layout. You can pass a :ref:`Key` constant. @@ -902,7 +902,7 @@ Returns ``true`` if you are pressing the Latin key in the current keyboard layou .. rst-class:: classref-method -:ref:`bool` **is_mouse_button_pressed** **(** :ref:`MouseButton` button **)** |const| +:ref:`bool` **is_mouse_button_pressed**\ (\ button\: :ref:`MouseButton`\ ) |const| Returns ``true`` if you are pressing the mouse button specified with :ref:`MouseButton`. @@ -914,7 +914,7 @@ Returns ``true`` if you are pressing the mouse button specified with :ref:`Mouse .. rst-class:: classref-method -:ref:`bool` **is_physical_key_pressed** **(** :ref:`Key` keycode **)** |const| +:ref:`bool` **is_physical_key_pressed**\ (\ keycode\: :ref:`Key`\ ) |const| Returns ``true`` if you are pressing the key in the physical location on the 101/102-key US QWERTY keyboard. You can pass a :ref:`Key` constant. @@ -930,7 +930,7 @@ Returns ``true`` if you are pressing the key in the physical location on the 101 .. rst-class:: classref-method -void **parse_input_event** **(** :ref:`InputEvent` event **)** +|void| **parse_input_event**\ (\ event\: :ref:`InputEvent`\ ) Feeds an :ref:`InputEvent` to the game. Can be used to artificially trigger input events from code. Also generates :ref:`Node._input` calls. @@ -963,7 +963,7 @@ Feeds an :ref:`InputEvent` to the game. Can be used to artific .. rst-class:: classref-method -void **remove_joy_mapping** **(** :ref:`String` guid **)** +|void| **remove_joy_mapping**\ (\ guid\: :ref:`String`\ ) Removes all mappings from the internal database that match the given GUID. @@ -975,7 +975,7 @@ Removes all mappings from the internal database that match the given GUID. .. rst-class:: classref-method -void **set_accelerometer** **(** :ref:`Vector3` value **)** +|void| **set_accelerometer**\ (\ value\: :ref:`Vector3`\ ) Sets the acceleration value of the accelerometer sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. @@ -989,7 +989,7 @@ Sets the acceleration value of the accelerometer sensor. Can be used for debuggi .. rst-class:: classref-method -void **set_custom_mouse_cursor** **(** :ref:`Resource` image, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2(0, 0) **)** +|void| **set_custom_mouse_cursor**\ (\ image\: :ref:`Resource`, shape\: :ref:`CursorShape` = 0, hotspot\: :ref:`Vector2` = Vector2(0, 0)\ ) Sets a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. Passing ``null`` to the image parameter resets to the system cursor. See :ref:`CursorShape` for the list of shapes. @@ -1011,7 +1011,7 @@ Sets a custom mouse cursor image, which is only visible inside the game window. .. rst-class:: classref-method -void **set_default_cursor_shape** **(** :ref:`CursorShape` shape=0 **)** +|void| **set_default_cursor_shape**\ (\ shape\: :ref:`CursorShape` = 0\ ) Sets the default cursor shape to be used in the viewport instead of :ref:`CURSOR_ARROW`. @@ -1027,7 +1027,7 @@ Sets the default cursor shape to be used in the viewport instead of :ref:`CURSOR .. rst-class:: classref-method -void **set_gravity** **(** :ref:`Vector3` value **)** +|void| **set_gravity**\ (\ value\: :ref:`Vector3`\ ) Sets the gravity value of the accelerometer sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. @@ -1041,7 +1041,7 @@ Sets the gravity value of the accelerometer sensor. Can be used for debugging on .. rst-class:: classref-method -void **set_gyroscope** **(** :ref:`Vector3` value **)** +|void| **set_gyroscope**\ (\ value\: :ref:`Vector3`\ ) Sets the value of the rotation rate of the gyroscope sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. @@ -1055,7 +1055,7 @@ Sets the value of the rotation rate of the gyroscope sensor. Can be used for deb .. rst-class:: classref-method -void **set_magnetometer** **(** :ref:`Vector3` value **)** +|void| **set_magnetometer**\ (\ value\: :ref:`Vector3`\ ) Sets the value of the magnetic field of the magnetometer sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. @@ -1069,7 +1069,7 @@ Sets the value of the magnetic field of the magnetometer sensor. Can be used for .. rst-class:: classref-method -:ref:`bool` **should_ignore_device** **(** :ref:`int` vendor_id, :ref:`int` product_id **)** |const| +:ref:`bool` **should_ignore_device**\ (\ vendor_id\: :ref:`int`, product_id\: :ref:`int`\ ) |const| Queries whether an input device should be ignored or not. Devices can be ignored by setting the environment variable ``SDL_GAMECONTROLLER_IGNORE_DEVICES``. Read the `SDL documentation `__ for more information. @@ -1083,12 +1083,14 @@ Queries whether an input device should be ignored or not. Devices can be ignored .. rst-class:: classref-method -void **start_joy_vibration** **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** +|void| **start_joy_vibration**\ (\ device\: :ref:`int`, weak_magnitude\: :ref:`float`, strong_magnitude\: :ref:`float`, duration\: :ref:`float` = 0\ ) Starts to vibrate the joypad. Joypads usually come with two rumble motors, a strong and a weak one. ``weak_magnitude`` is the strength of the weak motor (between 0 and 1) and ``strong_magnitude`` is the strength of the strong motor (between 0 and 1). ``duration`` is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). The vibration can be stopped early by calling :ref:`stop_joy_vibration`. \ **Note:** Not every hardware is compatible with long effect durations; it is recommended to restart an effect if it has to be played for more than a few seconds. +\ **Note:** For macOS, vibration is only supported in macOS 11 and later. + .. rst-class:: classref-item-separator ---- @@ -1097,7 +1099,7 @@ Starts to vibrate the joypad. Joypads usually come with two rumble motors, a str .. rst-class:: classref-method -void **stop_joy_vibration** **(** :ref:`int` device **)** +|void| **stop_joy_vibration**\ (\ device\: :ref:`int`\ ) Stops the vibration of the joypad started with :ref:`start_joy_vibration`. @@ -1109,7 +1111,7 @@ Stops the vibration of the joypad started with :ref:`start_joy_vibration` duration_ms=500 **)** +|void| **vibrate_handheld**\ (\ duration_ms\: :ref:`int` = 500\ ) Vibrate the handheld device for the specified duration in milliseconds. @@ -1129,7 +1131,7 @@ Vibrate the handheld device for the specified duration in milliseconds. .. rst-class:: classref-method -void **warp_mouse** **(** :ref:`Vector2` position **)** +|void| **warp_mouse**\ (\ position\: :ref:`Vector2`\ ) Sets the mouse position to the specified vector, provided in pixels and relative to an origin at the upper left corner of the currently focused Window Manager game window. @@ -1144,3 +1146,4 @@ Mouse position is clipped to the limits of the screen resolution, or to the limi .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index 15ae7e10b6c..a67a1b95e35 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -56,33 +56,33 @@ Methods .. table:: :widths: auto - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`accumulate` **(** :ref:`InputEvent` with_event **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`as_text` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_action_strength` **(** :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_action` **(** :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`StringName` action, :ref:`bool` allow_echo=false, :ref:`bool` exact_match=false **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_action_released` **(** :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_action_type` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_canceled` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_echo` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_match` **(** :ref:`InputEvent` event, :ref:`bool` exact_match=true **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_pressed` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_released` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`InputEvent` | :ref:`xformed_by` **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2(0, 0) **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`accumulate`\ (\ with_event\: :ref:`InputEvent`\ ) | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`as_text`\ (\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_action_strength`\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_action`\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_action_pressed`\ (\ action\: :ref:`StringName`, allow_echo\: :ref:`bool` = false, exact_match\: :ref:`bool` = false\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_action_released`\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_action_type`\ (\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_canceled`\ (\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_echo`\ (\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_match`\ (\ event\: :ref:`InputEvent`, exact_match\: :ref:`bool` = true\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_pressed`\ (\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_released`\ (\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`InputEvent` | :ref:`xformed_by`\ (\ xform\: :ref:`Transform2D`, local_ofs\: :ref:`Vector2` = Vector2(0, 0)\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -101,8 +101,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_device** **(** :ref:`int` value **)** -- :ref:`int` **get_device** **(** **)** +- |void| **set_device**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_device**\ (\ ) The event's device ID. @@ -121,7 +121,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **accumulate** **(** :ref:`InputEvent` with_event **)** +:ref:`bool` **accumulate**\ (\ with_event\: :ref:`InputEvent`\ ) Returns ``true`` if the given input event and this input event can be added together (only for events of type :ref:`InputEventMouseMotion`). @@ -135,7 +135,7 @@ The given input event's position, global position and speed will be copied. The .. rst-class:: classref-method -:ref:`String` **as_text** **(** **)** |const| +:ref:`String` **as_text**\ (\ ) |const| Returns a :ref:`String` representation of the event. @@ -147,7 +147,7 @@ Returns a :ref:`String` representation of the event. .. rst-class:: classref-method -:ref:`float` **get_action_strength** **(** :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| +:ref:`float` **get_action_strength**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type :ref:`InputEventJoypadMotion`. @@ -161,7 +161,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`bool` **is_action** **(** :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| +:ref:`bool` **is_action**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| Returns ``true`` if this input event matches a pre-defined action of any type. @@ -175,7 +175,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`bool` **is_action_pressed** **(** :ref:`StringName` action, :ref:`bool` allow_echo=false, :ref:`bool` exact_match=false **)** |const| +:ref:`bool` **is_action_pressed**\ (\ action\: :ref:`StringName`, allow_echo\: :ref:`bool` = false, exact_match\: :ref:`bool` = false\ ) |const| Returns ``true`` if the given action is being pressed (and is not an echo event for :ref:`InputEventKey` events, unless ``allow_echo`` is ``true``). Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. @@ -191,7 +191,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`bool` **is_action_released** **(** :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| +:ref:`bool` **is_action_released**\ (\ action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| Returns ``true`` if the given action is released (i.e. not pressed). Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. @@ -205,7 +205,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`bool` **is_action_type** **(** **)** |const| +:ref:`bool` **is_action_type**\ (\ ) |const| Returns ``true`` if this input event's type is one that can be assigned to an input action. @@ -217,7 +217,7 @@ Returns ``true`` if this input event's type is one that can be assigned to an in .. rst-class:: classref-method -:ref:`bool` **is_canceled** **(** **)** |const| +:ref:`bool` **is_canceled**\ (\ ) |const| Returns ``true`` if this input event has been canceled. @@ -229,7 +229,7 @@ Returns ``true`` if this input event has been canceled. .. rst-class:: classref-method -:ref:`bool` **is_echo** **(** **)** |const| +:ref:`bool` **is_echo**\ (\ ) |const| Returns ``true`` if this input event is an echo event (only for events of type :ref:`InputEventKey`). Any other event type returns ``false``. @@ -241,7 +241,7 @@ Returns ``true`` if this input event is an echo event (only for events of type : .. rst-class:: classref-method -:ref:`bool` **is_match** **(** :ref:`InputEvent` event, :ref:`bool` exact_match=true **)** |const| +:ref:`bool` **is_match**\ (\ event\: :ref:`InputEvent`, exact_match\: :ref:`bool` = true\ ) |const| Returns ``true`` if the specified ``event`` matches this event. Only valid for action events i.e key (:ref:`InputEventKey`), button (:ref:`InputEventMouseButton` or :ref:`InputEventJoypadButton`), axis :ref:`InputEventJoypadMotion` or action (:ref:`InputEventAction`) events. @@ -255,7 +255,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`bool` **is_pressed** **(** **)** |const| +:ref:`bool` **is_pressed**\ (\ ) |const| Returns ``true`` if this input event is pressed. Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. @@ -269,7 +269,7 @@ Returns ``true`` if this input event is pressed. Not relevant for events of type .. rst-class:: classref-method -:ref:`bool` **is_released** **(** **)** |const| +:ref:`bool` **is_released**\ (\ ) |const| Returns ``true`` if this input event is released. Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. @@ -281,7 +281,7 @@ Returns ``true`` if this input event is released. Not relevant for events of typ .. rst-class:: classref-method -:ref:`InputEvent` **xformed_by** **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2(0, 0) **)** |const| +:ref:`InputEvent` **xformed_by**\ (\ xform\: :ref:`Transform2D`, local_ofs\: :ref:`Vector2` = Vector2(0, 0)\ ) |const| Returns a copy of the given input event which has been offset by ``local_ofs`` and transformed by ``xform``. Relevant for events of type :ref:`InputEventMouseButton`, :ref:`InputEventMouseMotion`, :ref:`InputEventScreenTouch`, :ref:`InputEventScreenDrag`, :ref:`InputEventMagnifyGesture` and :ref:`InputEventPanGesture`. @@ -292,3 +292,4 @@ Returns a copy of the given input event which has been offset by ``local_ofs`` a .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index 5471ce67408..a9005655fe5 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -67,8 +67,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_action** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_action** **(** **)** +- |void| **set_action**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_action**\ (\ ) The action's name. Actions are accessed via this :ref:`String`. @@ -84,8 +84,8 @@ The action's name. Actions are accessed via this :ref:`String`. .. rst-class:: classref-property-setget -- void **set_pressed** **(** :ref:`bool` value **)** -- :ref:`bool` **is_pressed** **(** **)** +- |void| **set_pressed**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_pressed**\ (\ ) If ``true``, the action's state is pressed. If ``false``, the action's state is released. @@ -101,8 +101,8 @@ If ``true``, the action's state is pressed. If ``false``, the action's state is .. rst-class:: classref-property-setget -- void **set_strength** **(** :ref:`float` value **)** -- :ref:`float` **get_strength** **(** **)** +- |void| **set_strength**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_strength**\ (\ ) The action's strength between 0 and 1. This value is considered as equal to 0 if pressed is ``false``. The event strength allows faking analog joypad motion events, by specifying how strongly the joypad axis is bent or pressed. @@ -113,3 +113,4 @@ The action's strength between 0 and 1. This value is considered as equal to 0 if .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_inputeventfromwindow.rst b/classes/class_inputeventfromwindow.rst index 063ee5c0260..77bb2adfc7c 100644 --- a/classes/class_inputeventfromwindow.rst +++ b/classes/class_inputeventfromwindow.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_window_id** **(** :ref:`int` value **)** -- :ref:`int` **get_window_id** **(** **)** +- |void| **set_window_id**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_window_id**\ (\ ) The ID of a :ref:`Window` that received this event. @@ -64,3 +64,4 @@ The ID of a :ref:`Window` that received this event. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_inputeventgesture.rst b/classes/class_inputeventgesture.rst index 5153fcf5022..82bd255fa43 100644 --- a/classes/class_inputeventgesture.rst +++ b/classes/class_inputeventgesture.rst @@ -59,8 +59,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_position** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_position** **(** **)** +- |void| **set_position**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_position**\ (\ ) The local gesture position relative to the :ref:`Viewport`. If used in :ref:`Control._gui_input`, the position is relative to the current :ref:`Control` that received this gesture. @@ -71,3 +71,4 @@ The local gesture position relative to the :ref:`Viewport`. If u .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index d97729ca68c..6be15fee2a1 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: gamepad, controller + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -61,8 +64,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_button_index** **(** :ref:`JoyButton` value **)** -- :ref:`JoyButton` **get_button_index** **(** **)** +- |void| **set_button_index**\ (\ value\: :ref:`JoyButton`\ ) +- :ref:`JoyButton` **get_button_index**\ (\ ) Button identifier. One of the :ref:`JoyButton` button constants. @@ -78,8 +81,8 @@ Button identifier. One of the :ref:`JoyButton` butt .. rst-class:: classref-property-setget -- void **set_pressed** **(** :ref:`bool` value **)** -- :ref:`bool` **is_pressed** **(** **)** +- |void| **set_pressed**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_pressed**\ (\ ) If ``true``, the button's state is pressed. If ``false``, the button's state is released. @@ -95,15 +98,11 @@ If ``true``, the button's state is pressed. If ``false``, the button's state is .. rst-class:: classref-property-setget -- void **set_pressure** **(** :ref:`float` value **)** -- :ref:`float` **get_pressure** **(** **)** +- |void| **set_pressure**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pressure**\ (\ ) **Deprecated:** This property is never set by the engine and is always ``0``. -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! - .. |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.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` @@ -111,3 +110,4 @@ If ``true``, the button's state is pressed. If ``false``, the button's state is .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index c207962cfee..c3d7ff10d4e 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: gamepad, controller + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -59,8 +62,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_axis** **(** :ref:`JoyAxis` value **)** -- :ref:`JoyAxis` **get_axis** **(** **)** +- |void| **set_axis**\ (\ value\: :ref:`JoyAxis`\ ) +- :ref:`JoyAxis` **get_axis**\ (\ ) Axis identifier. Use one of the :ref:`JoyAxis` axis constants. @@ -76,8 +79,8 @@ Axis identifier. Use one of the :ref:`JoyAxis` axis c .. rst-class:: classref-property-setget -- void **set_axis_value** **(** :ref:`float` value **)** -- :ref:`float` **get_axis_value** **(** **)** +- |void| **set_axis_value**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_axis_value**\ (\ ) Current position of the joystick on the given axis. The value ranges from ``-1.0`` to ``1.0``. A value of ``0`` means the axis is in its resting position. @@ -88,3 +91,4 @@ Current position of the joystick on the given axis. The value ranges from ``-1.0 .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index 1d448257208..abb53403614 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -64,21 +64,21 @@ Methods .. table:: :widths: auto - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`as_text_key_label` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`as_text_keycode` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`as_text_location` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`as_text_physical_keycode` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Key` | :ref:`get_key_label_with_modifiers` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Key` | :ref:`get_keycode_with_modifiers` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Key` | :ref:`get_physical_keycode_with_modifiers` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`as_text_key_label`\ (\ ) |const| | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`as_text_keycode`\ (\ ) |const| | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`as_text_location`\ (\ ) |const| | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`as_text_physical_keycode`\ (\ ) |const| | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Key` | :ref:`get_key_label_with_modifiers`\ (\ ) |const| | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Key` | :ref:`get_keycode_with_modifiers`\ (\ ) |const| | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Key` | :ref:`get_physical_keycode_with_modifiers`\ (\ ) |const| | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -97,8 +97,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_echo** **(** :ref:`bool` value **)** -- :ref:`bool` **is_echo** **(** **)** +- |void| **set_echo**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_echo**\ (\ ) If ``true``, the key was already pressed before this event. It means the user is holding the key down. @@ -114,8 +114,8 @@ If ``true``, the key was already pressed before this event. It means the user is .. rst-class:: classref-property-setget -- void **set_key_label** **(** :ref:`Key` value **)** -- :ref:`Key` **get_key_label** **(** **)** +- |void| **set_key_label**\ (\ value\: :ref:`Key`\ ) +- :ref:`Key` **get_key_label**\ (\ ) Represents the localized label printed on the key in the current keyboard layout, which corresponds to one of the :ref:`Key` constants or any valid Unicode character. @@ -142,8 +142,8 @@ To get a human-readable representation of the **InputEventKey**, use ``OS.get_ke .. rst-class:: classref-property-setget -- void **set_keycode** **(** :ref:`Key` value **)** -- :ref:`Key` **get_keycode** **(** **)** +- |void| **set_keycode**\ (\ value\: :ref:`Key`\ ) +- :ref:`Key` **get_keycode**\ (\ ) Latin label printed on the key in the current keyboard layout, which corresponds to one of the :ref:`Key` constants. @@ -168,8 +168,8 @@ To get a human-readable representation of the **InputEventKey**, use ``OS.get_ke .. rst-class:: classref-property-setget -- void **set_location** **(** :ref:`KeyLocation` value **)** -- :ref:`KeyLocation` **get_location** **(** **)** +- |void| **set_location**\ (\ value\: :ref:`KeyLocation`\ ) +- :ref:`KeyLocation` **get_location**\ (\ ) Represents the location of a key which has both left and right versions, such as :kbd:`Shift` or :kbd:`Alt`. @@ -185,8 +185,8 @@ Represents the location of a key which has both left and right versions, such as .. rst-class:: classref-property-setget -- void **set_physical_keycode** **(** :ref:`Key` value **)** -- :ref:`Key` **get_physical_keycode** **(** **)** +- |void| **set_physical_keycode**\ (\ value\: :ref:`Key`\ ) +- :ref:`Key` **get_physical_keycode**\ (\ ) Represents the physical location of a key on the 101/102-key US QWERTY keyboard, which corresponds to one of the :ref:`Key` constants. @@ -227,8 +227,8 @@ To get a human-readable representation of the **InputEventKey**, use :ref:`OS.ge .. rst-class:: classref-property-setget -- void **set_pressed** **(** :ref:`bool` value **)** -- :ref:`bool` **is_pressed** **(** **)** +- |void| **set_pressed**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_pressed**\ (\ ) If ``true``, the key's state is pressed. If ``false``, the key's state is released. @@ -244,8 +244,8 @@ If ``true``, the key's state is pressed. If ``false``, the key's state is releas .. rst-class:: classref-property-setget -- void **set_unicode** **(** :ref:`int` value **)** -- :ref:`int` **get_unicode** **(** **)** +- |void| **set_unicode**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_unicode**\ (\ ) The key Unicode character code (when relevant), shifted by modifier keys. Unicode character codes for composite characters and complex scripts may not be available unless IME input mode is active. See :ref:`Window.set_ime_active` for more information. @@ -262,7 +262,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **as_text_key_label** **(** **)** |const| +:ref:`String` **as_text_key_label**\ (\ ) |const| Returns a :ref:`String` representation of the event's :ref:`key_label` and modifiers. @@ -274,7 +274,7 @@ Returns a :ref:`String` representation of the event's :ref:`key_la .. rst-class:: classref-method -:ref:`String` **as_text_keycode** **(** **)** |const| +:ref:`String` **as_text_keycode**\ (\ ) |const| Returns a :ref:`String` representation of the event's :ref:`keycode` and modifiers. @@ -286,7 +286,7 @@ Returns a :ref:`String` representation of the event's :ref:`keycod .. rst-class:: classref-method -:ref:`String` **as_text_location** **(** **)** |const| +:ref:`String` **as_text_location**\ (\ ) |const| Returns a :ref:`String` representation of the event's :ref:`location`. This will be a blank string if the event is not specific to a location. @@ -298,7 +298,7 @@ Returns a :ref:`String` representation of the event's :ref:`locati .. rst-class:: classref-method -:ref:`String` **as_text_physical_keycode** **(** **)** |const| +:ref:`String` **as_text_physical_keycode**\ (\ ) |const| Returns a :ref:`String` representation of the event's :ref:`physical_keycode` and modifiers. @@ -310,7 +310,7 @@ Returns a :ref:`String` representation of the event's :ref:`physic .. rst-class:: classref-method -:ref:`Key` **get_key_label_with_modifiers** **(** **)** |const| +:ref:`Key` **get_key_label_with_modifiers**\ (\ ) |const| Returns the localized key label combined with modifier keys such as :kbd:`Shift` or :kbd:`Alt`. See also :ref:`InputEventWithModifiers`. @@ -324,7 +324,7 @@ To get a human-readable representation of the **InputEventKey** with modifiers, .. rst-class:: classref-method -:ref:`Key` **get_keycode_with_modifiers** **(** **)** |const| +:ref:`Key` **get_keycode_with_modifiers**\ (\ ) |const| Returns the Latin keycode combined with modifier keys such as :kbd:`Shift` or :kbd:`Alt`. See also :ref:`InputEventWithModifiers`. @@ -338,7 +338,7 @@ To get a human-readable representation of the **InputEventKey** with modifiers, .. rst-class:: classref-method -:ref:`Key` **get_physical_keycode_with_modifiers** **(** **)** |const| +:ref:`Key` **get_physical_keycode_with_modifiers**\ (\ ) |const| Returns the physical keycode combined with modifier keys such as :kbd:`Shift` or :kbd:`Alt`. See also :ref:`InputEventWithModifiers`. @@ -351,3 +351,4 @@ To get a human-readable representation of the **InputEventKey** with modifiers, .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_inputeventmagnifygesture.rst b/classes/class_inputeventmagnifygesture.rst index e713ee6a539..1287a65470b 100644 --- a/classes/class_inputeventmagnifygesture.rst +++ b/classes/class_inputeventmagnifygesture.rst @@ -59,8 +59,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_factor** **(** :ref:`float` value **)** -- :ref:`float` **get_factor** **(** **)** +- |void| **set_factor**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_factor**\ (\ ) The amount (or delta) of the event. This value is closer to ``1.0`` the slower the gesture is performed. @@ -71,3 +71,4 @@ The amount (or delta) of the event. This value is closer to ``1.0`` the slower t .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_inputeventmidi.rst b/classes/class_inputeventmidi.rst index c68c144d91e..7c94617dbd7 100644 --- a/classes/class_inputeventmidi.rst +++ b/classes/class_inputeventmidi.rst @@ -136,8 +136,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_channel** **(** :ref:`int` value **)** -- :ref:`int` **get_channel** **(** **)** +- |void| **set_channel**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_channel**\ (\ ) The MIDI channel of this message, ranging from ``0`` to ``15``. MIDI channel ``9`` is reserved for percussion instruments. @@ -153,8 +153,8 @@ The MIDI channel of this message, ranging from ``0`` to ``15``. MIDI channel ``9 .. rst-class:: classref-property-setget -- void **set_controller_number** **(** :ref:`int` value **)** -- :ref:`int` **get_controller_number** **(** **)** +- |void| **set_controller_number**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_controller_number**\ (\ ) The unique number of the controller, if :ref:`message` is :ref:`@GlobalScope.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 `__ for a small list. @@ -170,8 +170,8 @@ The unique number of the controller, if :ref:`message` value **)** -- :ref:`int` **get_controller_value** **(** **)** +- |void| **set_controller_value**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_controller_value**\ (\ ) The value applied to the controller. If :ref:`message` is :ref:`@GlobalScope.MIDI_MESSAGE_CONTROL_CHANGE`, this value ranges from ``0`` to ``127``, otherwise it is ``0``. See also :ref:`controller_value`. @@ -187,8 +187,8 @@ The value applied to the controller. If :ref:`message` value **)** -- :ref:`int` **get_instrument** **(** **)** +- |void| **set_instrument**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_instrument**\ (\ ) The instrument (also called *program* or *preset*) used on this MIDI message. This value ranges from ``0`` to ``127``. @@ -206,8 +206,8 @@ To see what each value means, refer to the `General MIDI's instrument list ` value **)** -- :ref:`MIDIMessage` **get_message** **(** **)** +- |void| **set_message**\ (\ value\: :ref:`MIDIMessage`\ ) +- :ref:`MIDIMessage` **get_message**\ (\ ) Represents the type of MIDI message (see the :ref:`MIDIMessage` enum). @@ -225,8 +225,8 @@ For more information, see the `MIDI message status byte list chart ` value **)** -- :ref:`int` **get_pitch** **(** **)** +- |void| **set_pitch**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_pitch**\ (\ ) The pitch index number of this MIDI message. This value ranges from ``0`` to ``127``. @@ -244,8 +244,8 @@ On a piano, the **middle C** is ``60``, followed by a **C-sharp** (``61``), then .. rst-class:: classref-property-setget -- void **set_pressure** **(** :ref:`int` value **)** -- :ref:`int` **get_pressure** **(** **)** +- |void| **set_pressure**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_pressure**\ (\ ) The strength of the key being pressed. This value ranges from ``0`` to ``127``. @@ -263,8 +263,8 @@ The strength of the key being pressed. This value ranges from ``0`` to ``127``. .. rst-class:: classref-property-setget -- void **set_velocity** **(** :ref:`int` value **)** -- :ref:`int` **get_velocity** **(** **)** +- |void| **set_velocity**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_velocity**\ (\ ) 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. @@ -284,3 +284,4 @@ The velocity of the MIDI message. This value ranges from ``0`` to ``127``. For a .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst index bc5101d31f2..ef00a730f93 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -39,7 +39,7 @@ Properties :widths: auto +-------------------------------------------------------------------------+------------------------------------------------------------------------+-------------------+ - | |bitfield|\<:ref:`MouseButtonMask`\> | :ref:`button_mask` | ``0`` | + | |bitfield|\[:ref:`MouseButtonMask`\] | :ref:`button_mask` | ``0`` | +-------------------------------------------------------------------------+------------------------------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`global_position` | ``Vector2(0, 0)`` | +-------------------------------------------------------------------------+------------------------------------------------------------------------+-------------------+ @@ -59,12 +59,12 @@ Property Descriptions .. rst-class:: classref-property -|bitfield|\<:ref:`MouseButtonMask`\> **button_mask** = ``0`` +|bitfield|\[:ref:`MouseButtonMask`\] **button_mask** = ``0`` .. rst-class:: classref-property-setget -- void **set_button_mask** **(** |bitfield|\<:ref:`MouseButtonMask`\> value **)** -- |bitfield|\<:ref:`MouseButtonMask`\> **get_button_mask** **(** **)** +- |void| **set_button_mask**\ (\ value\: |bitfield|\[:ref:`MouseButtonMask`\]\ ) +- |bitfield|\[:ref:`MouseButtonMask`\] **get_button_mask**\ (\ ) The mouse button mask identifier, one of or a bitwise combination of the :ref:`MouseButton` button masks. @@ -80,8 +80,8 @@ The mouse button mask identifier, one of or a bitwise combination of the :ref:`M .. rst-class:: classref-property-setget -- void **set_global_position** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_global_position** **(** **)** +- |void| **set_global_position**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_global_position**\ (\ ) When received in :ref:`Node._input` or :ref:`Node._unhandled_input`, returns the mouse's position in the root :ref:`Viewport` using the coordinate system of the root :ref:`Viewport`. @@ -99,8 +99,8 @@ When received in :ref:`Control._gui_input` value **)** -- :ref:`Vector2` **get_position** **(** **)** +- |void| **set_position**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_position**\ (\ ) When received in :ref:`Node._input` or :ref:`Node._unhandled_input`, returns the mouse's position in the :ref:`Viewport` this :ref:`Node` is in using the coordinate system of this :ref:`Viewport`. @@ -113,3 +113,4 @@ When received in :ref:`Control._gui_input` value **)** -- :ref:`MouseButton` **get_button_index** **(** **)** +- |void| **set_button_index**\ (\ value\: :ref:`MouseButton`\ ) +- :ref:`MouseButton` **get_button_index**\ (\ ) The mouse button identifier, one of the :ref:`MouseButton` button or button wheel constants. @@ -89,8 +89,8 @@ The mouse button identifier, one of the :ref:`MouseButton` value **)** -- :ref:`bool` **is_canceled** **(** **)** +- |void| **set_canceled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_canceled**\ (\ ) If ``true``, the mouse button event has been canceled. @@ -106,8 +106,8 @@ If ``true``, the mouse button event has been canceled. .. rst-class:: classref-property-setget -- void **set_double_click** **(** :ref:`bool` value **)** -- :ref:`bool` **is_double_click** **(** **)** +- |void| **set_double_click**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_double_click**\ (\ ) If ``true``, the mouse button's state is a double-click. @@ -123,8 +123,8 @@ If ``true``, the mouse button's state is a double-click. .. rst-class:: classref-property-setget -- void **set_factor** **(** :ref:`float` value **)** -- :ref:`float` **get_factor** **(** **)** +- |void| **set_factor**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_factor**\ (\ ) The amount (or delta) of the event. When used for high-precision scroll events, this indicates the scroll amount (vertical or horizontal). This is only supported on some platforms; the reported sensitivity varies depending on the platform. May be ``0`` if not supported. @@ -140,8 +140,8 @@ The amount (or delta) of the event. When used for high-precision scroll events, .. rst-class:: classref-property-setget -- void **set_pressed** **(** :ref:`bool` value **)** -- :ref:`bool` **is_pressed** **(** **)** +- |void| **set_pressed**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_pressed**\ (\ ) If ``true``, the mouse button's state is pressed. If ``false``, the mouse button's state is released. @@ -152,3 +152,4 @@ If ``true``, the mouse button's state is pressed. If ``false``, the mouse button .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index f28b1636b2f..5cb1f622398 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -75,8 +75,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_pen_inverted** **(** :ref:`bool` value **)** -- :ref:`bool` **get_pen_inverted** **(** **)** +- |void| **set_pen_inverted**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_pen_inverted**\ (\ ) Returns ``true`` when using the eraser end of a stylus pen. @@ -94,8 +94,8 @@ Returns ``true`` when using the eraser end of a stylus pen. .. rst-class:: classref-property-setget -- void **set_pressure** **(** :ref:`float` value **)** -- :ref:`float` **get_pressure** **(** **)** +- |void| **set_pressure**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pressure**\ (\ ) Represents the pressure the user puts on the pen. Ranges from ``0.0`` to ``1.0``. @@ -111,8 +111,8 @@ Represents the pressure the user puts on the pen. Ranges from ``0.0`` to ``1.0`` .. rst-class:: classref-property-setget -- void **set_relative** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_relative** **(** **)** +- |void| **set_relative**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_relative**\ (\ ) The mouse position relative to the previous position (position at the last frame). @@ -132,8 +132,8 @@ The mouse position relative to the previous position (position at the last frame .. rst-class:: classref-property-setget -- void **set_screen_relative** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_screen_relative** **(** **)** +- |void| **set_screen_relative**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_screen_relative**\ (\ ) The unscaled mouse position relative to the previous position in the coordinate system of the screen (position at the last frame). @@ -151,8 +151,8 @@ The unscaled mouse position relative to the previous position in the coordinate .. rst-class:: classref-property-setget -- void **set_screen_velocity** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_screen_velocity** **(** **)** +- |void| **set_screen_velocity**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_screen_velocity**\ (\ ) The unscaled mouse velocity in pixels per second in screen coordinates. This velocity is *not* scaled according to the content scale factor or calls to :ref:`InputEvent.xformed_by`. This should be preferred over :ref:`velocity` for mouse aiming when using the :ref:`Input.MOUSE_MODE_CAPTURED` mouse mode, regardless of the project's stretch mode. @@ -168,8 +168,8 @@ The unscaled mouse velocity in pixels per second in screen coordinates. This vel .. rst-class:: classref-property-setget -- void **set_tilt** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_tilt** **(** **)** +- |void| **set_tilt**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_tilt**\ (\ ) Represents the angles of tilt of the pen. Positive X-coordinate value indicates a tilt to the right. Positive Y-coordinate value indicates a tilt toward the user. Ranges from ``-1.0`` to ``1.0`` for both axes. @@ -185,8 +185,8 @@ Represents the angles of tilt of the pen. Positive X-coordinate value indicates .. rst-class:: classref-property-setget -- void **set_velocity** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_velocity** **(** **)** +- |void| **set_velocity**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_velocity**\ (\ ) The mouse velocity in pixels per second. @@ -199,3 +199,4 @@ The mouse velocity in pixels per second. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_inputeventpangesture.rst b/classes/class_inputeventpangesture.rst index 4da467b1893..fc3edea6c7e 100644 --- a/classes/class_inputeventpangesture.rst +++ b/classes/class_inputeventpangesture.rst @@ -59,8 +59,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_delta** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_delta** **(** **)** +- |void| **set_delta**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_delta**\ (\ ) Panning amount since last pan event. @@ -71,3 +71,4 @@ Panning amount since last pan event. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index 83d62ca1131..15390c5fa52 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -73,8 +73,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_index** **(** :ref:`int` value **)** -- :ref:`int` **get_index** **(** **)** +- |void| **set_index**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_index**\ (\ ) The drag event index in the case of a multi-drag event. @@ -90,8 +90,8 @@ The drag event index in the case of a multi-drag event. .. rst-class:: classref-property-setget -- void **set_pen_inverted** **(** :ref:`bool` value **)** -- :ref:`bool` **get_pen_inverted** **(** **)** +- |void| **set_pen_inverted**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_pen_inverted**\ (\ ) Returns ``true`` when using the eraser end of a stylus pen. @@ -107,8 +107,8 @@ Returns ``true`` when using the eraser end of a stylus pen. .. rst-class:: classref-property-setget -- void **set_position** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_position** **(** **)** +- |void| **set_position**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_position**\ (\ ) The drag position. @@ -124,8 +124,8 @@ The drag position. .. rst-class:: classref-property-setget -- void **set_pressure** **(** :ref:`float` value **)** -- :ref:`float` **get_pressure** **(** **)** +- |void| **set_pressure**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pressure**\ (\ ) Represents the pressure the user puts on the pen. Ranges from ``0.0`` to ``1.0``. @@ -141,8 +141,8 @@ Represents the pressure the user puts on the pen. Ranges from ``0.0`` to ``1.0`` .. rst-class:: classref-property-setget -- void **set_relative** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_relative** **(** **)** +- |void| **set_relative**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_relative**\ (\ ) The drag position relative to the previous position (position at the last frame). @@ -160,8 +160,8 @@ The drag position relative to the previous position (position at the last frame) .. rst-class:: classref-property-setget -- void **set_screen_relative** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_screen_relative** **(** **)** +- |void| **set_screen_relative**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_screen_relative**\ (\ ) The unscaled drag position relative to the previous position in screen coordinates (position at the last frame). This position is *not* scaled according to the content scale factor or calls to :ref:`InputEvent.xformed_by`. This should be preferred over :ref:`relative` for touch aiming regardless of the project's stretch mode. @@ -177,8 +177,8 @@ The unscaled drag position relative to the previous position in screen coordinat .. rst-class:: classref-property-setget -- void **set_screen_velocity** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_screen_velocity** **(** **)** +- |void| **set_screen_velocity**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_screen_velocity**\ (\ ) The unscaled drag velocity in pixels per second in screen coordinates. This velocity is *not* scaled according to the content scale factor or calls to :ref:`InputEvent.xformed_by`. This should be preferred over :ref:`velocity` for touch aiming regardless of the project's stretch mode. @@ -194,8 +194,8 @@ The unscaled drag velocity in pixels per second in screen coordinates. This velo .. rst-class:: classref-property-setget -- void **set_tilt** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_tilt** **(** **)** +- |void| **set_tilt**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_tilt**\ (\ ) Represents the angles of tilt of the pen. Positive X-coordinate value indicates a tilt to the right. Positive Y-coordinate value indicates a tilt toward the user. Ranges from ``-1.0`` to ``1.0`` for both axes. @@ -211,8 +211,8 @@ Represents the angles of tilt of the pen. Positive X-coordinate value indicates .. rst-class:: classref-property-setget -- void **set_velocity** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_velocity** **(** **)** +- |void| **set_velocity**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_velocity**\ (\ ) The drag velocity. @@ -225,3 +225,4 @@ The drag velocity. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index c7e4ee170c5..e3459a9ab01 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -65,8 +65,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_canceled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_canceled** **(** **)** +- |void| **set_canceled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_canceled**\ (\ ) If ``true``, the touch event has been canceled. @@ -82,8 +82,8 @@ If ``true``, the touch event has been canceled. .. rst-class:: classref-property-setget -- void **set_double_tap** **(** :ref:`bool` value **)** -- :ref:`bool` **is_double_tap** **(** **)** +- |void| **set_double_tap**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_double_tap**\ (\ ) If ``true``, the touch's state is a double tap. @@ -99,8 +99,8 @@ If ``true``, the touch's state is a double tap. .. rst-class:: classref-property-setget -- void **set_index** **(** :ref:`int` value **)** -- :ref:`int` **get_index** **(** **)** +- |void| **set_index**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_index**\ (\ ) The touch index in the case of a multi-touch event. One index = one finger. @@ -116,8 +116,8 @@ The touch index in the case of a multi-touch event. One index = one finger. .. rst-class:: classref-property-setget -- void **set_position** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_position** **(** **)** +- |void| **set_position**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_position**\ (\ ) The touch position, in screen (global) coordinates. @@ -133,8 +133,8 @@ The touch position, in screen (global) coordinates. .. rst-class:: classref-property-setget -- void **set_pressed** **(** :ref:`bool` value **)** -- :ref:`bool` **is_pressed** **(** **)** +- |void| **set_pressed**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_pressed**\ (\ ) If ``true``, the touch's state is pressed. If ``false``, the touch's state is released. @@ -145,3 +145,4 @@ If ``true``, the touch's state is pressed. If ``false``, the touch's state is re .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_inputeventshortcut.rst b/classes/class_inputeventshortcut.rst index d405d4037f9..97fc7f725a9 100644 --- a/classes/class_inputeventshortcut.rst +++ b/classes/class_inputeventshortcut.rst @@ -50,8 +50,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_shortcut** **(** :ref:`Shortcut` value **)** -- :ref:`Shortcut` **get_shortcut** **(** **)** +- |void| **set_shortcut**\ (\ value\: :ref:`Shortcut`\ ) +- :ref:`Shortcut` **get_shortcut**\ (\ ) The :ref:`Shortcut` represented by this event. Its :ref:`Shortcut.matches_event` method will always return ``true`` for this event. @@ -62,3 +62,4 @@ The :ref:`Shortcut` represented by this event. Its :ref:`Shortcu .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index 10da1189bad..976a81da167 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -58,11 +58,11 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`KeyModifierMask`\> | :ref:`get_modifiers_mask` **(** **)** |const| | - +-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_command_or_control_pressed` **(** **)** |const| | - +-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`KeyModifierMask`\] | :ref:`get_modifiers_mask`\ (\ ) |const| | + +-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_command_or_control_pressed`\ (\ ) |const| | + +-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -81,8 +81,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_alt_pressed** **(** :ref:`bool` value **)** -- :ref:`bool` **is_alt_pressed** **(** **)** +- |void| **set_alt_pressed**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_alt_pressed**\ (\ ) State of the :kbd:`Alt` modifier. @@ -98,8 +98,8 @@ State of the :kbd:`Alt` modifier. .. rst-class:: classref-property-setget -- void **set_command_or_control_autoremap** **(** :ref:`bool` value **)** -- :ref:`bool` **is_command_or_control_autoremap** **(** **)** +- |void| **set_command_or_control_autoremap**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_command_or_control_autoremap**\ (\ ) Automatically use :kbd:`Meta` (:kbd:`Cmd`) on macOS and :kbd:`Ctrl` on other platforms. If ``true``, :ref:`ctrl_pressed` and :ref:`meta_pressed` cannot be set. @@ -115,8 +115,8 @@ Automatically use :kbd:`Meta` (:kbd:`Cmd`) on macOS and :kbd:`Ctrl` on other pla .. rst-class:: classref-property-setget -- void **set_ctrl_pressed** **(** :ref:`bool` value **)** -- :ref:`bool` **is_ctrl_pressed** **(** **)** +- |void| **set_ctrl_pressed**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_ctrl_pressed**\ (\ ) State of the :kbd:`Ctrl` modifier. @@ -132,8 +132,8 @@ State of the :kbd:`Ctrl` modifier. .. rst-class:: classref-property-setget -- void **set_meta_pressed** **(** :ref:`bool` value **)** -- :ref:`bool` **is_meta_pressed** **(** **)** +- |void| **set_meta_pressed**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_meta_pressed**\ (\ ) State of the :kbd:`Meta` modifier. On Windows and Linux, this represents the Windows key (sometimes called "meta" or "super" on Linux). On macOS, this represents the Command key. @@ -149,8 +149,8 @@ State of the :kbd:`Meta` modifier. On Windows and Linux, this represents the Win .. rst-class:: classref-property-setget -- void **set_shift_pressed** **(** :ref:`bool` value **)** -- :ref:`bool` **is_shift_pressed** **(** **)** +- |void| **set_shift_pressed**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_shift_pressed**\ (\ ) State of the :kbd:`Shift` modifier. @@ -167,7 +167,7 @@ Method Descriptions .. rst-class:: classref-method -|bitfield|\<:ref:`KeyModifierMask`\> **get_modifiers_mask** **(** **)** |const| +|bitfield|\[:ref:`KeyModifierMask`\] **get_modifiers_mask**\ (\ ) |const| Returns the keycode combination of modifier keys. @@ -179,7 +179,7 @@ Returns the keycode combination of modifier keys. .. rst-class:: classref-method -:ref:`bool` **is_command_or_control_pressed** **(** **)** |const| +:ref:`bool` **is_command_or_control_pressed**\ (\ ) |const| On macOS, returns ``true`` if :kbd:`Meta` (:kbd:`Cmd`) is pressed. @@ -192,3 +192,4 @@ On other platforms, returns ``true`` if :kbd:`Ctrl` is pressed. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index 9c172223cc9..1adf0c770ab 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -36,33 +36,33 @@ Methods .. table:: :widths: auto - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`action_add_event` **(** :ref:`StringName` action, :ref:`InputEvent` event **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`action_erase_event` **(** :ref:`StringName` action, :ref:`InputEvent` event **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`action_erase_events` **(** :ref:`StringName` action **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`action_get_deadzone` **(** :ref:`StringName` action **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`InputEvent[]` | :ref:`action_get_events` **(** :ref:`StringName` action **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`action_has_event` **(** :ref:`StringName` action, :ref:`InputEvent` event **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`action_set_deadzone` **(** :ref:`StringName` action, :ref:`float` deadzone **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_action` **(** :ref:`StringName` action, :ref:`float` deadzone=0.5 **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`erase_action` **(** :ref:`StringName` action **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`event_is_action` **(** :ref:`InputEvent` event, :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName[]` | :ref:`get_actions` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_action` **(** :ref:`StringName` action **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`load_from_project_settings` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`action_add_event`\ (\ action\: :ref:`StringName`, event\: :ref:`InputEvent`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`action_erase_event`\ (\ action\: :ref:`StringName`, event\: :ref:`InputEvent`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`action_erase_events`\ (\ action\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`action_get_deadzone`\ (\ action\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`InputEvent`\] | :ref:`action_get_events`\ (\ action\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`action_has_event`\ (\ action\: :ref:`StringName`, event\: :ref:`InputEvent`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`action_set_deadzone`\ (\ action\: :ref:`StringName`, deadzone\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_action`\ (\ action\: :ref:`StringName`, deadzone\: :ref:`float` = 0.5\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`erase_action`\ (\ action\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`event_is_action`\ (\ event\: :ref:`InputEvent`, action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`StringName`\] | :ref:`get_actions`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_action`\ (\ action\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`load_from_project_settings`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -77,7 +77,7 @@ Method Descriptions .. rst-class:: classref-method -void **action_add_event** **(** :ref:`StringName` action, :ref:`InputEvent` event **)** +|void| **action_add_event**\ (\ action\: :ref:`StringName`, event\: :ref:`InputEvent`\ ) Adds an :ref:`InputEvent` to an action. This :ref:`InputEvent` will trigger the action. @@ -89,7 +89,7 @@ Adds an :ref:`InputEvent` to an action. This :ref:`InputEvent< .. rst-class:: classref-method -void **action_erase_event** **(** :ref:`StringName` action, :ref:`InputEvent` event **)** +|void| **action_erase_event**\ (\ action\: :ref:`StringName`, event\: :ref:`InputEvent`\ ) Removes an :ref:`InputEvent` from an action. @@ -101,7 +101,7 @@ Removes an :ref:`InputEvent` from an action. .. rst-class:: classref-method -void **action_erase_events** **(** :ref:`StringName` action **)** +|void| **action_erase_events**\ (\ action\: :ref:`StringName`\ ) Removes all events from an action. @@ -113,7 +113,7 @@ Removes all events from an action. .. rst-class:: classref-method -:ref:`float` **action_get_deadzone** **(** :ref:`StringName` action **)** +:ref:`float` **action_get_deadzone**\ (\ action\: :ref:`StringName`\ ) Returns a deadzone value for the action. @@ -125,7 +125,7 @@ Returns a deadzone value for the action. .. rst-class:: classref-method -:ref:`InputEvent[]` **action_get_events** **(** :ref:`StringName` action **)** +:ref:`Array`\[:ref:`InputEvent`\] **action_get_events**\ (\ action\: :ref:`StringName`\ ) Returns an array of :ref:`InputEvent`\ s associated with a given action. @@ -139,7 +139,7 @@ Returns an array of :ref:`InputEvent`\ s associated with a giv .. rst-class:: classref-method -:ref:`bool` **action_has_event** **(** :ref:`StringName` action, :ref:`InputEvent` event **)** +:ref:`bool` **action_has_event**\ (\ action\: :ref:`StringName`, event\: :ref:`InputEvent`\ ) Returns ``true`` if the action has the given :ref:`InputEvent` associated with it. @@ -151,7 +151,7 @@ Returns ``true`` if the action has the given :ref:`InputEvent` .. rst-class:: classref-method -void **action_set_deadzone** **(** :ref:`StringName` action, :ref:`float` deadzone **)** +|void| **action_set_deadzone**\ (\ action\: :ref:`StringName`, deadzone\: :ref:`float`\ ) Sets a deadzone value for the action. @@ -163,7 +163,7 @@ Sets a deadzone value for the action. .. rst-class:: classref-method -void **add_action** **(** :ref:`StringName` action, :ref:`float` deadzone=0.5 **)** +|void| **add_action**\ (\ action\: :ref:`StringName`, deadzone\: :ref:`float` = 0.5\ ) Adds an empty action to the **InputMap** with a configurable ``deadzone``. @@ -177,7 +177,7 @@ An :ref:`InputEvent` can then be added to this action with :re .. rst-class:: classref-method -void **erase_action** **(** :ref:`StringName` action **)** +|void| **erase_action**\ (\ action\: :ref:`StringName`\ ) Removes an action from the **InputMap**. @@ -189,7 +189,7 @@ Removes an action from the **InputMap**. .. rst-class:: classref-method -:ref:`bool` **event_is_action** **(** :ref:`InputEvent` event, :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| +:ref:`bool` **event_is_action**\ (\ event\: :ref:`InputEvent`, action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| Returns ``true`` if the given event is part of an existing action. This method ignores keyboard modifiers if the given :ref:`InputEvent` is not pressed (for proper release detection). See :ref:`action_has_event` if you don't want this behavior. @@ -203,7 +203,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: .. rst-class:: classref-method -:ref:`StringName[]` **get_actions** **(** **)** +:ref:`Array`\[:ref:`StringName`\] **get_actions**\ (\ ) Returns an array of all actions in the **InputMap**. @@ -215,7 +215,7 @@ Returns an array of all actions in the **InputMap**. .. rst-class:: classref-method -:ref:`bool` **has_action** **(** :ref:`StringName` action **)** |const| +:ref:`bool` **has_action**\ (\ action\: :ref:`StringName`\ ) |const| Returns ``true`` if the **InputMap** has a registered action with the given name. @@ -227,7 +227,7 @@ Returns ``true`` if the **InputMap** has a registered action with the given name .. rst-class:: classref-method -void **load_from_project_settings** **(** **)** +|void| **load_from_project_settings**\ (\ ) Clears all :ref:`InputEventAction` in the **InputMap** and load it anew from :ref:`ProjectSettings`. @@ -238,3 +238,4 @@ Clears all :ref:`InputEventAction` in the **InputMap** a .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_instanceplaceholder.rst b/classes/class_instanceplaceholder.rst index d57409b6303..8df042defc1 100644 --- a/classes/class_instanceplaceholder.rst +++ b/classes/class_instanceplaceholder.rst @@ -31,13 +31,13 @@ Methods .. table:: :widths: auto - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`create_instance` **(** :ref:`bool` replace=false, :ref:`PackedScene` custom_scene=null **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_instance_path` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_stored_values` **(** :ref:`bool` with_order=false **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`create_instance`\ (\ replace\: :ref:`bool` = false, custom_scene\: :ref:`PackedScene` = null\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_instance_path`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_stored_values`\ (\ with_order\: :ref:`bool` = false\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -52,7 +52,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Node` **create_instance** **(** :ref:`bool` replace=false, :ref:`PackedScene` custom_scene=null **)** +:ref:`Node` **create_instance**\ (\ replace\: :ref:`bool` = false, custom_scene\: :ref:`PackedScene` = null\ ) Call this method to actually load in the node. The created node will be placed as a sibling *above* the **InstancePlaceholder** in the scene tree. The :ref:`Node`'s reference is also returned for convenience. @@ -66,7 +66,7 @@ Call this method to actually load in the node. The created node will be placed a .. rst-class:: classref-method -:ref:`String` **get_instance_path** **(** **)** |const| +:ref:`String` **get_instance_path**\ (\ ) |const| Gets the path to the :ref:`PackedScene` resource file that is loaded by default when calling :ref:`create_instance`. Not thread-safe. Use :ref:`Object.call_deferred` if calling from a thread. @@ -78,7 +78,7 @@ Gets the path to the :ref:`PackedScene` resource file that is .. rst-class:: classref-method -:ref:`Dictionary` **get_stored_values** **(** :ref:`bool` with_order=false **)** +:ref:`Dictionary` **get_stored_values**\ (\ with_order\: :ref:`bool` = false\ ) Returns the list of properties that will be applied to the node when :ref:`create_instance` is called. @@ -91,3 +91,4 @@ If ``with_order`` is ``true``, a key named ``.order`` (note the leading period) .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_int.rst b/classes/class_int.rst index edcdee797fa..42783ff8094 100644 --- a/classes/class_int.rst +++ b/classes/class_int.rst @@ -76,17 +76,17 @@ Constructors .. table:: :widths: auto - +-----------------------+------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`int` **(** **)** | - +-----------------------+------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`int` **(** :ref:`int` from **)** | - +-----------------------+------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`int` **(** :ref:`String` from **)** | - +-----------------------+------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`int` **(** :ref:`bool` from **)** | - +-----------------------+------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`int` **(** :ref:`float` from **)** | - +-----------------------+------------------------------------------------------------------------------------+ + +-----------------------+---------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`int`\ (\ ) | + +-----------------------+---------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`int`\ (\ from\: :ref:`int`\ ) | + +-----------------------+---------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`int`\ (\ from\: :ref:`String`\ ) | + +-----------------------+---------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`int`\ (\ from\: :ref:`bool`\ ) | + +-----------------------+---------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`int`\ (\ from\: :ref:`float`\ ) | + +-----------------------+---------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -96,85 +96,85 @@ Operators .. table:: :widths: auto - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`float` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`int` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator %` **(** :ref:`int` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator &` **(** :ref:`int` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`operator *` **(** :ref:`Color` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`operator *` **(** :ref:`Quaternion` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator *` **(** :ref:`Vector2` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`operator *` **(** :ref:`Vector2i` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator *` **(** :ref:`Vector3` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`operator *` **(** :ref:`Vector3i` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`operator *` **(** :ref:`Vector4` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`operator *` **(** :ref:`Vector4i` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator *` **(** :ref:`float` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator *` **(** :ref:`int` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator **` **(** :ref:`float` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator **` **(** :ref:`int` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator +` **(** :ref:`float` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator +` **(** :ref:`int` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator -` **(** :ref:`float` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator -` **(** :ref:`int` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator /` **(** :ref:`float` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator /` **(** :ref:`int` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<` **(** :ref:`float` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<` **(** :ref:`int` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator \<\<` **(** :ref:`int` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<=` **(** :ref:`float` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<=` **(** :ref:`int` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`float` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`int` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >` **(** :ref:`float` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >` **(** :ref:`int` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >=` **(** :ref:`float` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >=` **(** :ref:`int` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator >>` **(** :ref:`int` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator ^` **(** :ref:`int` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator unary+` **(** **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator unary-` **(** **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator |` **(** :ref:`int` right **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator ~` **(** **)** | - +-------------------------------------+------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator %`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator &`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`operator *`\ (\ right\: :ref:`Color`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`operator *`\ (\ right\: :ref:`Quaternion`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator *`\ (\ right\: :ref:`Vector2`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`operator *`\ (\ right\: :ref:`Vector2i`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator *`\ (\ right\: :ref:`Vector3`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`operator *`\ (\ right\: :ref:`Vector3i`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator *`\ (\ right\: :ref:`Vector4`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`operator *`\ (\ right\: :ref:`Vector4i`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator *`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator *`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator **`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator **`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator +`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator +`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator -`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator -`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator /`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator /`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator \<\<`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<=`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<=`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >=`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >=`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator >>`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator ^`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator unary+`\ (\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator unary-`\ (\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator |`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator ~`\ (\ ) | + +-------------------------------------+---------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -189,7 +189,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`int` **int** **(** **)** +:ref:`int` **int**\ (\ ) Constructs an **int** set to ``0``. @@ -199,7 +199,7 @@ Constructs an **int** set to ``0``. .. rst-class:: classref-constructor -:ref:`int` **int** **(** :ref:`int` from **)** +:ref:`int` **int**\ (\ from\: :ref:`int`\ ) Constructs an **int** as a copy of the given **int**. @@ -209,7 +209,7 @@ Constructs an **int** as a copy of the given **int**. .. rst-class:: classref-constructor -:ref:`int` **int** **(** :ref:`String` from **)** +:ref:`int` **int**\ (\ from\: :ref:`String`\ ) Constructs a new **int** from a :ref:`String`, following the same rules as :ref:`String.to_int`. @@ -219,7 +219,7 @@ Constructs a new **int** from a :ref:`String`, following the same .. rst-class:: classref-constructor -:ref:`int` **int** **(** :ref:`bool` from **)** +:ref:`int` **int**\ (\ from\: :ref:`bool`\ ) Constructs a new **int** from a :ref:`bool`. ``true`` is converted to ``1`` and ``false`` is converted to ``0``. @@ -229,7 +229,7 @@ Constructs a new **int** from a :ref:`bool`. ``true`` is converted t .. rst-class:: classref-constructor -:ref:`int` **int** **(** :ref:`float` from **)** +:ref:`int` **int**\ (\ from\: :ref:`float`\ ) Constructs a new **int** from a :ref:`float`. This will truncate the :ref:`float`, discarding anything after the floating point. @@ -246,7 +246,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`float` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`float`\ ) Returns ``true`` if the **int** is not equivalent to the :ref:`float`. @@ -258,7 +258,7 @@ Returns ``true`` if the **int** is not equivalent to the :ref:`float` **operator !=** **(** :ref:`int` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`int`\ ) Returns ``true`` if the **int**\ s are not equal. @@ -270,7 +270,7 @@ Returns ``true`` if the **int**\ s are not equal. .. rst-class:: classref-operator -:ref:`int` **operator %** **(** :ref:`int` right **)** +:ref:`int` **operator %**\ (\ right\: :ref:`int`\ ) Returns the remainder after dividing two **int**\ s. Uses truncated division, which returns a negative number if the dividend is negative. If this is not desired, consider using :ref:`@GlobalScope.posmod`. @@ -288,7 +288,7 @@ Returns the remainder after dividing two **int**\ s. Uses truncated division, wh .. rst-class:: classref-operator -:ref:`int` **operator &** **(** :ref:`int` right **)** +:ref:`int` **operator &**\ (\ right\: :ref:`int`\ ) Performs the bitwise ``AND`` operation. @@ -313,7 +313,7 @@ This is useful for retrieving binary flags from a variable. .. rst-class:: classref-operator -:ref:`Color` **operator *** **(** :ref:`Color` right **)** +:ref:`Color` **operator ***\ (\ right\: :ref:`Color`\ ) Multiplies each component of the :ref:`Color` by the **int**. @@ -325,7 +325,7 @@ Multiplies each component of the :ref:`Color` by the **int**. .. rst-class:: classref-operator -:ref:`Quaternion` **operator *** **(** :ref:`Quaternion` right **)** +:ref:`Quaternion` **operator ***\ (\ right\: :ref:`Quaternion`\ ) Multiplies each component of the :ref:`Quaternion` by the **int**. This operation is not meaningful on its own, but it can be used as a part of a larger expression. @@ -337,7 +337,7 @@ Multiplies each component of the :ref:`Quaternion` by the **in .. rst-class:: classref-operator -:ref:`Vector2` **operator *** **(** :ref:`Vector2` right **)** +:ref:`Vector2` **operator ***\ (\ right\: :ref:`Vector2`\ ) Multiplies each component of the :ref:`Vector2` by the **int**. @@ -353,7 +353,7 @@ Multiplies each component of the :ref:`Vector2` by the **int**. .. rst-class:: classref-operator -:ref:`Vector2i` **operator *** **(** :ref:`Vector2i` right **)** +:ref:`Vector2i` **operator ***\ (\ right\: :ref:`Vector2i`\ ) Multiplies each component of the :ref:`Vector2i` by the **int**. @@ -365,7 +365,7 @@ Multiplies each component of the :ref:`Vector2i` by the **int**. .. rst-class:: classref-operator -:ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3`\ ) Multiplies each component of the :ref:`Vector3` by the **int**. @@ -377,7 +377,7 @@ Multiplies each component of the :ref:`Vector3` by the **int**. .. rst-class:: classref-operator -:ref:`Vector3i` **operator *** **(** :ref:`Vector3i` right **)** +:ref:`Vector3i` **operator ***\ (\ right\: :ref:`Vector3i`\ ) Multiplies each component of the :ref:`Vector3i` by the **int**. @@ -389,7 +389,7 @@ Multiplies each component of the :ref:`Vector3i` by the **int**. .. rst-class:: classref-operator -:ref:`Vector4` **operator *** **(** :ref:`Vector4` right **)** +:ref:`Vector4` **operator ***\ (\ right\: :ref:`Vector4`\ ) Multiplies each component of the :ref:`Vector4` by the **int**. @@ -401,7 +401,7 @@ Multiplies each component of the :ref:`Vector4` by the **int**. .. rst-class:: classref-operator -:ref:`Vector4i` **operator *** **(** :ref:`Vector4i` right **)** +:ref:`Vector4i` **operator ***\ (\ right\: :ref:`Vector4i`\ ) Multiplies each component of the :ref:`Vector4i` by the **int**. @@ -413,7 +413,7 @@ Multiplies each component of the :ref:`Vector4i` by the **int**. .. rst-class:: classref-operator -:ref:`float` **operator *** **(** :ref:`float` right **)** +:ref:`float` **operator ***\ (\ right\: :ref:`float`\ ) Multiplies the :ref:`float` by the **int**. The result is a :ref:`float`. @@ -425,7 +425,7 @@ Multiplies the :ref:`float` by the **int**. The result is a :ref:`f .. rst-class:: classref-operator -:ref:`int` **operator *** **(** :ref:`int` right **)** +:ref:`int` **operator ***\ (\ right\: :ref:`int`\ ) Multiplies the two **int**\ s. @@ -437,7 +437,7 @@ Multiplies the two **int**\ s. .. rst-class:: classref-operator -:ref:`float` **operator **** **(** :ref:`float` right **)** +:ref:`float` **operator ****\ (\ right\: :ref:`float`\ ) Raises an **int** to a power of a :ref:`float`. The result is a :ref:`float`. @@ -453,7 +453,7 @@ Raises an **int** to a power of a :ref:`float`. The result is a :re .. rst-class:: classref-operator -:ref:`int` **operator **** **(** :ref:`int` right **)** +:ref:`int` **operator ****\ (\ right\: :ref:`int`\ ) Raises the left **int** to a power of the right **int**. @@ -469,7 +469,7 @@ Raises the left **int** to a power of the right **int**. .. rst-class:: classref-operator -:ref:`float` **operator +** **(** :ref:`float` right **)** +:ref:`float` **operator +**\ (\ right\: :ref:`float`\ ) Adds the **int** and the :ref:`float`. The result is a :ref:`float`. @@ -481,7 +481,7 @@ Adds the **int** and the :ref:`float`. The result is a :ref:`float< .. rst-class:: classref-operator -:ref:`int` **operator +** **(** :ref:`int` right **)** +:ref:`int` **operator +**\ (\ right\: :ref:`int`\ ) Adds the two **int**\ s. @@ -493,7 +493,7 @@ Adds the two **int**\ s. .. rst-class:: classref-operator -:ref:`float` **operator -** **(** :ref:`float` right **)** +:ref:`float` **operator -**\ (\ right\: :ref:`float`\ ) Subtracts the :ref:`float` from the **int**. The result is a :ref:`float`. @@ -505,7 +505,7 @@ Subtracts the :ref:`float` from the **int**. The result is a :ref:` .. rst-class:: classref-operator -:ref:`int` **operator -** **(** :ref:`int` right **)** +:ref:`int` **operator -**\ (\ right\: :ref:`int`\ ) Subtracts the two **int**\ s. @@ -517,7 +517,7 @@ Subtracts the two **int**\ s. .. rst-class:: classref-operator -:ref:`float` **operator /** **(** :ref:`float` right **)** +:ref:`float` **operator /**\ (\ right\: :ref:`float`\ ) Divides the **int** by the :ref:`float`. The result is a :ref:`float`. @@ -533,7 +533,7 @@ Divides the **int** by the :ref:`float`. The result is a :ref:`floa .. rst-class:: classref-operator -:ref:`int` **operator /** **(** :ref:`int` right **)** +:ref:`int` **operator /**\ (\ right\: :ref:`int`\ ) Divides the two **int**\ s. The result is an **int**. This will truncate the :ref:`float`, discarding anything after the floating point. @@ -550,7 +550,7 @@ Divides the two **int**\ s. The result is an **int**. This will truncate the :re .. rst-class:: classref-operator -:ref:`bool` **operator <** **(** :ref:`float` right **)** +:ref:`bool` **operator <**\ (\ right\: :ref:`float`\ ) Returns ``true`` if the **int** is less than the :ref:`float`. @@ -562,7 +562,7 @@ Returns ``true`` if the **int** is less than the :ref:`float`. .. rst-class:: classref-operator -:ref:`bool` **operator <** **(** :ref:`int` right **)** +:ref:`bool` **operator <**\ (\ right\: :ref:`int`\ ) Returns ``true`` if the left **int** is less than the right **int**. @@ -574,7 +574,7 @@ Returns ``true`` if the left **int** is less than the right **int**. .. rst-class:: classref-operator -:ref:`int` **operator <<** **(** :ref:`int` right **)** +:ref:`int` **operator <<**\ (\ right\: :ref:`int`\ ) Performs the bitwise shift left operation. Effectively the same as multiplying by a power of 2. @@ -591,7 +591,7 @@ Performs the bitwise shift left operation. Effectively the same as multiplying b .. rst-class:: classref-operator -:ref:`bool` **operator <=** **(** :ref:`float` right **)** +:ref:`bool` **operator <=**\ (\ right\: :ref:`float`\ ) Returns ``true`` if the **int** is less than or equal to the :ref:`float`. @@ -603,7 +603,7 @@ Returns ``true`` if the **int** is less than or equal to the :ref:`float` **operator <=** **(** :ref:`int` right **)** +:ref:`bool` **operator <=**\ (\ right\: :ref:`int`\ ) Returns ``true`` if the left **int** is less than or equal to the right **int**. @@ -615,7 +615,7 @@ Returns ``true`` if the left **int** is less than or equal to the right **int**. .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`float` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`float`\ ) Returns ``true`` if the **int** is equal to the :ref:`float`. @@ -627,7 +627,7 @@ Returns ``true`` if the **int** is equal to the :ref:`float`. .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`int` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`int`\ ) Returns ``true`` if the two **int**\ s are equal. @@ -639,7 +639,7 @@ Returns ``true`` if the two **int**\ s are equal. .. rst-class:: classref-operator -:ref:`bool` **operator >** **(** :ref:`float` right **)** +:ref:`bool` **operator >**\ (\ right\: :ref:`float`\ ) Returns ``true`` if the **int** is greater than the :ref:`float`. @@ -651,7 +651,7 @@ Returns ``true`` if the **int** is greater than the :ref:`float`. .. rst-class:: classref-operator -:ref:`bool` **operator >** **(** :ref:`int` right **)** +:ref:`bool` **operator >**\ (\ right\: :ref:`int`\ ) Returns ``true`` if the left **int** is greater than the right **int**. @@ -663,7 +663,7 @@ Returns ``true`` if the left **int** is greater than the right **int**. .. rst-class:: classref-operator -:ref:`bool` **operator >=** **(** :ref:`float` right **)** +:ref:`bool` **operator >=**\ (\ right\: :ref:`float`\ ) Returns ``true`` if the **int** is greater than or equal to the :ref:`float`. @@ -675,7 +675,7 @@ Returns ``true`` if the **int** is greater than or equal to the :ref:`float` **operator >=** **(** :ref:`int` right **)** +:ref:`bool` **operator >=**\ (\ right\: :ref:`int`\ ) Returns ``true`` if the left **int** is greater than or equal to the right **int**. @@ -687,7 +687,7 @@ Returns ``true`` if the left **int** is greater than or equal to the right **int .. rst-class:: classref-operator -:ref:`int` **operator >>** **(** :ref:`int` right **)** +:ref:`int` **operator >>**\ (\ right\: :ref:`int`\ ) Performs the bitwise shift right operation. Effectively the same as dividing by a power of 2. @@ -704,7 +704,7 @@ Performs the bitwise shift right operation. Effectively the same as dividing by .. rst-class:: classref-operator -:ref:`int` **operator ^** **(** :ref:`int` right **)** +:ref:`int` **operator ^**\ (\ right\: :ref:`int`\ ) Performs the bitwise ``XOR`` operation. @@ -720,7 +720,7 @@ Performs the bitwise ``XOR`` operation. .. rst-class:: classref-operator -:ref:`int` **operator unary+** **(** **)** +:ref:`int` **operator unary+**\ (\ ) Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -732,7 +732,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`int` **operator unary-** **(** **)** +:ref:`int` **operator unary-**\ (\ ) Returns the negated value of the **int**. If positive, turns the number negative. If negative, turns the number positive. If zero, does nothing. @@ -744,7 +744,7 @@ Returns the negated value of the **int**. If positive, turns the number negative .. rst-class:: classref-operator -:ref:`int` **operator |** **(** :ref:`int` right **)** +:ref:`int` **operator |**\ (\ right\: :ref:`int`\ ) Performs the bitwise ``OR`` operation. @@ -767,7 +767,7 @@ This is useful for storing binary flags in a variable. .. rst-class:: classref-operator -:ref:`int` **operator ~** **(** **)** +:ref:`int` **operator ~**\ (\ ) Performs the bitwise ``NOT`` operation on the **int**. Due to `2's complement `__, it's effectively equal to ``-(int + 1)``. @@ -783,3 +783,4 @@ Performs the bitwise ``NOT`` operation on the **int**. Due to `2's complement ` **(** :ref:`String` hostname="" **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`erase_resolve_item` **(** :ref:`int` id **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_local_addresses` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`get_local_interfaces` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_resolve_item_address` **(** :ref:`int` id **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_resolve_item_addresses` **(** :ref:`int` id **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ResolverStatus` | :ref:`get_resolve_item_status` **(** :ref:`int` id **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`resolve_hostname` **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`resolve_hostname_addresses` **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resolve_hostname_queue_item` **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_cache`\ (\ hostname\: :ref:`String` = ""\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`erase_resolve_item`\ (\ id\: :ref:`int`\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_local_addresses`\ (\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_local_interfaces`\ (\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_resolve_item_address`\ (\ id\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_resolve_item_addresses`\ (\ id\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ResolverStatus` | :ref:`get_resolve_item_status`\ (\ id\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`resolve_hostname`\ (\ host\: :ref:`String`, ip_type\: :ref:`Type` = 3\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`resolve_hostname_addresses`\ (\ host\: :ref:`String`, ip_type\: :ref:`Type` = 3\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resolve_hostname_queue_item`\ (\ host\: :ref:`String`, ip_type\: :ref:`Type` = 3\ ) | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -178,7 +181,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear_cache** **(** :ref:`String` hostname="" **)** +|void| **clear_cache**\ (\ hostname\: :ref:`String` = ""\ ) Removes all of a ``hostname``'s cached references. If no ``hostname`` is given, all cached IP addresses are removed. @@ -190,7 +193,7 @@ Removes all of a ``hostname``'s cached references. If no ``hostname`` is given, .. rst-class:: classref-method -void **erase_resolve_item** **(** :ref:`int` id **)** +|void| **erase_resolve_item**\ (\ id\: :ref:`int`\ ) Removes a given item ``id`` from the queue. This should be used to free a queue after it has completed to enable more queries to happen. @@ -202,7 +205,7 @@ Removes a given item ``id`` from the queue. This should be used to free a queue .. rst-class:: classref-method -:ref:`PackedStringArray` **get_local_addresses** **(** **)** |const| +:ref:`PackedStringArray` **get_local_addresses**\ (\ ) |const| Returns all the user's current IPv4 and IPv6 addresses as an array. @@ -214,7 +217,7 @@ Returns all the user's current IPv4 and IPv6 addresses as an array. .. rst-class:: classref-method -:ref:`Dictionary[]` **get_local_interfaces** **(** **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_local_interfaces**\ (\ ) |const| Returns all network adapters as an array. @@ -237,7 +240,7 @@ Each adapter is a dictionary of the form: .. rst-class:: classref-method -:ref:`String` **get_resolve_item_address** **(** :ref:`int` id **)** |const| +:ref:`String` **get_resolve_item_address**\ (\ id\: :ref:`int`\ ) |const| Returns a queued hostname's IP address, given its queue ``id``. Returns an empty string on error or if resolution hasn't happened yet (see :ref:`get_resolve_item_status`). @@ -249,7 +252,7 @@ Returns a queued hostname's IP address, given its queue ``id``. Returns an empty .. rst-class:: classref-method -:ref:`Array` **get_resolve_item_addresses** **(** :ref:`int` id **)** |const| +:ref:`Array` **get_resolve_item_addresses**\ (\ id\: :ref:`int`\ ) |const| Returns resolved addresses, or an empty array if an error happened or resolution didn't happen yet (see :ref:`get_resolve_item_status`). @@ -261,7 +264,7 @@ Returns resolved addresses, or an empty array if an error happened or resolution .. rst-class:: classref-method -:ref:`ResolverStatus` **get_resolve_item_status** **(** :ref:`int` id **)** |const| +:ref:`ResolverStatus` **get_resolve_item_status**\ (\ id\: :ref:`int`\ ) |const| Returns a queued hostname's status as a :ref:`ResolverStatus` constant, given its queue ``id``. @@ -273,7 +276,7 @@ Returns a queued hostname's status as a :ref:`ResolverStatus` **resolve_hostname** **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** +:ref:`String` **resolve_hostname**\ (\ host\: :ref:`String`, ip_type\: :ref:`Type` = 3\ ) Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the :ref:`Type` constant given as ``ip_type``. @@ -285,7 +288,7 @@ Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type met .. rst-class:: classref-method -:ref:`PackedStringArray` **resolve_hostname_addresses** **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** +:ref:`PackedStringArray` **resolve_hostname_addresses**\ (\ host\: :ref:`String`, ip_type\: :ref:`Type` = 3\ ) Resolves a given hostname in a blocking way. Addresses are returned as an :ref:`Array` of IPv4 or IPv6 addresses depending on ``ip_type``. @@ -297,7 +300,7 @@ Resolves a given hostname in a blocking way. Addresses are returned as an :ref:` .. rst-class:: classref-method -:ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** +:ref:`int` **resolve_hostname_queue_item**\ (\ host\: :ref:`String`, ip_type\: :ref:`Type` = 3\ ) Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the :ref:`Type` constant given as ``ip_type``. Returns the queue ID if successful, or :ref:`RESOLVER_INVALID_ID` on error. @@ -308,3 +311,4 @@ Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 0fb2dd23303..17188cf860d 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -79,97 +79,97 @@ Methods .. table:: :widths: auto - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`add_icon_item` **(** :ref:`Texture2D` icon, :ref:`bool` selectable=true **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`add_item` **(** :ref:`String` text, :ref:`Texture2D` icon=null, :ref:`bool` selectable=true **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`deselect` **(** :ref:`int` idx **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`deselect_all` **(** **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`ensure_current_is_visible` **(** **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`force_update_list_size` **(** **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_at_position` **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** |const| | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_item_custom_bg_color` **(** :ref:`int` idx **)** |const| | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_item_custom_fg_color` **(** :ref:`int` idx **)** |const| | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_item_icon` **(** :ref:`int` idx **)** |const| | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_item_icon_modulate` **(** :ref:`int` idx **)** |const| | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_item_icon_region` **(** :ref:`int` idx **)** |const| | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_language` **(** :ref:`int` idx **)** |const| | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** |const| | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_item_rect` **(** :ref:`int` idx, :ref:`bool` expand=true **)** |const| | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** |const| | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TextDirection` | :ref:`get_item_text_direction` **(** :ref:`int` idx **)** |const| | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** |const| | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_selected_items` **(** **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VScrollBar` | :ref:`get_v_scroll_bar` **(** **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_anything_selected` **(** **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** |const| | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_icon_transposed` **(** :ref:`int` idx **)** |const| | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_selectable` **(** :ref:`int` idx **)** |const| | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_tooltip_enabled` **(** :ref:`int` idx **)** |const| | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_selected` **(** :ref:`int` idx **)** |const| | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_item` **(** :ref:`int` from_idx, :ref:`int` to_idx **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_item` **(** :ref:`int` idx **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`select` **(** :ref:`int` idx, :ref:`bool` single=true **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_custom_bg_color` **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_custom_fg_color` **(** :ref:`int` idx, :ref:`Color` custom_fg_color **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture2D` icon **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_icon_modulate` **(** :ref:`int` idx, :ref:`Color` modulate **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_icon_region` **(** :ref:`int` idx, :ref:`Rect2` rect **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_icon_transposed` **(** :ref:`int` idx, :ref:`bool` transposed **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_language` **(** :ref:`int` idx, :ref:`String` language **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_selectable` **(** :ref:`int` idx, :ref:`bool` selectable **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_text_direction` **(** :ref:`int` idx, :ref:`TextDirection` direction **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_tooltip_enabled` **(** :ref:`int` idx, :ref:`bool` enable **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`sort_items_by_text` **(** **)** | - +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`add_icon_item`\ (\ icon\: :ref:`Texture2D`, selectable\: :ref:`bool` = true\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`add_item`\ (\ text\: :ref:`String`, icon\: :ref:`Texture2D` = null, selectable\: :ref:`bool` = true\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`deselect`\ (\ idx\: :ref:`int`\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`deselect_all`\ (\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`ensure_current_is_visible`\ (\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_update_list_size`\ (\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_at_position`\ (\ position\: :ref:`Vector2`, exact\: :ref:`bool` = false\ ) |const| | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_item_custom_bg_color`\ (\ idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_item_custom_fg_color`\ (\ idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_item_icon`\ (\ idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_item_icon_modulate`\ (\ idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_item_icon_region`\ (\ idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_language`\ (\ idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_item_metadata`\ (\ idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_item_rect`\ (\ idx\: :ref:`int`, expand\: :ref:`bool` = true\ ) |const| | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_text`\ (\ idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`get_item_text_direction`\ (\ idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_tooltip`\ (\ idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_selected_items`\ (\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`VScrollBar` | :ref:`get_v_scroll_bar`\ (\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_anything_selected`\ (\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_disabled`\ (\ idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_icon_transposed`\ (\ idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_selectable`\ (\ idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_tooltip_enabled`\ (\ idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_selected`\ (\ idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_item`\ (\ from_idx\: :ref:`int`, to_idx\: :ref:`int`\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_item`\ (\ idx\: :ref:`int`\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select`\ (\ idx\: :ref:`int`, single\: :ref:`bool` = true\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_custom_bg_color`\ (\ idx\: :ref:`int`, custom_bg_color\: :ref:`Color`\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_custom_fg_color`\ (\ idx\: :ref:`int`, custom_fg_color\: :ref:`Color`\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_disabled`\ (\ idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon`\ (\ idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon_modulate`\ (\ idx\: :ref:`int`, modulate\: :ref:`Color`\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon_region`\ (\ idx\: :ref:`int`, rect\: :ref:`Rect2`\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon_transposed`\ (\ idx\: :ref:`int`, transposed\: :ref:`bool`\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_language`\ (\ idx\: :ref:`int`, language\: :ref:`String`\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_metadata`\ (\ idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_selectable`\ (\ idx\: :ref:`int`, selectable\: :ref:`bool`\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_text`\ (\ idx\: :ref:`int`, text\: :ref:`String`\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_text_direction`\ (\ idx\: :ref:`int`, direction\: :ref:`TextDirection`\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_tooltip`\ (\ idx\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_tooltip_enabled`\ (\ idx\: :ref:`int`, enable\: :ref:`bool`\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sort_items_by_text`\ (\ ) | + +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -232,7 +232,7 @@ Signals .. rst-class:: classref-signal -**empty_clicked** **(** :ref:`Vector2` at_position, :ref:`int` mouse_button_index **)** +**empty_clicked**\ (\ at_position\: :ref:`Vector2`, mouse_button_index\: :ref:`int`\ ) Triggered when any mouse click is issued within the rect of the list but on empty space. @@ -244,7 +244,7 @@ Triggered when any mouse click is issued within the rect of the list but on empt .. rst-class:: classref-signal -**item_activated** **(** :ref:`int` index **)** +**item_activated**\ (\ index\: :ref:`int`\ ) Triggered when specified list item is activated via double-clicking or by pressing :kbd:`Enter`. @@ -256,7 +256,7 @@ Triggered when specified list item is activated via double-clicking or by pressi .. rst-class:: classref-signal -**item_clicked** **(** :ref:`int` index, :ref:`Vector2` at_position, :ref:`int` mouse_button_index **)** +**item_clicked**\ (\ index\: :ref:`int`, at_position\: :ref:`Vector2`, mouse_button_index\: :ref:`int`\ ) Triggered when specified list item has been clicked with any mouse button. @@ -270,7 +270,7 @@ The click position is also provided to allow appropriate popup of context menus .. rst-class:: classref-signal -**item_selected** **(** :ref:`int` index **)** +**item_selected**\ (\ index\: :ref:`int`\ ) Triggered when specified item has been selected. @@ -284,7 +284,7 @@ Triggered when specified item has been selected. .. rst-class:: classref-signal -**multi_selected** **(** :ref:`int` index, :ref:`bool` selected **)** +**multi_selected**\ (\ index\: :ref:`int`, selected\: :ref:`bool`\ ) Triggered when a multiple selection is altered on a list allowing multiple selection. @@ -362,8 +362,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_allow_reselect** **(** :ref:`bool` value **)** -- :ref:`bool` **get_allow_reselect** **(** **)** +- |void| **set_allow_reselect**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_allow_reselect**\ (\ ) If ``true``, the currently selected item can be selected again. @@ -379,8 +379,8 @@ If ``true``, the currently selected item can be selected again. .. rst-class:: classref-property-setget -- void **set_allow_rmb_select** **(** :ref:`bool` value **)** -- :ref:`bool` **get_allow_rmb_select** **(** **)** +- |void| **set_allow_rmb_select**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_allow_rmb_select**\ (\ ) If ``true``, right mouse button click can select items. @@ -396,8 +396,8 @@ If ``true``, right mouse button click can select items. .. rst-class:: classref-property-setget -- void **set_allow_search** **(** :ref:`bool` value **)** -- :ref:`bool` **get_allow_search** **(** **)** +- |void| **set_allow_search**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_allow_search**\ (\ ) If ``true``, allows navigating the **ItemList** with letter keys through incremental search. @@ -413,8 +413,8 @@ If ``true``, allows navigating the **ItemList** with letter keys through increme .. rst-class:: classref-property-setget -- void **set_auto_height** **(** :ref:`bool` value **)** -- :ref:`bool` **has_auto_height** **(** **)** +- |void| **set_auto_height**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **has_auto_height**\ (\ ) If ``true``, the control will automatically resize the height to fit its content. @@ -430,8 +430,8 @@ If ``true``, the control will automatically resize the height to fit its content .. rst-class:: classref-property-setget -- void **set_fixed_column_width** **(** :ref:`int` value **)** -- :ref:`int` **get_fixed_column_width** **(** **)** +- |void| **set_fixed_column_width**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_fixed_column_width**\ (\ ) The width all columns will be adjusted to. @@ -449,8 +449,8 @@ A value of zero disables the adjustment, each item will have a width equal to th .. rst-class:: classref-property-setget -- void **set_fixed_icon_size** **(** :ref:`Vector2i` value **)** -- :ref:`Vector2i` **get_fixed_icon_size** **(** **)** +- |void| **set_fixed_icon_size**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_fixed_icon_size**\ (\ ) The size all icons will be adjusted to. @@ -468,8 +468,8 @@ If either X or Y component is not greater than zero, icon size won't be affected .. rst-class:: classref-property-setget -- void **set_icon_mode** **(** :ref:`IconMode` value **)** -- :ref:`IconMode` **get_icon_mode** **(** **)** +- |void| **set_icon_mode**\ (\ value\: :ref:`IconMode`\ ) +- :ref:`IconMode` **get_icon_mode**\ (\ ) The icon position, whether above or to the left of the text. See the :ref:`IconMode` constants. @@ -485,8 +485,8 @@ The icon position, whether above or to the left of the text. See the :ref:`IconM .. rst-class:: classref-property-setget -- void **set_icon_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_icon_scale** **(** **)** +- |void| **set_icon_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_icon_scale**\ (\ ) The scale of icon applied after :ref:`fixed_icon_size` and transposing takes effect. @@ -502,8 +502,8 @@ The scale of icon applied after :ref:`fixed_icon_size` value **)** -- :ref:`int` **get_item_count** **(** **)** +- |void| **set_item_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_item_count**\ (\ ) The number of items currently in the list. @@ -519,8 +519,8 @@ The number of items currently in the list. .. rst-class:: classref-property-setget -- void **set_max_columns** **(** :ref:`int` value **)** -- :ref:`int` **get_max_columns** **(** **)** +- |void| **set_max_columns**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_columns**\ (\ ) Maximum columns the list will have. @@ -540,8 +540,8 @@ A value of zero means unlimited columns, i.e. all items will be put in the same .. rst-class:: classref-property-setget -- void **set_max_text_lines** **(** :ref:`int` value **)** -- :ref:`int` **get_max_text_lines** **(** **)** +- |void| **set_max_text_lines**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_text_lines**\ (\ ) Maximum lines of text allowed in each item. Space will be reserved even when there is not enough lines of text to display. @@ -559,8 +559,8 @@ Maximum lines of text allowed in each item. Space will be reserved even when the .. rst-class:: classref-property-setget -- void **set_same_column_width** **(** :ref:`bool` value **)** -- :ref:`bool` **is_same_column_width** **(** **)** +- |void| **set_same_column_width**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_same_column_width**\ (\ ) Whether all columns will have the same width. @@ -578,8 +578,8 @@ If ``true``, the width is equal to the largest column width of all columns. .. rst-class:: classref-property-setget -- void **set_select_mode** **(** :ref:`SelectMode` value **)** -- :ref:`SelectMode` **get_select_mode** **(** **)** +- |void| **set_select_mode**\ (\ value\: :ref:`SelectMode`\ ) +- :ref:`SelectMode` **get_select_mode**\ (\ ) Allows single or multiple item selection. See the :ref:`SelectMode` constants. @@ -595,8 +595,8 @@ Allows single or multiple item selection. See the :ref:`SelectMode` value **)** -- :ref:`OverrunBehavior` **get_text_overrun_behavior** **(** **)** +- |void| **set_text_overrun_behavior**\ (\ value\: :ref:`OverrunBehavior`\ ) +- :ref:`OverrunBehavior` **get_text_overrun_behavior**\ (\ ) Sets the clipping behavior when the text exceeds an item's bounding rectangle. See :ref:`OverrunBehavior` for a description of all modes. @@ -613,7 +613,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **add_icon_item** **(** :ref:`Texture2D` icon, :ref:`bool` selectable=true **)** +:ref:`int` **add_icon_item**\ (\ icon\: :ref:`Texture2D`, selectable\: :ref:`bool` = true\ ) Adds an item to the item list with no text, only an icon. Returns the index of an added item. @@ -625,7 +625,7 @@ Adds an item to the item list with no text, only an icon. Returns the index of a .. rst-class:: classref-method -:ref:`int` **add_item** **(** :ref:`String` text, :ref:`Texture2D` icon=null, :ref:`bool` selectable=true **)** +:ref:`int` **add_item**\ (\ text\: :ref:`String`, icon\: :ref:`Texture2D` = null, selectable\: :ref:`bool` = true\ ) Adds an item to the item list with specified text. Returns the index of an added item. @@ -641,7 +641,7 @@ If selectable is ``true``, the list item will be selectable. .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Removes all items from the list. @@ -653,7 +653,7 @@ Removes all items from the list. .. rst-class:: classref-method -void **deselect** **(** :ref:`int` idx **)** +|void| **deselect**\ (\ idx\: :ref:`int`\ ) Ensures the item associated with the specified index is not selected. @@ -665,7 +665,7 @@ Ensures the item associated with the specified index is not selected. .. rst-class:: classref-method -void **deselect_all** **(** **)** +|void| **deselect_all**\ (\ ) Ensures there are no items selected. @@ -677,7 +677,7 @@ Ensures there are no items selected. .. rst-class:: classref-method -void **ensure_current_is_visible** **(** **)** +|void| **ensure_current_is_visible**\ (\ ) Ensure current selection is visible, adjusting the scroll position as necessary. @@ -689,7 +689,7 @@ Ensure current selection is visible, adjusting the scroll position as necessary. .. rst-class:: classref-method -void **force_update_list_size** **(** **)** +|void| **force_update_list_size**\ (\ ) Forces an update to the list size based on its items. This happens automatically whenever size of the items, or other relevant settings like :ref:`auto_height`, change. The method can be used to trigger the update ahead of next drawing pass. @@ -701,7 +701,7 @@ Forces an update to the list size based on its items. This happens automatically .. rst-class:: classref-method -:ref:`int` **get_item_at_position** **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** |const| +:ref:`int` **get_item_at_position**\ (\ position\: :ref:`Vector2`, exact\: :ref:`bool` = false\ ) |const| Returns the item index at the given ``position``. @@ -717,7 +717,7 @@ When there is no item at that point, -1 will be returned if ``exact`` is ``true` .. rst-class:: classref-method -:ref:`Color` **get_item_custom_bg_color** **(** :ref:`int` idx **)** |const| +:ref:`Color` **get_item_custom_bg_color**\ (\ idx\: :ref:`int`\ ) |const| Returns the custom background color of the item specified by ``idx`` index. @@ -729,7 +729,7 @@ Returns the custom background color of the item specified by ``idx`` index. .. rst-class:: classref-method -:ref:`Color` **get_item_custom_fg_color** **(** :ref:`int` idx **)** |const| +:ref:`Color` **get_item_custom_fg_color**\ (\ idx\: :ref:`int`\ ) |const| Returns the custom foreground color of the item specified by ``idx`` index. @@ -741,7 +741,7 @@ Returns the custom foreground color of the item specified by ``idx`` index. .. rst-class:: classref-method -:ref:`Texture2D` **get_item_icon** **(** :ref:`int` idx **)** |const| +:ref:`Texture2D` **get_item_icon**\ (\ idx\: :ref:`int`\ ) |const| Returns the icon associated with the specified index. @@ -753,7 +753,7 @@ Returns the icon associated with the specified index. .. rst-class:: classref-method -:ref:`Color` **get_item_icon_modulate** **(** :ref:`int` idx **)** |const| +:ref:`Color` **get_item_icon_modulate**\ (\ idx\: :ref:`int`\ ) |const| Returns a :ref:`Color` modulating item's icon at the specified index. @@ -765,7 +765,7 @@ Returns a :ref:`Color` modulating item's icon at the specified inde .. rst-class:: classref-method -:ref:`Rect2` **get_item_icon_region** **(** :ref:`int` idx **)** |const| +:ref:`Rect2` **get_item_icon_region**\ (\ idx\: :ref:`int`\ ) |const| Returns the region of item's icon used. The whole icon will be used if the region has no area. @@ -777,7 +777,7 @@ Returns the region of item's icon used. The whole icon will be used if the regio .. rst-class:: classref-method -:ref:`String` **get_item_language** **(** :ref:`int` idx **)** |const| +:ref:`String` **get_item_language**\ (\ idx\: :ref:`int`\ ) |const| Returns item's text language code. @@ -789,7 +789,7 @@ Returns item's text language code. .. rst-class:: classref-method -:ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** |const| +:ref:`Variant` **get_item_metadata**\ (\ idx\: :ref:`int`\ ) |const| Returns the metadata value of the specified index. @@ -801,7 +801,7 @@ Returns the metadata value of the specified index. .. rst-class:: classref-method -:ref:`Rect2` **get_item_rect** **(** :ref:`int` idx, :ref:`bool` expand=true **)** |const| +:ref:`Rect2` **get_item_rect**\ (\ idx\: :ref:`int`, expand\: :ref:`bool` = true\ ) |const| Returns the position and size of the item with the specified index, in the coordinate system of the **ItemList** node. If ``expand`` is ``true`` the last column expands to fill the rest of the row. @@ -815,7 +815,7 @@ Returns the position and size of the item with the specified index, in the coord .. rst-class:: classref-method -:ref:`String` **get_item_text** **(** :ref:`int` idx **)** |const| +:ref:`String` **get_item_text**\ (\ idx\: :ref:`int`\ ) |const| Returns the text associated with the specified index. @@ -827,7 +827,7 @@ Returns the text associated with the specified index. .. rst-class:: classref-method -:ref:`TextDirection` **get_item_text_direction** **(** :ref:`int` idx **)** |const| +:ref:`TextDirection` **get_item_text_direction**\ (\ idx\: :ref:`int`\ ) |const| Returns item's text base writing direction. @@ -839,7 +839,7 @@ Returns item's text base writing direction. .. rst-class:: classref-method -:ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** |const| +:ref:`String` **get_item_tooltip**\ (\ idx\: :ref:`int`\ ) |const| Returns the tooltip hint associated with the specified index. @@ -851,7 +851,7 @@ Returns the tooltip hint associated with the specified index. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_selected_items** **(** **)** +:ref:`PackedInt32Array` **get_selected_items**\ (\ ) Returns an array with the indexes of the selected items. @@ -863,7 +863,7 @@ Returns an array with the indexes of the selected items. .. rst-class:: classref-method -:ref:`VScrollBar` **get_v_scroll_bar** **(** **)** +:ref:`VScrollBar` **get_v_scroll_bar**\ (\ ) Returns the vertical scrollbar. @@ -877,7 +877,7 @@ Returns the vertical scrollbar. .. rst-class:: classref-method -:ref:`bool` **is_anything_selected** **(** **)** +:ref:`bool` **is_anything_selected**\ (\ ) Returns ``true`` if one or more items are selected. @@ -889,7 +889,7 @@ Returns ``true`` if one or more items are selected. .. rst-class:: classref-method -:ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** |const| +:ref:`bool` **is_item_disabled**\ (\ idx\: :ref:`int`\ ) |const| Returns ``true`` if the item at the specified index is disabled. @@ -901,7 +901,7 @@ Returns ``true`` if the item at the specified index is disabled. .. rst-class:: classref-method -:ref:`bool` **is_item_icon_transposed** **(** :ref:`int` idx **)** |const| +:ref:`bool` **is_item_icon_transposed**\ (\ idx\: :ref:`int`\ ) |const| Returns ``true`` if the item icon will be drawn transposed, i.e. the X and Y axes are swapped. @@ -913,7 +913,7 @@ Returns ``true`` if the item icon will be drawn transposed, i.e. the X and Y axe .. rst-class:: classref-method -:ref:`bool` **is_item_selectable** **(** :ref:`int` idx **)** |const| +:ref:`bool` **is_item_selectable**\ (\ idx\: :ref:`int`\ ) |const| Returns ``true`` if the item at the specified index is selectable. @@ -925,7 +925,7 @@ Returns ``true`` if the item at the specified index is selectable. .. rst-class:: classref-method -:ref:`bool` **is_item_tooltip_enabled** **(** :ref:`int` idx **)** |const| +:ref:`bool` **is_item_tooltip_enabled**\ (\ idx\: :ref:`int`\ ) |const| Returns ``true`` if the tooltip is enabled for specified item index. @@ -937,7 +937,7 @@ Returns ``true`` if the tooltip is enabled for specified item index. .. rst-class:: classref-method -:ref:`bool` **is_selected** **(** :ref:`int` idx **)** |const| +:ref:`bool` **is_selected**\ (\ idx\: :ref:`int`\ ) |const| Returns ``true`` if the item at the specified index is currently selected. @@ -949,7 +949,7 @@ Returns ``true`` if the item at the specified index is currently selected. .. rst-class:: classref-method -void **move_item** **(** :ref:`int` from_idx, :ref:`int` to_idx **)** +|void| **move_item**\ (\ from_idx\: :ref:`int`, to_idx\: :ref:`int`\ ) Moves item from index ``from_idx`` to ``to_idx``. @@ -961,7 +961,7 @@ Moves item from index ``from_idx`` to ``to_idx``. .. rst-class:: classref-method -void **remove_item** **(** :ref:`int` idx **)** +|void| **remove_item**\ (\ idx\: :ref:`int`\ ) Removes the item specified by ``idx`` index from the list. @@ -973,7 +973,7 @@ Removes the item specified by ``idx`` index from the list. .. rst-class:: classref-method -void **select** **(** :ref:`int` idx, :ref:`bool` single=true **)** +|void| **select**\ (\ idx\: :ref:`int`, single\: :ref:`bool` = true\ ) Select the item at the specified index. @@ -987,7 +987,7 @@ Select the item at the specified index. .. rst-class:: classref-method -void **set_item_custom_bg_color** **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** +|void| **set_item_custom_bg_color**\ (\ idx\: :ref:`int`, custom_bg_color\: :ref:`Color`\ ) Sets the background color of the item specified by ``idx`` index to the specified :ref:`Color`. @@ -999,7 +999,7 @@ Sets the background color of the item specified by ``idx`` index to the specifie .. rst-class:: classref-method -void **set_item_custom_fg_color** **(** :ref:`int` idx, :ref:`Color` custom_fg_color **)** +|void| **set_item_custom_fg_color**\ (\ idx\: :ref:`int`, custom_fg_color\: :ref:`Color`\ ) Sets the foreground color of the item specified by ``idx`` index to the specified :ref:`Color`. @@ -1011,7 +1011,7 @@ Sets the foreground color of the item specified by ``idx`` index to the specifie .. rst-class:: classref-method -void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** +|void| **set_item_disabled**\ (\ idx\: :ref:`int`, disabled\: :ref:`bool`\ ) Disables (or enables) the item at the specified index. @@ -1025,7 +1025,7 @@ Disabled items cannot be selected and do not trigger activation signals (when do .. rst-class:: classref-method -void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture2D` icon **)** +|void| **set_item_icon**\ (\ idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) Sets (or replaces) the icon's :ref:`Texture2D` associated with the specified index. @@ -1037,7 +1037,7 @@ Sets (or replaces) the icon's :ref:`Texture2D` associated with .. rst-class:: classref-method -void **set_item_icon_modulate** **(** :ref:`int` idx, :ref:`Color` modulate **)** +|void| **set_item_icon_modulate**\ (\ idx\: :ref:`int`, modulate\: :ref:`Color`\ ) Sets a modulating :ref:`Color` of the item associated with the specified index. @@ -1049,7 +1049,7 @@ Sets a modulating :ref:`Color` of the item associated with the spec .. rst-class:: classref-method -void **set_item_icon_region** **(** :ref:`int` idx, :ref:`Rect2` rect **)** +|void| **set_item_icon_region**\ (\ idx\: :ref:`int`, rect\: :ref:`Rect2`\ ) Sets the region of item's icon used. The whole icon will be used if the region has no area. @@ -1061,7 +1061,7 @@ Sets the region of item's icon used. The whole icon will be used if the region h .. rst-class:: classref-method -void **set_item_icon_transposed** **(** :ref:`int` idx, :ref:`bool` transposed **)** +|void| **set_item_icon_transposed**\ (\ idx\: :ref:`int`, transposed\: :ref:`bool`\ ) Sets whether the item icon will be drawn transposed. @@ -1073,7 +1073,7 @@ Sets whether the item icon will be drawn transposed. .. rst-class:: classref-method -void **set_item_language** **(** :ref:`int` idx, :ref:`String` language **)** +|void| **set_item_language**\ (\ idx\: :ref:`int`, language\: :ref:`String`\ ) Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -1085,7 +1085,7 @@ Sets language code of item's text used for line-breaking and text shaping algori .. rst-class:: classref-method -void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** +|void| **set_item_metadata**\ (\ idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) Sets a value (of any type) to be stored with the item associated with the specified index. @@ -1097,7 +1097,7 @@ Sets a value (of any type) to be stored with the item associated with the specif .. rst-class:: classref-method -void **set_item_selectable** **(** :ref:`int` idx, :ref:`bool` selectable **)** +|void| **set_item_selectable**\ (\ idx\: :ref:`int`, selectable\: :ref:`bool`\ ) Allows or disallows selection of the item associated with the specified index. @@ -1109,7 +1109,7 @@ Allows or disallows selection of the item associated with the specified index. .. rst-class:: classref-method -void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** +|void| **set_item_text**\ (\ idx\: :ref:`int`, text\: :ref:`String`\ ) Sets text of the item associated with the specified index. @@ -1121,7 +1121,7 @@ Sets text of the item associated with the specified index. .. rst-class:: classref-method -void **set_item_text_direction** **(** :ref:`int` idx, :ref:`TextDirection` direction **)** +|void| **set_item_text_direction**\ (\ idx\: :ref:`int`, direction\: :ref:`TextDirection`\ ) Sets item's text base writing direction. @@ -1133,7 +1133,7 @@ Sets item's text base writing direction. .. rst-class:: classref-method -void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** +|void| **set_item_tooltip**\ (\ idx\: :ref:`int`, tooltip\: :ref:`String`\ ) Sets the tooltip hint for the item associated with the specified index. @@ -1145,7 +1145,7 @@ Sets the tooltip hint for the item associated with the specified index. .. rst-class:: classref-method -void **set_item_tooltip_enabled** **(** :ref:`int` idx, :ref:`bool` enable **)** +|void| **set_item_tooltip_enabled**\ (\ idx\: :ref:`int`, enable\: :ref:`bool`\ ) Sets whether the tooltip hint is enabled for specified item index. @@ -1157,7 +1157,7 @@ Sets whether the tooltip hint is enabled for specified item index. .. rst-class:: classref-method -void **sort_items_by_text** **(** **)** +|void| **sort_items_by_text**\ (\ ) Sorts items in the list by their text. @@ -1403,3 +1403,4 @@ The background style for the **ItemList**. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_javaclass.rst b/classes/class_javaclass.rst index 7ab5101cc52..191fc448c1b 100644 --- a/classes/class_javaclass.rst +++ b/classes/class_javaclass.rst @@ -23,3 +23,4 @@ JavaClass .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_javaclasswrapper.rst b/classes/class_javaclasswrapper.rst index d36918c9686..cb0f9c652a0 100644 --- a/classes/class_javaclasswrapper.rst +++ b/classes/class_javaclasswrapper.rst @@ -24,9 +24,9 @@ Methods .. table:: :widths: auto - +-----------------------------------+----------------------------------------------------------------------------------------------+ - | :ref:`JavaClass` | :ref:`wrap` **(** :ref:`String` name **)** | - +-----------------------------------+----------------------------------------------------------------------------------------------+ + +-----------------------------------+-------------------------------------------------------------------------------------------+ + | :ref:`JavaClass` | :ref:`wrap`\ (\ name\: :ref:`String`\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -41,7 +41,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`JavaClass` **wrap** **(** :ref:`String` name **)** +:ref:`JavaClass` **wrap**\ (\ name\: :ref:`String`\ ) .. container:: contribute @@ -54,3 +54,4 @@ Method Descriptions .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_javascriptbridge.rst b/classes/class_javascriptbridge.rst index d8be160c79c..d35cb5627ef 100644 --- a/classes/class_javascriptbridge.rst +++ b/classes/class_javascriptbridge.rst @@ -38,23 +38,23 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`JavaScriptObject` | :ref:`create_callback` **(** :ref:`Callable` callable **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`create_object` **(** :ref:`String` object, ... **)** |vararg| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`download_buffer` **(** :ref:`PackedByteArray` buffer, :ref:`String` name, :ref:`String` mime="application/octet-stream" **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`eval` **(** :ref:`String` code, :ref:`bool` use_global_execution_context=false **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`force_fs_sync` **(** **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`JavaScriptObject` | :ref:`get_interface` **(** :ref:`String` interface **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`pwa_needs_update` **(** **)** |const| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`pwa_update` **(** **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`JavaScriptObject` | :ref:`create_callback`\ (\ callable\: :ref:`Callable`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`create_object`\ (\ object\: :ref:`String`, ...\ ) |vararg| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`download_buffer`\ (\ buffer\: :ref:`PackedByteArray`, name\: :ref:`String`, mime\: :ref:`String` = "application/octet-stream"\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`eval`\ (\ code\: :ref:`String`, use_global_execution_context\: :ref:`bool` = false\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_fs_sync`\ (\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`JavaScriptObject` | :ref:`get_interface`\ (\ interface\: :ref:`String`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`pwa_needs_update`\ (\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`pwa_update`\ (\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -69,7 +69,7 @@ Signals .. rst-class:: classref-signal -**pwa_update_available** **(** **)** +**pwa_update_available**\ (\ ) Emitted when an update for this progressive web app has been detected but is waiting to be activated because a previous version is active. See :ref:`pwa_update` to force the update to take place immediately. @@ -86,7 +86,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`JavaScriptObject` **create_callback** **(** :ref:`Callable` callable **)** +:ref:`JavaScriptObject` **create_callback**\ (\ callable\: :ref:`Callable`\ ) Creates a reference to a :ref:`Callable` that can be used as a callback by JavaScript. The reference must be kept until the callback happens, or it won't be called at all. See :ref:`JavaScriptObject` for usage. @@ -98,7 +98,7 @@ Creates a reference to a :ref:`Callable` that can be used as a c .. rst-class:: classref-method -:ref:`Variant` **create_object** **(** :ref:`String` object, ... **)** |vararg| +:ref:`Variant` **create_object**\ (\ object\: :ref:`String`, ...\ ) |vararg| Creates a new JavaScript object using the ``new`` constructor. The ``object`` must a valid property of the JavaScript ``window``. See :ref:`JavaScriptObject` for usage. @@ -110,7 +110,7 @@ Creates a new JavaScript object using the ``new`` constructor. The ``object`` mu .. rst-class:: classref-method -void **download_buffer** **(** :ref:`PackedByteArray` buffer, :ref:`String` name, :ref:`String` mime="application/octet-stream" **)** +|void| **download_buffer**\ (\ buffer\: :ref:`PackedByteArray`, name\: :ref:`String`, mime\: :ref:`String` = "application/octet-stream"\ ) Prompts the user to download a file containing the specified ``buffer``. The file will have the given ``name`` and ``mime`` type. @@ -128,7 +128,7 @@ Prompts the user to download a file containing the specified ``buffer``. The fil .. rst-class:: classref-method -:ref:`Variant` **eval** **(** :ref:`String` code, :ref:`bool` use_global_execution_context=false **)** +:ref:`Variant` **eval**\ (\ code\: :ref:`String`, use_global_execution_context\: :ref:`bool` = false\ ) Execute the string ``code`` as JavaScript code within the browser window. This is a call to the actual global JavaScript function ``eval()``. @@ -142,7 +142,7 @@ If ``use_global_execution_context`` is ``true``, the code will be evaluated in t .. rst-class:: classref-method -void **force_fs_sync** **(** **)** +|void| **force_fs_sync**\ (\ ) Force synchronization of the persistent file system (when enabled). @@ -156,7 +156,7 @@ Force synchronization of the persistent file system (when enabled). .. rst-class:: classref-method -:ref:`JavaScriptObject` **get_interface** **(** :ref:`String` interface **)** +:ref:`JavaScriptObject` **get_interface**\ (\ interface\: :ref:`String`\ ) Returns an interface to a JavaScript object that can be used by scripts. The ``interface`` must be a valid property of the JavaScript ``window``. The callback must accept a single :ref:`Array` argument, which will contain the JavaScript ``arguments``. See :ref:`JavaScriptObject` for usage. @@ -168,7 +168,7 @@ Returns an interface to a JavaScript object that can be used by scripts. The ``i .. rst-class:: classref-method -:ref:`bool` **pwa_needs_update** **(** **)** |const| +:ref:`bool` **pwa_needs_update**\ (\ ) |const| Returns ``true`` if a new version of the progressive web app is waiting to be activated. @@ -182,7 +182,7 @@ Returns ``true`` if a new version of the progressive web app is waiting to be ac .. rst-class:: classref-method -:ref:`Error` **pwa_update** **(** **)** +:ref:`Error` **pwa_update**\ (\ ) Performs the live update of the progressive web app. Forcing the new version to be installed and the page to be reloaded. @@ -197,3 +197,4 @@ Performs the live update of the progressive web app. Forcing the new version to .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_javascriptobject.rst b/classes/class_javascriptobject.rst index 5bf84788e44..f42c6517c1d 100644 --- a/classes/class_javascriptobject.rst +++ b/classes/class_javascriptobject.rst @@ -58,3 +58,4 @@ JavaScriptObject is used to interact with JavaScript objects retrieved or create .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_jnisingleton.rst b/classes/class_jnisingleton.rst index 11a01e35873..7e09e92cdfe 100644 --- a/classes/class_jnisingleton.rst +++ b/classes/class_jnisingleton.rst @@ -35,3 +35,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index 3ebcea0d7b2..66b34f9132f 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -49,9 +49,9 @@ Methods .. table:: :widths: auto - +-----------------------+------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | - +-----------------------+------------------------------------------------------------------+ + +-----------------------+------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +-----------------------+------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -70,8 +70,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bias** **(** :ref:`float` value **)** -- :ref:`float` **get_bias** **(** **)** +- |void| **set_bias**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_bias**\ (\ ) When :ref:`node_a` and :ref:`node_b` move in different directions the :ref:`bias` controls how fast the joint pulls them back to their original position. The lower the :ref:`bias` the more the two bodies can pull on the joint. @@ -89,8 +89,8 @@ When set to ``0``, the default value from :ref:`ProjectSettings.physics/2d/solve .. rst-class:: classref-property-setget -- void **set_exclude_nodes_from_collision** **(** :ref:`bool` value **)** -- :ref:`bool` **get_exclude_nodes_from_collision** **(** **)** +- |void| **set_exclude_nodes_from_collision**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_exclude_nodes_from_collision**\ (\ ) If ``true``, :ref:`node_a` and :ref:`node_b` can not collide. @@ -106,8 +106,8 @@ If ``true``, :ref:`node_a` and :ref:`node_b` value **)** -- :ref:`NodePath` **get_node_a** **(** **)** +- |void| **set_node_a**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_node_a**\ (\ ) The first body attached to the joint. Must derive from :ref:`PhysicsBody2D`. @@ -123,8 +123,8 @@ The first body attached to the joint. Must derive from :ref:`PhysicsBody2D` value **)** -- :ref:`NodePath` **get_node_b** **(** **)** +- |void| **set_node_b**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_node_b**\ (\ ) The second body attached to the joint. Must derive from :ref:`PhysicsBody2D`. @@ -141,7 +141,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **get_rid** **(** **)** |const| +:ref:`RID` **get_rid**\ (\ ) |const| Returns the joint's :ref:`RID`. @@ -152,3 +152,4 @@ Returns the joint's :ref:`RID`. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_joint3d.rst b/classes/class_joint3d.rst index d6bf3fe9a6f..b0da458031b 100644 --- a/classes/class_joint3d.rst +++ b/classes/class_joint3d.rst @@ -56,9 +56,9 @@ Methods .. table:: :widths: auto - +-----------------------+------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | - +-----------------------+------------------------------------------------------------------+ + +-----------------------+------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +-----------------------+------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -77,8 +77,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_exclude_nodes_from_collision** **(** :ref:`bool` value **)** -- :ref:`bool` **get_exclude_nodes_from_collision** **(** **)** +- |void| **set_exclude_nodes_from_collision**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_exclude_nodes_from_collision**\ (\ ) If ``true``, the two bodies of the nodes are not able to collide with each other. @@ -94,8 +94,8 @@ If ``true``, the two bodies of the nodes are not able to collide with each other .. rst-class:: classref-property-setget -- void **set_node_a** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_node_a** **(** **)** +- |void| **set_node_a**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_node_a**\ (\ ) The node attached to the first side (A) of the joint. @@ -111,8 +111,8 @@ The node attached to the first side (A) of the joint. .. rst-class:: classref-property-setget -- void **set_node_b** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_node_b** **(** **)** +- |void| **set_node_b**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_node_b**\ (\ ) The node attached to the second side (B) of the joint. @@ -128,8 +128,8 @@ The node attached to the second side (B) of the joint. .. rst-class:: classref-property-setget -- void **set_solver_priority** **(** :ref:`int` value **)** -- :ref:`int` **get_solver_priority** **(** **)** +- |void| **set_solver_priority**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_solver_priority**\ (\ ) The priority used to define which solver is executed first for multiple joints. The lower the value, the higher the priority. @@ -146,7 +146,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **get_rid** **(** **)** |const| +:ref:`RID` **get_rid**\ (\ ) |const| Returns the joint's :ref:`RID`. @@ -157,3 +157,4 @@ Returns the joint's :ref:`RID`. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_json.rst b/classes/class_json.rst index a9d4a0a294f..ed96cb18eb5 100644 --- a/classes/class_json.rst +++ b/classes/class_json.rst @@ -81,19 +81,19 @@ Methods .. table:: :widths: auto - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_error_line` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_error_message` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_parsed_text` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`parse` **(** :ref:`String` json_text, :ref:`bool` keep_text=false **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`parse_string` **(** :ref:`String` json_string **)** |static| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`stringify` **(** :ref:`Variant` data, :ref:`String` indent="", :ref:`bool` sort_keys=true, :ref:`bool` full_precision=false **)** |static| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_error_line`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_error_message`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_parsed_text`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`parse`\ (\ json_text\: :ref:`String`, keep_text\: :ref:`bool` = false\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`parse_string`\ (\ json_string\: :ref:`String`\ ) |static| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`stringify`\ (\ data\: :ref:`Variant`, indent\: :ref:`String` = "", sort_keys\: :ref:`bool` = true, full_precision\: :ref:`bool` = false\ ) |static| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -112,8 +112,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_data** **(** :ref:`Variant` value **)** -- :ref:`Variant` **get_data** **(** **)** +- |void| **set_data**\ (\ value\: :ref:`Variant`\ ) +- :ref:`Variant` **get_data**\ (\ ) Contains the parsed JSON data in :ref:`Variant` form. @@ -130,7 +130,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_error_line** **(** **)** |const| +:ref:`int` **get_error_line**\ (\ ) |const| Returns ``0`` if the last call to :ref:`parse` was successful, or the line number where the parse failed. @@ -142,7 +142,7 @@ Returns ``0`` if the last call to :ref:`parse` was succ .. rst-class:: classref-method -:ref:`String` **get_error_message** **(** **)** |const| +:ref:`String` **get_error_message**\ (\ ) |const| Returns an empty string if the last call to :ref:`parse` was successful, or the error message if it failed. @@ -154,7 +154,7 @@ Returns an empty string if the last call to :ref:`parse .. rst-class:: classref-method -:ref:`String` **get_parsed_text** **(** **)** |const| +:ref:`String` **get_parsed_text**\ (\ ) |const| Return the text parsed by :ref:`parse` as long as the function is instructed to keep it. @@ -166,7 +166,7 @@ Return the text parsed by :ref:`parse` as long as the f .. rst-class:: classref-method -:ref:`Error` **parse** **(** :ref:`String` json_text, :ref:`bool` keep_text=false **)** +:ref:`Error` **parse**\ (\ json_text\: :ref:`String`, keep_text\: :ref:`bool` = false\ ) Attempts to parse the ``json_text`` provided. @@ -184,7 +184,7 @@ The optional ``keep_text`` argument instructs the parser to keep a copy of the o .. rst-class:: classref-method -:ref:`Variant` **parse_string** **(** :ref:`String` json_string **)** |static| +:ref:`Variant` **parse_string**\ (\ json_string\: :ref:`String`\ ) |static| Attempts to parse the ``json_string`` provided and returns the parsed data. Returns ``null`` if parse failed. @@ -196,7 +196,7 @@ Attempts to parse the ``json_string`` provided and returns the parsed data. Retu .. rst-class:: classref-method -:ref:`String` **stringify** **(** :ref:`Variant` data, :ref:`String` indent="", :ref:`bool` sort_keys=true, :ref:`bool` full_precision=false **)** |static| +:ref:`String` **stringify**\ (\ data\: :ref:`Variant`, indent\: :ref:`String` = "", sort_keys\: :ref:`bool` = true, full_precision\: :ref:`bool` = false\ ) |static| Converts a :ref:`Variant` var to JSON text and returns the result. Useful for serializing data to store or send over the network. @@ -252,3 +252,4 @@ The ``indent`` parameter controls if and how something is indented, the string u .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_jsonrpc.rst b/classes/class_jsonrpc.rst index 17d6a8256aa..a3f418adaa1 100644 --- a/classes/class_jsonrpc.rst +++ b/classes/class_jsonrpc.rst @@ -29,21 +29,21 @@ Methods .. table:: :widths: auto - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`make_notification` **(** :ref:`String` method, :ref:`Variant` params **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`make_request` **(** :ref:`String` method, :ref:`Variant` params, :ref:`Variant` id **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`make_response` **(** :ref:`Variant` result, :ref:`Variant` id **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`make_response_error` **(** :ref:`int` code, :ref:`String` message, :ref:`Variant` id=null **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`process_action` **(** :ref:`Variant` action, :ref:`bool` recurse=false **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`process_string` **(** :ref:`String` action **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_scope` **(** :ref:`String` scope, :ref:`Object` target **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`make_notification`\ (\ method\: :ref:`String`, params\: :ref:`Variant`\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`make_request`\ (\ method\: :ref:`String`, params\: :ref:`Variant`, id\: :ref:`Variant`\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`make_response`\ (\ result\: :ref:`Variant`, id\: :ref:`Variant`\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`make_response_error`\ (\ code\: :ref:`int`, message\: :ref:`String`, id\: :ref:`Variant` = null\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`process_action`\ (\ action\: :ref:`Variant`, recurse\: :ref:`bool` = false\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`process_string`\ (\ action\: :ref:`String`\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_scope`\ (\ scope\: :ref:`String`, target\: :ref:`Object`\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -129,7 +129,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary` **make_notification** **(** :ref:`String` method, :ref:`Variant` params **)** +:ref:`Dictionary` **make_notification**\ (\ method\: :ref:`String`, params\: :ref:`Variant`\ ) Returns a dictionary in the form of a JSON-RPC notification. Notifications are one-shot messages which do not expect a response. @@ -145,7 +145,7 @@ Returns a dictionary in the form of a JSON-RPC notification. Notifications are o .. rst-class:: classref-method -:ref:`Dictionary` **make_request** **(** :ref:`String` method, :ref:`Variant` params, :ref:`Variant` id **)** +:ref:`Dictionary` **make_request**\ (\ method\: :ref:`String`, params\: :ref:`Variant`, id\: :ref:`Variant`\ ) Returns a dictionary in the form of a JSON-RPC request. Requests are sent to a server with the expectation of a response. The ID field is used for the server to specify which exact request it is responding to. @@ -163,7 +163,7 @@ Returns a dictionary in the form of a JSON-RPC request. Requests are sent to a s .. rst-class:: classref-method -:ref:`Dictionary` **make_response** **(** :ref:`Variant` result, :ref:`Variant` id **)** +:ref:`Dictionary` **make_response**\ (\ result\: :ref:`Variant`, id\: :ref:`Variant`\ ) When a server has received and processed a request, it is expected to send a response. If you did not want a response then you need to have sent a Notification instead. @@ -179,7 +179,7 @@ When a server has received and processed a request, it is expected to send a res .. rst-class:: classref-method -:ref:`Dictionary` **make_response_error** **(** :ref:`int` code, :ref:`String` message, :ref:`Variant` id=null **)** |const| +:ref:`Dictionary` **make_response_error**\ (\ code\: :ref:`int`, message\: :ref:`String`, id\: :ref:`Variant` = null\ ) |const| Creates a response which indicates a previous reply has failed in some way. @@ -197,7 +197,7 @@ Creates a response which indicates a previous reply has failed in some way. .. rst-class:: classref-method -:ref:`Variant` **process_action** **(** :ref:`Variant` action, :ref:`bool` recurse=false **)** +:ref:`Variant` **process_action**\ (\ action\: :ref:`Variant`, recurse\: :ref:`bool` = false\ ) Given a Dictionary which takes the form of a JSON-RPC request: unpack the request and run it. Methods are resolved by looking at the field called "method" and looking for an equivalently named function in the JSONRPC object. If one is found that method is called. @@ -213,7 +213,7 @@ To add new supported methods extend the JSONRPC class and call :ref:`process_act .. rst-class:: classref-method -:ref:`String` **process_string** **(** :ref:`String` action **)** +:ref:`String` **process_string**\ (\ action\: :ref:`String`\ ) .. container:: contribute @@ -227,7 +227,7 @@ To add new supported methods extend the JSONRPC class and call :ref:`process_act .. rst-class:: classref-method -void **set_scope** **(** :ref:`String` scope, :ref:`Object` target **)** +|void| **set_scope**\ (\ scope\: :ref:`String`, target\: :ref:`Object`\ ) .. container:: contribute @@ -240,3 +240,4 @@ void **set_scope** **(** :ref:`String` scope, :ref:`Object` | :ref:`get_angle` **(** :ref:`Vector2` up_direction=Vector2(0, -1) **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_collider` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collider_id` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_collider_rid` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_collider_shape` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collider_shape_index` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_collider_velocity` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_depth` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_local_shape` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_normal` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_position` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_remainder` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_travel` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_angle`\ (\ up_direction\: :ref:`Vector2` = Vector2(0, -1)\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_collider`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collider_id`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_collider_rid`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_collider_shape`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collider_shape_index`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_collider_velocity`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_depth`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_local_shape`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_normal`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_position`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_remainder`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_travel`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -72,7 +72,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_angle** **(** :ref:`Vector2` up_direction=Vector2(0, -1) **)** |const| +:ref:`float` **get_angle**\ (\ up_direction\: :ref:`Vector2` = Vector2(0, -1)\ ) |const| Returns the collision angle according to ``up_direction``, which is :ref:`Vector2.UP` by default. This value is always positive. @@ -84,7 +84,7 @@ Returns the collision angle according to ``up_direction``, which is :ref:`Vector .. rst-class:: classref-method -:ref:`Object` **get_collider** **(** **)** |const| +:ref:`Object` **get_collider**\ (\ ) |const| Returns the colliding body's attached :ref:`Object`. @@ -96,7 +96,7 @@ Returns the colliding body's attached :ref:`Object`. .. rst-class:: classref-method -:ref:`int` **get_collider_id** **(** **)** |const| +:ref:`int` **get_collider_id**\ (\ ) |const| Returns the unique instance ID of the colliding body's attached :ref:`Object`. See :ref:`Object.get_instance_id`. @@ -108,7 +108,7 @@ Returns the unique instance ID of the colliding body's attached :ref:`Object` **get_collider_rid** **(** **)** |const| +:ref:`RID` **get_collider_rid**\ (\ ) |const| Returns the colliding body's :ref:`RID` used by the :ref:`PhysicsServer2D`. @@ -120,7 +120,7 @@ Returns the colliding body's :ref:`RID` used by the :ref:`PhysicsServ .. rst-class:: classref-method -:ref:`Object` **get_collider_shape** **(** **)** |const| +:ref:`Object` **get_collider_shape**\ (\ ) |const| Returns the colliding body's shape. @@ -132,7 +132,7 @@ Returns the colliding body's shape. .. rst-class:: classref-method -:ref:`int` **get_collider_shape_index** **(** **)** |const| +:ref:`int` **get_collider_shape_index**\ (\ ) |const| Returns the colliding body's shape index. See :ref:`CollisionObject2D`. @@ -144,7 +144,7 @@ Returns the colliding body's shape index. See :ref:`CollisionObject2D` **get_collider_velocity** **(** **)** |const| +:ref:`Vector2` **get_collider_velocity**\ (\ ) |const| Returns the colliding body's velocity. @@ -156,7 +156,7 @@ Returns the colliding body's velocity. .. rst-class:: classref-method -:ref:`float` **get_depth** **(** **)** |const| +:ref:`float` **get_depth**\ (\ ) |const| Returns the colliding body's length of overlap along the collision normal. @@ -168,7 +168,7 @@ Returns the colliding body's length of overlap along the collision normal. .. rst-class:: classref-method -:ref:`Object` **get_local_shape** **(** **)** |const| +:ref:`Object` **get_local_shape**\ (\ ) |const| Returns the moving object's colliding shape. @@ -180,7 +180,7 @@ Returns the moving object's colliding shape. .. rst-class:: classref-method -:ref:`Vector2` **get_normal** **(** **)** |const| +:ref:`Vector2` **get_normal**\ (\ ) |const| Returns the colliding body's shape's normal at the point of collision. @@ -192,7 +192,7 @@ Returns the colliding body's shape's normal at the point of collision. .. rst-class:: classref-method -:ref:`Vector2` **get_position** **(** **)** |const| +:ref:`Vector2` **get_position**\ (\ ) |const| Returns the point of collision in global coordinates. @@ -204,7 +204,7 @@ Returns the point of collision in global coordinates. .. rst-class:: classref-method -:ref:`Vector2` **get_remainder** **(** **)** |const| +:ref:`Vector2` **get_remainder**\ (\ ) |const| Returns the moving object's remaining movement vector. @@ -216,7 +216,7 @@ Returns the moving object's remaining movement vector. .. rst-class:: classref-method -:ref:`Vector2` **get_travel** **(** **)** |const| +:ref:`Vector2` **get_travel**\ (\ ) |const| Returns the moving object's travel before collision. @@ -227,3 +227,4 @@ Returns the moving object's travel before collision. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_kinematiccollision3d.rst b/classes/class_kinematiccollision3d.rst index c754716763f..0c9db3b4bd8 100644 --- a/classes/class_kinematiccollision3d.rst +++ b/classes/class_kinematiccollision3d.rst @@ -31,35 +31,35 @@ Methods .. table:: :widths: auto - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_angle` **(** :ref:`int` collision_index=0, :ref:`Vector3` up_direction=Vector3(0, 1, 0) **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_collider` **(** :ref:`int` collision_index=0 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collider_id` **(** :ref:`int` collision_index=0 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_collider_rid` **(** :ref:`int` collision_index=0 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_collider_shape` **(** :ref:`int` collision_index=0 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collider_shape_index` **(** :ref:`int` collision_index=0 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_collider_velocity` **(** :ref:`int` collision_index=0 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collision_count` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_depth` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_local_shape` **(** :ref:`int` collision_index=0 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_normal` **(** :ref:`int` collision_index=0 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_position` **(** :ref:`int` collision_index=0 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_remainder` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_travel` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_angle`\ (\ collision_index\: :ref:`int` = 0, up_direction\: :ref:`Vector3` = Vector3(0, 1, 0)\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_collider`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collider_id`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_collider_rid`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_collider_shape`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collider_shape_index`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_collider_velocity`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collision_count`\ (\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_depth`\ (\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_local_shape`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_normal`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_position`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_remainder`\ (\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_travel`\ (\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -74,7 +74,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_angle** **(** :ref:`int` collision_index=0, :ref:`Vector3` up_direction=Vector3(0, 1, 0) **)** |const| +:ref:`float` **get_angle**\ (\ collision_index\: :ref:`int` = 0, up_direction\: :ref:`Vector3` = Vector3(0, 1, 0)\ ) |const| Returns the collision angle according to ``up_direction``, which is :ref:`Vector3.UP` by default. This value is always positive. @@ -86,7 +86,7 @@ Returns the collision angle according to ``up_direction``, which is :ref:`Vector .. rst-class:: classref-method -:ref:`Object` **get_collider** **(** :ref:`int` collision_index=0 **)** |const| +:ref:`Object` **get_collider**\ (\ collision_index\: :ref:`int` = 0\ ) |const| Returns the colliding body's attached :ref:`Object` given a collision index (the deepest collision by default). @@ -98,7 +98,7 @@ Returns the colliding body's attached :ref:`Object` given a collis .. rst-class:: classref-method -:ref:`int` **get_collider_id** **(** :ref:`int` collision_index=0 **)** |const| +:ref:`int` **get_collider_id**\ (\ collision_index\: :ref:`int` = 0\ ) |const| Returns the unique instance ID of the colliding body's attached :ref:`Object` given a collision index (the deepest collision by default). See :ref:`Object.get_instance_id`. @@ -110,7 +110,7 @@ Returns the unique instance ID of the colliding body's attached :ref:`Object` **get_collider_rid** **(** :ref:`int` collision_index=0 **)** |const| +:ref:`RID` **get_collider_rid**\ (\ collision_index\: :ref:`int` = 0\ ) |const| Returns the colliding body's :ref:`RID` used by the :ref:`PhysicsServer3D` given a collision index (the deepest collision by default). @@ -122,7 +122,7 @@ Returns the colliding body's :ref:`RID` used by the :ref:`PhysicsServ .. rst-class:: classref-method -:ref:`Object` **get_collider_shape** **(** :ref:`int` collision_index=0 **)** |const| +:ref:`Object` **get_collider_shape**\ (\ collision_index\: :ref:`int` = 0\ ) |const| Returns the colliding body's shape given a collision index (the deepest collision by default). @@ -134,7 +134,7 @@ Returns the colliding body's shape given a collision index (the deepest collisio .. rst-class:: classref-method -:ref:`int` **get_collider_shape_index** **(** :ref:`int` collision_index=0 **)** |const| +:ref:`int` **get_collider_shape_index**\ (\ collision_index\: :ref:`int` = 0\ ) |const| Returns the colliding body's shape index given a collision index (the deepest collision by default). See :ref:`CollisionObject3D`. @@ -146,7 +146,7 @@ Returns the colliding body's shape index given a collision index (the deepest co .. rst-class:: classref-method -:ref:`Vector3` **get_collider_velocity** **(** :ref:`int` collision_index=0 **)** |const| +:ref:`Vector3` **get_collider_velocity**\ (\ collision_index\: :ref:`int` = 0\ ) |const| Returns the colliding body's velocity given a collision index (the deepest collision by default). @@ -158,7 +158,7 @@ Returns the colliding body's velocity given a collision index (the deepest colli .. rst-class:: classref-method -:ref:`int` **get_collision_count** **(** **)** |const| +:ref:`int` **get_collision_count**\ (\ ) |const| Returns the number of detected collisions. @@ -170,7 +170,7 @@ Returns the number of detected collisions. .. rst-class:: classref-method -:ref:`float` **get_depth** **(** **)** |const| +:ref:`float` **get_depth**\ (\ ) |const| Returns the colliding body's length of overlap along the collision normal. @@ -182,7 +182,7 @@ Returns the colliding body's length of overlap along the collision normal. .. rst-class:: classref-method -:ref:`Object` **get_local_shape** **(** :ref:`int` collision_index=0 **)** |const| +:ref:`Object` **get_local_shape**\ (\ collision_index\: :ref:`int` = 0\ ) |const| Returns the moving object's colliding shape given a collision index (the deepest collision by default). @@ -194,7 +194,7 @@ Returns the moving object's colliding shape given a collision index (the deepest .. rst-class:: classref-method -:ref:`Vector3` **get_normal** **(** :ref:`int` collision_index=0 **)** |const| +:ref:`Vector3` **get_normal**\ (\ collision_index\: :ref:`int` = 0\ ) |const| Returns the colliding body's shape's normal at the point of collision given a collision index (the deepest collision by default). @@ -206,7 +206,7 @@ Returns the colliding body's shape's normal at the point of collision given a co .. rst-class:: classref-method -:ref:`Vector3` **get_position** **(** :ref:`int` collision_index=0 **)** |const| +:ref:`Vector3` **get_position**\ (\ collision_index\: :ref:`int` = 0\ ) |const| Returns the point of collision in global coordinates given a collision index (the deepest collision by default). @@ -218,7 +218,7 @@ Returns the point of collision in global coordinates given a collision index (th .. rst-class:: classref-method -:ref:`Vector3` **get_remainder** **(** **)** |const| +:ref:`Vector3` **get_remainder**\ (\ ) |const| Returns the moving object's remaining movement vector. @@ -230,7 +230,7 @@ Returns the moving object's remaining movement vector. .. rst-class:: classref-method -:ref:`Vector3` **get_travel** **(** **)** |const| +:ref:`Vector3` **get_travel**\ (\ ) |const| Returns the moving object's travel before collision. @@ -241,3 +241,4 @@ Returns the moving object's travel before collision. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_label.rst b/classes/class_label.rst index c1fc10a8678..8baaa655ed7 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: text + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -45,7 +48,7 @@ Properties +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`HorizontalAlignment` | :ref:`horizontal_alignment` | ``0`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`JustificationFlag`\> | :ref:`justification_flags` | ``163`` | + | |bitfield|\[:ref:`JustificationFlag`\] | :ref:`justification_flags` | ``163`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`LabelSettings` | :ref:`label_settings` | | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ @@ -57,7 +60,7 @@ Properties +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`MouseFilter` | mouse_filter | ``2`` (overrides :ref:`Control`) | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`SizeFlags`\> | size_flags_vertical | ``4`` (overrides :ref:`Control`) | + | |bitfield|\[:ref:`SizeFlags`\] | size_flags_vertical | ``4`` (overrides :ref:`Control`) | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`StructuredTextParser` | :ref:`structured_text_bidi_override` | ``0`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ @@ -90,17 +93,17 @@ Methods .. table:: :widths: auto - +---------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_character_bounds` **(** :ref:`int` pos **)** |const| | - +---------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_count` **(** **)** |const| | - +---------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_height` **(** :ref:`int` line=-1 **)** |const| | - +---------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_total_character_count` **(** **)** |const| | - +---------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_visible_line_count` **(** **)** |const| | - +---------------------------+--------------------------------------------------------------------------------------------------------------------+ + +---------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_character_bounds`\ (\ pos\: :ref:`int`\ ) |const| | + +---------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_count`\ (\ ) |const| | + +---------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_height`\ (\ line\: :ref:`int` = -1\ ) |const| | + +---------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_total_character_count`\ (\ ) |const| | + +---------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_visible_line_count`\ (\ ) |const| | + +---------------------------+-----------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -151,8 +154,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_autowrap_mode** **(** :ref:`AutowrapMode` value **)** -- :ref:`AutowrapMode` **get_autowrap_mode** **(** **)** +- |void| **set_autowrap_mode**\ (\ value\: :ref:`AutowrapMode`\ ) +- :ref:`AutowrapMode` **get_autowrap_mode**\ (\ ) If set to something other than :ref:`TextServer.AUTOWRAP_OFF`, the text gets wrapped inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. To see how each mode behaves, see :ref:`AutowrapMode`. @@ -168,8 +171,8 @@ If set to something other than :ref:`TextServer.AUTOWRAP_OFF` value **)** -- :ref:`bool` **is_clipping_text** **(** **)** +- |void| **set_clip_text**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_clipping_text**\ (\ ) If ``true``, the Label only shows the text that fits inside its bounding rectangle and will clip text horizontally. @@ -185,8 +188,8 @@ If ``true``, the Label only shows the text that fits inside its bounding rectang .. rst-class:: classref-property-setget -- void **set_ellipsis_char** **(** :ref:`String` value **)** -- :ref:`String` **get_ellipsis_char** **(** **)** +- |void| **set_ellipsis_char**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_ellipsis_char**\ (\ ) Ellipsis character used for text clipping. @@ -202,8 +205,8 @@ Ellipsis character used for text clipping. .. rst-class:: classref-property-setget -- void **set_horizontal_alignment** **(** :ref:`HorizontalAlignment` value **)** -- :ref:`HorizontalAlignment` **get_horizontal_alignment** **(** **)** +- |void| **set_horizontal_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) +- :ref:`HorizontalAlignment` **get_horizontal_alignment**\ (\ ) Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify. Set it to one of the :ref:`HorizontalAlignment` constants. @@ -215,12 +218,12 @@ Controls the text's horizontal alignment. Supports left, center, right, and fill .. rst-class:: classref-property -|bitfield|\<:ref:`JustificationFlag`\> **justification_flags** = ``163`` +|bitfield|\[:ref:`JustificationFlag`\] **justification_flags** = ``163`` .. rst-class:: classref-property-setget -- void **set_justification_flags** **(** |bitfield|\<:ref:`JustificationFlag`\> value **)** -- |bitfield|\<:ref:`JustificationFlag`\> **get_justification_flags** **(** **)** +- |void| **set_justification_flags**\ (\ value\: |bitfield|\[:ref:`JustificationFlag`\]\ ) +- |bitfield|\[:ref:`JustificationFlag`\] **get_justification_flags**\ (\ ) Line fill alignment rules. For more info see :ref:`JustificationFlag`. @@ -236,8 +239,8 @@ Line fill alignment rules. For more info see :ref:`JustificationFlag` value **)** -- :ref:`LabelSettings` **get_label_settings** **(** **)** +- |void| **set_label_settings**\ (\ value\: :ref:`LabelSettings`\ ) +- :ref:`LabelSettings` **get_label_settings**\ (\ ) A :ref:`LabelSettings` resource that can be shared between multiple **Label** nodes. Takes priority over theme properties. @@ -253,8 +256,8 @@ A :ref:`LabelSettings` resource that can be shared between .. rst-class:: classref-property-setget -- void **set_language** **(** :ref:`String` value **)** -- :ref:`String` **get_language** **(** **)** +- |void| **set_language**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_language**\ (\ ) Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -270,8 +273,8 @@ Language code used for line-breaking and text shaping algorithms, if left empty .. rst-class:: classref-property-setget -- void **set_lines_skipped** **(** :ref:`int` value **)** -- :ref:`int` **get_lines_skipped** **(** **)** +- |void| **set_lines_skipped**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_lines_skipped**\ (\ ) The number of the lines ignored and not displayed from the start of the :ref:`text` value. @@ -287,8 +290,8 @@ The number of the lines ignored and not displayed from the start of the :ref:`te .. rst-class:: classref-property-setget -- void **set_max_lines_visible** **(** :ref:`int` value **)** -- :ref:`int` **get_max_lines_visible** **(** **)** +- |void| **set_max_lines_visible**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_lines_visible**\ (\ ) Limits the lines of text the node shows on screen. @@ -304,8 +307,8 @@ Limits the lines of text the node shows on screen. .. rst-class:: classref-property-setget -- void **set_structured_text_bidi_override** **(** :ref:`StructuredTextParser` value **)** -- :ref:`StructuredTextParser` **get_structured_text_bidi_override** **(** **)** +- |void| **set_structured_text_bidi_override**\ (\ value\: :ref:`StructuredTextParser`\ ) +- :ref:`StructuredTextParser` **get_structured_text_bidi_override**\ (\ ) Set BiDi algorithm override for the structured text. @@ -321,8 +324,8 @@ Set BiDi algorithm override for the structured text. .. rst-class:: classref-property-setget -- void **set_structured_text_bidi_override_options** **(** :ref:`Array` value **)** -- :ref:`Array` **get_structured_text_bidi_override_options** **(** **)** +- |void| **set_structured_text_bidi_override_options**\ (\ value\: :ref:`Array`\ ) +- :ref:`Array` **get_structured_text_bidi_override_options**\ (\ ) Set additional options for BiDi override. @@ -338,8 +341,8 @@ Set additional options for BiDi override. .. rst-class:: classref-property-setget -- void **set_tab_stops** **(** :ref:`PackedFloat32Array` value **)** -- :ref:`PackedFloat32Array` **get_tab_stops** **(** **)** +- |void| **set_tab_stops**\ (\ value\: :ref:`PackedFloat32Array`\ ) +- :ref:`PackedFloat32Array` **get_tab_stops**\ (\ ) Aligns text to the given tab-stops. @@ -355,8 +358,8 @@ Aligns text to the given tab-stops. .. rst-class:: classref-property-setget -- void **set_text** **(** :ref:`String` value **)** -- :ref:`String` **get_text** **(** **)** +- |void| **set_text**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_text**\ (\ ) The text to display on screen. @@ -372,8 +375,8 @@ The text to display on screen. .. rst-class:: classref-property-setget -- void **set_text_direction** **(** :ref:`TextDirection` value **)** -- :ref:`TextDirection` **get_text_direction** **(** **)** +- |void| **set_text_direction**\ (\ value\: :ref:`TextDirection`\ ) +- :ref:`TextDirection` **get_text_direction**\ (\ ) Base text writing direction. @@ -389,8 +392,8 @@ Base text writing direction. .. rst-class:: classref-property-setget -- void **set_text_overrun_behavior** **(** :ref:`OverrunBehavior` value **)** -- :ref:`OverrunBehavior` **get_text_overrun_behavior** **(** **)** +- |void| **set_text_overrun_behavior**\ (\ value\: :ref:`OverrunBehavior`\ ) +- :ref:`OverrunBehavior` **get_text_overrun_behavior**\ (\ ) Sets the clipping behavior when the text exceeds the node's bounding rectangle. See :ref:`OverrunBehavior` for a description of all modes. @@ -406,8 +409,8 @@ Sets the clipping behavior when the text exceeds the node's bounding rectangle. .. rst-class:: classref-property-setget -- void **set_uppercase** **(** :ref:`bool` value **)** -- :ref:`bool` **is_uppercase** **(** **)** +- |void| **set_uppercase**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_uppercase**\ (\ ) If ``true``, all the text displays as UPPERCASE. @@ -423,8 +426,8 @@ If ``true``, all the text displays as UPPERCASE. .. rst-class:: classref-property-setget -- void **set_vertical_alignment** **(** :ref:`VerticalAlignment` value **)** -- :ref:`VerticalAlignment` **get_vertical_alignment** **(** **)** +- |void| **set_vertical_alignment**\ (\ value\: :ref:`VerticalAlignment`\ ) +- :ref:`VerticalAlignment` **get_vertical_alignment**\ (\ ) Controls the text's vertical alignment. Supports top, center, bottom, and fill. Set it to one of the :ref:`VerticalAlignment` constants. @@ -440,8 +443,8 @@ Controls the text's vertical alignment. Supports top, center, bottom, and fill. .. rst-class:: classref-property-setget -- void **set_visible_characters** **(** :ref:`int` value **)** -- :ref:`int` **get_visible_characters** **(** **)** +- |void| **set_visible_characters**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_visible_characters**\ (\ ) The number of characters to display. If set to ``-1``, all characters are displayed. This can be useful when animating the text appearing in a dialog box. @@ -459,8 +462,8 @@ The number of characters to display. If set to ``-1``, all characters are displa .. rst-class:: classref-property-setget -- void **set_visible_characters_behavior** **(** :ref:`VisibleCharactersBehavior` value **)** -- :ref:`VisibleCharactersBehavior` **get_visible_characters_behavior** **(** **)** +- |void| **set_visible_characters_behavior**\ (\ value\: :ref:`VisibleCharactersBehavior`\ ) +- :ref:`VisibleCharactersBehavior` **get_visible_characters_behavior**\ (\ ) Sets the clipping behavior when :ref:`visible_characters` or :ref:`visible_ratio` is set. See :ref:`VisibleCharactersBehavior` for more info. @@ -476,8 +479,8 @@ Sets the clipping behavior when :ref:`visible_characters` value **)** -- :ref:`float` **get_visible_ratio** **(** **)** +- |void| **set_visible_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_visible_ratio**\ (\ ) The fraction of characters to display, relative to the total number of characters (see :ref:`get_total_character_count`). If set to ``1.0``, all characters are displayed. If set to ``0.5``, only half of the characters will be displayed. This can be useful when animating the text appearing in a dialog box. @@ -496,7 +499,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Rect2` **get_character_bounds** **(** :ref:`int` pos **)** |const| +:ref:`Rect2` **get_character_bounds**\ (\ pos\: :ref:`int`\ ) |const| Returns the bounding rectangle of the character at position ``pos``. If the character is a non-visual character or ``pos`` is outside the valid range, an empty :ref:`Rect2` is returned. If the character is a part of a composite grapheme, the bounding rectangle of the whole grapheme is returned. @@ -508,7 +511,7 @@ Returns the bounding rectangle of the character at position ``pos``. If the char .. rst-class:: classref-method -:ref:`int` **get_line_count** **(** **)** |const| +:ref:`int` **get_line_count**\ (\ ) |const| Returns the number of lines of text the Label has. @@ -520,7 +523,7 @@ Returns the number of lines of text the Label has. .. rst-class:: classref-method -:ref:`int` **get_line_height** **(** :ref:`int` line=-1 **)** |const| +:ref:`int` **get_line_height**\ (\ line\: :ref:`int` = -1\ ) |const| Returns the height of the line ``line``. @@ -536,7 +539,7 @@ If there are no lines, returns font size in pixels. .. rst-class:: classref-method -:ref:`int` **get_total_character_count** **(** **)** |const| +:ref:`int` **get_total_character_count**\ (\ ) |const| Returns the total number of printable characters in the text (excluding spaces and newlines). @@ -548,7 +551,7 @@ Returns the total number of printable characters in the text (excluding spaces a .. rst-class:: classref-method -:ref:`int` **get_visible_line_count** **(** **)** |const| +:ref:`int` **get_visible_line_count**\ (\ ) |const| Returns the number of lines shown. Useful if the **Label**'s height cannot currently display all lines. @@ -700,3 +703,4 @@ Background :ref:`StyleBox` for the **Label**. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_label3d.rst b/classes/class_label3d.rst index c62dd96a002..c66eab83e43 100644 --- a/classes/class_label3d.rst +++ b/classes/class_label3d.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: text + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -65,7 +68,7 @@ Properties +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ | :ref:`HorizontalAlignment` | :ref:`horizontal_alignment` | ``1`` | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`JustificationFlag`\> | :ref:`justification_flags` | ``163`` | + | |bitfield|\[:ref:`JustificationFlag`\] | :ref:`justification_flags` | ``163`` | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`language` | ``""`` | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ @@ -114,13 +117,13 @@ Methods .. table:: :widths: auto - +-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** |const| | - +-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_draw_flag` **(** :ref:`DrawFlags` flag **)** |const| | - +-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_draw_flag` **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** | - +-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TriangleMesh` | :ref:`generate_triangle_mesh`\ (\ ) |const| | + +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_draw_flag`\ (\ flag\: :ref:`DrawFlags`\ ) |const| | + +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_draw_flag`\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -242,8 +245,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_alpha_antialiasing_edge** **(** :ref:`float` value **)** -- :ref:`float` **get_alpha_antialiasing_edge** **(** **)** +- |void| **set_alpha_antialiasing_edge**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_alpha_antialiasing_edge**\ (\ ) Threshold at which antialiasing will be applied on the alpha channel. @@ -259,8 +262,8 @@ Threshold at which antialiasing will be applied on the alpha channel. .. rst-class:: classref-property-setget -- void **set_alpha_antialiasing** **(** :ref:`AlphaAntiAliasing` value **)** -- :ref:`AlphaAntiAliasing` **get_alpha_antialiasing** **(** **)** +- |void| **set_alpha_antialiasing**\ (\ value\: :ref:`AlphaAntiAliasing`\ ) +- :ref:`AlphaAntiAliasing` **get_alpha_antialiasing**\ (\ ) The type of alpha antialiasing to apply. See :ref:`AlphaAntiAliasing`. @@ -276,8 +279,8 @@ The type of alpha antialiasing to apply. See :ref:`AlphaAntiAliasing` value **)** -- :ref:`AlphaCutMode` **get_alpha_cut_mode** **(** **)** +- |void| **set_alpha_cut_mode**\ (\ value\: :ref:`AlphaCutMode`\ ) +- :ref:`AlphaCutMode` **get_alpha_cut_mode**\ (\ ) The alpha cutting mode to use for the sprite. See :ref:`AlphaCutMode` for possible values. @@ -293,8 +296,8 @@ The alpha cutting mode to use for the sprite. See :ref:`AlphaCutMode` value **)** -- :ref:`float` **get_alpha_hash_scale** **(** **)** +- |void| **set_alpha_hash_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_alpha_hash_scale**\ (\ ) The hashing scale for Alpha Hash. Recommended values between ``0`` and ``2``. @@ -310,8 +313,8 @@ The hashing scale for Alpha Hash. Recommended values between ``0`` and ``2``. .. rst-class:: classref-property-setget -- void **set_alpha_scissor_threshold** **(** :ref:`float` value **)** -- :ref:`float` **get_alpha_scissor_threshold** **(** **)** +- |void| **set_alpha_scissor_threshold**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_alpha_scissor_threshold**\ (\ ) Threshold at which the alpha scissor will discard values. @@ -327,8 +330,8 @@ Threshold at which the alpha scissor will discard values. .. rst-class:: classref-property-setget -- void **set_autowrap_mode** **(** :ref:`AutowrapMode` value **)** -- :ref:`AutowrapMode` **get_autowrap_mode** **(** **)** +- |void| **set_autowrap_mode**\ (\ value\: :ref:`AutowrapMode`\ ) +- :ref:`AutowrapMode` **get_autowrap_mode**\ (\ ) If set to something other than :ref:`TextServer.AUTOWRAP_OFF`, the text gets wrapped inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. To see how each mode behaves, see :ref:`AutowrapMode`. @@ -344,8 +347,8 @@ If set to something other than :ref:`TextServer.AUTOWRAP_OFF` value **)** -- :ref:`BillboardMode` **get_billboard_mode** **(** **)** +- |void| **set_billboard_mode**\ (\ value\: :ref:`BillboardMode`\ ) +- :ref:`BillboardMode` **get_billboard_mode**\ (\ ) The billboard mode to use for the label. See :ref:`BillboardMode` for possible values. @@ -361,8 +364,8 @@ The billboard mode to use for the label. See :ref:`BillboardMode` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** |const| +- |void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| If ``true``, text can be seen from the back as well, if ``false``, it is invisible when looking at it from behind. @@ -378,8 +381,8 @@ If ``true``, text can be seen from the back as well, if ``false``, it is invisib .. rst-class:: classref-property-setget -- void **set_draw_flag** **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** |const| +- |void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| If ``true``, the label is rendered at the same size regardless of distance. @@ -395,8 +398,8 @@ If ``true``, the label is rendered at the same size regardless of distance. .. rst-class:: classref-property-setget -- void **set_font** **(** :ref:`Font` value **)** -- :ref:`Font` **get_font** **(** **)** +- |void| **set_font**\ (\ value\: :ref:`Font`\ ) +- :ref:`Font` **get_font**\ (\ ) Font configuration used to display text. @@ -412,8 +415,8 @@ Font configuration used to display text. .. rst-class:: classref-property-setget -- void **set_font_size** **(** :ref:`int` value **)** -- :ref:`int` **get_font_size** **(** **)** +- |void| **set_font_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_font_size**\ (\ ) Font size of the **Label3D**'s text. To make the font look more detailed when up close, increase :ref:`font_size` while decreasing :ref:`pixel_size` at the same time. @@ -431,8 +434,8 @@ Higher font sizes require more time to render new characters, which can cause st .. rst-class:: classref-property-setget -- void **set_horizontal_alignment** **(** :ref:`HorizontalAlignment` value **)** -- :ref:`HorizontalAlignment` **get_horizontal_alignment** **(** **)** +- |void| **set_horizontal_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) +- :ref:`HorizontalAlignment` **get_horizontal_alignment**\ (\ ) Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify. Set it to one of the :ref:`HorizontalAlignment` constants. @@ -444,12 +447,12 @@ Controls the text's horizontal alignment. Supports left, center, right, and fill .. rst-class:: classref-property -|bitfield|\<:ref:`JustificationFlag`\> **justification_flags** = ``163`` +|bitfield|\[:ref:`JustificationFlag`\] **justification_flags** = ``163`` .. rst-class:: classref-property-setget -- void **set_justification_flags** **(** |bitfield|\<:ref:`JustificationFlag`\> value **)** -- |bitfield|\<:ref:`JustificationFlag`\> **get_justification_flags** **(** **)** +- |void| **set_justification_flags**\ (\ value\: |bitfield|\[:ref:`JustificationFlag`\]\ ) +- |bitfield|\[:ref:`JustificationFlag`\] **get_justification_flags**\ (\ ) Line fill alignment rules. For more info see :ref:`JustificationFlag`. @@ -465,8 +468,8 @@ Line fill alignment rules. For more info see :ref:`JustificationFlag` value **)** -- :ref:`String` **get_language** **(** **)** +- |void| **set_language**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_language**\ (\ ) Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -482,8 +485,8 @@ Language code used for line-breaking and text shaping algorithms, if left empty .. rst-class:: classref-property-setget -- void **set_line_spacing** **(** :ref:`float` value **)** -- :ref:`float` **get_line_spacing** **(** **)** +- |void| **set_line_spacing**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_line_spacing**\ (\ ) Vertical space between lines in multiline **Label3D**. @@ -499,8 +502,8 @@ Vertical space between lines in multiline **Label3D**. .. rst-class:: classref-property-setget -- void **set_modulate** **(** :ref:`Color` value **)** -- :ref:`Color` **get_modulate** **(** **)** +- |void| **set_modulate**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_modulate**\ (\ ) Text :ref:`Color` of the **Label3D**. @@ -516,8 +519,8 @@ Text :ref:`Color` of the **Label3D**. .. rst-class:: classref-property-setget -- void **set_draw_flag** **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** |const| +- |void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| If ``true``, depth testing is disabled and the object will be drawn in render order. @@ -533,8 +536,8 @@ If ``true``, depth testing is disabled and the object will be drawn in render or .. rst-class:: classref-property-setget -- void **set_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_offset** **(** **)** +- |void| **set_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_offset**\ (\ ) The text drawing offset (in pixels). @@ -550,8 +553,8 @@ The text drawing offset (in pixels). .. rst-class:: classref-property-setget -- void **set_outline_modulate** **(** :ref:`Color` value **)** -- :ref:`Color` **get_outline_modulate** **(** **)** +- |void| **set_outline_modulate**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_outline_modulate**\ (\ ) The tint of text outline. @@ -567,8 +570,8 @@ The tint of text outline. .. rst-class:: classref-property-setget -- void **set_outline_render_priority** **(** :ref:`int` value **)** -- :ref:`int` **get_outline_render_priority** **(** **)** +- |void| **set_outline_render_priority**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_outline_render_priority**\ (\ ) Sets the render priority for the text outline. Higher priority objects will be sorted in front of lower priority objects. @@ -588,8 +591,8 @@ Sets the render priority for the text outline. Higher priority objects will be s .. rst-class:: classref-property-setget -- void **set_outline_size** **(** :ref:`int` value **)** -- :ref:`int` **get_outline_size** **(** **)** +- |void| **set_outline_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_outline_size**\ (\ ) Text outline size. @@ -605,8 +608,8 @@ Text outline size. .. rst-class:: classref-property-setget -- void **set_pixel_size** **(** :ref:`float` value **)** -- :ref:`float` **get_pixel_size** **(** **)** +- |void| **set_pixel_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pixel_size**\ (\ ) The size of one pixel's width on the label to scale it in 3D. To make the font look more detailed when up close, increase :ref:`font_size` while decreasing :ref:`pixel_size` at the same time. @@ -622,8 +625,8 @@ The size of one pixel's width on the label to scale it in 3D. To make the font l .. rst-class:: classref-property-setget -- void **set_render_priority** **(** :ref:`int` value **)** -- :ref:`int` **get_render_priority** **(** **)** +- |void| **set_render_priority**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_render_priority**\ (\ ) Sets the render priority for the text. Higher priority objects will be sorted in front of lower priority objects. @@ -643,8 +646,8 @@ Sets the render priority for the text. Higher priority objects will be sorted in .. rst-class:: classref-property-setget -- void **set_draw_flag** **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** |const| +- |void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| If ``true``, the :ref:`Light3D` in the :ref:`Environment` has effects on the label. @@ -660,8 +663,8 @@ If ``true``, the :ref:`Light3D` in the :ref:`Environment` value **)** -- :ref:`StructuredTextParser` **get_structured_text_bidi_override** **(** **)** +- |void| **set_structured_text_bidi_override**\ (\ value\: :ref:`StructuredTextParser`\ ) +- :ref:`StructuredTextParser` **get_structured_text_bidi_override**\ (\ ) Set BiDi algorithm override for the structured text. @@ -677,8 +680,8 @@ Set BiDi algorithm override for the structured text. .. rst-class:: classref-property-setget -- void **set_structured_text_bidi_override_options** **(** :ref:`Array` value **)** -- :ref:`Array` **get_structured_text_bidi_override_options** **(** **)** +- |void| **set_structured_text_bidi_override_options**\ (\ value\: :ref:`Array`\ ) +- :ref:`Array` **get_structured_text_bidi_override_options**\ (\ ) Set additional options for BiDi override. @@ -694,8 +697,8 @@ Set additional options for BiDi override. .. rst-class:: classref-property-setget -- void **set_text** **(** :ref:`String` value **)** -- :ref:`String` **get_text** **(** **)** +- |void| **set_text**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_text**\ (\ ) The text to display on screen. @@ -711,8 +714,8 @@ The text to display on screen. .. rst-class:: classref-property-setget -- void **set_text_direction** **(** :ref:`Direction` value **)** -- :ref:`Direction` **get_text_direction** **(** **)** +- |void| **set_text_direction**\ (\ value\: :ref:`Direction`\ ) +- :ref:`Direction` **get_text_direction**\ (\ ) Base text writing direction. @@ -728,8 +731,8 @@ Base text writing direction. .. rst-class:: classref-property-setget -- void **set_texture_filter** **(** :ref:`TextureFilter` value **)** -- :ref:`TextureFilter` **get_texture_filter** **(** **)** +- |void| **set_texture_filter**\ (\ value\: :ref:`TextureFilter`\ ) +- :ref:`TextureFilter` **get_texture_filter**\ (\ ) Filter flags for the texture. See :ref:`TextureFilter` for options. @@ -745,8 +748,8 @@ Filter flags for the texture. See :ref:`TextureFilter` value **)** -- :ref:`bool` **is_uppercase** **(** **)** +- |void| **set_uppercase**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_uppercase**\ (\ ) If ``true``, all the text displays as UPPERCASE. @@ -762,8 +765,8 @@ If ``true``, all the text displays as UPPERCASE. .. rst-class:: classref-property-setget -- void **set_vertical_alignment** **(** :ref:`VerticalAlignment` value **)** -- :ref:`VerticalAlignment` **get_vertical_alignment** **(** **)** +- |void| **set_vertical_alignment**\ (\ value\: :ref:`VerticalAlignment`\ ) +- :ref:`VerticalAlignment` **get_vertical_alignment**\ (\ ) Controls the text's vertical alignment. Supports top, center, bottom. Set it to one of the :ref:`VerticalAlignment` constants. @@ -779,8 +782,8 @@ Controls the text's vertical alignment. Supports top, center, bottom. Set it to .. rst-class:: classref-property-setget -- void **set_width** **(** :ref:`float` value **)** -- :ref:`float` **get_width** **(** **)** +- |void| **set_width**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_width**\ (\ ) Text width (in pixels), used for autowrap and fill alignment. @@ -797,7 +800,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** |const| +:ref:`TriangleMesh` **generate_triangle_mesh**\ (\ ) |const| Returns a :ref:`TriangleMesh` with the label's vertices following its current configuration (such as its :ref:`pixel_size`). @@ -809,7 +812,7 @@ Returns a :ref:`TriangleMesh` with the label's vertices foll .. rst-class:: classref-method -:ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** |const| +:ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| Returns the value of the specified flag. @@ -821,7 +824,7 @@ Returns the value of the specified flag. .. rst-class:: classref-method -void **set_draw_flag** **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** +|void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) If ``true``, the specified flag will be enabled. See :ref:`DrawFlags` for a list of flags. @@ -832,3 +835,4 @@ If ``true``, the specified flag will be enabled. See :ref:`DrawFlags` value **)** -- :ref:`Font` **get_font** **(** **)** +- |void| **set_font**\ (\ value\: :ref:`Font`\ ) +- :ref:`Font` **get_font**\ (\ ) :ref:`Font` used for the text. @@ -83,8 +83,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_font_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_font_color** **(** **)** +- |void| **set_font_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_font_color**\ (\ ) Color of the text. @@ -100,8 +100,8 @@ Color of the text. .. rst-class:: classref-property-setget -- void **set_font_size** **(** :ref:`int` value **)** -- :ref:`int` **get_font_size** **(** **)** +- |void| **set_font_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_font_size**\ (\ ) Size of the text. @@ -117,8 +117,8 @@ Size of the text. .. rst-class:: classref-property-setget -- void **set_line_spacing** **(** :ref:`float` value **)** -- :ref:`float` **get_line_spacing** **(** **)** +- |void| **set_line_spacing**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_line_spacing**\ (\ ) Vertical space between lines when the text is multiline. @@ -134,8 +134,8 @@ Vertical space between lines when the text is multiline. .. rst-class:: classref-property-setget -- void **set_outline_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_outline_color** **(** **)** +- |void| **set_outline_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_outline_color**\ (\ ) The color of the outline. @@ -151,8 +151,8 @@ The color of the outline. .. rst-class:: classref-property-setget -- void **set_outline_size** **(** :ref:`int` value **)** -- :ref:`int` **get_outline_size** **(** **)** +- |void| **set_outline_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_outline_size**\ (\ ) Text outline size. @@ -168,8 +168,8 @@ Text outline size. .. rst-class:: classref-property-setget -- void **set_shadow_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_shadow_color** **(** **)** +- |void| **set_shadow_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_shadow_color**\ (\ ) Color of the shadow effect. If alpha is ``0``, no shadow will be drawn. @@ -185,8 +185,8 @@ Color of the shadow effect. If alpha is ``0``, no shadow will be drawn. .. rst-class:: classref-property-setget -- void **set_shadow_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_shadow_offset** **(** **)** +- |void| **set_shadow_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_shadow_offset**\ (\ ) Offset of the shadow effect, in pixels. @@ -202,8 +202,8 @@ Offset of the shadow effect, in pixels. .. rst-class:: classref-property-setget -- void **set_shadow_size** **(** :ref:`int` value **)** -- :ref:`int` **get_shadow_size** **(** **)** +- |void| **set_shadow_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_shadow_size**\ (\ ) Size of the shadow effect. @@ -214,3 +214,4 @@ Size of the shadow effect. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index 1e6df3b14db..be870dd0fe2 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -78,11 +78,11 @@ Methods .. table:: :widths: auto - +---------------------------+-------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_height` **(** **)** |const| | - +---------------------------+-------------------------------------------------------------------------------------------------+ - | void | :ref:`set_height` **(** :ref:`float` height **)** | - +---------------------------+-------------------------------------------------------------------------------------------------+ + +---------------------------+----------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_height`\ (\ ) |const| | + +---------------------------+----------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_height`\ (\ height\: :ref:`float`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -174,8 +174,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_blend_mode** **(** :ref:`BlendMode` value **)** -- :ref:`BlendMode` **get_blend_mode** **(** **)** +- |void| **set_blend_mode**\ (\ value\: :ref:`BlendMode`\ ) +- :ref:`BlendMode` **get_blend_mode**\ (\ ) The Light2D's blend mode. See :ref:`BlendMode` constants for values. @@ -191,8 +191,8 @@ The Light2D's blend mode. See :ref:`BlendMode` constants .. rst-class:: classref-property-setget -- void **set_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_color** **(** **)** +- |void| **set_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_color**\ (\ ) The Light2D's :ref:`Color`. @@ -208,8 +208,8 @@ The Light2D's :ref:`Color`. .. rst-class:: classref-property-setget -- void **set_editor_only** **(** :ref:`bool` value **)** -- :ref:`bool` **is_editor_only** **(** **)** +- |void| **set_editor_only**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_editor_only**\ (\ ) If ``true``, Light2D will only appear when editing the scene. @@ -225,8 +225,8 @@ If ``true``, Light2D will only appear when editing the scene. .. rst-class:: classref-property-setget -- void **set_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_enabled** **(** **)** +- |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_enabled**\ (\ ) If ``true``, Light2D will emit light. @@ -242,8 +242,8 @@ If ``true``, Light2D will emit light. .. rst-class:: classref-property-setget -- void **set_energy** **(** :ref:`float` value **)** -- :ref:`float` **get_energy** **(** **)** +- |void| **set_energy**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_energy**\ (\ ) The Light2D's energy value. The larger the value, the stronger the light. @@ -259,8 +259,8 @@ The Light2D's energy value. The larger the value, the stronger the light. .. rst-class:: classref-property-setget -- void **set_item_cull_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_item_cull_mask** **(** **)** +- |void| **set_item_cull_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_item_cull_mask**\ (\ ) The layer mask. Only objects with a matching :ref:`CanvasItem.light_mask` will be affected by the Light2D. See also :ref:`shadow_item_cull_mask`, which affects which objects can cast shadows. @@ -278,8 +278,8 @@ The layer mask. Only objects with a matching :ref:`CanvasItem.light_mask` value **)** -- :ref:`int` **get_layer_range_max** **(** **)** +- |void| **set_layer_range_max**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_layer_range_max**\ (\ ) Maximum layer value of objects that are affected by the Light2D. @@ -295,8 +295,8 @@ Maximum layer value of objects that are affected by the Light2D. .. rst-class:: classref-property-setget -- void **set_layer_range_min** **(** :ref:`int` value **)** -- :ref:`int` **get_layer_range_min** **(** **)** +- |void| **set_layer_range_min**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_layer_range_min**\ (\ ) Minimum layer value of objects that are affected by the Light2D. @@ -312,8 +312,8 @@ Minimum layer value of objects that are affected by the Light2D. .. rst-class:: classref-property-setget -- void **set_z_range_max** **(** :ref:`int` value **)** -- :ref:`int` **get_z_range_max** **(** **)** +- |void| **set_z_range_max**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_z_range_max**\ (\ ) Maximum ``z`` value of objects that are affected by the Light2D. @@ -329,8 +329,8 @@ Maximum ``z`` value of objects that are affected by the Light2D. .. rst-class:: classref-property-setget -- void **set_z_range_min** **(** :ref:`int` value **)** -- :ref:`int` **get_z_range_min** **(** **)** +- |void| **set_z_range_min**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_z_range_min**\ (\ ) Minimum ``z`` value of objects that are affected by the Light2D. @@ -346,8 +346,8 @@ Minimum ``z`` value of objects that are affected by the Light2D. .. rst-class:: classref-property-setget -- void **set_shadow_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_shadow_color** **(** **)** +- |void| **set_shadow_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_shadow_color**\ (\ ) :ref:`Color` of shadows cast by the Light2D. @@ -363,8 +363,8 @@ Minimum ``z`` value of objects that are affected by the Light2D. .. rst-class:: classref-property-setget -- void **set_shadow_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_shadow_enabled** **(** **)** +- |void| **set_shadow_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_shadow_enabled**\ (\ ) If ``true``, the Light2D will cast shadows. @@ -380,8 +380,8 @@ If ``true``, the Light2D will cast shadows. .. rst-class:: classref-property-setget -- void **set_shadow_filter** **(** :ref:`ShadowFilter` value **)** -- :ref:`ShadowFilter` **get_shadow_filter** **(** **)** +- |void| **set_shadow_filter**\ (\ value\: :ref:`ShadowFilter`\ ) +- :ref:`ShadowFilter` **get_shadow_filter**\ (\ ) Shadow filter type. See :ref:`ShadowFilter` for possible values. @@ -397,8 +397,8 @@ Shadow filter type. See :ref:`ShadowFilter` for possi .. rst-class:: classref-property-setget -- void **set_shadow_smooth** **(** :ref:`float` value **)** -- :ref:`float` **get_shadow_smooth** **(** **)** +- |void| **set_shadow_smooth**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_shadow_smooth**\ (\ ) Smoothing value for shadows. Higher values will result in softer shadows, at the cost of visible streaks that can appear in shadow rendering. :ref:`shadow_filter_smooth` only has an effect if :ref:`shadow_filter` is :ref:`SHADOW_FILTER_PCF5` or :ref:`SHADOW_FILTER_PCF13`. @@ -414,8 +414,8 @@ Smoothing value for shadows. Higher values will result in softer shadows, at the .. rst-class:: classref-property-setget -- void **set_item_shadow_cull_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_item_shadow_cull_mask** **(** **)** +- |void| **set_item_shadow_cull_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_item_shadow_cull_mask**\ (\ ) The shadow mask. Used with :ref:`LightOccluder2D` to cast shadows. Only occluders with a matching :ref:`CanvasItem.light_mask` will cast shadows. See also :ref:`range_item_cull_mask`, which affects which objects can *receive* the light. @@ -432,7 +432,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_height** **(** **)** |const| +:ref:`float` **get_height**\ (\ ) |const| Returns the light's height, which is used in 2D normal mapping. See :ref:`PointLight2D.height` and :ref:`DirectionalLight2D.height`. @@ -444,7 +444,7 @@ Returns the light's height, which is used in 2D normal mapping. See :ref:`PointL .. rst-class:: classref-method -void **set_height** **(** :ref:`float` height **)** +|void| **set_height**\ (\ height\: :ref:`float`\ ) Sets the light's height, which is used in 2D normal mapping. See :ref:`PointLight2D.height` and :ref:`DirectionalLight2D.height`. @@ -455,3 +455,4 @@ Sets the light's height, which is used in 2D normal mapping. See :ref:`PointLigh .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_light3d.rst b/classes/class_light3d.rst index a1d86de7c59..56158e345f5 100644 --- a/classes/class_light3d.rst +++ b/classes/class_light3d.rst @@ -104,13 +104,13 @@ Methods .. table:: :widths: auto - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_correlated_color` **(** **)** |const| | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_param` **(** :ref:`Param` param **)** |const| | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_param` **(** :ref:`Param` param, :ref:`float` value **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_correlated_color`\ (\ ) |const| | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_param`\ (\ param\: :ref:`Param`\ ) |const| | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_param`\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -358,8 +358,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_distance_fade_begin** **(** :ref:`float` value **)** -- :ref:`float` **get_distance_fade_begin** **(** **)** +- |void| **set_distance_fade_begin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_distance_fade_begin**\ (\ ) The distance from the camera at which the light begins to fade away (in 3D units). @@ -377,8 +377,8 @@ The distance from the camera at which the light begins to fade away (in 3D units .. rst-class:: classref-property-setget -- void **set_enable_distance_fade** **(** :ref:`bool` value **)** -- :ref:`bool` **is_distance_fade_enabled** **(** **)** +- |void| **set_enable_distance_fade**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_distance_fade_enabled**\ (\ ) If ``true``, the light will smoothly fade away when far from the active :ref:`Camera3D` starting at :ref:`distance_fade_begin`. This acts as a form of level of detail (LOD). The light will fade out over :ref:`distance_fade_begin` + :ref:`distance_fade_length`, after which it will be culled and not sent to the shader at all. Use this to reduce the number of active lights in a scene and thus improve performance. @@ -396,8 +396,8 @@ If ``true``, the light will smoothly fade away when far from the active :ref:`Ca .. rst-class:: classref-property-setget -- void **set_distance_fade_length** **(** :ref:`float` value **)** -- :ref:`float` **get_distance_fade_length** **(** **)** +- |void| **set_distance_fade_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_distance_fade_length**\ (\ ) Distance over which the light and its shadow fades. The light's energy and shadow's opacity is progressively reduced over this distance and is completely invisible at the end. @@ -415,8 +415,8 @@ Distance over which the light and its shadow fades. The light's energy and shado .. rst-class:: classref-property-setget -- void **set_distance_fade_shadow** **(** :ref:`float` value **)** -- :ref:`float` **get_distance_fade_shadow** **(** **)** +- |void| **set_distance_fade_shadow**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_distance_fade_shadow**\ (\ ) The distance from the camera at which the light's shadow cuts off (in 3D units). Set this to a value lower than :ref:`distance_fade_begin` + :ref:`distance_fade_length` to further improve performance, as shadow rendering is often more expensive than light rendering itself. @@ -434,8 +434,8 @@ The distance from the camera at which the light's shadow cuts off (in 3D units). .. rst-class:: classref-property-setget -- void **set_editor_only** **(** :ref:`bool` value **)** -- :ref:`bool` **is_editor_only** **(** **)** +- |void| **set_editor_only**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_editor_only**\ (\ ) If ``true``, the light only appears in the editor and will not be visible at runtime. If ``true``, the light will never be baked in :ref:`LightmapGI` regardless of its :ref:`light_bake_mode`. @@ -451,8 +451,8 @@ If ``true``, the light only appears in the editor and will not be visible at run .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The light's angular size in degrees. Increasing this will make shadows softer at greater distances (also called percentage-closer soft shadows, or PCSS). Only available for :ref:`DirectionalLight3D`\ s. For reference, the Sun from the Earth is approximately ``0.5``. Increasing this value above ``0.0`` for lights with shadows enabled will have a noticeable performance cost due to PCSS. @@ -472,8 +472,8 @@ The light's angular size in degrees. Increasing this will make shadows softer at .. rst-class:: classref-property-setget -- void **set_bake_mode** **(** :ref:`BakeMode` value **)** -- :ref:`BakeMode` **get_bake_mode** **(** **)** +- |void| **set_bake_mode**\ (\ value\: :ref:`BakeMode`\ ) +- :ref:`BakeMode` **get_bake_mode**\ (\ ) The light's bake mode. This will affect the global illumination techniques that have an effect on the light's rendering. See :ref:`BakeMode`. @@ -491,8 +491,8 @@ The light's bake mode. This will affect the global illumination techniques that .. rst-class:: classref-property-setget -- void **set_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_color** **(** **)** +- |void| **set_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_color**\ (\ ) The light's color. An *overbright* color can be used to achieve a result equivalent to increasing the light's :ref:`light_energy`. @@ -508,8 +508,8 @@ The light's color. An *overbright* color can be used to achieve a result equival .. rst-class:: classref-property-setget -- void **set_cull_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_cull_mask** **(** **)** +- |void| **set_cull_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_cull_mask**\ (\ ) The light will affect objects in the selected layers. @@ -525,8 +525,8 @@ The light will affect objects in the selected layers. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The light's strength multiplier (this is not a physical unit). For :ref:`OmniLight3D` and :ref:`SpotLight3D`, changing this value will only change the light color's intensity, not the light's radius. @@ -542,8 +542,8 @@ The light's strength multiplier (this is not a physical unit). For :ref:`OmniLig .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| Secondary multiplier used with indirect light (light bounces). Used with :ref:`VoxelGI` and SDFGI (see :ref:`Environment.sdfgi_enabled`). @@ -561,8 +561,8 @@ Secondary multiplier used with indirect light (light bounces). Used with :ref:`V .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| Used by positional lights (:ref:`OmniLight3D` and :ref:`SpotLight3D`) when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units` is ``true``. Sets the intensity of the light source measured in Lumens. Lumens are a measure of luminous flux, which is the total amount of visible light emitted by a light source per unit of time. @@ -582,8 +582,8 @@ A typical household lightbulb can range from around 600 lumens to 1,200 lumens, .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| Used by :ref:`DirectionalLight3D`\ s when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units` is ``true``. Sets the intensity of the light source measured in Lux. Lux is a measure of luminous flux per unit area, it is equal to one lumen per square meter. Lux is the measure of how much light hits a surface at a given time. @@ -601,8 +601,8 @@ On a clear sunny day a surface in direct sunlight may be approximately 100,000 l .. rst-class:: classref-property-setget -- void **set_negative** **(** :ref:`bool` value **)** -- :ref:`bool` **is_negative** **(** **)** +- |void| **set_negative**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_negative**\ (\ ) If ``true``, the light's effect is reversed, darkening areas and casting bright shadows. @@ -618,8 +618,8 @@ If ``true``, the light's effect is reversed, darkening areas and casting bright .. rst-class:: classref-property-setget -- void **set_projector** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_projector** **(** **)** +- |void| **set_projector**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_projector**\ (\ ) :ref:`Texture2D` projected by light. :ref:`shadow_enabled` must be on for the projector to work. Light projectors make the light appear as if it is shining through a colored but transparent object, almost like light shining through stained-glass. @@ -639,8 +639,8 @@ If ``true``, the light's effect is reversed, darkening areas and casting bright .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The size of the light in Godot units. Only available for :ref:`OmniLight3D`\ s and :ref:`SpotLight3D`\ s. Increasing this value will make the light fade out slower and shadows appear blurrier (also called percentage-closer soft shadows, or PCSS). This can be used to simulate area lights to an extent. Increasing this value above ``0.0`` for lights with shadows enabled will have a noticeable performance cost due to PCSS. @@ -660,8 +660,8 @@ The size of the light in Godot units. Only available for :ref:`OmniLight3D` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The intensity of the specular blob in objects affected by the light. At ``0``, the light becomes a pure diffuse light. When not baking emission, this can be used to avoid unrealistic reflections when placing lights above an emissive surface. @@ -677,8 +677,8 @@ The intensity of the specular blob in objects affected by the light. At ``0``, t .. rst-class:: classref-property-setget -- void **set_temperature** **(** :ref:`float` value **)** -- :ref:`float` **get_temperature** **(** **)** +- |void| **set_temperature**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_temperature**\ (\ ) Sets the color temperature of the light source, measured in Kelvin. This is used to calculate a correlated color temperature which tints the :ref:`light_color`. @@ -696,8 +696,8 @@ The sun on a cloudy day is approximately 6500 Kelvin, on a clear day it is betwe .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| Secondary multiplier multiplied with :ref:`light_energy` then used with the :ref:`Environment`'s volumetric fog (if enabled). If set to ``0.0``, computing volumetric fog will be skipped for this light, which can improve performance for large amounts of lights when volumetric fog is enabled. @@ -715,8 +715,8 @@ Secondary multiplier multiplied with :ref:`light_energy` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| Used to adjust shadow appearance. Too small a value results in self-shadowing ("shadow acne"), while too large a value causes shadows to separate from casters ("peter-panning"). Adjust as needed. @@ -732,8 +732,8 @@ Used to adjust shadow appearance. Too small a value results in self-shadowing (" .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| Blurs the edges of the shadow. Can be used to hide pixel artifacts in low-resolution shadow maps. A high value can impact performance, make shadows appear grainy and can cause other unwanted artifacts. Try to keep as near default as possible. @@ -749,8 +749,8 @@ Blurs the edges of the shadow. Can be used to hide pixel artifacts in low-resolu .. rst-class:: classref-property-setget -- void **set_shadow** **(** :ref:`bool` value **)** -- :ref:`bool` **has_shadow** **(** **)** +- |void| **set_shadow**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **has_shadow**\ (\ ) If ``true``, the light will cast real-time shadows. This has a significant performance cost. Only enable shadow rendering when it makes a noticeable difference in the scene's appearance, and consider using :ref:`distance_fade_enabled` to hide the light when far away from the :ref:`Camera3D`. @@ -766,8 +766,8 @@ If ``true``, the light will cast real-time shadows. This has a significant perfo .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| Offsets the lookup into the shadow map by the object's normal. This can be used to reduce self-shadowing artifacts without using :ref:`shadow_bias`. In practice, this value should be tweaked along with :ref:`shadow_bias` to reduce artifacts as much as possible. @@ -783,8 +783,8 @@ Offsets the lookup into the shadow map by the object's normal. This can be used .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The opacity to use when rendering the light's shadow map. Values lower than ``1.0`` make the light appear through shadows. This can be used to fake global illumination at a low performance cost. @@ -800,8 +800,8 @@ The opacity to use when rendering the light's shadow map. Values lower than ``1. .. rst-class:: classref-property-setget -- void **set_shadow_reverse_cull_face** **(** :ref:`bool` value **)** -- :ref:`bool` **get_shadow_reverse_cull_face** **(** **)** +- |void| **set_shadow_reverse_cull_face**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_shadow_reverse_cull_face**\ (\ ) If ``true``, reverses the backface culling of the mesh. This can be useful when you have a flat mesh that has a light behind it. If you need to cast a shadow on both sides of the mesh, set the mesh to use double-sided shadows with :ref:`GeometryInstance3D.SHADOW_CASTING_SETTING_DOUBLE_SIDED`. @@ -817,8 +817,8 @@ If ``true``, reverses the backface culling of the mesh. This can be useful when .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -837,7 +837,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Color` **get_correlated_color** **(** **)** |const| +:ref:`Color` **get_correlated_color**\ (\ ) |const| Returns the :ref:`Color` of an idealized blackbody at the given :ref:`light_temperature`. This value is calculated internally based on the :ref:`light_temperature`. This :ref:`Color` is multiplied by :ref:`light_color` before being sent to the :ref:`RenderingServer`. @@ -849,7 +849,7 @@ Returns the :ref:`Color` of an idealized blackbody at the given :re .. rst-class:: classref-method -:ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +:ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| Returns the value of the specified :ref:`Param` parameter. @@ -861,7 +861,7 @@ Returns the value of the specified :ref:`Param` parameter. .. rst-class:: classref-method -void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** +|void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) Sets the value of the specified :ref:`Param` parameter. @@ -872,3 +872,4 @@ Sets the value of the specified :ref:`Param` parameter. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_lightmapgi.rst b/classes/class_lightmapgi.rst index 0ea0a52b799..f623cb31233 100644 --- a/classes/class_lightmapgi.rst +++ b/classes/class_lightmapgi.rst @@ -332,8 +332,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bias** **(** :ref:`float` value **)** -- :ref:`float` **get_bias** **(** **)** +- |void| **set_bias**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_bias**\ (\ ) The bias to use when computing shadows. Increasing :ref:`bias` can fix shadow acne on the resulting baked lightmap, but can introduce peter-panning (shadows not connecting to their casters). Real-time :ref:`Light3D` shadows are not affected by this :ref:`bias` property. @@ -349,8 +349,8 @@ The bias to use when computing shadows. Increasing :ref:`bias` value **)** -- :ref:`float` **get_bounce_indirect_energy** **(** **)** +- |void| **set_bounce_indirect_energy**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_bounce_indirect_energy**\ (\ ) The energy multiplier for each bounce. Higher values will make indirect lighting brighter. A value of ``1.0`` represents physically accurate behavior, but higher values can be used to make indirect lighting propagate more visibly when using a low number of bounces. This can be used to speed up bake times by lowering the number of :ref:`bounces` then increasing :ref:`bounce_indirect_energy`. @@ -368,8 +368,8 @@ The energy multiplier for each bounce. Higher values will make indirect lighting .. rst-class:: classref-property-setget -- void **set_bounces** **(** :ref:`int` value **)** -- :ref:`int` **get_bounces** **(** **)** +- |void| **set_bounces**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_bounces**\ (\ ) Number of light bounces that are taken into account during baking. Higher values result in brighter, more realistic lighting, at the cost of longer bake times. If set to ``0``, only environment lighting, direct light and emissive lighting is baked. @@ -385,8 +385,8 @@ Number of light bounces that are taken into account during baking. Higher values .. rst-class:: classref-property-setget -- void **set_camera_attributes** **(** :ref:`CameraAttributes` value **)** -- :ref:`CameraAttributes` **get_camera_attributes** **(** **)** +- |void| **set_camera_attributes**\ (\ value\: :ref:`CameraAttributes`\ ) +- :ref:`CameraAttributes` **get_camera_attributes**\ (\ ) The :ref:`CameraAttributes` resource that specifies exposure levels to bake at. Auto-exposure and non exposure properties will be ignored. Exposure settings should be used to reduce the dynamic range present when baking. If exposure is too high, the **LightmapGI** will have banding artifacts or may have over-exposure artifacts. @@ -402,8 +402,8 @@ The :ref:`CameraAttributes` resource that specifies expo .. rst-class:: classref-property-setget -- void **set_denoiser_strength** **(** :ref:`float` value **)** -- :ref:`float` **get_denoiser_strength** **(** **)** +- |void| **set_denoiser_strength**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_denoiser_strength**\ (\ ) The strength of denoising step applied to the generated lightmaps. Only effective if :ref:`use_denoiser` is ``true`` and :ref:`ProjectSettings.rendering/lightmapping/denoising/denoiser` is set to JNLM. @@ -419,8 +419,8 @@ The strength of denoising step applied to the generated lightmaps. Only effectiv .. rst-class:: classref-property-setget -- void **set_directional** **(** :ref:`bool` value **)** -- :ref:`bool` **is_directional** **(** **)** +- |void| **set_directional**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_directional**\ (\ ) If ``true``, bakes lightmaps to contain directional information as spherical harmonics. This results in more realistic lighting appearance, especially with normal mapped materials and for lights that have their direct light baked (:ref:`Light3D.light_bake_mode` set to :ref:`Light3D.BAKE_STATIC` and with :ref:`Light3D.editor_only` set to ``false``). The directional information is also used to provide rough reflections for static and dynamic objects. This has a small run-time performance cost as the shader has to perform more work to interpret the direction information from the lightmap. Directional lightmaps also take longer to bake and result in larger file sizes. @@ -438,8 +438,8 @@ If ``true``, bakes lightmaps to contain directional information as spherical har .. rst-class:: classref-property-setget -- void **set_environment_custom_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_environment_custom_color** **(** **)** +- |void| **set_environment_custom_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_environment_custom_color**\ (\ ) The color to use for environment lighting. Only effective if :ref:`environment_mode` is :ref:`ENVIRONMENT_MODE_CUSTOM_COLOR`. @@ -455,8 +455,8 @@ The color to use for environment lighting. Only effective if :ref:`environment_m .. rst-class:: classref-property-setget -- void **set_environment_custom_energy** **(** :ref:`float` value **)** -- :ref:`float` **get_environment_custom_energy** **(** **)** +- |void| **set_environment_custom_energy**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_environment_custom_energy**\ (\ ) The color multiplier to use for environment lighting. Only effective if :ref:`environment_mode` is :ref:`ENVIRONMENT_MODE_CUSTOM_COLOR`. @@ -472,8 +472,8 @@ The color multiplier to use for environment lighting. Only effective if :ref:`en .. rst-class:: classref-property-setget -- void **set_environment_custom_sky** **(** :ref:`Sky` value **)** -- :ref:`Sky` **get_environment_custom_sky** **(** **)** +- |void| **set_environment_custom_sky**\ (\ value\: :ref:`Sky`\ ) +- :ref:`Sky` **get_environment_custom_sky**\ (\ ) The sky to use as a source of environment lighting. Only effective if :ref:`environment_mode` is :ref:`ENVIRONMENT_MODE_CUSTOM_SKY`. @@ -489,8 +489,8 @@ The sky to use as a source of environment lighting. Only effective if :ref:`envi .. rst-class:: classref-property-setget -- void **set_environment_mode** **(** :ref:`EnvironmentMode` value **)** -- :ref:`EnvironmentMode` **get_environment_mode** **(** **)** +- |void| **set_environment_mode**\ (\ value\: :ref:`EnvironmentMode`\ ) +- :ref:`EnvironmentMode` **get_environment_mode**\ (\ ) The environment mode to use when baking lightmaps. @@ -506,8 +506,8 @@ The environment mode to use when baking lightmaps. .. rst-class:: classref-property-setget -- void **set_generate_probes** **(** :ref:`GenerateProbes` value **)** -- :ref:`GenerateProbes` **get_generate_probes** **(** **)** +- |void| **set_generate_probes**\ (\ value\: :ref:`GenerateProbes`\ ) +- :ref:`GenerateProbes` **get_generate_probes**\ (\ ) The level of subdivision to use when automatically generating :ref:`LightmapProbe`\ s for dynamic object lighting. Higher values result in more accurate indirect lighting on dynamic objects, at the cost of longer bake times and larger file sizes. @@ -527,8 +527,8 @@ The level of subdivision to use when automatically generating :ref:`LightmapProb .. rst-class:: classref-property-setget -- void **set_interior** **(** :ref:`bool` value **)** -- :ref:`bool` **is_interior** **(** **)** +- |void| **set_interior**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_interior**\ (\ ) If ``true``, ignore environment lighting when baking lightmaps. @@ -544,8 +544,8 @@ If ``true``, ignore environment lighting when baking lightmaps. .. rst-class:: classref-property-setget -- void **set_light_data** **(** :ref:`LightmapGIData` value **)** -- :ref:`LightmapGIData` **get_light_data** **(** **)** +- |void| **set_light_data**\ (\ value\: :ref:`LightmapGIData`\ ) +- :ref:`LightmapGIData` **get_light_data**\ (\ ) The :ref:`LightmapGIData` associated to this **LightmapGI** node. This resource is automatically created after baking, and is not meant to be created manually. @@ -561,8 +561,8 @@ The :ref:`LightmapGIData` associated to this **LightmapGI* .. rst-class:: classref-property-setget -- void **set_max_texture_size** **(** :ref:`int` value **)** -- :ref:`int` **get_max_texture_size** **(** **)** +- |void| **set_max_texture_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_texture_size**\ (\ ) The maximum texture size for the generated texture atlas. Higher values will result in fewer slices being generated, but may not work on all hardware as a result of hardware limitations on texture sizes. Leave :ref:`max_texture_size` at its default value of ``16384`` if unsure. @@ -578,8 +578,8 @@ The maximum texture size for the generated texture atlas. Higher values will res .. rst-class:: classref-property-setget -- void **set_bake_quality** **(** :ref:`BakeQuality` value **)** -- :ref:`BakeQuality` **get_bake_quality** **(** **)** +- |void| **set_bake_quality**\ (\ value\: :ref:`BakeQuality`\ ) +- :ref:`BakeQuality` **get_bake_quality**\ (\ ) The quality preset to use when baking lightmaps. This affects bake times, but output file sizes remain mostly identical across quality levels. @@ -597,8 +597,8 @@ To further speed up bake times, decrease :ref:`bounces` value **)** -- :ref:`float` **get_texel_scale** **(** **)** +- |void| **set_texel_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_texel_scale**\ (\ ) Scales the lightmap texel density of all meshes for the current bake. This is a multiplier that builds upon the existing lightmap texel size defined in each imported 3D scene, along with the per-mesh density multiplier (which is designed to be used when the same mesh is used at different scales). Lower values will result in faster bake times. @@ -614,8 +614,8 @@ Scales the lightmap texel density of all meshes for the current bake. This is a .. rst-class:: classref-property-setget -- void **set_use_denoiser** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_denoiser** **(** **)** +- |void| **set_use_denoiser**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_denoiser**\ (\ ) If ``true``, uses a GPU-based denoising algorithm on the generated lightmap. This eliminates most noise within the generated lightmap at the cost of longer bake times. File sizes are generally not impacted significantly by the use of a denoiser, although lossless compression may do a better job at compressing a denoised image. @@ -631,8 +631,8 @@ If ``true``, uses a GPU-based denoising algorithm on the generated lightmap. Thi .. rst-class:: classref-property-setget -- void **set_use_texture_for_bounces** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_texture_for_bounces** **(** **)** +- |void| **set_use_texture_for_bounces**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_texture_for_bounces**\ (\ ) If ``true``, a texture with the lighting information will be generated to speed up the generation of indirect lighting at the cost of some accuracy. The geometry might exhibit extra light leak artifacts when using low resolution lightmaps or UVs that stretch the lightmap significantly across surfaces. Leave :ref:`use_texture_for_bounces` at its default value of ``true`` if unsure. @@ -645,3 +645,4 @@ If ``true``, a texture with the lighting information will be generated to speed .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_lightmapgidata.rst b/classes/class_lightmapgidata.rst index 73bee15c9bd..1b53b51ea15 100644 --- a/classes/class_lightmapgidata.rst +++ b/classes/class_lightmapgidata.rst @@ -29,11 +29,11 @@ Properties .. table:: :widths: auto - +-----------------------------------------------+---------------------------------------------------------------------------+--------+ - | :ref:`TextureLayered` | :ref:`light_texture` | | - +-----------------------------------------------+---------------------------------------------------------------------------+--------+ - | :ref:`TextureLayered[]` | :ref:`lightmap_textures` | ``[]`` | - +-----------------------------------------------+---------------------------------------------------------------------------+--------+ + +--------------------------------------------------------------------------+---------------------------------------------------------------------------+--------+ + | :ref:`TextureLayered` | :ref:`light_texture` | | + +--------------------------------------------------------------------------+---------------------------------------------------------------------------+--------+ + | :ref:`Array`\[:ref:`TextureLayered`\] | :ref:`lightmap_textures` | ``[]`` | + +--------------------------------------------------------------------------+---------------------------------------------------------------------------+--------+ .. rst-class:: classref-reftable-group @@ -43,19 +43,19 @@ Methods .. table:: :widths: auto - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_user` **(** :ref:`NodePath` path, :ref:`Rect2` uv_scale, :ref:`int` slice_index, :ref:`int` sub_instance **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_users` **(** **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_user_count` **(** **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_user_path` **(** :ref:`int` user_idx **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_using_spherical_harmonics` **(** **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_uses_spherical_harmonics` **(** :ref:`bool` uses_spherical_harmonics **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_user`\ (\ path\: :ref:`NodePath`, uv_scale\: :ref:`Rect2`, slice_index\: :ref:`int`, sub_instance\: :ref:`int`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_users`\ (\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_user_count`\ (\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_user_path`\ (\ user_idx\: :ref:`int`\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_using_spherical_harmonics`\ (\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_uses_spherical_harmonics`\ (\ uses_spherical_harmonics\: :ref:`bool`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -74,10 +74,10 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_light_texture** **(** :ref:`TextureLayered` value **)** -- :ref:`TextureLayered` **get_light_texture** **(** **)** +- |void| **set_light_texture**\ (\ value\: :ref:`TextureLayered`\ ) +- :ref:`TextureLayered` **get_light_texture**\ (\ ) -**Deprecated:** The lightmap atlas can now have multiple textures. See :ref:`lightmap_textures`. +**Deprecated:** The lightmap atlas can now contain multiple textures. See :ref:`lightmap_textures`. The lightmap atlas texture generated by the lightmapper. @@ -89,12 +89,12 @@ The lightmap atlas texture generated by the lightmapper. .. rst-class:: classref-property -:ref:`TextureLayered[]` **lightmap_textures** = ``[]`` +:ref:`Array`\[:ref:`TextureLayered`\] **lightmap_textures** = ``[]`` .. rst-class:: classref-property-setget -- void **set_lightmap_textures** **(** :ref:`TextureLayered[]` value **)** -- :ref:`TextureLayered[]` **get_lightmap_textures** **(** **)** +- |void| **set_lightmap_textures**\ (\ value\: :ref:`Array`\[:ref:`TextureLayered`\]\ ) +- :ref:`Array`\[:ref:`TextureLayered`\] **get_lightmap_textures**\ (\ ) The lightmap atlas textures generated by the lightmapper. @@ -111,7 +111,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_user** **(** :ref:`NodePath` path, :ref:`Rect2` uv_scale, :ref:`int` slice_index, :ref:`int` sub_instance **)** +|void| **add_user**\ (\ path\: :ref:`NodePath`, uv_scale\: :ref:`Rect2`, slice_index\: :ref:`int`, sub_instance\: :ref:`int`\ ) Adds an object that is considered baked within this **LightmapGIData**. @@ -123,7 +123,7 @@ Adds an object that is considered baked within this **LightmapGIData**. .. rst-class:: classref-method -void **clear_users** **(** **)** +|void| **clear_users**\ (\ ) Clear all objects that are considered baked within this **LightmapGIData**. @@ -135,7 +135,7 @@ Clear all objects that are considered baked within this **LightmapGIData**. .. rst-class:: classref-method -:ref:`int` **get_user_count** **(** **)** |const| +:ref:`int` **get_user_count**\ (\ ) |const| Returns the number of objects that are considered baked within this **LightmapGIData**. @@ -147,7 +147,7 @@ Returns the number of objects that are considered baked within this **LightmapGI .. rst-class:: classref-method -:ref:`NodePath` **get_user_path** **(** :ref:`int` user_idx **)** |const| +:ref:`NodePath` **get_user_path**\ (\ user_idx\: :ref:`int`\ ) |const| Returns the :ref:`NodePath` of the baked object at index ``user_idx``. @@ -159,7 +159,7 @@ Returns the :ref:`NodePath` of the baked object at index ``user_ .. rst-class:: classref-method -:ref:`bool` **is_using_spherical_harmonics** **(** **)** |const| +:ref:`bool` **is_using_spherical_harmonics**\ (\ ) |const| If ``true``, lightmaps were baked with directional information. See also :ref:`LightmapGI.directional`. @@ -171,7 +171,7 @@ If ``true``, lightmaps were baked with directional information. See also :ref:`L .. rst-class:: classref-method -void **set_uses_spherical_harmonics** **(** :ref:`bool` uses_spherical_harmonics **)** +|void| **set_uses_spherical_harmonics**\ (\ uses_spherical_harmonics\: :ref:`bool`\ ) If ``uses_spherical_harmonics`` is ``true``, tells the engine to treat the lightmap data as if it was baked with directional information. @@ -184,3 +184,4 @@ If ``uses_spherical_harmonics`` is ``true``, tells the engine to treat the light .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_lightmapper.rst b/classes/class_lightmapper.rst index f1546f2aa88..cf10058461f 100644 --- a/classes/class_lightmapper.rst +++ b/classes/class_lightmapper.rst @@ -32,3 +32,4 @@ Godot contains a built-in GPU-based lightmapper :ref:`LightmapperRD`) is .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_lightmapprobe.rst b/classes/class_lightmapprobe.rst index f98dbad1187..a13f61b7636 100644 --- a/classes/class_lightmapprobe.rst +++ b/classes/class_lightmapprobe.rst @@ -30,3 +30,4 @@ Typically, :ref:`LightmapGI` probes are placed automatically b .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index f325c8b2dad..1dd3d414b04 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -61,8 +61,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_occluder_polygon** **(** :ref:`OccluderPolygon2D` value **)** -- :ref:`OccluderPolygon2D` **get_occluder_polygon** **(** **)** +- |void| **set_occluder_polygon**\ (\ value\: :ref:`OccluderPolygon2D`\ ) +- :ref:`OccluderPolygon2D` **get_occluder_polygon**\ (\ ) The :ref:`OccluderPolygon2D` used to compute the shadow. @@ -78,8 +78,8 @@ The :ref:`OccluderPolygon2D` used to compute the shadow .. rst-class:: classref-property-setget -- void **set_occluder_light_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_occluder_light_mask** **(** **)** +- |void| **set_occluder_light_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_occluder_light_mask**\ (\ ) The LightOccluder2D's occluder light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s). @@ -95,8 +95,8 @@ The LightOccluder2D's occluder light mask. The LightOccluder2D will cast shadows .. rst-class:: classref-property-setget -- void **set_as_sdf_collision** **(** :ref:`bool` value **)** -- :ref:`bool` **is_set_as_sdf_collision** **(** **)** +- |void| **set_as_sdf_collision**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_set_as_sdf_collision**\ (\ ) If enabled, the occluder will be part of a real-time generated signed distance field that can be used in custom shaders. @@ -107,3 +107,4 @@ If enabled, the occluder will be part of a real-time generated signed distance f .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index f2c38718630..8fadb129817 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -80,19 +80,19 @@ Methods .. table:: :widths: auto - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`int` index=-1 **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_points` **(** **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_point_count` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` index **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_point` **(** :ref:`int` index **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_position` **(** :ref:`int` index, :ref:`Vector2` position **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_point`\ (\ position\: :ref:`Vector2`, index\: :ref:`int` = -1\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_points`\ (\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_point_count`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_point_position`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_point`\ (\ index\: :ref:`int`\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_position`\ (\ index\: :ref:`int`, position\: :ref:`Vector2`\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -218,8 +218,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_antialiased** **(** :ref:`bool` value **)** -- :ref:`bool` **get_antialiased** **(** **)** +- |void| **set_antialiased**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_antialiased**\ (\ ) If ``true``, the polyline's border will be anti-aliased. @@ -237,8 +237,8 @@ If ``true``, the polyline's border will be anti-aliased. .. rst-class:: classref-property-setget -- void **set_begin_cap_mode** **(** :ref:`LineCapMode` value **)** -- :ref:`LineCapMode` **get_begin_cap_mode** **(** **)** +- |void| **set_begin_cap_mode**\ (\ value\: :ref:`LineCapMode`\ ) +- :ref:`LineCapMode` **get_begin_cap_mode**\ (\ ) The style of the beginning of the polyline, if :ref:`closed` is ``false``. Use :ref:`LineCapMode` constants. @@ -254,8 +254,8 @@ The style of the beginning of the polyline, if :ref:`closed` value **)** -- :ref:`bool` **is_closed** **(** **)** +- |void| **set_closed**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_closed**\ (\ ) If ``true`` and the polyline has more than 2 points, the last point and the first one will be connected by a segment. @@ -275,8 +275,8 @@ If ``true`` and the polyline has more than 2 points, the last point and the firs .. rst-class:: classref-property-setget -- void **set_default_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_default_color** **(** **)** +- |void| **set_default_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_default_color**\ (\ ) The color of the polyline. Will not be used if a gradient is set. @@ -292,8 +292,8 @@ The color of the polyline. Will not be used if a gradient is set. .. rst-class:: classref-property-setget -- void **set_end_cap_mode** **(** :ref:`LineCapMode` value **)** -- :ref:`LineCapMode` **get_end_cap_mode** **(** **)** +- |void| **set_end_cap_mode**\ (\ value\: :ref:`LineCapMode`\ ) +- :ref:`LineCapMode` **get_end_cap_mode**\ (\ ) The style of the end of the polyline, if :ref:`closed` is ``false``. Use :ref:`LineCapMode` constants. @@ -309,8 +309,8 @@ The style of the end of the polyline, if :ref:`closed` value **)** -- :ref:`Gradient` **get_gradient** **(** **)** +- |void| **set_gradient**\ (\ value\: :ref:`Gradient`\ ) +- :ref:`Gradient` **get_gradient**\ (\ ) The gradient is drawn through the whole line from start to finish. The :ref:`default_color` will not be used if this property is set. @@ -326,8 +326,8 @@ The gradient is drawn through the whole line from start to finish. The :ref:`def .. rst-class:: classref-property-setget -- void **set_joint_mode** **(** :ref:`LineJointMode` value **)** -- :ref:`LineJointMode` **get_joint_mode** **(** **)** +- |void| **set_joint_mode**\ (\ value\: :ref:`LineJointMode`\ ) +- :ref:`LineJointMode` **get_joint_mode**\ (\ ) The style of the connections between segments of the polyline. Use :ref:`LineJointMode` constants. @@ -343,8 +343,8 @@ The style of the connections between segments of the polyline. Use :ref:`LineJoi .. rst-class:: classref-property-setget -- void **set_points** **(** :ref:`PackedVector2Array` value **)** -- :ref:`PackedVector2Array` **get_points** **(** **)** +- |void| **set_points**\ (\ value\: :ref:`PackedVector2Array`\ ) +- :ref:`PackedVector2Array` **get_points**\ (\ ) The points of the polyline, interpreted in local 2D coordinates. Segments are drawn between the adjacent points in this array. @@ -360,8 +360,8 @@ The points of the polyline, interpreted in local 2D coordinates. Segments are dr .. rst-class:: classref-property-setget -- void **set_round_precision** **(** :ref:`int` value **)** -- :ref:`int` **get_round_precision** **(** **)** +- |void| **set_round_precision**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_round_precision**\ (\ ) The smoothness used for rounded joints and caps. Higher values result in smoother corners, but are more demanding to render and update. @@ -377,8 +377,8 @@ The smoothness used for rounded joints and caps. Higher values result in smoothe .. rst-class:: classref-property-setget -- void **set_sharp_limit** **(** :ref:`float` value **)** -- :ref:`float` **get_sharp_limit** **(** **)** +- |void| **set_sharp_limit**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_sharp_limit**\ (\ ) Determines the miter limit of the polyline. Normally, when :ref:`joint_mode` is set to :ref:`LINE_JOINT_SHARP`, sharp angles fall back to using the logic of :ref:`LINE_JOINT_BEVEL` joints to prevent very long miters. Higher values of this property mean that the fallback to a bevel joint will happen at sharper angles. @@ -394,8 +394,8 @@ Determines the miter limit of the polyline. Normally, when :ref:`joint_mode` value **)** -- :ref:`Texture2D` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ ) The texture used for the polyline. Uses :ref:`texture_mode` for drawing style. @@ -411,8 +411,8 @@ The texture used for the polyline. Uses :ref:`texture_mode` value **)** -- :ref:`LineTextureMode` **get_texture_mode** **(** **)** +- |void| **set_texture_mode**\ (\ value\: :ref:`LineTextureMode`\ ) +- :ref:`LineTextureMode` **get_texture_mode**\ (\ ) The style to render the :ref:`texture` of the polyline. Use :ref:`LineTextureMode` constants. @@ -428,8 +428,8 @@ The style to render the :ref:`texture` of the pol .. rst-class:: classref-property-setget -- void **set_width** **(** :ref:`float` value **)** -- :ref:`float` **get_width** **(** **)** +- |void| **set_width**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_width**\ (\ ) The polyline's width. @@ -445,8 +445,8 @@ The polyline's width. .. rst-class:: classref-property-setget -- void **set_curve** **(** :ref:`Curve` value **)** -- :ref:`Curve` **get_curve** **(** **)** +- |void| **set_curve**\ (\ value\: :ref:`Curve`\ ) +- :ref:`Curve` **get_curve**\ (\ ) The polyline's width curve. The width of the polyline over its length will be equivalent to the value of the width curve over its domain. @@ -463,7 +463,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_point** **(** :ref:`Vector2` position, :ref:`int` index=-1 **)** +|void| **add_point**\ (\ position\: :ref:`Vector2`, index\: :ref:`int` = -1\ ) Adds a point with the specified ``position`` relative to the polyline's own position. If no ``index`` is provided, the new point will be added to the end of the points array. @@ -477,7 +477,7 @@ If ``index`` is given, the new point is inserted before the existing point ident .. rst-class:: classref-method -void **clear_points** **(** **)** +|void| **clear_points**\ (\ ) Removes all points from the polyline, making it empty. @@ -489,7 +489,7 @@ Removes all points from the polyline, making it empty. .. rst-class:: classref-method -:ref:`int` **get_point_count** **(** **)** |const| +:ref:`int` **get_point_count**\ (\ ) |const| Returns the number of points in the polyline. @@ -501,7 +501,7 @@ Returns the number of points in the polyline. .. rst-class:: classref-method -:ref:`Vector2` **get_point_position** **(** :ref:`int` index **)** |const| +:ref:`Vector2` **get_point_position**\ (\ index\: :ref:`int`\ ) |const| Returns the position of the point at index ``index``. @@ -513,7 +513,7 @@ Returns the position of the point at index ``index``. .. rst-class:: classref-method -void **remove_point** **(** :ref:`int` index **)** +|void| **remove_point**\ (\ index\: :ref:`int`\ ) Removes the point at index ``index`` from the polyline. @@ -525,7 +525,7 @@ Removes the point at index ``index`` from the polyline. .. rst-class:: classref-method -void **set_point_position** **(** :ref:`int` index, :ref:`Vector2` position **)** +|void| **set_point_position**\ (\ index\: :ref:`int`, position\: :ref:`Vector2`\ ) Overwrites the position of the point at the given ``index`` with the supplied ``position``. @@ -536,3 +536,4 @@ Overwrites the position of the point at the given ``index`` with the supplied `` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 1988cc5418e..bc37d583d63 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: text, input + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -145,37 +148,37 @@ Methods .. table:: :widths: auto - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`delete_char_at_caret` **(** **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`delete_text` **(** :ref:`int` from_column, :ref:`int` to_column **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`deselect` **(** **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PopupMenu` | :ref:`get_menu` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_scroll_offset` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_selected_text` **(** **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_from_column` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_to_column` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_selection` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`insert_text_at_caret` **(** :ref:`String` text **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_menu_visible` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`menu_option` **(** :ref:`int` option **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`select` **(** :ref:`int` from=0, :ref:`int` to=-1 **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`select_all` **(** **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`delete_char_at_caret`\ (\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`delete_text`\ (\ from_column\: :ref:`int`, to_column\: :ref:`int`\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`deselect`\ (\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PopupMenu` | :ref:`get_menu`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_scroll_offset`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_selected_text`\ (\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_from_column`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_to_column`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_selection`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`insert_text_at_caret`\ (\ text\: :ref:`String`\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_menu_visible`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`menu_option`\ (\ option\: :ref:`int`\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select`\ (\ from\: :ref:`int` = 0, to\: :ref:`int` = -1\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select_all`\ (\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -236,7 +239,7 @@ Signals .. rst-class:: classref-signal -**text_change_rejected** **(** :ref:`String` rejected_substring **)** +**text_change_rejected**\ (\ rejected_substring\: :ref:`String`\ ) Emitted when appending text that overflows the :ref:`max_length`. The appended text is truncated to fit :ref:`max_length`, and the part that couldn't fit is passed as the ``rejected_substring`` argument. @@ -248,7 +251,7 @@ Emitted when appending text that overflows the :ref:`max_length` new_text **)** +**text_changed**\ (\ new_text\: :ref:`String`\ ) Emitted when the text changes. @@ -260,7 +263,7 @@ Emitted when the text changes. .. rst-class:: classref-signal -**text_submitted** **(** :ref:`String` new_text **)** +**text_submitted**\ (\ new_text\: :ref:`String`\ ) Emitted when the user presses :ref:`@GlobalScope.KEY_ENTER` on the **LineEdit**. @@ -622,8 +625,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_horizontal_alignment** **(** :ref:`HorizontalAlignment` value **)** -- :ref:`HorizontalAlignment` **get_horizontal_alignment** **(** **)** +- |void| **set_horizontal_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) +- :ref:`HorizontalAlignment` **get_horizontal_alignment**\ (\ ) Text alignment as defined in the :ref:`HorizontalAlignment` enum. @@ -639,8 +642,8 @@ Text alignment as defined in the :ref:`HorizontalAlignment` value **)** -- :ref:`bool` **is_caret_blink_enabled** **(** **)** +- |void| **set_caret_blink_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_caret_blink_enabled**\ (\ ) If ``true``, makes the caret blink. @@ -656,8 +659,8 @@ If ``true``, makes the caret blink. .. rst-class:: classref-property-setget -- void **set_caret_blink_interval** **(** :ref:`float` value **)** -- :ref:`float` **get_caret_blink_interval** **(** **)** +- |void| **set_caret_blink_interval**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_caret_blink_interval**\ (\ ) The interval at which the caret blinks (in seconds). @@ -673,8 +676,8 @@ The interval at which the caret blinks (in seconds). .. rst-class:: classref-property-setget -- void **set_caret_column** **(** :ref:`int` value **)** -- :ref:`int` **get_caret_column** **(** **)** +- |void| **set_caret_column**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_caret_column**\ (\ ) The caret's column position inside the **LineEdit**. When set, the text may scroll to accommodate it. @@ -690,8 +693,8 @@ The caret's column position inside the **LineEdit**. When set, the text may scro .. rst-class:: classref-property-setget -- void **set_caret_force_displayed** **(** :ref:`bool` value **)** -- :ref:`bool` **is_caret_force_displayed** **(** **)** +- |void| **set_caret_force_displayed**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_caret_force_displayed**\ (\ ) If ``true``, the **LineEdit** will always show the caret, even if focus is lost. @@ -707,8 +710,8 @@ If ``true``, the **LineEdit** will always show the caret, even if focus is lost. .. rst-class:: classref-property-setget -- void **set_caret_mid_grapheme_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_caret_mid_grapheme_enabled** **(** **)** +- |void| **set_caret_mid_grapheme_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_caret_mid_grapheme_enabled**\ (\ ) Allow moving caret, selecting and removing the individual composite character components. @@ -726,8 +729,8 @@ Allow moving caret, selecting and removing the individual composite character co .. rst-class:: classref-property-setget -- void **set_clear_button_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_clear_button_enabled** **(** **)** +- |void| **set_clear_button_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_clear_button_enabled**\ (\ ) If ``true``, the **LineEdit** will show a clear button if :ref:`text` is not empty, which can be used to clear the text quickly. @@ -743,8 +746,8 @@ If ``true``, the **LineEdit** will show a clear button if :ref:`text` value **)** -- :ref:`bool` **is_context_menu_enabled** **(** **)** +- |void| **set_context_menu_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_context_menu_enabled**\ (\ ) If ``true``, the context menu will appear when right-clicked. @@ -760,8 +763,8 @@ If ``true``, the context menu will appear when right-clicked. .. rst-class:: classref-property-setget -- void **set_deselect_on_focus_loss_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_deselect_on_focus_loss_enabled** **(** **)** +- |void| **set_deselect_on_focus_loss_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_deselect_on_focus_loss_enabled**\ (\ ) If ``true``, the selected text will be deselected when focus is lost. @@ -777,8 +780,8 @@ If ``true``, the selected text will be deselected when focus is lost. .. rst-class:: classref-property-setget -- void **set_drag_and_drop_selection_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_drag_and_drop_selection_enabled** **(** **)** +- |void| **set_drag_and_drop_selection_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_drag_and_drop_selection_enabled**\ (\ ) If ``true``, allow drag and drop of selected text. @@ -794,8 +797,8 @@ If ``true``, allow drag and drop of selected text. .. rst-class:: classref-property-setget -- void **set_draw_control_chars** **(** :ref:`bool` value **)** -- :ref:`bool` **get_draw_control_chars** **(** **)** +- |void| **set_draw_control_chars**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_draw_control_chars**\ (\ ) If ``true``, control characters are displayed. @@ -811,8 +814,8 @@ If ``true``, control characters are displayed. .. rst-class:: classref-property-setget -- void **set_editable** **(** :ref:`bool` value **)** -- :ref:`bool` **is_editable** **(** **)** +- |void| **set_editable**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_editable**\ (\ ) If ``false``, existing text cannot be modified and new text cannot be added. @@ -828,8 +831,8 @@ If ``false``, existing text cannot be modified and new text cannot be added. .. rst-class:: classref-property-setget -- void **set_expand_to_text_length_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_expand_to_text_length_enabled** **(** **)** +- |void| **set_expand_to_text_length_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_expand_to_text_length_enabled**\ (\ ) If ``true``, the **LineEdit** width will increase to stay longer than the :ref:`text`. It will **not** compress if the :ref:`text` is shortened. @@ -845,8 +848,8 @@ If ``true``, the **LineEdit** width will increase to stay longer than the :ref:` .. rst-class:: classref-property-setget -- void **set_flat** **(** :ref:`bool` value **)** -- :ref:`bool` **is_flat** **(** **)** +- |void| **set_flat**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_flat**\ (\ ) If ``true``, the **LineEdit** doesn't display decoration. @@ -862,8 +865,8 @@ If ``true``, the **LineEdit** doesn't display decoration. .. rst-class:: classref-property-setget -- void **set_language** **(** :ref:`String` value **)** -- :ref:`String` **get_language** **(** **)** +- |void| **set_language**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_language**\ (\ ) Language code used for line-breaking and text shaping algorithms. If left empty, current locale is used instead. @@ -879,8 +882,8 @@ Language code used for line-breaking and text shaping algorithms. If left empty, .. rst-class:: classref-property-setget -- void **set_max_length** **(** :ref:`int` value **)** -- :ref:`int` **get_max_length** **(** **)** +- |void| **set_max_length**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_length**\ (\ ) Maximum number of characters that can be entered inside the **LineEdit**. If ``0``, there is no limit. @@ -925,8 +928,8 @@ When a limit is defined, characters that would exceed :ref:`max_length` value **)** -- :ref:`bool` **is_middle_mouse_paste_enabled** **(** **)** +- |void| **set_middle_mouse_paste_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_middle_mouse_paste_enabled**\ (\ ) If ``false``, using middle mouse button to paste clipboard will be disabled. @@ -944,8 +947,8 @@ If ``false``, using middle mouse button to paste clipboard will be disabled. .. rst-class:: classref-property-setget -- void **set_placeholder** **(** :ref:`String` value **)** -- :ref:`String` **get_placeholder** **(** **)** +- |void| **set_placeholder**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_placeholder**\ (\ ) Text shown when the **LineEdit** is empty. It is **not** the **LineEdit**'s default value (see :ref:`text`). @@ -961,8 +964,8 @@ Text shown when the **LineEdit** is empty. It is **not** the **LineEdit**'s defa .. rst-class:: classref-property-setget -- void **set_right_icon** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_right_icon** **(** **)** +- |void| **set_right_icon**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_right_icon**\ (\ ) Sets the icon that will appear in the right end of the **LineEdit** if there's no :ref:`text`, or always, if :ref:`clear_button_enabled` is set to ``false``. @@ -978,8 +981,8 @@ Sets the icon that will appear in the right end of the **LineEdit** if there's n .. rst-class:: classref-property-setget -- void **set_secret** **(** :ref:`bool` value **)** -- :ref:`bool` **is_secret** **(** **)** +- |void| **set_secret**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_secret**\ (\ ) If ``true``, every character is replaced with the secret character (see :ref:`secret_character`). @@ -995,8 +998,8 @@ If ``true``, every character is replaced with the secret character (see :ref:`se .. rst-class:: classref-property-setget -- void **set_secret_character** **(** :ref:`String` value **)** -- :ref:`String` **get_secret_character** **(** **)** +- |void| **set_secret_character**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_secret_character**\ (\ ) The character to use to mask secret input. Only a single character can be used as the secret character. If it is longer than one character, only the first one will be used. If it is empty, a space will be used instead. @@ -1012,8 +1015,8 @@ The character to use to mask secret input. Only a single character can be used a .. rst-class:: classref-property-setget -- void **set_select_all_on_focus** **(** :ref:`bool` value **)** -- :ref:`bool` **is_select_all_on_focus** **(** **)** +- |void| **set_select_all_on_focus**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_select_all_on_focus**\ (\ ) If ``true``, the **LineEdit** will select the whole text when it gains focus. @@ -1029,8 +1032,8 @@ If ``true``, the **LineEdit** will select the whole text when it gains focus. .. rst-class:: classref-property-setget -- void **set_selecting_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_selecting_enabled** **(** **)** +- |void| **set_selecting_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_selecting_enabled**\ (\ ) If ``false``, it's impossible to select the text using mouse nor keyboard. @@ -1046,8 +1049,8 @@ If ``false``, it's impossible to select the text using mouse nor keyboard. .. rst-class:: classref-property-setget -- void **set_shortcut_keys_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_shortcut_keys_enabled** **(** **)** +- |void| **set_shortcut_keys_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_shortcut_keys_enabled**\ (\ ) If ``false``, using shortcuts will be disabled. @@ -1063,8 +1066,8 @@ If ``false``, using shortcuts will be disabled. .. rst-class:: classref-property-setget -- void **set_structured_text_bidi_override** **(** :ref:`StructuredTextParser` value **)** -- :ref:`StructuredTextParser` **get_structured_text_bidi_override** **(** **)** +- |void| **set_structured_text_bidi_override**\ (\ value\: :ref:`StructuredTextParser`\ ) +- :ref:`StructuredTextParser` **get_structured_text_bidi_override**\ (\ ) Set BiDi algorithm override for the structured text. @@ -1080,8 +1083,8 @@ Set BiDi algorithm override for the structured text. .. rst-class:: classref-property-setget -- void **set_structured_text_bidi_override_options** **(** :ref:`Array` value **)** -- :ref:`Array` **get_structured_text_bidi_override_options** **(** **)** +- |void| **set_structured_text_bidi_override_options**\ (\ value\: :ref:`Array`\ ) +- :ref:`Array` **get_structured_text_bidi_override_options**\ (\ ) Set additional options for BiDi override. @@ -1097,8 +1100,8 @@ Set additional options for BiDi override. .. rst-class:: classref-property-setget -- void **set_text** **(** :ref:`String` value **)** -- :ref:`String` **get_text** **(** **)** +- |void| **set_text**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_text**\ (\ ) String value of the **LineEdit**. @@ -1116,8 +1119,8 @@ String value of the **LineEdit**. .. rst-class:: classref-property-setget -- void **set_text_direction** **(** :ref:`TextDirection` value **)** -- :ref:`TextDirection` **get_text_direction** **(** **)** +- |void| **set_text_direction**\ (\ value\: :ref:`TextDirection`\ ) +- :ref:`TextDirection` **get_text_direction**\ (\ ) Base text writing direction. @@ -1133,8 +1136,8 @@ Base text writing direction. .. rst-class:: classref-property-setget -- void **set_virtual_keyboard_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_virtual_keyboard_enabled** **(** **)** +- |void| **set_virtual_keyboard_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_virtual_keyboard_enabled**\ (\ ) If ``true``, the native virtual keyboard is shown when focused on platforms that support it. @@ -1150,8 +1153,8 @@ If ``true``, the native virtual keyboard is shown when focused on platforms that .. rst-class:: classref-property-setget -- void **set_virtual_keyboard_type** **(** :ref:`VirtualKeyboardType` value **)** -- :ref:`VirtualKeyboardType` **get_virtual_keyboard_type** **(** **)** +- |void| **set_virtual_keyboard_type**\ (\ value\: :ref:`VirtualKeyboardType`\ ) +- :ref:`VirtualKeyboardType` **get_virtual_keyboard_type**\ (\ ) Specifies the type of virtual keyboard to show. @@ -1168,7 +1171,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Erases the **LineEdit**'s :ref:`text`. @@ -1180,7 +1183,7 @@ Erases the **LineEdit**'s :ref:`text`. .. rst-class:: classref-method -void **delete_char_at_caret** **(** **)** +|void| **delete_char_at_caret**\ (\ ) Deletes one character at the caret's current position (equivalent to pressing :kbd:`Delete`). @@ -1192,7 +1195,7 @@ Deletes one character at the caret's current position (equivalent to pressing :k .. rst-class:: classref-method -void **delete_text** **(** :ref:`int` from_column, :ref:`int` to_column **)** +|void| **delete_text**\ (\ from_column\: :ref:`int`, to_column\: :ref:`int`\ ) Deletes a section of the :ref:`text` going from position ``from_column`` to ``to_column``. Both parameters should be within the text's length. @@ -1204,7 +1207,7 @@ Deletes a section of the :ref:`text` going from po .. rst-class:: classref-method -void **deselect** **(** **)** +|void| **deselect**\ (\ ) Clears the current selection. @@ -1216,7 +1219,7 @@ Clears the current selection. .. rst-class:: classref-method -:ref:`PopupMenu` **get_menu** **(** **)** |const| +:ref:`PopupMenu` **get_menu**\ (\ ) |const| Returns the :ref:`PopupMenu` of this **LineEdit**. By default, this menu is displayed when right-clicking on the **LineEdit**. @@ -1275,7 +1278,7 @@ You can add custom menu items or remove standard ones. Make sure your IDs don't .. rst-class:: classref-method -:ref:`float` **get_scroll_offset** **(** **)** |const| +:ref:`float` **get_scroll_offset**\ (\ ) |const| Returns the scroll offset due to :ref:`caret_column`, as a number of characters. @@ -1287,7 +1290,7 @@ Returns the scroll offset due to :ref:`caret_column` **get_selected_text** **(** **)** +:ref:`String` **get_selected_text**\ (\ ) Returns the text inside the selection. @@ -1299,7 +1302,7 @@ Returns the text inside the selection. .. rst-class:: classref-method -:ref:`int` **get_selection_from_column** **(** **)** |const| +:ref:`int` **get_selection_from_column**\ (\ ) |const| Returns the selection begin column. @@ -1311,7 +1314,7 @@ Returns the selection begin column. .. rst-class:: classref-method -:ref:`int` **get_selection_to_column** **(** **)** |const| +:ref:`int` **get_selection_to_column**\ (\ ) |const| Returns the selection end column. @@ -1323,7 +1326,7 @@ Returns the selection end column. .. rst-class:: classref-method -:ref:`bool` **has_selection** **(** **)** |const| +:ref:`bool` **has_selection**\ (\ ) |const| Returns ``true`` if the user has selected text. @@ -1335,7 +1338,7 @@ Returns ``true`` if the user has selected text. .. rst-class:: classref-method -void **insert_text_at_caret** **(** :ref:`String` text **)** +|void| **insert_text_at_caret**\ (\ text\: :ref:`String`\ ) Inserts ``text`` at the caret. If the resulting value is longer than :ref:`max_length`, nothing happens. @@ -1347,7 +1350,7 @@ Inserts ``text`` at the caret. If the resulting value is longer than :ref:`max_l .. rst-class:: classref-method -:ref:`bool` **is_menu_visible** **(** **)** |const| +:ref:`bool` **is_menu_visible**\ (\ ) |const| Returns whether the menu is visible. Use this instead of ``get_menu().visible`` to improve performance (so the creation of the menu is avoided). @@ -1359,7 +1362,7 @@ Returns whether the menu is visible. Use this instead of ``get_menu().visible`` .. rst-class:: classref-method -void **menu_option** **(** :ref:`int` option **)** +|void| **menu_option**\ (\ option\: :ref:`int`\ ) Executes a given action as defined in the :ref:`MenuItems` enum. @@ -1371,7 +1374,7 @@ Executes a given action as defined in the :ref:`MenuItems` from=0, :ref:`int` to=-1 **)** +|void| **select**\ (\ from\: :ref:`int` = 0, to\: :ref:`int` = -1\ ) Selects characters inside **LineEdit** between ``from`` and ``to``. By default, ``from`` is at the beginning and ``to`` at the end. @@ -1402,7 +1405,7 @@ Selects characters inside **LineEdit** between ``from`` and ``to``. By default, .. rst-class:: classref-method -void **select_all** **(** **)** +|void| **select_all**\ (\ ) Selects the whole :ref:`String`. @@ -1636,3 +1639,4 @@ Background used when **LineEdit** is in read-only mode (:ref:`editable` value **)** -- :ref:`String` **get_language** **(** **)** +- |void| **set_language**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_language**\ (\ ) Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -158,8 +158,8 @@ Language code used for line-breaking and text shaping algorithms, if left empty .. rst-class:: classref-property-setget -- void **set_structured_text_bidi_override** **(** :ref:`StructuredTextParser` value **)** -- :ref:`StructuredTextParser` **get_structured_text_bidi_override** **(** **)** +- |void| **set_structured_text_bidi_override**\ (\ value\: :ref:`StructuredTextParser`\ ) +- :ref:`StructuredTextParser` **get_structured_text_bidi_override**\ (\ ) Set BiDi algorithm override for the structured text. @@ -175,8 +175,8 @@ Set BiDi algorithm override for the structured text. .. rst-class:: classref-property-setget -- void **set_structured_text_bidi_override_options** **(** :ref:`Array` value **)** -- :ref:`Array` **get_structured_text_bidi_override_options** **(** **)** +- |void| **set_structured_text_bidi_override_options**\ (\ value\: :ref:`Array`\ ) +- :ref:`Array` **get_structured_text_bidi_override_options**\ (\ ) Set additional options for BiDi override. @@ -192,8 +192,8 @@ Set additional options for BiDi override. .. rst-class:: classref-property-setget -- void **set_text** **(** :ref:`String` value **)** -- :ref:`String` **get_text** **(** **)** +- |void| **set_text**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_text**\ (\ ) The button's text that will be displayed inside the button's area. @@ -209,8 +209,8 @@ The button's text that will be displayed inside the button's area. .. rst-class:: classref-property-setget -- void **set_text_direction** **(** :ref:`TextDirection` value **)** -- :ref:`TextDirection` **get_text_direction** **(** **)** +- |void| **set_text_direction**\ (\ value\: :ref:`TextDirection`\ ) +- :ref:`TextDirection` **get_text_direction**\ (\ ) Base text writing direction. @@ -226,8 +226,8 @@ Base text writing direction. .. rst-class:: classref-property-setget -- void **set_underline_mode** **(** :ref:`UnderlineMode` value **)** -- :ref:`UnderlineMode` **get_underline_mode** **(** **)** +- |void| **set_underline_mode**\ (\ value\: :ref:`UnderlineMode`\ ) +- :ref:`UnderlineMode` **get_underline_mode**\ (\ ) The underline mode to use for the text. See :ref:`UnderlineMode` for the available modes. @@ -243,8 +243,8 @@ The underline mode to use for the text. See :ref:`UnderlineMode` value **)** -- :ref:`String` **get_uri** **(** **)** +- |void| **set_uri**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_uri**\ (\ ) The `URI `__ for this **LinkButton**. If set to a valid URI, pressing the button opens the URI using the operating system's default program for the protocol (via :ref:`OS.shell_open`). HTTP and HTTPS URLs open the default web browser. @@ -425,3 +425,4 @@ Font size of the **LinkButton**'s text. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index f7fcce57b19..98ba40d049b 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -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; @@ -88,15 +89,15 @@ Methods .. table:: :widths: auto - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_finalize` **(** **)** |virtual| | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_initialize` **(** **)** |virtual| | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_physics_process` **(** :ref:`float` delta **)** |virtual| | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_process` **(** :ref:`float` delta **)** |virtual| | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+----------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_finalize`\ (\ ) |virtual| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_initialize`\ (\ ) |virtual| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_physics_process`\ (\ delta\: :ref:`float`\ ) |virtual| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_process`\ (\ delta\: :ref:`float`\ ) |virtual| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -111,7 +112,7 @@ Signals .. rst-class:: classref-signal -**on_request_permissions_result** **(** :ref:`String` permission, :ref:`bool` granted **)** +**on_request_permissions_result**\ (\ permission\: :ref:`String`, granted\: :ref:`bool`\ ) Emitted when a user responds to a permission request. @@ -235,7 +236,7 @@ Method Descriptions .. rst-class:: classref-method -void **_finalize** **(** **)** |virtual| +|void| **_finalize**\ (\ ) |virtual| Called before the program exits. @@ -247,7 +248,7 @@ Called before the program exits. .. rst-class:: classref-method -void **_initialize** **(** **)** |virtual| +|void| **_initialize**\ (\ ) |virtual| Called once during initialization. @@ -259,7 +260,7 @@ Called once during initialization. .. rst-class:: classref-method -:ref:`bool` **_physics_process** **(** :ref:`float` delta **)** |virtual| +:ref:`bool` **_physics_process**\ (\ delta\: :ref:`float`\ ) |virtual| Called each physics frame with the time since the last physics frame as argument (``delta``, in seconds). Equivalent to :ref:`Node._physics_process`. @@ -273,7 +274,7 @@ If implemented, the method must return a boolean value. ``true`` ends the main l .. rst-class:: classref-method -:ref:`bool` **_process** **(** :ref:`float` delta **)** |virtual| +:ref:`bool` **_process**\ (\ delta\: :ref:`float`\ ) |virtual| Called each process (idle) frame with the time since the last process frame as argument (in seconds). Equivalent to :ref:`Node._process`. @@ -286,3 +287,4 @@ If implemented, the method must return a boolean value. ``true`` ends the main l .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_margincontainer.rst b/classes/class_margincontainer.rst index 0e7af52d820..8269695ce5e 100644 --- a/classes/class_margincontainer.rst +++ b/classes/class_margincontainer.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: padding + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -131,3 +134,4 @@ Offsets towards the inside direct children of the container by this amount of pi .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_marker2d.rst b/classes/class_marker2d.rst index 431cbc5d9fb..6bf588f94e1 100644 --- a/classes/class_marker2d.rst +++ b/classes/class_marker2d.rst @@ -50,8 +50,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_gizmo_extents** **(** :ref:`float` value **)** -- :ref:`float` **get_gizmo_extents** **(** **)** +- |void| **set_gizmo_extents**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_gizmo_extents**\ (\ ) Size of the gizmo cross that appears in the editor. @@ -62,3 +62,4 @@ Size of the gizmo cross that appears in the editor. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_marker3d.rst b/classes/class_marker3d.rst index cafdacc282d..0077ebb3fd0 100644 --- a/classes/class_marker3d.rst +++ b/classes/class_marker3d.rst @@ -50,8 +50,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_gizmo_extents** **(** :ref:`float` value **)** -- :ref:`float` **get_gizmo_extents** **(** **)** +- |void| **set_gizmo_extents**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_gizmo_extents**\ (\ ) Size of the gizmo cross that appears in the editor. @@ -62,3 +62,4 @@ Size of the gizmo cross that appears in the editor. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index 6ca3b1434f8..59d0d562d1b 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -29,19 +29,19 @@ Methods .. table:: :widths: auto - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`base64_to_raw` **(** :ref:`String` base64_str **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`base64_to_utf8` **(** :ref:`String` base64_str **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`base64_to_variant` **(** :ref:`String` base64_str, :ref:`bool` allow_objects=false **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`raw_to_base64` **(** :ref:`PackedByteArray` array **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`utf8_to_base64` **(** :ref:`String` utf8_str **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`variant_to_base64` **(** :ref:`Variant` variant, :ref:`bool` full_objects=false **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`base64_to_raw`\ (\ base64_str\: :ref:`String`\ ) | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`base64_to_utf8`\ (\ base64_str\: :ref:`String`\ ) | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`base64_to_variant`\ (\ base64_str\: :ref:`String`, allow_objects\: :ref:`bool` = false\ ) | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`raw_to_base64`\ (\ array\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`utf8_to_base64`\ (\ utf8_str\: :ref:`String`\ ) | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`variant_to_base64`\ (\ variant\: :ref:`Variant`, full_objects\: :ref:`bool` = false\ ) | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -56,7 +56,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedByteArray` **base64_to_raw** **(** :ref:`String` base64_str **)** +:ref:`PackedByteArray` **base64_to_raw**\ (\ base64_str\: :ref:`String`\ ) Returns a decoded :ref:`PackedByteArray` corresponding to the Base64-encoded string ``base64_str``. @@ -68,7 +68,7 @@ Returns a decoded :ref:`PackedByteArray` corresponding to .. rst-class:: classref-method -:ref:`String` **base64_to_utf8** **(** :ref:`String` base64_str **)** +:ref:`String` **base64_to_utf8**\ (\ base64_str\: :ref:`String`\ ) Returns a decoded string corresponding to the Base64-encoded string ``base64_str``. @@ -80,7 +80,7 @@ Returns a decoded string corresponding to the Base64-encoded string ``base64_str .. rst-class:: classref-method -:ref:`Variant` **base64_to_variant** **(** :ref:`String` base64_str, :ref:`bool` allow_objects=false **)** +:ref:`Variant` **base64_to_variant**\ (\ base64_str\: :ref:`String`, allow_objects\: :ref:`bool` = false\ ) Returns a decoded :ref:`Variant` corresponding to the Base64-encoded string ``base64_str``. If ``allow_objects`` is ``true``, decoding objects is allowed. @@ -96,7 +96,7 @@ Internally, this uses the same decoding mechanism as the :ref:`@GlobalScope.byte .. rst-class:: classref-method -:ref:`String` **raw_to_base64** **(** :ref:`PackedByteArray` array **)** +:ref:`String` **raw_to_base64**\ (\ array\: :ref:`PackedByteArray`\ ) Returns a Base64-encoded string of a given :ref:`PackedByteArray`. @@ -108,7 +108,7 @@ Returns a Base64-encoded string of a given :ref:`PackedByteArray` **utf8_to_base64** **(** :ref:`String` utf8_str **)** +:ref:`String` **utf8_to_base64**\ (\ utf8_str\: :ref:`String`\ ) Returns a Base64-encoded string of the UTF-8 string ``utf8_str``. @@ -120,7 +120,7 @@ Returns a Base64-encoded string of the UTF-8 string ``utf8_str``. .. rst-class:: classref-method -:ref:`String` **variant_to_base64** **(** :ref:`Variant` variant, :ref:`bool` full_objects=false **)** +:ref:`String` **variant_to_base64**\ (\ variant\: :ref:`Variant`, full_objects\: :ref:`bool` = false\ ) Returns a Base64-encoded string of the :ref:`Variant` ``variant``. If ``full_objects`` is ``true``, encoding objects is allowed (and can potentially include code). @@ -133,3 +133,4 @@ Internally, this uses the same encoding mechanism as the :ref:`@GlobalScope.var_ .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_material.rst b/classes/class_material.rst index a29ae9964dc..9416e1ad5f6 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -56,19 +56,19 @@ Methods .. table:: :widths: auto - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_can_do_next_pass` **(** **)** |virtual| |const| | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_can_use_render_priority` **(** **)** |virtual| |const| | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------+ - | :ref:`Mode` | :ref:`_get_shader_mode` **(** **)** |virtual| |const| | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_get_shader_rid` **(** **)** |virtual| |const| | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`create_placeholder` **(** **)** |const| | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`inspect_native_shader_code` **(** **)** | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_can_do_next_pass`\ (\ ) |virtual| |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_can_use_render_priority`\ (\ ) |virtual| |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Mode` | :ref:`_get_shader_mode`\ (\ ) |virtual| |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_get_shader_rid`\ (\ ) |virtual| |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`create_placeholder`\ (\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`inspect_native_shader_code`\ (\ ) | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -112,8 +112,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_next_pass** **(** :ref:`Material` value **)** -- :ref:`Material` **get_next_pass** **(** **)** +- |void| **set_next_pass**\ (\ value\: :ref:`Material`\ ) +- :ref:`Material` **get_next_pass**\ (\ ) Sets the **Material** to be used for the next pass. This renders the object again using a different material. @@ -133,8 +133,8 @@ Sets the **Material** to be used for the next pass. This renders the object agai .. rst-class:: classref-property-setget -- void **set_render_priority** **(** :ref:`int` value **)** -- :ref:`int` **get_render_priority** **(** **)** +- |void| **set_render_priority**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_render_priority**\ (\ ) Sets the render priority for objects in 3D scenes. Higher priority objects will be sorted in front of lower priority objects. In other words, all objects with :ref:`render_priority` ``1`` will render before all objects with :ref:`render_priority` ``0``). @@ -155,7 +155,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_can_do_next_pass** **(** **)** |virtual| |const| +:ref:`bool` **_can_do_next_pass**\ (\ ) |virtual| |const| Only exposed for the purpose of overriding. You cannot call this function directly. Used internally to determine if :ref:`next_pass` should be shown in the editor or not. @@ -167,7 +167,7 @@ Only exposed for the purpose of overriding. You cannot call this function direct .. rst-class:: classref-method -:ref:`bool` **_can_use_render_priority** **(** **)** |virtual| |const| +:ref:`bool` **_can_use_render_priority**\ (\ ) |virtual| |const| Only exposed for the purpose of overriding. You cannot call this function directly. Used internally to determine if :ref:`render_priority` should be shown in the editor or not. @@ -179,7 +179,7 @@ Only exposed for the purpose of overriding. You cannot call this function direct .. rst-class:: classref-method -:ref:`Mode` **_get_shader_mode** **(** **)** |virtual| |const| +:ref:`Mode` **_get_shader_mode**\ (\ ) |virtual| |const| Only exposed for the purpose of overriding. You cannot call this function directly. Used internally by various editor tools. @@ -191,7 +191,7 @@ Only exposed for the purpose of overriding. You cannot call this function direct .. rst-class:: classref-method -:ref:`RID` **_get_shader_rid** **(** **)** |virtual| |const| +:ref:`RID` **_get_shader_rid**\ (\ ) |virtual| |const| Only exposed for the purpose of overriding. You cannot call this function directly. Used internally by various editor tools. Used to access the RID of the **Material**'s :ref:`Shader`. @@ -203,7 +203,7 @@ Only exposed for the purpose of overriding. You cannot call this function direct .. rst-class:: classref-method -:ref:`Resource` **create_placeholder** **(** **)** |const| +:ref:`Resource` **create_placeholder**\ (\ ) |const| Creates a placeholder version of this resource (:ref:`PlaceholderMaterial`). @@ -215,7 +215,7 @@ Creates a placeholder version of this resource (:ref:`PlaceholderMaterial` | :ref:`get_menu_count` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PopupMenu` | :ref:`get_menu_popup` **(** :ref:`int` menu **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_menu_title` **(** :ref:`int` menu **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_menu_tooltip` **(** :ref:`int` menu **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_menu_disabled` **(** :ref:`int` menu **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_menu_hidden` **(** :ref:`int` menu **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_native_menu` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_disable_shortcuts` **(** :ref:`bool` disabled **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_menu_disabled` **(** :ref:`int` menu, :ref:`bool` disabled **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_menu_hidden` **(** :ref:`int` menu, :ref:`bool` hidden **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_menu_title` **(** :ref:`int` menu, :ref:`String` title **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_menu_tooltip` **(** :ref:`int` menu, :ref:`String` tooltip **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_menu_count`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PopupMenu` | :ref:`get_menu_popup`\ (\ menu\: :ref:`int`\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_menu_title`\ (\ menu\: :ref:`int`\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_menu_tooltip`\ (\ menu\: :ref:`int`\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_menu_disabled`\ (\ menu\: :ref:`int`\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_menu_hidden`\ (\ menu\: :ref:`int`\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_native_menu`\ (\ ) |const| | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_disable_shortcuts`\ (\ disabled\: :ref:`bool`\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_menu_disabled`\ (\ menu\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_menu_hidden`\ (\ menu\: :ref:`int`, hidden\: :ref:`bool`\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_menu_title`\ (\ menu\: :ref:`int`, title\: :ref:`String`\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_menu_tooltip`\ (\ menu\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -146,8 +146,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_flat** **(** :ref:`bool` value **)** -- :ref:`bool` **is_flat** **(** **)** +- |void| **set_flat**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_flat**\ (\ ) Flat **MenuBar** don't display item decoration. @@ -163,8 +163,8 @@ Flat **MenuBar** don't display item decoration. .. rst-class:: classref-property-setget -- void **set_language** **(** :ref:`String` value **)** -- :ref:`String` **get_language** **(** **)** +- |void| **set_language**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_language**\ (\ ) Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -180,8 +180,8 @@ Language code used for line-breaking and text shaping algorithms, if left empty .. rst-class:: classref-property-setget -- void **set_prefer_global_menu** **(** :ref:`bool` value **)** -- :ref:`bool` **is_prefer_global_menu** **(** **)** +- |void| **set_prefer_global_menu**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_prefer_global_menu**\ (\ ) If ``true``, **MenuBar** will use system global menu when supported. @@ -197,8 +197,8 @@ If ``true``, **MenuBar** will use system global menu when supported. .. rst-class:: classref-property-setget -- void **set_start_index** **(** :ref:`int` value **)** -- :ref:`int` **get_start_index** **(** **)** +- |void| **set_start_index**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_start_index**\ (\ ) Position in the global menu to insert first **MenuBar** item at. @@ -214,8 +214,8 @@ Position in the global menu to insert first **MenuBar** item at. .. rst-class:: classref-property-setget -- void **set_switch_on_hover** **(** :ref:`bool` value **)** -- :ref:`bool` **is_switch_on_hover** **(** **)** +- |void| **set_switch_on_hover**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_switch_on_hover**\ (\ ) If ``true``, when the cursor hovers above menu item, it will close the current :ref:`PopupMenu` and open the other one. @@ -231,8 +231,8 @@ If ``true``, when the cursor hovers above menu item, it will close the current : .. rst-class:: classref-property-setget -- void **set_text_direction** **(** :ref:`TextDirection` value **)** -- :ref:`TextDirection` **get_text_direction** **(** **)** +- |void| **set_text_direction**\ (\ value\: :ref:`TextDirection`\ ) +- :ref:`TextDirection` **get_text_direction**\ (\ ) Base text writing direction. @@ -249,7 +249,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_menu_count** **(** **)** |const| +:ref:`int` **get_menu_count**\ (\ ) |const| Returns number of menu items. @@ -261,7 +261,7 @@ Returns number of menu items. .. rst-class:: classref-method -:ref:`PopupMenu` **get_menu_popup** **(** :ref:`int` menu **)** |const| +:ref:`PopupMenu` **get_menu_popup**\ (\ menu\: :ref:`int`\ ) |const| Returns :ref:`PopupMenu` associated with menu item. @@ -273,7 +273,7 @@ Returns :ref:`PopupMenu` associated with menu item. .. rst-class:: classref-method -:ref:`String` **get_menu_title** **(** :ref:`int` menu **)** |const| +:ref:`String` **get_menu_title**\ (\ menu\: :ref:`int`\ ) |const| Returns menu item title. @@ -285,7 +285,7 @@ Returns menu item title. .. rst-class:: classref-method -:ref:`String` **get_menu_tooltip** **(** :ref:`int` menu **)** |const| +:ref:`String` **get_menu_tooltip**\ (\ menu\: :ref:`int`\ ) |const| Returns menu item tooltip. @@ -297,7 +297,7 @@ Returns menu item tooltip. .. rst-class:: classref-method -:ref:`bool` **is_menu_disabled** **(** :ref:`int` menu **)** |const| +:ref:`bool` **is_menu_disabled**\ (\ menu\: :ref:`int`\ ) |const| Returns ``true``, if menu item is disabled. @@ -309,7 +309,7 @@ Returns ``true``, if menu item is disabled. .. rst-class:: classref-method -:ref:`bool` **is_menu_hidden** **(** :ref:`int` menu **)** |const| +:ref:`bool` **is_menu_hidden**\ (\ menu\: :ref:`int`\ ) |const| Returns ``true``, if menu item is hidden. @@ -321,7 +321,7 @@ Returns ``true``, if menu item is hidden. .. rst-class:: classref-method -:ref:`bool` **is_native_menu** **(** **)** |const| +:ref:`bool` **is_native_menu**\ (\ ) |const| Returns ``true``, if system global menu is supported and used by this **MenuBar**. @@ -333,7 +333,7 @@ Returns ``true``, if system global menu is supported and used by this **MenuBar* .. rst-class:: classref-method -void **set_disable_shortcuts** **(** :ref:`bool` disabled **)** +|void| **set_disable_shortcuts**\ (\ disabled\: :ref:`bool`\ ) If ``true``, shortcuts are disabled and cannot be used to trigger the button. @@ -345,7 +345,7 @@ If ``true``, shortcuts are disabled and cannot be used to trigger the button. .. rst-class:: classref-method -void **set_menu_disabled** **(** :ref:`int` menu, :ref:`bool` disabled **)** +|void| **set_menu_disabled**\ (\ menu\: :ref:`int`, disabled\: :ref:`bool`\ ) If ``true``, menu item is disabled. @@ -357,7 +357,7 @@ If ``true``, menu item is disabled. .. rst-class:: classref-method -void **set_menu_hidden** **(** :ref:`int` menu, :ref:`bool` hidden **)** +|void| **set_menu_hidden**\ (\ menu\: :ref:`int`, hidden\: :ref:`bool`\ ) If ``true``, menu item is hidden. @@ -369,7 +369,7 @@ If ``true``, menu item is hidden. .. rst-class:: classref-method -void **set_menu_title** **(** :ref:`int` menu, :ref:`String` title **)** +|void| **set_menu_title**\ (\ menu\: :ref:`int`, title\: :ref:`String`\ ) Sets menu item title. @@ -381,7 +381,7 @@ Sets menu item title. .. rst-class:: classref-method -void **set_menu_tooltip** **(** :ref:`int` menu, :ref:`String` tooltip **)** +|void| **set_menu_tooltip**\ (\ menu\: :ref:`int`, tooltip\: :ref:`String`\ ) Sets menu item tooltip. @@ -651,3 +651,4 @@ Default :ref:`StyleBox` for the menu item (for right-to-left lay .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index 2aa1f0ad73d..158c9b88d81 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -53,13 +53,13 @@ Methods .. table:: :widths: auto - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PopupMenu` | :ref:`get_popup` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_disable_shortcuts` **(** :ref:`bool` disabled **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`show_popup` **(** **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`PopupMenu` | :ref:`get_popup`\ (\ ) |const| | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_disable_shortcuts`\ (\ disabled\: :ref:`bool`\ ) | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`show_popup`\ (\ ) | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -74,7 +74,7 @@ Signals .. rst-class:: classref-signal -**about_to_popup** **(** **)** +**about_to_popup**\ (\ ) Emitted when the :ref:`PopupMenu` of this MenuButton is about to show. @@ -95,8 +95,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_item_count** **(** :ref:`int` value **)** -- :ref:`int` **get_item_count** **(** **)** +- |void| **set_item_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_item_count**\ (\ ) The number of items currently in the list. @@ -112,8 +112,8 @@ The number of items currently in the list. .. rst-class:: classref-property-setget -- void **set_switch_on_hover** **(** :ref:`bool` value **)** -- :ref:`bool` **is_switch_on_hover** **(** **)** +- |void| **set_switch_on_hover**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_switch_on_hover**\ (\ ) If ``true``, when the cursor hovers above another **MenuButton** within the same parent which also has :ref:`switch_on_hover` enabled, it will close the current **MenuButton** and open the other one. @@ -130,7 +130,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PopupMenu` **get_popup** **(** **)** |const| +:ref:`PopupMenu` **get_popup**\ (\ ) |const| Returns the :ref:`PopupMenu` contained in this button. @@ -144,7 +144,7 @@ Returns the :ref:`PopupMenu` contained in this button. .. rst-class:: classref-method -void **set_disable_shortcuts** **(** :ref:`bool` disabled **)** +|void| **set_disable_shortcuts**\ (\ disabled\: :ref:`bool`\ ) If ``true``, shortcuts are disabled and cannot be used to trigger the button. @@ -156,7 +156,7 @@ If ``true``, shortcuts are disabled and cannot be used to trigger the button. .. rst-class:: classref-method -void **show_popup** **(** **)** +|void| **show_popup**\ (\ ) Adjusts popup position and sizing for the **MenuButton**, then shows the :ref:`PopupMenu`. Prefer this over using ``get_popup().popup()``. @@ -167,3 +167,4 @@ Adjusts popup position and sizing for the **MenuButton**, then shows the :ref:`P .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index a3b5b79d151..5847e4416fd 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -56,59 +56,59 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`_get_aabb` **(** **)** |virtual| |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_blend_shape_count` **(** **)** |virtual| |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`_get_blend_shape_name` **(** :ref:`int` index **)** |virtual| |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_surface_count` **(** **)** |virtual| |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_blend_shape_name` **(** :ref:`int` index, :ref:`StringName` name **)** |virtual| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_surface_get_array_index_len` **(** :ref:`int` index **)** |virtual| |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_surface_get_array_len` **(** :ref:`int` index **)** |virtual| |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`_surface_get_arrays` **(** :ref:`int` index **)** |virtual| |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array[]` | :ref:`_surface_get_blend_shape_arrays` **(** :ref:`int` index **)** |virtual| |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_surface_get_format` **(** :ref:`int` index **)** |virtual| |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_surface_get_lods` **(** :ref:`int` index **)** |virtual| |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Material` | :ref:`_surface_get_material` **(** :ref:`int` index **)** |virtual| |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_surface_get_primitive_type` **(** :ref:`int` index **)** |virtual| |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_surface_set_material` **(** :ref:`int` index, :ref:`Material` material **)** |virtual| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ConvexPolygonShape3D` | :ref:`create_convex_shape` **(** :ref:`bool` clean=true, :ref:`bool` simplify=false **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Mesh` | :ref:`create_outline` **(** :ref:`float` margin **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`create_placeholder` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ConcavePolygonShape3D` | :ref:`create_trimesh_shape` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`get_aabb` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`get_faces` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_surface_count` **(** **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`surface_get_arrays` **(** :ref:`int` surf_idx **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array[]` | :ref:`surface_get_blend_shape_arrays` **(** :ref:`int` surf_idx **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** |const| | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | - +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`_get_aabb`\ (\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_blend_shape_count`\ (\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`_get_blend_shape_name`\ (\ index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_surface_count`\ (\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_blend_shape_name`\ (\ index\: :ref:`int`, name\: :ref:`StringName`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_surface_get_array_index_len`\ (\ index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_surface_get_array_len`\ (\ index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`_surface_get_arrays`\ (\ index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Array`\] | :ref:`_surface_get_blend_shape_arrays`\ (\ index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_surface_get_format`\ (\ index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_surface_get_lods`\ (\ index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Material` | :ref:`_surface_get_material`\ (\ index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_surface_get_primitive_type`\ (\ index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_surface_set_material`\ (\ index\: :ref:`int`, material\: :ref:`Material`\ ) |virtual| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ConvexPolygonShape3D` | :ref:`create_convex_shape`\ (\ clean\: :ref:`bool` = true, simplify\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Mesh` | :ref:`create_outline`\ (\ margin\: :ref:`float`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`create_placeholder`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ConcavePolygonShape3D` | :ref:`create_trimesh_shape`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TriangleMesh` | :ref:`generate_triangle_mesh`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`get_aabb`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`get_faces`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_surface_count`\ (\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`surface_get_arrays`\ (\ surf_idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Array`\] | :ref:`surface_get_blend_shape_arrays`\ (\ surf_idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Material` | :ref:`surface_get_material`\ (\ surf_idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`surface_set_material`\ (\ surf_idx\: :ref:`int`, material\: :ref:`Material`\ ) | + +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -640,8 +640,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_lightmap_size_hint** **(** :ref:`Vector2i` value **)** -- :ref:`Vector2i` **get_lightmap_size_hint** **(** **)** +- |void| **set_lightmap_size_hint**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_lightmap_size_hint**\ (\ ) Sets a hint to be used for lightmap resolution. @@ -658,7 +658,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AABB` **_get_aabb** **(** **)** |virtual| |const| +:ref:`AABB` **_get_aabb**\ (\ ) |virtual| |const| Virtual method to override the :ref:`AABB` for a custom class extending **Mesh**. @@ -670,7 +670,7 @@ Virtual method to override the :ref:`AABB` for a custom class extend .. rst-class:: classref-method -:ref:`int` **_get_blend_shape_count** **(** **)** |virtual| |const| +:ref:`int` **_get_blend_shape_count**\ (\ ) |virtual| |const| Virtual method to override the number of blend shapes for a custom class extending **Mesh**. @@ -682,7 +682,7 @@ Virtual method to override the number of blend shapes for a custom class extendi .. rst-class:: classref-method -:ref:`StringName` **_get_blend_shape_name** **(** :ref:`int` index **)** |virtual| |const| +:ref:`StringName` **_get_blend_shape_name**\ (\ index\: :ref:`int`\ ) |virtual| |const| Virtual method to override the retrieval of blend shape names for a custom class extending **Mesh**. @@ -694,7 +694,7 @@ Virtual method to override the retrieval of blend shape names for a custom class .. rst-class:: classref-method -:ref:`int` **_get_surface_count** **(** **)** |virtual| |const| +:ref:`int` **_get_surface_count**\ (\ ) |virtual| |const| Virtual method to override the surface count for a custom class extending **Mesh**. @@ -706,7 +706,7 @@ Virtual method to override the surface count for a custom class extending **Mesh .. rst-class:: classref-method -void **_set_blend_shape_name** **(** :ref:`int` index, :ref:`StringName` name **)** |virtual| +|void| **_set_blend_shape_name**\ (\ index\: :ref:`int`, name\: :ref:`StringName`\ ) |virtual| Virtual method to override the names of blend shapes for a custom class extending **Mesh**. @@ -718,7 +718,7 @@ Virtual method to override the names of blend shapes for a custom class extendin .. rst-class:: classref-method -:ref:`int` **_surface_get_array_index_len** **(** :ref:`int` index **)** |virtual| |const| +:ref:`int` **_surface_get_array_index_len**\ (\ index\: :ref:`int`\ ) |virtual| |const| Virtual method to override the surface array index length for a custom class extending **Mesh**. @@ -730,7 +730,7 @@ Virtual method to override the surface array index length for a custom class ext .. rst-class:: classref-method -:ref:`int` **_surface_get_array_len** **(** :ref:`int` index **)** |virtual| |const| +:ref:`int` **_surface_get_array_len**\ (\ index\: :ref:`int`\ ) |virtual| |const| Virtual method to override the surface array length for a custom class extending **Mesh**. @@ -742,7 +742,7 @@ Virtual method to override the surface array length for a custom class extending .. rst-class:: classref-method -:ref:`Array` **_surface_get_arrays** **(** :ref:`int` index **)** |virtual| |const| +:ref:`Array` **_surface_get_arrays**\ (\ index\: :ref:`int`\ ) |virtual| |const| Virtual method to override the surface arrays for a custom class extending **Mesh**. @@ -754,7 +754,7 @@ Virtual method to override the surface arrays for a custom class extending **Mes .. rst-class:: classref-method -:ref:`Array[]` **_surface_get_blend_shape_arrays** **(** :ref:`int` index **)** |virtual| |const| +:ref:`Array`\[:ref:`Array`\] **_surface_get_blend_shape_arrays**\ (\ index\: :ref:`int`\ ) |virtual| |const| Virtual method to override the blend shape arrays for a custom class extending **Mesh**. @@ -766,7 +766,7 @@ Virtual method to override the blend shape arrays for a custom class extending * .. rst-class:: classref-method -:ref:`int` **_surface_get_format** **(** :ref:`int` index **)** |virtual| |const| +:ref:`int` **_surface_get_format**\ (\ index\: :ref:`int`\ ) |virtual| |const| Virtual method to override the surface format for a custom class extending **Mesh**. @@ -778,7 +778,7 @@ Virtual method to override the surface format for a custom class extending **Mes .. rst-class:: classref-method -:ref:`Dictionary` **_surface_get_lods** **(** :ref:`int` index **)** |virtual| |const| +:ref:`Dictionary` **_surface_get_lods**\ (\ index\: :ref:`int`\ ) |virtual| |const| Virtual method to override the surface LODs for a custom class extending **Mesh**. @@ -790,7 +790,7 @@ Virtual method to override the surface LODs for a custom class extending **Mesh* .. rst-class:: classref-method -:ref:`Material` **_surface_get_material** **(** :ref:`int` index **)** |virtual| |const| +:ref:`Material` **_surface_get_material**\ (\ index\: :ref:`int`\ ) |virtual| |const| Virtual method to override the surface material for a custom class extending **Mesh**. @@ -802,7 +802,7 @@ Virtual method to override the surface material for a custom class extending **M .. rst-class:: classref-method -:ref:`int` **_surface_get_primitive_type** **(** :ref:`int` index **)** |virtual| |const| +:ref:`int` **_surface_get_primitive_type**\ (\ index\: :ref:`int`\ ) |virtual| |const| Virtual method to override the surface primitive type for a custom class extending **Mesh**. @@ -814,7 +814,7 @@ Virtual method to override the surface primitive type for a custom class extendi .. rst-class:: classref-method -void **_surface_set_material** **(** :ref:`int` index, :ref:`Material` material **)** |virtual| +|void| **_surface_set_material**\ (\ index\: :ref:`int`, material\: :ref:`Material`\ ) |virtual| Virtual method to override the setting of a ``material`` at the given ``index`` for a custom class extending **Mesh**. @@ -826,7 +826,7 @@ Virtual method to override the setting of a ``material`` at the given ``index`` .. rst-class:: classref-method -:ref:`ConvexPolygonShape3D` **create_convex_shape** **(** :ref:`bool` clean=true, :ref:`bool` simplify=false **)** |const| +:ref:`ConvexPolygonShape3D` **create_convex_shape**\ (\ clean\: :ref:`bool` = true, simplify\: :ref:`bool` = false\ ) |const| Calculate a :ref:`ConvexPolygonShape3D` from the mesh. @@ -842,7 +842,7 @@ If ``simplify`` is ``true``, the geometry can be further simplified to reduce th .. rst-class:: classref-method -:ref:`Mesh` **create_outline** **(** :ref:`float` margin **)** |const| +:ref:`Mesh` **create_outline**\ (\ margin\: :ref:`float`\ ) |const| Calculate an outline mesh at a defined offset (margin) from the original mesh. @@ -856,7 +856,7 @@ Calculate an outline mesh at a defined offset (margin) from the original mesh. .. rst-class:: classref-method -:ref:`Resource` **create_placeholder** **(** **)** |const| +:ref:`Resource` **create_placeholder**\ (\ ) |const| Creates a placeholder version of this resource (:ref:`PlaceholderMesh`). @@ -868,7 +868,7 @@ Creates a placeholder version of this resource (:ref:`PlaceholderMesh` **create_trimesh_shape** **(** **)** |const| +:ref:`ConcavePolygonShape3D` **create_trimesh_shape**\ (\ ) |const| Calculate a :ref:`ConcavePolygonShape3D` from the mesh. @@ -880,7 +880,7 @@ Calculate a :ref:`ConcavePolygonShape3D` from the m .. rst-class:: classref-method -:ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** |const| +:ref:`TriangleMesh` **generate_triangle_mesh**\ (\ ) |const| Generate a :ref:`TriangleMesh` from the mesh. Considers only surfaces using one of these primitive types: :ref:`PRIMITIVE_TRIANGLES`, :ref:`PRIMITIVE_TRIANGLE_STRIP`. @@ -892,7 +892,7 @@ Generate a :ref:`TriangleMesh` from the mesh. Considers only .. rst-class:: classref-method -:ref:`AABB` **get_aabb** **(** **)** |const| +:ref:`AABB` **get_aabb**\ (\ ) |const| Returns the smallest :ref:`AABB` enclosing this mesh in local space. Not affected by ``custom_aabb``. @@ -906,7 +906,7 @@ Returns the smallest :ref:`AABB` enclosing this mesh in local space. .. rst-class:: classref-method -:ref:`PackedVector3Array` **get_faces** **(** **)** |const| +:ref:`PackedVector3Array` **get_faces**\ (\ ) |const| Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle. @@ -918,7 +918,7 @@ Returns all the vertices that make up the faces of the mesh. Each three vertices .. rst-class:: classref-method -:ref:`int` **get_surface_count** **(** **)** |const| +:ref:`int` **get_surface_count**\ (\ ) |const| Returns the number of surfaces that the **Mesh** holds. This is equivalent to :ref:`MeshInstance3D.get_surface_override_material_count`. @@ -930,7 +930,7 @@ Returns the number of surfaces that the **Mesh** holds. This is equivalent to :r .. rst-class:: classref-method -:ref:`Array` **surface_get_arrays** **(** :ref:`int` surf_idx **)** |const| +:ref:`Array` **surface_get_arrays**\ (\ surf_idx\: :ref:`int`\ ) |const| Returns the arrays for the vertices, normals, UVs, etc. that make up the requested surface (see :ref:`ArrayMesh.add_surface_from_arrays`). @@ -942,7 +942,7 @@ Returns the arrays for the vertices, normals, UVs, etc. that make up the request .. rst-class:: classref-method -:ref:`Array[]` **surface_get_blend_shape_arrays** **(** :ref:`int` surf_idx **)** |const| +:ref:`Array`\[:ref:`Array`\] **surface_get_blend_shape_arrays**\ (\ surf_idx\: :ref:`int`\ ) |const| Returns the blend shape arrays for the requested surface. @@ -954,7 +954,7 @@ Returns the blend shape arrays for the requested surface. .. rst-class:: classref-method -:ref:`Material` **surface_get_material** **(** :ref:`int` surf_idx **)** |const| +:ref:`Material` **surface_get_material**\ (\ surf_idx\: :ref:`int`\ ) |const| Returns a :ref:`Material` in a given surface. Surface is rendered using this material. @@ -968,7 +968,7 @@ Returns a :ref:`Material` in a given surface. Surface is rendere .. rst-class:: classref-method -void **surface_set_material** **(** :ref:`int` surf_idx, :ref:`Material` material **)** +|void| **surface_set_material**\ (\ surf_idx\: :ref:`int`, material\: :ref:`Material`\ ) Sets a :ref:`Material` for a given surface. Surface will be rendered using this material. @@ -981,3 +981,4 @@ Sets a :ref:`Material` for a given surface. Surface will be rend .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_meshconvexdecompositionsettings.rst b/classes/class_meshconvexdecompositionsettings.rst index c1c6ab045e3..0debbfedcee 100644 --- a/classes/class_meshconvexdecompositionsettings.rst +++ b/classes/class_meshconvexdecompositionsettings.rst @@ -105,8 +105,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_convex_hull_approximation** **(** :ref:`bool` value **)** -- :ref:`bool` **get_convex_hull_approximation** **(** **)** +- |void| **set_convex_hull_approximation**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_convex_hull_approximation**\ (\ ) If enabled uses approximation for computing convex hulls. @@ -122,8 +122,8 @@ If enabled uses approximation for computing convex hulls. .. rst-class:: classref-property-setget -- void **set_convex_hull_downsampling** **(** :ref:`int` value **)** -- :ref:`int` **get_convex_hull_downsampling** **(** **)** +- |void| **set_convex_hull_downsampling**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_convex_hull_downsampling**\ (\ ) Controls the precision of the convex-hull generation process during the clipping plane selection stage. Ranges from ``1`` to ``16``. @@ -139,8 +139,8 @@ Controls the precision of the convex-hull generation process during the clipping .. rst-class:: classref-property-setget -- void **set_max_concavity** **(** :ref:`float` value **)** -- :ref:`float` **get_max_concavity** **(** **)** +- |void| **set_max_concavity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_max_concavity**\ (\ ) Maximum concavity. Ranges from ``0.0`` to ``1.0``. @@ -156,8 +156,8 @@ Maximum concavity. Ranges from ``0.0`` to ``1.0``. .. rst-class:: classref-property-setget -- void **set_max_convex_hulls** **(** :ref:`int` value **)** -- :ref:`int` **get_max_convex_hulls** **(** **)** +- |void| **set_max_convex_hulls**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_convex_hulls**\ (\ ) The maximum number of convex hulls to produce from the merge operation. @@ -173,8 +173,8 @@ The maximum number of convex hulls to produce from the merge operation. .. rst-class:: classref-property-setget -- void **set_max_num_vertices_per_convex_hull** **(** :ref:`int` value **)** -- :ref:`int` **get_max_num_vertices_per_convex_hull** **(** **)** +- |void| **set_max_num_vertices_per_convex_hull**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_num_vertices_per_convex_hull**\ (\ ) Controls the maximum number of triangles per convex-hull. Ranges from ``4`` to ``1024``. @@ -190,8 +190,8 @@ Controls the maximum number of triangles per convex-hull. Ranges from ``4`` to ` .. rst-class:: classref-property-setget -- void **set_min_volume_per_convex_hull** **(** :ref:`float` value **)** -- :ref:`float` **get_min_volume_per_convex_hull** **(** **)** +- |void| **set_min_volume_per_convex_hull**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_min_volume_per_convex_hull**\ (\ ) Controls the adaptive sampling of the generated convex-hulls. Ranges from ``0.0`` to ``0.01``. @@ -207,8 +207,8 @@ Controls the adaptive sampling of the generated convex-hulls. Ranges from ``0.0` .. rst-class:: classref-property-setget -- void **set_mode** **(** :ref:`Mode` value **)** -- :ref:`Mode` **get_mode** **(** **)** +- |void| **set_mode**\ (\ value\: :ref:`Mode`\ ) +- :ref:`Mode` **get_mode**\ (\ ) Mode for the approximate convex decomposition. @@ -224,8 +224,8 @@ Mode for the approximate convex decomposition. .. rst-class:: classref-property-setget -- void **set_normalize_mesh** **(** :ref:`bool` value **)** -- :ref:`bool` **get_normalize_mesh** **(** **)** +- |void| **set_normalize_mesh**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_normalize_mesh**\ (\ ) If enabled normalizes the mesh before applying the convex decomposition. @@ -241,8 +241,8 @@ If enabled normalizes the mesh before applying the convex decomposition. .. rst-class:: classref-property-setget -- void **set_plane_downsampling** **(** :ref:`int` value **)** -- :ref:`int` **get_plane_downsampling** **(** **)** +- |void| **set_plane_downsampling**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_plane_downsampling**\ (\ ) Controls the granularity of the search for the "best" clipping plane. Ranges from ``1`` to ``16``. @@ -258,8 +258,8 @@ Controls the granularity of the search for the "best" clipping plane. Ranges fro .. rst-class:: classref-property-setget -- void **set_project_hull_vertices** **(** :ref:`bool` value **)** -- :ref:`bool` **get_project_hull_vertices** **(** **)** +- |void| **set_project_hull_vertices**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_project_hull_vertices**\ (\ ) If enabled projects output convex hull vertices onto original source mesh to increase floating point accuracy of the results. @@ -275,8 +275,8 @@ If enabled projects output convex hull vertices onto original source mesh to inc .. rst-class:: classref-property-setget -- void **set_resolution** **(** :ref:`int` value **)** -- :ref:`int` **get_resolution** **(** **)** +- |void| **set_resolution**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_resolution**\ (\ ) Maximum number of voxels generated during the voxelization stage. @@ -292,8 +292,8 @@ Maximum number of voxels generated during the voxelization stage. .. rst-class:: classref-property-setget -- void **set_revolution_axes_clipping_bias** **(** :ref:`float` value **)** -- :ref:`float` **get_revolution_axes_clipping_bias** **(** **)** +- |void| **set_revolution_axes_clipping_bias**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_revolution_axes_clipping_bias**\ (\ ) Controls the bias toward clipping along revolution axes. Ranges from ``0.0`` to ``1.0``. @@ -309,8 +309,8 @@ Controls the bias toward clipping along revolution axes. Ranges from ``0.0`` to .. rst-class:: classref-property-setget -- void **set_symmetry_planes_clipping_bias** **(** :ref:`float` value **)** -- :ref:`float` **get_symmetry_planes_clipping_bias** **(** **)** +- |void| **set_symmetry_planes_clipping_bias**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_symmetry_planes_clipping_bias**\ (\ ) Controls the bias toward clipping along symmetry planes. Ranges from ``0.0`` to ``1.0``. @@ -321,3 +321,4 @@ Controls the bias toward clipping along symmetry planes. Ranges from ``0.0`` to .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index 57e131beea7..5aa309d7bbf 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -87,83 +87,83 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`commit_to_surface` **(** :ref:`ArrayMesh` mesh, :ref:`int` compression_flags=0 **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`create_from_surface` **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_edge_count` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_edge_faces` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_edge_meta` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_edge_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_face_count` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_face_edge` **(** :ref:`int` idx, :ref:`int` edge **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_face_meta` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_face_normal` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_face_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_format` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Material` | :ref:`get_material` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_vertex` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_vertex_bones` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_vertex_color` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_vertex_count` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_vertex_edges` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_vertex_faces` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_vertex_meta` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_vertex_normal` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Plane` | :ref:`get_vertex_tangent` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_vertex_uv` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_vertex_uv2` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`get_vertex_weights` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_edge_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_face_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_material` **(** :ref:`Material` material **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_vertex` **(** :ref:`int` idx, :ref:`Vector3` vertex **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_vertex_bones` **(** :ref:`int` idx, :ref:`PackedInt32Array` bones **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_vertex_color` **(** :ref:`int` idx, :ref:`Color` color **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_vertex_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_vertex_normal` **(** :ref:`int` idx, :ref:`Vector3` normal **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_vertex_tangent` **(** :ref:`int` idx, :ref:`Plane` tangent **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_vertex_uv` **(** :ref:`int` idx, :ref:`Vector2` uv **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_vertex_uv2` **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_vertex_weights` **(** :ref:`int` idx, :ref:`PackedFloat32Array` weights **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`commit_to_surface`\ (\ mesh\: :ref:`ArrayMesh`, compression_flags\: :ref:`int` = 0\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`create_from_surface`\ (\ mesh\: :ref:`ArrayMesh`, surface\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_edge_count`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_edge_faces`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_edge_meta`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_edge_vertex`\ (\ idx\: :ref:`int`, vertex\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_face_count`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_face_edge`\ (\ idx\: :ref:`int`, edge\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_face_meta`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_face_normal`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_face_vertex`\ (\ idx\: :ref:`int`, vertex\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_format`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Material` | :ref:`get_material`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_vertex`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_vertex_bones`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_vertex_color`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_vertex_count`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_vertex_edges`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_vertex_faces`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_vertex_meta`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_vertex_normal`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Plane` | :ref:`get_vertex_tangent`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_vertex_uv`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_vertex_uv2`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`get_vertex_weights`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_edge_meta`\ (\ idx\: :ref:`int`, meta\: :ref:`Variant`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_face_meta`\ (\ idx\: :ref:`int`, meta\: :ref:`Variant`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_material`\ (\ material\: :ref:`Material`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_vertex`\ (\ idx\: :ref:`int`, vertex\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_vertex_bones`\ (\ idx\: :ref:`int`, bones\: :ref:`PackedInt32Array`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_vertex_color`\ (\ idx\: :ref:`int`, color\: :ref:`Color`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_vertex_meta`\ (\ idx\: :ref:`int`, meta\: :ref:`Variant`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_vertex_normal`\ (\ idx\: :ref:`int`, normal\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_vertex_tangent`\ (\ idx\: :ref:`int`, tangent\: :ref:`Plane`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_vertex_uv`\ (\ idx\: :ref:`int`, uv\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_vertex_uv2`\ (\ idx\: :ref:`int`, uv2\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_vertex_weights`\ (\ idx\: :ref:`int`, weights\: :ref:`PackedFloat32Array`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -178,7 +178,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears all data currently in MeshDataTool. @@ -190,7 +190,7 @@ Clears all data currently in MeshDataTool. .. rst-class:: classref-method -:ref:`Error` **commit_to_surface** **(** :ref:`ArrayMesh` mesh, :ref:`int` compression_flags=0 **)** +:ref:`Error` **commit_to_surface**\ (\ mesh\: :ref:`ArrayMesh`, compression_flags\: :ref:`int` = 0\ ) Adds a new surface to specified :ref:`Mesh` with edited data. @@ -202,7 +202,7 @@ Adds a new surface to specified :ref:`Mesh` with edited data. .. rst-class:: classref-method -:ref:`Error` **create_from_surface** **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** +:ref:`Error` **create_from_surface**\ (\ mesh\: :ref:`ArrayMesh`, surface\: :ref:`int`\ ) Uses specified surface of given :ref:`Mesh` to populate data for MeshDataTool. @@ -216,7 +216,7 @@ Requires :ref:`Mesh` with primitive type :ref:`Mesh.PRIMITIVE_TRIANG .. rst-class:: classref-method -:ref:`int` **get_edge_count** **(** **)** |const| +:ref:`int` **get_edge_count**\ (\ ) |const| Returns the number of edges in this :ref:`Mesh`. @@ -228,7 +228,7 @@ Returns the number of edges in this :ref:`Mesh`. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_edge_faces** **(** :ref:`int` idx **)** |const| +:ref:`PackedInt32Array` **get_edge_faces**\ (\ idx\: :ref:`int`\ ) |const| Returns array of faces that touch given edge. @@ -240,7 +240,7 @@ Returns array of faces that touch given edge. .. rst-class:: classref-method -:ref:`Variant` **get_edge_meta** **(** :ref:`int` idx **)** |const| +:ref:`Variant` **get_edge_meta**\ (\ idx\: :ref:`int`\ ) |const| Returns meta information assigned to given edge. @@ -252,7 +252,7 @@ Returns meta information assigned to given edge. .. rst-class:: classref-method -:ref:`int` **get_edge_vertex** **(** :ref:`int` idx, :ref:`int` vertex **)** |const| +:ref:`int` **get_edge_vertex**\ (\ idx\: :ref:`int`, vertex\: :ref:`int`\ ) |const| Returns index of specified vertex connected to given edge. @@ -266,7 +266,7 @@ Vertex argument can only be 0 or 1 because edges are comprised of two vertices. .. rst-class:: classref-method -:ref:`int` **get_face_count** **(** **)** |const| +:ref:`int` **get_face_count**\ (\ ) |const| Returns the number of faces in this :ref:`Mesh`. @@ -278,7 +278,7 @@ Returns the number of faces in this :ref:`Mesh`. .. rst-class:: classref-method -:ref:`int` **get_face_edge** **(** :ref:`int` idx, :ref:`int` edge **)** |const| +:ref:`int` **get_face_edge**\ (\ idx\: :ref:`int`, edge\: :ref:`int`\ ) |const| Returns specified edge associated with given face. @@ -292,7 +292,7 @@ Edge argument must be either 0, 1, or 2 because a face only has three edges. .. rst-class:: classref-method -:ref:`Variant` **get_face_meta** **(** :ref:`int` idx **)** |const| +:ref:`Variant` **get_face_meta**\ (\ idx\: :ref:`int`\ ) |const| Returns the metadata associated with the given face. @@ -304,7 +304,7 @@ Returns the metadata associated with the given face. .. rst-class:: classref-method -:ref:`Vector3` **get_face_normal** **(** :ref:`int` idx **)** |const| +:ref:`Vector3` **get_face_normal**\ (\ idx\: :ref:`int`\ ) |const| Calculates and returns the face normal of the given face. @@ -316,7 +316,7 @@ Calculates and returns the face normal of the given face. .. rst-class:: classref-method -:ref:`int` **get_face_vertex** **(** :ref:`int` idx, :ref:`int` vertex **)** |const| +:ref:`int` **get_face_vertex**\ (\ idx\: :ref:`int`, vertex\: :ref:`int`\ ) |const| Returns the specified vertex index of the given face. @@ -349,7 +349,7 @@ Vertex argument must be either 0, 1, or 2 because faces contain three vertices. .. rst-class:: classref-method -:ref:`int` **get_format** **(** **)** |const| +:ref:`int` **get_format**\ (\ ) |const| Returns the :ref:`Mesh`'s format. Format is an integer made up of :ref:`Mesh` format flags combined together. For example, a mesh containing both vertices and normals would return a format of ``3`` because :ref:`Mesh.ARRAY_FORMAT_VERTEX` is ``1`` and :ref:`Mesh.ARRAY_FORMAT_NORMAL` is ``2``. @@ -363,7 +363,7 @@ See :ref:`ArrayFormat` for a list of format flags. .. rst-class:: classref-method -:ref:`Material` **get_material** **(** **)** |const| +:ref:`Material` **get_material**\ (\ ) |const| Returns the material assigned to the :ref:`Mesh`. @@ -375,7 +375,7 @@ Returns the material assigned to the :ref:`Mesh`. .. rst-class:: classref-method -:ref:`Vector3` **get_vertex** **(** :ref:`int` idx **)** |const| +:ref:`Vector3` **get_vertex**\ (\ idx\: :ref:`int`\ ) |const| Returns the position of the given vertex. @@ -387,7 +387,7 @@ Returns the position of the given vertex. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_vertex_bones** **(** :ref:`int` idx **)** |const| +:ref:`PackedInt32Array` **get_vertex_bones**\ (\ idx\: :ref:`int`\ ) |const| Returns the bones of the given vertex. @@ -399,7 +399,7 @@ Returns the bones of the given vertex. .. rst-class:: classref-method -:ref:`Color` **get_vertex_color** **(** :ref:`int` idx **)** |const| +:ref:`Color` **get_vertex_color**\ (\ idx\: :ref:`int`\ ) |const| Returns the color of the given vertex. @@ -411,7 +411,7 @@ Returns the color of the given vertex. .. rst-class:: classref-method -:ref:`int` **get_vertex_count** **(** **)** |const| +:ref:`int` **get_vertex_count**\ (\ ) |const| Returns the total number of vertices in :ref:`Mesh`. @@ -423,7 +423,7 @@ Returns the total number of vertices in :ref:`Mesh`. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_vertex_edges** **(** :ref:`int` idx **)** |const| +:ref:`PackedInt32Array` **get_vertex_edges**\ (\ idx\: :ref:`int`\ ) |const| Returns an array of edges that share the given vertex. @@ -435,7 +435,7 @@ Returns an array of edges that share the given vertex. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_vertex_faces** **(** :ref:`int` idx **)** |const| +:ref:`PackedInt32Array` **get_vertex_faces**\ (\ idx\: :ref:`int`\ ) |const| Returns an array of faces that share the given vertex. @@ -447,7 +447,7 @@ Returns an array of faces that share the given vertex. .. rst-class:: classref-method -:ref:`Variant` **get_vertex_meta** **(** :ref:`int` idx **)** |const| +:ref:`Variant` **get_vertex_meta**\ (\ idx\: :ref:`int`\ ) |const| Returns the metadata associated with the given vertex. @@ -459,7 +459,7 @@ Returns the metadata associated with the given vertex. .. rst-class:: classref-method -:ref:`Vector3` **get_vertex_normal** **(** :ref:`int` idx **)** |const| +:ref:`Vector3` **get_vertex_normal**\ (\ idx\: :ref:`int`\ ) |const| Returns the normal of the given vertex. @@ -471,7 +471,7 @@ Returns the normal of the given vertex. .. rst-class:: classref-method -:ref:`Plane` **get_vertex_tangent** **(** :ref:`int` idx **)** |const| +:ref:`Plane` **get_vertex_tangent**\ (\ idx\: :ref:`int`\ ) |const| Returns the tangent of the given vertex. @@ -483,7 +483,7 @@ Returns the tangent of the given vertex. .. rst-class:: classref-method -:ref:`Vector2` **get_vertex_uv** **(** :ref:`int` idx **)** |const| +:ref:`Vector2` **get_vertex_uv**\ (\ idx\: :ref:`int`\ ) |const| Returns the UV of the given vertex. @@ -495,7 +495,7 @@ Returns the UV of the given vertex. .. rst-class:: classref-method -:ref:`Vector2` **get_vertex_uv2** **(** :ref:`int` idx **)** |const| +:ref:`Vector2` **get_vertex_uv2**\ (\ idx\: :ref:`int`\ ) |const| Returns the UV2 of the given vertex. @@ -507,7 +507,7 @@ Returns the UV2 of the given vertex. .. rst-class:: classref-method -:ref:`PackedFloat32Array` **get_vertex_weights** **(** :ref:`int` idx **)** |const| +:ref:`PackedFloat32Array` **get_vertex_weights**\ (\ idx\: :ref:`int`\ ) |const| Returns bone weights of the given vertex. @@ -519,7 +519,7 @@ Returns bone weights of the given vertex. .. rst-class:: classref-method -void **set_edge_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** +|void| **set_edge_meta**\ (\ idx\: :ref:`int`, meta\: :ref:`Variant`\ ) Sets the metadata of the given edge. @@ -531,7 +531,7 @@ Sets the metadata of the given edge. .. rst-class:: classref-method -void **set_face_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** +|void| **set_face_meta**\ (\ idx\: :ref:`int`, meta\: :ref:`Variant`\ ) Sets the metadata of the given face. @@ -543,7 +543,7 @@ Sets the metadata of the given face. .. rst-class:: classref-method -void **set_material** **(** :ref:`Material` material **)** +|void| **set_material**\ (\ material\: :ref:`Material`\ ) Sets the material to be used by newly-constructed :ref:`Mesh`. @@ -555,7 +555,7 @@ Sets the material to be used by newly-constructed :ref:`Mesh`. .. rst-class:: classref-method -void **set_vertex** **(** :ref:`int` idx, :ref:`Vector3` vertex **)** +|void| **set_vertex**\ (\ idx\: :ref:`int`, vertex\: :ref:`Vector3`\ ) Sets the position of the given vertex. @@ -567,7 +567,7 @@ Sets the position of the given vertex. .. rst-class:: classref-method -void **set_vertex_bones** **(** :ref:`int` idx, :ref:`PackedInt32Array` bones **)** +|void| **set_vertex_bones**\ (\ idx\: :ref:`int`, bones\: :ref:`PackedInt32Array`\ ) Sets the bones of the given vertex. @@ -579,7 +579,7 @@ Sets the bones of the given vertex. .. rst-class:: classref-method -void **set_vertex_color** **(** :ref:`int` idx, :ref:`Color` color **)** +|void| **set_vertex_color**\ (\ idx\: :ref:`int`, color\: :ref:`Color`\ ) Sets the color of the given vertex. @@ -591,7 +591,7 @@ Sets the color of the given vertex. .. rst-class:: classref-method -void **set_vertex_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** +|void| **set_vertex_meta**\ (\ idx\: :ref:`int`, meta\: :ref:`Variant`\ ) Sets the metadata associated with the given vertex. @@ -603,7 +603,7 @@ Sets the metadata associated with the given vertex. .. rst-class:: classref-method -void **set_vertex_normal** **(** :ref:`int` idx, :ref:`Vector3` normal **)** +|void| **set_vertex_normal**\ (\ idx\: :ref:`int`, normal\: :ref:`Vector3`\ ) Sets the normal of the given vertex. @@ -615,7 +615,7 @@ Sets the normal of the given vertex. .. rst-class:: classref-method -void **set_vertex_tangent** **(** :ref:`int` idx, :ref:`Plane` tangent **)** +|void| **set_vertex_tangent**\ (\ idx\: :ref:`int`, tangent\: :ref:`Plane`\ ) Sets the tangent of the given vertex. @@ -627,7 +627,7 @@ Sets the tangent of the given vertex. .. rst-class:: classref-method -void **set_vertex_uv** **(** :ref:`int` idx, :ref:`Vector2` uv **)** +|void| **set_vertex_uv**\ (\ idx\: :ref:`int`, uv\: :ref:`Vector2`\ ) Sets the UV of the given vertex. @@ -639,7 +639,7 @@ Sets the UV of the given vertex. .. rst-class:: classref-method -void **set_vertex_uv2** **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** +|void| **set_vertex_uv2**\ (\ idx\: :ref:`int`, uv2\: :ref:`Vector2`\ ) Sets the UV2 of the given vertex. @@ -651,7 +651,7 @@ Sets the UV2 of the given vertex. .. rst-class:: classref-method -void **set_vertex_weights** **(** :ref:`int` idx, :ref:`PackedFloat32Array` weights **)** +|void| **set_vertex_weights**\ (\ idx\: :ref:`int`, weights\: :ref:`PackedFloat32Array`\ ) Sets the bone weights of the given vertex. @@ -662,3 +662,4 @@ Sets the bone weights of the given vertex. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_meshinstance2d.rst b/classes/class_meshinstance2d.rst index 5cf3f8028fe..25efc1f05fc 100644 --- a/classes/class_meshinstance2d.rst +++ b/classes/class_meshinstance2d.rst @@ -55,7 +55,7 @@ Signals .. rst-class:: classref-signal -**texture_changed** **(** **)** +**texture_changed**\ (\ ) Emitted when the :ref:`texture` is changed. @@ -76,8 +76,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_mesh** **(** :ref:`Mesh` value **)** -- :ref:`Mesh` **get_mesh** **(** **)** +- |void| **set_mesh**\ (\ value\: :ref:`Mesh`\ ) +- :ref:`Mesh` **get_mesh**\ (\ ) The :ref:`Mesh` that will be drawn by the **MeshInstance2D**. @@ -93,8 +93,8 @@ The :ref:`Mesh` that will be drawn by the **MeshInstance2D**. .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ ) The :ref:`Texture2D` that will be used if using the default :ref:`CanvasItemMaterial`. Can be accessed as ``TEXTURE`` in CanvasItem shader. @@ -105,3 +105,4 @@ The :ref:`Texture2D` that will be used if using the default :re .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_meshinstance3d.rst b/classes/class_meshinstance3d.rst index 3b6b53db854..1cd6607f4ed 100644 --- a/classes/class_meshinstance3d.rst +++ b/classes/class_meshinstance3d.rst @@ -60,31 +60,31 @@ Methods .. table:: :widths: auto - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_convex_collision` **(** :ref:`bool` clean=true, :ref:`bool` simplify=false **)** | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_debug_tangents` **(** **)** | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_multiple_convex_collisions` **(** :ref:`MeshConvexDecompositionSettings` settings=null **)** | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_trimesh_collision` **(** **)** | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find_blend_shape_by_name` **(** :ref:`StringName` name **)** | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Material` | :ref:`get_active_material` **(** :ref:`int` surface **)** |const| | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_blend_shape_count` **(** **)** |const| | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_blend_shape_value` **(** :ref:`int` blend_shape_idx **)** |const| | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Material` | :ref:`get_surface_override_material` **(** :ref:`int` surface **)** |const| | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_surface_override_material_count` **(** **)** |const| | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_blend_shape_value` **(** :ref:`int` blend_shape_idx, :ref:`float` value **)** | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_surface_override_material` **(** :ref:`int` surface, :ref:`Material` material **)** | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_convex_collision`\ (\ clean\: :ref:`bool` = true, simplify\: :ref:`bool` = false\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_debug_tangents`\ (\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_multiple_convex_collisions`\ (\ settings\: :ref:`MeshConvexDecompositionSettings` = null\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_trimesh_collision`\ (\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find_blend_shape_by_name`\ (\ name\: :ref:`StringName`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Material` | :ref:`get_active_material`\ (\ surface\: :ref:`int`\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_blend_shape_count`\ (\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_blend_shape_value`\ (\ blend_shape_idx\: :ref:`int`\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Material` | :ref:`get_surface_override_material`\ (\ surface\: :ref:`int`\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_surface_override_material_count`\ (\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_blend_shape_value`\ (\ blend_shape_idx\: :ref:`int`, value\: :ref:`float`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_surface_override_material`\ (\ surface\: :ref:`int`, material\: :ref:`Material`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -103,8 +103,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_mesh** **(** :ref:`Mesh` value **)** -- :ref:`Mesh` **get_mesh** **(** **)** +- |void| **set_mesh**\ (\ value\: :ref:`Mesh`\ ) +- :ref:`Mesh` **get_mesh**\ (\ ) The :ref:`Mesh` resource for the instance. @@ -120,8 +120,8 @@ The :ref:`Mesh` resource for the instance. .. rst-class:: classref-property-setget -- void **set_skeleton_path** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_skeleton_path** **(** **)** +- |void| **set_skeleton_path**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_skeleton_path**\ (\ ) :ref:`NodePath` to the :ref:`Skeleton3D` associated with the instance. @@ -137,8 +137,8 @@ The :ref:`Mesh` resource for the instance. .. rst-class:: classref-property-setget -- void **set_skin** **(** :ref:`Skin` value **)** -- :ref:`Skin` **get_skin** **(** **)** +- |void| **set_skin**\ (\ value\: :ref:`Skin`\ ) +- :ref:`Skin` **get_skin**\ (\ ) The :ref:`Skin` to be used by this instance. @@ -155,7 +155,7 @@ Method Descriptions .. rst-class:: classref-method -void **create_convex_collision** **(** :ref:`bool` clean=true, :ref:`bool` simplify=false **)** +|void| **create_convex_collision**\ (\ clean\: :ref:`bool` = true, simplify\: :ref:`bool` = false\ ) This helper creates a :ref:`StaticBody3D` child node with a :ref:`ConvexPolygonShape3D` collision shape calculated from the mesh geometry. It's mainly used for testing. @@ -171,7 +171,7 @@ If ``simplify`` is ``true``, the geometry can be further simplified to reduce th .. rst-class:: classref-method -void **create_debug_tangents** **(** **)** +|void| **create_debug_tangents**\ (\ ) This helper creates a **MeshInstance3D** child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing. @@ -183,7 +183,7 @@ This helper creates a **MeshInstance3D** child node with gizmos at every vertex .. rst-class:: classref-method -void **create_multiple_convex_collisions** **(** :ref:`MeshConvexDecompositionSettings` settings=null **)** +|void| **create_multiple_convex_collisions**\ (\ settings\: :ref:`MeshConvexDecompositionSettings` = null\ ) This helper creates a :ref:`StaticBody3D` child node with multiple :ref:`ConvexPolygonShape3D` collision shapes calculated from the mesh geometry via convex decomposition. The convex decomposition operation can be controlled with parameters from the optional ``settings``. @@ -195,7 +195,7 @@ This helper creates a :ref:`StaticBody3D` child node with mu .. rst-class:: classref-method -void **create_trimesh_collision** **(** **)** +|void| **create_trimesh_collision**\ (\ ) This helper creates a :ref:`StaticBody3D` child node with a :ref:`ConcavePolygonShape3D` collision shape calculated from the mesh geometry. It's mainly used for testing. @@ -207,7 +207,7 @@ This helper creates a :ref:`StaticBody3D` child node with a .. rst-class:: classref-method -:ref:`int` **find_blend_shape_by_name** **(** :ref:`StringName` name **)** +:ref:`int` **find_blend_shape_by_name**\ (\ name\: :ref:`StringName`\ ) Returns the index of the blend shape with the given ``name``. Returns ``-1`` if no blend shape with this name exists, including when :ref:`mesh` is ``null``. @@ -219,7 +219,7 @@ Returns the index of the blend shape with the given ``name``. Returns ``-1`` if .. rst-class:: classref-method -:ref:`Material` **get_active_material** **(** :ref:`int` surface **)** |const| +:ref:`Material` **get_active_material**\ (\ surface\: :ref:`int`\ ) |const| Returns the :ref:`Material` that will be used by the :ref:`Mesh` when drawing. This can return the :ref:`GeometryInstance3D.material_override`, the surface override :ref:`Material` defined in this **MeshInstance3D**, or the surface :ref:`Material` defined in the :ref:`mesh`. For example, if :ref:`GeometryInstance3D.material_override` is used, all surfaces will return the override material. @@ -233,7 +233,7 @@ Returns ``null`` if no material is active, including when :ref:`mesh` **get_blend_shape_count** **(** **)** |const| +:ref:`int` **get_blend_shape_count**\ (\ ) |const| Returns the number of blend shapes available. Produces an error if :ref:`mesh` is ``null``. @@ -245,7 +245,7 @@ Returns the number of blend shapes available. Produces an error if :ref:`mesh` **get_blend_shape_value** **(** :ref:`int` blend_shape_idx **)** |const| +:ref:`float` **get_blend_shape_value**\ (\ blend_shape_idx\: :ref:`int`\ ) |const| Returns the value of the blend shape at the given ``blend_shape_idx``. Returns ``0.0`` and produces an error if :ref:`mesh` is ``null`` or doesn't have a blend shape at that index. @@ -257,7 +257,7 @@ Returns the value of the blend shape at the given ``blend_shape_idx``. Returns ` .. rst-class:: classref-method -:ref:`Material` **get_surface_override_material** **(** :ref:`int` surface **)** |const| +:ref:`Material` **get_surface_override_material**\ (\ surface\: :ref:`int`\ ) |const| Returns the override :ref:`Material` for the specified ``surface`` of the :ref:`Mesh` resource. See also :ref:`get_surface_override_material_count`. @@ -271,7 +271,7 @@ Returns the override :ref:`Material` for the specified ``surface .. rst-class:: classref-method -:ref:`int` **get_surface_override_material_count** **(** **)** |const| +:ref:`int` **get_surface_override_material_count**\ (\ ) |const| Returns the number of surface override materials. This is equivalent to :ref:`Mesh.get_surface_count`. See also :ref:`get_surface_override_material`. @@ -283,7 +283,7 @@ Returns the number of surface override materials. This is equivalent to :ref:`Me .. rst-class:: classref-method -void **set_blend_shape_value** **(** :ref:`int` blend_shape_idx, :ref:`float` value **)** +|void| **set_blend_shape_value**\ (\ blend_shape_idx\: :ref:`int`, value\: :ref:`float`\ ) Sets the value of the blend shape at ``blend_shape_idx`` to ``value``. Produces an error if :ref:`mesh` is ``null`` or doesn't have a blend shape at that index. @@ -295,7 +295,7 @@ Sets the value of the blend shape at ``blend_shape_idx`` to ``value``. Produces .. rst-class:: classref-method -void **set_surface_override_material** **(** :ref:`int` surface, :ref:`Material` material **)** +|void| **set_surface_override_material**\ (\ surface\: :ref:`int`, material\: :ref:`Material`\ ) Sets the override ``material`` for the specified ``surface`` of the :ref:`Mesh` resource. This material is associated with this **MeshInstance3D** rather than with :ref:`mesh`. @@ -308,3 +308,4 @@ Sets the override ``material`` for the specified ``surface`` of the :ref:`Mesh` **(** **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_item` **(** :ref:`int` id **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find_item_by_name` **(** :ref:`String` name **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_item_list` **(** **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Mesh` | :ref:`get_item_mesh` **(** :ref:`int` id **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`get_item_mesh_transform` **(** :ref:`int` id **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_name` **(** :ref:`int` id **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_navigation_layers` **(** :ref:`int` id **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NavigationMesh` | :ref:`get_item_navigation_mesh` **(** :ref:`int` id **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`get_item_navigation_mesh_transform` **(** :ref:`int` id **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_item_preview` **(** :ref:`int` id **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_item_shapes` **(** :ref:`int` id **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_last_unused_item_id` **(** **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_item` **(** :ref:`int` id **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_mesh` **(** :ref:`int` id, :ref:`Mesh` mesh **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_mesh_transform` **(** :ref:`int` id, :ref:`Transform3D` mesh_transform **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_name` **(** :ref:`int` id, :ref:`String` name **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_navigation_layers` **(** :ref:`int` id, :ref:`int` navigation_layers **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_navigation_mesh` **(** :ref:`int` id, :ref:`NavigationMesh` navigation_mesh **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_navigation_mesh_transform` **(** :ref:`int` id, :ref:`Transform3D` navigation_mesh **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_preview` **(** :ref:`int` id, :ref:`Texture2D` texture **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_item`\ (\ id\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find_item_by_name`\ (\ name\: :ref:`String`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_item_list`\ (\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Mesh` | :ref:`get_item_mesh`\ (\ id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`get_item_mesh_transform`\ (\ id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_name`\ (\ id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_navigation_layers`\ (\ id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NavigationMesh` | :ref:`get_item_navigation_mesh`\ (\ id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`get_item_navigation_mesh_transform`\ (\ id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_item_preview`\ (\ id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_item_shapes`\ (\ id\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_last_unused_item_id`\ (\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_item`\ (\ id\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_mesh`\ (\ id\: :ref:`int`, mesh\: :ref:`Mesh`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_mesh_transform`\ (\ id\: :ref:`int`, mesh_transform\: :ref:`Transform3D`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_name`\ (\ id\: :ref:`int`, name\: :ref:`String`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_navigation_layers`\ (\ id\: :ref:`int`, navigation_layers\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_navigation_mesh`\ (\ id\: :ref:`int`, navigation_mesh\: :ref:`NavigationMesh`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_navigation_mesh_transform`\ (\ id\: :ref:`int`, navigation_mesh\: :ref:`Transform3D`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_preview`\ (\ id\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_shapes`\ (\ id\: :ref:`int`, shapes\: :ref:`Array`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -97,7 +97,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the library. @@ -109,7 +109,7 @@ Clears the library. .. rst-class:: classref-method -void **create_item** **(** :ref:`int` id **)** +|void| **create_item**\ (\ id\: :ref:`int`\ ) Creates a new item in the library with the given ID. @@ -123,7 +123,7 @@ You can get an unused ID from :ref:`get_last_unused_item_id` **find_item_by_name** **(** :ref:`String` name **)** |const| +:ref:`int` **find_item_by_name**\ (\ name\: :ref:`String`\ ) |const| Returns the first item with the given name. @@ -135,7 +135,7 @@ Returns the first item with the given name. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_item_list** **(** **)** |const| +:ref:`PackedInt32Array` **get_item_list**\ (\ ) |const| Returns the list of item IDs in use. @@ -147,7 +147,7 @@ Returns the list of item IDs in use. .. rst-class:: classref-method -:ref:`Mesh` **get_item_mesh** **(** :ref:`int` id **)** |const| +:ref:`Mesh` **get_item_mesh**\ (\ id\: :ref:`int`\ ) |const| Returns the item's mesh. @@ -159,7 +159,7 @@ Returns the item's mesh. .. rst-class:: classref-method -:ref:`Transform3D` **get_item_mesh_transform** **(** :ref:`int` id **)** |const| +:ref:`Transform3D` **get_item_mesh_transform**\ (\ id\: :ref:`int`\ ) |const| Returns the transform applied to the item's mesh. @@ -171,7 +171,7 @@ Returns the transform applied to the item's mesh. .. rst-class:: classref-method -:ref:`String` **get_item_name** **(** :ref:`int` id **)** |const| +:ref:`String` **get_item_name**\ (\ id\: :ref:`int`\ ) |const| Returns the item's name. @@ -183,7 +183,7 @@ Returns the item's name. .. rst-class:: classref-method -:ref:`int` **get_item_navigation_layers** **(** :ref:`int` id **)** |const| +:ref:`int` **get_item_navigation_layers**\ (\ id\: :ref:`int`\ ) |const| Returns the item's navigation layers bitmask. @@ -195,7 +195,7 @@ Returns the item's navigation layers bitmask. .. rst-class:: classref-method -:ref:`NavigationMesh` **get_item_navigation_mesh** **(** :ref:`int` id **)** |const| +:ref:`NavigationMesh` **get_item_navigation_mesh**\ (\ id\: :ref:`int`\ ) |const| Returns the item's navigation mesh. @@ -207,7 +207,7 @@ Returns the item's navigation mesh. .. rst-class:: classref-method -:ref:`Transform3D` **get_item_navigation_mesh_transform** **(** :ref:`int` id **)** |const| +:ref:`Transform3D` **get_item_navigation_mesh_transform**\ (\ id\: :ref:`int`\ ) |const| Returns the transform applied to the item's navigation mesh. @@ -219,7 +219,7 @@ Returns the transform applied to the item's navigation mesh. .. rst-class:: classref-method -:ref:`Texture2D` **get_item_preview** **(** :ref:`int` id **)** |const| +:ref:`Texture2D` **get_item_preview**\ (\ id\: :ref:`int`\ ) |const| When running in the editor, returns a generated item preview (a 3D rendering in isometric perspective). When used in a running project, returns the manually-defined item preview which can be set using :ref:`set_item_preview`. Returns an empty :ref:`Texture2D` if no preview was manually set in a running project. @@ -231,7 +231,7 @@ When running in the editor, returns a generated item preview (a 3D rendering in .. rst-class:: classref-method -:ref:`Array` **get_item_shapes** **(** :ref:`int` id **)** |const| +:ref:`Array` **get_item_shapes**\ (\ id\: :ref:`int`\ ) |const| Returns an item's collision shapes. @@ -245,7 +245,7 @@ The array consists of each :ref:`Shape3D` followed by its :ref:`T .. rst-class:: classref-method -:ref:`int` **get_last_unused_item_id** **(** **)** |const| +:ref:`int` **get_last_unused_item_id**\ (\ ) |const| Gets an unused ID for a new item. @@ -257,7 +257,7 @@ Gets an unused ID for a new item. .. rst-class:: classref-method -void **remove_item** **(** :ref:`int` id **)** +|void| **remove_item**\ (\ id\: :ref:`int`\ ) Removes the item. @@ -269,7 +269,7 @@ Removes the item. .. rst-class:: classref-method -void **set_item_mesh** **(** :ref:`int` id, :ref:`Mesh` mesh **)** +|void| **set_item_mesh**\ (\ id\: :ref:`int`, mesh\: :ref:`Mesh`\ ) Sets the item's mesh. @@ -281,7 +281,7 @@ Sets the item's mesh. .. rst-class:: classref-method -void **set_item_mesh_transform** **(** :ref:`int` id, :ref:`Transform3D` mesh_transform **)** +|void| **set_item_mesh_transform**\ (\ id\: :ref:`int`, mesh_transform\: :ref:`Transform3D`\ ) Sets the transform to apply to the item's mesh. @@ -293,7 +293,7 @@ Sets the transform to apply to the item's mesh. .. rst-class:: classref-method -void **set_item_name** **(** :ref:`int` id, :ref:`String` name **)** +|void| **set_item_name**\ (\ id\: :ref:`int`, name\: :ref:`String`\ ) Sets the item's name. @@ -307,7 +307,7 @@ This name is shown in the editor. It can also be used to look up the item later .. rst-class:: classref-method -void **set_item_navigation_layers** **(** :ref:`int` id, :ref:`int` navigation_layers **)** +|void| **set_item_navigation_layers**\ (\ id\: :ref:`int`, navigation_layers\: :ref:`int`\ ) Sets the item's navigation layers bitmask. @@ -319,7 +319,7 @@ Sets the item's navigation layers bitmask. .. rst-class:: classref-method -void **set_item_navigation_mesh** **(** :ref:`int` id, :ref:`NavigationMesh` navigation_mesh **)** +|void| **set_item_navigation_mesh**\ (\ id\: :ref:`int`, navigation_mesh\: :ref:`NavigationMesh`\ ) Sets the item's navigation mesh. @@ -331,7 +331,7 @@ Sets the item's navigation mesh. .. rst-class:: classref-method -void **set_item_navigation_mesh_transform** **(** :ref:`int` id, :ref:`Transform3D` navigation_mesh **)** +|void| **set_item_navigation_mesh_transform**\ (\ id\: :ref:`int`, navigation_mesh\: :ref:`Transform3D`\ ) Sets the transform to apply to the item's navigation mesh. @@ -343,7 +343,7 @@ Sets the transform to apply to the item's navigation mesh. .. rst-class:: classref-method -void **set_item_preview** **(** :ref:`int` id, :ref:`Texture2D` texture **)** +|void| **set_item_preview**\ (\ id\: :ref:`int`, texture\: :ref:`Texture2D`\ ) Sets a texture to use as the item's preview icon in the editor. @@ -355,7 +355,7 @@ Sets a texture to use as the item's preview icon in the editor. .. rst-class:: classref-method -void **set_item_shapes** **(** :ref:`int` id, :ref:`Array` shapes **)** +|void| **set_item_shapes**\ (\ id\: :ref:`int`, shapes\: :ref:`Array`\ ) Sets an item's collision shapes. @@ -368,3 +368,4 @@ The array should consist of :ref:`Shape3D` objects, each followed .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_meshtexture.rst b/classes/class_meshtexture.rst index dbfe9014f28..a1e7798f994 100644 --- a/classes/class_meshtexture.rst +++ b/classes/class_meshtexture.rst @@ -56,8 +56,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_base_texture** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_base_texture** **(** **)** +- |void| **set_base_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_base_texture**\ (\ ) Sets the base texture that the Mesh will use to draw. @@ -73,8 +73,8 @@ Sets the base texture that the Mesh will use to draw. .. rst-class:: classref-property-setget -- void **set_image_size** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_image_size** **(** **)** +- |void| **set_image_size**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_image_size**\ (\ ) Sets the size of the image, needed for reference. @@ -90,8 +90,8 @@ Sets the size of the image, needed for reference. .. rst-class:: classref-property-setget -- void **set_mesh** **(** :ref:`Mesh` value **)** -- :ref:`Mesh` **get_mesh** **(** **)** +- |void| **set_mesh**\ (\ value\: :ref:`Mesh`\ ) +- :ref:`Mesh` **get_mesh**\ (\ ) Sets the mesh used to draw. It must be a mesh using 2D vertices. @@ -102,3 +102,4 @@ Sets the mesh used to draw. It must be a mesh using 2D vertices. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_methodtweener.rst b/classes/class_methodtweener.rst index 9ddaff0c31b..ebb94c6bb06 100644 --- a/classes/class_methodtweener.rst +++ b/classes/class_methodtweener.rst @@ -33,13 +33,13 @@ Methods .. table:: :widths: auto - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ - | :ref:`MethodTweener` | :ref:`set_delay` **(** :ref:`float` delay **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ - | :ref:`MethodTweener` | :ref:`set_ease` **(** :ref:`EaseType` ease **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ - | :ref:`MethodTweener` | :ref:`set_trans` **(** :ref:`TransitionType` trans **)** | - +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | :ref:`MethodTweener` | :ref:`set_delay`\ (\ delay\: :ref:`float`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | :ref:`MethodTweener` | :ref:`set_ease`\ (\ ease\: :ref:`EaseType`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | :ref:`MethodTweener` | :ref:`set_trans`\ (\ trans\: :ref:`TransitionType`\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -54,7 +54,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`MethodTweener` **set_delay** **(** :ref:`float` delay **)** +:ref:`MethodTweener` **set_delay**\ (\ delay\: :ref:`float`\ ) Sets the time in seconds after which the **MethodTweener** will start interpolating. By default there's no delay. @@ -66,7 +66,7 @@ Sets the time in seconds after which the **MethodTweener** will start interpolat .. rst-class:: classref-method -:ref:`MethodTweener` **set_ease** **(** :ref:`EaseType` ease **)** +:ref:`MethodTweener` **set_ease**\ (\ ease\: :ref:`EaseType`\ ) Sets the type of used easing from :ref:`EaseType`. If not set, the default easing is used from the :ref:`Tween` that contains this Tweener. @@ -78,7 +78,7 @@ Sets the type of used easing from :ref:`EaseType`. If not s .. rst-class:: classref-method -:ref:`MethodTweener` **set_trans** **(** :ref:`TransitionType` trans **)** +:ref:`MethodTweener` **set_trans**\ (\ trans\: :ref:`TransitionType`\ ) Sets the type of used transition from :ref:`TransitionType`. If not set, the default transition is used from the :ref:`Tween` that contains this Tweener. @@ -89,3 +89,4 @@ Sets the type of used transition from :ref:`TransitionType` value **)** -- :ref:`String` **get_original_class** **(** **)** +- |void| **set_original_class**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_original_class**\ (\ ) The name of the class this node was supposed to be (see :ref:`Object.get_class`). @@ -73,8 +73,8 @@ The name of the class this node was supposed to be (see :ref:`Object.get_class` value **)** -- :ref:`String` **get_original_scene** **(** **)** +- |void| **set_original_scene**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_original_scene**\ (\ ) Returns the path of the scene this node was instance of originally. @@ -90,8 +90,8 @@ Returns the path of the scene this node was instance of originally. .. rst-class:: classref-property-setget -- void **set_recording_properties** **(** :ref:`bool` value **)** -- :ref:`bool` **is_recording_properties** **(** **)** +- |void| **set_recording_properties**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_recording_properties**\ (\ ) If ``true``, allows new properties to be set along with existing ones. If ``false``, only existing properties' values can be set, and new properties cannot be added. @@ -102,3 +102,4 @@ If ``true``, allows new properties to be set along with existing ones. If ``fals .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_missingresource.rst b/classes/class_missingresource.rst index 72412d7e9bd..c3856511c51 100644 --- a/classes/class_missingresource.rst +++ b/classes/class_missingresource.rst @@ -54,8 +54,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_original_class** **(** :ref:`String` value **)** -- :ref:`String` **get_original_class** **(** **)** +- |void| **set_original_class**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_original_class**\ (\ ) The name of the class this resource was supposed to be (see :ref:`Object.get_class`). @@ -71,8 +71,8 @@ The name of the class this resource was supposed to be (see :ref:`Object.get_cla .. rst-class:: classref-property-setget -- void **set_recording_properties** **(** :ref:`bool` value **)** -- :ref:`bool` **is_recording_properties** **(** **)** +- |void| **set_recording_properties**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_recording_properties**\ (\ ) If set to ``true``, allows new properties to be added on top of the existing ones with :ref:`Object.set`. @@ -83,3 +83,4 @@ If set to ``true``, allows new properties to be added on top of the existing one .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_mobilevrinterface.rst b/classes/class_mobilevrinterface.rst index b1324bbb504..0a48c51ad5b 100644 --- a/classes/class_mobilevrinterface.rst +++ b/classes/class_mobilevrinterface.rst @@ -74,8 +74,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_display_to_lens** **(** :ref:`float` value **)** -- :ref:`float` **get_display_to_lens** **(** **)** +- |void| **set_display_to_lens**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_display_to_lens**\ (\ ) The distance between the display and the lenses inside of the device in centimeters. @@ -91,8 +91,8 @@ The distance between the display and the lenses inside of the device in centimet .. rst-class:: classref-property-setget -- void **set_display_width** **(** :ref:`float` value **)** -- :ref:`float` **get_display_width** **(** **)** +- |void| **set_display_width**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_display_width**\ (\ ) The width of the display in centimeters. @@ -108,8 +108,8 @@ The width of the display in centimeters. .. rst-class:: classref-property-setget -- void **set_eye_height** **(** :ref:`float` value **)** -- :ref:`float` **get_eye_height** **(** **)** +- |void| **set_eye_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_eye_height**\ (\ ) The height at which the camera is placed in relation to the ground (i.e. :ref:`XROrigin3D` node). @@ -125,8 +125,8 @@ The height at which the camera is placed in relation to the ground (i.e. :ref:`X .. rst-class:: classref-property-setget -- void **set_iod** **(** :ref:`float` value **)** -- :ref:`float` **get_iod** **(** **)** +- |void| **set_iod**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_iod**\ (\ ) The interocular distance, also known as the interpupillary distance. The distance between the pupils of the left and right eye. @@ -142,8 +142,8 @@ The interocular distance, also known as the interpupillary distance. The distanc .. rst-class:: classref-property-setget -- void **set_k1** **(** :ref:`float` value **)** -- :ref:`float` **get_k1** **(** **)** +- |void| **set_k1**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_k1**\ (\ ) The k1 lens factor is one of the two constants that define the strength of the lens used and directly influences the lens distortion effect. @@ -159,8 +159,8 @@ The k1 lens factor is one of the two constants that define the strength of the l .. rst-class:: classref-property-setget -- void **set_k2** **(** :ref:`float` value **)** -- :ref:`float` **get_k2** **(** **)** +- |void| **set_k2**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_k2**\ (\ ) The k2 lens factor, see k1. @@ -176,8 +176,8 @@ The k2 lens factor, see k1. .. rst-class:: classref-property-setget -- void **set_oversample** **(** :ref:`float` value **)** -- :ref:`float` **get_oversample** **(** **)** +- |void| **set_oversample**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_oversample**\ (\ ) The oversample setting. Because of the lens distortion we have to render our buffers at a higher resolution then the screen can natively handle. A value between 1.5 and 2.0 often provides good results but at the cost of performance. @@ -188,3 +188,4 @@ The oversample setting. Because of the lens distortion we have to render our buf .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_moviewriter.rst b/classes/class_moviewriter.rst index 811480cc876..8f21441e3ae 100644 --- a/classes/class_moviewriter.rst +++ b/classes/class_moviewriter.rst @@ -41,21 +41,21 @@ Methods .. table:: :widths: auto - +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_audio_mix_rate` **(** **)** |virtual| |const| | - +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SpeakerMode` | :ref:`_get_audio_speaker_mode` **(** **)** |virtual| |const| | - +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_handles_file` **(** :ref:`String` path **)** |virtual| |const| | - +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_write_begin` **(** :ref:`Vector2i` movie_size, :ref:`int` fps, :ref:`String` base_path **)** |virtual| | - +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_write_end` **(** **)** |virtual| | - +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_write_frame` **(** :ref:`Image` frame_image, const void* audio_frame_block **)** |virtual| | - +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_writer` **(** :ref:`MovieWriter` writer **)** |static| | - +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_audio_mix_rate`\ (\ ) |virtual| |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SpeakerMode` | :ref:`_get_audio_speaker_mode`\ (\ ) |virtual| |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_handles_file`\ (\ path\: :ref:`String`\ ) |virtual| |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_write_begin`\ (\ movie_size\: :ref:`Vector2i`, fps\: :ref:`int`, base_path\: :ref:`String`\ ) |virtual| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_write_end`\ (\ ) |virtual| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_write_frame`\ (\ frame_image\: :ref:`Image`, audio_frame_block\: ``const void*``\ ) |virtual| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_writer`\ (\ writer\: :ref:`MovieWriter`\ ) |static| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -70,7 +70,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_audio_mix_rate** **(** **)** |virtual| |const| +:ref:`int` **_get_audio_mix_rate**\ (\ ) |virtual| |const| Called when the audio sample rate used for recording the audio is requested by the engine. The value returned must be specified in Hz. Defaults to 48000 Hz if :ref:`_get_audio_mix_rate` is not overridden. @@ -82,7 +82,7 @@ Called when the audio sample rate used for recording the audio is requested by t .. rst-class:: classref-method -:ref:`SpeakerMode` **_get_audio_speaker_mode** **(** **)** |virtual| |const| +:ref:`SpeakerMode` **_get_audio_speaker_mode**\ (\ ) |virtual| |const| Called when the audio speaker mode used for recording the audio is requested by the engine. This can affect the number of output channels in the resulting audio file/stream. Defaults to :ref:`AudioServer.SPEAKER_MODE_STEREO` if :ref:`_get_audio_speaker_mode` is not overridden. @@ -94,7 +94,7 @@ Called when the audio speaker mode used for recording the audio is requested by .. rst-class:: classref-method -:ref:`bool` **_handles_file** **(** :ref:`String` path **)** |virtual| |const| +:ref:`bool` **_handles_file**\ (\ path\: :ref:`String`\ ) |virtual| |const| Called when the engine determines whether this **MovieWriter** is able to handle the file at ``path``. Must return ``true`` if this **MovieWriter** is able to handle the given file path, ``false`` otherwise. Typically, :ref:`_handles_file` is overridden as follows to allow the user to record a file at any path with a given file extension: @@ -113,7 +113,7 @@ Called when the engine determines whether this **MovieWriter** is able to handle .. rst-class:: classref-method -:ref:`Error` **_write_begin** **(** :ref:`Vector2i` movie_size, :ref:`int` fps, :ref:`String` base_path **)** |virtual| +:ref:`Error` **_write_begin**\ (\ movie_size\: :ref:`Vector2i`, fps\: :ref:`int`, base_path\: :ref:`String`\ ) |virtual| Called once before the engine starts writing video and audio data. ``movie_size`` is the width and height of the video to save. ``fps`` is the number of frames per second specified in the project settings or using the ``--fixed-fps `` :doc:`command line argument <../tutorials/editor/command_line_tutorial>`. @@ -125,7 +125,7 @@ Called once before the engine starts writing video and audio data. ``movie_size` .. rst-class:: classref-method -void **_write_end** **(** **)** |virtual| +|void| **_write_end**\ (\ ) |virtual| Called when the engine finishes writing. This occurs when the engine quits by pressing the window manager's close button, or when :ref:`SceneTree.quit` is called. @@ -139,7 +139,7 @@ Called when the engine finishes writing. This occurs when the engine quits by pr .. rst-class:: classref-method -:ref:`Error` **_write_frame** **(** :ref:`Image` frame_image, const void* audio_frame_block **)** |virtual| +:ref:`Error` **_write_frame**\ (\ frame_image\: :ref:`Image`, audio_frame_block\: ``const void*``\ ) |virtual| Called at the end of every rendered frame. The ``frame_image`` and ``audio_frame_block`` function arguments should be written to. @@ -151,7 +151,7 @@ Called at the end of every rendered frame. The ``frame_image`` and ``audio_frame .. rst-class:: classref-method -void **add_writer** **(** :ref:`MovieWriter` writer **)** |static| +|void| **add_writer**\ (\ writer\: :ref:`MovieWriter`\ ) |static| Adds a writer to be usable by the engine. The supported file extensions can be set by overriding :ref:`_handles_file`. @@ -164,3 +164,4 @@ Adds a writer to be usable by the engine. The supported file extensions can be s .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index cc71b1d91f8..e99e8d7573c 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: batch + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -84,25 +87,25 @@ Methods .. table:: :widths: auto - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`get_aabb` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_instance_color` **(** :ref:`int` instance **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_instance_custom_data` **(** :ref:`int` instance **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`get_instance_transform` **(** :ref:`int` instance **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_instance_transform_2d` **(** :ref:`int` instance **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_instance_color` **(** :ref:`int` instance, :ref:`Color` color **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_instance_custom_data` **(** :ref:`int` instance, :ref:`Color` custom_data **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_instance_transform` **(** :ref:`int` instance, :ref:`Transform3D` transform **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_instance_transform_2d` **(** :ref:`int` instance, :ref:`Transform2D` transform **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`get_aabb`\ (\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_instance_color`\ (\ instance\: :ref:`int`\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_instance_custom_data`\ (\ instance\: :ref:`int`\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`get_instance_transform`\ (\ instance\: :ref:`int`\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_instance_transform_2d`\ (\ instance\: :ref:`int`\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_instance_color`\ (\ instance\: :ref:`int`, color\: :ref:`Color`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_instance_custom_data`\ (\ instance\: :ref:`int`, custom_data\: :ref:`Color`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_instance_transform`\ (\ instance\: :ref:`int`, transform\: :ref:`Transform3D`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_instance_transform_2d`\ (\ instance\: :ref:`int`, transform\: :ref:`Transform2D`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -152,8 +155,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_buffer** **(** :ref:`PackedFloat32Array` value **)** -- :ref:`PackedFloat32Array` **get_buffer** **(** **)** +- |void| **set_buffer**\ (\ value\: :ref:`PackedFloat32Array`\ ) +- :ref:`PackedFloat32Array` **get_buffer**\ (\ ) .. container:: contribute @@ -169,11 +172,9 @@ Property Descriptions :ref:`PackedColorArray` **color_array** -**Deprecated:** Use :ref:`set_instance_color` instead. +**Deprecated:** Accessing this property is very slow. Use :ref:`set_instance_color` and :ref:`get_instance_color` instead. -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +Array containing each :ref:`Color` used by all instances of this mesh. .. rst-class:: classref-item-separator @@ -187,8 +188,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_custom_aabb** **(** :ref:`AABB` value **)** -- :ref:`AABB` **get_custom_aabb** **(** **)** +- |void| **set_custom_aabb**\ (\ value\: :ref:`AABB`\ ) +- :ref:`AABB` **get_custom_aabb**\ (\ ) Custom AABB for this MultiMesh resource. Setting this manually prevents costly runtime AABB recalculations. @@ -202,9 +203,9 @@ Custom AABB for this MultiMesh resource. Setting this manually prevents costly r :ref:`PackedColorArray` **custom_data_array** -**Deprecated:** Use :ref:`set_instance_custom_data` instead. +**Deprecated:** Accessing this property is very slow. Use :ref:`set_instance_custom_data` and :ref:`get_instance_custom_data` instead. -See :ref:`set_instance_custom_data`. +Array containing each custom data value used by all instances of this mesh, as a :ref:`PackedColorArray`. .. rst-class:: classref-item-separator @@ -218,8 +219,8 @@ See :ref:`set_instance_custom_data` value **)** -- :ref:`int` **get_instance_count** **(** **)** +- |void| **set_instance_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_instance_count**\ (\ ) Number of instances that will get drawn. This clears and (re)sizes the buffers. Setting data format or flags afterwards will have no effect. @@ -237,8 +238,8 @@ By default, all instances are drawn but you can limit this with :ref:`visible_in .. rst-class:: classref-property-setget -- void **set_mesh** **(** :ref:`Mesh` value **)** -- :ref:`Mesh` **get_mesh** **(** **)** +- |void| **set_mesh**\ (\ value\: :ref:`Mesh`\ ) +- :ref:`Mesh` **get_mesh**\ (\ ) :ref:`Mesh` resource to be instanced. @@ -254,11 +255,9 @@ The looks of the individual instances can be modified using :ref:`set_instance_c :ref:`PackedVector2Array` **transform_2d_array** -**Deprecated:** Use :ref:`set_instance_transform_2d` instead. - -.. container:: contribute +**Deprecated:** Accessing this property is very slow. Use :ref:`set_instance_transform_2d` and :ref:`get_instance_transform_2d` instead. - There is currently no description for this property. Please help us by :ref:`contributing one `! +Array containing each :ref:`Transform2D` value used by all instances of this mesh, as a :ref:`PackedVector2Array`. Each transform is divided into 3 :ref:`Vector2` values corresponding to the transforms' ``x``, ``y``, and ``origin``. .. rst-class:: classref-item-separator @@ -270,11 +269,9 @@ The looks of the individual instances can be modified using :ref:`set_instance_c :ref:`PackedVector3Array` **transform_array** -**Deprecated:** Use :ref:`set_instance_transform` instead. +**Deprecated:** Accessing this property is very slow. Use :ref:`set_instance_transform` and :ref:`get_instance_transform` instead. -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +Array containing each :ref:`Transform3D` value used by all instances of this mesh, as a :ref:`PackedVector3Array`. Each transform is divided into 4 :ref:`Vector3` values corresponding to the transforms' ``x``, ``y``, ``z``, and ``origin``. .. rst-class:: classref-item-separator @@ -288,8 +285,8 @@ The looks of the individual instances can be modified using :ref:`set_instance_c .. rst-class:: classref-property-setget -- void **set_transform_format** **(** :ref:`TransformFormat` value **)** -- :ref:`TransformFormat` **get_transform_format** **(** **)** +- |void| **set_transform_format**\ (\ value\: :ref:`TransformFormat`\ ) +- :ref:`TransformFormat` **get_transform_format**\ (\ ) Format of transform used to transform mesh, either 2D or 3D. @@ -305,8 +302,8 @@ Format of transform used to transform mesh, either 2D or 3D. .. rst-class:: classref-property-setget -- void **set_use_colors** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_colors** **(** **)** +- |void| **set_use_colors**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_colors**\ (\ ) If ``true``, the **MultiMesh** will use color data (see :ref:`set_instance_color`). Can only be set when :ref:`instance_count` is ``0`` or less. This means that you need to call this method before setting the instance count, or temporarily reset it to ``0``. @@ -322,8 +319,8 @@ If ``true``, the **MultiMesh** will use color data (see :ref:`set_instance_color .. rst-class:: classref-property-setget -- void **set_use_custom_data** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_custom_data** **(** **)** +- |void| **set_use_custom_data**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_custom_data**\ (\ ) If ``true``, the **MultiMesh** will use custom data (see :ref:`set_instance_custom_data`). Can only be set when :ref:`instance_count` is ``0`` or less. This means that you need to call this method before setting the instance count, or temporarily reset it to ``0``. @@ -339,8 +336,8 @@ If ``true``, the **MultiMesh** will use custom data (see :ref:`set_instance_cust .. rst-class:: classref-property-setget -- void **set_visible_instance_count** **(** :ref:`int` value **)** -- :ref:`int` **get_visible_instance_count** **(** **)** +- |void| **set_visible_instance_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_visible_instance_count**\ (\ ) Limits the number of instances drawn, -1 draws all instances. Changing this does not change the sizes of the buffers. @@ -357,7 +354,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AABB` **get_aabb** **(** **)** |const| +:ref:`AABB` **get_aabb**\ (\ ) |const| Returns the visibility axis-aligned bounding box in local space. @@ -369,7 +366,7 @@ Returns the visibility axis-aligned bounding box in local space. .. rst-class:: classref-method -:ref:`Color` **get_instance_color** **(** :ref:`int` instance **)** |const| +:ref:`Color` **get_instance_color**\ (\ instance\: :ref:`int`\ ) |const| Gets a specific instance's color multiplier. @@ -381,7 +378,7 @@ Gets a specific instance's color multiplier. .. rst-class:: classref-method -:ref:`Color` **get_instance_custom_data** **(** :ref:`int` instance **)** |const| +:ref:`Color` **get_instance_custom_data**\ (\ instance\: :ref:`int`\ ) |const| Returns the custom data that has been set for a specific instance. @@ -393,7 +390,7 @@ Returns the custom data that has been set for a specific instance. .. rst-class:: classref-method -:ref:`Transform3D` **get_instance_transform** **(** :ref:`int` instance **)** |const| +:ref:`Transform3D` **get_instance_transform**\ (\ instance\: :ref:`int`\ ) |const| Returns the :ref:`Transform3D` of a specific instance. @@ -405,7 +402,7 @@ Returns the :ref:`Transform3D` of a specific instance. .. rst-class:: classref-method -:ref:`Transform2D` **get_instance_transform_2d** **(** :ref:`int` instance **)** |const| +:ref:`Transform2D` **get_instance_transform_2d**\ (\ instance\: :ref:`int`\ ) |const| Returns the :ref:`Transform2D` of a specific instance. @@ -417,7 +414,7 @@ Returns the :ref:`Transform2D` of a specific instance. .. rst-class:: classref-method -void **set_instance_color** **(** :ref:`int` instance, :ref:`Color` color **)** +|void| **set_instance_color**\ (\ instance\: :ref:`int`, color\: :ref:`Color`\ ) Sets the color of a specific instance by *multiplying* the mesh's existing vertex colors. This allows for different color tinting per instance. @@ -431,7 +428,7 @@ For the color to take effect, ensure that :ref:`use_colors` instance, :ref:`Color` custom_data **)** +|void| **set_instance_custom_data**\ (\ instance\: :ref:`int`, custom_data\: :ref:`Color`\ ) Sets custom data for a specific instance. Although :ref:`Color` is used, it is just a container for 4 floating point numbers. @@ -447,7 +444,7 @@ This custom instance data has to be manually accessed in your custom shader usin .. rst-class:: classref-method -void **set_instance_transform** **(** :ref:`int` instance, :ref:`Transform3D` transform **)** +|void| **set_instance_transform**\ (\ instance\: :ref:`int`, transform\: :ref:`Transform3D`\ ) Sets the :ref:`Transform3D` for a specific instance. @@ -459,7 +456,7 @@ Sets the :ref:`Transform3D` for a specific instance. .. rst-class:: classref-method -void **set_instance_transform_2d** **(** :ref:`int` instance, :ref:`Transform2D` transform **)** +|void| **set_instance_transform_2d**\ (\ instance\: :ref:`int`, transform\: :ref:`Transform2D`\ ) Sets the :ref:`Transform2D` for a specific instance. @@ -470,3 +467,4 @@ Sets the :ref:`Transform2D` for a specific instance. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_multimeshinstance2d.rst b/classes/class_multimeshinstance2d.rst index e30a8c4cce5..064b394415e 100644 --- a/classes/class_multimeshinstance2d.rst +++ b/classes/class_multimeshinstance2d.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: batch + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -50,7 +53,7 @@ Signals .. rst-class:: classref-signal -**texture_changed** **(** **)** +**texture_changed**\ (\ ) Emitted when the :ref:`texture` is changed. @@ -71,8 +74,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_multimesh** **(** :ref:`MultiMesh` value **)** -- :ref:`MultiMesh` **get_multimesh** **(** **)** +- |void| **set_multimesh**\ (\ value\: :ref:`MultiMesh`\ ) +- :ref:`MultiMesh` **get_multimesh**\ (\ ) The :ref:`MultiMesh` that will be drawn by the **MultiMeshInstance2D**. @@ -88,8 +91,8 @@ The :ref:`MultiMesh` that will be drawn by the **MultiMeshInsta .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ ) The :ref:`Texture2D` that will be used if using the default :ref:`CanvasItemMaterial`. Can be accessed as ``TEXTURE`` in CanvasItem shader. @@ -100,3 +103,4 @@ The :ref:`Texture2D` that will be used if using the default :re .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_multimeshinstance3d.rst b/classes/class_multimeshinstance3d.rst index 4fd271413c0..7eaad349fe1 100644 --- a/classes/class_multimeshinstance3d.rst +++ b/classes/class_multimeshinstance3d.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: batch + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -63,8 +66,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_multimesh** **(** :ref:`MultiMesh` value **)** -- :ref:`MultiMesh` **get_multimesh** **(** **)** +- |void| **set_multimesh**\ (\ value\: :ref:`MultiMesh`\ ) +- :ref:`MultiMesh` **get_multimesh**\ (\ ) The :ref:`MultiMesh` resource that will be used and shared among all instances of the **MultiMeshInstance3D**. @@ -75,3 +78,4 @@ The :ref:`MultiMesh` resource that will be used and shared amon .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_multiplayerapi.rst b/classes/class_multiplayerapi.rst index 850a9eba07a..82bc401240f 100644 --- a/classes/class_multiplayerapi.rst +++ b/classes/class_multiplayerapi.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: network + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -49,31 +52,31 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`MultiplayerAPI` | :ref:`create_default_interface` **(** **)** |static| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_default_interface` **(** **)** |static| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_peers` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_remote_sender_id` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_unique_id` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_multiplayer_peer` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_server` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`object_configuration_add` **(** :ref:`Object` object, :ref:`Variant` configuration **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`object_configuration_remove` **(** :ref:`Object` object, :ref:`Variant` configuration **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`poll` **(** **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`rpc` **(** :ref:`int` peer, :ref:`Object` object, :ref:`StringName` method, :ref:`Array` arguments=[] **)** | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_default_interface` **(** :ref:`StringName` interface_name **)** |static| | - +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`MultiplayerAPI` | :ref:`create_default_interface`\ (\ ) |static| | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_default_interface`\ (\ ) |static| | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_peers`\ (\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_remote_sender_id`\ (\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_unique_id`\ (\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_multiplayer_peer`\ (\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_server`\ (\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`object_configuration_add`\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`object_configuration_remove`\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`poll`\ (\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`rpc`\ (\ peer\: :ref:`int`, object\: :ref:`Object`, method\: :ref:`StringName`, arguments\: :ref:`Array` = []\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_default_interface`\ (\ interface_name\: :ref:`StringName`\ ) |static| | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -88,7 +91,7 @@ Signals .. rst-class:: classref-signal -**connected_to_server** **(** **)** +**connected_to_server**\ (\ ) Emitted when this MultiplayerAPI's :ref:`multiplayer_peer` successfully connected to a server. Only emitted on clients. @@ -100,7 +103,7 @@ Emitted when this MultiplayerAPI's :ref:`multiplayer_peer` fails to establish a connection to a server. Only emitted on clients. @@ -112,7 +115,7 @@ Emitted when this MultiplayerAPI's :ref:`multiplayer_peer` id **)** +**peer_connected**\ (\ id\: :ref:`int`\ ) Emitted when this MultiplayerAPI's :ref:`multiplayer_peer` connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). @@ -124,7 +127,7 @@ Emitted when this MultiplayerAPI's :ref:`multiplayer_peer` id **)** +**peer_disconnected**\ (\ id\: :ref:`int`\ ) Emitted when this MultiplayerAPI's :ref:`multiplayer_peer` disconnects from a peer. Clients get notified when other clients disconnect from the same server. @@ -136,7 +139,7 @@ Emitted when this MultiplayerAPI's :ref:`multiplayer_peer` disconnects from server. Only emitted on clients. @@ -196,8 +199,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_multiplayer_peer** **(** :ref:`MultiplayerPeer` value **)** -- :ref:`MultiplayerPeer` **get_multiplayer_peer** **(** **)** +- |void| **set_multiplayer_peer**\ (\ value\: :ref:`MultiplayerPeer`\ ) +- :ref:`MultiplayerPeer` **get_multiplayer_peer**\ (\ ) The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the MultiplayerAPI will become a network server (check with :ref:`is_server`) and will set root node's network mode to authority, or it will become a regular client peer. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to MultiplayerAPI's signals. @@ -214,7 +217,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`MultiplayerAPI` **create_default_interface** **(** **)** |static| +:ref:`MultiplayerAPI` **create_default_interface**\ (\ ) |static| Returns a new instance of the default MultiplayerAPI. @@ -226,7 +229,7 @@ Returns a new instance of the default MultiplayerAPI. .. rst-class:: classref-method -:ref:`StringName` **get_default_interface** **(** **)** |static| +:ref:`StringName` **get_default_interface**\ (\ ) |static| Returns the default MultiplayerAPI implementation class name. This is usually ``"SceneMultiplayer"`` when :ref:`SceneMultiplayer` is available. See :ref:`set_default_interface`. @@ -238,7 +241,7 @@ Returns the default MultiplayerAPI implementation class name. This is usually `` .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_peers** **(** **)** +:ref:`PackedInt32Array` **get_peers**\ (\ ) Returns the peer IDs of all connected peers of this MultiplayerAPI's :ref:`multiplayer_peer`. @@ -250,7 +253,7 @@ Returns the peer IDs of all connected peers of this MultiplayerAPI's :ref:`multi .. rst-class:: classref-method -:ref:`int` **get_remote_sender_id** **(** **)** +:ref:`int` **get_remote_sender_id**\ (\ ) Returns the sender's peer ID for the RPC currently being executed. @@ -264,7 +267,7 @@ Returns the sender's peer ID for the RPC currently being executed. .. rst-class:: classref-method -:ref:`int` **get_unique_id** **(** **)** +:ref:`int` **get_unique_id**\ (\ ) Returns the unique peer ID of this MultiplayerAPI's :ref:`multiplayer_peer`. @@ -276,7 +279,7 @@ Returns the unique peer ID of this MultiplayerAPI's :ref:`multiplayer_peer` **has_multiplayer_peer** **(** **)** +:ref:`bool` **has_multiplayer_peer**\ (\ ) Returns ``true`` if there is a :ref:`multiplayer_peer` set. @@ -288,7 +291,7 @@ Returns ``true`` if there is a :ref:`multiplayer_peer` **is_server** **(** **)** +:ref:`bool` **is_server**\ (\ ) Returns ``true`` if this MultiplayerAPI's :ref:`multiplayer_peer` is valid and in server mode (listening for connections). @@ -300,7 +303,7 @@ Returns ``true`` if this MultiplayerAPI's :ref:`multiplayer_peer` **object_configuration_add** **(** :ref:`Object` object, :ref:`Variant` configuration **)** +:ref:`Error` **object_configuration_add**\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) Notifies the MultiplayerAPI of a new ``configuration`` for the given ``object``. This method is used internally by :ref:`SceneTree` to configure the root path for this MultiplayerAPI (passing ``null`` and a valid :ref:`NodePath` as ``configuration``). This method can be further used by MultiplayerAPI implementations to provide additional features, refer to specific implementation (e.g. :ref:`SceneMultiplayer`) for details on how they use it. @@ -314,7 +317,7 @@ Notifies the MultiplayerAPI of a new ``configuration`` for the given ``object``. .. rst-class:: classref-method -:ref:`Error` **object_configuration_remove** **(** :ref:`Object` object, :ref:`Variant` configuration **)** +:ref:`Error` **object_configuration_remove**\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) Notifies the MultiplayerAPI to remove a ``configuration`` for the given ``object``. This method is used internally by :ref:`SceneTree` to configure the root path for this MultiplayerAPI (passing ``null`` and an empty :ref:`NodePath` as ``configuration``). This method can be further used by MultiplayerAPI implementations to provide additional features, refer to specific implementation (e.g. :ref:`SceneMultiplayer`) for details on how they use it. @@ -328,7 +331,7 @@ Notifies the MultiplayerAPI to remove a ``configuration`` for the given ``object .. rst-class:: classref-method -:ref:`Error` **poll** **(** **)** +:ref:`Error` **poll**\ (\ ) Method used for polling the MultiplayerAPI. You only need to worry about this if you set :ref:`SceneTree.multiplayer_poll` to ``false``. By default, :ref:`SceneTree` will poll its MultiplayerAPI(s) for you. @@ -342,7 +345,7 @@ Method used for polling the MultiplayerAPI. You only need to worry about this if .. rst-class:: classref-method -:ref:`Error` **rpc** **(** :ref:`int` peer, :ref:`Object` object, :ref:`StringName` method, :ref:`Array` arguments=[] **)** +:ref:`Error` **rpc**\ (\ peer\: :ref:`int`, object\: :ref:`Object`, method\: :ref:`StringName`, arguments\: :ref:`Array` = []\ ) Sends an RPC to the target ``peer``. The given ``method`` will be called on the remote ``object`` with the provided ``arguments``. The RPC may also be called locally depending on the implementation and RPC configuration. See :ref:`Node.rpc` and :ref:`Node.rpc_config`. @@ -356,7 +359,7 @@ Sends an RPC to the target ``peer``. The given ``method`` will be called on the .. rst-class:: classref-method -void **set_default_interface** **(** :ref:`StringName` interface_name **)** |static| +|void| **set_default_interface**\ (\ interface_name\: :ref:`StringName`\ ) |static| Sets the default MultiplayerAPI implementation class. This method can be used by modules and extensions to configure which implementation will be used by :ref:`SceneTree` when the engine starts. @@ -367,3 +370,4 @@ Sets the default MultiplayerAPI implementation class. This method can be used by .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_multiplayerapiextension.rst b/classes/class_multiplayerapiextension.rst index aabc9733799..c58e3edc762 100644 --- a/classes/class_multiplayerapiextension.rst +++ b/classes/class_multiplayerapiextension.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: network + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -108,25 +111,25 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`MultiplayerPeer` | :ref:`_get_multiplayer_peer` **(** **)** |virtual| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_get_peer_ids` **(** **)** |virtual| |const| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_remote_sender_id` **(** **)** |virtual| |const| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_unique_id` **(** **)** |virtual| |const| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_object_configuration_add` **(** :ref:`Object` object, :ref:`Variant` configuration **)** |virtual| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_object_configuration_remove` **(** :ref:`Object` object, :ref:`Variant` configuration **)** |virtual| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_poll` **(** **)** |virtual| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_rpc` **(** :ref:`int` peer, :ref:`Object` object, :ref:`StringName` method, :ref:`Array` args **)** |virtual| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_multiplayer_peer` **(** :ref:`MultiplayerPeer` multiplayer_peer **)** |virtual| | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`MultiplayerPeer` | :ref:`_get_multiplayer_peer`\ (\ ) |virtual| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_get_peer_ids`\ (\ ) |virtual| |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_remote_sender_id`\ (\ ) |virtual| |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_unique_id`\ (\ ) |virtual| |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_object_configuration_add`\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) |virtual| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_object_configuration_remove`\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) |virtual| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_poll`\ (\ ) |virtual| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_rpc`\ (\ peer\: :ref:`int`, object\: :ref:`Object`, method\: :ref:`StringName`, args\: :ref:`Array`\ ) |virtual| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_multiplayer_peer`\ (\ multiplayer_peer\: :ref:`MultiplayerPeer`\ ) |virtual| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -141,7 +144,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`MultiplayerPeer` **_get_multiplayer_peer** **(** **)** |virtual| +:ref:`MultiplayerPeer` **_get_multiplayer_peer**\ (\ ) |virtual| Called when the :ref:`MultiplayerAPI.multiplayer_peer` is retrieved. @@ -153,7 +156,7 @@ Called when the :ref:`MultiplayerAPI.multiplayer_peer` **_get_peer_ids** **(** **)** |virtual| |const| +:ref:`PackedInt32Array` **_get_peer_ids**\ (\ ) |virtual| |const| Callback for :ref:`MultiplayerAPI.get_peers`. @@ -165,7 +168,7 @@ Callback for :ref:`MultiplayerAPI.get_peers` **_get_remote_sender_id** **(** **)** |virtual| |const| +:ref:`int` **_get_remote_sender_id**\ (\ ) |virtual| |const| Callback for :ref:`MultiplayerAPI.get_remote_sender_id`. @@ -177,7 +180,7 @@ Callback for :ref:`MultiplayerAPI.get_remote_sender_id` **_get_unique_id** **(** **)** |virtual| |const| +:ref:`int` **_get_unique_id**\ (\ ) |virtual| |const| Callback for :ref:`MultiplayerAPI.get_unique_id`. @@ -189,7 +192,7 @@ Callback for :ref:`MultiplayerAPI.get_unique_id` **_object_configuration_add** **(** :ref:`Object` object, :ref:`Variant` configuration **)** |virtual| +:ref:`Error` **_object_configuration_add**\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) |virtual| Callback for :ref:`MultiplayerAPI.object_configuration_add`. @@ -201,7 +204,7 @@ Callback for :ref:`MultiplayerAPI.object_configuration_add` **_object_configuration_remove** **(** :ref:`Object` object, :ref:`Variant` configuration **)** |virtual| +:ref:`Error` **_object_configuration_remove**\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) |virtual| Callback for :ref:`MultiplayerAPI.object_configuration_remove`. @@ -213,7 +216,7 @@ Callback for :ref:`MultiplayerAPI.object_configuration_remove` **_poll** **(** **)** |virtual| +:ref:`Error` **_poll**\ (\ ) |virtual| Callback for :ref:`MultiplayerAPI.poll`. @@ -225,7 +228,7 @@ Callback for :ref:`MultiplayerAPI.poll`. .. rst-class:: classref-method -:ref:`Error` **_rpc** **(** :ref:`int` peer, :ref:`Object` object, :ref:`StringName` method, :ref:`Array` args **)** |virtual| +:ref:`Error` **_rpc**\ (\ peer\: :ref:`int`, object\: :ref:`Object`, method\: :ref:`StringName`, args\: :ref:`Array`\ ) |virtual| Callback for :ref:`MultiplayerAPI.rpc`. @@ -237,7 +240,7 @@ Callback for :ref:`MultiplayerAPI.rpc`. .. rst-class:: classref-method -void **_set_multiplayer_peer** **(** :ref:`MultiplayerPeer` multiplayer_peer **)** |virtual| +|void| **_set_multiplayer_peer**\ (\ multiplayer_peer\: :ref:`MultiplayerPeer`\ ) |virtual| Called when the :ref:`MultiplayerAPI.multiplayer_peer` is set. @@ -248,3 +251,4 @@ Called when the :ref:`MultiplayerAPI.multiplayer_peer` **(** **)** | - +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`disconnect_peer` **(** :ref:`int` peer, :ref:`bool` force=false **)** | - +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`generate_unique_id` **(** **)** |const| | - +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ConnectionStatus` | :ref:`get_connection_status` **(** **)** |const| | - +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_packet_channel` **(** **)** |const| | - +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TransferMode` | :ref:`get_packet_mode` **(** **)** |const| | - +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_packet_peer` **(** **)** |const| | - +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_unique_id` **(** **)** |const| | - +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_server_relay_supported` **(** **)** |const| | - +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`poll` **(** **)** | - +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_target_peer` **(** :ref:`int` id **)** | - +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`close`\ (\ ) | + +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`disconnect_peer`\ (\ peer\: :ref:`int`, force\: :ref:`bool` = false\ ) | + +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`generate_unique_id`\ (\ ) |const| | + +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ConnectionStatus` | :ref:`get_connection_status`\ (\ ) |const| | + +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_packet_channel`\ (\ ) |const| | + +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TransferMode` | :ref:`get_packet_mode`\ (\ ) |const| | + +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_packet_peer`\ (\ ) |const| | + +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_unique_id`\ (\ ) |const| | + +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_server_relay_supported`\ (\ ) |const| | + +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`poll`\ (\ ) | + +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_target_peer`\ (\ id\: :ref:`int`\ ) | + +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -97,7 +100,7 @@ Signals .. rst-class:: classref-signal -**peer_connected** **(** :ref:`int` id **)** +**peer_connected**\ (\ id\: :ref:`int`\ ) Emitted when a remote peer connects. @@ -109,7 +112,7 @@ Emitted when a remote peer connects. .. rst-class:: classref-signal -**peer_disconnected** **(** :ref:`int` id **)** +**peer_disconnected**\ (\ id\: :ref:`int`\ ) Emitted when a remote peer has disconnected. @@ -228,8 +231,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_refuse_new_connections** **(** :ref:`bool` value **)** -- :ref:`bool` **is_refusing_new_connections** **(** **)** +- |void| **set_refuse_new_connections**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_refusing_new_connections**\ (\ ) If ``true``, this **MultiplayerPeer** refuses new connections. @@ -245,8 +248,8 @@ If ``true``, this **MultiplayerPeer** refuses new connections. .. rst-class:: classref-property-setget -- void **set_transfer_channel** **(** :ref:`int` value **)** -- :ref:`int` **get_transfer_channel** **(** **)** +- |void| **set_transfer_channel**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_transfer_channel**\ (\ ) The channel to use to send packets. Many network APIs such as ENet and WebRTC allow the creation of multiple independent channels which behaves, in a way, like separate connections. This means that reliable data will only block delivery of other packets on that channel, and ordering will only be in respect to the channel the packet is being sent on. Using different channels to send **different and independent** state updates is a common way to optimize network usage and decrease latency in fast-paced games. @@ -264,8 +267,8 @@ The channel to use to send packets. Many network APIs such as ENet and WebRTC al .. rst-class:: classref-property-setget -- void **set_transfer_mode** **(** :ref:`TransferMode` value **)** -- :ref:`TransferMode` **get_transfer_mode** **(** **)** +- |void| **set_transfer_mode**\ (\ value\: :ref:`TransferMode`\ ) +- :ref:`TransferMode` **get_transfer_mode**\ (\ ) The manner in which to send packets to the target peer. See :ref:`TransferMode`, and the :ref:`set_target_peer` method. @@ -282,7 +285,7 @@ Method Descriptions .. rst-class:: classref-method -void **close** **(** **)** +|void| **close**\ (\ ) Immediately close the multiplayer peer returning to the state :ref:`CONNECTION_DISCONNECTED`. Connected peers will be dropped without emitting :ref:`peer_disconnected`. @@ -294,7 +297,7 @@ Immediately close the multiplayer peer returning to the state :ref:`CONNECTION_D .. rst-class:: classref-method -void **disconnect_peer** **(** :ref:`int` peer, :ref:`bool` force=false **)** +|void| **disconnect_peer**\ (\ peer\: :ref:`int`, force\: :ref:`bool` = false\ ) Disconnects the given ``peer`` from this host. If ``force`` is ``true`` the :ref:`peer_disconnected` signal will not be emitted for this peer. @@ -306,7 +309,7 @@ Disconnects the given ``peer`` from this host. If ``force`` is ``true`` the :ref .. rst-class:: classref-method -:ref:`int` **generate_unique_id** **(** **)** |const| +:ref:`int` **generate_unique_id**\ (\ ) |const| Returns a randomly generated integer that can be used as a network unique ID. @@ -318,7 +321,7 @@ Returns a randomly generated integer that can be used as a network unique ID. .. rst-class:: classref-method -:ref:`ConnectionStatus` **get_connection_status** **(** **)** |const| +:ref:`ConnectionStatus` **get_connection_status**\ (\ ) |const| Returns the current state of the connection. See :ref:`ConnectionStatus`. @@ -330,7 +333,7 @@ Returns the current state of the connection. See :ref:`ConnectionStatus` **get_packet_channel** **(** **)** |const| +:ref:`int` **get_packet_channel**\ (\ ) |const| Returns the channel over which the next available packet was received. See :ref:`PacketPeer.get_available_packet_count`. @@ -342,7 +345,7 @@ Returns the channel over which the next available packet was received. See :ref: .. rst-class:: classref-method -:ref:`TransferMode` **get_packet_mode** **(** **)** |const| +:ref:`TransferMode` **get_packet_mode**\ (\ ) |const| Returns the transfer mode the remote peer used to send the next available packet. See :ref:`PacketPeer.get_available_packet_count`. @@ -354,7 +357,7 @@ Returns the transfer mode the remote peer used to send the next available packet .. rst-class:: classref-method -:ref:`int` **get_packet_peer** **(** **)** |const| +:ref:`int` **get_packet_peer**\ (\ ) |const| Returns the ID of the **MultiplayerPeer** who sent the next available packet. See :ref:`PacketPeer.get_available_packet_count`. @@ -366,7 +369,7 @@ Returns the ID of the **MultiplayerPeer** who sent the next available packet. Se .. rst-class:: classref-method -:ref:`int` **get_unique_id** **(** **)** |const| +:ref:`int` **get_unique_id**\ (\ ) |const| Returns the ID of this **MultiplayerPeer**. @@ -378,7 +381,7 @@ Returns the ID of this **MultiplayerPeer**. .. rst-class:: classref-method -:ref:`bool` **is_server_relay_supported** **(** **)** |const| +:ref:`bool` **is_server_relay_supported**\ (\ ) |const| Returns true if the server can act as a relay in the current configuration (i.e. if the higher level :ref:`MultiplayerAPI` should notify connected clients of other peers, and implement a relay protocol to allow communication between them). @@ -390,7 +393,7 @@ Returns true if the server can act as a relay in the current configuration (i.e. .. rst-class:: classref-method -void **poll** **(** **)** +|void| **poll**\ (\ ) Waits up to 1 second to receive a new network event. @@ -402,7 +405,7 @@ Waits up to 1 second to receive a new network event. .. rst-class:: classref-method -void **set_target_peer** **(** :ref:`int` id **)** +|void| **set_target_peer**\ (\ id\: :ref:`int`\ ) Sets the peer to which packets will be sent. @@ -415,3 +418,4 @@ The ``id`` can be one of: :ref:`TARGET_PEER_BROADCAST` **(** **)** |virtual| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_disconnect_peer` **(** :ref:`int` p_peer, :ref:`bool` p_force **)** |virtual| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_available_packet_count` **(** **)** |virtual| |const| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ConnectionStatus` | :ref:`_get_connection_status` **(** **)** |virtual| |const| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_max_packet_size` **(** **)** |virtual| |const| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_get_packet` **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_packet_channel` **(** **)** |virtual| |const| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TransferMode` | :ref:`_get_packet_mode` **(** **)** |virtual| |const| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_packet_peer` **(** **)** |virtual| |const| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`_get_packet_script` **(** **)** |virtual| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_transfer_channel` **(** **)** |virtual| |const| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TransferMode` | :ref:`_get_transfer_mode` **(** **)** |virtual| |const| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_unique_id` **(** **)** |virtual| |const| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_refusing_new_connections` **(** **)** |virtual| |const| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_server` **(** **)** |virtual| |const| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_server_relay_supported` **(** **)** |virtual| |const| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_poll` **(** **)** |virtual| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_put_packet` **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_put_packet_script` **(** :ref:`PackedByteArray` p_buffer **)** |virtual| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_refuse_new_connections` **(** :ref:`bool` p_enable **)** |virtual| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_target_peer` **(** :ref:`int` p_peer **)** |virtual| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_transfer_channel` **(** :ref:`int` p_channel **)** |virtual| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_transfer_mode` **(** :ref:`TransferMode` p_mode **)** |virtual| | - +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_close`\ (\ ) |virtual| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_disconnect_peer`\ (\ p_peer\: :ref:`int`, p_force\: :ref:`bool`\ ) |virtual| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_available_packet_count`\ (\ ) |virtual| |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ConnectionStatus` | :ref:`_get_connection_status`\ (\ ) |virtual| |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_max_packet_size`\ (\ ) |virtual| |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_get_packet`\ (\ r_buffer\: ``const uint8_t **``, r_buffer_size\: ``int32_t*``\ ) |virtual| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_packet_channel`\ (\ ) |virtual| |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TransferMode` | :ref:`_get_packet_mode`\ (\ ) |virtual| |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_packet_peer`\ (\ ) |virtual| |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`_get_packet_script`\ (\ ) |virtual| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_transfer_channel`\ (\ ) |virtual| |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TransferMode` | :ref:`_get_transfer_mode`\ (\ ) |virtual| |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_unique_id`\ (\ ) |virtual| |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_refusing_new_connections`\ (\ ) |virtual| |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_server`\ (\ ) |virtual| |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_server_relay_supported`\ (\ ) |virtual| |const| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_poll`\ (\ ) |virtual| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_put_packet`\ (\ p_buffer\: ``const uint8_t*``, p_buffer_size\: :ref:`int`\ ) |virtual| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_put_packet_script`\ (\ p_buffer\: :ref:`PackedByteArray`\ ) |virtual| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_refuse_new_connections`\ (\ p_enable\: :ref:`bool`\ ) |virtual| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_target_peer`\ (\ p_peer\: :ref:`int`\ ) |virtual| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_transfer_channel`\ (\ p_channel\: :ref:`int`\ ) |virtual| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_transfer_mode`\ (\ p_mode\: :ref:`TransferMode`\ ) |virtual| | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -90,7 +93,7 @@ Method Descriptions .. rst-class:: classref-method -void **_close** **(** **)** |virtual| +|void| **_close**\ (\ ) |virtual| Called when the multiplayer peer should be immediately closed (see :ref:`MultiplayerPeer.close`). @@ -102,7 +105,7 @@ Called when the multiplayer peer should be immediately closed (see :ref:`Multipl .. rst-class:: classref-method -void **_disconnect_peer** **(** :ref:`int` p_peer, :ref:`bool` p_force **)** |virtual| +|void| **_disconnect_peer**\ (\ p_peer\: :ref:`int`, p_force\: :ref:`bool`\ ) |virtual| Called when the connected ``p_peer`` should be forcibly disconnected (see :ref:`MultiplayerPeer.disconnect_peer`). @@ -114,7 +117,7 @@ Called when the connected ``p_peer`` should be forcibly disconnected (see :ref:` .. rst-class:: classref-method -:ref:`int` **_get_available_packet_count** **(** **)** |virtual| |const| +:ref:`int` **_get_available_packet_count**\ (\ ) |virtual| |const| Called when the available packet count is internally requested by the :ref:`MultiplayerAPI`. @@ -126,7 +129,7 @@ Called when the available packet count is internally requested by the :ref:`Mult .. rst-class:: classref-method -:ref:`ConnectionStatus` **_get_connection_status** **(** **)** |virtual| |const| +:ref:`ConnectionStatus` **_get_connection_status**\ (\ ) |virtual| |const| Called when the connection status is requested on the :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.get_connection_status`). @@ -138,7 +141,7 @@ Called when the connection status is requested on the :ref:`MultiplayerPeer` **_get_max_packet_size** **(** **)** |virtual| |const| +:ref:`int` **_get_max_packet_size**\ (\ ) |virtual| |const| Called when the maximum allowed packet size (in bytes) is requested by the :ref:`MultiplayerAPI`. @@ -150,7 +153,7 @@ Called when the maximum allowed packet size (in bytes) is requested by the :ref: .. rst-class:: classref-method -:ref:`Error` **_get_packet** **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| +:ref:`Error` **_get_packet**\ (\ r_buffer\: ``const uint8_t **``, r_buffer_size\: ``int32_t*``\ ) |virtual| Called when a packet needs to be received by the :ref:`MultiplayerAPI`, with ``r_buffer_size`` being the size of the binary ``r_buffer`` in bytes. @@ -162,7 +165,7 @@ Called when a packet needs to be received by the :ref:`MultiplayerAPI` **_get_packet_channel** **(** **)** |virtual| |const| +:ref:`int` **_get_packet_channel**\ (\ ) |virtual| |const| Called to get the channel over which the next available packet was received. See :ref:`MultiplayerPeer.get_packet_channel`. @@ -174,7 +177,7 @@ Called to get the channel over which the next available packet was received. See .. rst-class:: classref-method -:ref:`TransferMode` **_get_packet_mode** **(** **)** |virtual| |const| +:ref:`TransferMode` **_get_packet_mode**\ (\ ) |virtual| |const| Called to get the transfer mode the remote peer used to send the next available packet. See :ref:`MultiplayerPeer.get_packet_mode`. @@ -186,7 +189,7 @@ Called to get the transfer mode the remote peer used to send the next available .. rst-class:: classref-method -:ref:`int` **_get_packet_peer** **(** **)** |virtual| |const| +:ref:`int` **_get_packet_peer**\ (\ ) |virtual| |const| Called when the ID of the :ref:`MultiplayerPeer` who sent the most recent packet is requested (see :ref:`MultiplayerPeer.get_packet_peer`). @@ -198,7 +201,7 @@ Called when the ID of the :ref:`MultiplayerPeer` who sent .. rst-class:: classref-method -:ref:`PackedByteArray` **_get_packet_script** **(** **)** |virtual| +:ref:`PackedByteArray` **_get_packet_script**\ (\ ) |virtual| Called when a packet needs to be received by the :ref:`MultiplayerAPI`, if :ref:`_get_packet` isn't implemented. Use this when extending this class via GDScript. @@ -210,7 +213,7 @@ Called when a packet needs to be received by the :ref:`MultiplayerAPI` **_get_transfer_channel** **(** **)** |virtual| |const| +:ref:`int` **_get_transfer_channel**\ (\ ) |virtual| |const| Called when the transfer channel to use is read on this :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.transfer_channel`). @@ -222,7 +225,7 @@ Called when the transfer channel to use is read on this :ref:`MultiplayerPeer` **_get_transfer_mode** **(** **)** |virtual| |const| +:ref:`TransferMode` **_get_transfer_mode**\ (\ ) |virtual| |const| Called when the transfer mode to use is read on this :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.transfer_mode`). @@ -234,7 +237,7 @@ Called when the transfer mode to use is read on this :ref:`MultiplayerPeer` **_get_unique_id** **(** **)** |virtual| |const| +:ref:`int` **_get_unique_id**\ (\ ) |virtual| |const| Called when the unique ID of this :ref:`MultiplayerPeer` is requested (see :ref:`MultiplayerPeer.get_unique_id`). The value must be between ``1`` and ``2147483647``. @@ -246,7 +249,7 @@ Called when the unique ID of this :ref:`MultiplayerPeer` .. rst-class:: classref-method -:ref:`bool` **_is_refusing_new_connections** **(** **)** |virtual| |const| +:ref:`bool` **_is_refusing_new_connections**\ (\ ) |virtual| |const| Called when the "refuse new connections" status is requested on this :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.refuse_new_connections`). @@ -258,7 +261,7 @@ Called when the "refuse new connections" status is requested on this :ref:`Multi .. rst-class:: classref-method -:ref:`bool` **_is_server** **(** **)** |virtual| |const| +:ref:`bool` **_is_server**\ (\ ) |virtual| |const| Called when the "is server" status is requested on the :ref:`MultiplayerAPI`. See :ref:`MultiplayerAPI.is_server`. @@ -270,7 +273,7 @@ Called when the "is server" status is requested on the :ref:`MultiplayerAPI` **_is_server_relay_supported** **(** **)** |virtual| |const| +:ref:`bool` **_is_server_relay_supported**\ (\ ) |virtual| |const| Called to check if the server can act as a relay in the current configuration. See :ref:`MultiplayerPeer.is_server_relay_supported`. @@ -282,7 +285,7 @@ Called to check if the server can act as a relay in the current configuration. S .. rst-class:: classref-method -void **_poll** **(** **)** |virtual| +|void| **_poll**\ (\ ) |virtual| Called when the :ref:`MultiplayerAPI` is polled. See :ref:`MultiplayerAPI.poll`. @@ -294,7 +297,7 @@ Called when the :ref:`MultiplayerAPI` is polled. See :ref: .. rst-class:: classref-method -:ref:`Error` **_put_packet** **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| +:ref:`Error` **_put_packet**\ (\ p_buffer\: ``const uint8_t*``, p_buffer_size\: :ref:`int`\ ) |virtual| Called when a packet needs to be sent by the :ref:`MultiplayerAPI`, with ``p_buffer_size`` being the size of the binary ``p_buffer`` in bytes. @@ -306,7 +309,7 @@ Called when a packet needs to be sent by the :ref:`MultiplayerAPI` **_put_packet_script** **(** :ref:`PackedByteArray` p_buffer **)** |virtual| +:ref:`Error` **_put_packet_script**\ (\ p_buffer\: :ref:`PackedByteArray`\ ) |virtual| Called when a packet needs to be sent by the :ref:`MultiplayerAPI`, if :ref:`_put_packet` isn't implemented. Use this when extending this class via GDScript. @@ -318,7 +321,7 @@ Called when a packet needs to be sent by the :ref:`MultiplayerAPI` p_enable **)** |virtual| +|void| **_set_refuse_new_connections**\ (\ p_enable\: :ref:`bool`\ ) |virtual| Called when the "refuse new connections" status is set on this :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.refuse_new_connections`). @@ -330,7 +333,7 @@ Called when the "refuse new connections" status is set on this :ref:`Multiplayer .. rst-class:: classref-method -void **_set_target_peer** **(** :ref:`int` p_peer **)** |virtual| +|void| **_set_target_peer**\ (\ p_peer\: :ref:`int`\ ) |virtual| Called when the target peer to use is set for this :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.set_target_peer`). @@ -342,7 +345,7 @@ Called when the target peer to use is set for this :ref:`MultiplayerPeer` p_channel **)** |virtual| +|void| **_set_transfer_channel**\ (\ p_channel\: :ref:`int`\ ) |virtual| Called when the channel to use is set for this :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.transfer_channel`). @@ -354,7 +357,7 @@ Called when the channel to use is set for this :ref:`MultiplayerPeer` p_mode **)** |virtual| +|void| **_set_transfer_mode**\ (\ p_mode\: :ref:`TransferMode`\ ) |virtual| Called when the transfer mode is set on this :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.transfer_mode`). @@ -365,3 +368,4 @@ Called when the transfer mode is set on this :ref:`MultiplayerPeer` **(** :ref:`String` path **)** | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_spawnable_scenes` **(** **)** | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_spawnable_scene` **(** :ref:`int` index **)** |const| | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_spawnable_scene_count` **(** **)** |const| | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`spawn` **(** :ref:`Variant` data=null **)** | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_spawnable_scene`\ (\ path\: :ref:`String`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_spawnable_scenes`\ (\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_spawnable_scene`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_spawnable_scene_count`\ (\ ) |const| | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`spawn`\ (\ data\: :ref:`Variant` = null\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -74,7 +77,7 @@ Signals .. rst-class:: classref-signal -**despawned** **(** :ref:`Node` node **)** +**despawned**\ (\ node\: :ref:`Node`\ ) Emitted when a spawnable scene or custom spawn was despawned by the multiplayer authority. Only called on puppets. @@ -86,7 +89,7 @@ Emitted when a spawnable scene or custom spawn was despawned by the multiplayer .. rst-class:: classref-signal -**spawned** **(** :ref:`Node` node **)** +**spawned**\ (\ node\: :ref:`Node`\ ) Emitted when a spawnable scene or custom spawn was spawned by the multiplayer authority. Only called on puppets. @@ -107,8 +110,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_spawn_function** **(** :ref:`Callable` value **)** -- :ref:`Callable` **get_spawn_function** **(** **)** +- |void| **set_spawn_function**\ (\ value\: :ref:`Callable`\ ) +- :ref:`Callable` **get_spawn_function**\ (\ ) Method called on all peers when for every custom :ref:`spawn` requested by the authority. Will receive the ``data`` parameter, and should return a :ref:`Node` that is not in the scene tree. @@ -126,8 +129,8 @@ Method called on all peers when for every custom :ref:`spawn` value **)** -- :ref:`int` **get_spawn_limit** **(** **)** +- |void| **set_spawn_limit**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_spawn_limit**\ (\ ) Maximum nodes that is allowed to be spawned by this spawner. Includes both spawnable scenes and custom spawns. @@ -145,8 +148,8 @@ When set to ``0`` (the default), there is no limit. .. rst-class:: classref-property-setget -- void **set_spawn_path** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_spawn_path** **(** **)** +- |void| **set_spawn_path**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_spawn_path**\ (\ ) Path to the spawn root. Spawnable scenes that are added as direct children are replicated to other peers. @@ -163,7 +166,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_spawnable_scene** **(** :ref:`String` path **)** +|void| **add_spawnable_scene**\ (\ path\: :ref:`String`\ ) Adds a scene path to spawnable scenes, making it automatically replicated from the multiplayer authority to other peers when added as children of the node pointed by :ref:`spawn_path`. @@ -175,7 +178,7 @@ Adds a scene path to spawnable scenes, making it automatically replicated from t .. rst-class:: classref-method -void **clear_spawnable_scenes** **(** **)** +|void| **clear_spawnable_scenes**\ (\ ) Clears all spawnable scenes. Does not despawn existing instances on remote peers. @@ -187,7 +190,7 @@ Clears all spawnable scenes. Does not despawn existing instances on remote peers .. rst-class:: classref-method -:ref:`String` **get_spawnable_scene** **(** :ref:`int` index **)** |const| +:ref:`String` **get_spawnable_scene**\ (\ index\: :ref:`int`\ ) |const| Returns the spawnable scene path by index. @@ -199,7 +202,7 @@ Returns the spawnable scene path by index. .. rst-class:: classref-method -:ref:`int` **get_spawnable_scene_count** **(** **)** |const| +:ref:`int` **get_spawnable_scene_count**\ (\ ) |const| Returns the count of spawnable scene paths. @@ -211,7 +214,7 @@ Returns the count of spawnable scene paths. .. rst-class:: classref-method -:ref:`Node` **spawn** **(** :ref:`Variant` data=null **)** +:ref:`Node` **spawn**\ (\ data\: :ref:`Variant` = null\ ) Requests a custom spawn, with ``data`` passed to :ref:`spawn_function` on all peers. Returns the locally spawned node instance already inside the scene tree, and added as a child of the node pointed by :ref:`spawn_path`. @@ -224,3 +227,4 @@ Requests a custom spawn, with ``data`` passed to :ref:`spawn_function` **(** :ref:`Callable` filter **)** | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_visibility_for` **(** :ref:`int` peer **)** |const| | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_visibility_filter` **(** :ref:`Callable` filter **)** | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_visibility_for` **(** :ref:`int` peer, :ref:`bool` visible **)** | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`update_visibility` **(** :ref:`int` for_peer=0 **)** | - +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_visibility_filter`\ (\ filter\: :ref:`Callable`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_visibility_for`\ (\ peer\: :ref:`int`\ ) |const| | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_visibility_filter`\ (\ filter\: :ref:`Callable`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_visibility_for`\ (\ peer\: :ref:`int`, visible\: :ref:`bool`\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update_visibility`\ (\ for_peer\: :ref:`int` = 0\ ) | + +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -84,7 +87,7 @@ Signals .. rst-class:: classref-signal -**delta_synchronized** **(** **)** +**delta_synchronized**\ (\ ) Emitted when a new delta synchronization state is received by this synchronizer after the properties have been updated. @@ -96,7 +99,7 @@ Emitted when a new delta synchronization state is received by this synchronizer .. rst-class:: classref-signal -**synchronized** **(** **)** +**synchronized**\ (\ ) Emitted when a new synchronization state is received by this synchronizer after the properties have been updated. @@ -108,7 +111,7 @@ Emitted when a new synchronization state is received by this synchronizer after .. rst-class:: classref-signal -**visibility_changed** **(** :ref:`int` for_peer **)** +**visibility_changed**\ (\ for_peer\: :ref:`int`\ ) Emitted when visibility of ``for_peer`` is updated. See :ref:`update_visibility`. @@ -168,8 +171,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_delta_interval** **(** :ref:`float` value **)** -- :ref:`float` **get_delta_interval** **(** **)** +- |void| **set_delta_interval**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_delta_interval**\ (\ ) Time interval between delta synchronizations. When set to ``0.0`` (the default), delta synchronizations happen every network process frame. @@ -185,8 +188,8 @@ Time interval between delta synchronizations. When set to ``0.0`` (the default), .. rst-class:: classref-property-setget -- void **set_visibility_public** **(** :ref:`bool` value **)** -- :ref:`bool` **is_visibility_public** **(** **)** +- |void| **set_visibility_public**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_visibility_public**\ (\ ) Whether synchronization should be visible to all peers by default. See :ref:`set_visibility_for` and :ref:`add_visibility_filter` for ways of configuring fine-grained visibility options. @@ -202,8 +205,8 @@ Whether synchronization should be visible to all peers by default. See :ref:`set .. rst-class:: classref-property-setget -- void **set_replication_config** **(** :ref:`SceneReplicationConfig` value **)** -- :ref:`SceneReplicationConfig` **get_replication_config** **(** **)** +- |void| **set_replication_config**\ (\ value\: :ref:`SceneReplicationConfig`\ ) +- :ref:`SceneReplicationConfig` **get_replication_config**\ (\ ) Resource containing which properties to synchronize. @@ -219,8 +222,8 @@ Resource containing which properties to synchronize. .. rst-class:: classref-property-setget -- void **set_replication_interval** **(** :ref:`float` value **)** -- :ref:`float` **get_replication_interval** **(** **)** +- |void| **set_replication_interval**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_replication_interval**\ (\ ) Time interval between synchronizations. When set to ``0.0`` (the default), synchronizations happen every network process frame. @@ -236,8 +239,8 @@ Time interval between synchronizations. When set to ``0.0`` (the default), synch .. rst-class:: classref-property-setget -- void **set_root_path** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_root_path** **(** **)** +- |void| **set_root_path**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_root_path**\ (\ ) Node path that replicated properties are relative to. @@ -255,8 +258,8 @@ If :ref:`root_path` was spawne .. rst-class:: classref-property-setget -- void **set_visibility_update_mode** **(** :ref:`VisibilityUpdateMode` value **)** -- :ref:`VisibilityUpdateMode` **get_visibility_update_mode** **(** **)** +- |void| **set_visibility_update_mode**\ (\ value\: :ref:`VisibilityUpdateMode`\ ) +- :ref:`VisibilityUpdateMode` **get_visibility_update_mode**\ (\ ) Specifies when visibility filters are updated (see :ref:`VisibilityUpdateMode` for options). @@ -273,7 +276,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_visibility_filter** **(** :ref:`Callable` filter **)** +|void| **add_visibility_filter**\ (\ filter\: :ref:`Callable`\ ) Adds a peer visibility filter for this synchronizer. @@ -287,7 +290,7 @@ Adds a peer visibility filter for this synchronizer. .. rst-class:: classref-method -:ref:`bool` **get_visibility_for** **(** :ref:`int` peer **)** |const| +:ref:`bool` **get_visibility_for**\ (\ peer\: :ref:`int`\ ) |const| Queries the current visibility for peer ``peer``. @@ -299,7 +302,7 @@ Queries the current visibility for peer ``peer``. .. rst-class:: classref-method -void **remove_visibility_filter** **(** :ref:`Callable` filter **)** +|void| **remove_visibility_filter**\ (\ filter\: :ref:`Callable`\ ) Removes a peer visibility filter from this synchronizer. @@ -311,7 +314,7 @@ Removes a peer visibility filter from this synchronizer. .. rst-class:: classref-method -void **set_visibility_for** **(** :ref:`int` peer, :ref:`bool` visible **)** +|void| **set_visibility_for**\ (\ peer\: :ref:`int`, visible\: :ref:`bool`\ ) Sets the visibility of ``peer`` to ``visible``. If ``peer`` is ``0``, the value of :ref:`public_visibility` will be updated instead. @@ -323,7 +326,7 @@ Sets the visibility of ``peer`` to ``visible``. If ``peer`` is ``0``, the value .. rst-class:: classref-method -void **update_visibility** **(** :ref:`int` for_peer=0 **)** +|void| **update_visibility**\ (\ for_peer\: :ref:`int` = 0\ ) Updates the visibility of ``for_peer`` according to visibility filters. If ``for_peer`` is ``0`` (the default), all peers' visibilties are updated. @@ -334,3 +337,4 @@ Updates the visibility of ``for_peer`` according to visibility filters. If ``for .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index 869ae609774..2aca65ceadb 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -48,13 +48,13 @@ Methods .. table:: :widths: auto - +-------------------------+----------------------------------------------------------+ - | void | :ref:`lock` **(** **)** | - +-------------------------+----------------------------------------------------------+ - | :ref:`bool` | :ref:`try_lock` **(** **)** | - +-------------------------+----------------------------------------------------------+ - | void | :ref:`unlock` **(** **)** | - +-------------------------+----------------------------------------------------------+ + +-------------------------+----------------------------------------------------+ + | |void| | :ref:`lock`\ (\ ) | + +-------------------------+----------------------------------------------------+ + | :ref:`bool` | :ref:`try_lock`\ (\ ) | + +-------------------------+----------------------------------------------------+ + | |void| | :ref:`unlock`\ (\ ) | + +-------------------------+----------------------------------------------------+ .. rst-class:: classref-section-separator @@ -69,7 +69,7 @@ Method Descriptions .. rst-class:: classref-method -void **lock** **(** **)** +|void| **lock**\ (\ ) Locks this **Mutex**, blocks until it is unlocked by the current owner. @@ -83,7 +83,7 @@ Locks this **Mutex**, blocks until it is unlocked by the current owner. .. rst-class:: classref-method -:ref:`bool` **try_lock** **(** **)** +:ref:`bool` **try_lock**\ (\ ) Tries locking this **Mutex**, but does not block. Returns ``true`` on success, ``false`` otherwise. @@ -97,7 +97,7 @@ Tries locking this **Mutex**, but does not block. Returns ``true`` on success, ` .. rst-class:: classref-method -void **unlock** **(** **)** +|void| **unlock**\ (\ ) Unlocks this **Mutex**, leaving it to other threads. @@ -112,3 +112,4 @@ Unlocks this **Mutex**, leaving it to other threads. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationagent2d.rst b/classes/class_navigationagent2d.rst index 9b282f2eb61..13c6cf32d98 100644 --- a/classes/class_navigationagent2d.rst +++ b/classes/class_navigationagent2d.rst @@ -73,7 +73,7 @@ Properties +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`path_max_distance` | ``100.0`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | |bitfield|\<:ref:`PathMetadataFlags`\> | :ref:`path_metadata_flags` | ``7`` | + | |bitfield|\[:ref:`PathMetadataFlags`\] | :ref:`path_metadata_flags` | ``7`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`PathPostProcessing` | :ref:`path_postprocessing` | ``0`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ @@ -100,45 +100,45 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`distance_to_target` **(** **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_avoidance_layer_value` **(** :ref:`int` layer_number **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_avoidance_mask_value` **(** :ref:`int` mask_number **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`get_current_navigation_path` **(** **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_current_navigation_path_index` **(** **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NavigationPathQueryResult2D` | :ref:`get_current_navigation_result` **(** **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_final_position` **(** **)** | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_navigation_layer_value` **(** :ref:`int` layer_number **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_navigation_map` **(** **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_next_path_position` **(** **)** | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_navigation_finished` **(** **)** | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_target_reachable` **(** **)** | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_target_reached` **(** **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_avoidance_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_avoidance_mask_value` **(** :ref:`int` mask_number, :ref:`bool` value **)** | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_navigation_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_navigation_map` **(** :ref:`RID` navigation_map **)** | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_velocity_forced` **(** :ref:`Vector2` velocity **)** | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`distance_to_target`\ (\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_avoidance_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_avoidance_mask_value`\ (\ mask_number\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`get_current_navigation_path`\ (\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_current_navigation_path_index`\ (\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NavigationPathQueryResult2D` | :ref:`get_current_navigation_result`\ (\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_final_position`\ (\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_navigation_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_navigation_map`\ (\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_next_path_position`\ (\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_navigation_finished`\ (\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_target_reachable`\ (\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_target_reached`\ (\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_avoidance_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_avoidance_mask_value`\ (\ mask_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_navigation_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_navigation_map`\ (\ navigation_map\: :ref:`RID`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_velocity_forced`\ (\ velocity\: :ref:`Vector2`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -153,7 +153,7 @@ Signals .. rst-class:: classref-signal -**link_reached** **(** :ref:`Dictionary` details **)** +**link_reached**\ (\ details\: :ref:`Dictionary`\ ) Signals that the agent reached a navigation link. Emitted when the agent moves within :ref:`path_desired_distance` of the next position of the path when that position is a navigation link. @@ -179,7 +179,7 @@ The details dictionary may contain the following keys depending on the value of .. rst-class:: classref-signal -**navigation_finished** **(** **)** +**navigation_finished**\ (\ ) Signals that the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached. This signal is emitted only once per loaded path. @@ -193,7 +193,7 @@ This signal will be emitted just after :ref:`target_reached` of the :ref:`target_position`. This signal is emitted only once per loaded path. @@ -227,7 +227,7 @@ It may not always be possible to reach the target but it should always be possib .. rst-class:: classref-signal -**velocity_computed** **(** :ref:`Vector2` safe_velocity **)** +**velocity_computed**\ (\ safe_velocity\: :ref:`Vector2`\ ) Notifies when the collision avoidance velocity is calculated. Emitted when :ref:`velocity` is set. Only emitted when :ref:`avoidance_enabled` is true. @@ -239,7 +239,7 @@ Notifies when the collision avoidance velocity is calculated. Emitted when :ref: .. rst-class:: classref-signal -**waypoint_reached** **(** :ref:`Dictionary` details **)** +**waypoint_reached**\ (\ details\: :ref:`Dictionary`\ ) Signals that the agent reached a waypoint. Emitted when the agent moves within :ref:`path_desired_distance` of the next position of the path. @@ -270,8 +270,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_avoidance_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **get_avoidance_enabled** **(** **)** +- |void| **set_avoidance_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_avoidance_enabled**\ (\ ) If ``true`` the agent is registered for an RVO avoidance callback on the :ref:`NavigationServer2D`. When :ref:`velocity` is used and the processing is completed a ``safe_velocity`` Vector2 is received with a signal connection to :ref:`velocity_computed`. Avoidance processing with many registered agents has a significant performance cost and should only be enabled on agents that currently require it. @@ -287,8 +287,8 @@ If ``true`` the agent is registered for an RVO avoidance callback on the :ref:`N .. rst-class:: classref-property-setget -- void **set_avoidance_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_avoidance_layers** **(** **)** +- |void| **set_avoidance_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_avoidance_layers**\ (\ ) A bitfield determining the avoidance layers for this NavigationAgent. Other agents with a matching bit on the :ref:`avoidance_mask` will avoid this agent. @@ -304,8 +304,8 @@ A bitfield determining the avoidance layers for this NavigationAgent. Other agen .. rst-class:: classref-property-setget -- void **set_avoidance_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_avoidance_mask** **(** **)** +- |void| **set_avoidance_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_avoidance_mask**\ (\ ) A bitfield determining what other avoidance agents and obstacles this NavigationAgent will avoid when a bit matches at least one of their :ref:`avoidance_layers`. @@ -321,8 +321,8 @@ A bitfield determining what other avoidance agents and obstacles this Navigation .. rst-class:: classref-property-setget -- void **set_avoidance_priority** **(** :ref:`float` value **)** -- :ref:`float` **get_avoidance_priority** **(** **)** +- |void| **set_avoidance_priority**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_avoidance_priority**\ (\ ) The agent does not adjust the velocity for other agents that would match the :ref:`avoidance_mask` but have a lower :ref:`avoidance_priority`. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent. @@ -338,8 +338,8 @@ The agent does not adjust the velocity for other agents that would match the :re .. rst-class:: classref-property-setget -- void **set_debug_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **get_debug_enabled** **(** **)** +- |void| **set_debug_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_debug_enabled**\ (\ ) If ``true`` shows debug visuals for this agent. @@ -355,8 +355,8 @@ If ``true`` shows debug visuals for this agent. .. rst-class:: classref-property-setget -- void **set_debug_path_custom_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_debug_path_custom_color** **(** **)** +- |void| **set_debug_path_custom_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_debug_path_custom_color**\ (\ ) If :ref:`debug_use_custom` is ``true`` uses this color for this agent instead of global color. @@ -372,8 +372,8 @@ If :ref:`debug_use_custom` is .. rst-class:: classref-property-setget -- void **set_debug_path_custom_line_width** **(** :ref:`float` value **)** -- :ref:`float` **get_debug_path_custom_line_width** **(** **)** +- |void| **set_debug_path_custom_line_width**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_debug_path_custom_line_width**\ (\ ) If :ref:`debug_use_custom` is ``true`` uses this line width for rendering paths for this agent instead of global line width. @@ -389,8 +389,8 @@ If :ref:`debug_use_custom` is .. rst-class:: classref-property-setget -- void **set_debug_path_custom_point_size** **(** :ref:`float` value **)** -- :ref:`float` **get_debug_path_custom_point_size** **(** **)** +- |void| **set_debug_path_custom_point_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_debug_path_custom_point_size**\ (\ ) If :ref:`debug_use_custom` is ``true`` uses this rasterized point size for rendering path points for this agent instead of global point size. @@ -406,8 +406,8 @@ If :ref:`debug_use_custom` is .. rst-class:: classref-property-setget -- void **set_debug_use_custom** **(** :ref:`bool` value **)** -- :ref:`bool` **get_debug_use_custom** **(** **)** +- |void| **set_debug_use_custom**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_debug_use_custom**\ (\ ) If ``true`` uses the defined :ref:`debug_path_custom_color` for this agent instead of global color. @@ -423,8 +423,8 @@ If ``true`` uses the defined :ref:`debug_path_custom_color` value **)** -- :ref:`int` **get_max_neighbors** **(** **)** +- |void| **set_max_neighbors**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_neighbors**\ (\ ) The maximum number of neighbors for the agent to consider. @@ -440,8 +440,8 @@ The maximum number of neighbors for the agent to consider. .. rst-class:: classref-property-setget -- void **set_max_speed** **(** :ref:`float` value **)** -- :ref:`float` **get_max_speed** **(** **)** +- |void| **set_max_speed**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_max_speed**\ (\ ) The maximum speed that an agent can move. @@ -457,8 +457,8 @@ The maximum speed that an agent can move. .. rst-class:: classref-property-setget -- void **set_navigation_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_navigation_layers** **(** **)** +- |void| **set_navigation_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_navigation_layers**\ (\ ) A bitfield determining which navigation layers of navigation regions this agent will use to calculate a path. Changing it during runtime will clear the current navigation path and generate a new one, according to the new navigation layers. @@ -474,8 +474,8 @@ A bitfield determining which navigation layers of navigation regions this agent .. rst-class:: classref-property-setget -- void **set_neighbor_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_neighbor_distance** **(** **)** +- |void| **set_neighbor_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_neighbor_distance**\ (\ ) The distance to search for other agents. @@ -491,8 +491,8 @@ The distance to search for other agents. .. rst-class:: classref-property-setget -- void **set_path_desired_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_path_desired_distance** **(** **)** +- |void| **set_path_desired_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_desired_distance**\ (\ ) The distance threshold before a path point is considered to be reached. This allows agents to not have to hit a path point on the path exactly, but only to reach its general area. If this value is set too high, the NavigationAgent will skip points on the path, which can lead to it leaving the navigation mesh. If this value is set too low, the NavigationAgent will be stuck in a repath loop because it will constantly overshoot the distance to the next point on each physics frame update. @@ -508,8 +508,8 @@ The distance threshold before a path point is considered to be reached. This all .. rst-class:: classref-property-setget -- void **set_path_max_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_path_max_distance** **(** **)** +- |void| **set_path_max_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_max_distance**\ (\ ) The maximum distance the agent is allowed away from the ideal path to the final position. This can happen due to trying to avoid collisions. When the maximum distance is exceeded, it recalculates the ideal path. @@ -521,12 +521,12 @@ The maximum distance the agent is allowed away from the ideal path to the final .. rst-class:: classref-property -|bitfield|\<:ref:`PathMetadataFlags`\> **path_metadata_flags** = ``7`` +|bitfield|\[:ref:`PathMetadataFlags`\] **path_metadata_flags** = ``7`` .. rst-class:: classref-property-setget -- void **set_path_metadata_flags** **(** |bitfield|\<:ref:`PathMetadataFlags`\> value **)** -- |bitfield|\<:ref:`PathMetadataFlags`\> **get_path_metadata_flags** **(** **)** +- |void| **set_path_metadata_flags**\ (\ value\: |bitfield|\[:ref:`PathMetadataFlags`\]\ ) +- |bitfield|\[:ref:`PathMetadataFlags`\] **get_path_metadata_flags**\ (\ ) Additional information to return with the navigation path. @@ -542,8 +542,8 @@ Additional information to return with the navigation path. .. rst-class:: classref-property-setget -- void **set_path_postprocessing** **(** :ref:`PathPostProcessing` value **)** -- :ref:`PathPostProcessing` **get_path_postprocessing** **(** **)** +- |void| **set_path_postprocessing**\ (\ value\: :ref:`PathPostProcessing`\ ) +- :ref:`PathPostProcessing` **get_path_postprocessing**\ (\ ) The path postprocessing applied to the raw path corridor found by the :ref:`pathfinding_algorithm`. @@ -559,8 +559,8 @@ The path postprocessing applied to the raw path corridor found by the :ref:`path .. rst-class:: classref-property-setget -- void **set_pathfinding_algorithm** **(** :ref:`PathfindingAlgorithm` value **)** -- :ref:`PathfindingAlgorithm` **get_pathfinding_algorithm** **(** **)** +- |void| **set_pathfinding_algorithm**\ (\ value\: :ref:`PathfindingAlgorithm`\ ) +- :ref:`PathfindingAlgorithm` **get_pathfinding_algorithm**\ (\ ) The pathfinding algorithm used in the path query. @@ -576,8 +576,8 @@ The pathfinding algorithm used in the path query. .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) The radius of the avoidance agent. This is the "body" of the avoidance agent and not the avoidance maneuver starting radius (which is controlled by :ref:`neighbor_distance`). @@ -595,8 +595,8 @@ Does not affect normal pathfinding. To change an actor's pathfinding radius bake .. rst-class:: classref-property-setget -- void **set_target_desired_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_target_desired_distance** **(** **)** +- |void| **set_target_desired_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_target_desired_distance**\ (\ ) The distance threshold before the target is considered to be reached. On reaching the target, :ref:`target_reached` is emitted and navigation ends (see :ref:`is_navigation_finished` and :ref:`navigation_finished`). @@ -616,8 +616,8 @@ You can also make navigation end closer to the target than each individual path .. rst-class:: classref-property-setget -- void **set_target_position** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_target_position** **(** **)** +- |void| **set_target_position**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_target_position**\ (\ ) If set, a new navigation path from the current agent position to the :ref:`target_position` is requested from the NavigationServer. @@ -633,8 +633,8 @@ If set, a new navigation path from the current agent position to the :ref:`targe .. rst-class:: classref-property-setget -- void **set_time_horizon_agents** **(** :ref:`float` value **)** -- :ref:`float` **get_time_horizon_agents** **(** **)** +- |void| **set_time_horizon_agents**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_time_horizon_agents**\ (\ ) The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithm, are safe with respect to other agents. The larger the number, the sooner the agent will respond to other agents, but less freedom in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. @@ -650,8 +650,8 @@ The minimal amount of time for which this agent's velocities, that are computed .. rst-class:: classref-property-setget -- void **set_time_horizon_obstacles** **(** :ref:`float` value **)** -- :ref:`float` **get_time_horizon_obstacles** **(** **)** +- |void| **set_time_horizon_obstacles**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_time_horizon_obstacles**\ (\ ) The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithm, are safe with respect to static avoidance obstacles. The larger the number, the sooner the agent will respond to static avoidance obstacles, but less freedom in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. @@ -667,8 +667,8 @@ The minimal amount of time for which this agent's velocities, that are computed .. rst-class:: classref-property-setget -- void **set_velocity** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_velocity** **(** **)** +- |void| **set_velocity**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_velocity**\ (\ ) Sets the new wanted velocity for the agent. The avoidance simulation will try to fulfill this velocity if possible but will modify it to avoid collision with other agents and obstacles. When an agent is teleported to a new position, use :ref:`set_velocity_forced` as well to reset the internal simulation velocity. @@ -685,7 +685,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **distance_to_target** **(** **)** |const| +:ref:`float` **distance_to_target**\ (\ ) |const| Returns the distance to the target position, using the agent's global position. The user must set :ref:`target_position` in order for this to be accurate. @@ -697,7 +697,7 @@ Returns the distance to the target position, using the agent's global position. .. rst-class:: classref-method -:ref:`bool` **get_avoidance_layer_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_avoidance_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`avoidance_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -709,7 +709,7 @@ Returns whether or not the specified layer of the :ref:`avoidance_layers` **get_avoidance_mask_value** **(** :ref:`int` mask_number **)** |const| +:ref:`bool` **get_avoidance_mask_value**\ (\ mask_number\: :ref:`int`\ ) |const| Returns whether or not the specified mask of the :ref:`avoidance_mask` bitmask is enabled, given a ``mask_number`` between 1 and 32. @@ -721,7 +721,7 @@ Returns whether or not the specified mask of the :ref:`avoidance_mask` **get_current_navigation_path** **(** **)** |const| +:ref:`PackedVector2Array` **get_current_navigation_path**\ (\ ) |const| Returns this agent's current path from start to finish in global coordinates. The path only updates when the target position is changed or the agent requires a repath. The path array is not intended to be used in direct path movement as the agent has its own internal path logic that would get corrupted by changing the path array manually. Use the intended :ref:`get_next_path_position` once every physics frame to receive the next path point for the agents movement as this function also updates the internal path logic. @@ -733,7 +733,7 @@ Returns this agent's current path from start to finish in global coordinates. Th .. rst-class:: classref-method -:ref:`int` **get_current_navigation_path_index** **(** **)** |const| +:ref:`int` **get_current_navigation_path_index**\ (\ ) |const| Returns which index the agent is currently on in the navigation path's :ref:`PackedVector2Array`. @@ -745,7 +745,7 @@ Returns which index the agent is currently on in the navigation path's :ref:`Pac .. rst-class:: classref-method -:ref:`NavigationPathQueryResult2D` **get_current_navigation_result** **(** **)** |const| +:ref:`NavigationPathQueryResult2D` **get_current_navigation_result**\ (\ ) |const| Returns the path query result for the path the agent is currently following. @@ -757,7 +757,7 @@ Returns the path query result for the path the agent is currently following. .. rst-class:: classref-method -:ref:`Vector2` **get_final_position** **(** **)** +:ref:`Vector2` **get_final_position**\ (\ ) Returns the reachable final position of the current navigation path in global coordinates. This position can change if the agent needs to update the navigation path which makes the agent emit the :ref:`path_changed` signal. @@ -769,7 +769,7 @@ Returns the reachable final position of the current navigation path in global co .. rst-class:: classref-method -:ref:`bool` **get_navigation_layer_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`navigation_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -781,7 +781,7 @@ Returns whether or not the specified layer of the :ref:`navigation_layers` **get_navigation_map** **(** **)** |const| +:ref:`RID` **get_navigation_map**\ (\ ) |const| Returns the :ref:`RID` of the navigation map for this NavigationAgent node. This function returns always the map set on the NavigationAgent node and not the map of the abstract agent on the NavigationServer. If the agent map is changed directly with the NavigationServer API the NavigationAgent node will not be aware of the map change. Use :ref:`set_navigation_map` to change the navigation map for the NavigationAgent and also update the agent on the NavigationServer. @@ -793,7 +793,7 @@ Returns the :ref:`RID` of the navigation map for this NavigationAgent .. rst-class:: classref-method -:ref:`Vector2` **get_next_path_position** **(** **)** +:ref:`Vector2` **get_next_path_position**\ (\ ) Returns the next position in global coordinates that can be moved to, making sure that there are no static objects in the way. If the agent does not have a navigation path, it will return the position of the agent's parent. The use of this function once every physics frame is required to update the internal path logic of the NavigationAgent. @@ -805,7 +805,7 @@ Returns the next position in global coordinates that can be moved to, making sur .. rst-class:: classref-method -:ref:`RID` **get_rid** **(** **)** |const| +:ref:`RID` **get_rid**\ (\ ) |const| Returns the :ref:`RID` of this agent on the :ref:`NavigationServer2D`. @@ -817,7 +817,7 @@ Returns the :ref:`RID` of this agent on the :ref:`NavigationServer2D< .. rst-class:: classref-method -:ref:`bool` **is_navigation_finished** **(** **)** +:ref:`bool` **is_navigation_finished**\ (\ ) Returns ``true`` if the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached. @@ -831,7 +831,7 @@ Returns ``true`` if the agent's navigation has finished. If the target is reacha .. rst-class:: classref-method -:ref:`bool` **is_target_reachable** **(** **)** +:ref:`bool` **is_target_reachable**\ (\ ) Returns ``true`` if :ref:`get_final_position` is within :ref:`target_desired_distance` of the :ref:`target_position`. @@ -843,7 +843,7 @@ Returns ``true`` if :ref:`get_final_position` **is_target_reached** **(** **)** |const| +:ref:`bool` **is_target_reached**\ (\ ) |const| Returns ``true`` if the agent reached the target, i.e. the agent moved within :ref:`target_desired_distance` of the :ref:`target_position`. It may not always be possible to reach the target but it should always be possible to reach the final position. See :ref:`get_final_position`. @@ -855,7 +855,7 @@ Returns ``true`` if the agent reached the target, i.e. the agent moved within :r .. rst-class:: classref-method -void **set_avoidance_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_avoidance_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`avoidance_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -867,7 +867,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`avoidan .. rst-class:: classref-method -void **set_avoidance_mask_value** **(** :ref:`int` mask_number, :ref:`bool` value **)** +|void| **set_avoidance_mask_value**\ (\ mask_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified mask in the :ref:`avoidance_mask` bitmask, given a ``mask_number`` between 1 and 32. @@ -879,7 +879,7 @@ Based on ``value``, enables or disables the specified mask in the :ref:`avoidanc .. rst-class:: classref-method -void **set_navigation_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`navigation_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -891,7 +891,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`navigat .. rst-class:: classref-method -void **set_navigation_map** **(** :ref:`RID` navigation_map **)** +|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) Sets the :ref:`RID` of the navigation map this NavigationAgent node should use and also updates the ``agent`` on the NavigationServer. @@ -903,7 +903,7 @@ Sets the :ref:`RID` of the navigation map this NavigationAgent node s .. rst-class:: classref-method -void **set_velocity_forced** **(** :ref:`Vector2` velocity **)** +|void| **set_velocity_forced**\ (\ velocity\: :ref:`Vector2`\ ) Replaces the internal velocity in the collision avoidance simulation with ``velocity``. When an agent is teleported to a new position this function should be used in the same frame. If called frequently this function can get agents stuck. @@ -914,3 +914,4 @@ Replaces the internal velocity in the collision avoidance simulation with ``velo .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationagent3d.rst b/classes/class_navigationagent3d.rst index ae015227826..af143b280e8 100644 --- a/classes/class_navigationagent3d.rst +++ b/classes/class_navigationagent3d.rst @@ -77,7 +77,7 @@ Properties +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`path_max_distance` | ``5.0`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ - | |bitfield|\<:ref:`PathMetadataFlags`\> | :ref:`path_metadata_flags` | ``7`` | + | |bitfield|\[:ref:`PathMetadataFlags`\] | :ref:`path_metadata_flags` | ``7`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`PathPostProcessing` | :ref:`path_postprocessing` | ``0`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------+ @@ -106,45 +106,45 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`distance_to_target` **(** **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_avoidance_layer_value` **(** :ref:`int` layer_number **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_avoidance_mask_value` **(** :ref:`int` mask_number **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`get_current_navigation_path` **(** **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_current_navigation_path_index` **(** **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NavigationPathQueryResult3D` | :ref:`get_current_navigation_result` **(** **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_final_position` **(** **)** | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_navigation_layer_value` **(** :ref:`int` layer_number **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_navigation_map` **(** **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_next_path_position` **(** **)** | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_navigation_finished` **(** **)** | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_target_reachable` **(** **)** | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_target_reached` **(** **)** |const| | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_avoidance_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_avoidance_mask_value` **(** :ref:`int` mask_number, :ref:`bool` value **)** | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_navigation_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_navigation_map` **(** :ref:`RID` navigation_map **)** | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_velocity_forced` **(** :ref:`Vector3` velocity **)** | - +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`distance_to_target`\ (\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_avoidance_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_avoidance_mask_value`\ (\ mask_number\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`get_current_navigation_path`\ (\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_current_navigation_path_index`\ (\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NavigationPathQueryResult3D` | :ref:`get_current_navigation_result`\ (\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_final_position`\ (\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_navigation_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_navigation_map`\ (\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_next_path_position`\ (\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_navigation_finished`\ (\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_target_reachable`\ (\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_target_reached`\ (\ ) |const| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_avoidance_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_avoidance_mask_value`\ (\ mask_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_navigation_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_navigation_map`\ (\ navigation_map\: :ref:`RID`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_velocity_forced`\ (\ velocity\: :ref:`Vector3`\ ) | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -159,7 +159,7 @@ Signals .. rst-class:: classref-signal -**link_reached** **(** :ref:`Dictionary` details **)** +**link_reached**\ (\ details\: :ref:`Dictionary`\ ) Signals that the agent reached a navigation link. Emitted when the agent moves within :ref:`path_desired_distance` of the next position of the path when that position is a navigation link. @@ -185,7 +185,7 @@ The details dictionary may contain the following keys depending on the value of .. rst-class:: classref-signal -**navigation_finished** **(** **)** +**navigation_finished**\ (\ ) Signals that the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached. This signal is emitted only once per loaded path. @@ -199,7 +199,7 @@ This signal will be emitted just after :ref:`target_reached` of the :ref:`target_position`. This signal is emitted only once per loaded path. @@ -233,7 +233,7 @@ It may not always be possible to reach the target but it should always be possib .. rst-class:: classref-signal -**velocity_computed** **(** :ref:`Vector3` safe_velocity **)** +**velocity_computed**\ (\ safe_velocity\: :ref:`Vector3`\ ) Notifies when the collision avoidance velocity is calculated. Emitted when :ref:`velocity` is set. Only emitted when :ref:`avoidance_enabled` is true. @@ -245,7 +245,7 @@ Notifies when the collision avoidance velocity is calculated. Emitted when :ref: .. rst-class:: classref-signal -**waypoint_reached** **(** :ref:`Dictionary` details **)** +**waypoint_reached**\ (\ details\: :ref:`Dictionary`\ ) Signals that the agent reached a waypoint. Emitted when the agent moves within :ref:`path_desired_distance` of the next position of the path. @@ -276,8 +276,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_avoidance_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **get_avoidance_enabled** **(** **)** +- |void| **set_avoidance_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_avoidance_enabled**\ (\ ) If ``true`` the agent is registered for an RVO avoidance callback on the :ref:`NavigationServer3D`. When :ref:`velocity` is set and the processing is completed a ``safe_velocity`` Vector3 is received with a signal connection to :ref:`velocity_computed`. Avoidance processing with many registered agents has a significant performance cost and should only be enabled on agents that currently require it. @@ -293,8 +293,8 @@ If ``true`` the agent is registered for an RVO avoidance callback on the :ref:`N .. rst-class:: classref-property-setget -- void **set_avoidance_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_avoidance_layers** **(** **)** +- |void| **set_avoidance_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_avoidance_layers**\ (\ ) A bitfield determining the avoidance layers for this NavigationAgent. Other agents with a matching bit on the :ref:`avoidance_mask` will avoid this agent. @@ -310,8 +310,8 @@ A bitfield determining the avoidance layers for this NavigationAgent. Other agen .. rst-class:: classref-property-setget -- void **set_avoidance_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_avoidance_mask** **(** **)** +- |void| **set_avoidance_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_avoidance_mask**\ (\ ) A bitfield determining what other avoidance agents and obstacles this NavigationAgent will avoid when a bit matches at least one of their :ref:`avoidance_layers`. @@ -327,8 +327,8 @@ A bitfield determining what other avoidance agents and obstacles this Navigation .. rst-class:: classref-property-setget -- void **set_avoidance_priority** **(** :ref:`float` value **)** -- :ref:`float` **get_avoidance_priority** **(** **)** +- |void| **set_avoidance_priority**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_avoidance_priority**\ (\ ) The agent does not adjust the velocity for other agents that would match the :ref:`avoidance_mask` but have a lower :ref:`avoidance_priority`. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent. @@ -344,8 +344,8 @@ The agent does not adjust the velocity for other agents that would match the :re .. rst-class:: classref-property-setget -- void **set_debug_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **get_debug_enabled** **(** **)** +- |void| **set_debug_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_debug_enabled**\ (\ ) If ``true`` shows debug visuals for this agent. @@ -361,8 +361,8 @@ If ``true`` shows debug visuals for this agent. .. rst-class:: classref-property-setget -- void **set_debug_path_custom_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_debug_path_custom_color** **(** **)** +- |void| **set_debug_path_custom_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_debug_path_custom_color**\ (\ ) If :ref:`debug_use_custom` is ``true`` uses this color for this agent instead of global color. @@ -378,8 +378,8 @@ If :ref:`debug_use_custom` is .. rst-class:: classref-property-setget -- void **set_debug_path_custom_point_size** **(** :ref:`float` value **)** -- :ref:`float` **get_debug_path_custom_point_size** **(** **)** +- |void| **set_debug_path_custom_point_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_debug_path_custom_point_size**\ (\ ) If :ref:`debug_use_custom` is ``true`` uses this rasterized point size for rendering path points for this agent instead of global point size. @@ -395,8 +395,8 @@ If :ref:`debug_use_custom` is .. rst-class:: classref-property-setget -- void **set_debug_use_custom** **(** :ref:`bool` value **)** -- :ref:`bool` **get_debug_use_custom** **(** **)** +- |void| **set_debug_use_custom**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_debug_use_custom**\ (\ ) If ``true`` uses the defined :ref:`debug_path_custom_color` for this agent instead of global color. @@ -412,8 +412,8 @@ If ``true`` uses the defined :ref:`debug_path_custom_color` value **)** -- :ref:`float` **get_height** **(** **)** +- |void| **set_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_height**\ (\ ) The height of the avoidance agent. Agents will ignore other agents or obstacles that are above or below their current position + height in 2D avoidance. Does nothing in 3D avoidance which uses radius spheres alone. @@ -429,8 +429,8 @@ The height of the avoidance agent. Agents will ignore other agents or obstacles .. rst-class:: classref-property-setget -- void **set_keep_y_velocity** **(** :ref:`bool` value **)** -- :ref:`bool` **get_keep_y_velocity** **(** **)** +- |void| **set_keep_y_velocity**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_keep_y_velocity**\ (\ ) If ``true``, and the agent uses 2D avoidance, it will remember the set y-axis velocity and reapply it after the avoidance step. While 2D avoidance has no y-axis and simulates on a flat plane this setting can help mitigate the most obvious clipping on uneven 3D geometry. @@ -446,8 +446,8 @@ If ``true``, and the agent uses 2D avoidance, it will remember the set y-axis ve .. rst-class:: classref-property-setget -- void **set_max_neighbors** **(** :ref:`int` value **)** -- :ref:`int` **get_max_neighbors** **(** **)** +- |void| **set_max_neighbors**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_neighbors**\ (\ ) The maximum number of neighbors for the agent to consider. @@ -463,8 +463,8 @@ The maximum number of neighbors for the agent to consider. .. rst-class:: classref-property-setget -- void **set_max_speed** **(** :ref:`float` value **)** -- :ref:`float` **get_max_speed** **(** **)** +- |void| **set_max_speed**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_max_speed**\ (\ ) The maximum speed that an agent can move. @@ -480,8 +480,8 @@ The maximum speed that an agent can move. .. rst-class:: classref-property-setget -- void **set_navigation_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_navigation_layers** **(** **)** +- |void| **set_navigation_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_navigation_layers**\ (\ ) A bitfield determining which navigation layers of navigation regions this agent will use to calculate a path. Changing it during runtime will clear the current navigation path and generate a new one, according to the new navigation layers. @@ -497,8 +497,8 @@ A bitfield determining which navigation layers of navigation regions this agent .. rst-class:: classref-property-setget -- void **set_neighbor_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_neighbor_distance** **(** **)** +- |void| **set_neighbor_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_neighbor_distance**\ (\ ) The distance to search for other agents. @@ -514,8 +514,8 @@ The distance to search for other agents. .. rst-class:: classref-property-setget -- void **set_path_desired_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_path_desired_distance** **(** **)** +- |void| **set_path_desired_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_desired_distance**\ (\ ) The distance threshold before a path point is considered to be reached. This allows agents to not have to hit a path point on the path exactly, but only to reach its general area. If this value is set too high, the NavigationAgent will skip points on the path, which can lead to it leaving the navigation mesh. If this value is set too low, the NavigationAgent will be stuck in a repath loop because it will constantly overshoot the distance to the next point on each physics frame update. @@ -531,8 +531,8 @@ The distance threshold before a path point is considered to be reached. This all .. rst-class:: classref-property-setget -- void **set_path_height_offset** **(** :ref:`float` value **)** -- :ref:`float` **get_path_height_offset** **(** **)** +- |void| **set_path_height_offset**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_height_offset**\ (\ ) The height offset is subtracted from the y-axis value of any vector path position for this NavigationAgent. The NavigationAgent height offset does not change or influence the navigation mesh or pathfinding query result. Additional navigation maps that use regions with navigation meshes that the developer baked with appropriate agent radius or height values are required to support different-sized agents. @@ -548,8 +548,8 @@ The height offset is subtracted from the y-axis value of any vector path positio .. rst-class:: classref-property-setget -- void **set_path_max_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_path_max_distance** **(** **)** +- |void| **set_path_max_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_path_max_distance**\ (\ ) The maximum distance the agent is allowed away from the ideal path to the final position. This can happen due to trying to avoid collisions. When the maximum distance is exceeded, it recalculates the ideal path. @@ -561,12 +561,12 @@ The maximum distance the agent is allowed away from the ideal path to the final .. rst-class:: classref-property -|bitfield|\<:ref:`PathMetadataFlags`\> **path_metadata_flags** = ``7`` +|bitfield|\[:ref:`PathMetadataFlags`\] **path_metadata_flags** = ``7`` .. rst-class:: classref-property-setget -- void **set_path_metadata_flags** **(** |bitfield|\<:ref:`PathMetadataFlags`\> value **)** -- |bitfield|\<:ref:`PathMetadataFlags`\> **get_path_metadata_flags** **(** **)** +- |void| **set_path_metadata_flags**\ (\ value\: |bitfield|\[:ref:`PathMetadataFlags`\]\ ) +- |bitfield|\[:ref:`PathMetadataFlags`\] **get_path_metadata_flags**\ (\ ) Additional information to return with the navigation path. @@ -582,8 +582,8 @@ Additional information to return with the navigation path. .. rst-class:: classref-property-setget -- void **set_path_postprocessing** **(** :ref:`PathPostProcessing` value **)** -- :ref:`PathPostProcessing` **get_path_postprocessing** **(** **)** +- |void| **set_path_postprocessing**\ (\ value\: :ref:`PathPostProcessing`\ ) +- :ref:`PathPostProcessing` **get_path_postprocessing**\ (\ ) The path postprocessing applied to the raw path corridor found by the :ref:`pathfinding_algorithm`. @@ -599,8 +599,8 @@ The path postprocessing applied to the raw path corridor found by the :ref:`path .. rst-class:: classref-property-setget -- void **set_pathfinding_algorithm** **(** :ref:`PathfindingAlgorithm` value **)** -- :ref:`PathfindingAlgorithm` **get_pathfinding_algorithm** **(** **)** +- |void| **set_pathfinding_algorithm**\ (\ value\: :ref:`PathfindingAlgorithm`\ ) +- :ref:`PathfindingAlgorithm` **get_pathfinding_algorithm**\ (\ ) The pathfinding algorithm used in the path query. @@ -616,8 +616,8 @@ The pathfinding algorithm used in the path query. .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) The radius of the avoidance agent. This is the "body" of the avoidance agent and not the avoidance maneuver starting radius (which is controlled by :ref:`neighbor_distance`). @@ -635,8 +635,8 @@ Does not affect normal pathfinding. To change an actor's pathfinding radius bake .. rst-class:: classref-property-setget -- void **set_target_desired_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_target_desired_distance** **(** **)** +- |void| **set_target_desired_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_target_desired_distance**\ (\ ) The distance threshold before the target is considered to be reached. On reaching the target, :ref:`target_reached` is emitted and navigation ends (see :ref:`is_navigation_finished` and :ref:`navigation_finished`). @@ -656,8 +656,8 @@ You can also make navigation end closer to the target than each individual path .. rst-class:: classref-property-setget -- void **set_target_position** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_target_position** **(** **)** +- |void| **set_target_position**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_target_position**\ (\ ) If set, a new navigation path from the current agent position to the :ref:`target_position` is requested from the NavigationServer. @@ -673,8 +673,8 @@ If set, a new navigation path from the current agent position to the :ref:`targe .. rst-class:: classref-property-setget -- void **set_time_horizon_agents** **(** :ref:`float` value **)** -- :ref:`float` **get_time_horizon_agents** **(** **)** +- |void| **set_time_horizon_agents**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_time_horizon_agents**\ (\ ) The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithm, are safe with respect to other agents. The larger the number, the sooner the agent will respond to other agents, but less freedom in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. @@ -690,8 +690,8 @@ The minimal amount of time for which this agent's velocities, that are computed .. rst-class:: classref-property-setget -- void **set_time_horizon_obstacles** **(** :ref:`float` value **)** -- :ref:`float` **get_time_horizon_obstacles** **(** **)** +- |void| **set_time_horizon_obstacles**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_time_horizon_obstacles**\ (\ ) The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithm, are safe with respect to static avoidance obstacles. The larger the number, the sooner the agent will respond to static avoidance obstacles, but less freedom in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. @@ -707,8 +707,8 @@ The minimal amount of time for which this agent's velocities, that are computed .. rst-class:: classref-property-setget -- void **set_use_3d_avoidance** **(** :ref:`bool` value **)** -- :ref:`bool` **get_use_3d_avoidance** **(** **)** +- |void| **set_use_3d_avoidance**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_3d_avoidance**\ (\ ) If ``true``, the agent calculates avoidance velocities in 3D omnidirectionally, e.g. for games that take place in air, underwater or space. Agents using 3D avoidance only avoid other agents using 3D avoidance, and react to radius-based avoidance obstacles. They ignore any vertex-based obstacles. @@ -726,8 +726,8 @@ If ``false``, the agent calculates avoidance velocities in 2D along the x and z- .. rst-class:: classref-property-setget -- void **set_velocity** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_velocity** **(** **)** +- |void| **set_velocity**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_velocity**\ (\ ) Sets the new wanted velocity for the agent. The avoidance simulation will try to fulfill this velocity if possible but will modify it to avoid collision with other agents and obstacles. When an agent is teleported to a new position, use :ref:`set_velocity_forced` as well to reset the internal simulation velocity. @@ -744,7 +744,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **distance_to_target** **(** **)** |const| +:ref:`float` **distance_to_target**\ (\ ) |const| Returns the distance to the target position, using the agent's global position. The user must set :ref:`target_position` in order for this to be accurate. @@ -756,7 +756,7 @@ Returns the distance to the target position, using the agent's global position. .. rst-class:: classref-method -:ref:`bool` **get_avoidance_layer_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_avoidance_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`avoidance_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -768,7 +768,7 @@ Returns whether or not the specified layer of the :ref:`avoidance_layers` **get_avoidance_mask_value** **(** :ref:`int` mask_number **)** |const| +:ref:`bool` **get_avoidance_mask_value**\ (\ mask_number\: :ref:`int`\ ) |const| Returns whether or not the specified mask of the :ref:`avoidance_mask` bitmask is enabled, given a ``mask_number`` between 1 and 32. @@ -780,7 +780,7 @@ Returns whether or not the specified mask of the :ref:`avoidance_mask` **get_current_navigation_path** **(** **)** |const| +:ref:`PackedVector3Array` **get_current_navigation_path**\ (\ ) |const| Returns this agent's current path from start to finish in global coordinates. The path only updates when the target position is changed or the agent requires a repath. The path array is not intended to be used in direct path movement as the agent has its own internal path logic that would get corrupted by changing the path array manually. Use the intended :ref:`get_next_path_position` once every physics frame to receive the next path point for the agents movement as this function also updates the internal path logic. @@ -792,7 +792,7 @@ Returns this agent's current path from start to finish in global coordinates. Th .. rst-class:: classref-method -:ref:`int` **get_current_navigation_path_index** **(** **)** |const| +:ref:`int` **get_current_navigation_path_index**\ (\ ) |const| Returns which index the agent is currently on in the navigation path's :ref:`PackedVector3Array`. @@ -804,7 +804,7 @@ Returns which index the agent is currently on in the navigation path's :ref:`Pac .. rst-class:: classref-method -:ref:`NavigationPathQueryResult3D` **get_current_navigation_result** **(** **)** |const| +:ref:`NavigationPathQueryResult3D` **get_current_navigation_result**\ (\ ) |const| Returns the path query result for the path the agent is currently following. @@ -816,7 +816,7 @@ Returns the path query result for the path the agent is currently following. .. rst-class:: classref-method -:ref:`Vector3` **get_final_position** **(** **)** +:ref:`Vector3` **get_final_position**\ (\ ) Returns the reachable final position of the current navigation path in global coordinates. This position can change if the agent needs to update the navigation path which makes the agent emit the :ref:`path_changed` signal. @@ -828,7 +828,7 @@ Returns the reachable final position of the current navigation path in global co .. rst-class:: classref-method -:ref:`bool` **get_navigation_layer_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`navigation_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -840,7 +840,7 @@ Returns whether or not the specified layer of the :ref:`navigation_layers` **get_navigation_map** **(** **)** |const| +:ref:`RID` **get_navigation_map**\ (\ ) |const| Returns the :ref:`RID` of the navigation map for this NavigationAgent node. This function returns always the map set on the NavigationAgent node and not the map of the abstract agent on the NavigationServer. If the agent map is changed directly with the NavigationServer API the NavigationAgent node will not be aware of the map change. Use :ref:`set_navigation_map` to change the navigation map for the NavigationAgent and also update the agent on the NavigationServer. @@ -852,7 +852,7 @@ Returns the :ref:`RID` of the navigation map for this NavigationAgent .. rst-class:: classref-method -:ref:`Vector3` **get_next_path_position** **(** **)** +:ref:`Vector3` **get_next_path_position**\ (\ ) Returns the next position in global coordinates that can be moved to, making sure that there are no static objects in the way. If the agent does not have a navigation path, it will return the position of the agent's parent. The use of this function once every physics frame is required to update the internal path logic of the NavigationAgent. @@ -864,7 +864,7 @@ Returns the next position in global coordinates that can be moved to, making sur .. rst-class:: classref-method -:ref:`RID` **get_rid** **(** **)** |const| +:ref:`RID` **get_rid**\ (\ ) |const| Returns the :ref:`RID` of this agent on the :ref:`NavigationServer3D`. @@ -876,7 +876,7 @@ Returns the :ref:`RID` of this agent on the :ref:`NavigationServer3D< .. rst-class:: classref-method -:ref:`bool` **is_navigation_finished** **(** **)** +:ref:`bool` **is_navigation_finished**\ (\ ) Returns ``true`` if the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached. @@ -890,7 +890,7 @@ Returns ``true`` if the agent's navigation has finished. If the target is reacha .. rst-class:: classref-method -:ref:`bool` **is_target_reachable** **(** **)** +:ref:`bool` **is_target_reachable**\ (\ ) Returns ``true`` if :ref:`get_final_position` is within :ref:`target_desired_distance` of the :ref:`target_position`. @@ -902,7 +902,7 @@ Returns ``true`` if :ref:`get_final_position` **is_target_reached** **(** **)** |const| +:ref:`bool` **is_target_reached**\ (\ ) |const| Returns ``true`` if the agent reached the target, i.e. the agent moved within :ref:`target_desired_distance` of the :ref:`target_position`. It may not always be possible to reach the target but it should always be possible to reach the final position. See :ref:`get_final_position`. @@ -914,7 +914,7 @@ Returns ``true`` if the agent reached the target, i.e. the agent moved within :r .. rst-class:: classref-method -void **set_avoidance_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_avoidance_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`avoidance_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -926,7 +926,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`avoidan .. rst-class:: classref-method -void **set_avoidance_mask_value** **(** :ref:`int` mask_number, :ref:`bool` value **)** +|void| **set_avoidance_mask_value**\ (\ mask_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified mask in the :ref:`avoidance_mask` bitmask, given a ``mask_number`` between 1 and 32. @@ -938,7 +938,7 @@ Based on ``value``, enables or disables the specified mask in the :ref:`avoidanc .. rst-class:: classref-method -void **set_navigation_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`navigation_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -950,7 +950,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`navigat .. rst-class:: classref-method -void **set_navigation_map** **(** :ref:`RID` navigation_map **)** +|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) Sets the :ref:`RID` of the navigation map this NavigationAgent node should use and also updates the ``agent`` on the NavigationServer. @@ -962,7 +962,7 @@ Sets the :ref:`RID` of the navigation map this NavigationAgent node s .. rst-class:: classref-method -void **set_velocity_forced** **(** :ref:`Vector3` velocity **)** +|void| **set_velocity_forced**\ (\ velocity\: :ref:`Vector3`\ ) Replaces the internal velocity in the collision avoidance simulation with ``velocity``. When an agent is teleported to a new position this function should be used in the same frame. If called frequently this function can get agents stuck. @@ -973,3 +973,4 @@ Replaces the internal velocity in the collision avoidance simulation with ``velo .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationlink2d.rst b/classes/class_navigationlink2d.rst index 8c179203e11..e397668b55a 100644 --- a/classes/class_navigationlink2d.rst +++ b/classes/class_navigationlink2d.rst @@ -62,21 +62,21 @@ Methods .. table:: :widths: auto - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_global_end_position` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_global_start_position` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_navigation_layer_value` **(** :ref:`int` layer_number **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_global_end_position` **(** :ref:`Vector2` position **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_global_start_position` **(** :ref:`Vector2` position **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_navigation_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_global_end_position`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_global_start_position`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_navigation_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_global_end_position`\ (\ position\: :ref:`Vector2`\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_global_start_position`\ (\ position\: :ref:`Vector2`\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_navigation_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -95,8 +95,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bidirectional** **(** :ref:`bool` value **)** -- :ref:`bool` **is_bidirectional** **(** **)** +- |void| **set_bidirectional**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_bidirectional**\ (\ ) Whether this link can be traveled in both directions or only from :ref:`start_position` to :ref:`end_position`. @@ -112,8 +112,8 @@ Whether this link can be traveled in both directions or only from :ref:`start_po .. rst-class:: classref-property-setget -- void **set_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_enabled** **(** **)** +- |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_enabled**\ (\ ) Whether this link is currently active. If ``false``, :ref:`NavigationServer2D.map_get_path` will ignore this link. @@ -129,8 +129,8 @@ Whether this link is currently active. If ``false``, :ref:`NavigationServer2D.ma .. rst-class:: classref-property-setget -- void **set_end_position** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_end_position** **(** **)** +- |void| **set_end_position**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_end_position**\ (\ ) Ending position of the link. @@ -150,8 +150,8 @@ The distance the link will search is controlled by :ref:`NavigationServer2D.map_ .. rst-class:: classref-property-setget -- void **set_enter_cost** **(** :ref:`float` value **)** -- :ref:`float` **get_enter_cost** **(** **)** +- |void| **set_enter_cost**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_enter_cost**\ (\ ) When pathfinding enters this link from another regions navigation mesh the :ref:`enter_cost` value is added to the path distance for determining the shortest path. @@ -167,8 +167,8 @@ When pathfinding enters this link from another regions navigation mesh the :ref: .. rst-class:: classref-property-setget -- void **set_navigation_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_navigation_layers** **(** **)** +- |void| **set_navigation_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_navigation_layers**\ (\ ) A bitfield determining all navigation layers the link belongs to. These navigation layers will be checked when requesting a path with :ref:`NavigationServer2D.map_get_path`. @@ -184,8 +184,8 @@ A bitfield determining all navigation layers the link belongs to. These navigati .. rst-class:: classref-property-setget -- void **set_start_position** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_start_position** **(** **)** +- |void| **set_start_position**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_start_position**\ (\ ) Starting position of the link. @@ -205,8 +205,8 @@ The distance the link will search is controlled by :ref:`NavigationServer2D.map_ .. rst-class:: classref-property-setget -- void **set_travel_cost** **(** :ref:`float` value **)** -- :ref:`float` **get_travel_cost** **(** **)** +- |void| **set_travel_cost**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_travel_cost**\ (\ ) When pathfinding moves along the link the traveled distance is multiplied with :ref:`travel_cost` for determining the shortest path. @@ -223,7 +223,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector2` **get_global_end_position** **(** **)** |const| +:ref:`Vector2` **get_global_end_position**\ (\ ) |const| Returns the :ref:`end_position` that is relative to the link as a global position. @@ -235,7 +235,7 @@ Returns the :ref:`end_position` th .. rst-class:: classref-method -:ref:`Vector2` **get_global_start_position** **(** **)** |const| +:ref:`Vector2` **get_global_start_position**\ (\ ) |const| Returns the :ref:`start_position` that is relative to the link as a global position. @@ -247,7 +247,7 @@ Returns the :ref:`start_position .. rst-class:: classref-method -:ref:`bool` **get_navigation_layer_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`navigation_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -259,7 +259,7 @@ Returns whether or not the specified layer of the :ref:`navigation_layers` **get_rid** **(** **)** |const| +:ref:`RID` **get_rid**\ (\ ) |const| Returns the :ref:`RID` of this link on the :ref:`NavigationServer2D`. @@ -271,7 +271,7 @@ Returns the :ref:`RID` of this link on the :ref:`NavigationServer2D` position **)** +|void| **set_global_end_position**\ (\ position\: :ref:`Vector2`\ ) Sets the :ref:`end_position` that is relative to the link from a global ``position``. @@ -283,7 +283,7 @@ Sets the :ref:`end_position` that .. rst-class:: classref-method -void **set_global_start_position** **(** :ref:`Vector2` position **)** +|void| **set_global_start_position**\ (\ position\: :ref:`Vector2`\ ) Sets the :ref:`start_position` that is relative to the link from a global ``position``. @@ -295,7 +295,7 @@ Sets the :ref:`start_position` t .. rst-class:: classref-method -void **set_navigation_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`navigation_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -306,3 +306,4 @@ Based on ``value``, enables or disables the specified layer in the :ref:`navigat .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationlink3d.rst b/classes/class_navigationlink3d.rst index 224e4fa9744..2e8779d62e1 100644 --- a/classes/class_navigationlink3d.rst +++ b/classes/class_navigationlink3d.rst @@ -62,21 +62,21 @@ Methods .. table:: :widths: auto - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_global_end_position` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_global_start_position` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_navigation_layer_value` **(** :ref:`int` layer_number **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_global_end_position` **(** :ref:`Vector3` position **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_global_start_position` **(** :ref:`Vector3` position **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_navigation_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_global_end_position`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_global_start_position`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_navigation_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_global_end_position`\ (\ position\: :ref:`Vector3`\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_global_start_position`\ (\ position\: :ref:`Vector3`\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_navigation_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -95,8 +95,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bidirectional** **(** :ref:`bool` value **)** -- :ref:`bool` **is_bidirectional** **(** **)** +- |void| **set_bidirectional**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_bidirectional**\ (\ ) Whether this link can be traveled in both directions or only from :ref:`start_position` to :ref:`end_position`. @@ -112,8 +112,8 @@ Whether this link can be traveled in both directions or only from :ref:`start_po .. rst-class:: classref-property-setget -- void **set_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_enabled** **(** **)** +- |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_enabled**\ (\ ) Whether this link is currently active. If ``false``, :ref:`NavigationServer3D.map_get_path` will ignore this link. @@ -129,8 +129,8 @@ Whether this link is currently active. If ``false``, :ref:`NavigationServer3D.ma .. rst-class:: classref-property-setget -- void **set_end_position** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_end_position** **(** **)** +- |void| **set_end_position**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_end_position**\ (\ ) Ending position of the link. @@ -150,8 +150,8 @@ The distance the link will search is controlled by :ref:`NavigationServer3D.map_ .. rst-class:: classref-property-setget -- void **set_enter_cost** **(** :ref:`float` value **)** -- :ref:`float` **get_enter_cost** **(** **)** +- |void| **set_enter_cost**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_enter_cost**\ (\ ) When pathfinding enters this link from another regions navigation mesh the :ref:`enter_cost` value is added to the path distance for determining the shortest path. @@ -167,8 +167,8 @@ When pathfinding enters this link from another regions navigation mesh the :ref: .. rst-class:: classref-property-setget -- void **set_navigation_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_navigation_layers** **(** **)** +- |void| **set_navigation_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_navigation_layers**\ (\ ) A bitfield determining all navigation layers the link belongs to. These navigation layers will be checked when requesting a path with :ref:`NavigationServer3D.map_get_path`. @@ -184,8 +184,8 @@ A bitfield determining all navigation layers the link belongs to. These navigati .. rst-class:: classref-property-setget -- void **set_start_position** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_start_position** **(** **)** +- |void| **set_start_position**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_start_position**\ (\ ) Starting position of the link. @@ -205,8 +205,8 @@ The distance the link will search is controlled by :ref:`NavigationServer3D.map_ .. rst-class:: classref-property-setget -- void **set_travel_cost** **(** :ref:`float` value **)** -- :ref:`float` **get_travel_cost** **(** **)** +- |void| **set_travel_cost**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_travel_cost**\ (\ ) When pathfinding moves along the link the traveled distance is multiplied with :ref:`travel_cost` for determining the shortest path. @@ -223,7 +223,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **get_global_end_position** **(** **)** |const| +:ref:`Vector3` **get_global_end_position**\ (\ ) |const| Returns the :ref:`end_position` that is relative to the link as a global position. @@ -235,7 +235,7 @@ Returns the :ref:`end_position` th .. rst-class:: classref-method -:ref:`Vector3` **get_global_start_position** **(** **)** |const| +:ref:`Vector3` **get_global_start_position**\ (\ ) |const| Returns the :ref:`start_position` that is relative to the link as a global position. @@ -247,7 +247,7 @@ Returns the :ref:`start_position .. rst-class:: classref-method -:ref:`bool` **get_navigation_layer_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`navigation_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -259,7 +259,7 @@ Returns whether or not the specified layer of the :ref:`navigation_layers` **get_rid** **(** **)** |const| +:ref:`RID` **get_rid**\ (\ ) |const| Returns the :ref:`RID` of this link on the :ref:`NavigationServer3D`. @@ -271,7 +271,7 @@ Returns the :ref:`RID` of this link on the :ref:`NavigationServer3D` position **)** +|void| **set_global_end_position**\ (\ position\: :ref:`Vector3`\ ) Sets the :ref:`end_position` that is relative to the link from a global ``position``. @@ -283,7 +283,7 @@ Sets the :ref:`end_position` that .. rst-class:: classref-method -void **set_global_start_position** **(** :ref:`Vector3` position **)** +|void| **set_global_start_position**\ (\ position\: :ref:`Vector3`\ ) Sets the :ref:`start_position` that is relative to the link from a global ``position``. @@ -295,7 +295,7 @@ Sets the :ref:`start_position` t .. rst-class:: classref-method -void **set_navigation_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`navigation_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -306,3 +306,4 @@ Based on ``value``, enables or disables the specified layer in the :ref:`navigat .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index 76349c5ae0b..a41d735eefb 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -98,27 +98,27 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_polygon` **(** :ref:`PackedInt32Array` polygon **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_polygons` **(** **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_collision_mask_value` **(** :ref:`int` layer_number **)** |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_polygon` **(** :ref:`int` idx **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_polygon_count` **(** **)** |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`get_vertices` **(** **)** |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_vertices` **(** :ref:`PackedVector3Array` vertices **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_polygon`\ (\ polygon\: :ref:`PackedInt32Array`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_polygons`\ (\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_from_mesh`\ (\ mesh\: :ref:`Mesh`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_collision_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_polygon`\ (\ idx\: :ref:`int`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_polygon_count`\ (\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`get_vertices`\ (\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_vertices`\ (\ vertices\: :ref:`PackedVector3Array`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -268,8 +268,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_agent_height** **(** :ref:`float` value **)** -- :ref:`float` **get_agent_height** **(** **)** +- |void| **set_agent_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_agent_height**\ (\ ) The minimum floor to ceiling height that will still allow the floor area to be considered walkable. @@ -287,8 +287,8 @@ The minimum floor to ceiling height that will still allow the floor area to be c .. rst-class:: classref-property-setget -- void **set_agent_max_climb** **(** :ref:`float` value **)** -- :ref:`float` **get_agent_max_climb** **(** **)** +- |void| **set_agent_max_climb**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_agent_max_climb**\ (\ ) The minimum ledge height that is considered to still be traversable. @@ -306,8 +306,8 @@ The minimum ledge height that is considered to still be traversable. .. rst-class:: classref-property-setget -- void **set_agent_max_slope** **(** :ref:`float` value **)** -- :ref:`float` **get_agent_max_slope** **(** **)** +- |void| **set_agent_max_slope**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_agent_max_slope**\ (\ ) The maximum slope that is considered walkable, in degrees. @@ -323,8 +323,8 @@ The maximum slope that is considered walkable, in degrees. .. rst-class:: classref-property-setget -- void **set_agent_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_agent_radius** **(** **)** +- |void| **set_agent_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_agent_radius**\ (\ ) The distance to erode/shrink the walkable area of the heightfield away from obstructions. @@ -342,8 +342,8 @@ The distance to erode/shrink the walkable area of the heightfield away from obst .. rst-class:: classref-property-setget -- void **set_border_size** **(** :ref:`float` value **)** -- :ref:`float` **get_border_size** **(** **)** +- |void| **set_border_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_border_size**\ (\ ) The size of the non-navigable border around the bake bounding area. @@ -363,8 +363,8 @@ In conjunction with the :ref:`filter_baking_aabb` value **)** -- :ref:`float` **get_cell_height** **(** **)** +- |void| **set_cell_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_cell_height**\ (\ ) The cell height used to rasterize the navigation mesh vertices on the Y axis. Must match with the cell height on the navigation map. @@ -380,8 +380,8 @@ The cell height used to rasterize the navigation mesh vertices on the Y axis. Mu .. rst-class:: classref-property-setget -- void **set_cell_size** **(** :ref:`float` value **)** -- :ref:`float` **get_cell_size** **(** **)** +- |void| **set_cell_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_cell_size**\ (\ ) The cell size used to rasterize the navigation mesh vertices on the XZ plane. Must match with the cell size on the navigation map. @@ -397,8 +397,8 @@ The cell size used to rasterize the navigation mesh vertices on the XZ plane. Mu .. rst-class:: classref-property-setget -- void **set_detail_sample_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_detail_sample_distance** **(** **)** +- |void| **set_detail_sample_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_detail_sample_distance**\ (\ ) The sampling distance to use when generating the detail mesh, in cell unit. @@ -414,8 +414,8 @@ The sampling distance to use when generating the detail mesh, in cell unit. .. rst-class:: classref-property-setget -- void **set_detail_sample_max_error** **(** :ref:`float` value **)** -- :ref:`float` **get_detail_sample_max_error** **(** **)** +- |void| **set_detail_sample_max_error**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_detail_sample_max_error**\ (\ ) The maximum distance the detail mesh surface should deviate from heightfield, in cell unit. @@ -431,8 +431,8 @@ The maximum distance the detail mesh surface should deviate from heightfield, in .. rst-class:: classref-property-setget -- void **set_edge_max_error** **(** :ref:`float` value **)** -- :ref:`float` **get_edge_max_error** **(** **)** +- |void| **set_edge_max_error**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_edge_max_error**\ (\ ) The maximum distance a simplified contour's border edges should deviate the original raw contour. @@ -448,8 +448,8 @@ The maximum distance a simplified contour's border edges should deviate the orig .. rst-class:: classref-property-setget -- void **set_edge_max_length** **(** :ref:`float` value **)** -- :ref:`float` **get_edge_max_length** **(** **)** +- |void| **set_edge_max_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_edge_max_length**\ (\ ) The maximum allowed length for contour edges along the border of the mesh. A value of ``0.0`` disables this feature. @@ -467,8 +467,8 @@ The maximum allowed length for contour edges along the border of the mesh. A val .. rst-class:: classref-property-setget -- void **set_filter_baking_aabb** **(** :ref:`AABB` value **)** -- :ref:`AABB` **get_filter_baking_aabb** **(** **)** +- |void| **set_filter_baking_aabb**\ (\ value\: :ref:`AABB`\ ) +- :ref:`AABB` **get_filter_baking_aabb**\ (\ ) If the baking :ref:`AABB` has a volume the navigation mesh baking will be restricted to its enclosing area. @@ -484,8 +484,8 @@ If the baking :ref:`AABB` has a volume the navigation mesh baking wi .. rst-class:: classref-property-setget -- void **set_filter_baking_aabb_offset** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_filter_baking_aabb_offset** **(** **)** +- |void| **set_filter_baking_aabb_offset**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_filter_baking_aabb_offset**\ (\ ) The position offset applied to the :ref:`filter_baking_aabb` :ref:`AABB`. @@ -501,8 +501,8 @@ The position offset applied to the :ref:`filter_baking_aabb` value **)** -- :ref:`bool` **get_filter_ledge_spans** **(** **)** +- |void| **set_filter_ledge_spans**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_filter_ledge_spans**\ (\ ) If ``true``, marks spans that are ledges as non-walkable. @@ -518,8 +518,8 @@ If ``true``, marks spans that are ledges as non-walkable. .. rst-class:: classref-property-setget -- void **set_filter_low_hanging_obstacles** **(** :ref:`bool` value **)** -- :ref:`bool` **get_filter_low_hanging_obstacles** **(** **)** +- |void| **set_filter_low_hanging_obstacles**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_filter_low_hanging_obstacles**\ (\ ) If ``true``, marks non-walkable spans as walkable if their maximum is within :ref:`agent_max_climb` of a walkable neighbor. @@ -535,8 +535,8 @@ If ``true``, marks non-walkable spans as walkable if their maximum is within :re .. rst-class:: classref-property-setget -- void **set_filter_walkable_low_height_spans** **(** :ref:`bool` value **)** -- :ref:`bool` **get_filter_walkable_low_height_spans** **(** **)** +- |void| **set_filter_walkable_low_height_spans**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_filter_walkable_low_height_spans**\ (\ ) If ``true``, marks walkable spans as not walkable if the clearance above the span is less than :ref:`agent_height`. @@ -552,8 +552,8 @@ If ``true``, marks walkable spans as not walkable if the clearance above the spa .. rst-class:: classref-property-setget -- void **set_collision_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_mask** **(** **)** +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) The physics layers to scan for static colliders. @@ -571,8 +571,8 @@ Only used when :ref:`geometry_parsed_geometry_type` value **)** -- :ref:`ParsedGeometryType` **get_parsed_geometry_type** **(** **)** +- |void| **set_parsed_geometry_type**\ (\ value\: :ref:`ParsedGeometryType`\ ) +- :ref:`ParsedGeometryType` **get_parsed_geometry_type**\ (\ ) Determines which type of nodes will be parsed as geometry. See :ref:`ParsedGeometryType` for possible values. @@ -588,8 +588,8 @@ Determines which type of nodes will be parsed as geometry. See :ref:`ParsedGeome .. rst-class:: classref-property-setget -- void **set_source_geometry_mode** **(** :ref:`SourceGeometryMode` value **)** -- :ref:`SourceGeometryMode` **get_source_geometry_mode** **(** **)** +- |void| **set_source_geometry_mode**\ (\ value\: :ref:`SourceGeometryMode`\ ) +- :ref:`SourceGeometryMode` **get_source_geometry_mode**\ (\ ) The source of the geometry used when baking. See :ref:`SourceGeometryMode` for possible values. @@ -605,8 +605,8 @@ The source of the geometry used when baking. See :ref:`SourceGeometryMode` value **)** -- :ref:`StringName` **get_source_group_name** **(** **)** +- |void| **set_source_group_name**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_source_group_name**\ (\ ) The name of the group to scan for geometry. @@ -624,8 +624,8 @@ Only used when :ref:`geometry_source_geometry_mode` value **)** -- :ref:`float` **get_region_merge_size** **(** **)** +- |void| **set_region_merge_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_region_merge_size**\ (\ ) Any regions with a size smaller than this will be merged with larger regions if possible. @@ -643,8 +643,8 @@ Any regions with a size smaller than this will be merged with larger regions if .. rst-class:: classref-property-setget -- void **set_region_min_size** **(** :ref:`float` value **)** -- :ref:`float` **get_region_min_size** **(** **)** +- |void| **set_region_min_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_region_min_size**\ (\ ) The minimum size of a region for it to be created. @@ -662,8 +662,8 @@ The minimum size of a region for it to be created. .. rst-class:: classref-property-setget -- void **set_sample_partition_type** **(** :ref:`SamplePartitionType` value **)** -- :ref:`SamplePartitionType` **get_sample_partition_type** **(** **)** +- |void| **set_sample_partition_type**\ (\ value\: :ref:`SamplePartitionType`\ ) +- :ref:`SamplePartitionType` **get_sample_partition_type**\ (\ ) Partitioning algorithm for creating the navigation mesh polys. See :ref:`SamplePartitionType` for possible values. @@ -679,8 +679,8 @@ Partitioning algorithm for creating the navigation mesh polys. See :ref:`SampleP .. rst-class:: classref-property-setget -- void **set_vertices_per_polygon** **(** :ref:`float` value **)** -- :ref:`float` **get_vertices_per_polygon** **(** **)** +- |void| **set_vertices_per_polygon**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_vertices_per_polygon**\ (\ ) The maximum number of vertices allowed for polygons generated during the contour to polygon conversion process. @@ -697,7 +697,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_polygon** **(** :ref:`PackedInt32Array` polygon **)** +|void| **add_polygon**\ (\ polygon\: :ref:`PackedInt32Array`\ ) Adds a polygon using the indices of the vertices you get when calling :ref:`get_vertices`. @@ -709,7 +709,7 @@ Adds a polygon using the indices of the vertices you get when calling :ref:`get_ .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the internal arrays for vertices and polygon indices. @@ -721,7 +721,7 @@ Clears the internal arrays for vertices and polygon indices. .. rst-class:: classref-method -void **clear_polygons** **(** **)** +|void| **clear_polygons**\ (\ ) Clears the array of polygons, but it doesn't clear the array of vertices. @@ -733,7 +733,7 @@ Clears the array of polygons, but it doesn't clear the array of vertices. .. rst-class:: classref-method -void **create_from_mesh** **(** :ref:`Mesh` mesh **)** +|void| **create_from_mesh**\ (\ mesh\: :ref:`Mesh`\ ) Initializes the navigation mesh by setting the vertices and indices according to a :ref:`Mesh`. @@ -747,7 +747,7 @@ Initializes the navigation mesh by setting the vertices and indices according to .. rst-class:: classref-method -:ref:`bool` **get_collision_mask_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`geometry_collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -759,7 +759,7 @@ Returns whether or not the specified layer of the :ref:`geometry_collision_mask< .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_polygon** **(** :ref:`int` idx **)** +:ref:`PackedInt32Array` **get_polygon**\ (\ idx\: :ref:`int`\ ) Returns a :ref:`PackedInt32Array` containing the indices of the vertices of a created polygon. @@ -771,7 +771,7 @@ Returns a :ref:`PackedInt32Array` containing the indices .. rst-class:: classref-method -:ref:`int` **get_polygon_count** **(** **)** |const| +:ref:`int` **get_polygon_count**\ (\ ) |const| Returns the number of polygons in the navigation mesh. @@ -783,7 +783,7 @@ Returns the number of polygons in the navigation mesh. .. rst-class:: classref-method -:ref:`PackedVector3Array` **get_vertices** **(** **)** |const| +:ref:`PackedVector3Array` **get_vertices**\ (\ ) |const| Returns a :ref:`PackedVector3Array` containing all the vertices being used to create the polygons. @@ -795,7 +795,7 @@ Returns a :ref:`PackedVector3Array` containing all the .. rst-class:: classref-method -void **set_collision_mask_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`geometry_collision_mask`, given a ``layer_number`` between 1 and 32. @@ -807,7 +807,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`geometr .. rst-class:: classref-method -void **set_vertices** **(** :ref:`PackedVector3Array` vertices **)** +|void| **set_vertices**\ (\ vertices\: :ref:`PackedVector3Array`\ ) Sets the vertices that can be then indexed to create polygons with the :ref:`add_polygon` method. @@ -818,3 +818,4 @@ Sets the vertices that can be then indexed to create polygons with the :ref:`add .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationmeshgenerator.rst b/classes/class_navigationmeshgenerator.rst index bea38620bc8..839c007a9d4 100644 --- a/classes/class_navigationmeshgenerator.rst +++ b/classes/class_navigationmeshgenerator.rst @@ -46,15 +46,15 @@ Methods .. table:: :widths: auto - +------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`bake` **(** :ref:`NavigationMesh` navigation_mesh, :ref:`Node` root_node **)** | - +------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`bake_from_source_geometry_data` **(** :ref:`NavigationMesh` navigation_mesh, :ref:`NavigationMeshSourceGeometryData3D` source_geometry_data, :ref:`Callable` callback=Callable() **)** | - +------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** :ref:`NavigationMesh` navigation_mesh **)** | - +------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`parse_source_geometry_data` **(** :ref:`NavigationMesh` navigation_mesh, :ref:`NavigationMeshSourceGeometryData3D` source_geometry_data, :ref:`Node` root_node, :ref:`Callable` callback=Callable() **)** | - +------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bake`\ (\ navigation_mesh\: :ref:`NavigationMesh`, root_node\: :ref:`Node`\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bake_from_source_geometry_data`\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, callback\: :ref:`Callable` = Callable()\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ navigation_mesh\: :ref:`NavigationMesh`\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`parse_source_geometry_data`\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, root_node\: :ref:`Node`, callback\: :ref:`Callable` = Callable()\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -69,11 +69,11 @@ Method Descriptions .. rst-class:: classref-method -void **bake** **(** :ref:`NavigationMesh` navigation_mesh, :ref:`Node` root_node **)** +|void| **bake**\ (\ navigation_mesh\: :ref:`NavigationMesh`, root_node\: :ref:`Node`\ ) -**Deprecated:** This method may be changed or removed in future versions. +**Deprecated:** This method is deprecated due to core threading changes. To upgrade existing code, first create a :ref:`NavigationMeshSourceGeometryData3D` resource. Use this resource with :ref:`parse_source_geometry_data` to parse the :ref:`SceneTree` for nodes that should contribute to the navigation mesh baking. The :ref:`SceneTree` parsing needs to happen on the main thread. After the parsing is finished use the resource with :ref:`bake_from_source_geometry_data` to bake a navigation mesh. -The bake function is deprecated due to core threading changes. To upgrade existing code, first create a :ref:`NavigationMeshSourceGeometryData3D` resource. Use this resource with :ref:`parse_source_geometry_data` to parse the SceneTree for nodes that should contribute to the navigation mesh baking. The SceneTree parsing needs to happen on the main thread. After the parsing is finished use the resource with :ref:`bake_from_source_geometry_data` to bake a navigation mesh. +Bakes the ``navigation_mesh`` with source geometry collected starting from the ``root_node``. .. rst-class:: classref-item-separator @@ -83,7 +83,7 @@ The bake function is deprecated due to core threading changes. To upgrade existi .. rst-class:: classref-method -void **bake_from_source_geometry_data** **(** :ref:`NavigationMesh` navigation_mesh, :ref:`NavigationMeshSourceGeometryData3D` source_geometry_data, :ref:`Callable` callback=Callable() **)** +|void| **bake_from_source_geometry_data**\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, callback\: :ref:`Callable` = Callable()\ ) Bakes the provided ``navigation_mesh`` with the data from the provided ``source_geometry_data``. After the process is finished the optional ``callback`` will be called. @@ -95,7 +95,7 @@ Bakes the provided ``navigation_mesh`` with the data from the provided ``source_ .. rst-class:: classref-method -void **clear** **(** :ref:`NavigationMesh` navigation_mesh **)** +|void| **clear**\ (\ navigation_mesh\: :ref:`NavigationMesh`\ ) Removes all polygons and vertices from the provided ``navigation_mesh`` resource. @@ -107,7 +107,7 @@ Removes all polygons and vertices from the provided ``navigation_mesh`` resource .. rst-class:: classref-method -void **parse_source_geometry_data** **(** :ref:`NavigationMesh` navigation_mesh, :ref:`NavigationMeshSourceGeometryData3D` source_geometry_data, :ref:`Node` root_node, :ref:`Callable` callback=Callable() **)** +|void| **parse_source_geometry_data**\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, root_node\: :ref:`Node`, callback\: :ref:`Callable` = Callable()\ ) Parses the :ref:`SceneTree` for source geometry according to the properties of ``navigation_mesh``. Updates the provided ``source_geometry_data`` resource with the resulting data. The resource can then be used to bake a navigation mesh with :ref:`bake_from_source_geometry_data`. After the process is finished the optional ``callback`` will be called. @@ -122,3 +122,4 @@ Parses the :ref:`SceneTree` for source geometry according to th .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationmeshsourcegeometrydata2d.rst b/classes/class_navigationmeshsourcegeometrydata2d.rst index 3542002cbb9..2ace10a563e 100644 --- a/classes/class_navigationmeshsourcegeometrydata2d.rst +++ b/classes/class_navigationmeshsourcegeometrydata2d.rst @@ -31,23 +31,23 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_obstruction_outline` **(** :ref:`PackedVector2Array` shape_outline **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_traversable_outline` **(** :ref:`PackedVector2Array` shape_outline **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array[]` | :ref:`get_obstruction_outlines` **(** **)** |const| | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array[]` | :ref:`get_traversable_outlines` **(** **)** |const| | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_data` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_obstruction_outlines` **(** :ref:`PackedVector2Array[]` obstruction_outlines **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_traversable_outlines` **(** :ref:`PackedVector2Array[]` traversable_outlines **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_obstruction_outline`\ (\ shape_outline\: :ref:`PackedVector2Array`\ ) | + +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_traversable_outline`\ (\ shape_outline\: :ref:`PackedVector2Array`\ ) | + +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`PackedVector2Array`\] | :ref:`get_obstruction_outlines`\ (\ ) |const| | + +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`PackedVector2Array`\] | :ref:`get_traversable_outlines`\ (\ ) |const| | + +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_data`\ (\ ) | + +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_obstruction_outlines`\ (\ obstruction_outlines\: :ref:`Array`\[:ref:`PackedVector2Array`\]\ ) | + +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_traversable_outlines`\ (\ traversable_outlines\: :ref:`Array`\[:ref:`PackedVector2Array`\]\ ) | + +----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -62,7 +62,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_obstruction_outline** **(** :ref:`PackedVector2Array` shape_outline **)** +|void| **add_obstruction_outline**\ (\ shape_outline\: :ref:`PackedVector2Array`\ ) Adds the outline points of a shape as obstructed area. @@ -74,7 +74,7 @@ Adds the outline points of a shape as obstructed area. .. rst-class:: classref-method -void **add_traversable_outline** **(** :ref:`PackedVector2Array` shape_outline **)** +|void| **add_traversable_outline**\ (\ shape_outline\: :ref:`PackedVector2Array`\ ) Adds the outline points of a shape as traversable area. @@ -86,7 +86,7 @@ Adds the outline points of a shape as traversable area. .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the internal data. @@ -98,7 +98,7 @@ Clears the internal data. .. rst-class:: classref-method -:ref:`PackedVector2Array[]` **get_obstruction_outlines** **(** **)** |const| +:ref:`Array`\[:ref:`PackedVector2Array`\] **get_obstruction_outlines**\ (\ ) |const| Returns all the obstructed area outlines arrays. @@ -110,7 +110,7 @@ Returns all the obstructed area outlines arrays. .. rst-class:: classref-method -:ref:`PackedVector2Array[]` **get_traversable_outlines** **(** **)** |const| +:ref:`Array`\[:ref:`PackedVector2Array`\] **get_traversable_outlines**\ (\ ) |const| Returns all the traversable area outlines arrays. @@ -122,7 +122,7 @@ Returns all the traversable area outlines arrays. .. rst-class:: classref-method -:ref:`bool` **has_data** **(** **)** +:ref:`bool` **has_data**\ (\ ) Returns ``true`` when parsed source geometry data exists. @@ -134,7 +134,7 @@ Returns ``true`` when parsed source geometry data exists. .. rst-class:: classref-method -void **set_obstruction_outlines** **(** :ref:`PackedVector2Array[]` obstruction_outlines **)** +|void| **set_obstruction_outlines**\ (\ obstruction_outlines\: :ref:`Array`\[:ref:`PackedVector2Array`\]\ ) Sets all the obstructed area outlines arrays. @@ -146,7 +146,7 @@ Sets all the obstructed area outlines arrays. .. rst-class:: classref-method -void **set_traversable_outlines** **(** :ref:`PackedVector2Array[]` traversable_outlines **)** +|void| **set_traversable_outlines**\ (\ traversable_outlines\: :ref:`Array`\[:ref:`PackedVector2Array`\]\ ) Sets all the traversable area outlines arrays. @@ -157,3 +157,4 @@ Sets all the traversable area outlines arrays. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationmeshsourcegeometrydata3d.rst b/classes/class_navigationmeshsourcegeometrydata3d.rst index e61af29162c..d6a6ab20349 100644 --- a/classes/class_navigationmeshsourcegeometrydata3d.rst +++ b/classes/class_navigationmeshsourcegeometrydata3d.rst @@ -31,25 +31,25 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_faces` **(** :ref:`PackedVector3Array` faces, :ref:`Transform3D` xform **)** | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_mesh` **(** :ref:`Mesh` mesh, :ref:`Transform3D` xform **)** | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_mesh_array` **(** :ref:`Array` mesh_array, :ref:`Transform3D` xform **)** | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_indices` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`get_vertices` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_data` **(** **)** | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_indices` **(** :ref:`PackedInt32Array` indices **)** | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_vertices` **(** :ref:`PackedFloat32Array` vertices **)** | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_faces`\ (\ faces\: :ref:`PackedVector3Array`, xform\: :ref:`Transform3D`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_mesh`\ (\ mesh\: :ref:`Mesh`, xform\: :ref:`Transform3D`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_mesh_array`\ (\ mesh_array\: :ref:`Array`, xform\: :ref:`Transform3D`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_indices`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`get_vertices`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_data`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_indices`\ (\ indices\: :ref:`PackedInt32Array`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_vertices`\ (\ vertices\: :ref:`PackedFloat32Array`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -64,7 +64,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_faces** **(** :ref:`PackedVector3Array` faces, :ref:`Transform3D` xform **)** +|void| **add_faces**\ (\ faces\: :ref:`PackedVector3Array`, xform\: :ref:`Transform3D`\ ) Adds an array of vertex positions to the geometry data for navigation mesh baking to form triangulated faces. For each face the array must have three vertex positions in clockwise winding order. Since :ref:`NavigationMesh` resources have no transform, all vertex positions need to be offset by the node's transform using ``xform``. @@ -76,7 +76,7 @@ Adds an array of vertex positions to the geometry data for navigation mesh bakin .. rst-class:: classref-method -void **add_mesh** **(** :ref:`Mesh` mesh, :ref:`Transform3D` xform **)** +|void| **add_mesh**\ (\ mesh\: :ref:`Mesh`, xform\: :ref:`Transform3D`\ ) Adds the geometry data of a :ref:`Mesh` resource to the navigation mesh baking data. The mesh must have valid triangulated mesh data to be considered. Since :ref:`NavigationMesh` resources have no transform, all vertex positions need to be offset by the node's transform using ``xform``. @@ -88,7 +88,7 @@ Adds the geometry data of a :ref:`Mesh` resource to the navigation m .. rst-class:: classref-method -void **add_mesh_array** **(** :ref:`Array` mesh_array, :ref:`Transform3D` xform **)** +|void| **add_mesh_array**\ (\ mesh_array\: :ref:`Array`, xform\: :ref:`Transform3D`\ ) Adds an :ref:`Array` the size of :ref:`Mesh.ARRAY_MAX` and with vertices at index :ref:`Mesh.ARRAY_VERTEX` and indices at index :ref:`Mesh.ARRAY_INDEX` to the navigation mesh baking data. The array must have valid triangulated mesh data to be considered. Since :ref:`NavigationMesh` resources have no transform, all vertex positions need to be offset by the node's transform using ``xform``. @@ -100,7 +100,7 @@ Adds an :ref:`Array` the size of :ref:`Mesh.ARRAY_MAX` **get_indices** **(** **)** |const| +:ref:`PackedInt32Array` **get_indices**\ (\ ) |const| Returns the parsed source geometry data indices array. @@ -124,7 +124,7 @@ Returns the parsed source geometry data indices array. .. rst-class:: classref-method -:ref:`PackedFloat32Array` **get_vertices** **(** **)** |const| +:ref:`PackedFloat32Array` **get_vertices**\ (\ ) |const| Returns the parsed source geometry data vertices array. @@ -136,7 +136,7 @@ Returns the parsed source geometry data vertices array. .. rst-class:: classref-method -:ref:`bool` **has_data** **(** **)** +:ref:`bool` **has_data**\ (\ ) Returns ``true`` when parsed source geometry data exists. @@ -148,7 +148,7 @@ Returns ``true`` when parsed source geometry data exists. .. rst-class:: classref-method -void **set_indices** **(** :ref:`PackedInt32Array` indices **)** +|void| **set_indices**\ (\ indices\: :ref:`PackedInt32Array`\ ) Sets the parsed source geometry data indices. The indices need to be matched with appropriated vertices. @@ -162,7 +162,7 @@ Sets the parsed source geometry data indices. The indices need to be matched wit .. rst-class:: classref-method -void **set_vertices** **(** :ref:`PackedFloat32Array` vertices **)** +|void| **set_vertices**\ (\ vertices\: :ref:`PackedFloat32Array`\ ) Sets the parsed source geometry data vertices. The vertices need to be matched with appropriated indices. @@ -175,3 +175,4 @@ Sets the parsed source geometry data vertices. The vertices need to be matched w .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationobstacle2d.rst b/classes/class_navigationobstacle2d.rst index ff0edd79dc3..ce40dc5ef3e 100644 --- a/classes/class_navigationobstacle2d.rst +++ b/classes/class_navigationobstacle2d.rst @@ -64,17 +64,17 @@ Methods .. table:: :widths: auto - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_avoidance_layer_value` **(** :ref:`int` layer_number **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_navigation_map` **(** **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_avoidance_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_navigation_map` **(** :ref:`RID` navigation_map **)** | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_avoidance_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_navigation_map`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_avoidance_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_navigation_map`\ (\ navigation_map\: :ref:`RID`\ ) | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -93,8 +93,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_avoidance_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **get_avoidance_enabled** **(** **)** +- |void| **set_avoidance_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_avoidance_enabled**\ (\ ) If ``true`` the obstacle affects avoidance using agents. @@ -110,8 +110,8 @@ If ``true`` the obstacle affects avoidance using agents. .. rst-class:: classref-property-setget -- void **set_avoidance_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_avoidance_layers** **(** **)** +- |void| **set_avoidance_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_avoidance_layers**\ (\ ) A bitfield determining the avoidance layers for this obstacle. Agents with a matching bit on the their avoidance mask will avoid this obstacle. @@ -127,8 +127,8 @@ A bitfield determining the avoidance layers for this obstacle. Agents with a mat .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) Sets the avoidance radius for the obstacle. @@ -144,8 +144,8 @@ Sets the avoidance radius for the obstacle. .. rst-class:: classref-property-setget -- void **set_velocity** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_velocity** **(** **)** +- |void| **set_velocity**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_velocity**\ (\ ) Sets the wanted velocity for the obstacle so other agent's can better predict the obstacle if it is moved with a velocity regularly (every frame) instead of warped to a new position. Does only affect avoidance for the obstacles :ref:`radius`. Does nothing for the obstacles static vertices. @@ -161,8 +161,8 @@ Sets the wanted velocity for the obstacle so other agent's can better predict th .. rst-class:: classref-property-setget -- void **set_vertices** **(** :ref:`PackedVector2Array` value **)** -- :ref:`PackedVector2Array` **get_vertices** **(** **)** +- |void| **set_vertices**\ (\ value\: :ref:`PackedVector2Array`\ ) +- :ref:`PackedVector2Array` **get_vertices**\ (\ ) The outline vertices of the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out. Outlines can not be crossed or overlap. Should the vertices using obstacle be warped to a new position agent's can not predict this movement and may get trapped inside the obstacle. @@ -179,7 +179,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_avoidance_layer_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_avoidance_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`avoidance_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -191,7 +191,7 @@ Returns whether or not the specified layer of the :ref:`avoidance_layers` **get_navigation_map** **(** **)** |const| +:ref:`RID` **get_navigation_map**\ (\ ) |const| Returns the :ref:`RID` of the navigation map for this NavigationObstacle node. This function returns always the map set on the NavigationObstacle node and not the map of the abstract obstacle on the NavigationServer. If the obstacle map is changed directly with the NavigationServer API the NavigationObstacle node will not be aware of the map change. Use :ref:`set_navigation_map` to change the navigation map for the NavigationObstacle and also update the obstacle on the NavigationServer. @@ -203,7 +203,7 @@ Returns the :ref:`RID` of the navigation map for this NavigationObsta .. rst-class:: classref-method -:ref:`RID` **get_rid** **(** **)** |const| +:ref:`RID` **get_rid**\ (\ ) |const| Returns the :ref:`RID` of this obstacle on the :ref:`NavigationServer2D`. @@ -215,7 +215,7 @@ Returns the :ref:`RID` of this obstacle on the :ref:`NavigationServer .. rst-class:: classref-method -void **set_avoidance_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_avoidance_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`avoidance_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -227,7 +227,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`avoidan .. rst-class:: classref-method -void **set_navigation_map** **(** :ref:`RID` navigation_map **)** +|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) Sets the :ref:`RID` of the navigation map this NavigationObstacle node should use and also updates the ``obstacle`` on the NavigationServer. @@ -238,3 +238,4 @@ Sets the :ref:`RID` of the navigation map this NavigationObstacle nod .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationobstacle3d.rst b/classes/class_navigationobstacle3d.rst index 8928883dfa1..a1fa2f8a6c1 100644 --- a/classes/class_navigationobstacle3d.rst +++ b/classes/class_navigationobstacle3d.rst @@ -68,17 +68,17 @@ Methods .. table:: :widths: auto - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_avoidance_layer_value` **(** :ref:`int` layer_number **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_navigation_map` **(** **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_avoidance_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_navigation_map` **(** :ref:`RID` navigation_map **)** | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_avoidance_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_navigation_map`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_avoidance_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_navigation_map`\ (\ navigation_map\: :ref:`RID`\ ) | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -97,8 +97,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_avoidance_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **get_avoidance_enabled** **(** **)** +- |void| **set_avoidance_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_avoidance_enabled**\ (\ ) If ``true`` the obstacle affects avoidance using agents. @@ -114,8 +114,8 @@ If ``true`` the obstacle affects avoidance using agents. .. rst-class:: classref-property-setget -- void **set_avoidance_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_avoidance_layers** **(** **)** +- |void| **set_avoidance_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_avoidance_layers**\ (\ ) A bitfield determining the avoidance layers for this obstacle. Agents with a matching bit on the their avoidance mask will avoid this obstacle. @@ -131,8 +131,8 @@ A bitfield determining the avoidance layers for this obstacle. Agents with a mat .. rst-class:: classref-property-setget -- void **set_height** **(** :ref:`float` value **)** -- :ref:`float` **get_height** **(** **)** +- |void| **set_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_height**\ (\ ) Sets the obstacle height used in 2D avoidance. 2D avoidance using agent's ignore obstacles that are below or above them. @@ -148,8 +148,8 @@ Sets the obstacle height used in 2D avoidance. 2D avoidance using agent's ignore .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) Sets the avoidance radius for the obstacle. @@ -165,8 +165,8 @@ Sets the avoidance radius for the obstacle. .. rst-class:: classref-property-setget -- void **set_use_3d_avoidance** **(** :ref:`bool` value **)** -- :ref:`bool` **get_use_3d_avoidance** **(** **)** +- |void| **set_use_3d_avoidance**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_3d_avoidance**\ (\ ) If ``true`` the obstacle affects 3D avoidance using agent's with obstacle :ref:`radius`. @@ -184,8 +184,8 @@ If ``false`` the obstacle affects 2D avoidance using agent's with both obstacle .. rst-class:: classref-property-setget -- void **set_velocity** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_velocity** **(** **)** +- |void| **set_velocity**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_velocity**\ (\ ) Sets the wanted velocity for the obstacle so other agent's can better predict the obstacle if it is moved with a velocity regularly (every frame) instead of warped to a new position. Does only affect avoidance for the obstacles :ref:`radius`. Does nothing for the obstacles static vertices. @@ -201,8 +201,8 @@ Sets the wanted velocity for the obstacle so other agent's can better predict th .. rst-class:: classref-property-setget -- void **set_vertices** **(** :ref:`PackedVector3Array` value **)** -- :ref:`PackedVector3Array` **get_vertices** **(** **)** +- |void| **set_vertices**\ (\ value\: :ref:`PackedVector3Array`\ ) +- :ref:`PackedVector3Array` **get_vertices**\ (\ ) The outline vertices of the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out. Outlines can not be crossed or overlap. Should the vertices using obstacle be warped to a new position agent's can not predict this movement and may get trapped inside the obstacle. @@ -219,7 +219,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_avoidance_layer_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_avoidance_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`avoidance_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -231,7 +231,7 @@ Returns whether or not the specified layer of the :ref:`avoidance_layers` **get_navigation_map** **(** **)** |const| +:ref:`RID` **get_navigation_map**\ (\ ) |const| Returns the :ref:`RID` of the navigation map for this NavigationObstacle node. This function returns always the map set on the NavigationObstacle node and not the map of the abstract obstacle on the NavigationServer. If the obstacle map is changed directly with the NavigationServer API the NavigationObstacle node will not be aware of the map change. Use :ref:`set_navigation_map` to change the navigation map for the NavigationObstacle and also update the obstacle on the NavigationServer. @@ -243,7 +243,7 @@ Returns the :ref:`RID` of the navigation map for this NavigationObsta .. rst-class:: classref-method -:ref:`RID` **get_rid** **(** **)** |const| +:ref:`RID` **get_rid**\ (\ ) |const| Returns the :ref:`RID` of this obstacle on the :ref:`NavigationServer3D`. @@ -255,7 +255,7 @@ Returns the :ref:`RID` of this obstacle on the :ref:`NavigationServer .. rst-class:: classref-method -void **set_avoidance_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_avoidance_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`avoidance_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -267,7 +267,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`avoidan .. rst-class:: classref-method -void **set_navigation_map** **(** :ref:`RID` navigation_map **)** +|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) Sets the :ref:`RID` of the navigation map this NavigationObstacle node should use and also updates the ``obstacle`` on the NavigationServer. @@ -278,3 +278,4 @@ Sets the :ref:`RID` of the navigation map this NavigationObstacle nod .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationpathqueryparameters2d.rst b/classes/class_navigationpathqueryparameters2d.rst index 7985271238f..c8ba2e996e0 100644 --- a/classes/class_navigationpathqueryparameters2d.rst +++ b/classes/class_navigationpathqueryparameters2d.rst @@ -41,7 +41,7 @@ Properties +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------+ | :ref:`RID` | :ref:`map` | ``RID()`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------+ - | |bitfield|\<:ref:`PathMetadataFlags`\> | :ref:`metadata_flags` | ``7`` | + | |bitfield|\[:ref:`PathMetadataFlags`\] | :ref:`metadata_flags` | ``7`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------+ | :ref:`int` | :ref:`navigation_layers` | ``1`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------+ @@ -170,8 +170,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_map** **(** :ref:`RID` value **)** -- :ref:`RID` **get_map** **(** **)** +- |void| **set_map**\ (\ value\: :ref:`RID`\ ) +- :ref:`RID` **get_map**\ (\ ) The navigation map :ref:`RID` used in the path query. @@ -183,12 +183,12 @@ The navigation map :ref:`RID` used in the path query. .. rst-class:: classref-property -|bitfield|\<:ref:`PathMetadataFlags`\> **metadata_flags** = ``7`` +|bitfield|\[:ref:`PathMetadataFlags`\] **metadata_flags** = ``7`` .. rst-class:: classref-property-setget -- void **set_metadata_flags** **(** |bitfield|\<:ref:`PathMetadataFlags`\> value **)** -- |bitfield|\<:ref:`PathMetadataFlags`\> **get_metadata_flags** **(** **)** +- |void| **set_metadata_flags**\ (\ value\: |bitfield|\[:ref:`PathMetadataFlags`\]\ ) +- |bitfield|\[:ref:`PathMetadataFlags`\] **get_metadata_flags**\ (\ ) Additional information to include with the navigation path. @@ -204,8 +204,8 @@ Additional information to include with the navigation path. .. rst-class:: classref-property-setget -- void **set_navigation_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_navigation_layers** **(** **)** +- |void| **set_navigation_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_navigation_layers**\ (\ ) The navigation layers the query will use (as a bitmask). @@ -221,8 +221,8 @@ The navigation layers the query will use (as a bitmask). .. rst-class:: classref-property-setget -- void **set_path_postprocessing** **(** :ref:`PathPostProcessing` value **)** -- :ref:`PathPostProcessing` **get_path_postprocessing** **(** **)** +- |void| **set_path_postprocessing**\ (\ value\: :ref:`PathPostProcessing`\ ) +- :ref:`PathPostProcessing` **get_path_postprocessing**\ (\ ) The path postprocessing applied to the raw path corridor found by the :ref:`pathfinding_algorithm`. @@ -238,8 +238,8 @@ The path postprocessing applied to the raw path corridor found by the :ref:`path .. rst-class:: classref-property-setget -- void **set_pathfinding_algorithm** **(** :ref:`PathfindingAlgorithm` value **)** -- :ref:`PathfindingAlgorithm` **get_pathfinding_algorithm** **(** **)** +- |void| **set_pathfinding_algorithm**\ (\ value\: :ref:`PathfindingAlgorithm`\ ) +- :ref:`PathfindingAlgorithm` **get_pathfinding_algorithm**\ (\ ) The pathfinding algorithm used in the path query. @@ -255,8 +255,8 @@ The pathfinding algorithm used in the path query. .. rst-class:: classref-property-setget -- void **set_start_position** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_start_position** **(** **)** +- |void| **set_start_position**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_start_position**\ (\ ) The pathfinding start position in global coordinates. @@ -272,8 +272,8 @@ The pathfinding start position in global coordinates. .. rst-class:: classref-property-setget -- void **set_target_position** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_target_position** **(** **)** +- |void| **set_target_position**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_target_position**\ (\ ) The pathfinding target position in global coordinates. @@ -284,3 +284,4 @@ The pathfinding target position in global coordinates. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationpathqueryparameters3d.rst b/classes/class_navigationpathqueryparameters3d.rst index 3381fa2705a..434aa82c991 100644 --- a/classes/class_navigationpathqueryparameters3d.rst +++ b/classes/class_navigationpathqueryparameters3d.rst @@ -41,7 +41,7 @@ Properties +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`RID` | :ref:`map` | ``RID()`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ - | |bitfield|\<:ref:`PathMetadataFlags`\> | :ref:`metadata_flags` | ``7`` | + | |bitfield|\[:ref:`PathMetadataFlags`\] | :ref:`metadata_flags` | ``7`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`int` | :ref:`navigation_layers` | ``1`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ @@ -170,8 +170,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_map** **(** :ref:`RID` value **)** -- :ref:`RID` **get_map** **(** **)** +- |void| **set_map**\ (\ value\: :ref:`RID`\ ) +- :ref:`RID` **get_map**\ (\ ) The navigation map :ref:`RID` used in the path query. @@ -183,12 +183,12 @@ The navigation map :ref:`RID` used in the path query. .. rst-class:: classref-property -|bitfield|\<:ref:`PathMetadataFlags`\> **metadata_flags** = ``7`` +|bitfield|\[:ref:`PathMetadataFlags`\] **metadata_flags** = ``7`` .. rst-class:: classref-property-setget -- void **set_metadata_flags** **(** |bitfield|\<:ref:`PathMetadataFlags`\> value **)** -- |bitfield|\<:ref:`PathMetadataFlags`\> **get_metadata_flags** **(** **)** +- |void| **set_metadata_flags**\ (\ value\: |bitfield|\[:ref:`PathMetadataFlags`\]\ ) +- |bitfield|\[:ref:`PathMetadataFlags`\] **get_metadata_flags**\ (\ ) Additional information to include with the navigation path. @@ -204,8 +204,8 @@ Additional information to include with the navigation path. .. rst-class:: classref-property-setget -- void **set_navigation_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_navigation_layers** **(** **)** +- |void| **set_navigation_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_navigation_layers**\ (\ ) The navigation layers the query will use (as a bitmask). @@ -221,8 +221,8 @@ The navigation layers the query will use (as a bitmask). .. rst-class:: classref-property-setget -- void **set_path_postprocessing** **(** :ref:`PathPostProcessing` value **)** -- :ref:`PathPostProcessing` **get_path_postprocessing** **(** **)** +- |void| **set_path_postprocessing**\ (\ value\: :ref:`PathPostProcessing`\ ) +- :ref:`PathPostProcessing` **get_path_postprocessing**\ (\ ) The path postprocessing applied to the raw path corridor found by the :ref:`pathfinding_algorithm`. @@ -238,8 +238,8 @@ The path postprocessing applied to the raw path corridor found by the :ref:`path .. rst-class:: classref-property-setget -- void **set_pathfinding_algorithm** **(** :ref:`PathfindingAlgorithm` value **)** -- :ref:`PathfindingAlgorithm` **get_pathfinding_algorithm** **(** **)** +- |void| **set_pathfinding_algorithm**\ (\ value\: :ref:`PathfindingAlgorithm`\ ) +- :ref:`PathfindingAlgorithm` **get_pathfinding_algorithm**\ (\ ) The pathfinding algorithm used in the path query. @@ -255,8 +255,8 @@ The pathfinding algorithm used in the path query. .. rst-class:: classref-property-setget -- void **set_start_position** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_start_position** **(** **)** +- |void| **set_start_position**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_start_position**\ (\ ) The pathfinding start position in global coordinates. @@ -272,8 +272,8 @@ The pathfinding start position in global coordinates. .. rst-class:: classref-property-setget -- void **set_target_position** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_target_position** **(** **)** +- |void| **set_target_position**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_target_position**\ (\ ) The pathfinding target position in global coordinates. @@ -284,3 +284,4 @@ The pathfinding target position in global coordinates. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationpathqueryresult2d.rst b/classes/class_navigationpathqueryresult2d.rst index 34aeb2fedd2..36acd5000eb 100644 --- a/classes/class_navigationpathqueryresult2d.rst +++ b/classes/class_navigationpathqueryresult2d.rst @@ -43,7 +43,7 @@ Properties +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ | :ref:`PackedInt64Array` | :ref:`path_owner_ids` | ``PackedInt64Array()`` | +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ - | :ref:`RID[]` | :ref:`path_rids` | ``[]`` | + | :ref:`Array`\[:ref:`RID`\] | :ref:`path_rids` | ``[]`` | +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ | :ref:`PackedInt32Array` | :ref:`path_types` | ``PackedInt32Array()`` | +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ @@ -56,9 +56,9 @@ Methods .. table:: :widths: auto - +------+--------------------------------------------------------------------------+ - | void | :ref:`reset` **(** **)** | - +------+--------------------------------------------------------------------------+ + +--------+--------------------------------------------------------------------+ + | |void| | :ref:`reset`\ (\ ) | + +--------+--------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -108,8 +108,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_path** **(** :ref:`PackedVector2Array` value **)** -- :ref:`PackedVector2Array` **get_path** **(** **)** +- |void| **set_path**\ (\ value\: :ref:`PackedVector2Array`\ ) +- :ref:`PackedVector2Array` **get_path**\ (\ ) The resulting path array from the navigation query. All path array positions are in global coordinates. Without customized query parameters this is the same path as returned by :ref:`NavigationServer2D.map_get_path`. @@ -125,8 +125,8 @@ The resulting path array from the navigation query. All path array positions are .. rst-class:: classref-property-setget -- void **set_path_owner_ids** **(** :ref:`PackedInt64Array` value **)** -- :ref:`PackedInt64Array` **get_path_owner_ids** **(** **)** +- |void| **set_path_owner_ids**\ (\ value\: :ref:`PackedInt64Array`\ ) +- :ref:`PackedInt64Array` **get_path_owner_ids**\ (\ ) The ``ObjectID``\ s of the :ref:`Object`\ s which manage the regions and links each point of the path goes through. @@ -138,12 +138,12 @@ The ``ObjectID``\ s of the :ref:`Object`\ s which manage the regio .. rst-class:: classref-property -:ref:`RID[]` **path_rids** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **path_rids** = ``[]`` .. rst-class:: classref-property-setget -- void **set_path_rids** **(** :ref:`RID[]` value **)** -- :ref:`RID[]` **get_path_rids** **(** **)** +- |void| **set_path_rids**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) +- :ref:`Array`\[:ref:`RID`\] **get_path_rids**\ (\ ) The :ref:`RID`\ s of the regions and links that each point of the path goes through. @@ -159,8 +159,8 @@ The :ref:`RID`\ s of the regions and links that each point of the pat .. rst-class:: classref-property-setget -- void **set_path_types** **(** :ref:`PackedInt32Array` value **)** -- :ref:`PackedInt32Array` **get_path_types** **(** **)** +- |void| **set_path_types**\ (\ value\: :ref:`PackedInt32Array`\ ) +- :ref:`PackedInt32Array` **get_path_types**\ (\ ) The type of navigation primitive (region or link) that each point of the path goes through. @@ -177,7 +177,7 @@ Method Descriptions .. rst-class:: classref-method -void **reset** **(** **)** +|void| **reset**\ (\ ) Reset the result object to its initial state. This is useful to reuse the object across multiple queries. @@ -188,3 +188,4 @@ Reset the result object to its initial state. This is useful to reuse the object .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationpathqueryresult3d.rst b/classes/class_navigationpathqueryresult3d.rst index 488949e98ea..79ba4bd5804 100644 --- a/classes/class_navigationpathqueryresult3d.rst +++ b/classes/class_navigationpathqueryresult3d.rst @@ -43,7 +43,7 @@ Properties +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ | :ref:`PackedInt64Array` | :ref:`path_owner_ids` | ``PackedInt64Array()`` | +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ - | :ref:`RID[]` | :ref:`path_rids` | ``[]`` | + | :ref:`Array`\[:ref:`RID`\] | :ref:`path_rids` | ``[]`` | +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ | :ref:`PackedInt32Array` | :ref:`path_types` | ``PackedInt32Array()`` | +-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------+ @@ -56,9 +56,9 @@ Methods .. table:: :widths: auto - +------+--------------------------------------------------------------------------+ - | void | :ref:`reset` **(** **)** | - +------+--------------------------------------------------------------------------+ + +--------+--------------------------------------------------------------------+ + | |void| | :ref:`reset`\ (\ ) | + +--------+--------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -108,8 +108,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_path** **(** :ref:`PackedVector3Array` value **)** -- :ref:`PackedVector3Array` **get_path** **(** **)** +- |void| **set_path**\ (\ value\: :ref:`PackedVector3Array`\ ) +- :ref:`PackedVector3Array` **get_path**\ (\ ) The resulting path array from the navigation query. All path array positions are in global coordinates. Without customized query parameters this is the same path as returned by :ref:`NavigationServer3D.map_get_path`. @@ -125,8 +125,8 @@ The resulting path array from the navigation query. All path array positions are .. rst-class:: classref-property-setget -- void **set_path_owner_ids** **(** :ref:`PackedInt64Array` value **)** -- :ref:`PackedInt64Array` **get_path_owner_ids** **(** **)** +- |void| **set_path_owner_ids**\ (\ value\: :ref:`PackedInt64Array`\ ) +- :ref:`PackedInt64Array` **get_path_owner_ids**\ (\ ) The ``ObjectID``\ s of the :ref:`Object`\ s which manage the regions and links each point of the path goes through. @@ -138,12 +138,12 @@ The ``ObjectID``\ s of the :ref:`Object`\ s which manage the regio .. rst-class:: classref-property -:ref:`RID[]` **path_rids** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **path_rids** = ``[]`` .. rst-class:: classref-property-setget -- void **set_path_rids** **(** :ref:`RID[]` value **)** -- :ref:`RID[]` **get_path_rids** **(** **)** +- |void| **set_path_rids**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) +- :ref:`Array`\[:ref:`RID`\] **get_path_rids**\ (\ ) The :ref:`RID`\ s of the regions and links that each point of the path goes through. @@ -159,8 +159,8 @@ The :ref:`RID`\ s of the regions and links that each point of the pat .. rst-class:: classref-property-setget -- void **set_path_types** **(** :ref:`PackedInt32Array` value **)** -- :ref:`PackedInt32Array` **get_path_types** **(** **)** +- |void| **set_path_types**\ (\ value\: :ref:`PackedInt32Array`\ ) +- :ref:`PackedInt32Array` **get_path_types**\ (\ ) The type of navigation primitive (region or link) that each point of the path goes through. @@ -177,7 +177,7 @@ Method Descriptions .. rst-class:: classref-method -void **reset** **(** **)** +|void| **reset**\ (\ ) Reset the result object to its initial state. This is useful to reuse the object across multiple queries. @@ -188,3 +188,4 @@ Reset the result object to its initial state. This is useful to reuse the object .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index eecb5c8269a..4eea55a10d4 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -116,43 +116,43 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_outline` **(** :ref:`PackedVector2Array` outline **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_outline_at_index` **(** :ref:`PackedVector2Array` outline, :ref:`int` index **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_polygon` **(** :ref:`PackedInt32Array` polygon **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_outlines` **(** **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_polygons` **(** **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NavigationMesh` | :ref:`get_navigation_mesh` **(** **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`get_outline` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_outline_count` **(** **)** |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_parsed_collision_mask_value` **(** :ref:`int` layer_number **)** |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_polygon` **(** :ref:`int` idx **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_polygon_count` **(** **)** |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`get_vertices` **(** **)** |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`make_polygons_from_outlines` **(** **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_outline` **(** :ref:`int` idx **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_outline` **(** :ref:`int` idx, :ref:`PackedVector2Array` outline **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_parsed_collision_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_vertices` **(** :ref:`PackedVector2Array` vertices **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_outline`\ (\ outline\: :ref:`PackedVector2Array`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_outline_at_index`\ (\ outline\: :ref:`PackedVector2Array`, index\: :ref:`int`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_polygon`\ (\ polygon\: :ref:`PackedInt32Array`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_outlines`\ (\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_polygons`\ (\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NavigationMesh` | :ref:`get_navigation_mesh`\ (\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`get_outline`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_outline_count`\ (\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_parsed_collision_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_polygon`\ (\ idx\: :ref:`int`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_polygon_count`\ (\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`get_vertices`\ (\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`make_polygons_from_outlines`\ (\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_outline`\ (\ idx\: :ref:`int`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_outline`\ (\ idx\: :ref:`int`, outline\: :ref:`PackedVector2Array`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_parsed_collision_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_vertices`\ (\ vertices\: :ref:`PackedVector2Array`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -262,8 +262,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_agent_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_agent_radius** **(** **)** +- |void| **set_agent_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_agent_radius**\ (\ ) The distance to erode/shrink the walkable surface when baking the navigation mesh. @@ -279,8 +279,8 @@ The distance to erode/shrink the walkable surface when baking the navigation mes .. rst-class:: classref-property-setget -- void **set_baking_rect** **(** :ref:`Rect2` value **)** -- :ref:`Rect2` **get_baking_rect** **(** **)** +- |void| **set_baking_rect**\ (\ value\: :ref:`Rect2`\ ) +- :ref:`Rect2` **get_baking_rect**\ (\ ) If the baking :ref:`Rect2` has an area the navigation mesh baking will be restricted to its enclosing area. @@ -296,8 +296,8 @@ If the baking :ref:`Rect2` has an area the navigation mesh baking w .. rst-class:: classref-property-setget -- void **set_baking_rect_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_baking_rect_offset** **(** **)** +- |void| **set_baking_rect_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_baking_rect_offset**\ (\ ) The position offset applied to the :ref:`baking_rect` :ref:`Rect2`. @@ -313,8 +313,8 @@ The position offset applied to the :ref:`baking_rect` value **)** -- :ref:`float` **get_border_size** **(** **)** +- |void| **set_border_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_border_size**\ (\ ) The size of the non-navigable border around the bake bounding area defined by the :ref:`baking_rect` :ref:`Rect2`. @@ -332,8 +332,8 @@ In conjunction with the :ref:`baking_rect` value **)** -- :ref:`float` **get_cell_size** **(** **)** +- |void| **set_cell_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_cell_size**\ (\ ) The cell size used to rasterize the navigation mesh vertices. Must match with the cell size on the navigation map. @@ -349,8 +349,8 @@ The cell size used to rasterize the navigation mesh vertices. Must match with th .. rst-class:: classref-property-setget -- void **set_parsed_collision_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_parsed_collision_mask** **(** **)** +- |void| **set_parsed_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_parsed_collision_mask**\ (\ ) The physics layers to scan for static colliders. @@ -368,8 +368,8 @@ Only used when :ref:`parsed_geometry_type` value **)** -- :ref:`ParsedGeometryType` **get_parsed_geometry_type** **(** **)** +- |void| **set_parsed_geometry_type**\ (\ value\: :ref:`ParsedGeometryType`\ ) +- :ref:`ParsedGeometryType` **get_parsed_geometry_type**\ (\ ) Determines which type of nodes will be parsed as geometry. See :ref:`ParsedGeometryType` for possible values. @@ -385,8 +385,8 @@ Determines which type of nodes will be parsed as geometry. See :ref:`ParsedGeome .. rst-class:: classref-property-setget -- void **set_source_geometry_group_name** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_source_geometry_group_name** **(** **)** +- |void| **set_source_geometry_group_name**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_source_geometry_group_name**\ (\ ) The group name of nodes that should be parsed for baking source geometry. @@ -404,8 +404,8 @@ Only used when :ref:`source_geometry_mode` value **)** -- :ref:`SourceGeometryMode` **get_source_geometry_mode** **(** **)** +- |void| **set_source_geometry_mode**\ (\ value\: :ref:`SourceGeometryMode`\ ) +- :ref:`SourceGeometryMode` **get_source_geometry_mode**\ (\ ) The source of the geometry used when baking. See :ref:`SourceGeometryMode` for possible values. @@ -422,7 +422,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_outline** **(** :ref:`PackedVector2Array` outline **)** +|void| **add_outline**\ (\ outline\: :ref:`PackedVector2Array`\ ) Appends a :ref:`PackedVector2Array` that contains the vertices of an outline to the internal array that contains all the outlines. @@ -434,7 +434,7 @@ Appends a :ref:`PackedVector2Array` that contains the .. rst-class:: classref-method -void **add_outline_at_index** **(** :ref:`PackedVector2Array` outline, :ref:`int` index **)** +|void| **add_outline_at_index**\ (\ outline\: :ref:`PackedVector2Array`, index\: :ref:`int`\ ) Adds a :ref:`PackedVector2Array` that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position. @@ -446,7 +446,7 @@ Adds a :ref:`PackedVector2Array` that contains the ver .. rst-class:: classref-method -void **add_polygon** **(** :ref:`PackedInt32Array` polygon **)** +|void| **add_polygon**\ (\ polygon\: :ref:`PackedInt32Array`\ ) Adds a polygon using the indices of the vertices you get when calling :ref:`get_vertices`. @@ -458,7 +458,7 @@ Adds a polygon using the indices of the vertices you get when calling :ref:`get_ .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the internal arrays for vertices and polygon indices. @@ -470,7 +470,7 @@ Clears the internal arrays for vertices and polygon indices. .. rst-class:: classref-method -void **clear_outlines** **(** **)** +|void| **clear_outlines**\ (\ ) Clears the array of the outlines, but it doesn't clear the vertices and the polygons that were created by them. @@ -482,7 +482,7 @@ Clears the array of the outlines, but it doesn't clear the vertices and the poly .. rst-class:: classref-method -void **clear_polygons** **(** **)** +|void| **clear_polygons**\ (\ ) Clears the array of polygons, but it doesn't clear the array of outlines and vertices. @@ -494,7 +494,7 @@ Clears the array of polygons, but it doesn't clear the array of outlines and ver .. rst-class:: classref-method -:ref:`NavigationMesh` **get_navigation_mesh** **(** **)** +:ref:`NavigationMesh` **get_navigation_mesh**\ (\ ) Returns the :ref:`NavigationMesh` resulting from this navigation polygon. This navigation mesh can be used to update the navigation mesh of a region with the :ref:`NavigationServer3D.region_set_navigation_mesh` API directly (as 2D uses the 3D server behind the scene). @@ -506,7 +506,7 @@ Returns the :ref:`NavigationMesh` resulting from this navi .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_outline** **(** :ref:`int` idx **)** |const| +:ref:`PackedVector2Array` **get_outline**\ (\ idx\: :ref:`int`\ ) |const| Returns a :ref:`PackedVector2Array` containing the vertices of an outline that was created in the editor or by script. @@ -518,7 +518,7 @@ Returns a :ref:`PackedVector2Array` containing the ver .. rst-class:: classref-method -:ref:`int` **get_outline_count** **(** **)** |const| +:ref:`int` **get_outline_count**\ (\ ) |const| Returns the number of outlines that were created in the editor or by script. @@ -530,7 +530,7 @@ Returns the number of outlines that were created in the editor or by script. .. rst-class:: classref-method -:ref:`bool` **get_parsed_collision_mask_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_parsed_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`parsed_collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -542,7 +542,7 @@ Returns whether or not the specified layer of the :ref:`parsed_collision_mask` **get_polygon** **(** :ref:`int` idx **)** +:ref:`PackedInt32Array` **get_polygon**\ (\ idx\: :ref:`int`\ ) Returns a :ref:`PackedInt32Array` containing the indices of the vertices of a created polygon. @@ -554,7 +554,7 @@ Returns a :ref:`PackedInt32Array` containing the indices .. rst-class:: classref-method -:ref:`int` **get_polygon_count** **(** **)** |const| +:ref:`int` **get_polygon_count**\ (\ ) |const| Returns the count of all polygons. @@ -566,7 +566,7 @@ Returns the count of all polygons. .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_vertices** **(** **)** |const| +:ref:`PackedVector2Array` **get_vertices**\ (\ ) |const| Returns a :ref:`PackedVector2Array` containing all the vertices being used to create the polygons. @@ -578,7 +578,7 @@ Returns a :ref:`PackedVector2Array` containing all the .. rst-class:: classref-method -void **make_polygons_from_outlines** **(** **)** +|void| **make_polygons_from_outlines**\ (\ ) **Deprecated:** Use :ref:`NavigationServer2D.parse_source_geometry_data` and :ref:`NavigationServer2D.bake_from_source_geometry_data` instead. @@ -592,7 +592,7 @@ Creates polygons from the outlines added in the editor or by script. .. rst-class:: classref-method -void **remove_outline** **(** :ref:`int` idx **)** +|void| **remove_outline**\ (\ idx\: :ref:`int`\ ) Removes an outline created in the editor or by script. You have to call :ref:`make_polygons_from_outlines` for the polygons to update. @@ -604,7 +604,7 @@ Removes an outline created in the editor or by script. You have to call :ref:`ma .. rst-class:: classref-method -void **set_outline** **(** :ref:`int` idx, :ref:`PackedVector2Array` outline **)** +|void| **set_outline**\ (\ idx\: :ref:`int`, outline\: :ref:`PackedVector2Array`\ ) Changes an outline created in the editor or by script. You have to call :ref:`make_polygons_from_outlines` for the polygons to update. @@ -616,7 +616,7 @@ Changes an outline created in the editor or by script. You have to call :ref:`ma .. rst-class:: classref-method -void **set_parsed_collision_mask_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_parsed_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`parsed_collision_mask`, given a ``layer_number`` between 1 and 32. @@ -628,7 +628,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`parsed_ .. rst-class:: classref-method -void **set_vertices** **(** :ref:`PackedVector2Array` vertices **)** +|void| **set_vertices**\ (\ vertices\: :ref:`PackedVector2Array`\ ) Sets the vertices that can be then indexed to create polygons with the :ref:`add_polygon` method. @@ -639,3 +639,4 @@ Sets the vertices that can be then indexed to create polygons with the :ref:`add .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationregion2d.rst b/classes/class_navigationregion2d.rst index 6b890482ead..e5196d99845 100644 --- a/classes/class_navigationregion2d.rst +++ b/classes/class_navigationregion2d.rst @@ -76,27 +76,27 @@ Methods .. table:: :widths: auto - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`bake_navigation_polygon` **(** :ref:`bool` on_thread=true **)** | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_avoidance_layer_value` **(** :ref:`int` layer_number **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_navigation_layer_value` **(** :ref:`int` layer_number **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_navigation_map` **(** **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_region_rid` **(** **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_baking` **(** **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_avoidance_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_navigation_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_navigation_map` **(** :ref:`RID` navigation_map **)** | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bake_navigation_polygon`\ (\ on_thread\: :ref:`bool` = true\ ) | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_avoidance_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_navigation_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_navigation_map`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_region_rid`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_baking`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_avoidance_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_navigation_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_navigation_map`\ (\ navigation_map\: :ref:`RID`\ ) | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -111,7 +111,7 @@ Signals .. rst-class:: classref-signal -**bake_finished** **(** **)** +**bake_finished**\ (\ ) Emitted when a navigation polygon bake operation is completed. @@ -123,7 +123,7 @@ Emitted when a navigation polygon bake operation is completed. .. rst-class:: classref-signal -**navigation_polygon_changed** **(** **)** +**navigation_polygon_changed**\ (\ ) Emitted when the used navigation polygon is replaced or changes to the internals of the current navigation polygon are committed. @@ -144,8 +144,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_avoidance_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_avoidance_layers** **(** **)** +- |void| **set_avoidance_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_avoidance_layers**\ (\ ) A bitfield determining all avoidance layers for the avoidance constrain. @@ -161,12 +161,12 @@ A bitfield determining all avoidance layers for the avoidance constrain. .. rst-class:: classref-property-setget -- void **set_constrain_avoidance** **(** :ref:`bool` value **)** -- :ref:`bool` **get_constrain_avoidance** **(** **)** +- |void| **set_constrain_avoidance**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_constrain_avoidance**\ (\ ) -If ``true`` constraints avoidance agent's with an avoidance mask bit that matches with a bit of the :ref:`avoidance_layers` to the navigation polygon. Due to each navigation polygon outline creating an obstacle and each polygon edge creating an avoidance line constrain keep the navigation polygon shape as simple as possible for performance. +**Experimental:** When enabled, agents are known to get stuck on the navigation polygon corners and edges, especially at a high frame rate. Not recommended for use in production at this stage. -\ **Experimental:** This is an experimental feature and should not be used in production as agent's can get stuck on the navigation polygon corners and edges especially at high frame rate. +If ``true`` constraints avoidance agent's with an avoidance mask bit that matches with a bit of the :ref:`avoidance_layers` to the navigation polygon. Due to each navigation polygon outline creating an obstacle and each polygon edge creating an avoidance line constrain keep the navigation polygon shape as simple as possible for performance. .. rst-class:: classref-item-separator @@ -180,8 +180,8 @@ If ``true`` constraints avoidance agent's with an avoidance mask bit that matche .. rst-class:: classref-property-setget -- void **set_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_enabled** **(** **)** +- |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_enabled**\ (\ ) Determines if the **NavigationRegion2D** is enabled or disabled. @@ -197,8 +197,8 @@ Determines if the **NavigationRegion2D** is enabled or disabled. .. rst-class:: classref-property-setget -- void **set_enter_cost** **(** :ref:`float` value **)** -- :ref:`float` **get_enter_cost** **(** **)** +- |void| **set_enter_cost**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_enter_cost**\ (\ ) When pathfinding enters this region's navigation mesh from another regions navigation mesh the :ref:`enter_cost` value is added to the path distance for determining the shortest path. @@ -214,8 +214,8 @@ When pathfinding enters this region's navigation mesh from another regions navig .. rst-class:: classref-property-setget -- void **set_navigation_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_navigation_layers** **(** **)** +- |void| **set_navigation_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_navigation_layers**\ (\ ) A bitfield determining all navigation layers the region belongs to. These navigation layers can be checked upon when requesting a path with :ref:`NavigationServer2D.map_get_path`. @@ -231,8 +231,8 @@ A bitfield determining all navigation layers the region belongs to. These naviga .. rst-class:: classref-property-setget -- void **set_navigation_polygon** **(** :ref:`NavigationPolygon` value **)** -- :ref:`NavigationPolygon` **get_navigation_polygon** **(** **)** +- |void| **set_navigation_polygon**\ (\ value\: :ref:`NavigationPolygon`\ ) +- :ref:`NavigationPolygon` **get_navigation_polygon**\ (\ ) The :ref:`NavigationPolygon` resource to use. @@ -248,8 +248,8 @@ The :ref:`NavigationPolygon` resource to use. .. rst-class:: classref-property-setget -- void **set_travel_cost** **(** :ref:`float` value **)** -- :ref:`float` **get_travel_cost** **(** **)** +- |void| **set_travel_cost**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_travel_cost**\ (\ ) When pathfinding moves inside this region's navigation mesh the traveled distances are multiplied with :ref:`travel_cost` for determining the shortest path. @@ -265,8 +265,8 @@ When pathfinding moves inside this region's navigation mesh the traveled distanc .. rst-class:: classref-property-setget -- void **set_use_edge_connections** **(** :ref:`bool` value **)** -- :ref:`bool` **get_use_edge_connections** **(** **)** +- |void| **set_use_edge_connections**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_edge_connections**\ (\ ) If enabled the navigation region will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -283,7 +283,7 @@ Method Descriptions .. rst-class:: classref-method -void **bake_navigation_polygon** **(** :ref:`bool` on_thread=true **)** +|void| **bake_navigation_polygon**\ (\ on_thread\: :ref:`bool` = true\ ) Bakes the :ref:`NavigationPolygon`. If ``on_thread`` is set to ``true`` (default), the baking is done on a separate thread. @@ -295,7 +295,7 @@ Bakes the :ref:`NavigationPolygon`. If ``on_thread`` is .. rst-class:: classref-method -:ref:`bool` **get_avoidance_layer_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_avoidance_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`avoidance_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -307,7 +307,7 @@ Returns whether or not the specified layer of the :ref:`avoidance_layers` **get_navigation_layer_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`navigation_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -319,7 +319,7 @@ Returns whether or not the specified layer of the :ref:`navigation_layers` **get_navigation_map** **(** **)** |const| +:ref:`RID` **get_navigation_map**\ (\ ) |const| Returns the current navigation map :ref:`RID` used by this region. @@ -331,7 +331,7 @@ Returns the current navigation map :ref:`RID` used by this region. .. rst-class:: classref-method -:ref:`RID` **get_region_rid** **(** **)** |const| +:ref:`RID` **get_region_rid**\ (\ ) |const| **Deprecated:** Use :ref:`get_rid` instead. @@ -345,7 +345,7 @@ Returns the :ref:`RID` of this region on the :ref:`NavigationServer2D .. rst-class:: classref-method -:ref:`RID` **get_rid** **(** **)** |const| +:ref:`RID` **get_rid**\ (\ ) |const| Returns the :ref:`RID` of this region on the :ref:`NavigationServer2D`. Combined with :ref:`NavigationServer2D.map_get_closest_point_owner` can be used to identify the **NavigationRegion2D** closest to a point on the merged navigation map. @@ -357,7 +357,7 @@ Returns the :ref:`RID` of this region on the :ref:`NavigationServer2D .. rst-class:: classref-method -:ref:`bool` **is_baking** **(** **)** |const| +:ref:`bool` **is_baking**\ (\ ) |const| Returns ``true`` when the :ref:`NavigationPolygon` is being baked on a background thread. @@ -369,7 +369,7 @@ Returns ``true`` when the :ref:`NavigationPolygon` is b .. rst-class:: classref-method -void **set_avoidance_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_avoidance_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`avoidance_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -381,7 +381,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`avoidan .. rst-class:: classref-method -void **set_navigation_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`navigation_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -393,7 +393,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`navigat .. rst-class:: classref-method -void **set_navigation_map** **(** :ref:`RID` navigation_map **)** +|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) Sets the :ref:`RID` of the navigation map this region should use. By default the region will automatically join the :ref:`World2D` default navigation map so this function is only required to override the default map. @@ -404,3 +404,4 @@ Sets the :ref:`RID` of the navigation map this region should use. By .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationregion3d.rst b/classes/class_navigationregion3d.rst index 27493e5e6cc..813ed23b6be 100644 --- a/classes/class_navigationregion3d.rst +++ b/classes/class_navigationregion3d.rst @@ -72,23 +72,23 @@ Methods .. table:: :widths: auto - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`bake_navigation_mesh` **(** :ref:`bool` on_thread=true **)** | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_navigation_layer_value` **(** :ref:`int` layer_number **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_navigation_map` **(** **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_region_rid` **(** **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_baking` **(** **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_navigation_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_navigation_map` **(** :ref:`RID` navigation_map **)** | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bake_navigation_mesh`\ (\ on_thread\: :ref:`bool` = true\ ) | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_navigation_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_navigation_map`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_region_rid`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_baking`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_navigation_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_navigation_map`\ (\ navigation_map\: :ref:`RID`\ ) | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -103,7 +103,7 @@ Signals .. rst-class:: classref-signal -**bake_finished** **(** **)** +**bake_finished**\ (\ ) Notifies when the navigation mesh bake operation is completed. @@ -115,7 +115,7 @@ Notifies when the navigation mesh bake operation is completed. .. rst-class:: classref-signal -**navigation_mesh_changed** **(** **)** +**navigation_mesh_changed**\ (\ ) Notifies when the :ref:`NavigationMesh` has changed. @@ -136,8 +136,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_enabled** **(** **)** +- |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_enabled**\ (\ ) Determines if the **NavigationRegion3D** is enabled or disabled. @@ -153,8 +153,8 @@ Determines if the **NavigationRegion3D** is enabled or disabled. .. rst-class:: classref-property-setget -- void **set_enter_cost** **(** :ref:`float` value **)** -- :ref:`float` **get_enter_cost** **(** **)** +- |void| **set_enter_cost**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_enter_cost**\ (\ ) When pathfinding enters this region's navigation mesh from another regions navigation mesh the :ref:`enter_cost` value is added to the path distance for determining the shortest path. @@ -170,8 +170,8 @@ When pathfinding enters this region's navigation mesh from another regions navig .. rst-class:: classref-property-setget -- void **set_navigation_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_navigation_layers** **(** **)** +- |void| **set_navigation_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_navigation_layers**\ (\ ) A bitfield determining all navigation layers the region belongs to. These navigation layers can be checked upon when requesting a path with :ref:`NavigationServer3D.map_get_path`. @@ -187,8 +187,8 @@ A bitfield determining all navigation layers the region belongs to. These naviga .. rst-class:: classref-property-setget -- void **set_navigation_mesh** **(** :ref:`NavigationMesh` value **)** -- :ref:`NavigationMesh` **get_navigation_mesh** **(** **)** +- |void| **set_navigation_mesh**\ (\ value\: :ref:`NavigationMesh`\ ) +- :ref:`NavigationMesh` **get_navigation_mesh**\ (\ ) The :ref:`NavigationMesh` resource to use. @@ -204,8 +204,8 @@ The :ref:`NavigationMesh` resource to use. .. rst-class:: classref-property-setget -- void **set_travel_cost** **(** :ref:`float` value **)** -- :ref:`float` **get_travel_cost** **(** **)** +- |void| **set_travel_cost**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_travel_cost**\ (\ ) When pathfinding moves inside this region's navigation mesh the traveled distances are multiplied with :ref:`travel_cost` for determining the shortest path. @@ -221,8 +221,8 @@ When pathfinding moves inside this region's navigation mesh the traveled distanc .. rst-class:: classref-property-setget -- void **set_use_edge_connections** **(** :ref:`bool` value **)** -- :ref:`bool` **get_use_edge_connections** **(** **)** +- |void| **set_use_edge_connections**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_edge_connections**\ (\ ) If enabled the navigation region will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -239,7 +239,7 @@ Method Descriptions .. rst-class:: classref-method -void **bake_navigation_mesh** **(** :ref:`bool` on_thread=true **)** +|void| **bake_navigation_mesh**\ (\ on_thread\: :ref:`bool` = true\ ) Bakes the :ref:`NavigationMesh`. If ``on_thread`` is set to ``true`` (default), the baking is done on a separate thread. Baking on separate thread is useful because navigation baking is not a cheap operation. When it is completed, it automatically sets the new :ref:`NavigationMesh`. Please note that baking on separate thread may be very slow if geometry is parsed from meshes as async access to each mesh involves heavy synchronization. Also, please note that baking on a separate thread is automatically disabled on operating systems that cannot use threads (such as Web with threads disabled). @@ -251,7 +251,7 @@ Bakes the :ref:`NavigationMesh`. If ``on_thread`` is set t .. rst-class:: classref-method -:ref:`bool` **get_navigation_layer_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_navigation_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`navigation_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. @@ -263,7 +263,7 @@ Returns whether or not the specified layer of the :ref:`navigation_layers` **get_navigation_map** **(** **)** |const| +:ref:`RID` **get_navigation_map**\ (\ ) |const| Returns the current navigation map :ref:`RID` used by this region. @@ -275,7 +275,7 @@ Returns the current navigation map :ref:`RID` used by this region. .. rst-class:: classref-method -:ref:`RID` **get_region_rid** **(** **)** |const| +:ref:`RID` **get_region_rid**\ (\ ) |const| **Deprecated:** Use :ref:`get_rid` instead. @@ -289,7 +289,7 @@ Returns the :ref:`RID` of this region on the :ref:`NavigationServer3D .. rst-class:: classref-method -:ref:`RID` **get_rid** **(** **)** |const| +:ref:`RID` **get_rid**\ (\ ) |const| Returns the :ref:`RID` of this region on the :ref:`NavigationServer3D`. Combined with :ref:`NavigationServer3D.map_get_closest_point_owner` can be used to identify the **NavigationRegion3D** closest to a point on the merged navigation map. @@ -301,7 +301,7 @@ Returns the :ref:`RID` of this region on the :ref:`NavigationServer3D .. rst-class:: classref-method -:ref:`bool` **is_baking** **(** **)** |const| +:ref:`bool` **is_baking**\ (\ ) |const| Returns ``true`` when the :ref:`NavigationMesh` is being baked on a background thread. @@ -313,7 +313,7 @@ Returns ``true`` when the :ref:`NavigationMesh` is being b .. rst-class:: classref-method -void **set_navigation_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_navigation_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`navigation_layers` bitmask, given a ``layer_number`` between 1 and 32. @@ -325,7 +325,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`navigat .. rst-class:: classref-method -void **set_navigation_map** **(** :ref:`RID` navigation_map **)** +|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID`\ ) Sets the :ref:`RID` of the navigation map this region should use. By default the region will automatically join the :ref:`World3D` default navigation map so this function is only required to override the default map. @@ -336,3 +336,4 @@ Sets the :ref:`RID` of the navigation map this region should use. By .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationserver2d.rst b/classes/class_navigationserver2d.rst index 70ce112db5a..dd08d0571dc 100644 --- a/classes/class_navigationserver2d.rst +++ b/classes/class_navigationserver2d.rst @@ -54,249 +54,251 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`agent_create` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`agent_get_avoidance_enabled` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`agent_get_avoidance_layers` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`agent_get_avoidance_mask` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`agent_get_avoidance_priority` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`agent_get_map` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`agent_get_max_neighbors` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`agent_get_max_speed` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`agent_get_neighbor_distance` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`agent_get_paused` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`agent_get_position` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`agent_get_radius` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`agent_get_time_horizon_agents` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`agent_get_time_horizon_obstacles` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`agent_get_velocity` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`agent_has_avoidance_callback` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`agent_is_map_changed` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_avoidance_callback` **(** :ref:`RID` agent, :ref:`Callable` callback **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_avoidance_enabled` **(** :ref:`RID` agent, :ref:`bool` enabled **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_avoidance_layers` **(** :ref:`RID` agent, :ref:`int` layers **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_avoidance_mask` **(** :ref:`RID` agent, :ref:`int` mask **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_avoidance_priority` **(** :ref:`RID` agent, :ref:`float` priority **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_map` **(** :ref:`RID` agent, :ref:`RID` map **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_max_neighbors` **(** :ref:`RID` agent, :ref:`int` count **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_max_speed` **(** :ref:`RID` agent, :ref:`float` max_speed **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_neighbor_distance` **(** :ref:`RID` agent, :ref:`float` distance **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_paused` **(** :ref:`RID` agent, :ref:`bool` paused **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_position` **(** :ref:`RID` agent, :ref:`Vector2` position **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_radius` **(** :ref:`RID` agent, :ref:`float` radius **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_time_horizon_agents` **(** :ref:`RID` agent, :ref:`float` time_horizon **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_time_horizon_obstacles` **(** :ref:`RID` agent, :ref:`float` time_horizon **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_velocity` **(** :ref:`RID` agent, :ref:`Vector2` velocity **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_velocity_forced` **(** :ref:`RID` agent, :ref:`Vector2` velocity **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`bake_from_source_geometry_data` **(** :ref:`NavigationPolygon` navigation_polygon, :ref:`NavigationMeshSourceGeometryData2D` source_geometry_data, :ref:`Callable` callback=Callable() **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`bake_from_source_geometry_data_async` **(** :ref:`NavigationPolygon` navigation_polygon, :ref:`NavigationMeshSourceGeometryData2D` source_geometry_data, :ref:`Callable` callback=Callable() **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`free_rid` **(** :ref:`RID` rid **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_debug_enabled` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`get_maps` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_baking_navigation_polygon` **(** :ref:`NavigationPolygon` navigation_polygon **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`link_create` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`link_get_enabled` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`link_get_end_position` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`link_get_enter_cost` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`link_get_map` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`link_get_navigation_layers` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`link_get_owner_id` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`link_get_start_position` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`link_get_travel_cost` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`link_is_bidirectional` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_bidirectional` **(** :ref:`RID` link, :ref:`bool` bidirectional **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_enabled` **(** :ref:`RID` link, :ref:`bool` enabled **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_end_position` **(** :ref:`RID` link, :ref:`Vector2` position **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_enter_cost` **(** :ref:`RID` link, :ref:`float` enter_cost **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_map` **(** :ref:`RID` link, :ref:`RID` map **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_navigation_layers` **(** :ref:`RID` link, :ref:`int` navigation_layers **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_owner_id` **(** :ref:`RID` link, :ref:`int` owner_id **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_start_position` **(** :ref:`RID` link, :ref:`Vector2` position **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_travel_cost` **(** :ref:`RID` link, :ref:`float` travel_cost **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`map_create` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_force_update` **(** :ref:`RID` map **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`map_get_agents` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`map_get_cell_size` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`map_get_closest_point` **(** :ref:`RID` map, :ref:`Vector2` to_point **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`map_get_closest_point_owner` **(** :ref:`RID` map, :ref:`Vector2` to_point **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`map_get_edge_connection_margin` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`map_get_link_connection_radius` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`map_get_links` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`map_get_obstacles` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`map_get_path` **(** :ref:`RID` map, :ref:`Vector2` origin, :ref:`Vector2` destination, :ref:`bool` optimize, :ref:`int` navigation_layers=1 **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`map_get_random_point` **(** :ref:`RID` map, :ref:`int` navigation_layers, :ref:`bool` uniformly **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`map_get_regions` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`map_get_use_edge_connections` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`map_is_active` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_set_active` **(** :ref:`RID` map, :ref:`bool` active **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_set_cell_size` **(** :ref:`RID` map, :ref:`float` cell_size **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_set_edge_connection_margin` **(** :ref:`RID` map, :ref:`float` margin **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_set_link_connection_radius` **(** :ref:`RID` map, :ref:`float` radius **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_set_use_edge_connections` **(** :ref:`RID` map, :ref:`bool` enabled **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`obstacle_create` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`obstacle_get_avoidance_enabled` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`obstacle_get_avoidance_layers` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`obstacle_get_map` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`obstacle_get_paused` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`obstacle_get_position` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`obstacle_get_radius` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`obstacle_get_velocity` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`obstacle_get_vertices` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_avoidance_enabled` **(** :ref:`RID` obstacle, :ref:`bool` enabled **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_avoidance_layers` **(** :ref:`RID` obstacle, :ref:`int` layers **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_map` **(** :ref:`RID` obstacle, :ref:`RID` map **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_paused` **(** :ref:`RID` obstacle, :ref:`bool` paused **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_position` **(** :ref:`RID` obstacle, :ref:`Vector2` position **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_radius` **(** :ref:`RID` obstacle, :ref:`float` radius **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_velocity` **(** :ref:`RID` obstacle, :ref:`Vector2` velocity **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_vertices` **(** :ref:`RID` obstacle, :ref:`PackedVector2Array` vertices **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`parse_source_geometry_data` **(** :ref:`NavigationPolygon` navigation_polygon, :ref:`NavigationMeshSourceGeometryData2D` source_geometry_data, :ref:`Node` root_node, :ref:`Callable` callback=Callable() **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`query_path` **(** :ref:`NavigationPathQueryParameters2D` parameters, :ref:`NavigationPathQueryResult2D` result **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`region_create` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`region_get_connection_pathway_end` **(** :ref:`RID` region, :ref:`int` connection **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`region_get_connection_pathway_start` **(** :ref:`RID` region, :ref:`int` connection **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`region_get_connections_count` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`region_get_enabled` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`region_get_enter_cost` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`region_get_map` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`region_get_navigation_layers` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`region_get_owner_id` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`region_get_random_point` **(** :ref:`RID` region, :ref:`int` navigation_layers, :ref:`bool` uniformly **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`region_get_transform` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`region_get_travel_cost` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`region_get_use_edge_connections` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`region_owns_point` **(** :ref:`RID` region, :ref:`Vector2` point **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_enabled` **(** :ref:`RID` region, :ref:`bool` enabled **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_enter_cost` **(** :ref:`RID` region, :ref:`float` enter_cost **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_map` **(** :ref:`RID` region, :ref:`RID` map **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_navigation_layers` **(** :ref:`RID` region, :ref:`int` navigation_layers **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_navigation_polygon` **(** :ref:`RID` region, :ref:`NavigationPolygon` navigation_polygon **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_owner_id` **(** :ref:`RID` region, :ref:`int` owner_id **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_transform` **(** :ref:`RID` region, :ref:`Transform2D` transform **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_travel_cost` **(** :ref:`RID` region, :ref:`float` travel_cost **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_use_edge_connections` **(** :ref:`RID` region, :ref:`bool` enabled **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_debug_enabled` **(** :ref:`bool` enabled **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`agent_create`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`agent_get_avoidance_enabled`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`agent_get_avoidance_layers`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`agent_get_avoidance_mask`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`agent_get_avoidance_priority`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`agent_get_map`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`agent_get_max_neighbors`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`agent_get_max_speed`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`agent_get_neighbor_distance`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`agent_get_paused`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`agent_get_position`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`agent_get_radius`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`agent_get_time_horizon_agents`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`agent_get_time_horizon_obstacles`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`agent_get_velocity`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`agent_has_avoidance_callback`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`agent_is_map_changed`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_avoidance_callback`\ (\ agent\: :ref:`RID`, callback\: :ref:`Callable`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_avoidance_enabled`\ (\ agent\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_avoidance_layers`\ (\ agent\: :ref:`RID`, layers\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_avoidance_mask`\ (\ agent\: :ref:`RID`, mask\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_avoidance_priority`\ (\ agent\: :ref:`RID`, priority\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_map`\ (\ agent\: :ref:`RID`, map\: :ref:`RID`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_max_neighbors`\ (\ agent\: :ref:`RID`, count\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_max_speed`\ (\ agent\: :ref:`RID`, max_speed\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_neighbor_distance`\ (\ agent\: :ref:`RID`, distance\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_paused`\ (\ agent\: :ref:`RID`, paused\: :ref:`bool`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_position`\ (\ agent\: :ref:`RID`, position\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_radius`\ (\ agent\: :ref:`RID`, radius\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_time_horizon_agents`\ (\ agent\: :ref:`RID`, time_horizon\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_time_horizon_obstacles`\ (\ agent\: :ref:`RID`, time_horizon\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_velocity`\ (\ agent\: :ref:`RID`, velocity\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_velocity_forced`\ (\ agent\: :ref:`RID`, velocity\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bake_from_source_geometry_data`\ (\ navigation_polygon\: :ref:`NavigationPolygon`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData2D`, callback\: :ref:`Callable` = Callable()\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bake_from_source_geometry_data_async`\ (\ navigation_polygon\: :ref:`NavigationPolygon`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData2D`, callback\: :ref:`Callable` = Callable()\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`free_rid`\ (\ rid\: :ref:`RID`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_debug_enabled`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`get_maps`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_baking_navigation_polygon`\ (\ navigation_polygon\: :ref:`NavigationPolygon`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`link_create`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`link_get_enabled`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`link_get_end_position`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`link_get_enter_cost`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`link_get_map`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`link_get_navigation_layers`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`link_get_owner_id`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`link_get_start_position`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`link_get_travel_cost`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`link_is_bidirectional`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`link_set_bidirectional`\ (\ link\: :ref:`RID`, bidirectional\: :ref:`bool`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`link_set_enabled`\ (\ link\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`link_set_end_position`\ (\ link\: :ref:`RID`, position\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`link_set_enter_cost`\ (\ link\: :ref:`RID`, enter_cost\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`link_set_map`\ (\ link\: :ref:`RID`, map\: :ref:`RID`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`link_set_navigation_layers`\ (\ link\: :ref:`RID`, navigation_layers\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`link_set_owner_id`\ (\ link\: :ref:`RID`, owner_id\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`link_set_start_position`\ (\ link\: :ref:`RID`, position\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`link_set_travel_cost`\ (\ link\: :ref:`RID`, travel_cost\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`map_create`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`map_force_update`\ (\ map\: :ref:`RID`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`map_get_agents`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`map_get_cell_size`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`map_get_closest_point`\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector2`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`map_get_closest_point_owner`\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector2`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`map_get_edge_connection_margin`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`map_get_iteration_id`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`map_get_link_connection_radius`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`map_get_links`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`map_get_obstacles`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`map_get_path`\ (\ map\: :ref:`RID`, origin\: :ref:`Vector2`, destination\: :ref:`Vector2`, optimize\: :ref:`bool`, navigation_layers\: :ref:`int` = 1\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`map_get_random_point`\ (\ map\: :ref:`RID`, navigation_layers\: :ref:`int`, uniformly\: :ref:`bool`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`map_get_regions`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`map_get_use_edge_connections`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`map_is_active`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`map_set_active`\ (\ map\: :ref:`RID`, active\: :ref:`bool`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`map_set_cell_size`\ (\ map\: :ref:`RID`, cell_size\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`map_set_edge_connection_margin`\ (\ map\: :ref:`RID`, margin\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`map_set_link_connection_radius`\ (\ map\: :ref:`RID`, radius\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`map_set_use_edge_connections`\ (\ map\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`obstacle_create`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`obstacle_get_avoidance_enabled`\ (\ obstacle\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`obstacle_get_avoidance_layers`\ (\ obstacle\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`obstacle_get_map`\ (\ obstacle\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`obstacle_get_paused`\ (\ obstacle\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`obstacle_get_position`\ (\ obstacle\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`obstacle_get_radius`\ (\ obstacle\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`obstacle_get_velocity`\ (\ obstacle\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`obstacle_get_vertices`\ (\ obstacle\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`obstacle_set_avoidance_enabled`\ (\ obstacle\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`obstacle_set_avoidance_layers`\ (\ obstacle\: :ref:`RID`, layers\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`obstacle_set_map`\ (\ obstacle\: :ref:`RID`, map\: :ref:`RID`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`obstacle_set_paused`\ (\ obstacle\: :ref:`RID`, paused\: :ref:`bool`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`obstacle_set_position`\ (\ obstacle\: :ref:`RID`, position\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`obstacle_set_radius`\ (\ obstacle\: :ref:`RID`, radius\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`obstacle_set_velocity`\ (\ obstacle\: :ref:`RID`, velocity\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`obstacle_set_vertices`\ (\ obstacle\: :ref:`RID`, vertices\: :ref:`PackedVector2Array`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`parse_source_geometry_data`\ (\ navigation_polygon\: :ref:`NavigationPolygon`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData2D`, root_node\: :ref:`Node`, callback\: :ref:`Callable` = Callable()\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`query_path`\ (\ parameters\: :ref:`NavigationPathQueryParameters2D`, result\: :ref:`NavigationPathQueryResult2D`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`region_create`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`region_get_connection_pathway_end`\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`region_get_connection_pathway_start`\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`region_get_connections_count`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`region_get_enabled`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`region_get_enter_cost`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`region_get_map`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`region_get_navigation_layers`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`region_get_owner_id`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`region_get_random_point`\ (\ region\: :ref:`RID`, navigation_layers\: :ref:`int`, uniformly\: :ref:`bool`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`region_get_transform`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`region_get_travel_cost`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`region_get_use_edge_connections`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`region_owns_point`\ (\ region\: :ref:`RID`, point\: :ref:`Vector2`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_enabled`\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_enter_cost`\ (\ region\: :ref:`RID`, enter_cost\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_map`\ (\ region\: :ref:`RID`, map\: :ref:`RID`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_navigation_layers`\ (\ region\: :ref:`RID`, navigation_layers\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_navigation_polygon`\ (\ region\: :ref:`RID`, navigation_polygon\: :ref:`NavigationPolygon`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_owner_id`\ (\ region\: :ref:`RID`, owner_id\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_transform`\ (\ region\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_travel_cost`\ (\ region\: :ref:`RID`, travel_cost\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_use_edge_connections`\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_debug_enabled`\ (\ enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -311,7 +313,7 @@ Signals .. rst-class:: classref-signal -**map_changed** **(** :ref:`RID` map **)** +**map_changed**\ (\ map\: :ref:`RID`\ ) Emitted when a navigation map is updated, when a region moves or is modified. @@ -323,7 +325,7 @@ Emitted when a navigation map is updated, when a region moves or is modified. .. rst-class:: classref-signal -**navigation_debug_changed** **(** **)** +**navigation_debug_changed**\ (\ ) Emitted when navigation debug settings are changed. Only available in debug builds. @@ -340,7 +342,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **agent_create** **(** **)** +:ref:`RID` **agent_create**\ (\ ) Creates the agent. @@ -352,7 +354,7 @@ Creates the agent. .. rst-class:: classref-method -:ref:`bool` **agent_get_avoidance_enabled** **(** :ref:`RID` agent **)** |const| +:ref:`bool` **agent_get_avoidance_enabled**\ (\ agent\: :ref:`RID`\ ) |const| Return ``true`` if the specified ``agent`` uses avoidance. @@ -364,7 +366,7 @@ Return ``true`` if the specified ``agent`` uses avoidance. .. rst-class:: classref-method -:ref:`int` **agent_get_avoidance_layers** **(** :ref:`RID` agent **)** |const| +:ref:`int` **agent_get_avoidance_layers**\ (\ agent\: :ref:`RID`\ ) |const| Returns the ``avoidance_layers`` bitmask of the specified ``agent``. @@ -376,7 +378,7 @@ Returns the ``avoidance_layers`` bitmask of the specified ``agent``. .. rst-class:: classref-method -:ref:`int` **agent_get_avoidance_mask** **(** :ref:`RID` agent **)** |const| +:ref:`int` **agent_get_avoidance_mask**\ (\ agent\: :ref:`RID`\ ) |const| Returns the ``avoidance_mask`` bitmask of the specified ``agent``. @@ -388,7 +390,7 @@ Returns the ``avoidance_mask`` bitmask of the specified ``agent``. .. rst-class:: classref-method -:ref:`float` **agent_get_avoidance_priority** **(** :ref:`RID` agent **)** |const| +:ref:`float` **agent_get_avoidance_priority**\ (\ agent\: :ref:`RID`\ ) |const| Returns the ``avoidance_priority`` of the specified ``agent``. @@ -400,7 +402,7 @@ Returns the ``avoidance_priority`` of the specified ``agent``. .. rst-class:: classref-method -:ref:`RID` **agent_get_map** **(** :ref:`RID` agent **)** |const| +:ref:`RID` **agent_get_map**\ (\ agent\: :ref:`RID`\ ) |const| Returns the navigation map :ref:`RID` the requested ``agent`` is currently assigned to. @@ -412,7 +414,7 @@ Returns the navigation map :ref:`RID` the requested ``agent`` is curr .. rst-class:: classref-method -:ref:`int` **agent_get_max_neighbors** **(** :ref:`RID` agent **)** |const| +:ref:`int` **agent_get_max_neighbors**\ (\ agent\: :ref:`RID`\ ) |const| Returns the maximum number of other agents the specified ``agent`` takes into account in the navigation. @@ -424,7 +426,7 @@ Returns the maximum number of other agents the specified ``agent`` takes into ac .. rst-class:: classref-method -:ref:`float` **agent_get_max_speed** **(** :ref:`RID` agent **)** |const| +:ref:`float` **agent_get_max_speed**\ (\ agent\: :ref:`RID`\ ) |const| Returns the maximum speed of the specified ``agent``. @@ -436,7 +438,7 @@ Returns the maximum speed of the specified ``agent``. .. rst-class:: classref-method -:ref:`float` **agent_get_neighbor_distance** **(** :ref:`RID` agent **)** |const| +:ref:`float` **agent_get_neighbor_distance**\ (\ agent\: :ref:`RID`\ ) |const| Returns the maximum distance to other agents the specified ``agent`` takes into account in the navigation. @@ -448,7 +450,7 @@ Returns the maximum distance to other agents the specified ``agent`` takes into .. rst-class:: classref-method -:ref:`bool` **agent_get_paused** **(** :ref:`RID` agent **)** |const| +:ref:`bool` **agent_get_paused**\ (\ agent\: :ref:`RID`\ ) |const| Returns ``true`` if the specified ``agent`` is paused. @@ -460,7 +462,7 @@ Returns ``true`` if the specified ``agent`` is paused. .. rst-class:: classref-method -:ref:`Vector2` **agent_get_position** **(** :ref:`RID` agent **)** |const| +:ref:`Vector2` **agent_get_position**\ (\ agent\: :ref:`RID`\ ) |const| Returns the position of the specified ``agent`` in world space. @@ -472,7 +474,7 @@ Returns the position of the specified ``agent`` in world space. .. rst-class:: classref-method -:ref:`float` **agent_get_radius** **(** :ref:`RID` agent **)** |const| +:ref:`float` **agent_get_radius**\ (\ agent\: :ref:`RID`\ ) |const| Returns the radius of the specified ``agent``. @@ -484,7 +486,7 @@ Returns the radius of the specified ``agent``. .. rst-class:: classref-method -:ref:`float` **agent_get_time_horizon_agents** **(** :ref:`RID` agent **)** |const| +:ref:`float` **agent_get_time_horizon_agents**\ (\ agent\: :ref:`RID`\ ) |const| Returns the minimal amount of time for which the specified ``agent``'s velocities that are computed by the simulation are safe with respect to other agents. @@ -496,7 +498,7 @@ Returns the minimal amount of time for which the specified ``agent``'s velocitie .. rst-class:: classref-method -:ref:`float` **agent_get_time_horizon_obstacles** **(** :ref:`RID` agent **)** |const| +:ref:`float` **agent_get_time_horizon_obstacles**\ (\ agent\: :ref:`RID`\ ) |const| Returns the minimal amount of time for which the specified ``agent``'s velocities that are computed by the simulation are safe with respect to static avoidance obstacles. @@ -508,7 +510,7 @@ Returns the minimal amount of time for which the specified ``agent``'s velocitie .. rst-class:: classref-method -:ref:`Vector2` **agent_get_velocity** **(** :ref:`RID` agent **)** |const| +:ref:`Vector2` **agent_get_velocity**\ (\ agent\: :ref:`RID`\ ) |const| Returns the velocity of the specified ``agent``. @@ -520,7 +522,7 @@ Returns the velocity of the specified ``agent``. .. rst-class:: classref-method -:ref:`bool` **agent_has_avoidance_callback** **(** :ref:`RID` agent **)** |const| +:ref:`bool` **agent_has_avoidance_callback**\ (\ agent\: :ref:`RID`\ ) |const| Return ``true`` if the specified ``agent`` has an avoidance callback. @@ -532,7 +534,7 @@ Return ``true`` if the specified ``agent`` has an avoidance callback. .. rst-class:: classref-method -:ref:`bool` **agent_is_map_changed** **(** :ref:`RID` agent **)** |const| +:ref:`bool` **agent_is_map_changed**\ (\ agent\: :ref:`RID`\ ) |const| Returns true if the map got changed the previous frame. @@ -544,7 +546,7 @@ Returns true if the map got changed the previous frame. .. rst-class:: classref-method -void **agent_set_avoidance_callback** **(** :ref:`RID` agent, :ref:`Callable` callback **)** +|void| **agent_set_avoidance_callback**\ (\ agent\: :ref:`RID`, callback\: :ref:`Callable`\ ) Sets the callback :ref:`Callable` that gets called after each avoidance processing step for the ``agent``. The calculated ``safe_velocity`` will be dispatched with a signal to the object just before the physics calculations. @@ -558,7 +560,7 @@ Sets the callback :ref:`Callable` that gets called after each av .. rst-class:: classref-method -void **agent_set_avoidance_enabled** **(** :ref:`RID` agent, :ref:`bool` enabled **)** +|void| **agent_set_avoidance_enabled**\ (\ agent\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``enabled`` is ``true``, the specified ``agent`` uses avoidance. @@ -570,7 +572,7 @@ If ``enabled`` is ``true``, the specified ``agent`` uses avoidance. .. rst-class:: classref-method -void **agent_set_avoidance_layers** **(** :ref:`RID` agent, :ref:`int` layers **)** +|void| **agent_set_avoidance_layers**\ (\ agent\: :ref:`RID`, layers\: :ref:`int`\ ) Set the agent's ``avoidance_layers`` bitmask. @@ -582,7 +584,7 @@ Set the agent's ``avoidance_layers`` bitmask. .. rst-class:: classref-method -void **agent_set_avoidance_mask** **(** :ref:`RID` agent, :ref:`int` mask **)** +|void| **agent_set_avoidance_mask**\ (\ agent\: :ref:`RID`, mask\: :ref:`int`\ ) Set the agent's ``avoidance_mask`` bitmask. @@ -594,7 +596,7 @@ Set the agent's ``avoidance_mask`` bitmask. .. rst-class:: classref-method -void **agent_set_avoidance_priority** **(** :ref:`RID` agent, :ref:`float` priority **)** +|void| **agent_set_avoidance_priority**\ (\ agent\: :ref:`RID`, priority\: :ref:`float`\ ) Set the agent's ``avoidance_priority`` with a ``priority`` between 0.0 (lowest priority) to 1.0 (highest priority). @@ -608,7 +610,7 @@ The specified ``agent`` does not adjust the velocity for other agents that would .. rst-class:: classref-method -void **agent_set_map** **(** :ref:`RID` agent, :ref:`RID` map **)** +|void| **agent_set_map**\ (\ agent\: :ref:`RID`, map\: :ref:`RID`\ ) Puts the agent in the map. @@ -620,7 +622,7 @@ Puts the agent in the map. .. rst-class:: classref-method -void **agent_set_max_neighbors** **(** :ref:`RID` agent, :ref:`int` count **)** +|void| **agent_set_max_neighbors**\ (\ agent\: :ref:`RID`, count\: :ref:`int`\ ) Sets the maximum number of other agents the agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. @@ -632,7 +634,7 @@ Sets the maximum number of other agents the agent takes into account in the navi .. rst-class:: classref-method -void **agent_set_max_speed** **(** :ref:`RID` agent, :ref:`float` max_speed **)** +|void| **agent_set_max_speed**\ (\ agent\: :ref:`RID`, max_speed\: :ref:`float`\ ) Sets the maximum speed of the agent. Must be positive. @@ -644,7 +646,7 @@ Sets the maximum speed of the agent. Must be positive. .. rst-class:: classref-method -void **agent_set_neighbor_distance** **(** :ref:`RID` agent, :ref:`float` distance **)** +|void| **agent_set_neighbor_distance**\ (\ agent\: :ref:`RID`, distance\: :ref:`float`\ ) Sets the maximum distance to other agents this agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. @@ -656,7 +658,7 @@ Sets the maximum distance to other agents this agent takes into account in the n .. rst-class:: classref-method -void **agent_set_paused** **(** :ref:`RID` agent, :ref:`bool` paused **)** +|void| **agent_set_paused**\ (\ agent\: :ref:`RID`, paused\: :ref:`bool`\ ) If ``paused`` is true the specified ``agent`` will not be processed, e.g. calculate avoidance velocities or receive avoidance callbacks. @@ -668,7 +670,7 @@ If ``paused`` is true the specified ``agent`` will not be processed, e.g. calcul .. rst-class:: classref-method -void **agent_set_position** **(** :ref:`RID` agent, :ref:`Vector2` position **)** +|void| **agent_set_position**\ (\ agent\: :ref:`RID`, position\: :ref:`Vector2`\ ) Sets the position of the agent in world space. @@ -680,7 +682,7 @@ Sets the position of the agent in world space. .. rst-class:: classref-method -void **agent_set_radius** **(** :ref:`RID` agent, :ref:`float` radius **)** +|void| **agent_set_radius**\ (\ agent\: :ref:`RID`, radius\: :ref:`float`\ ) Sets the radius of the agent. @@ -692,7 +694,7 @@ Sets the radius of the agent. .. rst-class:: classref-method -void **agent_set_time_horizon_agents** **(** :ref:`RID` agent, :ref:`float` time_horizon **)** +|void| **agent_set_time_horizon_agents**\ (\ agent\: :ref:`RID`, time_horizon\: :ref:`float`\ ) The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to other agents. The larger this number, the sooner this agent will respond to the presence of other agents, but the less freedom this agent has in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. @@ -704,7 +706,7 @@ The minimal amount of time for which the agent's velocities that are computed by .. rst-class:: classref-method -void **agent_set_time_horizon_obstacles** **(** :ref:`RID` agent, :ref:`float` time_horizon **)** +|void| **agent_set_time_horizon_obstacles**\ (\ agent\: :ref:`RID`, time_horizon\: :ref:`float`\ ) The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to static avoidance obstacles. The larger this number, the sooner this agent will respond to the presence of static avoidance obstacles, but the less freedom this agent has in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. @@ -716,7 +718,7 @@ The minimal amount of time for which the agent's velocities that are computed by .. rst-class:: classref-method -void **agent_set_velocity** **(** :ref:`RID` agent, :ref:`Vector2` velocity **)** +|void| **agent_set_velocity**\ (\ agent\: :ref:`RID`, velocity\: :ref:`Vector2`\ ) Sets ``velocity`` as the new wanted velocity for the specified ``agent``. The avoidance simulation will try to fulfill this velocity if possible but will modify it to avoid collision with other agent's and obstacles. When an agent is teleported to a new position far away use :ref:`agent_set_velocity_forced` instead to reset the internal velocity state. @@ -728,7 +730,7 @@ Sets ``velocity`` as the new wanted velocity for the specified ``agent``. The av .. rst-class:: classref-method -void **agent_set_velocity_forced** **(** :ref:`RID` agent, :ref:`Vector2` velocity **)** +|void| **agent_set_velocity_forced**\ (\ agent\: :ref:`RID`, velocity\: :ref:`Vector2`\ ) Replaces the internal velocity in the collision avoidance simulation with ``velocity`` for the specified ``agent``. When an agent is teleported to a new position far away this function should be used in the same frame. If called frequently this function can get agents stuck. @@ -740,7 +742,7 @@ Replaces the internal velocity in the collision avoidance simulation with ``velo .. rst-class:: classref-method -void **bake_from_source_geometry_data** **(** :ref:`NavigationPolygon` navigation_polygon, :ref:`NavigationMeshSourceGeometryData2D` source_geometry_data, :ref:`Callable` callback=Callable() **)** +|void| **bake_from_source_geometry_data**\ (\ navigation_polygon\: :ref:`NavigationPolygon`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData2D`, callback\: :ref:`Callable` = Callable()\ ) Bakes the provided ``navigation_polygon`` with the data from the provided ``source_geometry_data``. After the process is finished the optional ``callback`` will be called. @@ -752,7 +754,7 @@ Bakes the provided ``navigation_polygon`` with the data from the provided ``sour .. rst-class:: classref-method -void **bake_from_source_geometry_data_async** **(** :ref:`NavigationPolygon` navigation_polygon, :ref:`NavigationMeshSourceGeometryData2D` source_geometry_data, :ref:`Callable` callback=Callable() **)** +|void| **bake_from_source_geometry_data_async**\ (\ navigation_polygon\: :ref:`NavigationPolygon`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData2D`, callback\: :ref:`Callable` = Callable()\ ) Bakes the provided ``navigation_polygon`` with the data from the provided ``source_geometry_data`` as an async task running on a background thread. After the process is finished the optional ``callback`` will be called. @@ -764,7 +766,7 @@ Bakes the provided ``navigation_polygon`` with the data from the provided ``sour .. rst-class:: classref-method -void **free_rid** **(** :ref:`RID` rid **)** +|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) Destroys the given RID. @@ -776,7 +778,7 @@ Destroys the given RID. .. rst-class:: classref-method -:ref:`bool` **get_debug_enabled** **(** **)** |const| +:ref:`bool` **get_debug_enabled**\ (\ ) |const| Returns ``true`` when the NavigationServer has debug enabled. @@ -788,7 +790,7 @@ Returns ``true`` when the NavigationServer has debug enabled. .. rst-class:: classref-method -:ref:`RID[]` **get_maps** **(** **)** |const| +:ref:`Array`\[:ref:`RID`\] **get_maps**\ (\ ) |const| Returns all created navigation map :ref:`RID`\ s on the NavigationServer. This returns both 2D and 3D created navigation maps as there is technically no distinction between them. @@ -800,7 +802,7 @@ Returns all created navigation map :ref:`RID`\ s on the NavigationSer .. rst-class:: classref-method -:ref:`bool` **is_baking_navigation_polygon** **(** :ref:`NavigationPolygon` navigation_polygon **)** |const| +:ref:`bool` **is_baking_navigation_polygon**\ (\ navigation_polygon\: :ref:`NavigationPolygon`\ ) |const| Returns ``true`` when the provided navigation polygon is being baked on a background thread. @@ -812,7 +814,7 @@ Returns ``true`` when the provided navigation polygon is being baked on a backgr .. rst-class:: classref-method -:ref:`RID` **link_create** **(** **)** +:ref:`RID` **link_create**\ (\ ) Create a new link between two positions on a map. @@ -824,7 +826,7 @@ Create a new link between two positions on a map. .. rst-class:: classref-method -:ref:`bool` **link_get_enabled** **(** :ref:`RID` link **)** |const| +:ref:`bool` **link_get_enabled**\ (\ link\: :ref:`RID`\ ) |const| Returns ``true`` if the specified ``link`` is enabled. @@ -836,7 +838,7 @@ Returns ``true`` if the specified ``link`` is enabled. .. rst-class:: classref-method -:ref:`Vector2` **link_get_end_position** **(** :ref:`RID` link **)** |const| +:ref:`Vector2` **link_get_end_position**\ (\ link\: :ref:`RID`\ ) |const| Returns the ending position of this ``link``. @@ -848,7 +850,7 @@ Returns the ending position of this ``link``. .. rst-class:: classref-method -:ref:`float` **link_get_enter_cost** **(** :ref:`RID` link **)** |const| +:ref:`float` **link_get_enter_cost**\ (\ link\: :ref:`RID`\ ) |const| Returns the enter cost of this ``link``. @@ -860,7 +862,7 @@ Returns the enter cost of this ``link``. .. rst-class:: classref-method -:ref:`RID` **link_get_map** **(** :ref:`RID` link **)** |const| +:ref:`RID` **link_get_map**\ (\ link\: :ref:`RID`\ ) |const| Returns the navigation map :ref:`RID` the requested ``link`` is currently assigned to. @@ -872,7 +874,7 @@ Returns the navigation map :ref:`RID` the requested ``link`` is curre .. rst-class:: classref-method -:ref:`int` **link_get_navigation_layers** **(** :ref:`RID` link **)** |const| +:ref:`int` **link_get_navigation_layers**\ (\ link\: :ref:`RID`\ ) |const| Returns the navigation layers for this ``link``. @@ -884,7 +886,7 @@ Returns the navigation layers for this ``link``. .. rst-class:: classref-method -:ref:`int` **link_get_owner_id** **(** :ref:`RID` link **)** |const| +:ref:`int` **link_get_owner_id**\ (\ link\: :ref:`RID`\ ) |const| Returns the ``ObjectID`` of the object which manages this link. @@ -896,7 +898,7 @@ Returns the ``ObjectID`` of the object which manages this link. .. rst-class:: classref-method -:ref:`Vector2` **link_get_start_position** **(** :ref:`RID` link **)** |const| +:ref:`Vector2` **link_get_start_position**\ (\ link\: :ref:`RID`\ ) |const| Returns the starting position of this ``link``. @@ -908,7 +910,7 @@ Returns the starting position of this ``link``. .. rst-class:: classref-method -:ref:`float` **link_get_travel_cost** **(** :ref:`RID` link **)** |const| +:ref:`float` **link_get_travel_cost**\ (\ link\: :ref:`RID`\ ) |const| Returns the travel cost of this ``link``. @@ -920,7 +922,7 @@ Returns the travel cost of this ``link``. .. rst-class:: classref-method -:ref:`bool` **link_is_bidirectional** **(** :ref:`RID` link **)** |const| +:ref:`bool` **link_is_bidirectional**\ (\ link\: :ref:`RID`\ ) |const| Returns whether this ``link`` can be travelled in both directions. @@ -932,7 +934,7 @@ Returns whether this ``link`` can be travelled in both directions. .. rst-class:: classref-method -void **link_set_bidirectional** **(** :ref:`RID` link, :ref:`bool` bidirectional **)** +|void| **link_set_bidirectional**\ (\ link\: :ref:`RID`, bidirectional\: :ref:`bool`\ ) Sets whether this ``link`` can be travelled in both directions. @@ -944,7 +946,7 @@ Sets whether this ``link`` can be travelled in both directions. .. rst-class:: classref-method -void **link_set_enabled** **(** :ref:`RID` link, :ref:`bool` enabled **)** +|void| **link_set_enabled**\ (\ link\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``enabled`` is ``true``, the specified ``link`` will contribute to its current navigation map. @@ -956,7 +958,7 @@ If ``enabled`` is ``true``, the specified ``link`` will contribute to its curren .. rst-class:: classref-method -void **link_set_end_position** **(** :ref:`RID` link, :ref:`Vector2` position **)** +|void| **link_set_end_position**\ (\ link\: :ref:`RID`, position\: :ref:`Vector2`\ ) Sets the exit position for the ``link``. @@ -968,7 +970,7 @@ Sets the exit position for the ``link``. .. rst-class:: classref-method -void **link_set_enter_cost** **(** :ref:`RID` link, :ref:`float` enter_cost **)** +|void| **link_set_enter_cost**\ (\ link\: :ref:`RID`, enter_cost\: :ref:`float`\ ) Sets the ``enter_cost`` for this ``link``. @@ -980,7 +982,7 @@ Sets the ``enter_cost`` for this ``link``. .. rst-class:: classref-method -void **link_set_map** **(** :ref:`RID` link, :ref:`RID` map **)** +|void| **link_set_map**\ (\ link\: :ref:`RID`, map\: :ref:`RID`\ ) Sets the navigation map :ref:`RID` for the link. @@ -992,7 +994,7 @@ Sets the navigation map :ref:`RID` for the link. .. rst-class:: classref-method -void **link_set_navigation_layers** **(** :ref:`RID` link, :ref:`int` navigation_layers **)** +|void| **link_set_navigation_layers**\ (\ link\: :ref:`RID`, navigation_layers\: :ref:`int`\ ) Set the links's navigation layers. This allows selecting links from a path request (when using :ref:`map_get_path`). @@ -1004,7 +1006,7 @@ Set the links's navigation layers. This allows selecting links from a path reque .. rst-class:: classref-method -void **link_set_owner_id** **(** :ref:`RID` link, :ref:`int` owner_id **)** +|void| **link_set_owner_id**\ (\ link\: :ref:`RID`, owner_id\: :ref:`int`\ ) Set the ``ObjectID`` of the object which manages this link. @@ -1016,7 +1018,7 @@ Set the ``ObjectID`` of the object which manages this link. .. rst-class:: classref-method -void **link_set_start_position** **(** :ref:`RID` link, :ref:`Vector2` position **)** +|void| **link_set_start_position**\ (\ link\: :ref:`RID`, position\: :ref:`Vector2`\ ) Sets the entry position for this ``link``. @@ -1028,7 +1030,7 @@ Sets the entry position for this ``link``. .. rst-class:: classref-method -void **link_set_travel_cost** **(** :ref:`RID` link, :ref:`float` travel_cost **)** +|void| **link_set_travel_cost**\ (\ link\: :ref:`RID`, travel_cost\: :ref:`float`\ ) Sets the ``travel_cost`` for this ``link``. @@ -1040,7 +1042,7 @@ Sets the ``travel_cost`` for this ``link``. .. rst-class:: classref-method -:ref:`RID` **map_create** **(** **)** +:ref:`RID` **map_create**\ (\ ) Create a new map. @@ -1052,7 +1054,7 @@ Create a new map. .. rst-class:: classref-method -void **map_force_update** **(** :ref:`RID` map **)** +|void| **map_force_update**\ (\ map\: :ref:`RID`\ ) This function immediately forces synchronization of the specified navigation ``map`` :ref:`RID`. By default navigation maps are only synchronized at the end of each physics frame. This function can be used to immediately (re)calculate all the navigation meshes and region connections of the navigation map. This makes it possible to query a navigation path for a changed map immediately and in the same frame (multiple times if needed). @@ -1070,7 +1072,7 @@ Avoidance processing and dispatch of the ``safe_velocity`` signals is unaffected .. rst-class:: classref-method -:ref:`RID[]` **map_get_agents** **(** :ref:`RID` map **)** |const| +:ref:`Array`\[:ref:`RID`\] **map_get_agents**\ (\ map\: :ref:`RID`\ ) |const| Returns all navigation agents :ref:`RID`\ s that are currently assigned to the requested navigation ``map``. @@ -1082,7 +1084,7 @@ Returns all navigation agents :ref:`RID`\ s that are currently assign .. rst-class:: classref-method -:ref:`float` **map_get_cell_size** **(** :ref:`RID` map **)** |const| +:ref:`float` **map_get_cell_size**\ (\ map\: :ref:`RID`\ ) |const| Returns the map cell size used to rasterize the navigation mesh vertices. @@ -1094,7 +1096,7 @@ Returns the map cell size used to rasterize the navigation mesh vertices. .. rst-class:: classref-method -:ref:`Vector2` **map_get_closest_point** **(** :ref:`RID` map, :ref:`Vector2` to_point **)** |const| +:ref:`Vector2` **map_get_closest_point**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector2`\ ) |const| Returns the point closest to the provided ``to_point`` on the navigation mesh surface. @@ -1106,7 +1108,7 @@ Returns the point closest to the provided ``to_point`` on the navigation mesh su .. rst-class:: classref-method -:ref:`RID` **map_get_closest_point_owner** **(** :ref:`RID` map, :ref:`Vector2` to_point **)** |const| +:ref:`RID` **map_get_closest_point_owner**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector2`\ ) |const| Returns the owner region RID for the point returned by :ref:`map_get_closest_point`. @@ -1118,7 +1120,7 @@ Returns the owner region RID for the point returned by :ref:`map_get_closest_poi .. rst-class:: classref-method -:ref:`float` **map_get_edge_connection_margin** **(** :ref:`RID` map **)** |const| +:ref:`float` **map_get_edge_connection_margin**\ (\ map\: :ref:`RID`\ ) |const| Returns the edge connection margin of the map. The edge connection margin is a distance used to connect two regions. @@ -1126,11 +1128,25 @@ Returns the edge connection margin of the map. The edge connection margin is a d ---- +.. _class_NavigationServer2D_method_map_get_iteration_id: + +.. rst-class:: classref-method + +:ref:`int` **map_get_iteration_id**\ (\ map\: :ref:`RID`\ ) |const| + +Returns the current iteration id of the navigation map. Every time the navigation map changes and synchronizes the iteration id increases. An iteration id of 0 means the navigation map has never synchronized. + +\ **Note:** The iteration id will wrap back to 1 after reaching its range limit. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer2D_method_map_get_link_connection_radius: .. rst-class:: classref-method -:ref:`float` **map_get_link_connection_radius** **(** :ref:`RID` map **)** |const| +:ref:`float` **map_get_link_connection_radius**\ (\ map\: :ref:`RID`\ ) |const| Returns the link connection radius of the map. This distance is the maximum range any link will search for navigation mesh polygons to connect to. @@ -1142,7 +1158,7 @@ Returns the link connection radius of the map. This distance is the maximum rang .. rst-class:: classref-method -:ref:`RID[]` **map_get_links** **(** :ref:`RID` map **)** |const| +:ref:`Array`\[:ref:`RID`\] **map_get_links**\ (\ map\: :ref:`RID`\ ) |const| Returns all navigation link :ref:`RID`\ s that are currently assigned to the requested navigation ``map``. @@ -1154,7 +1170,7 @@ Returns all navigation link :ref:`RID`\ s that are currently assigned .. rst-class:: classref-method -:ref:`RID[]` **map_get_obstacles** **(** :ref:`RID` map **)** |const| +:ref:`Array`\[:ref:`RID`\] **map_get_obstacles**\ (\ map\: :ref:`RID`\ ) |const| Returns all navigation obstacle :ref:`RID`\ s that are currently assigned to the requested navigation ``map``. @@ -1166,7 +1182,7 @@ Returns all navigation obstacle :ref:`RID`\ s that are currently assi .. rst-class:: classref-method -:ref:`PackedVector2Array` **map_get_path** **(** :ref:`RID` map, :ref:`Vector2` origin, :ref:`Vector2` destination, :ref:`bool` optimize, :ref:`int` navigation_layers=1 **)** |const| +:ref:`PackedVector2Array` **map_get_path**\ (\ map\: :ref:`RID`, origin\: :ref:`Vector2`, destination\: :ref:`Vector2`, optimize\: :ref:`bool`, navigation_layers\: :ref:`int` = 1\ ) |const| Returns the navigation path to reach the destination from the origin. ``navigation_layers`` is a bitmask of all region navigation layers that are allowed to be in the path. @@ -1178,7 +1194,7 @@ Returns the navigation path to reach the destination from the origin. ``navigati .. rst-class:: classref-method -:ref:`Vector2` **map_get_random_point** **(** :ref:`RID` map, :ref:`int` navigation_layers, :ref:`bool` uniformly **)** |const| +:ref:`Vector2` **map_get_random_point**\ (\ map\: :ref:`RID`, navigation_layers\: :ref:`int`, uniformly\: :ref:`bool`\ ) |const| Returns a random position picked from all map region polygons with matching ``navigation_layers``. @@ -1194,7 +1210,7 @@ If ``uniformly`` is ``false``, just a random region and a random polygon are pic .. rst-class:: classref-method -:ref:`RID[]` **map_get_regions** **(** :ref:`RID` map **)** |const| +:ref:`Array`\[:ref:`RID`\] **map_get_regions**\ (\ map\: :ref:`RID`\ ) |const| Returns all navigation regions :ref:`RID`\ s that are currently assigned to the requested navigation ``map``. @@ -1206,7 +1222,7 @@ Returns all navigation regions :ref:`RID`\ s that are currently assig .. rst-class:: classref-method -:ref:`bool` **map_get_use_edge_connections** **(** :ref:`RID` map **)** |const| +:ref:`bool` **map_get_use_edge_connections**\ (\ map\: :ref:`RID`\ ) |const| Returns whether the navigation ``map`` allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -1218,7 +1234,7 @@ Returns whether the navigation ``map`` allows navigation regions to use edge con .. rst-class:: classref-method -:ref:`bool` **map_is_active** **(** :ref:`RID` map **)** |const| +:ref:`bool` **map_is_active**\ (\ map\: :ref:`RID`\ ) |const| Returns true if the map is active. @@ -1230,7 +1246,7 @@ Returns true if the map is active. .. rst-class:: classref-method -void **map_set_active** **(** :ref:`RID` map, :ref:`bool` active **)** +|void| **map_set_active**\ (\ map\: :ref:`RID`, active\: :ref:`bool`\ ) Sets the map active. @@ -1242,7 +1258,7 @@ Sets the map active. .. rst-class:: classref-method -void **map_set_cell_size** **(** :ref:`RID` map, :ref:`float` cell_size **)** +|void| **map_set_cell_size**\ (\ map\: :ref:`RID`, cell_size\: :ref:`float`\ ) Sets the map cell size used to rasterize the navigation mesh vertices. Must match with the cell size of the used navigation meshes. @@ -1254,7 +1270,7 @@ Sets the map cell size used to rasterize the navigation mesh vertices. Must matc .. rst-class:: classref-method -void **map_set_edge_connection_margin** **(** :ref:`RID` map, :ref:`float` margin **)** +|void| **map_set_edge_connection_margin**\ (\ map\: :ref:`RID`, margin\: :ref:`float`\ ) Set the map edge connection margin used to weld the compatible region edges. @@ -1266,7 +1282,7 @@ Set the map edge connection margin used to weld the compatible region edges. .. rst-class:: classref-method -void **map_set_link_connection_radius** **(** :ref:`RID` map, :ref:`float` radius **)** +|void| **map_set_link_connection_radius**\ (\ map\: :ref:`RID`, radius\: :ref:`float`\ ) Set the map's link connection radius used to connect links to navigation polygons. @@ -1278,7 +1294,7 @@ Set the map's link connection radius used to connect links to navigation polygon .. rst-class:: classref-method -void **map_set_use_edge_connections** **(** :ref:`RID` map, :ref:`bool` enabled **)** +|void| **map_set_use_edge_connections**\ (\ map\: :ref:`RID`, enabled\: :ref:`bool`\ ) Set the navigation ``map`` edge connection use. If ``enabled`` is ``true``, the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -1290,7 +1306,7 @@ Set the navigation ``map`` edge connection use. If ``enabled`` is ``true``, the .. rst-class:: classref-method -:ref:`RID` **obstacle_create** **(** **)** +:ref:`RID` **obstacle_create**\ (\ ) Creates a new navigation obstacle. @@ -1302,7 +1318,7 @@ Creates a new navigation obstacle. .. rst-class:: classref-method -:ref:`bool` **obstacle_get_avoidance_enabled** **(** :ref:`RID` obstacle **)** |const| +:ref:`bool` **obstacle_get_avoidance_enabled**\ (\ obstacle\: :ref:`RID`\ ) |const| Returns ``true`` if the provided ``obstacle`` has avoidance enabled. @@ -1314,7 +1330,7 @@ Returns ``true`` if the provided ``obstacle`` has avoidance enabled. .. rst-class:: classref-method -:ref:`int` **obstacle_get_avoidance_layers** **(** :ref:`RID` obstacle **)** |const| +:ref:`int` **obstacle_get_avoidance_layers**\ (\ obstacle\: :ref:`RID`\ ) |const| Returns the ``avoidance_layers`` bitmask of the specified ``obstacle``. @@ -1326,7 +1342,7 @@ Returns the ``avoidance_layers`` bitmask of the specified ``obstacle``. .. rst-class:: classref-method -:ref:`RID` **obstacle_get_map** **(** :ref:`RID` obstacle **)** |const| +:ref:`RID` **obstacle_get_map**\ (\ obstacle\: :ref:`RID`\ ) |const| Returns the navigation map :ref:`RID` the requested ``obstacle`` is currently assigned to. @@ -1338,7 +1354,7 @@ Returns the navigation map :ref:`RID` the requested ``obstacle`` is c .. rst-class:: classref-method -:ref:`bool` **obstacle_get_paused** **(** :ref:`RID` obstacle **)** |const| +:ref:`bool` **obstacle_get_paused**\ (\ obstacle\: :ref:`RID`\ ) |const| Returns ``true`` if the specified ``obstacle`` is paused. @@ -1350,7 +1366,7 @@ Returns ``true`` if the specified ``obstacle`` is paused. .. rst-class:: classref-method -:ref:`Vector2` **obstacle_get_position** **(** :ref:`RID` obstacle **)** |const| +:ref:`Vector2` **obstacle_get_position**\ (\ obstacle\: :ref:`RID`\ ) |const| Returns the position of the specified ``obstacle`` in world space. @@ -1362,7 +1378,7 @@ Returns the position of the specified ``obstacle`` in world space. .. rst-class:: classref-method -:ref:`float` **obstacle_get_radius** **(** :ref:`RID` obstacle **)** |const| +:ref:`float` **obstacle_get_radius**\ (\ obstacle\: :ref:`RID`\ ) |const| Returns the radius of the specified dynamic ``obstacle``. @@ -1374,7 +1390,7 @@ Returns the radius of the specified dynamic ``obstacle``. .. rst-class:: classref-method -:ref:`Vector2` **obstacle_get_velocity** **(** :ref:`RID` obstacle **)** |const| +:ref:`Vector2` **obstacle_get_velocity**\ (\ obstacle\: :ref:`RID`\ ) |const| Returns the velocity of the specified dynamic ``obstacle``. @@ -1386,7 +1402,7 @@ Returns the velocity of the specified dynamic ``obstacle``. .. rst-class:: classref-method -:ref:`PackedVector2Array` **obstacle_get_vertices** **(** :ref:`RID` obstacle **)** |const| +:ref:`PackedVector2Array` **obstacle_get_vertices**\ (\ obstacle\: :ref:`RID`\ ) |const| Returns the outline vertices for the specified ``obstacle``. @@ -1398,7 +1414,7 @@ Returns the outline vertices for the specified ``obstacle``. .. rst-class:: classref-method -void **obstacle_set_avoidance_enabled** **(** :ref:`RID` obstacle, :ref:`bool` enabled **)** +|void| **obstacle_set_avoidance_enabled**\ (\ obstacle\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``enabled`` is ``true``, the provided ``obstacle`` affects avoidance using agents. @@ -1410,7 +1426,7 @@ If ``enabled`` is ``true``, the provided ``obstacle`` affects avoidance using ag .. rst-class:: classref-method -void **obstacle_set_avoidance_layers** **(** :ref:`RID` obstacle, :ref:`int` layers **)** +|void| **obstacle_set_avoidance_layers**\ (\ obstacle\: :ref:`RID`, layers\: :ref:`int`\ ) Set the obstacles's ``avoidance_layers`` bitmask. @@ -1422,7 +1438,7 @@ Set the obstacles's ``avoidance_layers`` bitmask. .. rst-class:: classref-method -void **obstacle_set_map** **(** :ref:`RID` obstacle, :ref:`RID` map **)** +|void| **obstacle_set_map**\ (\ obstacle\: :ref:`RID`, map\: :ref:`RID`\ ) Sets the navigation map :ref:`RID` for the obstacle. @@ -1434,7 +1450,7 @@ Sets the navigation map :ref:`RID` for the obstacle. .. rst-class:: classref-method -void **obstacle_set_paused** **(** :ref:`RID` obstacle, :ref:`bool` paused **)** +|void| **obstacle_set_paused**\ (\ obstacle\: :ref:`RID`, paused\: :ref:`bool`\ ) If ``paused`` is true the specified ``obstacle`` will not be processed, e.g. affect avoidance velocities. @@ -1446,7 +1462,7 @@ If ``paused`` is true the specified ``obstacle`` will not be processed, e.g. aff .. rst-class:: classref-method -void **obstacle_set_position** **(** :ref:`RID` obstacle, :ref:`Vector2` position **)** +|void| **obstacle_set_position**\ (\ obstacle\: :ref:`RID`, position\: :ref:`Vector2`\ ) Sets the position of the obstacle in world space. @@ -1458,7 +1474,7 @@ Sets the position of the obstacle in world space. .. rst-class:: classref-method -void **obstacle_set_radius** **(** :ref:`RID` obstacle, :ref:`float` radius **)** +|void| **obstacle_set_radius**\ (\ obstacle\: :ref:`RID`, radius\: :ref:`float`\ ) Sets the radius of the dynamic obstacle. @@ -1470,7 +1486,7 @@ Sets the radius of the dynamic obstacle. .. rst-class:: classref-method -void **obstacle_set_velocity** **(** :ref:`RID` obstacle, :ref:`Vector2` velocity **)** +|void| **obstacle_set_velocity**\ (\ obstacle\: :ref:`RID`, velocity\: :ref:`Vector2`\ ) Sets ``velocity`` of the dynamic ``obstacle``. Allows other agents to better predict the movement of the dynamic obstacle. Only works in combination with the radius of the obstacle. @@ -1482,7 +1498,7 @@ Sets ``velocity`` of the dynamic ``obstacle``. Allows other agents to better pre .. rst-class:: classref-method -void **obstacle_set_vertices** **(** :ref:`RID` obstacle, :ref:`PackedVector2Array` vertices **)** +|void| **obstacle_set_vertices**\ (\ obstacle\: :ref:`RID`, vertices\: :ref:`PackedVector2Array`\ ) Sets the outline vertices for the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out. @@ -1494,7 +1510,7 @@ Sets the outline vertices for the obstacle. If the vertices are winded in clockw .. rst-class:: classref-method -void **parse_source_geometry_data** **(** :ref:`NavigationPolygon` navigation_polygon, :ref:`NavigationMeshSourceGeometryData2D` source_geometry_data, :ref:`Node` root_node, :ref:`Callable` callback=Callable() **)** +|void| **parse_source_geometry_data**\ (\ navigation_polygon\: :ref:`NavigationPolygon`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData2D`, root_node\: :ref:`Node`, callback\: :ref:`Callable` = Callable()\ ) Parses the :ref:`SceneTree` for source geometry according to the properties of ``navigation_polygon``. Updates the provided ``source_geometry_data`` resource with the resulting data. The resource can then be used to bake a navigation mesh with :ref:`bake_from_source_geometry_data`. After the process is finished the optional ``callback`` will be called. @@ -1510,7 +1526,7 @@ Parses the :ref:`SceneTree` for source geometry according to th .. rst-class:: classref-method -void **query_path** **(** :ref:`NavigationPathQueryParameters2D` parameters, :ref:`NavigationPathQueryResult2D` result **)** |const| +|void| **query_path**\ (\ parameters\: :ref:`NavigationPathQueryParameters2D`, result\: :ref:`NavigationPathQueryResult2D`\ ) |const| Queries a path in a given navigation map. Start and target position and other parameters are defined through :ref:`NavigationPathQueryParameters2D`. Updates the provided :ref:`NavigationPathQueryResult2D` result object with the path among other results requested by the query. @@ -1522,7 +1538,7 @@ Queries a path in a given navigation map. Start and target position and other pa .. rst-class:: classref-method -:ref:`RID` **region_create** **(** **)** +:ref:`RID` **region_create**\ (\ ) Creates a new region. @@ -1534,7 +1550,7 @@ Creates a new region. .. rst-class:: classref-method -:ref:`Vector2` **region_get_connection_pathway_end** **(** :ref:`RID` region, :ref:`int` connection **)** |const| +:ref:`Vector2` **region_get_connection_pathway_end**\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| Returns the ending point of a connection door. ``connection`` is an index between 0 and the return value of :ref:`region_get_connections_count`. @@ -1546,7 +1562,7 @@ Returns the ending point of a connection door. ``connection`` is an index betwee .. rst-class:: classref-method -:ref:`Vector2` **region_get_connection_pathway_start** **(** :ref:`RID` region, :ref:`int` connection **)** |const| +:ref:`Vector2` **region_get_connection_pathway_start**\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| Returns the starting point of a connection door. ``connection`` is an index between 0 and the return value of :ref:`region_get_connections_count`. @@ -1558,7 +1574,7 @@ Returns the starting point of a connection door. ``connection`` is an index betw .. rst-class:: classref-method -:ref:`int` **region_get_connections_count** **(** :ref:`RID` region **)** |const| +:ref:`int` **region_get_connections_count**\ (\ region\: :ref:`RID`\ ) |const| Returns how many connections this ``region`` has with other regions in the map. @@ -1570,7 +1586,7 @@ Returns how many connections this ``region`` has with other regions in the map. .. rst-class:: classref-method -:ref:`bool` **region_get_enabled** **(** :ref:`RID` region **)** |const| +:ref:`bool` **region_get_enabled**\ (\ region\: :ref:`RID`\ ) |const| Returns ``true`` if the specified ``region`` is enabled. @@ -1582,7 +1598,7 @@ Returns ``true`` if the specified ``region`` is enabled. .. rst-class:: classref-method -:ref:`float` **region_get_enter_cost** **(** :ref:`RID` region **)** |const| +:ref:`float` **region_get_enter_cost**\ (\ region\: :ref:`RID`\ ) |const| Returns the enter cost of this ``region``. @@ -1594,7 +1610,7 @@ Returns the enter cost of this ``region``. .. rst-class:: classref-method -:ref:`RID` **region_get_map** **(** :ref:`RID` region **)** |const| +:ref:`RID` **region_get_map**\ (\ region\: :ref:`RID`\ ) |const| Returns the navigation map :ref:`RID` the requested ``region`` is currently assigned to. @@ -1606,7 +1622,7 @@ Returns the navigation map :ref:`RID` the requested ``region`` is cur .. rst-class:: classref-method -:ref:`int` **region_get_navigation_layers** **(** :ref:`RID` region **)** |const| +:ref:`int` **region_get_navigation_layers**\ (\ region\: :ref:`RID`\ ) |const| Returns the region's navigation layers. @@ -1618,7 +1634,7 @@ Returns the region's navigation layers. .. rst-class:: classref-method -:ref:`int` **region_get_owner_id** **(** :ref:`RID` region **)** |const| +:ref:`int` **region_get_owner_id**\ (\ region\: :ref:`RID`\ ) |const| Returns the ``ObjectID`` of the object which manages this region. @@ -1630,7 +1646,7 @@ Returns the ``ObjectID`` of the object which manages this region. .. rst-class:: classref-method -:ref:`Vector2` **region_get_random_point** **(** :ref:`RID` region, :ref:`int` navigation_layers, :ref:`bool` uniformly **)** |const| +:ref:`Vector2` **region_get_random_point**\ (\ region\: :ref:`RID`, navigation_layers\: :ref:`int`, uniformly\: :ref:`bool`\ ) |const| Returns a random position picked from all region polygons with matching ``navigation_layers``. @@ -1646,7 +1662,7 @@ If ``uniformly`` is ``false``, just a random polygon and face is picked (faster) .. rst-class:: classref-method -:ref:`Transform2D` **region_get_transform** **(** :ref:`RID` region **)** |const| +:ref:`Transform2D` **region_get_transform**\ (\ region\: :ref:`RID`\ ) |const| Returns the global transformation of this ``region``. @@ -1658,7 +1674,7 @@ Returns the global transformation of this ``region``. .. rst-class:: classref-method -:ref:`float` **region_get_travel_cost** **(** :ref:`RID` region **)** |const| +:ref:`float` **region_get_travel_cost**\ (\ region\: :ref:`RID`\ ) |const| Returns the travel cost of this ``region``. @@ -1670,7 +1686,7 @@ Returns the travel cost of this ``region``. .. rst-class:: classref-method -:ref:`bool` **region_get_use_edge_connections** **(** :ref:`RID` region **)** |const| +:ref:`bool` **region_get_use_edge_connections**\ (\ region\: :ref:`RID`\ ) |const| Returns whether the navigation ``region`` is set to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -1682,7 +1698,7 @@ Returns whether the navigation ``region`` is set to use edge connections to conn .. rst-class:: classref-method -:ref:`bool` **region_owns_point** **(** :ref:`RID` region, :ref:`Vector2` point **)** |const| +:ref:`bool` **region_owns_point**\ (\ region\: :ref:`RID`, point\: :ref:`Vector2`\ ) |const| Returns ``true`` if the provided ``point`` in world space is currently owned by the provided navigation ``region``. Owned in this context means that one of the region's navigation mesh polygon faces has a possible position at the closest distance to this point compared to all other navigation meshes from other navigation regions that are also registered on the navigation map of the provided region. @@ -1698,7 +1714,7 @@ If multiple navigation meshes have positions at equal distance the navigation re .. rst-class:: classref-method -void **region_set_enabled** **(** :ref:`RID` region, :ref:`bool` enabled **)** +|void| **region_set_enabled**\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``enabled`` is ``true`` the specified ``region`` will contribute to its current navigation map. @@ -1710,7 +1726,7 @@ If ``enabled`` is ``true`` the specified ``region`` will contribute to its curre .. rst-class:: classref-method -void **region_set_enter_cost** **(** :ref:`RID` region, :ref:`float` enter_cost **)** +|void| **region_set_enter_cost**\ (\ region\: :ref:`RID`, enter_cost\: :ref:`float`\ ) Sets the ``enter_cost`` for this ``region``. @@ -1722,7 +1738,7 @@ Sets the ``enter_cost`` for this ``region``. .. rst-class:: classref-method -void **region_set_map** **(** :ref:`RID` region, :ref:`RID` map **)** +|void| **region_set_map**\ (\ region\: :ref:`RID`, map\: :ref:`RID`\ ) Sets the map for the region. @@ -1734,7 +1750,7 @@ Sets the map for the region. .. rst-class:: classref-method -void **region_set_navigation_layers** **(** :ref:`RID` region, :ref:`int` navigation_layers **)** +|void| **region_set_navigation_layers**\ (\ region\: :ref:`RID`, navigation_layers\: :ref:`int`\ ) Set the region's navigation layers. This allows selecting regions from a path request (when using :ref:`map_get_path`). @@ -1746,7 +1762,7 @@ Set the region's navigation layers. This allows selecting regions from a path re .. rst-class:: classref-method -void **region_set_navigation_polygon** **(** :ref:`RID` region, :ref:`NavigationPolygon` navigation_polygon **)** +|void| **region_set_navigation_polygon**\ (\ region\: :ref:`RID`, navigation_polygon\: :ref:`NavigationPolygon`\ ) Sets the ``navigation_polygon`` for the region. @@ -1758,7 +1774,7 @@ Sets the ``navigation_polygon`` for the region. .. rst-class:: classref-method -void **region_set_owner_id** **(** :ref:`RID` region, :ref:`int` owner_id **)** +|void| **region_set_owner_id**\ (\ region\: :ref:`RID`, owner_id\: :ref:`int`\ ) Set the ``ObjectID`` of the object which manages this region. @@ -1770,7 +1786,7 @@ Set the ``ObjectID`` of the object which manages this region. .. rst-class:: classref-method -void **region_set_transform** **(** :ref:`RID` region, :ref:`Transform2D` transform **)** +|void| **region_set_transform**\ (\ region\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) Sets the global transformation for the region. @@ -1782,7 +1798,7 @@ Sets the global transformation for the region. .. rst-class:: classref-method -void **region_set_travel_cost** **(** :ref:`RID` region, :ref:`float` travel_cost **)** +|void| **region_set_travel_cost**\ (\ region\: :ref:`RID`, travel_cost\: :ref:`float`\ ) Sets the ``travel_cost`` for this ``region``. @@ -1794,7 +1810,7 @@ Sets the ``travel_cost`` for this ``region``. .. rst-class:: classref-method -void **region_set_use_edge_connections** **(** :ref:`RID` region, :ref:`bool` enabled **)** +|void| **region_set_use_edge_connections**\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``enabled`` is ``true``, the navigation ``region`` will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -1806,7 +1822,7 @@ If ``enabled`` is ``true``, the navigation ``region`` will use edge connections .. rst-class:: classref-method -void **set_debug_enabled** **(** :ref:`bool` enabled **)** +|void| **set_debug_enabled**\ (\ enabled\: :ref:`bool`\ ) If ``true`` enables debug mode on the NavigationServer. @@ -1817,3 +1833,4 @@ If ``true`` enables debug mode on the NavigationServer. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_navigationserver3d.rst b/classes/class_navigationserver3d.rst index 314d70543ca..387c85ccf6e 100644 --- a/classes/class_navigationserver3d.rst +++ b/classes/class_navigationserver3d.rst @@ -54,287 +54,289 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`agent_create` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`agent_get_avoidance_enabled` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`agent_get_avoidance_layers` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`agent_get_avoidance_mask` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`agent_get_avoidance_priority` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`agent_get_height` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`agent_get_map` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`agent_get_max_neighbors` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`agent_get_max_speed` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`agent_get_neighbor_distance` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`agent_get_paused` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`agent_get_position` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`agent_get_radius` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`agent_get_time_horizon_agents` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`agent_get_time_horizon_obstacles` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`agent_get_use_3d_avoidance` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`agent_get_velocity` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`agent_has_avoidance_callback` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`agent_is_map_changed` **(** :ref:`RID` agent **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_avoidance_callback` **(** :ref:`RID` agent, :ref:`Callable` callback **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_avoidance_enabled` **(** :ref:`RID` agent, :ref:`bool` enabled **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_avoidance_layers` **(** :ref:`RID` agent, :ref:`int` layers **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_avoidance_mask` **(** :ref:`RID` agent, :ref:`int` mask **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_avoidance_priority` **(** :ref:`RID` agent, :ref:`float` priority **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_height` **(** :ref:`RID` agent, :ref:`float` height **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_map` **(** :ref:`RID` agent, :ref:`RID` map **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_max_neighbors` **(** :ref:`RID` agent, :ref:`int` count **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_max_speed` **(** :ref:`RID` agent, :ref:`float` max_speed **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_neighbor_distance` **(** :ref:`RID` agent, :ref:`float` distance **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_paused` **(** :ref:`RID` agent, :ref:`bool` paused **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_position` **(** :ref:`RID` agent, :ref:`Vector3` position **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_radius` **(** :ref:`RID` agent, :ref:`float` radius **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_time_horizon_agents` **(** :ref:`RID` agent, :ref:`float` time_horizon **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_time_horizon_obstacles` **(** :ref:`RID` agent, :ref:`float` time_horizon **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_use_3d_avoidance` **(** :ref:`RID` agent, :ref:`bool` enabled **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_velocity` **(** :ref:`RID` agent, :ref:`Vector3` velocity **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`agent_set_velocity_forced` **(** :ref:`RID` agent, :ref:`Vector3` velocity **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`bake_from_source_geometry_data` **(** :ref:`NavigationMesh` navigation_mesh, :ref:`NavigationMeshSourceGeometryData3D` source_geometry_data, :ref:`Callable` callback=Callable() **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`bake_from_source_geometry_data_async` **(** :ref:`NavigationMesh` navigation_mesh, :ref:`NavigationMeshSourceGeometryData3D` source_geometry_data, :ref:`Callable` callback=Callable() **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`free_rid` **(** :ref:`RID` rid **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_debug_enabled` **(** **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`get_maps` **(** **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_process_info` **(** :ref:`ProcessInfo` process_info **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_baking_navigation_mesh` **(** :ref:`NavigationMesh` navigation_mesh **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`link_create` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`link_get_enabled` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`link_get_end_position` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`link_get_enter_cost` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`link_get_map` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`link_get_navigation_layers` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`link_get_owner_id` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`link_get_start_position` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`link_get_travel_cost` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`link_is_bidirectional` **(** :ref:`RID` link **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_bidirectional` **(** :ref:`RID` link, :ref:`bool` bidirectional **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_enabled` **(** :ref:`RID` link, :ref:`bool` enabled **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_end_position` **(** :ref:`RID` link, :ref:`Vector3` position **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_enter_cost` **(** :ref:`RID` link, :ref:`float` enter_cost **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_map` **(** :ref:`RID` link, :ref:`RID` map **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_navigation_layers` **(** :ref:`RID` link, :ref:`int` navigation_layers **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_owner_id` **(** :ref:`RID` link, :ref:`int` owner_id **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_start_position` **(** :ref:`RID` link, :ref:`Vector3` position **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`link_set_travel_cost` **(** :ref:`RID` link, :ref:`float` travel_cost **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`map_create` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_force_update` **(** :ref:`RID` map **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`map_get_agents` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`map_get_cell_height` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`map_get_cell_size` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`map_get_closest_point` **(** :ref:`RID` map, :ref:`Vector3` to_point **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`map_get_closest_point_normal` **(** :ref:`RID` map, :ref:`Vector3` to_point **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`map_get_closest_point_owner` **(** :ref:`RID` map, :ref:`Vector3` to_point **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`map_get_closest_point_to_segment` **(** :ref:`RID` map, :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`map_get_edge_connection_margin` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`map_get_link_connection_radius` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`map_get_links` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`map_get_merge_rasterizer_cell_scale` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`map_get_obstacles` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`map_get_path` **(** :ref:`RID` map, :ref:`Vector3` origin, :ref:`Vector3` destination, :ref:`bool` optimize, :ref:`int` navigation_layers=1 **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`map_get_random_point` **(** :ref:`RID` map, :ref:`int` navigation_layers, :ref:`bool` uniformly **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`map_get_regions` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`map_get_up` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`map_get_use_edge_connections` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`map_is_active` **(** :ref:`RID` map **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_set_active` **(** :ref:`RID` map, :ref:`bool` active **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_set_cell_height` **(** :ref:`RID` map, :ref:`float` cell_height **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_set_cell_size` **(** :ref:`RID` map, :ref:`float` cell_size **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_set_edge_connection_margin` **(** :ref:`RID` map, :ref:`float` margin **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_set_link_connection_radius` **(** :ref:`RID` map, :ref:`float` radius **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_set_merge_rasterizer_cell_scale` **(** :ref:`RID` map, :ref:`float` scale **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_set_up` **(** :ref:`RID` map, :ref:`Vector3` up **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`map_set_use_edge_connections` **(** :ref:`RID` map, :ref:`bool` enabled **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`obstacle_create` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`obstacle_get_avoidance_enabled` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`obstacle_get_avoidance_layers` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`obstacle_get_height` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`obstacle_get_map` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`obstacle_get_paused` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`obstacle_get_position` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`obstacle_get_radius` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`obstacle_get_use_3d_avoidance` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`obstacle_get_velocity` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`obstacle_get_vertices` **(** :ref:`RID` obstacle **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_avoidance_enabled` **(** :ref:`RID` obstacle, :ref:`bool` enabled **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_avoidance_layers` **(** :ref:`RID` obstacle, :ref:`int` layers **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_height` **(** :ref:`RID` obstacle, :ref:`float` height **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_map` **(** :ref:`RID` obstacle, :ref:`RID` map **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_paused` **(** :ref:`RID` obstacle, :ref:`bool` paused **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_position` **(** :ref:`RID` obstacle, :ref:`Vector3` position **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_radius` **(** :ref:`RID` obstacle, :ref:`float` radius **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_use_3d_avoidance` **(** :ref:`RID` obstacle, :ref:`bool` enabled **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_velocity` **(** :ref:`RID` obstacle, :ref:`Vector3` velocity **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`obstacle_set_vertices` **(** :ref:`RID` obstacle, :ref:`PackedVector3Array` vertices **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`parse_source_geometry_data` **(** :ref:`NavigationMesh` navigation_mesh, :ref:`NavigationMeshSourceGeometryData3D` source_geometry_data, :ref:`Node` root_node, :ref:`Callable` callback=Callable() **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`query_path` **(** :ref:`NavigationPathQueryParameters3D` parameters, :ref:`NavigationPathQueryResult3D` result **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_bake_navigation_mesh` **(** :ref:`NavigationMesh` navigation_mesh, :ref:`Node` root_node **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`region_create` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`region_get_connection_pathway_end` **(** :ref:`RID` region, :ref:`int` connection **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`region_get_connection_pathway_start` **(** :ref:`RID` region, :ref:`int` connection **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`region_get_connections_count` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`region_get_enabled` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`region_get_enter_cost` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`region_get_map` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`region_get_navigation_layers` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`region_get_owner_id` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`region_get_random_point` **(** :ref:`RID` region, :ref:`int` navigation_layers, :ref:`bool` uniformly **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`region_get_transform` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`region_get_travel_cost` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`region_get_use_edge_connections` **(** :ref:`RID` region **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`region_owns_point` **(** :ref:`RID` region, :ref:`Vector3` point **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_enabled` **(** :ref:`RID` region, :ref:`bool` enabled **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_enter_cost` **(** :ref:`RID` region, :ref:`float` enter_cost **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_map` **(** :ref:`RID` region, :ref:`RID` map **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_navigation_layers` **(** :ref:`RID` region, :ref:`int` navigation_layers **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_navigation_mesh` **(** :ref:`RID` region, :ref:`NavigationMesh` navigation_mesh **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_owner_id` **(** :ref:`RID` region, :ref:`int` owner_id **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_transform` **(** :ref:`RID` region, :ref:`Transform3D` transform **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_travel_cost` **(** :ref:`RID` region, :ref:`float` travel_cost **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`region_set_use_edge_connections` **(** :ref:`RID` region, :ref:`bool` enabled **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_active` **(** :ref:`bool` active **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_debug_enabled` **(** :ref:`bool` enabled **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`agent_create`\ (\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`agent_get_avoidance_enabled`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`agent_get_avoidance_layers`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`agent_get_avoidance_mask`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`agent_get_avoidance_priority`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`agent_get_height`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`agent_get_map`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`agent_get_max_neighbors`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`agent_get_max_speed`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`agent_get_neighbor_distance`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`agent_get_paused`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`agent_get_position`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`agent_get_radius`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`agent_get_time_horizon_agents`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`agent_get_time_horizon_obstacles`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`agent_get_use_3d_avoidance`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`agent_get_velocity`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`agent_has_avoidance_callback`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`agent_is_map_changed`\ (\ agent\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_avoidance_callback`\ (\ agent\: :ref:`RID`, callback\: :ref:`Callable`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_avoidance_enabled`\ (\ agent\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_avoidance_layers`\ (\ agent\: :ref:`RID`, layers\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_avoidance_mask`\ (\ agent\: :ref:`RID`, mask\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_avoidance_priority`\ (\ agent\: :ref:`RID`, priority\: :ref:`float`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_height`\ (\ agent\: :ref:`RID`, height\: :ref:`float`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_map`\ (\ agent\: :ref:`RID`, map\: :ref:`RID`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_max_neighbors`\ (\ agent\: :ref:`RID`, count\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_max_speed`\ (\ agent\: :ref:`RID`, max_speed\: :ref:`float`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_neighbor_distance`\ (\ agent\: :ref:`RID`, distance\: :ref:`float`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_paused`\ (\ agent\: :ref:`RID`, paused\: :ref:`bool`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_position`\ (\ agent\: :ref:`RID`, position\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_radius`\ (\ agent\: :ref:`RID`, radius\: :ref:`float`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_time_horizon_agents`\ (\ agent\: :ref:`RID`, time_horizon\: :ref:`float`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_time_horizon_obstacles`\ (\ agent\: :ref:`RID`, time_horizon\: :ref:`float`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_use_3d_avoidance`\ (\ agent\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_velocity`\ (\ agent\: :ref:`RID`, velocity\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`agent_set_velocity_forced`\ (\ agent\: :ref:`RID`, velocity\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bake_from_source_geometry_data`\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, callback\: :ref:`Callable` = Callable()\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bake_from_source_geometry_data_async`\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, callback\: :ref:`Callable` = Callable()\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`free_rid`\ (\ rid\: :ref:`RID`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_debug_enabled`\ (\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`get_maps`\ (\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_process_info`\ (\ process_info\: :ref:`ProcessInfo`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_baking_navigation_mesh`\ (\ navigation_mesh\: :ref:`NavigationMesh`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`link_create`\ (\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`link_get_enabled`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`link_get_end_position`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`link_get_enter_cost`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`link_get_map`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`link_get_navigation_layers`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`link_get_owner_id`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`link_get_start_position`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`link_get_travel_cost`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`link_is_bidirectional`\ (\ link\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`link_set_bidirectional`\ (\ link\: :ref:`RID`, bidirectional\: :ref:`bool`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`link_set_enabled`\ (\ link\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`link_set_end_position`\ (\ link\: :ref:`RID`, position\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`link_set_enter_cost`\ (\ link\: :ref:`RID`, enter_cost\: :ref:`float`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`link_set_map`\ (\ link\: :ref:`RID`, map\: :ref:`RID`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`link_set_navigation_layers`\ (\ link\: :ref:`RID`, navigation_layers\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`link_set_owner_id`\ (\ link\: :ref:`RID`, owner_id\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`link_set_start_position`\ (\ link\: :ref:`RID`, position\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`link_set_travel_cost`\ (\ link\: :ref:`RID`, travel_cost\: :ref:`float`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`map_create`\ (\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`map_force_update`\ (\ map\: :ref:`RID`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`map_get_agents`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`map_get_cell_height`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`map_get_cell_size`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`map_get_closest_point`\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`map_get_closest_point_normal`\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`map_get_closest_point_owner`\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`map_get_closest_point_to_segment`\ (\ map\: :ref:`RID`, start\: :ref:`Vector3`, end\: :ref:`Vector3`, use_collision\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`map_get_edge_connection_margin`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`map_get_iteration_id`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`map_get_link_connection_radius`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`map_get_links`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`map_get_merge_rasterizer_cell_scale`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`map_get_obstacles`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`map_get_path`\ (\ map\: :ref:`RID`, origin\: :ref:`Vector3`, destination\: :ref:`Vector3`, optimize\: :ref:`bool`, navigation_layers\: :ref:`int` = 1\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`map_get_random_point`\ (\ map\: :ref:`RID`, navigation_layers\: :ref:`int`, uniformly\: :ref:`bool`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`map_get_regions`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`map_get_up`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`map_get_use_edge_connections`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`map_is_active`\ (\ map\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`map_set_active`\ (\ map\: :ref:`RID`, active\: :ref:`bool`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`map_set_cell_height`\ (\ map\: :ref:`RID`, cell_height\: :ref:`float`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`map_set_cell_size`\ (\ map\: :ref:`RID`, cell_size\: :ref:`float`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`map_set_edge_connection_margin`\ (\ map\: :ref:`RID`, margin\: :ref:`float`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`map_set_link_connection_radius`\ (\ map\: :ref:`RID`, radius\: :ref:`float`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`map_set_merge_rasterizer_cell_scale`\ (\ map\: :ref:`RID`, scale\: :ref:`float`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`map_set_up`\ (\ map\: :ref:`RID`, up\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`map_set_use_edge_connections`\ (\ map\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`obstacle_create`\ (\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`obstacle_get_avoidance_enabled`\ (\ obstacle\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`obstacle_get_avoidance_layers`\ (\ obstacle\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`obstacle_get_height`\ (\ obstacle\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`obstacle_get_map`\ (\ obstacle\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`obstacle_get_paused`\ (\ obstacle\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`obstacle_get_position`\ (\ obstacle\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`obstacle_get_radius`\ (\ obstacle\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`obstacle_get_use_3d_avoidance`\ (\ obstacle\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`obstacle_get_velocity`\ (\ obstacle\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`obstacle_get_vertices`\ (\ obstacle\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`obstacle_set_avoidance_enabled`\ (\ obstacle\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`obstacle_set_avoidance_layers`\ (\ obstacle\: :ref:`RID`, layers\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`obstacle_set_height`\ (\ obstacle\: :ref:`RID`, height\: :ref:`float`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`obstacle_set_map`\ (\ obstacle\: :ref:`RID`, map\: :ref:`RID`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`obstacle_set_paused`\ (\ obstacle\: :ref:`RID`, paused\: :ref:`bool`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`obstacle_set_position`\ (\ obstacle\: :ref:`RID`, position\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`obstacle_set_radius`\ (\ obstacle\: :ref:`RID`, radius\: :ref:`float`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`obstacle_set_use_3d_avoidance`\ (\ obstacle\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`obstacle_set_velocity`\ (\ obstacle\: :ref:`RID`, velocity\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`obstacle_set_vertices`\ (\ obstacle\: :ref:`RID`, vertices\: :ref:`PackedVector3Array`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`parse_source_geometry_data`\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, root_node\: :ref:`Node`, callback\: :ref:`Callable` = Callable()\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`query_path`\ (\ parameters\: :ref:`NavigationPathQueryParameters3D`, result\: :ref:`NavigationPathQueryResult3D`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_bake_navigation_mesh`\ (\ navigation_mesh\: :ref:`NavigationMesh`, root_node\: :ref:`Node`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`region_create`\ (\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`region_get_connection_pathway_end`\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`region_get_connection_pathway_start`\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`region_get_connections_count`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`region_get_enabled`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`region_get_enter_cost`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`region_get_map`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`region_get_navigation_layers`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`region_get_owner_id`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`region_get_random_point`\ (\ region\: :ref:`RID`, navigation_layers\: :ref:`int`, uniformly\: :ref:`bool`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`region_get_transform`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`region_get_travel_cost`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`region_get_use_edge_connections`\ (\ region\: :ref:`RID`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`region_owns_point`\ (\ region\: :ref:`RID`, point\: :ref:`Vector3`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_enabled`\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_enter_cost`\ (\ region\: :ref:`RID`, enter_cost\: :ref:`float`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_map`\ (\ region\: :ref:`RID`, map\: :ref:`RID`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_navigation_layers`\ (\ region\: :ref:`RID`, navigation_layers\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_navigation_mesh`\ (\ region\: :ref:`RID`, navigation_mesh\: :ref:`NavigationMesh`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_owner_id`\ (\ region\: :ref:`RID`, owner_id\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_transform`\ (\ region\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_travel_cost`\ (\ region\: :ref:`RID`, travel_cost\: :ref:`float`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`region_set_use_edge_connections`\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_active`\ (\ active\: :ref:`bool`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_debug_enabled`\ (\ enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -349,7 +351,7 @@ Signals .. rst-class:: classref-signal -**avoidance_debug_changed** **(** **)** +**avoidance_debug_changed**\ (\ ) Emitted when avoidance debug settings are changed. Only available in debug builds. @@ -361,7 +363,7 @@ Emitted when avoidance debug settings are changed. Only available in debug build .. rst-class:: classref-signal -**map_changed** **(** :ref:`RID` map **)** +**map_changed**\ (\ map\: :ref:`RID`\ ) Emitted when a navigation map is updated, when a region moves or is modified. @@ -373,7 +375,7 @@ Emitted when a navigation map is updated, when a region moves or is modified. .. rst-class:: classref-signal -**navigation_debug_changed** **(** **)** +**navigation_debug_changed**\ (\ ) Emitted when navigation debug settings are changed. Only available in debug builds. @@ -477,7 +479,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **agent_create** **(** **)** +:ref:`RID` **agent_create**\ (\ ) Creates the agent. @@ -489,7 +491,7 @@ Creates the agent. .. rst-class:: classref-method -:ref:`bool` **agent_get_avoidance_enabled** **(** :ref:`RID` agent **)** |const| +:ref:`bool` **agent_get_avoidance_enabled**\ (\ agent\: :ref:`RID`\ ) |const| Returns ``true`` if the provided ``agent`` has avoidance enabled. @@ -501,7 +503,7 @@ Returns ``true`` if the provided ``agent`` has avoidance enabled. .. rst-class:: classref-method -:ref:`int` **agent_get_avoidance_layers** **(** :ref:`RID` agent **)** |const| +:ref:`int` **agent_get_avoidance_layers**\ (\ agent\: :ref:`RID`\ ) |const| Returns the ``avoidance_layers`` bitmask of the specified ``agent``. @@ -513,7 +515,7 @@ Returns the ``avoidance_layers`` bitmask of the specified ``agent``. .. rst-class:: classref-method -:ref:`int` **agent_get_avoidance_mask** **(** :ref:`RID` agent **)** |const| +:ref:`int` **agent_get_avoidance_mask**\ (\ agent\: :ref:`RID`\ ) |const| Returns the ``avoidance_mask`` bitmask of the specified ``agent``. @@ -525,7 +527,7 @@ Returns the ``avoidance_mask`` bitmask of the specified ``agent``. .. rst-class:: classref-method -:ref:`float` **agent_get_avoidance_priority** **(** :ref:`RID` agent **)** |const| +:ref:`float` **agent_get_avoidance_priority**\ (\ agent\: :ref:`RID`\ ) |const| Returns the ``avoidance_priority`` of the specified ``agent``. @@ -537,7 +539,7 @@ Returns the ``avoidance_priority`` of the specified ``agent``. .. rst-class:: classref-method -:ref:`float` **agent_get_height** **(** :ref:`RID` agent **)** |const| +:ref:`float` **agent_get_height**\ (\ agent\: :ref:`RID`\ ) |const| Returns the ``height`` of the specified ``agent``. @@ -549,7 +551,7 @@ Returns the ``height`` of the specified ``agent``. .. rst-class:: classref-method -:ref:`RID` **agent_get_map** **(** :ref:`RID` agent **)** |const| +:ref:`RID` **agent_get_map**\ (\ agent\: :ref:`RID`\ ) |const| Returns the navigation map :ref:`RID` the requested ``agent`` is currently assigned to. @@ -561,7 +563,7 @@ Returns the navigation map :ref:`RID` the requested ``agent`` is curr .. rst-class:: classref-method -:ref:`int` **agent_get_max_neighbors** **(** :ref:`RID` agent **)** |const| +:ref:`int` **agent_get_max_neighbors**\ (\ agent\: :ref:`RID`\ ) |const| Returns the maximum number of other agents the specified ``agent`` takes into account in the navigation. @@ -573,7 +575,7 @@ Returns the maximum number of other agents the specified ``agent`` takes into ac .. rst-class:: classref-method -:ref:`float` **agent_get_max_speed** **(** :ref:`RID` agent **)** |const| +:ref:`float` **agent_get_max_speed**\ (\ agent\: :ref:`RID`\ ) |const| Returns the maximum speed of the specified ``agent``. @@ -585,7 +587,7 @@ Returns the maximum speed of the specified ``agent``. .. rst-class:: classref-method -:ref:`float` **agent_get_neighbor_distance** **(** :ref:`RID` agent **)** |const| +:ref:`float` **agent_get_neighbor_distance**\ (\ agent\: :ref:`RID`\ ) |const| Returns the maximum distance to other agents the specified ``agent`` takes into account in the navigation. @@ -597,7 +599,7 @@ Returns the maximum distance to other agents the specified ``agent`` takes into .. rst-class:: classref-method -:ref:`bool` **agent_get_paused** **(** :ref:`RID` agent **)** |const| +:ref:`bool` **agent_get_paused**\ (\ agent\: :ref:`RID`\ ) |const| Returns ``true`` if the specified ``agent`` is paused. @@ -609,7 +611,7 @@ Returns ``true`` if the specified ``agent`` is paused. .. rst-class:: classref-method -:ref:`Vector3` **agent_get_position** **(** :ref:`RID` agent **)** |const| +:ref:`Vector3` **agent_get_position**\ (\ agent\: :ref:`RID`\ ) |const| Returns the position of the specified ``agent`` in world space. @@ -621,7 +623,7 @@ Returns the position of the specified ``agent`` in world space. .. rst-class:: classref-method -:ref:`float` **agent_get_radius** **(** :ref:`RID` agent **)** |const| +:ref:`float` **agent_get_radius**\ (\ agent\: :ref:`RID`\ ) |const| Returns the radius of the specified ``agent``. @@ -633,7 +635,7 @@ Returns the radius of the specified ``agent``. .. rst-class:: classref-method -:ref:`float` **agent_get_time_horizon_agents** **(** :ref:`RID` agent **)** |const| +:ref:`float` **agent_get_time_horizon_agents**\ (\ agent\: :ref:`RID`\ ) |const| Returns the minimal amount of time for which the specified ``agent``'s velocities that are computed by the simulation are safe with respect to other agents. @@ -645,7 +647,7 @@ Returns the minimal amount of time for which the specified ``agent``'s velocitie .. rst-class:: classref-method -:ref:`float` **agent_get_time_horizon_obstacles** **(** :ref:`RID` agent **)** |const| +:ref:`float` **agent_get_time_horizon_obstacles**\ (\ agent\: :ref:`RID`\ ) |const| Returns the minimal amount of time for which the specified ``agent``'s velocities that are computed by the simulation are safe with respect to static avoidance obstacles. @@ -657,7 +659,7 @@ Returns the minimal amount of time for which the specified ``agent``'s velocitie .. rst-class:: classref-method -:ref:`bool` **agent_get_use_3d_avoidance** **(** :ref:`RID` agent **)** |const| +:ref:`bool` **agent_get_use_3d_avoidance**\ (\ agent\: :ref:`RID`\ ) |const| Returns ``true`` if the provided ``agent`` uses avoidance in 3D space Vector3(x,y,z) instead of horizontal 2D Vector2(x,y) / Vector3(x,0.0,z). @@ -669,7 +671,7 @@ Returns ``true`` if the provided ``agent`` uses avoidance in 3D space Vector3(x, .. rst-class:: classref-method -:ref:`Vector3` **agent_get_velocity** **(** :ref:`RID` agent **)** |const| +:ref:`Vector3` **agent_get_velocity**\ (\ agent\: :ref:`RID`\ ) |const| Returns the velocity of the specified ``agent``. @@ -681,7 +683,7 @@ Returns the velocity of the specified ``agent``. .. rst-class:: classref-method -:ref:`bool` **agent_has_avoidance_callback** **(** :ref:`RID` agent **)** |const| +:ref:`bool` **agent_has_avoidance_callback**\ (\ agent\: :ref:`RID`\ ) |const| Return ``true`` if the specified ``agent`` has an avoidance callback. @@ -693,7 +695,7 @@ Return ``true`` if the specified ``agent`` has an avoidance callback. .. rst-class:: classref-method -:ref:`bool` **agent_is_map_changed** **(** :ref:`RID` agent **)** |const| +:ref:`bool` **agent_is_map_changed**\ (\ agent\: :ref:`RID`\ ) |const| Returns true if the map got changed the previous frame. @@ -705,7 +707,7 @@ Returns true if the map got changed the previous frame. .. rst-class:: classref-method -void **agent_set_avoidance_callback** **(** :ref:`RID` agent, :ref:`Callable` callback **)** +|void| **agent_set_avoidance_callback**\ (\ agent\: :ref:`RID`, callback\: :ref:`Callable`\ ) Sets the callback :ref:`Callable` that gets called after each avoidance processing step for the ``agent``. The calculated ``safe_velocity`` will be dispatched with a signal to the object just before the physics calculations. @@ -719,7 +721,7 @@ Sets the callback :ref:`Callable` that gets called after each av .. rst-class:: classref-method -void **agent_set_avoidance_enabled** **(** :ref:`RID` agent, :ref:`bool` enabled **)** +|void| **agent_set_avoidance_enabled**\ (\ agent\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``enabled`` is ``true``, the provided ``agent`` calculates avoidance. @@ -731,7 +733,7 @@ If ``enabled`` is ``true``, the provided ``agent`` calculates avoidance. .. rst-class:: classref-method -void **agent_set_avoidance_layers** **(** :ref:`RID` agent, :ref:`int` layers **)** +|void| **agent_set_avoidance_layers**\ (\ agent\: :ref:`RID`, layers\: :ref:`int`\ ) Set the agent's ``avoidance_layers`` bitmask. @@ -743,7 +745,7 @@ Set the agent's ``avoidance_layers`` bitmask. .. rst-class:: classref-method -void **agent_set_avoidance_mask** **(** :ref:`RID` agent, :ref:`int` mask **)** +|void| **agent_set_avoidance_mask**\ (\ agent\: :ref:`RID`, mask\: :ref:`int`\ ) Set the agent's ``avoidance_mask`` bitmask. @@ -755,7 +757,7 @@ Set the agent's ``avoidance_mask`` bitmask. .. rst-class:: classref-method -void **agent_set_avoidance_priority** **(** :ref:`RID` agent, :ref:`float` priority **)** +|void| **agent_set_avoidance_priority**\ (\ agent\: :ref:`RID`, priority\: :ref:`float`\ ) Set the agent's ``avoidance_priority`` with a ``priority`` between 0.0 (lowest priority) to 1.0 (highest priority). @@ -769,7 +771,7 @@ The specified ``agent`` does not adjust the velocity for other agents that would .. rst-class:: classref-method -void **agent_set_height** **(** :ref:`RID` agent, :ref:`float` height **)** +|void| **agent_set_height**\ (\ agent\: :ref:`RID`, height\: :ref:`float`\ ) Updates the provided ``agent`` ``height``. @@ -781,7 +783,7 @@ Updates the provided ``agent`` ``height``. .. rst-class:: classref-method -void **agent_set_map** **(** :ref:`RID` agent, :ref:`RID` map **)** +|void| **agent_set_map**\ (\ agent\: :ref:`RID`, map\: :ref:`RID`\ ) Puts the agent in the map. @@ -793,7 +795,7 @@ Puts the agent in the map. .. rst-class:: classref-method -void **agent_set_max_neighbors** **(** :ref:`RID` agent, :ref:`int` count **)** +|void| **agent_set_max_neighbors**\ (\ agent\: :ref:`RID`, count\: :ref:`int`\ ) Sets the maximum number of other agents the agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. @@ -805,7 +807,7 @@ Sets the maximum number of other agents the agent takes into account in the navi .. rst-class:: classref-method -void **agent_set_max_speed** **(** :ref:`RID` agent, :ref:`float` max_speed **)** +|void| **agent_set_max_speed**\ (\ agent\: :ref:`RID`, max_speed\: :ref:`float`\ ) Sets the maximum speed of the agent. Must be positive. @@ -817,7 +819,7 @@ Sets the maximum speed of the agent. Must be positive. .. rst-class:: classref-method -void **agent_set_neighbor_distance** **(** :ref:`RID` agent, :ref:`float` distance **)** +|void| **agent_set_neighbor_distance**\ (\ agent\: :ref:`RID`, distance\: :ref:`float`\ ) Sets the maximum distance to other agents this agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. @@ -829,7 +831,7 @@ Sets the maximum distance to other agents this agent takes into account in the n .. rst-class:: classref-method -void **agent_set_paused** **(** :ref:`RID` agent, :ref:`bool` paused **)** +|void| **agent_set_paused**\ (\ agent\: :ref:`RID`, paused\: :ref:`bool`\ ) If ``paused`` is true the specified ``agent`` will not be processed, e.g. calculate avoidance velocities or receive avoidance callbacks. @@ -841,7 +843,7 @@ If ``paused`` is true the specified ``agent`` will not be processed, e.g. calcul .. rst-class:: classref-method -void **agent_set_position** **(** :ref:`RID` agent, :ref:`Vector3` position **)** +|void| **agent_set_position**\ (\ agent\: :ref:`RID`, position\: :ref:`Vector3`\ ) Sets the position of the agent in world space. @@ -853,7 +855,7 @@ Sets the position of the agent in world space. .. rst-class:: classref-method -void **agent_set_radius** **(** :ref:`RID` agent, :ref:`float` radius **)** +|void| **agent_set_radius**\ (\ agent\: :ref:`RID`, radius\: :ref:`float`\ ) Sets the radius of the agent. @@ -865,7 +867,7 @@ Sets the radius of the agent. .. rst-class:: classref-method -void **agent_set_time_horizon_agents** **(** :ref:`RID` agent, :ref:`float` time_horizon **)** +|void| **agent_set_time_horizon_agents**\ (\ agent\: :ref:`RID`, time_horizon\: :ref:`float`\ ) The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to other agents. The larger this number, the sooner this agent will respond to the presence of other agents, but the less freedom this agent has in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. @@ -877,7 +879,7 @@ The minimal amount of time for which the agent's velocities that are computed by .. rst-class:: classref-method -void **agent_set_time_horizon_obstacles** **(** :ref:`RID` agent, :ref:`float` time_horizon **)** +|void| **agent_set_time_horizon_obstacles**\ (\ agent\: :ref:`RID`, time_horizon\: :ref:`float`\ ) The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to static avoidance obstacles. The larger this number, the sooner this agent will respond to the presence of static avoidance obstacles, but the less freedom this agent has in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. @@ -889,7 +891,7 @@ The minimal amount of time for which the agent's velocities that are computed by .. rst-class:: classref-method -void **agent_set_use_3d_avoidance** **(** :ref:`RID` agent, :ref:`bool` enabled **)** +|void| **agent_set_use_3d_avoidance**\ (\ agent\: :ref:`RID`, enabled\: :ref:`bool`\ ) Sets if the agent uses the 2D avoidance or the 3D avoidance while avoidance is enabled. @@ -905,7 +907,7 @@ If ``false`` the agent calculates avoidance velocities in 2D along the xz-axis i .. rst-class:: classref-method -void **agent_set_velocity** **(** :ref:`RID` agent, :ref:`Vector3` velocity **)** +|void| **agent_set_velocity**\ (\ agent\: :ref:`RID`, velocity\: :ref:`Vector3`\ ) Sets ``velocity`` as the new wanted velocity for the specified ``agent``. The avoidance simulation will try to fulfill this velocity if possible but will modify it to avoid collision with other agent's and obstacles. When an agent is teleported to a new position use :ref:`agent_set_velocity_forced` as well to reset the internal simulation velocity. @@ -917,7 +919,7 @@ Sets ``velocity`` as the new wanted velocity for the specified ``agent``. The av .. rst-class:: classref-method -void **agent_set_velocity_forced** **(** :ref:`RID` agent, :ref:`Vector3` velocity **)** +|void| **agent_set_velocity_forced**\ (\ agent\: :ref:`RID`, velocity\: :ref:`Vector3`\ ) Replaces the internal velocity in the collision avoidance simulation with ``velocity`` for the specified ``agent``. When an agent is teleported to a new position this function should be used in the same frame. If called frequently this function can get agents stuck. @@ -929,7 +931,7 @@ Replaces the internal velocity in the collision avoidance simulation with ``velo .. rst-class:: classref-method -void **bake_from_source_geometry_data** **(** :ref:`NavigationMesh` navigation_mesh, :ref:`NavigationMeshSourceGeometryData3D` source_geometry_data, :ref:`Callable` callback=Callable() **)** +|void| **bake_from_source_geometry_data**\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, callback\: :ref:`Callable` = Callable()\ ) Bakes the provided ``navigation_mesh`` with the data from the provided ``source_geometry_data``. After the process is finished the optional ``callback`` will be called. @@ -941,7 +943,7 @@ Bakes the provided ``navigation_mesh`` with the data from the provided ``source_ .. rst-class:: classref-method -void **bake_from_source_geometry_data_async** **(** :ref:`NavigationMesh` navigation_mesh, :ref:`NavigationMeshSourceGeometryData3D` source_geometry_data, :ref:`Callable` callback=Callable() **)** +|void| **bake_from_source_geometry_data_async**\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, callback\: :ref:`Callable` = Callable()\ ) Bakes the provided ``navigation_mesh`` with the data from the provided ``source_geometry_data`` as an async task running on a background thread. After the process is finished the optional ``callback`` will be called. @@ -953,7 +955,7 @@ Bakes the provided ``navigation_mesh`` with the data from the provided ``source_ .. rst-class:: classref-method -void **free_rid** **(** :ref:`RID` rid **)** +|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) Destroys the given RID. @@ -965,7 +967,7 @@ Destroys the given RID. .. rst-class:: classref-method -:ref:`bool` **get_debug_enabled** **(** **)** |const| +:ref:`bool` **get_debug_enabled**\ (\ ) |const| Returns ``true`` when the NavigationServer has debug enabled. @@ -977,7 +979,7 @@ Returns ``true`` when the NavigationServer has debug enabled. .. rst-class:: classref-method -:ref:`RID[]` **get_maps** **(** **)** |const| +:ref:`Array`\[:ref:`RID`\] **get_maps**\ (\ ) |const| Returns all created navigation map :ref:`RID`\ s on the NavigationServer. This returns both 2D and 3D created navigation maps as there is technically no distinction between them. @@ -989,7 +991,7 @@ Returns all created navigation map :ref:`RID`\ s on the NavigationSer .. rst-class:: classref-method -:ref:`int` **get_process_info** **(** :ref:`ProcessInfo` process_info **)** |const| +:ref:`int` **get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) |const| Returns information about the current state of the NavigationServer. See :ref:`ProcessInfo` for a list of available states. @@ -1001,7 +1003,7 @@ Returns information about the current state of the NavigationServer. See :ref:`P .. rst-class:: classref-method -:ref:`bool` **is_baking_navigation_mesh** **(** :ref:`NavigationMesh` navigation_mesh **)** |const| +:ref:`bool` **is_baking_navigation_mesh**\ (\ navigation_mesh\: :ref:`NavigationMesh`\ ) |const| Returns ``true`` when the provided navigation mesh is being baked on a background thread. @@ -1013,7 +1015,7 @@ Returns ``true`` when the provided navigation mesh is being baked on a backgroun .. rst-class:: classref-method -:ref:`RID` **link_create** **(** **)** +:ref:`RID` **link_create**\ (\ ) Create a new link between two positions on a map. @@ -1025,7 +1027,7 @@ Create a new link between two positions on a map. .. rst-class:: classref-method -:ref:`bool` **link_get_enabled** **(** :ref:`RID` link **)** |const| +:ref:`bool` **link_get_enabled**\ (\ link\: :ref:`RID`\ ) |const| Returns ``true`` if the specified ``link`` is enabled. @@ -1037,7 +1039,7 @@ Returns ``true`` if the specified ``link`` is enabled. .. rst-class:: classref-method -:ref:`Vector3` **link_get_end_position** **(** :ref:`RID` link **)** |const| +:ref:`Vector3` **link_get_end_position**\ (\ link\: :ref:`RID`\ ) |const| Returns the ending position of this ``link``. @@ -1049,7 +1051,7 @@ Returns the ending position of this ``link``. .. rst-class:: classref-method -:ref:`float` **link_get_enter_cost** **(** :ref:`RID` link **)** |const| +:ref:`float` **link_get_enter_cost**\ (\ link\: :ref:`RID`\ ) |const| Returns the enter cost of this ``link``. @@ -1061,7 +1063,7 @@ Returns the enter cost of this ``link``. .. rst-class:: classref-method -:ref:`RID` **link_get_map** **(** :ref:`RID` link **)** |const| +:ref:`RID` **link_get_map**\ (\ link\: :ref:`RID`\ ) |const| Returns the navigation map :ref:`RID` the requested ``link`` is currently assigned to. @@ -1073,7 +1075,7 @@ Returns the navigation map :ref:`RID` the requested ``link`` is curre .. rst-class:: classref-method -:ref:`int` **link_get_navigation_layers** **(** :ref:`RID` link **)** |const| +:ref:`int` **link_get_navigation_layers**\ (\ link\: :ref:`RID`\ ) |const| Returns the navigation layers for this ``link``. @@ -1085,7 +1087,7 @@ Returns the navigation layers for this ``link``. .. rst-class:: classref-method -:ref:`int` **link_get_owner_id** **(** :ref:`RID` link **)** |const| +:ref:`int` **link_get_owner_id**\ (\ link\: :ref:`RID`\ ) |const| Returns the ``ObjectID`` of the object which manages this link. @@ -1097,7 +1099,7 @@ Returns the ``ObjectID`` of the object which manages this link. .. rst-class:: classref-method -:ref:`Vector3` **link_get_start_position** **(** :ref:`RID` link **)** |const| +:ref:`Vector3` **link_get_start_position**\ (\ link\: :ref:`RID`\ ) |const| Returns the starting position of this ``link``. @@ -1109,7 +1111,7 @@ Returns the starting position of this ``link``. .. rst-class:: classref-method -:ref:`float` **link_get_travel_cost** **(** :ref:`RID` link **)** |const| +:ref:`float` **link_get_travel_cost**\ (\ link\: :ref:`RID`\ ) |const| Returns the travel cost of this ``link``. @@ -1121,7 +1123,7 @@ Returns the travel cost of this ``link``. .. rst-class:: classref-method -:ref:`bool` **link_is_bidirectional** **(** :ref:`RID` link **)** |const| +:ref:`bool` **link_is_bidirectional**\ (\ link\: :ref:`RID`\ ) |const| Returns whether this ``link`` can be travelled in both directions. @@ -1133,7 +1135,7 @@ Returns whether this ``link`` can be travelled in both directions. .. rst-class:: classref-method -void **link_set_bidirectional** **(** :ref:`RID` link, :ref:`bool` bidirectional **)** +|void| **link_set_bidirectional**\ (\ link\: :ref:`RID`, bidirectional\: :ref:`bool`\ ) Sets whether this ``link`` can be travelled in both directions. @@ -1145,7 +1147,7 @@ Sets whether this ``link`` can be travelled in both directions. .. rst-class:: classref-method -void **link_set_enabled** **(** :ref:`RID` link, :ref:`bool` enabled **)** +|void| **link_set_enabled**\ (\ link\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``enabled`` is ``true``, the specified ``link`` will contribute to its current navigation map. @@ -1157,7 +1159,7 @@ If ``enabled`` is ``true``, the specified ``link`` will contribute to its curren .. rst-class:: classref-method -void **link_set_end_position** **(** :ref:`RID` link, :ref:`Vector3` position **)** +|void| **link_set_end_position**\ (\ link\: :ref:`RID`, position\: :ref:`Vector3`\ ) Sets the exit position for the ``link``. @@ -1169,7 +1171,7 @@ Sets the exit position for the ``link``. .. rst-class:: classref-method -void **link_set_enter_cost** **(** :ref:`RID` link, :ref:`float` enter_cost **)** +|void| **link_set_enter_cost**\ (\ link\: :ref:`RID`, enter_cost\: :ref:`float`\ ) Sets the ``enter_cost`` for this ``link``. @@ -1181,7 +1183,7 @@ Sets the ``enter_cost`` for this ``link``. .. rst-class:: classref-method -void **link_set_map** **(** :ref:`RID` link, :ref:`RID` map **)** +|void| **link_set_map**\ (\ link\: :ref:`RID`, map\: :ref:`RID`\ ) Sets the navigation map :ref:`RID` for the link. @@ -1193,7 +1195,7 @@ Sets the navigation map :ref:`RID` for the link. .. rst-class:: classref-method -void **link_set_navigation_layers** **(** :ref:`RID` link, :ref:`int` navigation_layers **)** +|void| **link_set_navigation_layers**\ (\ link\: :ref:`RID`, navigation_layers\: :ref:`int`\ ) Set the links's navigation layers. This allows selecting links from a path request (when using :ref:`map_get_path`). @@ -1205,7 +1207,7 @@ Set the links's navigation layers. This allows selecting links from a path reque .. rst-class:: classref-method -void **link_set_owner_id** **(** :ref:`RID` link, :ref:`int` owner_id **)** +|void| **link_set_owner_id**\ (\ link\: :ref:`RID`, owner_id\: :ref:`int`\ ) Set the ``ObjectID`` of the object which manages this link. @@ -1217,7 +1219,7 @@ Set the ``ObjectID`` of the object which manages this link. .. rst-class:: classref-method -void **link_set_start_position** **(** :ref:`RID` link, :ref:`Vector3` position **)** +|void| **link_set_start_position**\ (\ link\: :ref:`RID`, position\: :ref:`Vector3`\ ) Sets the entry position for this ``link``. @@ -1229,7 +1231,7 @@ Sets the entry position for this ``link``. .. rst-class:: classref-method -void **link_set_travel_cost** **(** :ref:`RID` link, :ref:`float` travel_cost **)** +|void| **link_set_travel_cost**\ (\ link\: :ref:`RID`, travel_cost\: :ref:`float`\ ) Sets the ``travel_cost`` for this ``link``. @@ -1241,7 +1243,7 @@ Sets the ``travel_cost`` for this ``link``. .. rst-class:: classref-method -:ref:`RID` **map_create** **(** **)** +:ref:`RID` **map_create**\ (\ ) Create a new map. @@ -1253,7 +1255,7 @@ Create a new map. .. rst-class:: classref-method -void **map_force_update** **(** :ref:`RID` map **)** +|void| **map_force_update**\ (\ map\: :ref:`RID`\ ) This function immediately forces synchronization of the specified navigation ``map`` :ref:`RID`. By default navigation maps are only synchronized at the end of each physics frame. This function can be used to immediately (re)calculate all the navigation meshes and region connections of the navigation map. This makes it possible to query a navigation path for a changed map immediately and in the same frame (multiple times if needed). @@ -1271,7 +1273,7 @@ Avoidance processing and dispatch of the ``safe_velocity`` signals is unaffected .. rst-class:: classref-method -:ref:`RID[]` **map_get_agents** **(** :ref:`RID` map **)** |const| +:ref:`Array`\[:ref:`RID`\] **map_get_agents**\ (\ map\: :ref:`RID`\ ) |const| Returns all navigation agents :ref:`RID`\ s that are currently assigned to the requested navigation ``map``. @@ -1283,7 +1285,7 @@ Returns all navigation agents :ref:`RID`\ s that are currently assign .. rst-class:: classref-method -:ref:`float` **map_get_cell_height** **(** :ref:`RID` map **)** |const| +:ref:`float` **map_get_cell_height**\ (\ map\: :ref:`RID`\ ) |const| Returns the map cell height used to rasterize the navigation mesh vertices on the Y axis. @@ -1295,7 +1297,7 @@ Returns the map cell height used to rasterize the navigation mesh vertices on th .. rst-class:: classref-method -:ref:`float` **map_get_cell_size** **(** :ref:`RID` map **)** |const| +:ref:`float` **map_get_cell_size**\ (\ map\: :ref:`RID`\ ) |const| Returns the map cell size used to rasterize the navigation mesh vertices on the XZ plane. @@ -1307,7 +1309,7 @@ Returns the map cell size used to rasterize the navigation mesh vertices on the .. rst-class:: classref-method -:ref:`Vector3` **map_get_closest_point** **(** :ref:`RID` map, :ref:`Vector3` to_point **)** |const| +:ref:`Vector3` **map_get_closest_point**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| Returns the point closest to the provided ``to_point`` on the navigation mesh surface. @@ -1319,7 +1321,7 @@ Returns the point closest to the provided ``to_point`` on the navigation mesh su .. rst-class:: classref-method -:ref:`Vector3` **map_get_closest_point_normal** **(** :ref:`RID` map, :ref:`Vector3` to_point **)** |const| +:ref:`Vector3` **map_get_closest_point_normal**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| Returns the normal for the point returned by :ref:`map_get_closest_point`. @@ -1331,7 +1333,7 @@ Returns the normal for the point returned by :ref:`map_get_closest_point` **map_get_closest_point_owner** **(** :ref:`RID` map, :ref:`Vector3` to_point **)** |const| +:ref:`RID` **map_get_closest_point_owner**\ (\ map\: :ref:`RID`, to_point\: :ref:`Vector3`\ ) |const| Returns the owner region RID for the point returned by :ref:`map_get_closest_point`. @@ -1343,7 +1345,7 @@ Returns the owner region RID for the point returned by :ref:`map_get_closest_poi .. rst-class:: classref-method -:ref:`Vector3` **map_get_closest_point_to_segment** **(** :ref:`RID` map, :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** |const| +:ref:`Vector3` **map_get_closest_point_to_segment**\ (\ map\: :ref:`RID`, start\: :ref:`Vector3`, end\: :ref:`Vector3`, use_collision\: :ref:`bool` = false\ ) |const| Returns the closest point between the navigation surface and the segment. @@ -1355,7 +1357,7 @@ Returns the closest point between the navigation surface and the segment. .. rst-class:: classref-method -:ref:`float` **map_get_edge_connection_margin** **(** :ref:`RID` map **)** |const| +:ref:`float` **map_get_edge_connection_margin**\ (\ map\: :ref:`RID`\ ) |const| Returns the edge connection margin of the map. This distance is the minimum vertex distance needed to connect two edges from different regions. @@ -1363,11 +1365,25 @@ Returns the edge connection margin of the map. This distance is the minimum vert ---- +.. _class_NavigationServer3D_method_map_get_iteration_id: + +.. rst-class:: classref-method + +:ref:`int` **map_get_iteration_id**\ (\ map\: :ref:`RID`\ ) |const| + +Returns the current iteration id of the navigation map. Every time the navigation map changes and synchronizes the iteration id increases. An iteration id of 0 means the navigation map has never synchronized. + +\ **Note:** The iteration id will wrap back to 1 after reaching its range limit. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer3D_method_map_get_link_connection_radius: .. rst-class:: classref-method -:ref:`float` **map_get_link_connection_radius** **(** :ref:`RID` map **)** |const| +:ref:`float` **map_get_link_connection_radius**\ (\ map\: :ref:`RID`\ ) |const| Returns the link connection radius of the map. This distance is the maximum range any link will search for navigation mesh polygons to connect to. @@ -1379,7 +1395,7 @@ Returns the link connection radius of the map. This distance is the maximum rang .. rst-class:: classref-method -:ref:`RID[]` **map_get_links** **(** :ref:`RID` map **)** |const| +:ref:`Array`\[:ref:`RID`\] **map_get_links**\ (\ map\: :ref:`RID`\ ) |const| Returns all navigation link :ref:`RID`\ s that are currently assigned to the requested navigation ``map``. @@ -1391,7 +1407,7 @@ Returns all navigation link :ref:`RID`\ s that are currently assigned .. rst-class:: classref-method -:ref:`float` **map_get_merge_rasterizer_cell_scale** **(** :ref:`RID` map **)** |const| +:ref:`float` **map_get_merge_rasterizer_cell_scale**\ (\ map\: :ref:`RID`\ ) |const| Returns map's internal merge rasterizer cell scale. @@ -1403,7 +1419,7 @@ Returns map's internal merge rasterizer cell scale. .. rst-class:: classref-method -:ref:`RID[]` **map_get_obstacles** **(** :ref:`RID` map **)** |const| +:ref:`Array`\[:ref:`RID`\] **map_get_obstacles**\ (\ map\: :ref:`RID`\ ) |const| Returns all navigation obstacle :ref:`RID`\ s that are currently assigned to the requested navigation ``map``. @@ -1415,7 +1431,7 @@ Returns all navigation obstacle :ref:`RID`\ s that are currently assi .. rst-class:: classref-method -:ref:`PackedVector3Array` **map_get_path** **(** :ref:`RID` map, :ref:`Vector3` origin, :ref:`Vector3` destination, :ref:`bool` optimize, :ref:`int` navigation_layers=1 **)** |const| +:ref:`PackedVector3Array` **map_get_path**\ (\ map\: :ref:`RID`, origin\: :ref:`Vector3`, destination\: :ref:`Vector3`, optimize\: :ref:`bool`, navigation_layers\: :ref:`int` = 1\ ) |const| Returns the navigation path to reach the destination from the origin. ``navigation_layers`` is a bitmask of all region navigation layers that are allowed to be in the path. @@ -1427,7 +1443,7 @@ Returns the navigation path to reach the destination from the origin. ``navigati .. rst-class:: classref-method -:ref:`Vector3` **map_get_random_point** **(** :ref:`RID` map, :ref:`int` navigation_layers, :ref:`bool` uniformly **)** |const| +:ref:`Vector3` **map_get_random_point**\ (\ map\: :ref:`RID`, navigation_layers\: :ref:`int`, uniformly\: :ref:`bool`\ ) |const| Returns a random position picked from all map region polygons with matching ``navigation_layers``. @@ -1443,7 +1459,7 @@ If ``uniformly`` is ``false``, just a random region and a random polygon are pic .. rst-class:: classref-method -:ref:`RID[]` **map_get_regions** **(** :ref:`RID` map **)** |const| +:ref:`Array`\[:ref:`RID`\] **map_get_regions**\ (\ map\: :ref:`RID`\ ) |const| Returns all navigation regions :ref:`RID`\ s that are currently assigned to the requested navigation ``map``. @@ -1455,7 +1471,7 @@ Returns all navigation regions :ref:`RID`\ s that are currently assig .. rst-class:: classref-method -:ref:`Vector3` **map_get_up** **(** :ref:`RID` map **)** |const| +:ref:`Vector3` **map_get_up**\ (\ map\: :ref:`RID`\ ) |const| Returns the map's up direction. @@ -1467,7 +1483,7 @@ Returns the map's up direction. .. rst-class:: classref-method -:ref:`bool` **map_get_use_edge_connections** **(** :ref:`RID` map **)** |const| +:ref:`bool` **map_get_use_edge_connections**\ (\ map\: :ref:`RID`\ ) |const| Returns true if the navigation ``map`` allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -1479,7 +1495,7 @@ Returns true if the navigation ``map`` allows navigation regions to use edge con .. rst-class:: classref-method -:ref:`bool` **map_is_active** **(** :ref:`RID` map **)** |const| +:ref:`bool` **map_is_active**\ (\ map\: :ref:`RID`\ ) |const| Returns true if the map is active. @@ -1491,7 +1507,7 @@ Returns true if the map is active. .. rst-class:: classref-method -void **map_set_active** **(** :ref:`RID` map, :ref:`bool` active **)** +|void| **map_set_active**\ (\ map\: :ref:`RID`, active\: :ref:`bool`\ ) Sets the map active. @@ -1503,7 +1519,7 @@ Sets the map active. .. rst-class:: classref-method -void **map_set_cell_height** **(** :ref:`RID` map, :ref:`float` cell_height **)** +|void| **map_set_cell_height**\ (\ map\: :ref:`RID`, cell_height\: :ref:`float`\ ) Sets the map cell height used to rasterize the navigation mesh vertices on the Y axis. Must match with the cell height of the used navigation meshes. @@ -1515,7 +1531,7 @@ Sets the map cell height used to rasterize the navigation mesh vertices on the Y .. rst-class:: classref-method -void **map_set_cell_size** **(** :ref:`RID` map, :ref:`float` cell_size **)** +|void| **map_set_cell_size**\ (\ map\: :ref:`RID`, cell_size\: :ref:`float`\ ) Sets the map cell size used to rasterize the navigation mesh vertices on the XZ plane. Must match with the cell size of the used navigation meshes. @@ -1527,7 +1543,7 @@ Sets the map cell size used to rasterize the navigation mesh vertices on the XZ .. rst-class:: classref-method -void **map_set_edge_connection_margin** **(** :ref:`RID` map, :ref:`float` margin **)** +|void| **map_set_edge_connection_margin**\ (\ map\: :ref:`RID`, margin\: :ref:`float`\ ) Set the map edge connection margin used to weld the compatible region edges. @@ -1539,7 +1555,7 @@ Set the map edge connection margin used to weld the compatible region edges. .. rst-class:: classref-method -void **map_set_link_connection_radius** **(** :ref:`RID` map, :ref:`float` radius **)** +|void| **map_set_link_connection_radius**\ (\ map\: :ref:`RID`, radius\: :ref:`float`\ ) Set the map's link connection radius used to connect links to navigation polygons. @@ -1551,7 +1567,7 @@ Set the map's link connection radius used to connect links to navigation polygon .. rst-class:: classref-method -void **map_set_merge_rasterizer_cell_scale** **(** :ref:`RID` map, :ref:`float` scale **)** +|void| **map_set_merge_rasterizer_cell_scale**\ (\ map\: :ref:`RID`, scale\: :ref:`float`\ ) Set the map's internal merge rasterizer cell scale used to control merging sensitivity. @@ -1563,7 +1579,7 @@ Set the map's internal merge rasterizer cell scale used to control merging sensi .. rst-class:: classref-method -void **map_set_up** **(** :ref:`RID` map, :ref:`Vector3` up **)** +|void| **map_set_up**\ (\ map\: :ref:`RID`, up\: :ref:`Vector3`\ ) Sets the map up direction. @@ -1575,7 +1591,7 @@ Sets the map up direction. .. rst-class:: classref-method -void **map_set_use_edge_connections** **(** :ref:`RID` map, :ref:`bool` enabled **)** +|void| **map_set_use_edge_connections**\ (\ map\: :ref:`RID`, enabled\: :ref:`bool`\ ) Set the navigation ``map`` edge connection use. If ``enabled`` is ``true``, the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -1587,7 +1603,7 @@ Set the navigation ``map`` edge connection use. If ``enabled`` is ``true``, the .. rst-class:: classref-method -:ref:`RID` **obstacle_create** **(** **)** +:ref:`RID` **obstacle_create**\ (\ ) Creates a new obstacle. @@ -1599,7 +1615,7 @@ Creates a new obstacle. .. rst-class:: classref-method -:ref:`bool` **obstacle_get_avoidance_enabled** **(** :ref:`RID` obstacle **)** |const| +:ref:`bool` **obstacle_get_avoidance_enabled**\ (\ obstacle\: :ref:`RID`\ ) |const| Returns ``true`` if the provided ``obstacle`` has avoidance enabled. @@ -1611,7 +1627,7 @@ Returns ``true`` if the provided ``obstacle`` has avoidance enabled. .. rst-class:: classref-method -:ref:`int` **obstacle_get_avoidance_layers** **(** :ref:`RID` obstacle **)** |const| +:ref:`int` **obstacle_get_avoidance_layers**\ (\ obstacle\: :ref:`RID`\ ) |const| Returns the ``avoidance_layers`` bitmask of the specified ``obstacle``. @@ -1623,7 +1639,7 @@ Returns the ``avoidance_layers`` bitmask of the specified ``obstacle``. .. rst-class:: classref-method -:ref:`float` **obstacle_get_height** **(** :ref:`RID` obstacle **)** |const| +:ref:`float` **obstacle_get_height**\ (\ obstacle\: :ref:`RID`\ ) |const| Returns the ``height`` of the specified ``obstacle``. @@ -1635,7 +1651,7 @@ Returns the ``height`` of the specified ``obstacle``. .. rst-class:: classref-method -:ref:`RID` **obstacle_get_map** **(** :ref:`RID` obstacle **)** |const| +:ref:`RID` **obstacle_get_map**\ (\ obstacle\: :ref:`RID`\ ) |const| Returns the navigation map :ref:`RID` the requested ``obstacle`` is currently assigned to. @@ -1647,7 +1663,7 @@ Returns the navigation map :ref:`RID` the requested ``obstacle`` is c .. rst-class:: classref-method -:ref:`bool` **obstacle_get_paused** **(** :ref:`RID` obstacle **)** |const| +:ref:`bool` **obstacle_get_paused**\ (\ obstacle\: :ref:`RID`\ ) |const| Returns ``true`` if the specified ``obstacle`` is paused. @@ -1659,7 +1675,7 @@ Returns ``true`` if the specified ``obstacle`` is paused. .. rst-class:: classref-method -:ref:`Vector3` **obstacle_get_position** **(** :ref:`RID` obstacle **)** |const| +:ref:`Vector3` **obstacle_get_position**\ (\ obstacle\: :ref:`RID`\ ) |const| Returns the position of the specified ``obstacle`` in world space. @@ -1671,7 +1687,7 @@ Returns the position of the specified ``obstacle`` in world space. .. rst-class:: classref-method -:ref:`float` **obstacle_get_radius** **(** :ref:`RID` obstacle **)** |const| +:ref:`float` **obstacle_get_radius**\ (\ obstacle\: :ref:`RID`\ ) |const| Returns the radius of the specified dynamic ``obstacle``. @@ -1683,7 +1699,7 @@ Returns the radius of the specified dynamic ``obstacle``. .. rst-class:: classref-method -:ref:`bool` **obstacle_get_use_3d_avoidance** **(** :ref:`RID` obstacle **)** |const| +:ref:`bool` **obstacle_get_use_3d_avoidance**\ (\ obstacle\: :ref:`RID`\ ) |const| Returns ``true`` if the provided ``obstacle`` uses avoidance in 3D space Vector3(x,y,z) instead of horizontal 2D Vector2(x,y) / Vector3(x,0.0,z). @@ -1695,7 +1711,7 @@ Returns ``true`` if the provided ``obstacle`` uses avoidance in 3D space Vector3 .. rst-class:: classref-method -:ref:`Vector3` **obstacle_get_velocity** **(** :ref:`RID` obstacle **)** |const| +:ref:`Vector3` **obstacle_get_velocity**\ (\ obstacle\: :ref:`RID`\ ) |const| Returns the velocity of the specified dynamic ``obstacle``. @@ -1707,7 +1723,7 @@ Returns the velocity of the specified dynamic ``obstacle``. .. rst-class:: classref-method -:ref:`PackedVector3Array` **obstacle_get_vertices** **(** :ref:`RID` obstacle **)** |const| +:ref:`PackedVector3Array` **obstacle_get_vertices**\ (\ obstacle\: :ref:`RID`\ ) |const| Returns the outline vertices for the specified ``obstacle``. @@ -1719,7 +1735,7 @@ Returns the outline vertices for the specified ``obstacle``. .. rst-class:: classref-method -void **obstacle_set_avoidance_enabled** **(** :ref:`RID` obstacle, :ref:`bool` enabled **)** +|void| **obstacle_set_avoidance_enabled**\ (\ obstacle\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``enabled`` is ``true``, the provided ``obstacle`` affects avoidance using agents. @@ -1731,7 +1747,7 @@ If ``enabled`` is ``true``, the provided ``obstacle`` affects avoidance using ag .. rst-class:: classref-method -void **obstacle_set_avoidance_layers** **(** :ref:`RID` obstacle, :ref:`int` layers **)** +|void| **obstacle_set_avoidance_layers**\ (\ obstacle\: :ref:`RID`, layers\: :ref:`int`\ ) Set the obstacles's ``avoidance_layers`` bitmask. @@ -1743,7 +1759,7 @@ Set the obstacles's ``avoidance_layers`` bitmask. .. rst-class:: classref-method -void **obstacle_set_height** **(** :ref:`RID` obstacle, :ref:`float` height **)** +|void| **obstacle_set_height**\ (\ obstacle\: :ref:`RID`, height\: :ref:`float`\ ) Sets the ``height`` for the ``obstacle``. In 3D agents will ignore obstacles that are above or below them while using 2D avoidance. @@ -1755,7 +1771,7 @@ Sets the ``height`` for the ``obstacle``. In 3D agents will ignore obstacles tha .. rst-class:: classref-method -void **obstacle_set_map** **(** :ref:`RID` obstacle, :ref:`RID` map **)** +|void| **obstacle_set_map**\ (\ obstacle\: :ref:`RID`, map\: :ref:`RID`\ ) Assigns the ``obstacle`` to a navigation map. @@ -1767,7 +1783,7 @@ Assigns the ``obstacle`` to a navigation map. .. rst-class:: classref-method -void **obstacle_set_paused** **(** :ref:`RID` obstacle, :ref:`bool` paused **)** +|void| **obstacle_set_paused**\ (\ obstacle\: :ref:`RID`, paused\: :ref:`bool`\ ) If ``paused`` is true the specified ``obstacle`` will not be processed, e.g. affect avoidance velocities. @@ -1779,7 +1795,7 @@ If ``paused`` is true the specified ``obstacle`` will not be processed, e.g. aff .. rst-class:: classref-method -void **obstacle_set_position** **(** :ref:`RID` obstacle, :ref:`Vector3` position **)** +|void| **obstacle_set_position**\ (\ obstacle\: :ref:`RID`, position\: :ref:`Vector3`\ ) Updates the ``position`` in world space for the ``obstacle``. @@ -1791,7 +1807,7 @@ Updates the ``position`` in world space for the ``obstacle``. .. rst-class:: classref-method -void **obstacle_set_radius** **(** :ref:`RID` obstacle, :ref:`float` radius **)** +|void| **obstacle_set_radius**\ (\ obstacle\: :ref:`RID`, radius\: :ref:`float`\ ) Sets the radius of the dynamic obstacle. @@ -1803,7 +1819,7 @@ Sets the radius of the dynamic obstacle. .. rst-class:: classref-method -void **obstacle_set_use_3d_avoidance** **(** :ref:`RID` obstacle, :ref:`bool` enabled **)** +|void| **obstacle_set_use_3d_avoidance**\ (\ obstacle\: :ref:`RID`, enabled\: :ref:`bool`\ ) Sets if the ``obstacle`` uses the 2D avoidance or the 3D avoidance while avoidance is enabled. @@ -1815,7 +1831,7 @@ Sets if the ``obstacle`` uses the 2D avoidance or the 3D avoidance while avoidan .. rst-class:: classref-method -void **obstacle_set_velocity** **(** :ref:`RID` obstacle, :ref:`Vector3` velocity **)** +|void| **obstacle_set_velocity**\ (\ obstacle\: :ref:`RID`, velocity\: :ref:`Vector3`\ ) Sets ``velocity`` of the dynamic ``obstacle``. Allows other agents to better predict the movement of the dynamic obstacle. Only works in combination with the radius of the obstacle. @@ -1827,7 +1843,7 @@ Sets ``velocity`` of the dynamic ``obstacle``. Allows other agents to better pre .. rst-class:: classref-method -void **obstacle_set_vertices** **(** :ref:`RID` obstacle, :ref:`PackedVector3Array` vertices **)** +|void| **obstacle_set_vertices**\ (\ obstacle\: :ref:`RID`, vertices\: :ref:`PackedVector3Array`\ ) Sets the outline vertices for the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out. @@ -1839,7 +1855,7 @@ Sets the outline vertices for the obstacle. If the vertices are winded in clockw .. rst-class:: classref-method -void **parse_source_geometry_data** **(** :ref:`NavigationMesh` navigation_mesh, :ref:`NavigationMeshSourceGeometryData3D` source_geometry_data, :ref:`Node` root_node, :ref:`Callable` callback=Callable() **)** +|void| **parse_source_geometry_data**\ (\ navigation_mesh\: :ref:`NavigationMesh`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D`, root_node\: :ref:`Node`, callback\: :ref:`Callable` = Callable()\ ) Parses the :ref:`SceneTree` for source geometry according to the properties of ``navigation_mesh``. Updates the provided ``source_geometry_data`` resource with the resulting data. The resource can then be used to bake a navigation mesh with :ref:`bake_from_source_geometry_data`. After the process is finished the optional ``callback`` will be called. @@ -1855,7 +1871,7 @@ Parses the :ref:`SceneTree` for source geometry according to th .. rst-class:: classref-method -void **query_path** **(** :ref:`NavigationPathQueryParameters3D` parameters, :ref:`NavigationPathQueryResult3D` result **)** |const| +|void| **query_path**\ (\ parameters\: :ref:`NavigationPathQueryParameters3D`, result\: :ref:`NavigationPathQueryResult3D`\ ) |const| Queries a path in a given navigation map. Start and target position and other parameters are defined through :ref:`NavigationPathQueryParameters3D`. Updates the provided :ref:`NavigationPathQueryResult3D` result object with the path among other results requested by the query. @@ -1867,14 +1883,12 @@ Queries a path in a given navigation map. Start and target position and other pa .. rst-class:: classref-method -void **region_bake_navigation_mesh** **(** :ref:`NavigationMesh` navigation_mesh, :ref:`Node` root_node **)** +|void| **region_bake_navigation_mesh**\ (\ navigation_mesh\: :ref:`NavigationMesh`, root_node\: :ref:`Node`\ ) -**Deprecated:** This method is deprecated due to core threading changes. +**Deprecated:** This method is deprecated due to core threading changes. To upgrade existing code, first create a :ref:`NavigationMeshSourceGeometryData3D` resource. Use this resource with :ref:`parse_source_geometry_data` to parse the :ref:`SceneTree` for nodes that should contribute to the navigation mesh baking. The :ref:`SceneTree` parsing needs to happen on the main thread. After the parsing is finished use the resource with :ref:`bake_from_source_geometry_data` to bake a navigation mesh. Bakes the ``navigation_mesh`` with bake source geometry collected starting from the ``root_node``. -\ *Deprecated.* To upgrade existing code, first create a :ref:`NavigationMeshSourceGeometryData3D` resource. Use this resource with :ref:`parse_source_geometry_data` to parse the SceneTree for nodes that should contribute to the navigation mesh baking. The SceneTree parsing needs to happen on the main thread. After the parsing is finished use the resource with :ref:`bake_from_source_geometry_data` to bake a navigation mesh. - .. rst-class:: classref-item-separator ---- @@ -1883,7 +1897,7 @@ Bakes the ``navigation_mesh`` with bake source geometry collected starting from .. rst-class:: classref-method -:ref:`RID` **region_create** **(** **)** +:ref:`RID` **region_create**\ (\ ) Creates a new region. @@ -1895,7 +1909,7 @@ Creates a new region. .. rst-class:: classref-method -:ref:`Vector3` **region_get_connection_pathway_end** **(** :ref:`RID` region, :ref:`int` connection **)** |const| +:ref:`Vector3` **region_get_connection_pathway_end**\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| Returns the ending point of a connection door. ``connection`` is an index between 0 and the return value of :ref:`region_get_connections_count`. @@ -1907,7 +1921,7 @@ Returns the ending point of a connection door. ``connection`` is an index betwee .. rst-class:: classref-method -:ref:`Vector3` **region_get_connection_pathway_start** **(** :ref:`RID` region, :ref:`int` connection **)** |const| +:ref:`Vector3` **region_get_connection_pathway_start**\ (\ region\: :ref:`RID`, connection\: :ref:`int`\ ) |const| Returns the starting point of a connection door. ``connection`` is an index between 0 and the return value of :ref:`region_get_connections_count`. @@ -1919,7 +1933,7 @@ Returns the starting point of a connection door. ``connection`` is an index betw .. rst-class:: classref-method -:ref:`int` **region_get_connections_count** **(** :ref:`RID` region **)** |const| +:ref:`int` **region_get_connections_count**\ (\ region\: :ref:`RID`\ ) |const| Returns how many connections this ``region`` has with other regions in the map. @@ -1931,7 +1945,7 @@ Returns how many connections this ``region`` has with other regions in the map. .. rst-class:: classref-method -:ref:`bool` **region_get_enabled** **(** :ref:`RID` region **)** |const| +:ref:`bool` **region_get_enabled**\ (\ region\: :ref:`RID`\ ) |const| Returns ``true`` if the specified ``region`` is enabled. @@ -1943,7 +1957,7 @@ Returns ``true`` if the specified ``region`` is enabled. .. rst-class:: classref-method -:ref:`float` **region_get_enter_cost** **(** :ref:`RID` region **)** |const| +:ref:`float` **region_get_enter_cost**\ (\ region\: :ref:`RID`\ ) |const| Returns the enter cost of this ``region``. @@ -1955,7 +1969,7 @@ Returns the enter cost of this ``region``. .. rst-class:: classref-method -:ref:`RID` **region_get_map** **(** :ref:`RID` region **)** |const| +:ref:`RID` **region_get_map**\ (\ region\: :ref:`RID`\ ) |const| Returns the navigation map :ref:`RID` the requested ``region`` is currently assigned to. @@ -1967,7 +1981,7 @@ Returns the navigation map :ref:`RID` the requested ``region`` is cur .. rst-class:: classref-method -:ref:`int` **region_get_navigation_layers** **(** :ref:`RID` region **)** |const| +:ref:`int` **region_get_navigation_layers**\ (\ region\: :ref:`RID`\ ) |const| Returns the region's navigation layers. @@ -1979,7 +1993,7 @@ Returns the region's navigation layers. .. rst-class:: classref-method -:ref:`int` **region_get_owner_id** **(** :ref:`RID` region **)** |const| +:ref:`int` **region_get_owner_id**\ (\ region\: :ref:`RID`\ ) |const| Returns the ``ObjectID`` of the object which manages this region. @@ -1991,7 +2005,7 @@ Returns the ``ObjectID`` of the object which manages this region. .. rst-class:: classref-method -:ref:`Vector3` **region_get_random_point** **(** :ref:`RID` region, :ref:`int` navigation_layers, :ref:`bool` uniformly **)** |const| +:ref:`Vector3` **region_get_random_point**\ (\ region\: :ref:`RID`, navigation_layers\: :ref:`int`, uniformly\: :ref:`bool`\ ) |const| Returns a random position picked from all region polygons with matching ``navigation_layers``. @@ -2007,7 +2021,7 @@ If ``uniformly`` is ``false``, just a random polygon and face is picked (faster) .. rst-class:: classref-method -:ref:`Transform3D` **region_get_transform** **(** :ref:`RID` region **)** |const| +:ref:`Transform3D` **region_get_transform**\ (\ region\: :ref:`RID`\ ) |const| Returns the global transformation of this ``region``. @@ -2019,7 +2033,7 @@ Returns the global transformation of this ``region``. .. rst-class:: classref-method -:ref:`float` **region_get_travel_cost** **(** :ref:`RID` region **)** |const| +:ref:`float` **region_get_travel_cost**\ (\ region\: :ref:`RID`\ ) |const| Returns the travel cost of this ``region``. @@ -2031,7 +2045,7 @@ Returns the travel cost of this ``region``. .. rst-class:: classref-method -:ref:`bool` **region_get_use_edge_connections** **(** :ref:`RID` region **)** |const| +:ref:`bool` **region_get_use_edge_connections**\ (\ region\: :ref:`RID`\ ) |const| Returns true if the navigation ``region`` is set to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -2043,7 +2057,7 @@ Returns true if the navigation ``region`` is set to use edge connections to conn .. rst-class:: classref-method -:ref:`bool` **region_owns_point** **(** :ref:`RID` region, :ref:`Vector3` point **)** |const| +:ref:`bool` **region_owns_point**\ (\ region\: :ref:`RID`, point\: :ref:`Vector3`\ ) |const| Returns ``true`` if the provided ``point`` in world space is currently owned by the provided navigation ``region``. Owned in this context means that one of the region's navigation mesh polygon faces has a possible position at the closest distance to this point compared to all other navigation meshes from other navigation regions that are also registered on the navigation map of the provided region. @@ -2059,7 +2073,7 @@ If multiple navigation meshes have positions at equal distance the navigation re .. rst-class:: classref-method -void **region_set_enabled** **(** :ref:`RID` region, :ref:`bool` enabled **)** +|void| **region_set_enabled**\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``enabled`` is ``true``, the specified ``region`` will contribute to its current navigation map. @@ -2071,7 +2085,7 @@ If ``enabled`` is ``true``, the specified ``region`` will contribute to its curr .. rst-class:: classref-method -void **region_set_enter_cost** **(** :ref:`RID` region, :ref:`float` enter_cost **)** +|void| **region_set_enter_cost**\ (\ region\: :ref:`RID`, enter_cost\: :ref:`float`\ ) Sets the ``enter_cost`` for this ``region``. @@ -2083,7 +2097,7 @@ Sets the ``enter_cost`` for this ``region``. .. rst-class:: classref-method -void **region_set_map** **(** :ref:`RID` region, :ref:`RID` map **)** +|void| **region_set_map**\ (\ region\: :ref:`RID`, map\: :ref:`RID`\ ) Sets the map for the region. @@ -2095,7 +2109,7 @@ Sets the map for the region. .. rst-class:: classref-method -void **region_set_navigation_layers** **(** :ref:`RID` region, :ref:`int` navigation_layers **)** +|void| **region_set_navigation_layers**\ (\ region\: :ref:`RID`, navigation_layers\: :ref:`int`\ ) Set the region's navigation layers. This allows selecting regions from a path request (when using :ref:`map_get_path`). @@ -2107,7 +2121,7 @@ Set the region's navigation layers. This allows selecting regions from a path re .. rst-class:: classref-method -void **region_set_navigation_mesh** **(** :ref:`RID` region, :ref:`NavigationMesh` navigation_mesh **)** +|void| **region_set_navigation_mesh**\ (\ region\: :ref:`RID`, navigation_mesh\: :ref:`NavigationMesh`\ ) Sets the navigation mesh for the region. @@ -2119,7 +2133,7 @@ Sets the navigation mesh for the region. .. rst-class:: classref-method -void **region_set_owner_id** **(** :ref:`RID` region, :ref:`int` owner_id **)** +|void| **region_set_owner_id**\ (\ region\: :ref:`RID`, owner_id\: :ref:`int`\ ) Set the ``ObjectID`` of the object which manages this region. @@ -2131,7 +2145,7 @@ Set the ``ObjectID`` of the object which manages this region. .. rst-class:: classref-method -void **region_set_transform** **(** :ref:`RID` region, :ref:`Transform3D` transform **)** +|void| **region_set_transform**\ (\ region\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) Sets the global transformation for the region. @@ -2143,7 +2157,7 @@ Sets the global transformation for the region. .. rst-class:: classref-method -void **region_set_travel_cost** **(** :ref:`RID` region, :ref:`float` travel_cost **)** +|void| **region_set_travel_cost**\ (\ region\: :ref:`RID`, travel_cost\: :ref:`float`\ ) Sets the ``travel_cost`` for this ``region``. @@ -2155,7 +2169,7 @@ Sets the ``travel_cost`` for this ``region``. .. rst-class:: classref-method -void **region_set_use_edge_connections** **(** :ref:`RID` region, :ref:`bool` enabled **)** +|void| **region_set_use_edge_connections**\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``enabled`` is ``true``, the navigation ``region`` will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -2167,7 +2181,7 @@ If ``enabled`` is ``true``, the navigation ``region`` will use edge connections .. rst-class:: classref-method -void **set_active** **(** :ref:`bool` active **)** +|void| **set_active**\ (\ active\: :ref:`bool`\ ) Control activation of this server. @@ -2179,7 +2193,7 @@ Control activation of this server. .. rst-class:: classref-method -void **set_debug_enabled** **(** :ref:`bool` enabled **)** +|void| **set_debug_enabled**\ (\ enabled\: :ref:`bool`\ ) If ``true`` enables debug mode on the NavigationServer. @@ -2190,3 +2204,4 @@ If ``true`` enables debug mode on the NavigationServer. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index 14219a4a554..c1afe222b83 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -59,11 +59,11 @@ Methods .. table:: :widths: auto - +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_patch_margin` **(** :ref:`Side` margin **)** |const| | - +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_patch_margin` **(** :ref:`Side` margin, :ref:`int` value **)** | - +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_patch_margin`\ (\ margin\: :ref:`Side`\ ) |const| | + +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_patch_margin`\ (\ margin\: :ref:`Side`, value\: :ref:`int`\ ) | + +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -78,7 +78,7 @@ Signals .. rst-class:: classref-signal -**texture_changed** **(** **)** +**texture_changed**\ (\ ) Emitted when the node's texture changes. @@ -138,8 +138,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_h_axis_stretch_mode** **(** :ref:`AxisStretchMode` value **)** -- :ref:`AxisStretchMode` **get_h_axis_stretch_mode** **(** **)** +- |void| **set_h_axis_stretch_mode**\ (\ value\: :ref:`AxisStretchMode`\ ) +- :ref:`AxisStretchMode` **get_h_axis_stretch_mode**\ (\ ) The stretch mode to use for horizontal stretching/tiling. See :ref:`AxisStretchMode` for possible values. @@ -155,8 +155,8 @@ The stretch mode to use for horizontal stretching/tiling. See :ref:`AxisStretchM .. rst-class:: classref-property-setget -- void **set_v_axis_stretch_mode** **(** :ref:`AxisStretchMode` value **)** -- :ref:`AxisStretchMode` **get_v_axis_stretch_mode** **(** **)** +- |void| **set_v_axis_stretch_mode**\ (\ value\: :ref:`AxisStretchMode`\ ) +- :ref:`AxisStretchMode` **get_v_axis_stretch_mode**\ (\ ) The stretch mode to use for vertical stretching/tiling. See :ref:`AxisStretchMode` for possible values. @@ -172,8 +172,8 @@ The stretch mode to use for vertical stretching/tiling. See :ref:`AxisStretchMod .. rst-class:: classref-property-setget -- void **set_draw_center** **(** :ref:`bool` value **)** -- :ref:`bool` **is_draw_center_enabled** **(** **)** +- |void| **set_draw_center**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_draw_center_enabled**\ (\ ) If ``true``, draw the panel's center. Else, only draw the 9-slice's borders. @@ -189,8 +189,8 @@ If ``true``, draw the panel's center. Else, only draw the 9-slice's borders. .. rst-class:: classref-property-setget -- void **set_patch_margin** **(** :ref:`Side` margin, :ref:`int` value **)** -- :ref:`int` **get_patch_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_patch_margin**\ (\ margin\: :ref:`Side`, value\: :ref:`int`\ ) +- :ref:`int` **get_patch_margin**\ (\ margin\: :ref:`Side`\ ) |const| The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. @@ -206,8 +206,8 @@ The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's botto .. rst-class:: classref-property-setget -- void **set_patch_margin** **(** :ref:`Side` margin, :ref:`int` value **)** -- :ref:`int` **get_patch_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_patch_margin**\ (\ margin\: :ref:`Side`, value\: :ref:`int`\ ) +- :ref:`int` **get_patch_margin**\ (\ margin\: :ref:`Side`\ ) |const| The width of the 9-slice's left column. A margin of 16 means the 9-slice's left corners and side will have a width of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. @@ -223,8 +223,8 @@ The width of the 9-slice's left column. A margin of 16 means the 9-slice's left .. rst-class:: classref-property-setget -- void **set_patch_margin** **(** :ref:`Side` margin, :ref:`int` value **)** -- :ref:`int` **get_patch_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_patch_margin**\ (\ margin\: :ref:`Side`, value\: :ref:`int`\ ) +- :ref:`int` **get_patch_margin**\ (\ margin\: :ref:`Side`\ ) |const| The width of the 9-slice's right column. A margin of 16 means the 9-slice's right corners and side will have a width of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. @@ -240,8 +240,8 @@ The width of the 9-slice's right column. A margin of 16 means the 9-slice's righ .. rst-class:: classref-property-setget -- void **set_patch_margin** **(** :ref:`Side` margin, :ref:`int` value **)** -- :ref:`int` **get_patch_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_patch_margin**\ (\ margin\: :ref:`Side`, value\: :ref:`int`\ ) +- :ref:`int` **get_patch_margin**\ (\ margin\: :ref:`Side`\ ) |const| The height of the 9-slice's top row. A margin of 16 means the 9-slice's top corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. @@ -257,8 +257,8 @@ The height of the 9-slice's top row. A margin of 16 means the 9-slice's top corn .. rst-class:: classref-property-setget -- void **set_region_rect** **(** :ref:`Rect2` value **)** -- :ref:`Rect2` **get_region_rect** **(** **)** +- |void| **set_region_rect**\ (\ value\: :ref:`Rect2`\ ) +- :ref:`Rect2` **get_region_rect**\ (\ ) Rectangular region of the texture to sample from. If you're working with an atlas, use this property to define the area the 9-slice should use. All other properties are relative to this one. If the rect is empty, NinePatchRect will use the whole texture. @@ -274,8 +274,8 @@ Rectangular region of the texture to sample from. If you're working with an atla .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ ) The node's texture resource. @@ -292,7 +292,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_patch_margin** **(** :ref:`Side` margin **)** |const| +:ref:`int` **get_patch_margin**\ (\ margin\: :ref:`Side`\ ) |const| Returns the size of the margin on the specified :ref:`Side`. @@ -304,7 +304,7 @@ Returns the size of the margin on the specified :ref:`Side` margin, :ref:`int` value **)** +|void| **set_patch_margin**\ (\ margin\: :ref:`Side`, value\: :ref:`int`\ ) Sets the size of the margin on the specified :ref:`Side` to ``value`` pixels. @@ -315,3 +315,4 @@ Sets the size of the margin on the specified :ref:`Side` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_node.rst b/classes/class_node.rst index 11099860d64..4b3f5e793df 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -62,6 +62,8 @@ Properties .. table:: :widths: auto + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ + | :ref:`AutoTranslateMode` | :ref:`auto_translate_mode` | ``0`` | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`editor_description` | ``""`` | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ @@ -81,7 +83,7 @@ Properties +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`process_thread_group_order` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | |bitfield|\<:ref:`ProcessThreadMessages`\> | :ref:`process_thread_messages` | | + | |bitfield|\[:ref:`ProcessThreadMessages`\] | :ref:`process_thread_messages` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`scene_file_path` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ @@ -96,191 +98,195 @@ Methods .. table:: :widths: auto - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_enter_tree` **(** **)** |virtual| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_exit_tree` **(** **)** |virtual| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`_get_configuration_warnings` **(** **)** |virtual| |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_input` **(** :ref:`InputEvent` event **)** |virtual| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_physics_process` **(** :ref:`float` delta **)** |virtual| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_process` **(** :ref:`float` delta **)** |virtual| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_ready` **(** **)** |virtual| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shortcut_input` **(** :ref:`InputEvent` event **)** |virtual| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** |virtual| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_unhandled_key_input` **(** :ref:`InputEvent` event **)** |virtual| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` force_readable_name=false, :ref:`InternalMode` internal=0 **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_sibling` **(** :ref:`Node` sibling, :ref:`bool` force_readable_name=false **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_to_group` **(** :ref:`StringName` group, :ref:`bool` persistent=false **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`call_deferred_thread_group` **(** :ref:`StringName` method, ... **)** |vararg| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`call_thread_safe` **(** :ref:`StringName` method, ... **)** |vararg| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`can_process` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Tween` | :ref:`create_tween` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`duplicate` **(** :ref:`int` flags=15 **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`find_child` **(** :ref:`String` pattern, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node[]` | :ref:`find_children` **(** :ref:`String` pattern, :ref:`String` type="", :ref:`bool` recursive=true, :ref:`bool` owned=true **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`find_parent` **(** :ref:`String` pattern **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx, :ref:`bool` include_internal=false **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_child_count` **(** :ref:`bool` include_internal=false **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node[]` | :ref:`get_children` **(** :ref:`bool` include_internal=false **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName[]` | :ref:`get_groups` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_index` **(** :ref:`bool` include_internal=false **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Window` | :ref:`get_last_exclusive_window` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_multiplayer_authority` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_node_and_resource` **(** :ref:`NodePath` path **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`get_node_or_null` **(** :ref:`NodePath` path **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`get_parent` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_path` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node, :ref:`bool` use_unique_path=false **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_physics_process_delta_time` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_process_delta_time` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_scene_instance_load_placeholder` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SceneTree` | :ref:`get_tree` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_tree_string` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_tree_string_pretty` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Viewport` | :ref:`get_viewport` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Window` | :ref:`get_window` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_ancestor_of` **(** :ref:`Node` node **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_displayed_folded` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_editable_instance` **(** :ref:`Node` node **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_in_group` **(** :ref:`StringName` group **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_inside_tree` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_multiplayer_authority` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_node_ready` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_physics_processing` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_physics_processing_internal` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_processing` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_processing_input` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_processing_internal` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_processing_shortcut_input` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_index **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`notify_deferred_thread_group` **(** :ref:`int` what **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`notify_thread_safe` **(** :ref:`int` what **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`print_orphan_nodes` **(** **)** |static| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`print_tree` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`print_tree_pretty` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`propagate_call` **(** :ref:`StringName` method, :ref:`Array` args=[], :ref:`bool` parent_first=false **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`propagate_notification` **(** :ref:`int` what **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`queue_free` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_child` **(** :ref:`Node` node **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_from_group` **(** :ref:`StringName` group **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reparent` **(** :ref:`Node` new_parent, :ref:`bool` keep_global_transform=true **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_groups=false **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`request_ready` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`rpc` **(** :ref:`StringName` method, ... **)** |vararg| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rpc_config` **(** :ref:`StringName` method, :ref:`Variant` config **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`rpc_id` **(** :ref:`int` peer_id, :ref:`StringName` method, ... **)** |vararg| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_deferred_thread_group` **(** :ref:`StringName` property, :ref:`Variant` value **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_editable_instance` **(** :ref:`Node` node, :ref:`bool` is_editable **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_multiplayer_authority` **(** :ref:`int` id, :ref:`bool` recursive=true **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_physics_process` **(** :ref:`bool` enable **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_physics_process_internal` **(** :ref:`bool` enable **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_process` **(** :ref:`bool` enable **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_process_input` **(** :ref:`bool` enable **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_process_internal` **(** :ref:`bool` enable **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_process_shortcut_input` **(** :ref:`bool` enable **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_process_unhandled_input` **(** :ref:`bool` enable **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_process_unhandled_key_input` **(** :ref:`bool` enable **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_scene_instance_load_placeholder` **(** :ref:`bool` load_placeholder **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_thread_safe` **(** :ref:`StringName` property, :ref:`Variant` value **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`update_configuration_warnings` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_enter_tree`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_exit_tree`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_configuration_warnings`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_input`\ (\ event\: :ref:`InputEvent`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_physics_process`\ (\ delta\: :ref:`float`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_process`\ (\ delta\: :ref:`float`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_ready`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shortcut_input`\ (\ event\: :ref:`InputEvent`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_unhandled_input`\ (\ event\: :ref:`InputEvent`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_unhandled_key_input`\ (\ event\: :ref:`InputEvent`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_child`\ (\ node\: :ref:`Node`, force_readable_name\: :ref:`bool` = false, internal\: :ref:`InternalMode` = 0\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_sibling`\ (\ sibling\: :ref:`Node`, force_readable_name\: :ref:`bool` = false\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_to_group`\ (\ group\: :ref:`StringName`, persistent\: :ref:`bool` = false\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`atr`\ (\ message\: :ref:`String`, context\: :ref:`StringName` = ""\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`atr_n`\ (\ message\: :ref:`String`, plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = ""\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`call_deferred_thread_group`\ (\ method\: :ref:`StringName`, ...\ ) |vararg| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`call_thread_safe`\ (\ method\: :ref:`StringName`, ...\ ) |vararg| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`can_process`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Tween` | :ref:`create_tween`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`duplicate`\ (\ flags\: :ref:`int` = 15\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`find_child`\ (\ pattern\: :ref:`String`, recursive\: :ref:`bool` = true, owned\: :ref:`bool` = true\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Node`\] | :ref:`find_children`\ (\ pattern\: :ref:`String`, type\: :ref:`String` = "", recursive\: :ref:`bool` = true, owned\: :ref:`bool` = true\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`find_parent`\ (\ pattern\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`get_child`\ (\ idx\: :ref:`int`, include_internal\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_child_count`\ (\ include_internal\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Node`\] | :ref:`get_children`\ (\ include_internal\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`StringName`\] | :ref:`get_groups`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_index`\ (\ include_internal\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Window` | :ref:`get_last_exclusive_window`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_multiplayer_authority`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`get_node`\ (\ path\: :ref:`NodePath`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_node_and_resource`\ (\ path\: :ref:`NodePath`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`get_node_or_null`\ (\ path\: :ref:`NodePath`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`get_parent`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_path`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_path_to`\ (\ node\: :ref:`Node`, use_unique_path\: :ref:`bool` = false\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_physics_process_delta_time`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_process_delta_time`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_scene_instance_load_placeholder`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SceneTree` | :ref:`get_tree`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_tree_string`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_tree_string_pretty`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Viewport` | :ref:`get_viewport`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Window` | :ref:`get_window`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_node`\ (\ path\: :ref:`NodePath`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_node_and_resource`\ (\ path\: :ref:`NodePath`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_ancestor_of`\ (\ node\: :ref:`Node`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_displayed_folded`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_editable_instance`\ (\ node\: :ref:`Node`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_greater_than`\ (\ node\: :ref:`Node`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_in_group`\ (\ group\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_inside_tree`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_multiplayer_authority`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_node_ready`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_physics_processing`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_physics_processing_internal`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_processing`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_processing_input`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_processing_internal`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_processing_shortcut_input`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_processing_unhandled_input`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_processing_unhandled_key_input`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_child`\ (\ child_node\: :ref:`Node`, to_index\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`notify_deferred_thread_group`\ (\ what\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`notify_thread_safe`\ (\ what\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`print_orphan_nodes`\ (\ ) |static| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`print_tree`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`print_tree_pretty`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`propagate_call`\ (\ method\: :ref:`StringName`, args\: :ref:`Array` = [], parent_first\: :ref:`bool` = false\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`propagate_notification`\ (\ what\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`queue_free`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_child`\ (\ node\: :ref:`Node`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_from_group`\ (\ group\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reparent`\ (\ new_parent\: :ref:`Node`, keep_global_transform\: :ref:`bool` = true\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`replace_by`\ (\ node\: :ref:`Node`, keep_groups\: :ref:`bool` = false\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`request_ready`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`rpc`\ (\ method\: :ref:`StringName`, ...\ ) |vararg| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rpc_config`\ (\ method\: :ref:`StringName`, config\: :ref:`Variant`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`rpc_id`\ (\ peer_id\: :ref:`int`, method\: :ref:`StringName`, ...\ ) |vararg| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_deferred_thread_group`\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_display_folded`\ (\ fold\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_editable_instance`\ (\ node\: :ref:`Node`, is_editable\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_multiplayer_authority`\ (\ id\: :ref:`int`, recursive\: :ref:`bool` = true\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_physics_process`\ (\ enable\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_physics_process_internal`\ (\ enable\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_process`\ (\ enable\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_process_input`\ (\ enable\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_process_internal`\ (\ enable\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_process_shortcut_input`\ (\ enable\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_process_unhandled_input`\ (\ enable\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_process_unhandled_key_input`\ (\ enable\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_scene_instance_load_placeholder`\ (\ load_placeholder\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_thread_safe`\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update_configuration_warnings`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -295,7 +301,7 @@ Signals .. rst-class:: classref-signal -**child_entered_tree** **(** :ref:`Node` node **)** +**child_entered_tree**\ (\ node\: :ref:`Node`\ ) Emitted when the child ``node`` enters the :ref:`SceneTree`, usually because this node entered the tree (see :ref:`tree_entered`), or :ref:`add_child` has been called. @@ -309,7 +315,7 @@ This signal is emitted *after* the child node's own :ref:`NOTIFICATION_ENTER_TRE .. rst-class:: classref-signal -**child_exiting_tree** **(** :ref:`Node` node **)** +**child_exiting_tree**\ (\ node\: :ref:`Node`\ ) Emitted when the child ``node`` is about to exit the :ref:`SceneTree`, usually because this node is exiting the tree (see :ref:`tree_exiting`), or because the child ``node`` is being removed or freed. @@ -323,7 +329,7 @@ When this signal is received, the child ``node`` is still accessible inside the .. rst-class:: classref-signal -**child_order_changed** **(** **)** +**child_order_changed**\ (\ ) Emitted when the list of children is changed. This happens when child nodes are added, moved or removed. @@ -335,7 +341,7 @@ Emitted when the list of children is changed. This happens when child nodes are .. rst-class:: classref-signal -**editor_description_changed** **(** :ref:`Node` node **)** +**editor_description_changed**\ (\ node\: :ref:`Node`\ ) Emitted when the node's editor description field changed. @@ -347,7 +353,7 @@ Emitted when the node's editor description field changed. .. rst-class:: classref-signal -**ready** **(** **)** +**ready**\ (\ ) Emitted when the node is considered ready, after :ref:`_ready` is called. @@ -359,7 +365,7 @@ Emitted when the node is considered ready, after :ref:`_ready` is changed, if the node is inside the tree. @@ -371,7 +377,7 @@ Emitted when the node's :ref:`name` is changed, if the .. rst-class:: classref-signal -**replacing_by** **(** :ref:`Node` node **)** +**replacing_by**\ (\ node\: :ref:`Node`\ ) Emitted when this node is being replaced by the ``node``, see :ref:`replace_by`. @@ -385,7 +391,7 @@ This signal is emitted *after* ``node`` has been added as a child of the origina .. rst-class:: classref-signal -**tree_entered** **(** **)** +**tree_entered**\ (\ ) Emitted when the node enters the tree. @@ -399,7 +405,7 @@ This signal is emitted *after* the related :ref:`NOTIFICATION_ENTER_TREE` **PROCESS_MODE_INHERIT** = ``0`` -Inherits :ref:`process_mode` from the node's parent. For the root node, it is equivalent to :ref:`PROCESS_MODE_PAUSABLE`. This is the default for any newly created node. +Inherits :ref:`process_mode` from the node's parent. This is the default for any newly created node. .. _class_Node_constant_PROCESS_MODE_PAUSABLE: @@ -448,7 +454,7 @@ Inherits :ref:`process_mode` from the node's p :ref:`ProcessMode` **PROCESS_MODE_PAUSABLE** = ``1`` -Stops processing when :ref:`SceneTree.paused` is ``true``. This is the inverse of :ref:`PROCESS_MODE_WHEN_PAUSED`. +Stops processing when :ref:`SceneTree.paused` is ``true``. This is the inverse of :ref:`PROCESS_MODE_WHEN_PAUSED`, and the default for the root node. .. _class_Node_constant_PROCESS_MODE_WHEN_PAUSED: @@ -618,6 +624,42 @@ The node will be placed at the beginning of the parent's children list, before a The node will be placed at the end of the parent's children list, after any non-internal sibling. +.. rst-class:: classref-item-separator + +---- + +.. _enum_Node_AutoTranslateMode: + +.. rst-class:: classref-enumeration + +enum **AutoTranslateMode**: + +.. _class_Node_constant_AUTO_TRANSLATE_MODE_INHERIT: + +.. rst-class:: classref-enumeration-constant + +:ref:`AutoTranslateMode` **AUTO_TRANSLATE_MODE_INHERIT** = ``0`` + +Inherits :ref:`auto_translate_mode` from the node's parent. This is the default for any newly created node. + +.. _class_Node_constant_AUTO_TRANSLATE_MODE_ALWAYS: + +.. rst-class:: classref-enumeration-constant + +:ref:`AutoTranslateMode` **AUTO_TRANSLATE_MODE_ALWAYS** = ``1`` + +Always automatically translate. This is the inverse of :ref:`AUTO_TRANSLATE_MODE_DISABLED`, and the default for the root node. + +.. _class_Node_constant_AUTO_TRANSLATE_MODE_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`AutoTranslateMode` **AUTO_TRANSLATE_MODE_DISABLED** = ``2`` + +Never automatically translate. This is the inverse of :ref:`AUTO_TRANSLATE_MODE_ALWAYS`. + +String parsing for POT generation will be skipped for this node and children that are set to :ref:`AUTO_TRANSLATE_MODE_INHERIT`. + .. rst-class:: classref-section-separator ---- @@ -653,9 +695,9 @@ This notification is received *after* the related :ref:`tree_exiting` instead. +**Deprecated:** This notification is no longer sent by the engine. Use :ref:`NOTIFICATION_CHILD_ORDER_CHANGED` instead. + -This notification is no longer emitted. .. _class_Node_constant_NOTIFICATION_READY: @@ -1020,6 +1062,25 @@ Notification received when the :ref:`TextServer` is changed. Property Descriptions --------------------- +.. _class_Node_property_auto_translate_mode: + +.. rst-class:: classref-property + +:ref:`AutoTranslateMode` **auto_translate_mode** = ``0`` + +.. rst-class:: classref-property-setget + +- |void| **set_auto_translate_mode**\ (\ value\: :ref:`AutoTranslateMode`\ ) +- :ref:`AutoTranslateMode` **get_auto_translate_mode**\ (\ ) + +Defines if any text should automatically change to its translated version depending on the current locale (for nodes such as :ref:`Label`, :ref:`RichTextLabel`, :ref:`Window`, etc.). See :ref:`AutoTranslateMode`. + +Also decides if the node's strings should be parsed for POT generation. + +.. rst-class:: classref-item-separator + +---- + .. _class_Node_property_editor_description: .. rst-class:: classref-property @@ -1028,8 +1089,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_editor_description** **(** :ref:`String` value **)** -- :ref:`String` **get_editor_description** **(** **)** +- |void| **set_editor_description**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_editor_description**\ (\ ) An optional description to the node. It will be displayed as a tooltip when hovering over the node in the editor's Scene dock. @@ -1045,7 +1106,7 @@ An optional description to the node. It will be displayed as a tooltip when hove .. rst-class:: classref-property-setget -- :ref:`MultiplayerAPI` **get_multiplayer** **(** **)** +- :ref:`MultiplayerAPI` **get_multiplayer**\ (\ ) The :ref:`MultiplayerAPI` instance associated with this node. See :ref:`SceneTree.get_multiplayer`. @@ -1063,8 +1124,8 @@ The :ref:`MultiplayerAPI` instance associated with this no .. rst-class:: classref-property-setget -- void **set_name** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_name** **(** **)** +- |void| **set_name**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_name**\ (\ ) 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. @@ -1082,8 +1143,8 @@ The name of the node. This name must be unique among the siblings (other child n .. rst-class:: classref-property-setget -- void **set_owner** **(** :ref:`Node` value **)** -- :ref:`Node` **get_owner** **(** **)** +- |void| **set_owner**\ (\ value\: :ref:`Node`\ ) +- :ref:`Node` **get_owner**\ (\ ) The owner of this node. The owner must be an ancestor of this node. When packing the owner node in a :ref:`PackedScene`, all the nodes it owns are also saved with it. @@ -1101,8 +1162,8 @@ The owner of this node. The owner must be an ancestor of this node. When packing .. rst-class:: classref-property-setget -- void **set_process_mode** **(** :ref:`ProcessMode` value **)** -- :ref:`ProcessMode` **get_process_mode** **(** **)** +- |void| **set_process_mode**\ (\ value\: :ref:`ProcessMode`\ ) +- :ref:`ProcessMode` **get_process_mode**\ (\ ) The node's processing behavior (see :ref:`ProcessMode`). To check if the node can process in its current mode, use :ref:`can_process`. @@ -1118,8 +1179,8 @@ The node's processing behavior (see :ref:`ProcessMode`). .. rst-class:: classref-property-setget -- void **set_physics_process_priority** **(** :ref:`int` value **)** -- :ref:`int` **get_physics_process_priority** **(** **)** +- |void| **set_physics_process_priority**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_physics_process_priority**\ (\ ) Similar to :ref:`process_priority` but for :ref:`NOTIFICATION_PHYSICS_PROCESS`, :ref:`_physics_process` or the internal version. @@ -1135,8 +1196,8 @@ Similar to :ref:`process_priority` but for .. rst-class:: classref-property-setget -- void **set_process_priority** **(** :ref:`int` value **)** -- :ref:`int` **get_process_priority** **(** **)** +- |void| **set_process_priority**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_process_priority**\ (\ ) The node's execution order of the process callbacks (:ref:`_process`, :ref:`_physics_process`, and internal processing). Nodes whose priority value is *lower* call their process callbacks first, regardless of tree order. @@ -1152,8 +1213,8 @@ The node's execution order of the process callbacks (:ref:`_process` value **)** -- :ref:`ProcessThreadGroup` **get_process_thread_group** **(** **)** +- |void| **set_process_thread_group**\ (\ value\: :ref:`ProcessThreadGroup`\ ) +- :ref:`ProcessThreadGroup` **get_process_thread_group**\ (\ ) Set the process thread group for this node (basically, whether it receives :ref:`NOTIFICATION_PROCESS`, :ref:`NOTIFICATION_PHYSICS_PROCESS`, :ref:`_process` or :ref:`_physics_process` (and the internal versions) on the main thread or in a sub-thread. @@ -1175,8 +1236,8 @@ To better understand process thread groups, the idea is that any node set to any .. rst-class:: classref-property-setget -- void **set_process_thread_group_order** **(** :ref:`int` value **)** -- :ref:`int` **get_process_thread_group_order** **(** **)** +- |void| **set_process_thread_group_order**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_process_thread_group_order**\ (\ ) Change the process thread group order. Groups with a lesser order will process before groups with a greater order. This is useful when a large amount of nodes process in sub thread and, afterwards, another group wants to collect their result in the main thread, as an example. @@ -1188,12 +1249,12 @@ Change the process thread group order. Groups with a lesser order will process b .. rst-class:: classref-property -|bitfield|\<:ref:`ProcessThreadMessages`\> **process_thread_messages** +|bitfield|\[:ref:`ProcessThreadMessages`\] **process_thread_messages** .. rst-class:: classref-property-setget -- void **set_process_thread_messages** **(** |bitfield|\<:ref:`ProcessThreadMessages`\> value **)** -- |bitfield|\<:ref:`ProcessThreadMessages`\> **get_process_thread_messages** **(** **)** +- |void| **set_process_thread_messages**\ (\ value\: |bitfield|\[:ref:`ProcessThreadMessages`\]\ ) +- |bitfield|\[:ref:`ProcessThreadMessages`\] **get_process_thread_messages**\ (\ ) Set whether the current thread group will process messages (calls to :ref:`call_deferred_thread_group` on threads, and whether it wants to receive them during regular process or physics process callbacks. @@ -1209,8 +1270,8 @@ Set whether the current thread group will process messages (calls to :ref:`call_ .. rst-class:: classref-property-setget -- void **set_scene_file_path** **(** :ref:`String` value **)** -- :ref:`String` **get_scene_file_path** **(** **)** +- |void| **set_scene_file_path**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_scene_file_path**\ (\ ) The original scene's file path, if the node has been instantiated from a :ref:`PackedScene` file. Only scene root nodes contains this. @@ -1226,8 +1287,8 @@ The original scene's file path, if the node has been instantiated from a :ref:`P .. rst-class:: classref-property-setget -- void **set_unique_name_in_owner** **(** :ref:`bool` value **)** -- :ref:`bool` **is_unique_name_in_owner** **(** **)** +- |void| **set_unique_name_in_owner**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_unique_name_in_owner**\ (\ ) If ``true``, the node can be accessed from any node sharing the same :ref:`owner` or from the :ref:`owner` itself, with special ``%Name`` syntax in :ref:`get_node`. @@ -1246,7 +1307,7 @@ Method Descriptions .. rst-class:: classref-method -void **_enter_tree** **(** **)** |virtual| +|void| **_enter_tree**\ (\ ) |virtual| Called when the node enters the :ref:`SceneTree` (e.g. upon instantiating, scene changing, or after calling :ref:`add_child` in a script). If the node has children, its :ref:`_enter_tree` callback will be called first, and then that of the children. @@ -1260,7 +1321,7 @@ Corresponds to the :ref:`NOTIFICATION_ENTER_TREE` (e.g. upon freeing, scene changing, or after calling :ref:`remove_child` in a script). If the node has children, its :ref:`_exit_tree` callback will be called last, after all its children have left the tree. @@ -1274,18 +1335,10 @@ Corresponds to the :ref:`NOTIFICATION_EXIT_TREE` **_get_configuration_warnings** **(** **)** |virtual| |const| +:ref:`PackedStringArray` **_get_configuration_warnings**\ (\ ) |virtual| |const| The elements in the array returned from this method are displayed as warnings in the Scene dock if the script that overrides it is a ``tool`` script. -Each array element must either be a :ref:`String` or a :ref:`Dictionary`. - -A dictionary element must contain a key ``message`` of type :ref:`String` which is shown in the user interface. - -The dictionary may optionally contain a key ``property`` of type :ref:`NodePath`, which also shows this warning in the inspector on the corresponding property. - -If a string is found in the returned array, it is converted to an equivalent dictionary with the ``message`` field set. - Returning an empty array produces no warnings. Call :ref:`update_configuration_warnings` when the warnings need to be updated for this node. @@ -1311,7 +1364,7 @@ Call :ref:`update_configuration_warnings` event **)** |virtual| +|void| **_input**\ (\ event\: :ref:`InputEvent`\ ) |virtual| Called when there is an input event. The input event propagates up through the node tree until a node consumes it. @@ -1331,7 +1384,7 @@ For gameplay input, :ref:`_unhandled_input` delta **)** |virtual| +|void| **_physics_process**\ (\ delta\: :ref:`float`\ ) |virtual| Called during the physics processing step of the main loop. Physics processing means that the frame rate is synced to the physics, i.e. the ``delta`` variable should be constant. ``delta`` is in seconds. @@ -1349,7 +1402,7 @@ Corresponds to the :ref:`NOTIFICATION_PHYSICS_PROCESS` delta **)** |virtual| +|void| **_process**\ (\ delta\: :ref:`float`\ ) |virtual| Called during the processing step of the main loop. Processing happens at every frame and as fast as possible, so the ``delta`` time since the previous frame is not constant. ``delta`` is in seconds. @@ -1367,7 +1420,7 @@ Corresponds to the :ref:`NOTIFICATION_PROCESS` callbacks get triggered first, and the parent node will receive the ready notification afterwards. @@ -1385,7 +1438,7 @@ Usually used for initialization. For even earlier initialization, :ref:`Object._ .. rst-class:: classref-method -void **_shortcut_input** **(** :ref:`InputEvent` event **)** |virtual| +|void| **_shortcut_input**\ (\ event\: :ref:`InputEvent`\ ) |virtual| Called when an :ref:`InputEventKey` or :ref:`InputEventShortcut` hasn't been consumed by :ref:`_input` or any GUI :ref:`Control` item. It is called before :ref:`_unhandled_key_input` and :ref:`_unhandled_input`. The input event propagates up through the node tree until a node consumes it. @@ -1405,7 +1458,7 @@ This method can be used to handle shortcuts. For generic GUI events, use :ref:`_ .. rst-class:: classref-method -void **_unhandled_input** **(** :ref:`InputEvent` event **)** |virtual| +|void| **_unhandled_input**\ (\ event\: :ref:`InputEvent`\ ) |virtual| Called when an :ref:`InputEvent` hasn't been consumed by :ref:`_input` or any GUI :ref:`Control` item. It is called after :ref:`_shortcut_input` and after :ref:`_unhandled_key_input`. The input event propagates up through the node tree until a node consumes it. @@ -1425,7 +1478,7 @@ For gameplay input, this method is usually a better fit than :ref:`_input` event **)** |virtual| +|void| **_unhandled_key_input**\ (\ event\: :ref:`InputEvent`\ ) |virtual| Called when an :ref:`InputEventKey` hasn't been consumed by :ref:`_input` or any GUI :ref:`Control` item. It is called after :ref:`_shortcut_input` but before :ref:`_unhandled_input`. The input event propagates up through the node tree until a node consumes it. @@ -1447,7 +1500,7 @@ For gameplay input, this and :ref:`_unhandled_input` node, :ref:`bool` force_readable_name=false, :ref:`InternalMode` internal=0 **)** +|void| **add_child**\ (\ node\: :ref:`Node`, force_readable_name\: :ref:`bool` = false, internal\: :ref:`InternalMode` = 0\ ) Adds a child ``node``. Nodes can have any number of children, but every child must have a unique name. Child nodes are automatically deleted when the parent node is deleted, so an entire scene can be removed by deleting its topmost node. @@ -1490,7 +1543,7 @@ If you need the child node to be added below a specific node in the list of chil .. rst-class:: classref-method -void **add_sibling** **(** :ref:`Node` sibling, :ref:`bool` force_readable_name=false **)** +|void| **add_sibling**\ (\ sibling\: :ref:`Node`, force_readable_name\: :ref:`bool` = false\ ) Adds a ``sibling`` node to this node's parent, and moves the added sibling right below this node. @@ -1508,7 +1561,7 @@ Use :ref:`add_child` instead of this method if you .. rst-class:: classref-method -void **add_to_group** **(** :ref:`StringName` group, :ref:`bool` persistent=false **)** +|void| **add_to_group**\ (\ group\: :ref:`StringName`, persistent\: :ref:`bool` = false\ ) 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`. @@ -1522,11 +1575,51 @@ If ``persistent`` is ``true``, the group will be stored when saved inside a :ref ---- +.. _class_Node_method_atr: + +.. rst-class:: classref-method + +:ref:`String` **atr**\ (\ message\: :ref:`String`, context\: :ref:`StringName` = ""\ ) |const| + +Translates a ``message``, using the translation catalogs configured in the Project Settings. Further ``context`` can be specified to help with the translation. + +This method works the same as :ref:`Object.tr`, with the addition of respecting the :ref:`auto_translate_mode` state. + +If :ref:`Object.can_translate_messages` is ``false``, or no translation is available, this method returns the ``message`` without changes. See :ref:`Object.set_message_translation`. + +For detailed examples, see :doc:`Internationalizing games <../tutorials/i18n/internationalizing_games>`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Node_method_atr_n: + +.. rst-class:: classref-method + +:ref:`String` **atr_n**\ (\ message\: :ref:`String`, plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = ""\ ) |const| + +Translates a ``message`` or ``plural_message``, using the translation catalogs configured in the Project Settings. Further ``context`` can be specified to help with the translation. + +This method works the same as :ref:`Object.tr_n`, with the addition of respecting the :ref:`auto_translate_mode` state. + +If :ref:`Object.can_translate_messages` is ``false``, or no translation is available, this method returns ``message`` or ``plural_message``, without changes. See :ref:`Object.set_message_translation`. + +The ``n`` is the number, or amount, of the message's subject. It is used by the translation system to fetch the correct plural form for the current language. + +For detailed examples, see :doc:`Localization using gettext <../tutorials/i18n/localization_using_gettext>`. + +\ **Note:** Negative and :ref:`float` numbers may not properly apply to some countable subjects. It's recommended to handle these cases with :ref:`atr`. + +.. rst-class:: classref-item-separator + +---- + .. _class_Node_method_call_deferred_thread_group: .. rst-class:: classref-method -:ref:`Variant` **call_deferred_thread_group** **(** :ref:`StringName` method, ... **)** |vararg| +:ref:`Variant` **call_deferred_thread_group**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| This function is similar to :ref:`Object.call_deferred` except that the call will take place when the node thread group is processed. If the node thread group processes in sub-threads, then the call will be done on that thread, right before :ref:`NOTIFICATION_PROCESS` or :ref:`NOTIFICATION_PHYSICS_PROCESS`, the :ref:`_process` or :ref:`_physics_process` or their internal versions are called. @@ -1538,7 +1631,7 @@ This function is similar to :ref:`Object.call_deferred` **call_thread_safe** **(** :ref:`StringName` method, ... **)** |vararg| +:ref:`Variant` **call_thread_safe**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| This function ensures that the calling of this function will succeed, no matter whether it's being done from a thread or not. If called from a thread that is not allowed to call the function, the call will become deferred. Otherwise, the call will go through directly. @@ -1550,9 +1643,9 @@ This function ensures that the calling of this function will succeed, no matter .. rst-class:: classref-method -:ref:`bool` **can_process** **(** **)** |const| +:ref:`bool` **can_process**\ (\ ) |const| -Returns ``true`` if the node can receive processing notifications and input callbacks (:ref:`NOTIFICATION_PROCESS`, :ref:`_input`, etc) from the :ref:`SceneTree` and :ref:`Viewport`. The returned value depends on :ref:`process_mode`: +Returns ``true`` if the node can receive processing notifications and input callbacks (:ref:`NOTIFICATION_PROCESS`, :ref:`_input`, etc.) from the :ref:`SceneTree` and :ref:`Viewport`. The returned value depends on :ref:`process_mode`: - If set to :ref:`PROCESS_MODE_PAUSABLE`, returns ``true`` when the game is processing, i.e. :ref:`SceneTree.paused` is ``false``; @@ -1574,7 +1667,7 @@ If the node is not inside the tree, returns ``false`` no matter the value of :re .. rst-class:: classref-method -:ref:`Tween` **create_tween** **(** **)** +:ref:`Tween` **create_tween**\ (\ ) Creates a new :ref:`Tween` and binds it to this node. @@ -1605,7 +1698,7 @@ The Tween will start automatically on the next process frame or physics frame (d .. rst-class:: classref-method -:ref:`Node` **duplicate** **(** :ref:`int` flags=15 **)** |const| +:ref:`Node` **duplicate**\ (\ flags\: :ref:`int` = 15\ ) |const| 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`). @@ -1619,7 +1712,7 @@ Duplicates the node, returning a new node with all of its properties, signals an .. rst-class:: classref-method -:ref:`Node` **find_child** **(** :ref:`String` pattern, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** |const| +:ref:`Node` **find_child**\ (\ pattern\: :ref:`String`, recursive\: :ref:`bool` = true, owned\: :ref:`bool` = true\ ) |const| Finds the first descendant of this node whose :ref:`name` matches ``pattern``, returning ``null`` if no match is found. The matching is done against node names, *not* their paths, through :ref:`String.match`. As such, it is case-sensitive, ``"*"`` matches zero or more characters, and ``"?"`` matches any single character. @@ -1639,7 +1732,7 @@ If ``owned`` is ``true``, only descendants with a valid :ref:`owner` **find_children** **(** :ref:`String` pattern, :ref:`String` type="", :ref:`bool` recursive=true, :ref:`bool` owned=true **)** |const| +:ref:`Array`\[:ref:`Node`\] **find_children**\ (\ pattern\: :ref:`String`, type\: :ref:`String` = "", recursive\: :ref:`bool` = true, owned\: :ref:`bool` = true\ ) |const| Finds all descendants of this node whose names match ``pattern``, returning an empty :ref:`Array` if no match is found. The matching is done against node names, *not* their paths, through :ref:`String.match`. As such, it is case-sensitive, ``"*"`` matches zero or more characters, and ``"?"`` matches any single character. @@ -1661,7 +1754,7 @@ If ``owned`` is ``true``, only descendants with a valid :ref:`owner` **find_parent** **(** :ref:`String` pattern **)** |const| +:ref:`Node` **find_parent**\ (\ pattern\: :ref:`String`\ ) |const| Finds the first ancestor of this node whose :ref:`name` matches ``pattern``, returning ``null`` if no match is found. The matching is done through :ref:`String.match`. As such, it is case-sensitive, ``"*"`` matches zero or more characters, and ``"?"`` matches any single character. See also :ref:`find_child` and :ref:`find_children`. @@ -1675,7 +1768,7 @@ Finds the first ancestor of this node whose :ref:`name .. rst-class:: classref-method -:ref:`Node` **get_child** **(** :ref:`int` idx, :ref:`bool` include_internal=false **)** |const| +:ref:`Node` **get_child**\ (\ idx\: :ref:`int`, include_internal\: :ref:`bool` = false\ ) |const| Fetches a child node by its index. Each child node has an index relative its siblings (see :ref:`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` to iterate over this node's children. If no child exists at the given index, this method returns ``null`` and an error is generated. @@ -1701,7 +1794,7 @@ If ``include_internal`` is ``false``, internal children are ignored (see :ref:`a .. rst-class:: classref-method -:ref:`int` **get_child_count** **(** :ref:`bool` include_internal=false **)** |const| +:ref:`int` **get_child_count**\ (\ include_internal\: :ref:`bool` = false\ ) |const| Returns the number of children of this node. @@ -1715,7 +1808,7 @@ If ``include_internal`` is ``false``, internal children are not counted (see :re .. rst-class:: classref-method -:ref:`Node[]` **get_children** **(** :ref:`bool` include_internal=false **)** |const| +:ref:`Array`\[:ref:`Node`\] **get_children**\ (\ include_internal\: :ref:`bool` = false\ ) |const| Returns all children of this node inside an :ref:`Array`. @@ -1729,7 +1822,7 @@ If ``include_internal`` is ``false``, excludes internal children from the return .. rst-class:: classref-method -:ref:`StringName[]` **get_groups** **(** **)** |const| +:ref:`Array`\[:ref:`StringName`\] **get_groups**\ (\ ) |const| Returns an :ref:`Array` of group names that the node has been added to. @@ -1768,7 +1861,7 @@ Returns an :ref:`Array` of group names that the node has been added .. rst-class:: classref-method -:ref:`int` **get_index** **(** :ref:`bool` include_internal=false **)** |const| +:ref:`int` **get_index**\ (\ include_internal\: :ref:`bool` = false\ ) |const| Returns this node's order among its siblings. The first node's index is ``0``. See also :ref:`get_child`. @@ -1782,7 +1875,7 @@ If ``include_internal`` is ``false``, returns the index ignoring internal childr .. rst-class:: classref-method -:ref:`Window` **get_last_exclusive_window** **(** **)** |const| +:ref:`Window` **get_last_exclusive_window**\ (\ ) |const| Returns the :ref:`Window` that contains this node, or the last exclusive child in a chain of windows starting with the one that contains this node. @@ -1794,7 +1887,7 @@ Returns the :ref:`Window` that contains this node, or the last exc .. rst-class:: classref-method -:ref:`int` **get_multiplayer_authority** **(** **)** |const| +:ref:`int` **get_multiplayer_authority**\ (\ ) |const| Returns the peer ID of the multiplayer authority for this node. See :ref:`set_multiplayer_authority`. @@ -1806,7 +1899,7 @@ Returns the peer ID of the multiplayer authority for this node. See :ref:`set_mu .. rst-class:: classref-method -:ref:`Node` **get_node** **(** :ref:`NodePath` path **)** |const| +:ref:`Node` **get_node**\ (\ path\: :ref:`NodePath`\ ) |const| Fetches a node. The :ref:`NodePath` can either be a relative path (from this node), or an absolute path (from the :ref:`SceneTree.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 on a null instance."* error. @@ -1856,7 +1949,7 @@ The following calls will return a valid node: .. rst-class:: classref-method -:ref:`Array` **get_node_and_resource** **(** :ref:`NodePath` path **)** +:ref:`Array` **get_node_and_resource**\ (\ path\: :ref:`NodePath`\ ) Fetches a node and its most nested resource as specified by the :ref:`NodePath`'s subname. Returns an :ref:`Array` of size ``3`` where: @@ -1915,7 +2008,7 @@ Fetches a node and its most nested resource as specified by the :ref:`NodePath` **get_node_or_null** **(** :ref:`NodePath` path **)** |const| +:ref:`Node` **get_node_or_null**\ (\ path\: :ref:`NodePath`\ ) |const| Fetches a node by :ref:`NodePath`. Similar to :ref:`get_node`, but does not generate an error if ``path`` does not point to a valid node. @@ -1927,7 +2020,7 @@ Fetches a node by :ref:`NodePath`. Similar to :ref:`get_node` **get_parent** **(** **)** |const| +:ref:`Node` **get_parent**\ (\ ) |const| Returns this node's parent node, or ``null`` if the node doesn't have a parent. @@ -1939,7 +2032,7 @@ Returns this node's parent node, or ``null`` if the node doesn't have a parent. .. rst-class:: classref-method -:ref:`NodePath` **get_path** **(** **)** |const| +:ref:`NodePath` **get_path**\ (\ ) |const| Returns the node's absolute path, relative to the :ref:`SceneTree.root`. If the node is not inside the scene tree, this method fails and returns an empty :ref:`NodePath`. @@ -1951,7 +2044,7 @@ Returns the node's absolute path, relative to the :ref:`SceneTree.root` **get_path_to** **(** :ref:`Node` node, :ref:`bool` use_unique_path=false **)** |const| +:ref:`NodePath` **get_path_to**\ (\ node\: :ref:`Node`, use_unique_path\: :ref:`bool` = false\ ) |const| Returns the relative :ref:`NodePath` from this node to the specified ``node``. Both nodes must be in the same :ref:`SceneTree` or scene hierarchy, otherwise this method fails and returns an empty :ref:`NodePath`. @@ -1967,7 +2060,7 @@ If ``use_unique_path`` is ``true``, returns the shortest path accounting for thi .. rst-class:: classref-method -:ref:`float` **get_physics_process_delta_time** **(** **)** |const| +:ref:`float` **get_physics_process_delta_time**\ (\ ) |const| Returns the time elapsed (in seconds) since the last physics callback. This value is identical to :ref:`_physics_process`'s ``delta`` parameter, and is often consistent at run-time, unless :ref:`Engine.physics_ticks_per_second` is changed. See also :ref:`NOTIFICATION_PHYSICS_PROCESS`. @@ -1979,7 +2072,7 @@ Returns the time elapsed (in seconds) since the last physics callback. This valu .. rst-class:: classref-method -:ref:`float` **get_process_delta_time** **(** **)** |const| +:ref:`float` **get_process_delta_time**\ (\ ) |const| Returns the time elapsed (in seconds) since the last process callback. This value is identical to :ref:`_process`'s ``delta`` parameter, and may vary from frame to frame. See also :ref:`NOTIFICATION_PROCESS`. @@ -1991,7 +2084,7 @@ Returns the time elapsed (in seconds) since the last process callback. This valu .. rst-class:: classref-method -:ref:`bool` **get_scene_instance_load_placeholder** **(** **)** |const| +:ref:`bool` **get_scene_instance_load_placeholder**\ (\ ) |const| Returns ``true`` if this node is an instance load placeholder. See :ref:`InstancePlaceholder` and :ref:`set_scene_instance_load_placeholder`. @@ -2003,7 +2096,7 @@ Returns ``true`` if this node is an instance load placeholder. See :ref:`Instanc .. rst-class:: classref-method -:ref:`SceneTree` **get_tree** **(** **)** |const| +:ref:`SceneTree` **get_tree**\ (\ ) |const| Returns the :ref:`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`. @@ -2015,7 +2108,7 @@ Returns the :ref:`SceneTree` that contains this node. If this n .. rst-class:: classref-method -:ref:`String` **get_tree_string** **(** **)** +:ref:`String` **get_tree_string**\ (\ ) Returns the tree as a :ref:`String`. 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` function. It also can be used in game UI/UX. @@ -2038,7 +2131,7 @@ Returns the tree as a :ref:`String`. Used mainly for debugging pur .. rst-class:: classref-method -:ref:`String` **get_tree_string_pretty** **(** **)** +:ref:`String` **get_tree_string_pretty**\ (\ ) Similar to :ref:`get_tree_string`, this returns the tree as a :ref:`String`. This version displays a more graphical representation similar to what is displayed in the Scene Dock. It is useful for inspecting larger trees. @@ -2061,7 +2154,7 @@ Similar to :ref:`get_tree_string`, this retur .. rst-class:: classref-method -:ref:`Viewport` **get_viewport** **(** **)** |const| +:ref:`Viewport` **get_viewport**\ (\ ) |const| Returns the node's closest :ref:`Viewport` ancestor, if the node is inside the tree. Otherwise, returns ``null``. @@ -2073,7 +2166,7 @@ Returns the node's closest :ref:`Viewport` ancestor, if the node .. rst-class:: classref-method -:ref:`Window` **get_window** **(** **)** |const| +:ref:`Window` **get_window**\ (\ ) |const| Returns the :ref:`Window` that contains this node. If the node is in the main window, this is equivalent to getting the root node (``get_tree().get_root()``). @@ -2085,7 +2178,7 @@ Returns the :ref:`Window` that contains this node. If the node is .. rst-class:: classref-method -:ref:`bool` **has_node** **(** :ref:`NodePath` path **)** |const| +:ref:`bool` **has_node**\ (\ path\: :ref:`NodePath`\ ) |const| Returns ``true`` if the ``path`` points to a valid node. See also :ref:`get_node`. @@ -2097,7 +2190,7 @@ Returns ``true`` if the ``path`` points to a valid node. See also :ref:`get_node .. rst-class:: classref-method -:ref:`bool` **has_node_and_resource** **(** :ref:`NodePath` path **)** |const| +:ref:`bool` **has_node_and_resource**\ (\ path\: :ref:`NodePath`\ ) |const| Returns ``true`` if ``path`` points to a valid node and its subnames point to a valid :ref:`Resource`, e.g. ``Area2D/CollisionShape2D:shape``. Properties that are not :ref:`Resource` types (such as nodes or other :ref:`Variant` types) are not considered. See also :ref:`get_node_and_resource`. @@ -2109,7 +2202,7 @@ Returns ``true`` if ``path`` points to a valid node and its subnames point to a .. rst-class:: classref-method -:ref:`bool` **is_ancestor_of** **(** :ref:`Node` node **)** |const| +:ref:`bool` **is_ancestor_of**\ (\ node\: :ref:`Node`\ ) |const| Returns ``true`` if the given ``node`` is a direct or indirect child of this node. @@ -2121,7 +2214,7 @@ Returns ``true`` if the given ``node`` is a direct or indirect child of this nod .. rst-class:: classref-method -:ref:`bool` **is_displayed_folded** **(** **)** |const| +:ref:`bool` **is_displayed_folded**\ (\ ) |const| 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`. @@ -2133,7 +2226,7 @@ Returns ``true`` if the node is folded (collapsed) in the Scene dock. This metho .. rst-class:: classref-method -:ref:`bool` **is_editable_instance** **(** :ref:`Node` node **)** |const| +:ref:`bool` **is_editable_instance**\ (\ node\: :ref:`Node`\ ) |const| 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`. @@ -2145,7 +2238,7 @@ Returns ``true`` if ``node`` has editable children enabled relative to this node .. rst-class:: classref-method -:ref:`bool` **is_greater_than** **(** :ref:`Node` node **)** |const| +:ref:`bool` **is_greater_than**\ (\ node\: :ref:`Node`\ ) |const| Returns ``true`` if the given ``node`` occurs later in the scene hierarchy than this node. A node occurring later is usually processed last. @@ -2157,7 +2250,7 @@ Returns ``true`` if the given ``node`` occurs later in the scene hierarchy than .. rst-class:: classref-method -:ref:`bool` **is_in_group** **(** :ref:`StringName` group **)** |const| +:ref:`bool` **is_in_group**\ (\ group\: :ref:`StringName`\ ) |const| Returns ``true`` if this node has been added to the given ``group``. See :ref:`add_to_group` and :ref:`remove_from_group`. See also notes in the description, and the :ref:`SceneTree`'s group methods. @@ -2169,7 +2262,7 @@ Returns ``true`` if this node has been added to the given ``group``. See :ref:`a .. rst-class:: classref-method -:ref:`bool` **is_inside_tree** **(** **)** |const| +:ref:`bool` **is_inside_tree**\ (\ ) |const| Returns ``true`` if this node is currently inside a :ref:`SceneTree`. See also :ref:`get_tree`. @@ -2181,7 +2274,7 @@ Returns ``true`` if this node is currently inside a :ref:`SceneTree` **is_multiplayer_authority** **(** **)** |const| +:ref:`bool` **is_multiplayer_authority**\ (\ ) |const| Returns ``true`` if the local system is the multiplayer authority of this node. @@ -2193,7 +2286,7 @@ Returns ``true`` if the local system is the multiplayer authority of this node. .. rst-class:: classref-method -:ref:`bool` **is_node_ready** **(** **)** |const| +:ref:`bool` **is_node_ready**\ (\ ) |const| Returns ``true`` if the node is ready, i.e. it's inside scene tree and all its children are initialized. @@ -2207,7 +2300,7 @@ Returns ``true`` if the node is ready, i.e. it's inside scene tree and all its c .. rst-class:: classref-method -:ref:`bool` **is_physics_processing** **(** **)** |const| +:ref:`bool` **is_physics_processing**\ (\ ) |const| Returns ``true`` if physics processing is enabled (see :ref:`set_physics_process`). @@ -2219,7 +2312,7 @@ Returns ``true`` if physics processing is enabled (see :ref:`set_physics_process .. rst-class:: classref-method -:ref:`bool` **is_physics_processing_internal** **(** **)** |const| +:ref:`bool` **is_physics_processing_internal**\ (\ ) |const| Returns ``true`` if internal physics processing is enabled (see :ref:`set_physics_process_internal`). @@ -2231,7 +2324,7 @@ Returns ``true`` if internal physics processing is enabled (see :ref:`set_physic .. rst-class:: classref-method -:ref:`bool` **is_processing** **(** **)** |const| +:ref:`bool` **is_processing**\ (\ ) |const| Returns ``true`` if processing is enabled (see :ref:`set_process`). @@ -2243,7 +2336,7 @@ Returns ``true`` if processing is enabled (see :ref:`set_process` **is_processing_input** **(** **)** |const| +:ref:`bool` **is_processing_input**\ (\ ) |const| Returns ``true`` if the node is processing input (see :ref:`set_process_input`). @@ -2255,7 +2348,7 @@ Returns ``true`` if the node is processing input (see :ref:`set_process_input` **is_processing_internal** **(** **)** |const| +:ref:`bool` **is_processing_internal**\ (\ ) |const| Returns ``true`` if internal processing is enabled (see :ref:`set_process_internal`). @@ -2267,7 +2360,7 @@ Returns ``true`` if internal processing is enabled (see :ref:`set_process_intern .. rst-class:: classref-method -:ref:`bool` **is_processing_shortcut_input** **(** **)** |const| +:ref:`bool` **is_processing_shortcut_input**\ (\ ) |const| Returns ``true`` if the node is processing shortcuts (see :ref:`set_process_shortcut_input`). @@ -2279,7 +2372,7 @@ Returns ``true`` if the node is processing shortcuts (see :ref:`set_process_shor .. rst-class:: classref-method -:ref:`bool` **is_processing_unhandled_input** **(** **)** |const| +:ref:`bool` **is_processing_unhandled_input**\ (\ ) |const| Returns ``true`` if the node is processing unhandled input (see :ref:`set_process_unhandled_input`). @@ -2291,7 +2384,7 @@ Returns ``true`` if the node is processing unhandled input (see :ref:`set_proces .. rst-class:: classref-method -:ref:`bool` **is_processing_unhandled_key_input** **(** **)** |const| +:ref:`bool` **is_processing_unhandled_key_input**\ (\ ) |const| Returns ``true`` if the node is processing unhandled key input (see :ref:`set_process_unhandled_key_input`). @@ -2303,7 +2396,7 @@ Returns ``true`` if the node is processing unhandled key input (see :ref:`set_pr .. rst-class:: classref-method -void **move_child** **(** :ref:`Node` child_node, :ref:`int` to_index **)** +|void| **move_child**\ (\ child_node\: :ref:`Node`, to_index\: :ref:`int`\ ) 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` and :ref:`get_index`. @@ -2317,7 +2410,7 @@ Moves ``child_node`` to the given index. A node's index is the order among its s .. rst-class:: classref-method -void **notify_deferred_thread_group** **(** :ref:`int` what **)** +|void| **notify_deferred_thread_group**\ (\ what\: :ref:`int`\ ) Similar to :ref:`call_deferred_thread_group`, but for notifications. @@ -2329,7 +2422,7 @@ Similar to :ref:`call_deferred_thread_group` what **)** +|void| **notify_thread_safe**\ (\ what\: :ref:`int`\ ) Similar to :ref:`call_thread_safe`, but for notifications. @@ -2341,7 +2434,7 @@ Similar to :ref:`call_thread_safe`, but for .. rst-class:: classref-method -void **print_orphan_nodes** **(** **)** |static| +|void| **print_orphan_nodes**\ (\ ) |static| Prints all orphan nodes (nodes outside the :ref:`SceneTree`). Useful for debugging. @@ -2355,7 +2448,7 @@ Prints all orphan nodes (nodes outside the :ref:`SceneTree`). U .. rst-class:: classref-method -void **print_tree** **(** **)** +|void| **print_tree**\ (\ ) 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`\ s relative to this node, and is good for copy/pasting into :ref:`get_node`. See also :ref:`print_tree_pretty`. @@ -2378,7 +2471,7 @@ Prints the node and its children to the console, recursively. The node does not .. rst-class:: classref-method -void **print_tree_pretty** **(** **)** +|void| **print_tree_pretty**\ (\ ) 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`, but the graphical representation looks like what is displayed in the editor's Scene dock. It is useful for inspecting larger trees. @@ -2401,7 +2494,7 @@ Prints the node and its children to the console, recursively. The node does not .. rst-class:: classref-method -void **propagate_call** **(** :ref:`StringName` method, :ref:`Array` args=[], :ref:`bool` parent_first=false **)** +|void| **propagate_call**\ (\ method\: :ref:`StringName`, args\: :ref:`Array` = [], parent_first\: :ref:`bool` = false\ ) Calls the given ``method`` name, passing ``args`` as arguments, on this node and all of its children, recursively. @@ -2415,7 +2508,7 @@ If ``parent_first`` is ``true``, the method is called on this node first, then o .. rst-class:: classref-method -void **propagate_notification** **(** :ref:`int` what **)** +|void| **propagate_notification**\ (\ what\: :ref:`int`\ ) Calls :ref:`Object.notification` with ``what`` on this node and all of its children, recursively. @@ -2427,7 +2520,7 @@ Calls :ref:`Object.notification` with ``what`` .. rst-class:: classref-method -void **queue_free** **(** **)** +|void| **queue_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. @@ -2443,7 +2536,7 @@ Unlike with :ref:`Object.free`, the node is not delete .. rst-class:: classref-method -void **remove_child** **(** :ref:`Node` node **)** +|void| **remove_child**\ (\ node\: :ref:`Node`\ ) Removes a child ``node``. The ``node``, along with its children, are **not** deleted. To delete a node, see :ref:`queue_free`. @@ -2457,7 +2550,7 @@ Removes a child ``node``. The ``node``, along with its children, are **not** del .. rst-class:: classref-method -void **remove_from_group** **(** :ref:`StringName` group **)** +|void| **remove_from_group**\ (\ group\: :ref:`StringName`\ ) 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`'s group methods. @@ -2469,7 +2562,7 @@ Removes the node from the given ``group``. Does nothing if the node is not in th .. rst-class:: classref-method -void **reparent** **(** :ref:`Node` new_parent, :ref:`bool` keep_global_transform=true **)** +|void| **reparent**\ (\ new_parent\: :ref:`Node`, keep_global_transform\: :ref:`bool` = true\ ) Changes the parent of this **Node** to the ``new_parent``. The node needs to already have a parent. The node's :ref:`owner` is preserved if its owner is still reachable from the new location (i.e., the node is still a descendant of the new parent after the operation). @@ -2483,7 +2576,7 @@ If ``keep_global_transform`` is ``true``, the node's global transform will be pr .. rst-class:: classref-method -void **replace_by** **(** :ref:`Node` node, :ref:`bool` keep_groups=false **)** +|void| **replace_by**\ (\ node\: :ref:`Node`, keep_groups\: :ref:`bool` = false\ ) Replaces this node by the given ``node``. All children of this node are moved to ``node``. @@ -2499,7 +2592,7 @@ If ``keep_groups`` is ``true``, the ``node`` is added to the same groups that th .. rst-class:: classref-method -void **request_ready** **(** **)** +|void| **request_ready**\ (\ ) Requests :ref:`_ready` to be called again the next time the node enters the tree. Does **not** immediately call :ref:`_ready`. @@ -2513,7 +2606,7 @@ Requests :ref:`_ready` to be called again the .. rst-class:: classref-method -:ref:`Error` **rpc** **(** :ref:`StringName` method, ... **)** |vararg| +:ref:`Error` **rpc**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| 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`, including the exact same :ref:`name`. Behavior depends on the RPC configuration for the given ``method`` (see :ref:`rpc_config` and :ref:`@GDScript.@rpc`). By default, methods are not exposed to RPCs. @@ -2529,7 +2622,7 @@ May return :ref:`@GlobalScope.OK` if the call is .. rst-class:: classref-method -void **rpc_config** **(** :ref:`StringName` method, :ref:`Variant` config **)** +|void| **rpc_config**\ (\ method\: :ref:`StringName`, config\: :ref:`Variant`\ ) Changes the RPC configuration for the given ``method``. ``config`` should either be ``null`` to disable the feature (as by default), or a :ref:`Dictionary` containing the following entries: @@ -2551,7 +2644,7 @@ Changes the RPC configuration for the given ``method``. ``config`` should either .. rst-class:: classref-method -:ref:`Error` **rpc_id** **(** :ref:`int` peer_id, :ref:`StringName` method, ... **)** |vararg| +:ref:`Error` **rpc_id**\ (\ peer_id\: :ref:`int`, method\: :ref:`StringName`, ...\ ) |vararg| Sends a :ref:`rpc` to a specific peer identified by ``peer_id`` (see :ref:`MultiplayerPeer.set_target_peer`). @@ -2565,7 +2658,7 @@ May return :ref:`@GlobalScope.OK` if the call is .. rst-class:: classref-method -void **set_deferred_thread_group** **(** :ref:`StringName` property, :ref:`Variant` value **)** +|void| **set_deferred_thread_group**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) Similar to :ref:`call_deferred_thread_group`, but for setting properties. @@ -2577,7 +2670,7 @@ Similar to :ref:`call_deferred_thread_group` fold **)** +|void| **set_display_folded**\ (\ fold\: :ref:`bool`\ ) 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`. @@ -2589,7 +2682,7 @@ If set to ``true``, the node appears folded in the Scene dock. As a result, all .. rst-class:: classref-method -void **set_editable_instance** **(** :ref:`Node` node, :ref:`bool` is_editable **)** +|void| **set_editable_instance**\ (\ node\: :ref:`Node`, is_editable\: :ref:`bool`\ ) Set to ``true`` to allow all nodes owned by ``node`` to be available, and editable, in the Scene dock, even if their :ref:`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`. @@ -2601,7 +2694,7 @@ Set to ``true`` to allow all nodes owned by ``node`` to be available, and editab .. rst-class:: classref-method -void **set_multiplayer_authority** **(** :ref:`int` id, :ref:`bool` recursive=true **)** +|void| **set_multiplayer_authority**\ (\ id\: :ref:`int`, recursive\: :ref:`bool` = 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. Defaults to peer ID 1 (the server). Useful in conjunction with :ref:`rpc_config` and the :ref:`MultiplayerAPI`. @@ -2617,7 +2710,7 @@ If ``recursive`` is ``true``, the given peer is recursively set as the authority .. rst-class:: classref-method -void **set_physics_process** **(** :ref:`bool` enable **)** +|void| **set_physics_process**\ (\ enable\: :ref:`bool`\ ) If set to ``true``, enables physics (fixed framerate) processing. When a node is being processed, it will receive a :ref:`NOTIFICATION_PHYSICS_PROCESS` at a fixed (usually 60 FPS, see :ref:`Engine.physics_ticks_per_second` to change) interval (and the :ref:`_physics_process` callback will be called if it exists). @@ -2631,7 +2724,7 @@ If set to ``true``, enables physics (fixed framerate) processing. When a node is .. rst-class:: classref-method -void **set_physics_process_internal** **(** :ref:`bool` enable **)** +|void| **set_physics_process_internal**\ (\ enable\: :ref:`bool`\ ) If set to ``true``, enables internal physics for this node. Internal physics processing happens in isolation from the normal :ref:`_physics_process` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting (:ref:`set_physics_process`). @@ -2645,7 +2738,7 @@ If set to ``true``, enables internal physics for this node. Internal physics pro .. rst-class:: classref-method -void **set_process** **(** :ref:`bool` enable **)** +|void| **set_process**\ (\ enable\: :ref:`bool`\ ) If set to ``true``, enables processing. When a node is being processed, it will receive a :ref:`NOTIFICATION_PROCESS` on every drawn frame (and the :ref:`_process` callback will be called if it exists). @@ -2661,7 +2754,7 @@ If set to ``true``, enables processing. When a node is being processed, it will .. rst-class:: classref-method -void **set_process_input** **(** :ref:`bool` enable **)** +|void| **set_process_input**\ (\ enable\: :ref:`bool`\ ) If set to ``true``, enables input processing. @@ -2675,7 +2768,7 @@ If set to ``true``, enables input processing. .. rst-class:: classref-method -void **set_process_internal** **(** :ref:`bool` enable **)** +|void| **set_process_internal**\ (\ enable\: :ref:`bool`\ ) If set to ``true``, enables internal processing for this node. Internal processing happens in isolation from the normal :ref:`_process` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting (:ref:`set_process`). @@ -2689,7 +2782,7 @@ If set to ``true``, enables internal processing for this node. Internal processi .. rst-class:: classref-method -void **set_process_shortcut_input** **(** :ref:`bool` enable **)** +|void| **set_process_shortcut_input**\ (\ enable\: :ref:`bool`\ ) If set to ``true``, enables shortcut processing for this node. @@ -2703,7 +2796,7 @@ If set to ``true``, enables shortcut processing for this node. .. rst-class:: classref-method -void **set_process_unhandled_input** **(** :ref:`bool` enable **)** +|void| **set_process_unhandled_input**\ (\ enable\: :ref:`bool`\ ) If set to ``true``, enables unhandled input processing. It enables the node to receive all input that was not previously handled (usually by a :ref:`Control`). @@ -2717,7 +2810,7 @@ If set to ``true``, enables unhandled input processing. It enables the node to r .. rst-class:: classref-method -void **set_process_unhandled_key_input** **(** :ref:`bool` enable **)** +|void| **set_process_unhandled_key_input**\ (\ enable\: :ref:`bool`\ ) If set to ``true``, enables unhandled key input processing. @@ -2731,7 +2824,7 @@ If set to ``true``, enables unhandled key input processing. .. rst-class:: classref-method -void **set_scene_instance_load_placeholder** **(** :ref:`bool` load_placeholder **)** +|void| **set_scene_instance_load_placeholder**\ (\ load_placeholder\: :ref:`bool`\ ) If set to ``true``, the node becomes a :ref:`InstancePlaceholder` when packed and instantiated from a :ref:`PackedScene`. See also :ref:`get_scene_instance_load_placeholder`. @@ -2743,7 +2836,7 @@ If set to ``true``, the node becomes a :ref:`InstancePlaceholder` property, :ref:`Variant` value **)** +|void| **set_thread_safe**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) Similar to :ref:`call_thread_safe`, but for setting properties. @@ -2755,7 +2848,7 @@ Similar to :ref:`call_thread_safe`, but for .. rst-class:: classref-method -void **update_configuration_warnings** **(** **)** +|void| **update_configuration_warnings**\ (\ ) Refreshes the warnings displayed for this node in the Scene dock. Use :ref:`_get_configuration_warnings` to customize the warning messages to display. @@ -2766,3 +2859,4 @@ Refreshes the warnings displayed for this node in the Scene dock. Use :ref:`_get .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index b79b705a711..b01b7601ae6 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -74,29 +74,29 @@ Methods .. table:: :widths: auto - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_scale` **(** :ref:`Vector2` ratio **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_angle_to` **(** :ref:`Vector2` point **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_relative_transform_to_parent` **(** :ref:`Node` parent **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_translate` **(** :ref:`Vector2` offset **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`look_at` **(** :ref:`Vector2` point **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_local_x` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_local_y` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rotate` **(** :ref:`float` radians **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`to_global` **(** :ref:`Vector2` local_point **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`to_local` **(** :ref:`Vector2` global_point **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`translate` **(** :ref:`Vector2` offset **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_scale`\ (\ ratio\: :ref:`Vector2`\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_angle_to`\ (\ point\: :ref:`Vector2`\ ) |const| | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_relative_transform_to_parent`\ (\ parent\: :ref:`Node`\ ) |const| | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_translate`\ (\ offset\: :ref:`Vector2`\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`look_at`\ (\ point\: :ref:`Vector2`\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_local_x`\ (\ delta\: :ref:`float`, scaled\: :ref:`bool` = false\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_local_y`\ (\ delta\: :ref:`float`, scaled\: :ref:`bool` = false\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rotate`\ (\ radians\: :ref:`float`\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`to_global`\ (\ local_point\: :ref:`Vector2`\ ) |const| | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`to_local`\ (\ global_point\: :ref:`Vector2`\ ) |const| | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`translate`\ (\ offset\: :ref:`Vector2`\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -115,8 +115,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_global_position** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_global_position** **(** **)** +- |void| **set_global_position**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_global_position**\ (\ ) Global position. @@ -132,8 +132,8 @@ Global position. .. rst-class:: classref-property-setget -- void **set_global_rotation** **(** :ref:`float` value **)** -- :ref:`float` **get_global_rotation** **(** **)** +- |void| **set_global_rotation**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_global_rotation**\ (\ ) Global rotation in radians. @@ -149,8 +149,8 @@ Global rotation in radians. .. rst-class:: classref-property-setget -- void **set_global_rotation_degrees** **(** :ref:`float` value **)** -- :ref:`float` **get_global_rotation_degrees** **(** **)** +- |void| **set_global_rotation_degrees**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_global_rotation_degrees**\ (\ ) Helper property to access :ref:`global_rotation` in degrees instead of radians. @@ -166,8 +166,8 @@ Helper property to access :ref:`global_rotation` value **)** -- :ref:`Vector2` **get_global_scale** **(** **)** +- |void| **set_global_scale**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_global_scale**\ (\ ) Global scale. @@ -183,8 +183,8 @@ Global scale. .. rst-class:: classref-property-setget -- void **set_global_skew** **(** :ref:`float` value **)** -- :ref:`float` **get_global_skew** **(** **)** +- |void| **set_global_skew**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_global_skew**\ (\ ) Global skew in radians. @@ -200,8 +200,8 @@ Global skew in radians. .. rst-class:: classref-property-setget -- void **set_global_transform** **(** :ref:`Transform2D` value **)** -- :ref:`Transform2D` **get_global_transform** **(** **)** +- |void| **set_global_transform**\ (\ value\: :ref:`Transform2D`\ ) +- :ref:`Transform2D` **get_global_transform**\ (\ ) Global :ref:`Transform2D`. @@ -217,8 +217,8 @@ Global :ref:`Transform2D`. .. rst-class:: classref-property-setget -- void **set_position** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_position** **(** **)** +- |void| **set_position**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_position**\ (\ ) Position, relative to the node's parent. @@ -234,8 +234,8 @@ Position, relative to the node's parent. .. rst-class:: classref-property-setget -- void **set_rotation** **(** :ref:`float` value **)** -- :ref:`float` **get_rotation** **(** **)** +- |void| **set_rotation**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_rotation**\ (\ ) Rotation in radians, relative to the node's parent. @@ -253,8 +253,8 @@ Rotation in radians, relative to the node's parent. .. rst-class:: classref-property-setget -- void **set_rotation_degrees** **(** :ref:`float` value **)** -- :ref:`float` **get_rotation_degrees** **(** **)** +- |void| **set_rotation_degrees**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_rotation_degrees**\ (\ ) Helper property to access :ref:`rotation` in degrees instead of radians. @@ -270,8 +270,8 @@ Helper property to access :ref:`rotation` in deg .. rst-class:: classref-property-setget -- void **set_scale** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_scale** **(** **)** +- |void| **set_scale**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_scale**\ (\ ) The node's scale. Unscaled value: ``(1, 1)``. @@ -289,8 +289,8 @@ The node's scale. Unscaled value: ``(1, 1)``. .. rst-class:: classref-property-setget -- void **set_skew** **(** :ref:`float` value **)** -- :ref:`float` **get_skew** **(** **)** +- |void| **set_skew**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_skew**\ (\ ) Slants the node. @@ -308,8 +308,8 @@ Slants the node. .. rst-class:: classref-property-setget -- void **set_transform** **(** :ref:`Transform2D` value **)** -- :ref:`Transform2D` **get_transform** **(** **)** +- |void| **set_transform**\ (\ value\: :ref:`Transform2D`\ ) +- :ref:`Transform2D` **get_transform**\ (\ ) Local :ref:`Transform2D`. @@ -326,7 +326,7 @@ Method Descriptions .. rst-class:: classref-method -void **apply_scale** **(** :ref:`Vector2` ratio **)** +|void| **apply_scale**\ (\ ratio\: :ref:`Vector2`\ ) Multiplies the current scale by the ``ratio`` vector. @@ -338,7 +338,7 @@ Multiplies the current scale by the ``ratio`` vector. .. rst-class:: classref-method -:ref:`float` **get_angle_to** **(** :ref:`Vector2` point **)** |const| +:ref:`float` **get_angle_to**\ (\ point\: :ref:`Vector2`\ ) |const| Returns the angle between the node and the ``point`` in radians. @@ -352,7 +352,7 @@ Returns the angle between the node and the ``point`` in radians. .. rst-class:: classref-method -:ref:`Transform2D` **get_relative_transform_to_parent** **(** :ref:`Node` parent **)** |const| +:ref:`Transform2D` **get_relative_transform_to_parent**\ (\ parent\: :ref:`Node`\ ) |const| Returns the :ref:`Transform2D` relative to this node's parent. @@ -364,7 +364,7 @@ Returns the :ref:`Transform2D` relative to this node's parent .. rst-class:: classref-method -void **global_translate** **(** :ref:`Vector2` offset **)** +|void| **global_translate**\ (\ offset\: :ref:`Vector2`\ ) Adds the ``offset`` vector to the node's global position. @@ -376,7 +376,7 @@ Adds the ``offset`` vector to the node's global position. .. rst-class:: classref-method -void **look_at** **(** :ref:`Vector2` point **)** +|void| **look_at**\ (\ point\: :ref:`Vector2`\ ) Rotates the node so it points towards the ``point``, which is expected to use global coordinates. @@ -388,7 +388,7 @@ Rotates the node so it points towards the ``point``, which is expected to use gl .. rst-class:: classref-method -void **move_local_x** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** +|void| **move_local_x**\ (\ delta\: :ref:`float`, scaled\: :ref:`bool` = false\ ) Applies a local translation on the node's X axis based on the :ref:`Node._process`'s ``delta``. If ``scaled`` is ``false``, normalizes the movement. @@ -400,7 +400,7 @@ Applies a local translation on the node's X axis based on the :ref:`Node._proces .. rst-class:: classref-method -void **move_local_y** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** +|void| **move_local_y**\ (\ delta\: :ref:`float`, scaled\: :ref:`bool` = false\ ) Applies a local translation on the node's Y axis based on the :ref:`Node._process`'s ``delta``. If ``scaled`` is ``false``, normalizes the movement. @@ -412,7 +412,7 @@ Applies a local translation on the node's Y axis based on the :ref:`Node._proces .. rst-class:: classref-method -void **rotate** **(** :ref:`float` radians **)** +|void| **rotate**\ (\ radians\: :ref:`float`\ ) Applies a rotation to the node, in radians, starting from its current rotation. @@ -424,7 +424,7 @@ Applies a rotation to the node, in radians, starting from its current rotation. .. rst-class:: classref-method -:ref:`Vector2` **to_global** **(** :ref:`Vector2` local_point **)** |const| +:ref:`Vector2` **to_global**\ (\ local_point\: :ref:`Vector2`\ ) |const| Transforms the provided local position into a position in global coordinate space. The input is expected to be local relative to the **Node2D** it is called on. e.g. Applying this method to the positions of child nodes will correctly transform their positions into the global coordinate space, but applying it to a node's own position will give an incorrect result, as it will incorporate the node's own transformation into its global position. @@ -436,7 +436,7 @@ Transforms the provided local position into a position in global coordinate spac .. rst-class:: classref-method -:ref:`Vector2` **to_local** **(** :ref:`Vector2` global_point **)** |const| +:ref:`Vector2` **to_local**\ (\ global_point\: :ref:`Vector2`\ ) |const| Transforms the provided global position into a position in local coordinate space. The output will be local relative to the **Node2D** it is called on. e.g. It is appropriate for determining the positions of child nodes, but it is not appropriate for determining its own position relative to its parent. @@ -448,7 +448,7 @@ Transforms the provided global position into a position in local coordinate spac .. rst-class:: classref-method -void **translate** **(** :ref:`Vector2` offset **)** +|void| **translate**\ (\ offset\: :ref:`Vector2`\ ) Translates the node by the given ``offset`` in local coordinates. @@ -459,3 +459,4 @@ Translates the node by the given ``offset`` in local coordinates. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_node3d.rst b/classes/class_node3d.rst index 4b973f47105..3ece35c33a3 100644 --- a/classes/class_node3d.rst +++ b/classes/class_node3d.rst @@ -12,7 +12,7 @@ Node3D **Inherits:** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`AudioListener3D`, :ref:`AudioStreamPlayer3D`, :ref:`BoneAttachment3D`, :ref:`Camera3D`, :ref:`CollisionObject3D`, :ref:`CollisionPolygon3D`, :ref:`CollisionShape3D`, :ref:`GridMap`, :ref:`ImporterMeshInstance3D`, :ref:`Joint3D`, :ref:`LightmapProbe`, :ref:`Marker3D`, :ref:`NavigationLink3D`, :ref:`NavigationObstacle3D`, :ref:`NavigationRegion3D`, :ref:`OccluderInstance3D`, :ref:`OpenXRHand`, :ref:`Path3D`, :ref:`PathFollow3D`, :ref:`RayCast3D`, :ref:`RemoteTransform3D`, :ref:`ShapeCast3D`, :ref:`Skeleton3D`, :ref:`SpringArm3D`, :ref:`VehicleWheel3D`, :ref:`VisualInstance3D`, :ref:`XRNode3D`, :ref:`XROrigin3D` +**Inherited By:** :ref:`AudioListener3D`, :ref:`AudioStreamPlayer3D`, :ref:`BoneAttachment3D`, :ref:`Camera3D`, :ref:`CollisionObject3D`, :ref:`CollisionPolygon3D`, :ref:`CollisionShape3D`, :ref:`GridMap`, :ref:`ImporterMeshInstance3D`, :ref:`Joint3D`, :ref:`LightmapProbe`, :ref:`Marker3D`, :ref:`NavigationLink3D`, :ref:`NavigationObstacle3D`, :ref:`NavigationRegion3D`, :ref:`OccluderInstance3D`, :ref:`OpenXRHand`, :ref:`Path3D`, :ref:`PathFollow3D`, :ref:`RayCast3D`, :ref:`RemoteTransform3D`, :ref:`ShapeCast3D`, :ref:`Skeleton3D`, :ref:`SpringArm3D`, :ref:`VehicleWheel3D`, :ref:`VisualInstance3D`, :ref:`XRFaceModifier3D`, :ref:`XRHandModifier3D`, :ref:`XRNode3D`, :ref:`XROrigin3D` Most basic 3D game object, parent of all 3D-related nodes. @@ -90,79 +90,79 @@ Methods .. table:: :widths: auto - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_gizmo` **(** :ref:`Node3DGizmo` gizmo **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_gizmos` **(** **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_subgizmo_selection` **(** **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`force_update_transform` **(** **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node3DGizmo[]` | :ref:`get_gizmos` **(** **)** |const| | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node3D` | :ref:`get_parent_node_3d` **(** **)** |const| | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`World3D` | :ref:`get_world_3d` **(** **)** |const| | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_rotate` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_scale` **(** :ref:`Vector3` scale **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_translate` **(** :ref:`Vector3` offset **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`hide` **(** **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** |const| | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_scale_disabled` **(** **)** |const| | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** |const| | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** |const| | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`look_at` **(** :ref:`Vector3` target, :ref:`Vector3` up=Vector3(0, 1, 0), :ref:`bool` use_model_front=false **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`look_at_from_position` **(** :ref:`Vector3` position, :ref:`Vector3` target, :ref:`Vector3` up=Vector3(0, 1, 0), :ref:`bool` use_model_front=false **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`orthonormalize` **(** **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rotate` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rotate_object_local` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rotate_x` **(** :ref:`float` angle **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rotate_y` **(** :ref:`float` angle **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rotate_z` **(** :ref:`float` angle **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`scale_object_local` **(** :ref:`Vector3` scale **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_disable_scale` **(** :ref:`bool` disable **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_identity` **(** **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_ignore_transform_notification` **(** :ref:`bool` enabled **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_subgizmo_selection` **(** :ref:`Node3DGizmo` gizmo, :ref:`int` id, :ref:`Transform3D` transform **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`show` **(** **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`to_global` **(** :ref:`Vector3` local_point **)** |const| | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`to_local` **(** :ref:`Vector3` global_point **)** |const| | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`translate` **(** :ref:`Vector3` offset **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`translate_object_local` **(** :ref:`Vector3` offset **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`update_gizmos` **(** **)** | - +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_gizmo`\ (\ gizmo\: :ref:`Node3DGizmo`\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_gizmos`\ (\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_subgizmo_selection`\ (\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_update_transform`\ (\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Node3DGizmo`\] | :ref:`get_gizmos`\ (\ ) |const| | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node3D` | :ref:`get_parent_node_3d`\ (\ ) |const| | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`World3D` | :ref:`get_world_3d`\ (\ ) |const| | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_rotate`\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_scale`\ (\ scale\: :ref:`Vector3`\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_translate`\ (\ offset\: :ref:`Vector3`\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`hide`\ (\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_local_transform_notification_enabled`\ (\ ) |const| | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_scale_disabled`\ (\ ) |const| | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_transform_notification_enabled`\ (\ ) |const| | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_visible_in_tree`\ (\ ) |const| | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`look_at`\ (\ target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`look_at_from_position`\ (\ position\: :ref:`Vector3`, target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`orthonormalize`\ (\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rotate`\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rotate_object_local`\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rotate_x`\ (\ angle\: :ref:`float`\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rotate_y`\ (\ angle\: :ref:`float`\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rotate_z`\ (\ angle\: :ref:`float`\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`scale_object_local`\ (\ scale\: :ref:`Vector3`\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_disable_scale`\ (\ disable\: :ref:`bool`\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_identity`\ (\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_ignore_transform_notification`\ (\ enabled\: :ref:`bool`\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_notify_local_transform`\ (\ enable\: :ref:`bool`\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_notify_transform`\ (\ enable\: :ref:`bool`\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_subgizmo_selection`\ (\ gizmo\: :ref:`Node3DGizmo`, id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`show`\ (\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`to_global`\ (\ local_point\: :ref:`Vector3`\ ) |const| | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`to_local`\ (\ global_point\: :ref:`Vector3`\ ) |const| | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`translate`\ (\ offset\: :ref:`Vector3`\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`translate_object_local`\ (\ offset\: :ref:`Vector3`\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update_gizmos`\ (\ ) | + +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -177,7 +177,7 @@ Signals .. rst-class:: classref-signal -**visibility_changed** **(** **)** +**visibility_changed**\ (\ ) Emitted when node visibility changes. @@ -290,8 +290,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_basis** **(** :ref:`Basis` value **)** -- :ref:`Basis` **get_basis** **(** **)** +- |void| **set_basis**\ (\ value\: :ref:`Basis`\ ) +- :ref:`Basis` **get_basis**\ (\ ) Direct access to the 3x3 basis of the :ref:`transform` property. @@ -307,8 +307,8 @@ Direct access to the 3x3 basis of the :ref:`transform` value **)** -- :ref:`Basis` **get_global_basis** **(** **)** +- |void| **set_global_basis**\ (\ value\: :ref:`Basis`\ ) +- :ref:`Basis` **get_global_basis**\ (\ ) Global basis of this node. This is equivalent to ``global_transform.basis``. @@ -324,8 +324,8 @@ Global basis of this node. This is equivalent to ``global_transform.basis``. .. rst-class:: classref-property-setget -- void **set_global_position** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_global_position** **(** **)** +- |void| **set_global_position**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_global_position**\ (\ ) Global position of this node. This is equivalent to ``global_transform.origin``. @@ -341,8 +341,8 @@ Global position of this node. This is equivalent to ``global_transform.origin``. .. rst-class:: classref-property-setget -- void **set_global_rotation** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_global_rotation** **(** **)** +- |void| **set_global_rotation**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_global_rotation**\ (\ ) Rotation part of the global transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle). @@ -360,8 +360,8 @@ Rotation part of the global transformation in radians, specified in terms of YXZ .. rst-class:: classref-property-setget -- void **set_global_rotation_degrees** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_global_rotation_degrees** **(** **)** +- |void| **set_global_rotation_degrees**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_global_rotation_degrees**\ (\ ) Helper property to access :ref:`global_rotation` in degrees instead of radians. @@ -377,8 +377,8 @@ Helper property to access :ref:`global_rotation` value **)** -- :ref:`Transform3D` **get_global_transform** **(** **)** +- |void| **set_global_transform**\ (\ value\: :ref:`Transform3D`\ ) +- :ref:`Transform3D` **get_global_transform**\ (\ ) World3D space (global) :ref:`Transform3D` of this node. @@ -394,8 +394,8 @@ World3D space (global) :ref:`Transform3D` of this node. .. rst-class:: classref-property-setget -- void **set_position** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_position** **(** **)** +- |void| **set_position**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_position**\ (\ ) Local position or translation of this node relative to the parent. This is equivalent to ``transform.origin``. @@ -411,8 +411,8 @@ Local position or translation of this node relative to the parent. This is equiv .. rst-class:: classref-property-setget -- void **set_quaternion** **(** :ref:`Quaternion` value **)** -- :ref:`Quaternion` **get_quaternion** **(** **)** +- |void| **set_quaternion**\ (\ value\: :ref:`Quaternion`\ ) +- :ref:`Quaternion` **get_quaternion**\ (\ ) Access to the node rotation as a :ref:`Quaternion`. This property is ideal for tweening complex rotations. @@ -428,8 +428,8 @@ Access to the node rotation as a :ref:`Quaternion`. This prope .. rst-class:: classref-property-setget -- void **set_rotation** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_rotation** **(** **)** +- |void| **set_rotation**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_rotation**\ (\ ) Rotation part of the local transformation in radians, specified in terms of Euler angles. The angles construct a rotation in the order specified by the :ref:`rotation_order` property. @@ -449,8 +449,8 @@ Rotation part of the local transformation in radians, specified in terms of Eule .. rst-class:: classref-property-setget -- void **set_rotation_degrees** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_rotation_degrees** **(** **)** +- |void| **set_rotation_degrees**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_rotation_degrees**\ (\ ) Helper property to access :ref:`rotation` in degrees instead of radians. @@ -466,8 +466,8 @@ Helper property to access :ref:`rotation` in deg .. rst-class:: classref-property-setget -- void **set_rotation_edit_mode** **(** :ref:`RotationEditMode` value **)** -- :ref:`RotationEditMode` **get_rotation_edit_mode** **(** **)** +- |void| **set_rotation_edit_mode**\ (\ value\: :ref:`RotationEditMode`\ ) +- :ref:`RotationEditMode` **get_rotation_edit_mode**\ (\ ) Specify how rotation (and scale) will be presented in the editor. @@ -483,8 +483,8 @@ Specify how rotation (and scale) will be presented in the editor. .. rst-class:: classref-property-setget -- void **set_rotation_order** **(** :ref:`EulerOrder` value **)** -- :ref:`EulerOrder` **get_rotation_order** **(** **)** +- |void| **set_rotation_order**\ (\ value\: :ref:`EulerOrder`\ ) +- :ref:`EulerOrder` **get_rotation_order**\ (\ ) Specify the axis rotation order of the :ref:`rotation` property. The final orientation is constructed by rotating the Euler angles in the order specified by this property. @@ -500,8 +500,8 @@ Specify the axis rotation order of the :ref:`rotation` value **)** -- :ref:`Vector3` **get_scale** **(** **)** +- |void| **set_scale**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_scale**\ (\ ) Scale part of the local transformation. @@ -521,8 +521,8 @@ Scale part of the local transformation. .. rst-class:: classref-property-setget -- void **set_as_top_level** **(** :ref:`bool` value **)** -- :ref:`bool` **is_set_as_top_level** **(** **)** +- |void| **set_as_top_level**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_set_as_top_level**\ (\ ) If ``true``, the node will not inherit its transformations from its parent. Node transformations are only in global space. @@ -538,8 +538,8 @@ If ``true``, the node will not inherit its transformations from its parent. Node .. rst-class:: classref-property-setget -- void **set_transform** **(** :ref:`Transform3D` value **)** -- :ref:`Transform3D` **get_transform** **(** **)** +- |void| **set_transform**\ (\ value\: :ref:`Transform3D`\ ) +- :ref:`Transform3D` **get_transform**\ (\ ) Local space :ref:`Transform3D` of this node, with respect to the parent node. @@ -555,8 +555,8 @@ Local space :ref:`Transform3D` of this node, with respect to .. rst-class:: classref-property-setget -- void **set_visibility_parent** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_visibility_parent** **(** **)** +- |void| **set_visibility_parent**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_visibility_parent**\ (\ ) Defines the visibility range parent for this node and its subtree. The visibility parent must be a GeometryInstance3D. Any visual instance will only be visible if the visibility parent (and all of its visibility ancestors) is hidden by being closer to the camera than its own :ref:`GeometryInstance3D.visibility_range_begin`. Nodes hidden via the :ref:`visible` property are essentially removed from the visibility dependency tree, so dependent instances will not take the hidden node or its ancestors into account. @@ -572,8 +572,8 @@ Defines the visibility range parent for this node and its subtree. The visibilit .. rst-class:: classref-property-setget -- void **set_visible** **(** :ref:`bool` value **)** -- :ref:`bool` **is_visible** **(** **)** +- |void| **set_visible**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_visible**\ (\ ) If ``true``, this node is drawn. The node is only visible if all of its ancestors are visible as well (in other words, :ref:`is_visible_in_tree` must return ``true``). @@ -590,7 +590,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_gizmo** **(** :ref:`Node3DGizmo` gizmo **)** +|void| **add_gizmo**\ (\ gizmo\: :ref:`Node3DGizmo`\ ) Attach an editor gizmo to this **Node3D**. @@ -604,7 +604,7 @@ Attach an editor gizmo to this **Node3D**. .. rst-class:: classref-method -void **clear_gizmos** **(** **)** +|void| **clear_gizmos**\ (\ ) Clear all gizmos attached to this **Node3D**. @@ -616,7 +616,7 @@ Clear all gizmos attached to this **Node3D**. .. rst-class:: classref-method -void **clear_subgizmo_selection** **(** **)** +|void| **clear_subgizmo_selection**\ (\ ) Clears subgizmo selection for this node in the editor. Useful when subgizmo IDs become invalid after a property change. @@ -628,7 +628,7 @@ Clears subgizmo selection for this node in the editor. Useful when subgizmo IDs .. rst-class:: classref-method -void **force_update_transform** **(** **)** +|void| **force_update_transform**\ (\ ) Forces the transform to update. Transform changes in physics are not instant for performance reasons. Transforms are accumulated and then set. Use this if you need an up-to-date transform when doing physics operations. @@ -640,7 +640,7 @@ Forces the transform to update. Transform changes in physics are not instant for .. rst-class:: classref-method -:ref:`Node3DGizmo[]` **get_gizmos** **(** **)** |const| +:ref:`Array`\[:ref:`Node3DGizmo`\] **get_gizmos**\ (\ ) |const| Returns all the gizmos attached to this **Node3D**. @@ -652,7 +652,7 @@ Returns all the gizmos attached to this **Node3D**. .. rst-class:: classref-method -:ref:`Node3D` **get_parent_node_3d** **(** **)** |const| +:ref:`Node3D` **get_parent_node_3d**\ (\ ) |const| Returns the parent **Node3D**, or an empty :ref:`Object` if no parent exists or parent is not of type **Node3D**. @@ -664,7 +664,7 @@ Returns the parent **Node3D**, or an empty :ref:`Object` if no par .. rst-class:: classref-method -:ref:`World3D` **get_world_3d** **(** **)** |const| +:ref:`World3D` **get_world_3d**\ (\ ) |const| Returns the current :ref:`World3D` resource this **Node3D** node is registered to. @@ -676,7 +676,7 @@ Returns the current :ref:`World3D` resource this **Node3D** node .. rst-class:: classref-method -void **global_rotate** **(** :ref:`Vector3` axis, :ref:`float` angle **)** +|void| **global_rotate**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) Rotates the global (world) transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. The rotation axis is in global coordinate system. @@ -688,7 +688,7 @@ Rotates the global (world) transformation around axis, a unit :ref:`Vector3` scale **)** +|void| **global_scale**\ (\ scale\: :ref:`Vector3`\ ) Scales the global (world) transformation by the given :ref:`Vector3` scale factors. @@ -700,7 +700,7 @@ Scales the global (world) transformation by the given :ref:`Vector3` offset **)** +|void| **global_translate**\ (\ offset\: :ref:`Vector3`\ ) Moves the global (world) transformation by :ref:`Vector3` offset. The offset is in global coordinate system. @@ -712,7 +712,7 @@ Moves the global (world) transformation by :ref:`Vector3` offset. .. rst-class:: classref-method -void **hide** **(** **)** +|void| **hide**\ (\ ) Disables rendering of this node. Changes :ref:`visible` to ``false``. @@ -724,7 +724,7 @@ Disables rendering of this node. Changes :ref:`visible` **is_local_transform_notification_enabled** **(** **)** |const| +:ref:`bool` **is_local_transform_notification_enabled**\ (\ ) |const| Returns whether node notifies about its local transformation changes. **Node3D** will not propagate this by default. @@ -736,7 +736,7 @@ Returns whether node notifies about its local transformation changes. **Node3D** .. rst-class:: classref-method -:ref:`bool` **is_scale_disabled** **(** **)** |const| +:ref:`bool` **is_scale_disabled**\ (\ ) |const| Returns whether this node uses a scale of ``(1, 1, 1)`` or its local transformation scale. @@ -748,7 +748,7 @@ Returns whether this node uses a scale of ``(1, 1, 1)`` or its local transformat .. rst-class:: classref-method -:ref:`bool` **is_transform_notification_enabled** **(** **)** |const| +:ref:`bool` **is_transform_notification_enabled**\ (\ ) |const| Returns whether the node notifies about its global and local transformation changes. **Node3D** will not propagate this by default. @@ -760,7 +760,7 @@ Returns whether the node notifies about its global and local transformation chan .. rst-class:: classref-method -:ref:`bool` **is_visible_in_tree** **(** **)** |const| +: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. @@ -772,7 +772,7 @@ Returns ``true`` if the node is present in the :ref:`SceneTree` .. rst-class:: classref-method -void **look_at** **(** :ref:`Vector3` target, :ref:`Vector3` up=Vector3(0, 1, 0), :ref:`bool` use_model_front=false **)** +|void| **look_at**\ (\ target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) Rotates the node so that the local forward axis (-Z, :ref:`Vector3.FORWARD`) points toward the ``target`` position. @@ -792,7 +792,7 @@ If ``use_model_front`` is ``true``, the +Z axis (asset front) is treated as forw .. rst-class:: classref-method -void **look_at_from_position** **(** :ref:`Vector3` position, :ref:`Vector3` target, :ref:`Vector3` up=Vector3(0, 1, 0), :ref:`bool` use_model_front=false **)** +|void| **look_at_from_position**\ (\ position\: :ref:`Vector3`, target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) Moves the node to the specified ``position``, and then rotates the node to point toward the ``target`` as per :ref:`look_at`. Operations take place in global space. @@ -804,7 +804,7 @@ Moves the node to the specified ``position``, and then rotates the node to point .. rst-class:: classref-method -void **orthonormalize** **(** **)** +|void| **orthonormalize**\ (\ ) Resets this node's transformations (like scale, skew and taper) preserving its rotation and translation by performing Gram-Schmidt orthonormalization on this node's :ref:`Transform3D`. @@ -816,7 +816,7 @@ Resets this node's transformations (like scale, skew and taper) preserving its r .. rst-class:: classref-method -void **rotate** **(** :ref:`Vector3` axis, :ref:`float` angle **)** +|void| **rotate**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) Rotates the local transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. @@ -828,7 +828,7 @@ Rotates the local transformation around axis, a unit :ref:`Vector3` axis, :ref:`float` angle **)** +|void| **rotate_object_local**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) Rotates the local transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. The rotation axis is in object-local coordinate system. @@ -840,7 +840,7 @@ Rotates the local transformation around axis, a unit :ref:`Vector3` angle **)** +|void| **rotate_x**\ (\ angle\: :ref:`float`\ ) Rotates the local transformation around the X axis by angle in radians. @@ -852,7 +852,7 @@ Rotates the local transformation around the X axis by angle in radians. .. rst-class:: classref-method -void **rotate_y** **(** :ref:`float` angle **)** +|void| **rotate_y**\ (\ angle\: :ref:`float`\ ) Rotates the local transformation around the Y axis by angle in radians. @@ -864,7 +864,7 @@ Rotates the local transformation around the Y axis by angle in radians. .. rst-class:: classref-method -void **rotate_z** **(** :ref:`float` angle **)** +|void| **rotate_z**\ (\ angle\: :ref:`float`\ ) Rotates the local transformation around the Z axis by angle in radians. @@ -876,7 +876,7 @@ Rotates the local transformation around the Z axis by angle in radians. .. rst-class:: classref-method -void **scale_object_local** **(** :ref:`Vector3` scale **)** +|void| **scale_object_local**\ (\ scale\: :ref:`Vector3`\ ) Scales the local transformation by given 3D scale factors in object-local coordinate system. @@ -888,7 +888,7 @@ Scales the local transformation by given 3D scale factors in object-local coordi .. rst-class:: classref-method -void **set_disable_scale** **(** :ref:`bool` disable **)** +|void| **set_disable_scale**\ (\ disable\: :ref:`bool`\ ) Sets whether the node uses a scale of ``(1, 1, 1)`` or its local transformation scale. Changes to the local transformation scale are preserved. @@ -900,7 +900,7 @@ Sets whether the node uses a scale of ``(1, 1, 1)`` or its local transformation .. rst-class:: classref-method -void **set_identity** **(** **)** +|void| **set_identity**\ (\ ) Reset all transformations for this node (sets its :ref:`Transform3D` to the identity matrix). @@ -912,7 +912,7 @@ Reset all transformations for this node (sets its :ref:`Transform3D` enabled **)** +|void| **set_ignore_transform_notification**\ (\ enabled\: :ref:`bool`\ ) Sets whether the node ignores notification that its transformation (global or local) changed. @@ -924,7 +924,7 @@ Sets whether the node ignores notification that its transformation (global or lo .. rst-class:: classref-method -void **set_notify_local_transform** **(** :ref:`bool` enable **)** +|void| **set_notify_local_transform**\ (\ enable\: :ref:`bool`\ ) Sets whether the node notifies about its local transformation changes. **Node3D** will not propagate this by default. @@ -936,7 +936,7 @@ Sets whether the node notifies about its local transformation changes. **Node3D* .. rst-class:: classref-method -void **set_notify_transform** **(** :ref:`bool` enable **)** +|void| **set_notify_transform**\ (\ enable\: :ref:`bool`\ ) Sets whether the node notifies about its global and local transformation changes. **Node3D** will not propagate this by default, unless it is in the editor context and it has a valid gizmo. @@ -948,7 +948,7 @@ Sets whether the node notifies about its global and local transformation changes .. rst-class:: classref-method -void **set_subgizmo_selection** **(** :ref:`Node3DGizmo` gizmo, :ref:`int` id, :ref:`Transform3D` transform **)** +|void| **set_subgizmo_selection**\ (\ gizmo\: :ref:`Node3DGizmo`, id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) Set subgizmo selection for this node in the editor. @@ -962,7 +962,7 @@ Set subgizmo selection for this node in the editor. .. rst-class:: classref-method -void **show** **(** **)** +|void| **show**\ (\ ) Enables rendering of this node. Changes :ref:`visible` to ``true``. @@ -974,7 +974,7 @@ Enables rendering of this node. Changes :ref:`visible` **to_global** **(** :ref:`Vector3` local_point **)** |const| +:ref:`Vector3` **to_global**\ (\ local_point\: :ref:`Vector3`\ ) |const| Transforms ``local_point`` from this node's local space to world space. @@ -986,7 +986,7 @@ Transforms ``local_point`` from this node's local space to world space. .. rst-class:: classref-method -:ref:`Vector3` **to_local** **(** :ref:`Vector3` global_point **)** |const| +:ref:`Vector3` **to_local**\ (\ global_point\: :ref:`Vector3`\ ) |const| Transforms ``global_point`` from world space to this node's local space. @@ -998,7 +998,7 @@ Transforms ``global_point`` from world space to this node's local space. .. rst-class:: classref-method -void **translate** **(** :ref:`Vector3` offset **)** +|void| **translate**\ (\ offset\: :ref:`Vector3`\ ) Changes the node's position by the given offset :ref:`Vector3`. @@ -1012,7 +1012,7 @@ Note that the translation ``offset`` is affected by the node's scale, so if scal .. rst-class:: classref-method -void **translate_object_local** **(** :ref:`Vector3` offset **)** +|void| **translate_object_local**\ (\ offset\: :ref:`Vector3`\ ) Changes the node's position by the given offset :ref:`Vector3` in local space. @@ -1024,7 +1024,7 @@ Changes the node's position by the given offset :ref:`Vector3` in .. rst-class:: classref-method -void **update_gizmos** **(** **)** +|void| **update_gizmos**\ (\ ) Updates all the **Node3D** gizmos attached to this node. @@ -1035,3 +1035,4 @@ Updates all the **Node3D** gizmos attached to this node. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_node3dgizmo.rst b/classes/class_node3dgizmo.rst index 5577bb9699c..439f4bad10c 100644 --- a/classes/class_node3dgizmo.rst +++ b/classes/class_node3dgizmo.rst @@ -32,3 +32,4 @@ This abstract class helps connect the :ref:`Node3D` scene with the .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index 296d0a0b906..507e4650fd1 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -76,13 +76,13 @@ Constructors .. table:: :widths: auto - +---------------------------------+-------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`NodePath` **(** **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`NodePath` **(** :ref:`NodePath` from **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`NodePath` **(** :ref:`String` from **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------+ + +---------------------------------+----------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`NodePath`\ (\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`NodePath`\ (\ from\: :ref:`NodePath`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`NodePath`\ (\ from\: :ref:`String`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -92,27 +92,27 @@ Methods .. table:: :widths: auto - +-------------------------------------+-------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_as_property_path` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_concatenated_names` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_concatenated_subnames` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_name` **(** :ref:`int` idx **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_name_count` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_subname` **(** :ref:`int` idx **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_subname_count` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`hash` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_absolute` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------+ + +-------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_as_property_path`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_concatenated_names`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_concatenated_subnames`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_name`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_name_count`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_subname`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_subname_count`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`hash`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_absolute`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -122,11 +122,11 @@ Operators .. table:: :widths: auto - +-------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`NodePath` right **)** | - +-------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`NodePath` right **)** | - +-------------------------+------------------------------------------------------------------------------------------------------------+ + +-------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`NodePath`\ ) | + +-------------------------+---------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`NodePath`\ ) | + +-------------------------+---------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -141,7 +141,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`NodePath` **NodePath** **(** **)** +:ref:`NodePath` **NodePath**\ (\ ) Constructs an empty **NodePath**. @@ -151,7 +151,7 @@ Constructs an empty **NodePath**. .. rst-class:: classref-constructor -:ref:`NodePath` **NodePath** **(** :ref:`NodePath` from **)** +:ref:`NodePath` **NodePath**\ (\ from\: :ref:`NodePath`\ ) Constructs a **NodePath** as a copy of the given **NodePath**. @@ -161,7 +161,7 @@ Constructs a **NodePath** as a copy of the given **NodePath**. .. rst-class:: classref-constructor -:ref:`NodePath` **NodePath** **(** :ref:`String` from **)** +:ref:`NodePath` **NodePath**\ (\ from\: :ref:`String`\ ) Constructs a **NodePath** from a :ref:`String`. The created path is absolute if prefixed with a slash (see :ref:`is_absolute`). @@ -203,7 +203,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`NodePath` **get_as_property_path** **(** **)** |const| +:ref:`NodePath` **get_as_property_path**\ (\ ) |const| Returns a copy of this node path with a colon character (``:``) prefixed, transforming it to a pure property path with no node names (relative to the current node). @@ -238,7 +238,7 @@ Returns a copy of this node path with a colon character (``:``) prefixed, transf .. rst-class:: classref-method -:ref:`StringName` **get_concatenated_names** **(** **)** |const| +:ref:`StringName` **get_concatenated_names**\ (\ ) |const| Returns all node names concatenated with a slash character (``/``) as a single :ref:`StringName`. @@ -250,7 +250,7 @@ Returns all node names concatenated with a slash character (``/``) as a single : .. rst-class:: classref-method -:ref:`StringName` **get_concatenated_subnames** **(** **)** |const| +:ref:`StringName` **get_concatenated_subnames**\ (\ ) |const| Returns all property subnames concatenated with a colon character (``:``) as a single :ref:`StringName`. @@ -277,7 +277,7 @@ Returns all property subnames concatenated with a colon character (``:``) as a s .. rst-class:: classref-method -:ref:`StringName` **get_name** **(** :ref:`int` idx **)** |const| +:ref:`StringName` **get_name**\ (\ idx\: :ref:`int`\ ) |const| Returns the node name indicated by ``idx``, starting from 0. If ``idx`` is out of bounds, an error is generated. See also :ref:`get_subname_count` and :ref:`get_name_count`. @@ -308,7 +308,7 @@ Returns the node name indicated by ``idx``, starting from 0. If ``idx`` is out o .. rst-class:: classref-method -:ref:`int` **get_name_count** **(** **)** |const| +:ref:`int` **get_name_count**\ (\ ) |const| Returns the number of node names in the path. Property subnames are not included. @@ -322,7 +322,7 @@ For example, ``"../RigidBody2D/Sprite2D:texture"`` contains 3 node names. .. rst-class:: classref-method -:ref:`StringName` **get_subname** **(** :ref:`int` idx **)** |const| +:ref:`StringName` **get_subname**\ (\ idx\: :ref:`int`\ ) |const| Returns the property name indicated by ``idx``, starting from 0. If ``idx`` is out of bounds, an error is generated. See also :ref:`get_subname_count`. @@ -351,7 +351,7 @@ Returns the property name indicated by ``idx``, starting from 0. If ``idx`` is o .. rst-class:: classref-method -:ref:`int` **get_subname_count** **(** **)** |const| +:ref:`int` **get_subname_count**\ (\ ) |const| Returns the number of property names ("subnames") in the path. Each subname in the node path is listed after a colon character (``:``). @@ -365,7 +365,7 @@ For example, ``"Level/RigidBody2D/Sprite2D:texture:resource_name"`` contains 2 s .. rst-class:: classref-method -:ref:`int` **hash** **(** **)** |const| +:ref:`int` **hash**\ (\ ) |const| Returns the 32-bit hash value representing the node path's contents. @@ -379,7 +379,7 @@ Returns the 32-bit hash value representing the node path's contents. .. rst-class:: classref-method -:ref:`bool` **is_absolute** **(** **)** |const| +:ref:`bool` **is_absolute**\ (\ ) |const| Returns ``true`` if the node path is absolute. Unlike a relative path, an absolute path is represented by a leading slash character (``/``) and always begins from the :ref:`SceneTree`. It can be used to reliably access nodes from the root node (e.g. ``"/root/Global"`` if an autoload named "Global" exists). @@ -391,7 +391,7 @@ Returns ``true`` if the node path is absolute. Unlike a relative path, an absolu .. rst-class:: classref-method -:ref:`bool` **is_empty** **(** **)** |const| +:ref:`bool` **is_empty**\ (\ ) |const| Returns ``true`` if the node path has been constructed from an empty :ref:`String` (``""``). @@ -408,7 +408,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`NodePath` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`NodePath`\ ) Returns ``true`` if two node paths are not equal. @@ -420,7 +420,7 @@ Returns ``true`` if two node paths are not equal. .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`NodePath` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`NodePath`\ ) Returns ``true`` if two node paths are equal, that is, they are composed of the same node names and subnames in the same order. @@ -431,3 +431,4 @@ Returns ``true`` if two node paths are equal, that is, they are composed of the .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_noise.rst b/classes/class_noise.rst index b1b093270aa..4c47cb45651 100644 --- a/classes/class_noise.rst +++ b/classes/class_noise.rst @@ -35,25 +35,25 @@ Methods .. table:: :widths: auto - +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`get_image` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` invert=false, :ref:`bool` in_3d_space=false, :ref:`bool` normalize=true **)** |const| | - +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image[]` | :ref:`get_image_3d` **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`bool` invert=false, :ref:`bool` normalize=true **)** |const| | - +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_noise_1d` **(** :ref:`float` x **)** |const| | - +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_noise_2d` **(** :ref:`float` x, :ref:`float` y **)** |const| | - +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_noise_2dv` **(** :ref:`Vector2` v **)** |const| | - +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_noise_3d` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** |const| | - +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_noise_3dv` **(** :ref:`Vector3` v **)** |const| | - +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`get_seamless_image` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` invert=false, :ref:`bool` in_3d_space=false, :ref:`float` skirt=0.1, :ref:`bool` normalize=true **)** |const| | - +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image[]` | :ref:`get_seamless_image_3d` **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`bool` invert=false, :ref:`float` skirt=0.1, :ref:`bool` normalize=true **)** |const| | - +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`get_image`\ (\ width\: :ref:`int`, height\: :ref:`int`, invert\: :ref:`bool` = false, in_3d_space\: :ref:`bool` = false, normalize\: :ref:`bool` = true\ ) |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Image`\] | :ref:`get_image_3d`\ (\ width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, invert\: :ref:`bool` = false, normalize\: :ref:`bool` = true\ ) |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_noise_1d`\ (\ x\: :ref:`float`\ ) |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_noise_2d`\ (\ x\: :ref:`float`, y\: :ref:`float`\ ) |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_noise_2dv`\ (\ v\: :ref:`Vector2`\ ) |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_noise_3d`\ (\ x\: :ref:`float`, y\: :ref:`float`, z\: :ref:`float`\ ) |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_noise_3dv`\ (\ v\: :ref:`Vector3`\ ) |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`get_seamless_image`\ (\ width\: :ref:`int`, height\: :ref:`int`, invert\: :ref:`bool` = false, in_3d_space\: :ref:`bool` = false, skirt\: :ref:`float` = 0.1, normalize\: :ref:`bool` = true\ ) |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Image`\] | :ref:`get_seamless_image_3d`\ (\ width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, invert\: :ref:`bool` = false, skirt\: :ref:`float` = 0.1, normalize\: :ref:`bool` = true\ ) |const| | + +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -68,7 +68,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Image` **get_image** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` invert=false, :ref:`bool` in_3d_space=false, :ref:`bool` normalize=true **)** |const| +:ref:`Image` **get_image**\ (\ width\: :ref:`int`, height\: :ref:`int`, invert\: :ref:`bool` = false, in_3d_space\: :ref:`bool` = false, normalize\: :ref:`bool` = true\ ) |const| Returns an :ref:`Image` containing 2D noise values. @@ -82,7 +82,7 @@ Returns an :ref:`Image` containing 2D noise values. .. rst-class:: classref-method -:ref:`Image[]` **get_image_3d** **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`bool` invert=false, :ref:`bool` normalize=true **)** |const| +:ref:`Array`\[:ref:`Image`\] **get_image_3d**\ (\ width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, invert\: :ref:`bool` = false, normalize\: :ref:`bool` = true\ ) |const| Returns an :ref:`Array` of :ref:`Image`\ s containing 3D noise values for use with :ref:`ImageTexture3D.create`. @@ -96,7 +96,7 @@ Returns an :ref:`Array` of :ref:`Image`\ s containing .. rst-class:: classref-method -:ref:`float` **get_noise_1d** **(** :ref:`float` x **)** |const| +:ref:`float` **get_noise_1d**\ (\ x\: :ref:`float`\ ) |const| Returns the 1D noise value at the given (x) coordinate. @@ -108,7 +108,7 @@ Returns the 1D noise value at the given (x) coordinate. .. rst-class:: classref-method -:ref:`float` **get_noise_2d** **(** :ref:`float` x, :ref:`float` y **)** |const| +:ref:`float` **get_noise_2d**\ (\ x\: :ref:`float`, y\: :ref:`float`\ ) |const| Returns the 2D noise value at the given position. @@ -120,7 +120,7 @@ Returns the 2D noise value at the given position. .. rst-class:: classref-method -:ref:`float` **get_noise_2dv** **(** :ref:`Vector2` v **)** |const| +:ref:`float` **get_noise_2dv**\ (\ v\: :ref:`Vector2`\ ) |const| Returns the 2D noise value at the given position. @@ -132,7 +132,7 @@ Returns the 2D noise value at the given position. .. rst-class:: classref-method -:ref:`float` **get_noise_3d** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** |const| +:ref:`float` **get_noise_3d**\ (\ x\: :ref:`float`, y\: :ref:`float`, z\: :ref:`float`\ ) |const| Returns the 3D noise value at the given position. @@ -144,7 +144,7 @@ Returns the 3D noise value at the given position. .. rst-class:: classref-method -:ref:`float` **get_noise_3dv** **(** :ref:`Vector3` v **)** |const| +:ref:`float` **get_noise_3dv**\ (\ v\: :ref:`Vector3`\ ) |const| Returns the 3D noise value at the given position. @@ -156,7 +156,7 @@ Returns the 3D noise value at the given position. .. rst-class:: classref-method -:ref:`Image` **get_seamless_image** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` invert=false, :ref:`bool` in_3d_space=false, :ref:`float` skirt=0.1, :ref:`bool` normalize=true **)** |const| +:ref:`Image` **get_seamless_image**\ (\ width\: :ref:`int`, height\: :ref:`int`, invert\: :ref:`bool` = false, in_3d_space\: :ref:`bool` = false, skirt\: :ref:`float` = 0.1, normalize\: :ref:`bool` = true\ ) |const| Returns an :ref:`Image` containing seamless 2D noise values. @@ -170,7 +170,7 @@ Returns an :ref:`Image` containing seamless 2D noise values. .. rst-class:: classref-method -:ref:`Image[]` **get_seamless_image_3d** **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`bool` invert=false, :ref:`float` skirt=0.1, :ref:`bool` normalize=true **)** |const| +:ref:`Array`\[:ref:`Image`\] **get_seamless_image_3d**\ (\ width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, invert\: :ref:`bool` = false, skirt\: :ref:`float` = 0.1, normalize\: :ref:`bool` = true\ ) |const| Returns an :ref:`Array` of :ref:`Image`\ s containing seamless 3D noise values for use with :ref:`ImageTexture3D.create`. @@ -183,3 +183,4 @@ Returns an :ref:`Array` of :ref:`Image`\ s containing .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_noisetexture2d.rst b/classes/class_noisetexture2d.rst index 9c43eb5cb2b..c9445f591b1 100644 --- a/classes/class_noisetexture2d.rst +++ b/classes/class_noisetexture2d.rst @@ -84,8 +84,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_as_normal_map** **(** :ref:`bool` value **)** -- :ref:`bool` **is_normal_map** **(** **)** +- |void| **set_as_normal_map**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_normal_map**\ (\ ) If ``true``, the resulting texture contains a normal map created from the original noise interpreted as a bump map. @@ -101,8 +101,8 @@ If ``true``, the resulting texture contains a normal map created from the origin .. rst-class:: classref-property-setget -- void **set_bump_strength** **(** :ref:`float` value **)** -- :ref:`float` **get_bump_strength** **(** **)** +- |void| **set_bump_strength**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_bump_strength**\ (\ ) Strength of the bump maps used in this texture. A higher value will make the bump maps appear larger while a lower value will make them appear softer. @@ -118,8 +118,8 @@ Strength of the bump maps used in this texture. A higher value will make the bum .. rst-class:: classref-property-setget -- void **set_color_ramp** **(** :ref:`Gradient` value **)** -- :ref:`Gradient` **get_color_ramp** **(** **)** +- |void| **set_color_ramp**\ (\ value\: :ref:`Gradient`\ ) +- :ref:`Gradient` **get_color_ramp**\ (\ ) A :ref:`Gradient` which is used to map the luminance of each pixel to a color value. @@ -135,8 +135,8 @@ A :ref:`Gradient` which is used to map the luminance of each pix .. rst-class:: classref-property-setget -- void **set_generate_mipmaps** **(** :ref:`bool` value **)** -- :ref:`bool` **is_generating_mipmaps** **(** **)** +- |void| **set_generate_mipmaps**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_generating_mipmaps**\ (\ ) Determines whether mipmaps are generated for this texture. Enabling this results in less texture aliasing in the distance, at the cost of increasing memory usage by roughly 33% and making the noise texture generation take longer. @@ -154,8 +154,8 @@ Determines whether mipmaps are generated for this texture. Enabling this results .. rst-class:: classref-property-setget -- void **set_height** **(** :ref:`int` value **)** -- :ref:`int` **get_height** **(** **)** +- |void| **set_height**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_height**\ (\ ) Height of the generated texture (in pixels). @@ -171,8 +171,8 @@ Height of the generated texture (in pixels). .. rst-class:: classref-property-setget -- void **set_in_3d_space** **(** :ref:`bool` value **)** -- :ref:`bool` **is_in_3d_space** **(** **)** +- |void| **set_in_3d_space**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_in_3d_space**\ (\ ) Determines whether the noise image is calculated in 3D space. May result in reduced contrast. @@ -188,8 +188,8 @@ Determines whether the noise image is calculated in 3D space. May result in redu .. rst-class:: classref-property-setget -- void **set_invert** **(** :ref:`bool` value **)** -- :ref:`bool` **get_invert** **(** **)** +- |void| **set_invert**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_invert**\ (\ ) If ``true``, inverts the noise texture. White becomes black, black becomes white. @@ -205,8 +205,8 @@ If ``true``, inverts the noise texture. White becomes black, black becomes white .. rst-class:: classref-property-setget -- void **set_noise** **(** :ref:`Noise` value **)** -- :ref:`Noise` **get_noise** **(** **)** +- |void| **set_noise**\ (\ value\: :ref:`Noise`\ ) +- :ref:`Noise` **get_noise**\ (\ ) The instance of the :ref:`Noise` object. @@ -222,8 +222,8 @@ The instance of the :ref:`Noise` object. .. rst-class:: classref-property-setget -- void **set_normalize** **(** :ref:`bool` value **)** -- :ref:`bool` **is_normalized** **(** **)** +- |void| **set_normalize**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_normalized**\ (\ ) If ``true``, the noise image coming from the noise generator is normalized to the range ``0.0`` to ``1.0``. @@ -241,8 +241,8 @@ Turning normalization off can affect the contrast and allows you to generate non .. rst-class:: classref-property-setget -- void **set_seamless** **(** :ref:`bool` value **)** -- :ref:`bool` **get_seamless** **(** **)** +- |void| **set_seamless**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_seamless**\ (\ ) If ``true``, a seamless texture is requested from the :ref:`Noise` resource. @@ -262,8 +262,8 @@ If ``true``, a seamless texture is requested from the :ref:`Noise` .. rst-class:: classref-property-setget -- void **set_seamless_blend_skirt** **(** :ref:`float` value **)** -- :ref:`float` **get_seamless_blend_skirt** **(** **)** +- |void| **set_seamless_blend_skirt**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_seamless_blend_skirt**\ (\ ) Used for the default/fallback implementation of the seamless texture generation. It determines the distance over which the seams are blended. High values may result in less details and contrast. See :ref:`Noise` for further details. @@ -281,8 +281,8 @@ Used for the default/fallback implementation of the seamless texture generation. .. rst-class:: classref-property-setget -- void **set_width** **(** :ref:`int` value **)** -- :ref:`int` **get_width** **(** **)** +- |void| **set_width**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_width**\ (\ ) Width of the generated texture (in pixels). @@ -293,3 +293,4 @@ Width of the generated texture (in pixels). .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_noisetexture3d.rst b/classes/class_noisetexture3d.rst index e0d128333eb..8e326be3707 100644 --- a/classes/class_noisetexture3d.rst +++ b/classes/class_noisetexture3d.rst @@ -75,8 +75,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_color_ramp** **(** :ref:`Gradient` value **)** -- :ref:`Gradient` **get_color_ramp** **(** **)** +- |void| **set_color_ramp**\ (\ value\: :ref:`Gradient`\ ) +- :ref:`Gradient` **get_color_ramp**\ (\ ) A :ref:`Gradient` which is used to map the luminance of each pixel to a color value. @@ -92,8 +92,8 @@ A :ref:`Gradient` which is used to map the luminance of each pix .. rst-class:: classref-property-setget -- void **set_depth** **(** :ref:`int` value **)** -- :ref:`int` **get_depth** **(** **)** +- |void| **set_depth**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_depth**\ (\ ) Depth of the generated texture (in pixels). @@ -109,8 +109,8 @@ Depth of the generated texture (in pixels). .. rst-class:: classref-property-setget -- void **set_height** **(** :ref:`int` value **)** -- :ref:`int` **get_height** **(** **)** +- |void| **set_height**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_height**\ (\ ) Height of the generated texture (in pixels). @@ -126,8 +126,8 @@ Height of the generated texture (in pixels). .. rst-class:: classref-property-setget -- void **set_invert** **(** :ref:`bool` value **)** -- :ref:`bool` **get_invert** **(** **)** +- |void| **set_invert**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_invert**\ (\ ) If ``true``, inverts the noise texture. White becomes black, black becomes white. @@ -143,8 +143,8 @@ If ``true``, inverts the noise texture. White becomes black, black becomes white .. rst-class:: classref-property-setget -- void **set_noise** **(** :ref:`Noise` value **)** -- :ref:`Noise` **get_noise** **(** **)** +- |void| **set_noise**\ (\ value\: :ref:`Noise`\ ) +- :ref:`Noise` **get_noise**\ (\ ) The instance of the :ref:`Noise` object. @@ -160,8 +160,8 @@ The instance of the :ref:`Noise` object. .. rst-class:: classref-property-setget -- void **set_normalize** **(** :ref:`bool` value **)** -- :ref:`bool` **is_normalized** **(** **)** +- |void| **set_normalize**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_normalized**\ (\ ) If ``true``, the noise image coming from the noise generator is normalized to the range ``0.0`` to ``1.0``. @@ -179,8 +179,8 @@ Turning normalization off can affect the contrast and allows you to generate non .. rst-class:: classref-property-setget -- void **set_seamless** **(** :ref:`bool` value **)** -- :ref:`bool` **get_seamless** **(** **)** +- |void| **set_seamless**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_seamless**\ (\ ) If ``true``, a seamless texture is requested from the :ref:`Noise` resource. @@ -200,8 +200,8 @@ If ``true``, a seamless texture is requested from the :ref:`Noise` .. rst-class:: classref-property-setget -- void **set_seamless_blend_skirt** **(** :ref:`float` value **)** -- :ref:`float` **get_seamless_blend_skirt** **(** **)** +- |void| **set_seamless_blend_skirt**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_seamless_blend_skirt**\ (\ ) Used for the default/fallback implementation of the seamless texture generation. It determines the distance over which the seams are blended. High values may result in less details and contrast. See :ref:`Noise` for further details. @@ -219,8 +219,8 @@ Used for the default/fallback implementation of the seamless texture generation. .. rst-class:: classref-property-setget -- void **set_width** **(** :ref:`int` value **)** -- :ref:`int` **get_width** **(** **)** +- |void| **set_width**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_width**\ (\ ) Width of the generated texture (in pixels). @@ -231,3 +231,4 @@ Width of the generated texture (in pixels). .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_object.rst b/classes/class_object.rst index d69c059852a..8f57efb9330 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -10,7 +10,7 @@ Object ====== -**Inherited By:** :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`DisplayServer`, :ref:`EditorFileSystemDirectory`, :ref:`EditorInterface`, :ref:`EditorPaths`, :ref:`EditorSelection`, :ref:`EditorUndoRedoManager`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`EngineDebugger`, :ref:`GDExtensionManager`, :ref:`Geometry2D`, :ref:`Geometry3D`, :ref:`GodotSharp`, :ref:`Input`, :ref:`InputMap`, :ref:`IP`, :ref:`JavaClassWrapper`, :ref:`JavaScriptBridge`, :ref:`JNISingleton`, :ref:`JSONRPC`, :ref:`MainLoop`, :ref:`Marshalls`, :ref:`MovieWriter`, :ref:`NavigationMeshGenerator`, :ref:`NavigationServer2D`, :ref:`NavigationServer3D`, :ref:`Node`, :ref:`OpenXRExtensionWrapperExtension`, :ref:`OpenXRInteractionProfileMetadata`, :ref:`OS`, :ref:`Performance`, :ref:`PhysicsDirectBodyState2D`, :ref:`PhysicsDirectBodyState3D`, :ref:`PhysicsDirectSpaceState2D`, :ref:`PhysicsDirectSpaceState3D`, :ref:`PhysicsServer2D`, :ref:`PhysicsServer2DManager`, :ref:`PhysicsServer3D`, :ref:`PhysicsServer3DManager`, :ref:`PhysicsServer3DRenderingServerHandler`, :ref:`ProjectSettings`, :ref:`RefCounted`, :ref:`RenderingDevice`, :ref:`RenderingServer`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`ResourceUID`, :ref:`ScriptLanguage`, :ref:`TextServerManager`, :ref:`ThemeDB`, :ref:`TileData`, :ref:`Time`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`WorkerThreadPool`, :ref:`XRServer` +**Inherited By:** :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`DisplayServer`, :ref:`EditorFileSystemDirectory`, :ref:`EditorInterface`, :ref:`EditorPaths`, :ref:`EditorSelection`, :ref:`EditorUndoRedoManager`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`EngineDebugger`, :ref:`FramebufferCacheRD`, :ref:`GDExtensionManager`, :ref:`Geometry2D`, :ref:`Geometry3D`, :ref:`GodotSharp`, :ref:`Input`, :ref:`InputMap`, :ref:`IP`, :ref:`JavaClassWrapper`, :ref:`JavaScriptBridge`, :ref:`JNISingleton`, :ref:`JSONRPC`, :ref:`MainLoop`, :ref:`Marshalls`, :ref:`MovieWriter`, :ref:`NavigationMeshGenerator`, :ref:`NavigationServer2D`, :ref:`NavigationServer3D`, :ref:`Node`, :ref:`OpenXRExtensionWrapperExtension`, :ref:`OpenXRInteractionProfileMetadata`, :ref:`OS`, :ref:`Performance`, :ref:`PhysicsDirectBodyState2D`, :ref:`PhysicsDirectBodyState3D`, :ref:`PhysicsDirectSpaceState2D`, :ref:`PhysicsDirectSpaceState3D`, :ref:`PhysicsServer2D`, :ref:`PhysicsServer2DManager`, :ref:`PhysicsServer3D`, :ref:`PhysicsServer3DManager`, :ref:`PhysicsServer3DRenderingServerHandler`, :ref:`ProjectSettings`, :ref:`RefCounted`, :ref:`RenderData`, :ref:`RenderingDevice`, :ref:`RenderingServer`, :ref:`RenderSceneData`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`ResourceUID`, :ref:`ScriptLanguage`, :ref:`TextServerManager`, :ref:`ThemeDB`, :ref:`TileData`, :ref:`Time`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`UniformSetCacheRD`, :ref:`WorkerThreadPool`, :ref:`XRServer` Base class for all other classes in the engine. @@ -68,115 +68,115 @@ Methods .. table:: :widths: auto - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get` **(** :ref:`StringName` property **)** |virtual| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`_get_property_list` **(** **)** |virtual| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_init` **(** **)** |virtual| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_notification` **(** :ref:`int` what **)** |virtual| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_property_can_revert` **(** :ref:`StringName` property **)** |virtual| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_property_get_revert` **(** :ref:`StringName` property **)** |virtual| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_set` **(** :ref:`StringName` property, :ref:`Variant` value **)** |virtual| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_to_string` **(** **)** |virtual| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_validate_property` **(** :ref:`Dictionary` property **)** |virtual| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=[] **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`call` **(** :ref:`StringName` method, ... **)** |vararg| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`call_deferred` **(** :ref:`StringName` method, ... **)** |vararg| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`callv` **(** :ref:`StringName` method, :ref:`Array` arg_array **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`can_translate_messages` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`cancel_free` **(** **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`connect` **(** :ref:`StringName` signal, :ref:`Callable` callable, :ref:`int` flags=0 **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`disconnect` **(** :ref:`StringName` signal, :ref:`Callable` callable **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`emit_signal` **(** :ref:`StringName` signal, ... **)** |vararg| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`free` **(** **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get` **(** :ref:`StringName` property **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_class` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`get_incoming_connections` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_indexed` **(** :ref:`NodePath` property_path **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_instance_id` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_meta` **(** :ref:`StringName` name, :ref:`Variant` default=null **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName[]` | :ref:`get_meta_list` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`get_method_list` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`get_property_list` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_script` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`get_signal_connection_list` **(** :ref:`StringName` signal **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`get_signal_list` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_meta` **(** :ref:`StringName` name **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_method` **(** :ref:`StringName` method **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_signal` **(** :ref:`StringName` signal **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_user_signal` **(** :ref:`StringName` signal **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_blocking_signals` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_class` **(** :ref:`String` class **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_connected` **(** :ref:`StringName` signal, :ref:`Callable` callable **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`notification` **(** :ref:`int` what, :ref:`bool` reversed=false **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`notify_property_list_changed` **(** **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`property_can_revert` **(** :ref:`StringName` property **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`StringName` property **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_meta` **(** :ref:`StringName` name **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set` **(** :ref:`StringName` property, :ref:`Variant` value **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_deferred` **(** :ref:`StringName` property, :ref:`Variant` value **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_indexed` **(** :ref:`NodePath` property_path, :ref:`Variant` value **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_meta` **(** :ref:`StringName` name, :ref:`Variant` value **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_script` **(** :ref:`Variant` script **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`to_string` **(** **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`tr` **(** :ref:`StringName` message, :ref:`StringName` context="" **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`tr_n` **(** :ref:`StringName` message, :ref:`StringName` plural_message, :ref:`int` n, :ref:`StringName` context="" **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get`\ (\ property\: :ref:`StringName`\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_property_list`\ (\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_init`\ (\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_notification`\ (\ what\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_property_can_revert`\ (\ property\: :ref:`StringName`\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_property_get_revert`\ (\ property\: :ref:`StringName`\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_set`\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_to_string`\ (\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_validate_property`\ (\ property\: :ref:`Dictionary`\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_user_signal`\ (\ signal\: :ref:`String`, arguments\: :ref:`Array` = []\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`call`\ (\ method\: :ref:`StringName`, ...\ ) |vararg| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`call_deferred`\ (\ method\: :ref:`StringName`, ...\ ) |vararg| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`callv`\ (\ method\: :ref:`StringName`, arg_array\: :ref:`Array`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`can_translate_messages`\ (\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cancel_free`\ (\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`connect`\ (\ signal\: :ref:`StringName`, callable\: :ref:`Callable`, flags\: :ref:`int` = 0\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`disconnect`\ (\ signal\: :ref:`StringName`, callable\: :ref:`Callable`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`emit_signal`\ (\ signal\: :ref:`StringName`, ...\ ) |vararg| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`free`\ (\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get`\ (\ property\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_class`\ (\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_incoming_connections`\ (\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_indexed`\ (\ property_path\: :ref:`NodePath`\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_instance_id`\ (\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_meta`\ (\ name\: :ref:`StringName`, default\: :ref:`Variant` = null\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`StringName`\] | :ref:`get_meta_list`\ (\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_method_list`\ (\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_property_list`\ (\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_script`\ (\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_signal_connection_list`\ (\ signal\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_signal_list`\ (\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_meta`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_method`\ (\ method\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_signal`\ (\ signal\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_user_signal`\ (\ signal\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_blocking_signals`\ (\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_class`\ (\ class\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_connected`\ (\ signal\: :ref:`StringName`, callable\: :ref:`Callable`\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_queued_for_deletion`\ (\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`notification`\ (\ what\: :ref:`int`, reversed\: :ref:`bool` = false\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`notify_property_list_changed`\ (\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`property_can_revert`\ (\ property\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`property_get_revert`\ (\ property\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_meta`\ (\ name\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_block_signals`\ (\ enable\: :ref:`bool`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_deferred`\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_indexed`\ (\ property_path\: :ref:`NodePath`, value\: :ref:`Variant`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_message_translation`\ (\ enable\: :ref:`bool`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_meta`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_script`\ (\ script\: :ref:`Variant`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`to_string`\ (\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`tr`\ (\ message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`tr_n`\ (\ message\: :ref:`StringName`, plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -191,7 +191,7 @@ Signals .. rst-class:: classref-signal -**property_list_changed** **(** **)** +**property_list_changed**\ (\ ) Emitted when :ref:`notify_property_list_changed` is called. @@ -203,7 +203,7 @@ Emitted when :ref:`notify_property_list_changed` **_get** **(** :ref:`StringName` property **)** |virtual| +:ref:`Variant` **_get**\ (\ property\: :ref:`StringName`\ ) |virtual| Override this method to customize the behavior of :ref:`get`. Should return the given ``property``'s value, or ``null`` if the ``property`` should be handled normally. @@ -357,7 +357,7 @@ Combined with :ref:`_set` and :ref:`_get_prope .. rst-class:: classref-method -:ref:`Dictionary[]` **_get_property_list** **(** **)** |virtual| +:ref:`Array`\[:ref:`Dictionary`\] **_get_property_list**\ (\ ) |virtual| Override this method to provide a custom list of additional properties to handle by the engine. @@ -485,7 +485,7 @@ The example below displays a list of numbers shown as words going from ``ZERO`` .. rst-class:: classref-method -void **_init** **(** **)** |virtual| +|void| **_init**\ (\ ) |virtual| Called when the object's script is instantiated, oftentimes after the object is initialized in memory (through ``Object.new()`` in GDScript, or ``new GodotObject`` in C#). It can be also defined to take in parameters. This method is similar to a constructor in most programming languages. @@ -499,7 +499,7 @@ Called when the object's script is instantiated, oftentimes after the object is .. rst-class:: classref-method -void **_notification** **(** :ref:`int` what **)** |virtual| +|void| **_notification**\ (\ what\: :ref:`int`\ ) |virtual| Called when the object receives a notification, which can be identified in ``what`` by comparing it with a constant. See also :ref:`notification`. @@ -534,9 +534,9 @@ Called when the object receives a notification, which can be identified in ``wha .. rst-class:: classref-method -:ref:`bool` **_property_can_revert** **(** :ref:`StringName` property **)** |virtual| +:ref:`bool` **_property_can_revert**\ (\ property\: :ref:`StringName`\ ) |virtual| -Override this method to customize the given ``property``'s revert behavior. Should return ``true`` if the ``property`` can be reverted in the Inspector dock. Use :ref:`_property_get_revert` to specify the ``property``'s default value. +Override this method to customize the given ``property``'s revert behavior. Should return ``true`` if the ``property`` has a custom default value and is revertible in the Inspector dock. Use :ref:`_property_get_revert` to specify the ``property``'s default value. \ **Note:** This method must return consistently, regardless of the current value of the ``property``. @@ -548,7 +548,7 @@ Override this method to customize the given ``property``'s revert behavior. Shou .. rst-class:: classref-method -:ref:`Variant` **_property_get_revert** **(** :ref:`StringName` property **)** |virtual| +:ref:`Variant` **_property_get_revert**\ (\ property\: :ref:`StringName`\ ) |virtual| Override this method to customize the given ``property``'s revert behavior. Should return the default value for the ``property``. If the default value differs from the ``property``'s current value, a revert icon is displayed in the Inspector dock. @@ -562,7 +562,7 @@ Override this method to customize the given ``property``'s revert behavior. Shou .. rst-class:: classref-method -:ref:`bool` **_set** **(** :ref:`StringName` property, :ref:`Variant` value **)** |virtual| +:ref:`bool` **_set**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| Override this method to customize the behavior of :ref:`set`. Should set the ``property`` to ``value`` and return ``true``, or ``false`` if the ``property`` should be handled normally. The *exact* way to set the ``property`` is up to this method's implementation. @@ -625,7 +625,7 @@ Combined with :ref:`_get` and :ref:`_get_prope .. rst-class:: classref-method -:ref:`String` **_to_string** **(** **)** |virtual| +:ref:`String` **_to_string**\ (\ ) |virtual| Override this method to customize the return value of :ref:`to_string`, and therefore the object's representation as a :ref:`String`. @@ -646,7 +646,7 @@ Override this method to customize the return value of :ref:`to_string` property **)** |virtual| +|void| **_validate_property**\ (\ property\: :ref:`Dictionary`\ ) |virtual| Override this method to customize existing properties. Every property info goes through this method, except properties added with :ref:`_get_property_list`. The dictionary contents is the same as in :ref:`_get_property_list`. @@ -709,7 +709,7 @@ Override this method to customize existing properties. Every property info goes .. rst-class:: classref-method -void **add_user_signal** **(** :ref:`String` signal, :ref:`Array` arguments=[] **)** +|void| **add_user_signal**\ (\ signal\: :ref:`String`, arguments\: :ref:`Array` = []\ ) Adds a user-defined ``signal``. Optional arguments for the signal can be added as an :ref:`Array` of dictionaries, each defining a ``name`` :ref:`String` and a ``type`` :ref:`int` (see :ref:`Variant.Type`). See also :ref:`has_user_signal`. @@ -749,7 +749,7 @@ Adds a user-defined ``signal``. Optional arguments for the signal can be added a .. rst-class:: classref-method -:ref:`Variant` **call** **(** :ref:`StringName` method, ... **)** |vararg| +:ref:`Variant` **call**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| Calls the ``method`` on the object and returns the result. This method supports a variable number of arguments, so parameters can be passed as a comma separated list. @@ -778,7 +778,7 @@ Calls the ``method`` on the object and returns the result. This method supports .. rst-class:: classref-method -:ref:`Variant` **call_deferred** **(** :ref:`StringName` method, ... **)** |vararg| +:ref:`Variant` **call_deferred**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| Calls the ``method`` on the object during idle time. Always returns null, **not** the method's result. @@ -824,7 +824,7 @@ See also :ref:`Callable.call_deferred`. .. rst-class:: classref-method -:ref:`Variant` **callv** **(** :ref:`StringName` method, :ref:`Array` arg_array **)** +:ref:`Variant` **callv**\ (\ method\: :ref:`StringName`, arg_array\: :ref:`Array`\ ) Calls the ``method`` on the object and returns the result. Unlike :ref:`call`, this method expects all parameters to be contained inside ``arg_array``. @@ -853,7 +853,7 @@ Calls the ``method`` on the object and returns the result. Unlike :ref:`call` **can_translate_messages** **(** **)** |const| +:ref:`bool` **can_translate_messages**\ (\ ) |const| Returns ``true`` if the object is allowed to translate messages with :ref:`tr` and :ref:`tr_n`. See also :ref:`set_message_translation`. @@ -865,7 +865,7 @@ Returns ``true`` if the object is allowed to translate messages with :ref:`tr`, this object will reject being freed and will remain allocated. This is mostly an internal function used for error handling to avoid the user from freeing objects when they are not intended to. @@ -877,7 +877,7 @@ If this method is called during :ref:`NOTIFICATION_PREDELETE` **connect** **(** :ref:`StringName` signal, :ref:`Callable` callable, :ref:`int` flags=0 **)** +:ref:`Error` **connect**\ (\ signal\: :ref:`StringName`, callable\: :ref:`Callable`, flags\: :ref:`int` = 0\ ) Connects a ``signal`` by name to a ``callable``. Optional ``flags`` can be also added to configure the connection's behavior (see :ref:`ConnectFlags` constants). @@ -1039,7 +1039,7 @@ When calling :ref:`emit_signal`, the signal par .. rst-class:: classref-method -void **disconnect** **(** :ref:`StringName` signal, :ref:`Callable` callable **)** +|void| **disconnect**\ (\ signal\: :ref:`StringName`, callable\: :ref:`Callable`\ ) Disconnects a ``signal`` by name from a given ``callable``. If the connection does not exist, generates an error. Use :ref:`is_connected` to make sure that the connection exists. @@ -1051,7 +1051,7 @@ Disconnects a ``signal`` by name from a given ``callable``. If the connection do .. rst-class:: classref-method -:ref:`Error` **emit_signal** **(** :ref:`StringName` signal, ... **)** |vararg| +:ref:`Error` **emit_signal**\ (\ signal\: :ref:`StringName`, ...\ ) |vararg| Emits the given ``signal`` by name. The signal must exist, so it should be a built-in signal of this class or one of its inherited classes, or a user-defined signal (see :ref:`add_user_signal`). This method supports a variable number of arguments, so parameters can be passed as a comma separated list. @@ -1082,7 +1082,7 @@ Returns :ref:`@GlobalScope.ERR_UNAVAILABLE` will return ``false``. @@ -1094,7 +1094,7 @@ Deletes the object from memory. Pre-existing references to the object become inv .. rst-class:: classref-method -:ref:`Variant` **get** **(** :ref:`StringName` property **)** |const| +:ref:`Variant` **get**\ (\ property\: :ref:`StringName`\ ) |const| Returns the :ref:`Variant` value of the given ``property``. If the ``property`` does not exist, this method returns ``null``. @@ -1125,7 +1125,7 @@ Returns the :ref:`Variant` value of the given ``property``. If th .. rst-class:: classref-method -:ref:`String` **get_class** **(** **)** |const| +:ref:`String` **get_class**\ (\ ) |const| Returns the object's built-in class name, as a :ref:`String`. See also :ref:`is_class`. @@ -1139,7 +1139,7 @@ Returns the object's built-in class name, as a :ref:`String`. See .. rst-class:: classref-method -:ref:`Dictionary[]` **get_incoming_connections** **(** **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_incoming_connections**\ (\ ) |const| Returns an :ref:`Array` of signal connections received by this object. Each connection is represented as a :ref:`Dictionary` that contains three entries: @@ -1157,7 +1157,7 @@ Returns an :ref:`Array` of signal connections received by this obje .. rst-class:: classref-method -:ref:`Variant` **get_indexed** **(** :ref:`NodePath` property_path **)** |const| +:ref:`Variant` **get_indexed**\ (\ property_path\: :ref:`NodePath`\ ) |const| Gets the object's property indexed by the given ``property_path``. The path should be a :ref:`NodePath` relative to the current object and can use the colon character (``:``) to access nested properties. @@ -1194,7 +1194,7 @@ Gets the object's property indexed by the given ``property_path``. The path shou .. rst-class:: classref-method -:ref:`int` **get_instance_id** **(** **)** |const| +:ref:`int` **get_instance_id**\ (\ ) |const| Returns the object's unique instance ID. This ID can be saved in :ref:`EncodedObjectAsID`, and can be used to retrieve this object instance with :ref:`@GlobalScope.instance_from_id`. @@ -1206,7 +1206,7 @@ Returns the object's unique instance ID. This ID can be saved in :ref:`EncodedOb .. rst-class:: classref-method -:ref:`Variant` **get_meta** **(** :ref:`StringName` name, :ref:`Variant` default=null **)** |const| +:ref:`Variant` **get_meta**\ (\ name\: :ref:`StringName`, default\: :ref:`Variant` = null\ ) |const| Returns the object's metadata value for the given entry ``name``. If the entry does not exist, returns ``default``. If ``default`` is ``null``, an error is also generated. @@ -1222,7 +1222,7 @@ Returns the object's metadata value for the given entry ``name``. If the entry d .. rst-class:: classref-method -:ref:`StringName[]` **get_meta_list** **(** **)** |const| +:ref:`Array`\[:ref:`StringName`\] **get_meta_list**\ (\ ) |const| Returns the object's metadata entry names as a :ref:`PackedStringArray`. @@ -1234,7 +1234,7 @@ Returns the object's metadata entry names as a :ref:`PackedStringArray` **get_method_list** **(** **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_method_list**\ (\ ) |const| Returns this object's methods and their signatures as an :ref:`Array` of dictionaries. Each :ref:`Dictionary` contains the following entries: @@ -1260,7 +1260,7 @@ Returns this object's methods and their signatures as an :ref:`Array` **get_property_list** **(** **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_property_list**\ (\ ) |const| Returns the object's property list as an :ref:`Array` of dictionaries. Each :ref:`Dictionary` contains the following entries: @@ -1286,7 +1286,7 @@ Returns the object's property list as an :ref:`Array` of dictionari .. rst-class:: classref-method -:ref:`Variant` **get_script** **(** **)** |const| +:ref:`Variant` **get_script**\ (\ ) |const| Returns the object's :ref:`Script` instance, or ``null`` if no script is attached. @@ -1298,7 +1298,7 @@ Returns the object's :ref:`Script` instance, or ``null`` if no scr .. rst-class:: classref-method -:ref:`Dictionary[]` **get_signal_connection_list** **(** :ref:`StringName` signal **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_signal_connection_list**\ (\ signal\: :ref:`StringName`\ ) |const| Returns an :ref:`Array` of connections for the given ``signal`` name. Each connection is represented as a :ref:`Dictionary` that contains three entries: @@ -1316,7 +1316,7 @@ Returns an :ref:`Array` of connections for the given ``signal`` nam .. rst-class:: classref-method -:ref:`Dictionary[]` **get_signal_list** **(** **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_signal_list**\ (\ ) |const| Returns the list of existing signals as an :ref:`Array` of dictionaries. @@ -1330,7 +1330,7 @@ Returns the list of existing signals as an :ref:`Array` of dictiona .. rst-class:: classref-method -:ref:`bool` **has_meta** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_meta**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if a metadata entry is found with the given ``name``. See also :ref:`get_meta`, :ref:`set_meta` and :ref:`remove_meta`. @@ -1346,7 +1346,7 @@ Returns ``true`` if a metadata entry is found with the given ``name``. See also .. rst-class:: classref-method -:ref:`bool` **has_method** **(** :ref:`StringName` method **)** |const| +:ref:`bool` **has_method**\ (\ method\: :ref:`StringName`\ ) |const| Returns ``true`` if the given ``method`` name exists in the object. @@ -1360,7 +1360,7 @@ Returns ``true`` if the given ``method`` name exists in the object. .. rst-class:: classref-method -:ref:`bool` **has_signal** **(** :ref:`StringName` signal **)** |const| +:ref:`bool` **has_signal**\ (\ signal\: :ref:`StringName`\ ) |const| Returns ``true`` if the given ``signal`` name exists in the object. @@ -1374,7 +1374,7 @@ Returns ``true`` if the given ``signal`` name exists in the object. .. rst-class:: classref-method -:ref:`bool` **has_user_signal** **(** :ref:`StringName` signal **)** |const| +:ref:`bool` **has_user_signal**\ (\ signal\: :ref:`StringName`\ ) |const| Returns ``true`` if the given user-defined ``signal`` name exists. Only signals added with :ref:`add_user_signal` are included. @@ -1386,7 +1386,7 @@ Returns ``true`` if the given user-defined ``signal`` name exists. Only signals .. rst-class:: classref-method -:ref:`bool` **is_blocking_signals** **(** **)** |const| +:ref:`bool` **is_blocking_signals**\ (\ ) |const| Returns ``true`` if the object is blocking its signals from being emitted. See :ref:`set_block_signals`. @@ -1398,7 +1398,7 @@ Returns ``true`` if the object is blocking its signals from being emitted. See : .. rst-class:: classref-method -:ref:`bool` **is_class** **(** :ref:`String` class **)** |const| +:ref:`bool` **is_class**\ (\ class\: :ref:`String`\ ) |const| Returns ``true`` if the object inherits from the given ``class``. See also :ref:`get_class`. @@ -1431,7 +1431,7 @@ Returns ``true`` if the object inherits from the given ``class``. See also :ref: .. rst-class:: classref-method -:ref:`bool` **is_connected** **(** :ref:`StringName` signal, :ref:`Callable` callable **)** |const| +:ref:`bool` **is_connected**\ (\ signal\: :ref:`StringName`, callable\: :ref:`Callable`\ ) |const| Returns ``true`` if a connection exists between the given ``signal`` name and ``callable``. @@ -1445,7 +1445,7 @@ Returns ``true`` if a connection exists between the given ``signal`` name and `` .. rst-class:: classref-method -:ref:`bool` **is_queued_for_deletion** **(** **)** |const| +:ref:`bool` **is_queued_for_deletion**\ (\ ) |const| Returns ``true`` if the :ref:`Node.queue_free` method was called for the object. @@ -1457,7 +1457,7 @@ Returns ``true`` if the :ref:`Node.queue_free` met .. rst-class:: classref-method -void **notification** **(** :ref:`int` what, :ref:`bool` reversed=false **)** +|void| **notification**\ (\ what\: :ref:`int`, reversed\: :ref:`bool` = false\ ) Sends the given ``what`` notification to all classes inherited by the object, triggering calls to :ref:`_notification`, starting from the highest ancestor (the **Object** class) and going down to the object's script. @@ -1498,7 +1498,7 @@ If ``reversed`` is ``true``, the call order is reversed. .. rst-class:: classref-method -void **notify_property_list_changed** **(** **)** +|void| **notify_property_list_changed**\ (\ ) Emits the :ref:`property_list_changed` signal. This is mainly used to refresh the editor, so that the Inspector and editor plugins are properly updated. @@ -1510,7 +1510,7 @@ Emits the :ref:`property_list_changed .. rst-class:: classref-method -:ref:`bool` **property_can_revert** **(** :ref:`StringName` property **)** |const| +:ref:`bool` **property_can_revert**\ (\ property\: :ref:`StringName`\ ) |const| Returns ``true`` if the given ``property`` has a custom default value. Use :ref:`property_get_revert` to get the ``property``'s default value. @@ -1524,7 +1524,7 @@ Returns ``true`` if the given ``property`` has a custom default value. Use :ref: .. rst-class:: classref-method -:ref:`Variant` **property_get_revert** **(** :ref:`StringName` property **)** |const| +:ref:`Variant` **property_get_revert**\ (\ property\: :ref:`StringName`\ ) |const| Returns the custom default value of the given ``property``. Use :ref:`property_can_revert` to check if the ``property`` has a custom default value. @@ -1538,7 +1538,7 @@ Returns the custom default value of the given ``property``. Use :ref:`property_c .. rst-class:: classref-method -void **remove_meta** **(** :ref:`StringName` name **)** +|void| **remove_meta**\ (\ name\: :ref:`StringName`\ ) Removes the given entry ``name`` from the object's metadata. See also :ref:`has_meta`, :ref:`get_meta` and :ref:`set_meta`. @@ -1554,7 +1554,7 @@ Removes the given entry ``name`` from the object's metadata. See also :ref:`has_ .. rst-class:: classref-method -void **set** **(** :ref:`StringName` property, :ref:`Variant` value **)** +|void| **set**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) Assigns ``value`` to the given ``property``. If the property does not exist or the given ``value``'s type doesn't match, nothing happens. @@ -1585,7 +1585,7 @@ Assigns ``value`` to the given ``property``. If the property does not exist or t .. rst-class:: classref-method -void **set_block_signals** **(** :ref:`bool` enable **)** +|void| **set_block_signals**\ (\ enable\: :ref:`bool`\ ) If set to ``true``, the object becomes unable to emit signals. As such, :ref:`emit_signal` and signal connections will not work, until it is set to ``false``. @@ -1597,7 +1597,7 @@ If set to ``true``, the object becomes unable to emit signals. As such, :ref:`em .. rst-class:: classref-method -void **set_deferred** **(** :ref:`StringName` property, :ref:`Variant` value **)** +|void| **set_deferred**\ (\ property\: :ref:`StringName`, value\: :ref:`Variant`\ ) Assigns ``value`` to the given ``property``, at the end of the current frame. This is equivalent to calling :ref:`set` through :ref:`call_deferred`. @@ -1638,7 +1638,7 @@ Assigns ``value`` to the given ``property``, at the end of the current frame. Th .. rst-class:: classref-method -void **set_indexed** **(** :ref:`NodePath` property_path, :ref:`Variant` value **)** +|void| **set_indexed**\ (\ property_path\: :ref:`NodePath`, value\: :ref:`Variant`\ ) Assigns a new ``value`` to the property identified by the ``property_path``. The path should be a :ref:`NodePath` relative to this object, and can use the colon character (``:``) to access nested properties. @@ -1671,7 +1671,7 @@ Assigns a new ``value`` to the property identified by the ``property_path``. The .. rst-class:: classref-method -void **set_message_translation** **(** :ref:`bool` enable **)** +|void| **set_message_translation**\ (\ enable\: :ref:`bool`\ ) If set to ``true``, allows the object to translate messages with :ref:`tr` and :ref:`tr_n`. Enabled by default. See also :ref:`can_translate_messages`. @@ -1683,7 +1683,7 @@ If set to ``true``, allows the object to translate messages with :ref:`tr` name, :ref:`Variant` value **)** +|void| **set_meta**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) Adds or changes the entry ``name`` inside the object's metadata. The metadata ``value`` can be any :ref:`Variant`, although some types cannot be serialized correctly. @@ -1701,7 +1701,7 @@ If ``value`` is ``null``, the entry is removed. This is the equivalent of using .. rst-class:: classref-method -void **set_script** **(** :ref:`Variant` script **)** +|void| **set_script**\ (\ script\: :ref:`Variant`\ ) Attaches ``script`` to the object, and instantiates it. As a result, the script's :ref:`_init` is called. A :ref:`Script` is used to extend the object's functionality. @@ -1715,7 +1715,7 @@ If a script already exists, its instance is detached, and its property values an .. rst-class:: classref-method -:ref:`String` **to_string** **(** **)** +:ref:`String` **to_string**\ (\ ) Returns a :ref:`String` representing the object. Defaults to ``""``. Override :ref:`_to_string` to customize the string representation of the object. @@ -1727,7 +1727,7 @@ Returns a :ref:`String` representing the object. Defaults to ``"` **tr** **(** :ref:`StringName` message, :ref:`StringName` context="" **)** |const| +:ref:`String` **tr**\ (\ message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| Translates a ``message``, using the translation catalogs configured in the Project Settings. Further ``context`` can be specified to help with the translation. @@ -1743,7 +1743,7 @@ For detailed examples, see :doc:`Internationalizing games <../tutorials/i18n/int .. rst-class:: classref-method -:ref:`String` **tr_n** **(** :ref:`StringName` message, :ref:`StringName` plural_message, :ref:`int` n, :ref:`StringName` context="" **)** |const| +:ref:`String` **tr_n**\ (\ message\: :ref:`StringName`, plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| Translates a ``message`` or ``plural_message``, using the translation catalogs configured in the Project Settings. Further ``context`` can be specified to help with the translation. @@ -1753,7 +1753,7 @@ The ``n`` is the number, or amount, of the message's subject. It is used by the For detailed examples, see :doc:`Localization using gettext <../tutorials/i18n/localization_using_gettext>`. -\ **Note:** Negative and :ref:`float` numbers may not properly apply to some countable subjects. It's recommended handling these cases with :ref:`tr`. +\ **Note:** Negative and :ref:`float` numbers may not properly apply to some countable subjects. It's recommended to handle these cases with :ref:`tr`. .. |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.)` @@ -1762,3 +1762,4 @@ For detailed examples, see :doc:`Localization using gettext <../tutorials/i18n/l .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_occluder3d.rst b/classes/class_occluder3d.rst index 1a38021adbb..26e36199c6f 100644 --- a/classes/class_occluder3d.rst +++ b/classes/class_occluder3d.rst @@ -40,11 +40,11 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_indices` **(** **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`get_vertices` **(** **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------+ + +-----------------------------------------------------+-------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_indices`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`get_vertices`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -59,7 +59,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_indices** **(** **)** |const| +:ref:`PackedInt32Array` **get_indices**\ (\ ) |const| Returns the occluder shape's vertex indices. @@ -71,7 +71,7 @@ Returns the occluder shape's vertex indices. .. rst-class:: classref-method -:ref:`PackedVector3Array` **get_vertices** **(** **)** |const| +:ref:`PackedVector3Array` **get_vertices**\ (\ ) |const| Returns the occluder shape's vertex positions. @@ -82,3 +82,4 @@ Returns the occluder shape's vertex positions. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_occluderinstance3d.rst b/classes/class_occluderinstance3d.rst index d8323a2041e..b1380983f45 100644 --- a/classes/class_occluderinstance3d.rst +++ b/classes/class_occluderinstance3d.rst @@ -62,11 +62,11 @@ Methods .. table:: :widths: auto - +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_bake_mask_value` **(** :ref:`int` layer_number **)** |const| | - +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bake_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_bake_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bake_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -85,8 +85,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bake_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_bake_mask** **(** **)** +- |void| **set_bake_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_bake_mask**\ (\ ) The visual layers to account for when baking for occluders. Only :ref:`MeshInstance3D`\ s whose :ref:`VisualInstance3D.layers` match with this :ref:`bake_mask` will be included in the generated occluder mesh. By default, all objects with *opaque* materials are taken into account for the occluder baking. @@ -104,8 +104,8 @@ To improve performance and avoid artifacts, it is recommended to exclude dynamic .. rst-class:: classref-property-setget -- void **set_bake_simplification_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_bake_simplification_distance** **(** **)** +- |void| **set_bake_simplification_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_bake_simplification_distance**\ (\ ) The simplification distance to use for simplifying the generated occluder polygon (in 3D units). Higher values result in a less detailed occluder mesh, which improves performance but reduces culling accuracy. @@ -127,8 +127,8 @@ Setting this to ``0.0`` disables simplification entirely, but vertices in the ex .. rst-class:: classref-property-setget -- void **set_occluder** **(** :ref:`Occluder3D` value **)** -- :ref:`Occluder3D` **get_occluder** **(** **)** +- |void| **set_occluder**\ (\ value\: :ref:`Occluder3D`\ ) +- :ref:`Occluder3D` **get_occluder**\ (\ ) The occluder resource for this **OccluderInstance3D**. You can generate an occluder resource by selecting an **OccluderInstance3D** node then using the **Bake Occluders** button at the top of the editor. @@ -149,7 +149,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **get_bake_mask_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_bake_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`bake_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -161,7 +161,7 @@ Returns whether or not the specified layer of the :ref:`bake_mask` layer_number, :ref:`bool` value **)** +|void| **set_bake_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`bake_mask`, given a ``layer_number`` between 1 and 32. @@ -172,3 +172,4 @@ Based on ``value``, enables or disables the specified layer in the :ref:`bake_ma .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index cf390932c8a..0784c6893e8 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -93,8 +93,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_closed** **(** :ref:`bool` value **)** -- :ref:`bool` **is_closed** **(** **)** +- |void| **set_closed**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_closed**\ (\ ) If ``true``, closes the polygon. A closed OccluderPolygon2D occludes the light coming from any direction. An opened OccluderPolygon2D occludes the light only at its outline's direction. @@ -110,8 +110,8 @@ If ``true``, closes the polygon. A closed OccluderPolygon2D occludes the light c .. rst-class:: classref-property-setget -- void **set_cull_mode** **(** :ref:`CullMode` value **)** -- :ref:`CullMode` **get_cull_mode** **(** **)** +- |void| **set_cull_mode**\ (\ value\: :ref:`CullMode`\ ) +- :ref:`CullMode` **get_cull_mode**\ (\ ) The culling mode to use. @@ -127,8 +127,8 @@ The culling mode to use. .. rst-class:: classref-property-setget -- void **set_polygon** **(** :ref:`PackedVector2Array` value **)** -- :ref:`PackedVector2Array` **get_polygon** **(** **)** +- |void| **set_polygon**\ (\ value\: :ref:`PackedVector2Array`\ ) +- :ref:`PackedVector2Array` **get_polygon**\ (\ ) A :ref:`Vector2` array with the index for polygon's vertices positions. @@ -141,3 +141,4 @@ A :ref:`Vector2` array with the index for polygon's vertices posi .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_offlinemultiplayerpeer.rst b/classes/class_offlinemultiplayerpeer.rst index 1aa7b2c72ec..10ceec7ae58 100644 --- a/classes/class_offlinemultiplayerpeer.rst +++ b/classes/class_offlinemultiplayerpeer.rst @@ -30,3 +30,4 @@ This means that the :ref:`SceneTree` will act as the multiplaye .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_oggpacketsequence.rst b/classes/class_oggpacketsequence.rst index 0daafa57530..7a8f1cec8b1 100644 --- a/classes/class_oggpacketsequence.rst +++ b/classes/class_oggpacketsequence.rst @@ -29,13 +29,13 @@ Properties .. table:: :widths: auto - +-------------------------------------------------+------------------------------------------------------------------------------+------------------------+ - | :ref:`PackedInt64Array` | :ref:`granule_positions` | ``PackedInt64Array()`` | - +-------------------------------------------------+------------------------------------------------------------------------------+------------------------+ - | :ref:`Array[]` | :ref:`packet_data` | ``[]`` | - +-------------------------------------------------+------------------------------------------------------------------------------+------------------------+ - | :ref:`float` | :ref:`sampling_rate` | ``0.0`` | - +-------------------------------------------------+------------------------------------------------------------------------------+------------------------+ + +--------------------------------------------------------+------------------------------------------------------------------------------+------------------------+ + | :ref:`PackedInt64Array` | :ref:`granule_positions` | ``PackedInt64Array()`` | + +--------------------------------------------------------+------------------------------------------------------------------------------+------------------------+ + | :ref:`Array`\[:ref:`Array`\] | :ref:`packet_data` | ``[]`` | + +--------------------------------------------------------+------------------------------------------------------------------------------+------------------------+ + | :ref:`float` | :ref:`sampling_rate` | ``0.0`` | + +--------------------------------------------------------+------------------------------------------------------------------------------+------------------------+ .. rst-class:: classref-reftable-group @@ -45,9 +45,9 @@ Methods .. table:: :widths: auto - +---------------------------+----------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_length` **(** **)** |const| | - +---------------------------+----------------------------------------------------------------------------------+ + +---------------------------+----------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_length`\ (\ ) |const| | + +---------------------------+----------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -66,8 +66,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_packet_granule_positions** **(** :ref:`PackedInt64Array` value **)** -- :ref:`PackedInt64Array` **get_packet_granule_positions** **(** **)** +- |void| **set_packet_granule_positions**\ (\ value\: :ref:`PackedInt64Array`\ ) +- :ref:`PackedInt64Array` **get_packet_granule_positions**\ (\ ) Contains the granule positions for each page in this packet sequence. @@ -79,12 +79,12 @@ Contains the granule positions for each page in this packet sequence. .. rst-class:: classref-property -:ref:`Array[]` **packet_data** = ``[]`` +:ref:`Array`\[:ref:`Array`\] **packet_data** = ``[]`` .. rst-class:: classref-property-setget -- void **set_packet_data** **(** :ref:`Array[]` value **)** -- :ref:`Array[]` **get_packet_data** **(** **)** +- |void| **set_packet_data**\ (\ value\: :ref:`Array`\[:ref:`Array`\]\ ) +- :ref:`Array`\[:ref:`Array`\] **get_packet_data**\ (\ ) Contains the raw packets that make up this OggPacketSequence. @@ -100,8 +100,8 @@ Contains the raw packets that make up this OggPacketSequence. .. rst-class:: classref-property-setget -- void **set_sampling_rate** **(** :ref:`float` value **)** -- :ref:`float` **get_sampling_rate** **(** **)** +- |void| **set_sampling_rate**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_sampling_rate**\ (\ ) Holds sample rate information about this sequence. Must be set by another class that actually understands the codec. @@ -118,7 +118,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_length** **(** **)** |const| +:ref:`float` **get_length**\ (\ ) |const| The length of this stream, in seconds. @@ -129,3 +129,4 @@ The length of this stream, in seconds. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_oggpacketsequenceplayback.rst b/classes/class_oggpacketsequenceplayback.rst index 2c8b750f537..d974f7256c5 100644 --- a/classes/class_oggpacketsequenceplayback.rst +++ b/classes/class_oggpacketsequenceplayback.rst @@ -23,3 +23,4 @@ OggPacketSequencePlayback .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_omnilight3d.rst b/classes/class_omnilight3d.rst index 0881362407e..080c50489a5 100644 --- a/classes/class_omnilight3d.rst +++ b/classes/class_omnilight3d.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: point + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -100,8 +103,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`float` value **)** -- :ref:`float` **get_param** **(** **)** +- |void| **set_param**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ ) Controls the distance attenuation function for omnilights. @@ -123,8 +126,8 @@ A value of ``0.0`` smoothly attenuates light at the edge of the range. A value o .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`float` value **)** -- :ref:`float` **get_param** **(** **)** +- |void| **set_param**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ ) The light's radius. Note that the effectively lit area may appear to be smaller depending on the :ref:`omni_attenuation` in use. No matter the :ref:`omni_attenuation` in use, the light will never reach anything outside this radius. @@ -142,8 +145,8 @@ The light's radius. Note that the effectively lit area may appear to be smaller .. rst-class:: classref-property-setget -- void **set_shadow_mode** **(** :ref:`ShadowMode` value **)** -- :ref:`ShadowMode` **get_shadow_mode** **(** **)** +- |void| **set_shadow_mode**\ (\ value\: :ref:`ShadowMode`\ ) +- :ref:`ShadowMode` **get_shadow_mode**\ (\ ) See :ref:`ShadowMode`. @@ -154,3 +157,4 @@ See :ref:`ShadowMode`. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_openxraction.rst b/classes/class_openxraction.rst index 4f4d6add2b2..f84d8616293 100644 --- a/classes/class_openxraction.rst +++ b/classes/class_openxraction.rst @@ -111,8 +111,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_action_type** **(** :ref:`ActionType` value **)** -- :ref:`ActionType` **get_action_type** **(** **)** +- |void| **set_action_type**\ (\ value\: :ref:`ActionType`\ ) +- :ref:`ActionType` **get_action_type**\ (\ ) The type of action. @@ -128,8 +128,8 @@ The type of action. .. rst-class:: classref-property-setget -- void **set_localized_name** **(** :ref:`String` value **)** -- :ref:`String` **get_localized_name** **(** **)** +- |void| **set_localized_name**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_localized_name**\ (\ ) The localized description of this action. @@ -145,8 +145,8 @@ The localized description of this action. .. rst-class:: classref-property-setget -- void **set_toplevel_paths** **(** :ref:`PackedStringArray` value **)** -- :ref:`PackedStringArray` **get_toplevel_paths** **(** **)** +- |void| **set_toplevel_paths**\ (\ value\: :ref:`PackedStringArray`\ ) +- :ref:`PackedStringArray` **get_toplevel_paths**\ (\ ) A collections of toplevel paths to which this action can be bound. @@ -157,3 +157,4 @@ A collections of toplevel paths to which this action can be bound. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_openxractionmap.rst b/classes/class_openxractionmap.rst index 94d3b968e3c..26e6827243a 100644 --- a/classes/class_openxractionmap.rst +++ b/classes/class_openxractionmap.rst @@ -47,29 +47,29 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_action_set` **(** :ref:`OpenXRActionSet` action_set **)** | - +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_interaction_profile` **(** :ref:`OpenXRInteractionProfile` interaction_profile **)** | - +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_default_action_sets` **(** **)** | - +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`OpenXRActionSet` | :ref:`find_action_set` **(** :ref:`String` name **)** |const| | - +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`OpenXRInteractionProfile` | :ref:`find_interaction_profile` **(** :ref:`String` name **)** |const| | - +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`OpenXRActionSet` | :ref:`get_action_set` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_action_set_count` **(** **)** |const| | - +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`OpenXRInteractionProfile` | :ref:`get_interaction_profile` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_interaction_profile_count` **(** **)** |const| | - +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_action_set` **(** :ref:`OpenXRActionSet` action_set **)** | - +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_interaction_profile` **(** :ref:`OpenXRInteractionProfile` interaction_profile **)** | - +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_action_set`\ (\ action_set\: :ref:`OpenXRActionSet`\ ) | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_interaction_profile`\ (\ interaction_profile\: :ref:`OpenXRInteractionProfile`\ ) | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_default_action_sets`\ (\ ) | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`OpenXRActionSet` | :ref:`find_action_set`\ (\ name\: :ref:`String`\ ) |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`OpenXRInteractionProfile` | :ref:`find_interaction_profile`\ (\ name\: :ref:`String`\ ) |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`OpenXRActionSet` | :ref:`get_action_set`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_action_set_count`\ (\ ) |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`OpenXRInteractionProfile` | :ref:`get_interaction_profile`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_interaction_profile_count`\ (\ ) |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_action_set`\ (\ action_set\: :ref:`OpenXRActionSet`\ ) | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_interaction_profile`\ (\ interaction_profile\: :ref:`OpenXRInteractionProfile`\ ) | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -88,8 +88,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_action_sets** **(** :ref:`Array` value **)** -- :ref:`Array` **get_action_sets** **(** **)** +- |void| **set_action_sets**\ (\ value\: :ref:`Array`\ ) +- :ref:`Array` **get_action_sets**\ (\ ) Collection of :ref:`OpenXRActionSet`\ s that are part of this action map. @@ -105,8 +105,8 @@ Collection of :ref:`OpenXRActionSet`\ s that are part of .. rst-class:: classref-property-setget -- void **set_interaction_profiles** **(** :ref:`Array` value **)** -- :ref:`Array` **get_interaction_profiles** **(** **)** +- |void| **set_interaction_profiles**\ (\ value\: :ref:`Array`\ ) +- :ref:`Array` **get_interaction_profiles**\ (\ ) Collection of :ref:`OpenXRInteractionProfile`\ s that are part of this action map. @@ -123,7 +123,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_action_set** **(** :ref:`OpenXRActionSet` action_set **)** +|void| **add_action_set**\ (\ action_set\: :ref:`OpenXRActionSet`\ ) Add an action set. @@ -135,7 +135,7 @@ Add an action set. .. rst-class:: classref-method -void **add_interaction_profile** **(** :ref:`OpenXRInteractionProfile` interaction_profile **)** +|void| **add_interaction_profile**\ (\ interaction_profile\: :ref:`OpenXRInteractionProfile`\ ) Add an interaction profile. @@ -147,7 +147,7 @@ Add an interaction profile. .. rst-class:: classref-method -void **create_default_action_sets** **(** **)** +|void| **create_default_action_sets**\ (\ ) Setup this action set with our default actions. @@ -159,7 +159,7 @@ Setup this action set with our default actions. .. rst-class:: classref-method -:ref:`OpenXRActionSet` **find_action_set** **(** :ref:`String` name **)** |const| +:ref:`OpenXRActionSet` **find_action_set**\ (\ name\: :ref:`String`\ ) |const| Retrieve an action set by name. @@ -171,7 +171,7 @@ Retrieve an action set by name. .. rst-class:: classref-method -:ref:`OpenXRInteractionProfile` **find_interaction_profile** **(** :ref:`String` name **)** |const| +:ref:`OpenXRInteractionProfile` **find_interaction_profile**\ (\ name\: :ref:`String`\ ) |const| Find an interaction profile by its name (path). @@ -183,7 +183,7 @@ Find an interaction profile by its name (path). .. rst-class:: classref-method -:ref:`OpenXRActionSet` **get_action_set** **(** :ref:`int` idx **)** |const| +:ref:`OpenXRActionSet` **get_action_set**\ (\ idx\: :ref:`int`\ ) |const| Retrieve the action set at this index. @@ -195,7 +195,7 @@ Retrieve the action set at this index. .. rst-class:: classref-method -:ref:`int` **get_action_set_count** **(** **)** |const| +:ref:`int` **get_action_set_count**\ (\ ) |const| Retrieve the number of actions sets in our action map. @@ -207,7 +207,7 @@ Retrieve the number of actions sets in our action map. .. rst-class:: classref-method -:ref:`OpenXRInteractionProfile` **get_interaction_profile** **(** :ref:`int` idx **)** |const| +:ref:`OpenXRInteractionProfile` **get_interaction_profile**\ (\ idx\: :ref:`int`\ ) |const| Get the interaction profile at this index. @@ -219,7 +219,7 @@ Get the interaction profile at this index. .. rst-class:: classref-method -:ref:`int` **get_interaction_profile_count** **(** **)** |const| +:ref:`int` **get_interaction_profile_count**\ (\ ) |const| Retrieve the number of interaction profiles in our action map. @@ -231,7 +231,7 @@ Retrieve the number of interaction profiles in our action map. .. rst-class:: classref-method -void **remove_action_set** **(** :ref:`OpenXRActionSet` action_set **)** +|void| **remove_action_set**\ (\ action_set\: :ref:`OpenXRActionSet`\ ) Remove an action set. @@ -243,7 +243,7 @@ Remove an action set. .. rst-class:: classref-method -void **remove_interaction_profile** **(** :ref:`OpenXRInteractionProfile` interaction_profile **)** +|void| **remove_interaction_profile**\ (\ interaction_profile\: :ref:`OpenXRInteractionProfile`\ ) Remove an interaction profile. @@ -254,3 +254,4 @@ Remove an interaction profile. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_openxractionset.rst b/classes/class_openxractionset.rst index 8e28559793e..9c2e2791bac 100644 --- a/classes/class_openxractionset.rst +++ b/classes/class_openxractionset.rst @@ -47,13 +47,13 @@ Methods .. table:: :widths: auto - +-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_action` **(** :ref:`OpenXRAction` action **)** | - +-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_action_count` **(** **)** |const| | - +-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_action` **(** :ref:`OpenXRAction` action **)** | - +-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_action`\ (\ action\: :ref:`OpenXRAction`\ ) | + +-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_action_count`\ (\ ) |const| | + +-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_action`\ (\ action\: :ref:`OpenXRAction`\ ) | + +-----------------------+--------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -72,8 +72,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_actions** **(** :ref:`Array` value **)** -- :ref:`Array` **get_actions** **(** **)** +- |void| **set_actions**\ (\ value\: :ref:`Array`\ ) +- :ref:`Array` **get_actions**\ (\ ) Collection of actions for this action set. @@ -89,8 +89,8 @@ Collection of actions for this action set. .. rst-class:: classref-property-setget -- void **set_localized_name** **(** :ref:`String` value **)** -- :ref:`String` **get_localized_name** **(** **)** +- |void| **set_localized_name**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_localized_name**\ (\ ) The localized name of this action set. @@ -106,8 +106,8 @@ The localized name of this action set. .. rst-class:: classref-property-setget -- void **set_priority** **(** :ref:`int` value **)** -- :ref:`int` **get_priority** **(** **)** +- |void| **set_priority**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_priority**\ (\ ) The priority for this action set. @@ -124,7 +124,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_action** **(** :ref:`OpenXRAction` action **)** +|void| **add_action**\ (\ action\: :ref:`OpenXRAction`\ ) Add an action to this action set. @@ -136,7 +136,7 @@ Add an action to this action set. .. rst-class:: classref-method -:ref:`int` **get_action_count** **(** **)** |const| +:ref:`int` **get_action_count**\ (\ ) |const| Retrieve the number of actions in our action set. @@ -148,7 +148,7 @@ Retrieve the number of actions in our action set. .. rst-class:: classref-method -void **remove_action** **(** :ref:`OpenXRAction` action **)** +|void| **remove_action**\ (\ action\: :ref:`OpenXRAction`\ ) Remove an action from this action set. @@ -159,3 +159,4 @@ Remove an action from this action set. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_openxrapiextension.rst b/classes/class_openxrapiextension.rst index a0806af76d6..223e42687f2 100644 --- a/classes/class_openxrapiextension.rst +++ b/classes/class_openxrapiextension.rst @@ -50,43 +50,45 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`can_render` **(** **)** | - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_error_string` **(** :ref:`int` result **)** | - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_instance` **(** **)** | - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_instance_proc_addr` **(** :ref:`String` name **)** | - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_next_frame_time` **(** **)** | - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_play_space` **(** **)** | - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_session` **(** **)** | - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_swapchain_format_name` **(** :ref:`int` swapchain_format **)** | - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_system_id` **(** **)** | - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`OpenXRAlphaBlendModeSupport` | :ref:`is_environment_blend_mode_alpha_supported` **(** **)** | - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_initialized` **(** **)** | - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_running` **(** **)** | - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`openxr_is_enabled` **(** :ref:`bool` check_run_in_editor **)** |static| | - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`register_composition_layer_provider` **(** :ref:`OpenXRExtensionWrapperExtension` extension **)** | - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_emulate_environment_blend_mode_alpha_blend` **(** :ref:`bool` enabled **)** | - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`transform_from_pose` **(** const void* pose **)** | - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`unregister_composition_layer_provider` **(** :ref:`OpenXRExtensionWrapperExtension` extension **)** | - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`xr_result` **(** :ref:`int` result, :ref:`String` format, :ref:`Array` args **)** | - +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`can_render`\ (\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_error_string`\ (\ result\: :ref:`int`\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_hand_tracker`\ (\ hand_index\: :ref:`int`\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_instance`\ (\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_instance_proc_addr`\ (\ name\: :ref:`String`\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_next_frame_time`\ (\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_play_space`\ (\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_session`\ (\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_swapchain_format_name`\ (\ swapchain_format\: :ref:`int`\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_system_id`\ (\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`OpenXRAlphaBlendModeSupport` | :ref:`is_environment_blend_mode_alpha_supported`\ (\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_initialized`\ (\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_running`\ (\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`openxr_is_enabled`\ (\ check_run_in_editor\: :ref:`bool`\ ) |static| | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_composition_layer_provider`\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_emulate_environment_blend_mode_alpha_blend`\ (\ enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`transform_from_pose`\ (\ pose\: ``const void*``\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unregister_composition_layer_provider`\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`xr_result`\ (\ result\: :ref:`int`, format\: :ref:`String`, args\: :ref:`Array`\ ) | + +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -140,7 +142,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **can_render** **(** **)** +:ref:`bool` **can_render**\ (\ ) Returns ``true`` if OpenXR is initialized for rendering with an XR viewport. @@ -152,7 +154,7 @@ Returns ``true`` if OpenXR is initialized for rendering with an XR viewport. .. rst-class:: classref-method -:ref:`String` **get_error_string** **(** :ref:`int` result **)** +:ref:`String` **get_error_string**\ (\ result\: :ref:`int`\ ) Returns an error string for the given `XrResult `__. @@ -160,11 +162,23 @@ Returns an error string for the given `XrResult ` **get_hand_tracker**\ (\ hand_index\: :ref:`int`\ ) + +Returns the corresponding ``XRHandTrackerEXT`` handle for the given hand index value. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRAPIExtension_method_get_instance: .. rst-class:: classref-method -:ref:`int` **get_instance** **(** **)** +:ref:`int` **get_instance**\ (\ ) Returns the `XrInstance `__ created during the initialization of the OpenXR API. @@ -176,7 +190,7 @@ Returns the `XrInstance ` **get_instance_proc_addr** **(** :ref:`String` name **)** +:ref:`int` **get_instance_proc_addr**\ (\ name\: :ref:`String`\ ) Returns the function pointer of the OpenXR function with the specified name, cast to an integer. If the function with the given name does not exist, the method returns ``0``. @@ -190,7 +204,7 @@ Returns the function pointer of the OpenXR function with the specified name, cas .. rst-class:: classref-method -:ref:`int` **get_next_frame_time** **(** **)** +:ref:`int` **get_next_frame_time**\ (\ ) Returns the timing for the next frame. @@ -202,7 +216,7 @@ Returns the timing for the next frame. .. rst-class:: classref-method -:ref:`int` **get_play_space** **(** **)** +:ref:`int` **get_play_space**\ (\ ) Returns the play space, which is an `XrSpace `__ cast to an integer. @@ -214,7 +228,7 @@ Returns the play space, which is an `XrSpace ` **get_session** **(** **)** +:ref:`int` **get_session**\ (\ ) Returns the OpenXR session, which is an `XrSession `__ cast to an integer. @@ -226,7 +240,7 @@ Returns the OpenXR session, which is an `XrSession ` **get_swapchain_format_name** **(** :ref:`int` swapchain_format **)** +:ref:`String` **get_swapchain_format_name**\ (\ swapchain_format\: :ref:`int`\ ) Returns the name of the specified swapchain format. @@ -238,7 +252,7 @@ Returns the name of the specified swapchain format. .. rst-class:: classref-method -:ref:`int` **get_system_id** **(** **)** +:ref:`int` **get_system_id**\ (\ ) Returns the id of the system, which is a `XrSystemId `__ cast to an integer. @@ -250,7 +264,7 @@ Returns the id of the system, which is a `XrSystemId ` **is_environment_blend_mode_alpha_supported** **(** **)** +:ref:`OpenXRAlphaBlendModeSupport` **is_environment_blend_mode_alpha_supported**\ (\ ) Returns :ref:`OpenXRAlphaBlendModeSupport` denoting if :ref:`XRInterface.XR_ENV_BLEND_MODE_ALPHA_BLEND` is really supported, emulated or not supported at all. @@ -262,7 +276,7 @@ Returns :ref:`OpenXRAlphaBlendModeSupport` **is_initialized** **(** **)** +:ref:`bool` **is_initialized**\ (\ ) Returns ``true`` if OpenXR is initialized. @@ -274,7 +288,7 @@ Returns ``true`` if OpenXR is initialized. .. rst-class:: classref-method -:ref:`bool` **is_running** **(** **)** +:ref:`bool` **is_running**\ (\ ) Returns ``true`` if OpenXR is running (`xrBeginSession `__ was successfully called and the swapchains were created). @@ -286,7 +300,7 @@ Returns ``true`` if OpenXR is running (`xrBeginSession ` **openxr_is_enabled** **(** :ref:`bool` check_run_in_editor **)** |static| +:ref:`bool` **openxr_is_enabled**\ (\ check_run_in_editor\: :ref:`bool`\ ) |static| Returns ``true`` if OpenXR is enabled. @@ -298,7 +312,7 @@ Returns ``true`` if OpenXR is enabled. .. rst-class:: classref-method -void **register_composition_layer_provider** **(** :ref:`OpenXRExtensionWrapperExtension` extension **)** +|void| **register_composition_layer_provider**\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) Registers the given extension as a composition layer provider. @@ -310,7 +324,7 @@ Registers the given extension as a composition layer provider. .. rst-class:: classref-method -void **set_emulate_environment_blend_mode_alpha_blend** **(** :ref:`bool` enabled **)** +|void| **set_emulate_environment_blend_mode_alpha_blend**\ (\ enabled\: :ref:`bool`\ ) If set to ``true``, an OpenXR extension is loaded which is capable of emulating the :ref:`XRInterface.XR_ENV_BLEND_MODE_ALPHA_BLEND` blend mode. @@ -322,7 +336,7 @@ If set to ``true``, an OpenXR extension is loaded which is capable of emulating .. rst-class:: classref-method -:ref:`Transform3D` **transform_from_pose** **(** const void* pose **)** +:ref:`Transform3D` **transform_from_pose**\ (\ pose\: ``const void*``\ ) Creates a :ref:`Transform3D` from an `XrPosef `__. @@ -334,7 +348,7 @@ Creates a :ref:`Transform3D` from an `XrPosef ` extension **)** +|void| **unregister_composition_layer_provider**\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) Unregisters the given extension as a composition layer provider. @@ -346,7 +360,7 @@ Unregisters the given extension as a composition layer provider. .. rst-class:: classref-method -:ref:`bool` **xr_result** **(** :ref:`int` result, :ref:`String` format, :ref:`Array` args **)** +:ref:`bool` **xr_result**\ (\ result\: :ref:`int`, format\: :ref:`String`, args\: :ref:`Array`\ ) Returns ``true`` if the provided `XrResult `__ (cast to an integer) is successful. Otherwise returns ``false`` and prints the `XrResult `__ converted to a string, with the specified additional information. @@ -357,3 +371,4 @@ Returns ``true`` if the provided `XrResult ` | :ref:`_get_composition_layer` **(** **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_requested_extensions` **(** **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_suggested_tracker_names` **(** **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_on_before_instance_created` **(** **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_on_event_polled` **(** const void* event **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_on_instance_created` **(** :ref:`int` instance **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_on_instance_destroyed` **(** **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_on_pre_render` **(** **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_on_process` **(** **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_on_register_metadata` **(** **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_on_session_created` **(** :ref:`int` session **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_on_session_destroyed` **(** **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_on_state_exiting` **(** **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_on_state_focused` **(** **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_on_state_idle` **(** **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_on_state_loss_pending` **(** **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_on_state_ready` **(** **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_on_state_stopping` **(** **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_on_state_synchronized` **(** **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_on_state_visible` **(** **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_hand_joint_locations_and_get_next_pointer` **(** :ref:`int` hand_index, void* next_pointer **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_instance_create_info_and_get_next_pointer` **(** void* next_pointer **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_session_create_and_get_next_pointer` **(** void* next_pointer **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_swapchain_create_info_and_get_next_pointer` **(** void* next_pointer **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_system_properties_and_get_next_pointer` **(** void* next_pointer **)** |virtual| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`OpenXRAPIExtension` | :ref:`get_openxr_api` **(** **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`register_extension_wrapper` **(** **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_composition_layer`\ (\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_requested_extensions`\ (\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_suggested_tracker_names`\ (\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_before_instance_created`\ (\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_on_event_polled`\ (\ event\: ``const void*``\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_instance_created`\ (\ instance\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_instance_destroyed`\ (\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_pre_render`\ (\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_process`\ (\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_register_metadata`\ (\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_session_created`\ (\ session\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_session_destroyed`\ (\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_exiting`\ (\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_focused`\ (\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_idle`\ (\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_loss_pending`\ (\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_ready`\ (\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_stopping`\ (\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_synchronized`\ (\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_visible`\ (\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_hand_joint_locations_and_get_next_pointer`\ (\ hand_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_instance_create_info_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_session_create_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_swapchain_create_info_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_system_properties_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`OpenXRAPIExtension` | :ref:`get_openxr_api`\ (\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_extension_wrapper`\ (\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -98,7 +98,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_composition_layer** **(** **)** |virtual| +:ref:`int` **_get_composition_layer**\ (\ ) |virtual| Returns a pointer to a ``XrCompositionLayerBaseHeader`` struct to provide a composition layer. This will only be called if the extension previously registered itself with :ref:`OpenXRAPIExtension.register_composition_layer_provider`. @@ -110,7 +110,7 @@ Returns a pointer to a ``XrCompositionLayerBaseHeader`` struct to provide a comp .. rst-class:: classref-method -:ref:`Dictionary` **_get_requested_extensions** **(** **)** |virtual| +:ref:`Dictionary` **_get_requested_extensions**\ (\ ) |virtual| Returns a :ref:`Dictionary` of OpenXR extensions related to this extension. The :ref:`Dictionary` should contain the name of the extension, mapped to a ``bool *`` cast to an integer: @@ -126,7 +126,7 @@ Returns a :ref:`Dictionary` of OpenXR extensions related to th .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_suggested_tracker_names** **(** **)** |virtual| +:ref:`PackedStringArray` **_get_suggested_tracker_names**\ (\ ) |virtual| Returns a :ref:`PackedStringArray` of positional tracker names that are used within the extension wrapper. @@ -138,7 +138,7 @@ Returns a :ref:`PackedStringArray` of positional tracke .. rst-class:: classref-method -void **_on_before_instance_created** **(** **)** |virtual| +|void| **_on_before_instance_created**\ (\ ) |virtual| Called before the OpenXR instance is created. @@ -150,7 +150,7 @@ Called before the OpenXR instance is created. .. rst-class:: classref-method -:ref:`bool` **_on_event_polled** **(** const void* event **)** |virtual| +:ref:`bool` **_on_event_polled**\ (\ event\: ``const void*``\ ) |virtual| Called when there is an OpenXR event to process. When implementing, return ``true`` if the event was handled, return ``false`` otherwise. @@ -162,7 +162,7 @@ Called when there is an OpenXR event to process. When implementing, return ``tru .. rst-class:: classref-method -void **_on_instance_created** **(** :ref:`int` instance **)** |virtual| +|void| **_on_instance_created**\ (\ instance\: :ref:`int`\ ) |virtual| Called right after the OpenXR instance is created. @@ -174,7 +174,7 @@ Called right after the OpenXR instance is created. .. rst-class:: classref-method -void **_on_instance_destroyed** **(** **)** |virtual| +|void| **_on_instance_destroyed**\ (\ ) |virtual| Called right before the OpenXR instance is destroyed. @@ -186,7 +186,7 @@ Called right before the OpenXR instance is destroyed. .. rst-class:: classref-method -void **_on_pre_render** **(** **)** |virtual| +|void| **_on_pre_render**\ (\ ) |virtual| Called right before the XR viewports begin their rendering step. @@ -198,7 +198,7 @@ Called right before the XR viewports begin their rendering step. .. rst-class:: classref-method -void **_on_process** **(** **)** |virtual| +|void| **_on_process**\ (\ ) |virtual| Called as part of the OpenXR process handling. This happens right before general and physics processing steps of the main loop. During this step controller data is queried and made available to game logic. @@ -210,7 +210,7 @@ Called as part of the OpenXR process handling. This happens right before general .. rst-class:: classref-method -void **_on_register_metadata** **(** **)** |virtual| +|void| **_on_register_metadata**\ (\ ) |virtual| Allows extensions to register additional controller metadata. This function is called even when the OpenXR API is not constructed as the metadata needs to be available to the editor. @@ -224,7 +224,7 @@ Extensions should also provide metadata regardless of whether they are supported .. rst-class:: classref-method -void **_on_session_created** **(** :ref:`int` session **)** |virtual| +|void| **_on_session_created**\ (\ session\: :ref:`int`\ ) |virtual| Called right after the OpenXR session is created. @@ -236,7 +236,7 @@ Called right after the OpenXR session is created. .. rst-class:: classref-method -void **_on_session_destroyed** **(** **)** |virtual| +|void| **_on_session_destroyed**\ (\ ) |virtual| Called right before the OpenXR session is destroyed. @@ -248,7 +248,7 @@ Called right before the OpenXR session is destroyed. .. rst-class:: classref-method -void **_on_state_exiting** **(** **)** |virtual| +|void| **_on_state_exiting**\ (\ ) |virtual| Called when the OpenXR session state is changed to exiting. @@ -260,7 +260,7 @@ Called when the OpenXR session state is changed to exiting. .. rst-class:: classref-method -void **_on_state_focused** **(** **)** |virtual| +|void| **_on_state_focused**\ (\ ) |virtual| Called when the OpenXR session state is changed to focused. This state is the active state when the game runs. @@ -272,7 +272,7 @@ Called when the OpenXR session state is changed to focused. This state is the ac .. rst-class:: classref-method -void **_on_state_idle** **(** **)** |virtual| +|void| **_on_state_idle**\ (\ ) |virtual| Called when the OpenXR session state is changed to idle. @@ -284,7 +284,7 @@ Called when the OpenXR session state is changed to idle. .. rst-class:: classref-method -void **_on_state_loss_pending** **(** **)** |virtual| +|void| **_on_state_loss_pending**\ (\ ) |virtual| Called when the OpenXR session state is changed to loss pending. @@ -296,7 +296,7 @@ Called when the OpenXR session state is changed to loss pending. .. rst-class:: classref-method -void **_on_state_ready** **(** **)** |virtual| +|void| **_on_state_ready**\ (\ ) |virtual| Called when the OpenXR session state is changed to ready. This means OpenXR is ready to set up the session. @@ -308,7 +308,7 @@ Called when the OpenXR session state is changed to ready. This means OpenXR is r .. rst-class:: classref-method -void **_on_state_stopping** **(** **)** |virtual| +|void| **_on_state_stopping**\ (\ ) |virtual| Called when the OpenXR session state is changed to stopping. @@ -320,7 +320,7 @@ Called when the OpenXR session state is changed to stopping. .. rst-class:: classref-method -void **_on_state_synchronized** **(** **)** |virtual| +|void| **_on_state_synchronized**\ (\ ) |virtual| Called when the OpenXR session state is changed to synchronized. OpenXR also returns to this state when the application loses focus. @@ -332,7 +332,7 @@ Called when the OpenXR session state is changed to synchronized. OpenXR also ret .. rst-class:: classref-method -void **_on_state_visible** **(** **)** |virtual| +|void| **_on_state_visible**\ (\ ) |virtual| Called when the OpenXR session state is changed to visible. This means OpenXR is now ready to receive frames. @@ -344,7 +344,7 @@ Called when the OpenXR session state is changed to visible. This means OpenXR is .. rst-class:: classref-method -:ref:`int` **_set_hand_joint_locations_and_get_next_pointer** **(** :ref:`int` hand_index, void* next_pointer **)** |virtual| +:ref:`int` **_set_hand_joint_locations_and_get_next_pointer**\ (\ hand_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| Adds additional data structures when each hand tracker is created. @@ -356,7 +356,7 @@ Adds additional data structures when each hand tracker is created. .. rst-class:: classref-method -:ref:`int` **_set_instance_create_info_and_get_next_pointer** **(** void* next_pointer **)** |virtual| +:ref:`int` **_set_instance_create_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| Adds additional data structures when the OpenXR instance is created. @@ -368,7 +368,7 @@ Adds additional data structures when the OpenXR instance is created. .. rst-class:: classref-method -:ref:`int` **_set_session_create_and_get_next_pointer** **(** void* next_pointer **)** |virtual| +:ref:`int` **_set_session_create_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| Adds additional data structures when the OpenXR session is created. @@ -380,7 +380,7 @@ Adds additional data structures when the OpenXR session is created. .. rst-class:: classref-method -:ref:`int` **_set_swapchain_create_info_and_get_next_pointer** **(** void* next_pointer **)** |virtual| +:ref:`int` **_set_swapchain_create_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| Adds additional data structures when creating OpenXR swapchains. @@ -392,7 +392,7 @@ Adds additional data structures when creating OpenXR swapchains. .. rst-class:: classref-method -:ref:`int` **_set_system_properties_and_get_next_pointer** **(** void* next_pointer **)** |virtual| +:ref:`int` **_set_system_properties_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| Adds additional data structures when interogating OpenXR system abilities. @@ -404,7 +404,7 @@ Adds additional data structures when interogating OpenXR system abilities. .. rst-class:: classref-method -:ref:`OpenXRAPIExtension` **get_openxr_api** **(** **)** +:ref:`OpenXRAPIExtension` **get_openxr_api**\ (\ ) Returns the created :ref:`OpenXRAPIExtension`, which can be used to access the OpenXR API. @@ -416,7 +416,7 @@ Returns the created :ref:`OpenXRAPIExtension`, which c .. rst-class:: classref-method -void **register_extension_wrapper** **(** **)** +|void| **register_extension_wrapper**\ (\ ) Registers the extension. This should happen at core module initialization level. @@ -427,3 +427,4 @@ Registers the extension. This should happen at core module initialization level. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_openxrhand.rst b/classes/class_openxrhand.rst index bc517de1e75..af4ef5e29cd 100644 --- a/classes/class_openxrhand.rst +++ b/classes/class_openxrhand.rst @@ -10,6 +10,8 @@ OpenXRHand ========== +**Deprecated:** Use :ref:`XRHandModifier3D` instead. + **Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` Node supporting hand and finger tracking in OpenXR. @@ -205,8 +207,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bone_update** **(** :ref:`BoneUpdate` value **)** -- :ref:`BoneUpdate` **get_bone_update** **(** **)** +- |void| **set_bone_update**\ (\ value\: :ref:`BoneUpdate`\ ) +- :ref:`BoneUpdate` **get_bone_update**\ (\ ) Specify the type of updates to perform on the bone. @@ -222,8 +224,8 @@ Specify the type of updates to perform on the bone. .. rst-class:: classref-property-setget -- void **set_hand** **(** :ref:`Hands` value **)** -- :ref:`Hands` **get_hand** **(** **)** +- |void| **set_hand**\ (\ value\: :ref:`Hands`\ ) +- :ref:`Hands` **get_hand**\ (\ ) Specifies whether this node tracks the left or right hand of the player. @@ -239,8 +241,8 @@ Specifies whether this node tracks the left or right hand of the player. .. rst-class:: classref-property-setget -- void **set_hand_skeleton** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_hand_skeleton** **(** **)** +- |void| **set_hand_skeleton**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_hand_skeleton**\ (\ ) Set a :ref:`Skeleton3D` node for which the pose positions will be updated. @@ -256,8 +258,8 @@ Set a :ref:`Skeleton3D` node for which the pose positions will .. rst-class:: classref-property-setget -- void **set_motion_range** **(** :ref:`MotionRange` value **)** -- :ref:`MotionRange` **get_motion_range** **(** **)** +- |void| **set_motion_range**\ (\ value\: :ref:`MotionRange`\ ) +- :ref:`MotionRange` **get_motion_range**\ (\ ) Set the motion range (if supported) limiting the hand motion. @@ -273,8 +275,8 @@ Set the motion range (if supported) limiting the hand motion. .. rst-class:: classref-property-setget -- void **set_skeleton_rig** **(** :ref:`SkeletonRig` value **)** -- :ref:`SkeletonRig` **get_skeleton_rig** **(** **)** +- |void| **set_skeleton_rig**\ (\ value\: :ref:`SkeletonRig`\ ) +- :ref:`SkeletonRig` **get_skeleton_rig**\ (\ ) Set the type of skeleton rig the :ref:`hand_skeleton` is compliant with. @@ -285,3 +287,4 @@ Set the type of skeleton rig the :ref:`hand_skeleton` | :ref:`get_binding` **(** :ref:`int` index **)** |const| | - +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_binding_count` **(** **)** |const| | - +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | :ref:`OpenXRIPBinding` | :ref:`get_binding`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_binding_count`\ (\ ) |const| | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -68,8 +68,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bindings** **(** :ref:`Array` value **)** -- :ref:`Array` **get_bindings** **(** **)** +- |void| **set_bindings**\ (\ value\: :ref:`Array`\ ) +- :ref:`Array` **get_bindings**\ (\ ) Action bindings for this interaction profile. @@ -85,8 +85,8 @@ Action bindings for this interaction profile. .. rst-class:: classref-property-setget -- void **set_interaction_profile_path** **(** :ref:`String` value **)** -- :ref:`String` **get_interaction_profile_path** **(** **)** +- |void| **set_interaction_profile_path**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_interaction_profile_path**\ (\ ) The interaction profile path identifying the XR device. @@ -103,7 +103,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`OpenXRIPBinding` **get_binding** **(** :ref:`int` index **)** |const| +:ref:`OpenXRIPBinding` **get_binding**\ (\ index\: :ref:`int`\ ) |const| Retrieve the binding at this index. @@ -115,7 +115,7 @@ Retrieve the binding at this index. .. rst-class:: classref-method -:ref:`int` **get_binding_count** **(** **)** |const| +:ref:`int` **get_binding_count**\ (\ ) |const| Get the number of bindings in this interaction profile. @@ -126,3 +126,4 @@ Get the number of bindings in this interaction profile. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_openxrinteractionprofilemetadata.rst b/classes/class_openxrinteractionprofilemetadata.rst index 8d8897c54b8..92634d89de2 100644 --- a/classes/class_openxrinteractionprofilemetadata.rst +++ b/classes/class_openxrinteractionprofilemetadata.rst @@ -29,15 +29,15 @@ Methods .. table:: :widths: auto - +------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`register_interaction_profile` **(** :ref:`String` display_name, :ref:`String` openxr_path, :ref:`String` openxr_extension_name **)** | - +------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`register_io_path` **(** :ref:`String` interaction_profile, :ref:`String` display_name, :ref:`String` toplevel_path, :ref:`String` openxr_path, :ref:`String` openxr_extension_name, :ref:`ActionType` action_type **)** | - +------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`register_profile_rename` **(** :ref:`String` old_name, :ref:`String` new_name **)** | - +------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`register_top_level_path` **(** :ref:`String` display_name, :ref:`String` openxr_path, :ref:`String` openxr_extension_name **)** | - +------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_interaction_profile`\ (\ display_name\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_name\: :ref:`String`\ ) | + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_io_path`\ (\ interaction_profile\: :ref:`String`, display_name\: :ref:`String`, toplevel_path\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_name\: :ref:`String`, action_type\: :ref:`ActionType`\ ) | + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_profile_rename`\ (\ old_name\: :ref:`String`, new_name\: :ref:`String`\ ) | + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_top_level_path`\ (\ display_name\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_name\: :ref:`String`\ ) | + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -52,7 +52,7 @@ Method Descriptions .. rst-class:: classref-method -void **register_interaction_profile** **(** :ref:`String` display_name, :ref:`String` openxr_path, :ref:`String` openxr_extension_name **)** +|void| **register_interaction_profile**\ (\ display_name\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_name\: :ref:`String`\ ) Registers an interaction profile using its OpenXR designation (e.g. ``/interaction_profiles/khr/simple_controller`` is the profile for OpenXR's simple controller profile). @@ -66,7 +66,7 @@ Registers an interaction profile using its OpenXR designation (e.g. ``/interacti .. rst-class:: classref-method -void **register_io_path** **(** :ref:`String` interaction_profile, :ref:`String` display_name, :ref:`String` toplevel_path, :ref:`String` openxr_path, :ref:`String` openxr_extension_name, :ref:`ActionType` action_type **)** +|void| **register_io_path**\ (\ interaction_profile\: :ref:`String`, display_name\: :ref:`String`, toplevel_path\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_name\: :ref:`String`, action_type\: :ref:`ActionType`\ ) Registers an input/output path for the given ``interaction_profile``. The profile should previously have been registered using :ref:`register_interaction_profile`. ``display_name`` is the description shown to the user. ``toplevel_path`` specifies the bind path this input/output can be bound to (e.g. ``/user/hand/left`` or ``/user/hand/right``). ``openxr_path`` is the action input/output being registered (e.g. ``/user/hand/left/input/aim/pose``). ``openxr_extension_name`` restricts this input/output to an enabled/available extension, this doesn't need to repeat the extension on the profile but relates to overlapping extension (e.g. ``XR_EXT_palm_pose`` that introduces ``…/input/palm_ext/pose`` input paths). ``action_type`` defines the type of input or output provided by OpenXR. @@ -78,7 +78,7 @@ Registers an input/output path for the given ``interaction_profile``. The profil .. rst-class:: classref-method -void **register_profile_rename** **(** :ref:`String` old_name, :ref:`String` new_name **)** +|void| **register_profile_rename**\ (\ old_name\: :ref:`String`, new_name\: :ref:`String`\ ) Allows for renaming old interaction profile paths to new paths to maintain backwards compatibility with older action maps. @@ -90,7 +90,7 @@ Allows for renaming old interaction profile paths to new paths to maintain backw .. rst-class:: classref-method -void **register_top_level_path** **(** :ref:`String` display_name, :ref:`String` openxr_path, :ref:`String` openxr_extension_name **)** +|void| **register_top_level_path**\ (\ display_name\: :ref:`String`, openxr_path\: :ref:`String`, openxr_extension_name\: :ref:`String`\ ) Registers a top level path to which profiles can be bound. For instance ``/user/hand/left`` refers to the bind point for the player's left hand. Extensions can register additional top level paths, for instance a haptic vest extension might register ``/user/body/vest``. @@ -105,3 +105,4 @@ When a top level path ends up being bound by OpenXR, a :ref:`XRPositionalTracker .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_openxrinterface.rst b/classes/class_openxrinterface.rst index 4bce1b673d1..1a3f478eed5 100644 --- a/classes/class_openxrinterface.rst +++ b/classes/class_openxrinterface.rst @@ -56,39 +56,39 @@ Methods .. table:: :widths: auto - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_action_sets` **(** **)** |const| | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_available_display_refresh_rates` **(** **)** |const| | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_hand_joint_angular_velocity` **(** :ref:`Hand` hand, :ref:`HandJoints` joint **)** |const| | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`HandJointFlags`\> | :ref:`get_hand_joint_flags` **(** :ref:`Hand` hand, :ref:`HandJoints` joint **)** |const| | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_hand_joint_linear_velocity` **(** :ref:`Hand` hand, :ref:`HandJoints` joint **)** |const| | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_hand_joint_position` **(** :ref:`Hand` hand, :ref:`HandJoints` joint **)** |const| | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_hand_joint_radius` **(** :ref:`Hand` hand, :ref:`HandJoints` joint **)** |const| | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`get_hand_joint_rotation` **(** :ref:`Hand` hand, :ref:`HandJoints` joint **)** |const| | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`HandTrackedSource` | :ref:`get_hand_tracking_source` **(** :ref:`Hand` hand **)** |const| | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`HandMotionRange` | :ref:`get_motion_range` **(** :ref:`Hand` hand **)** |const| | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_action_set_active` **(** :ref:`String` name **)** |const| | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_eye_gaze_interaction_supported` **(** **)** | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_foveation_supported` **(** **)** |const| | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_hand_tracking_supported` **(** **)** | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_action_set_active` **(** :ref:`String` name, :ref:`bool` active **)** | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_motion_range` **(** :ref:`Hand` hand, :ref:`HandMotionRange` motion_range **)** | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_action_sets`\ (\ ) |const| | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_available_display_refresh_rates`\ (\ ) |const| | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_hand_joint_angular_velocity`\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`HandJointFlags`\] | :ref:`get_hand_joint_flags`\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_hand_joint_linear_velocity`\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_hand_joint_position`\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_hand_joint_radius`\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`get_hand_joint_rotation`\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`HandTrackedSource` | :ref:`get_hand_tracking_source`\ (\ hand\: :ref:`Hand`\ ) |const| | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`HandMotionRange` | :ref:`get_motion_range`\ (\ hand\: :ref:`Hand`\ ) |const| | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_action_set_active`\ (\ name\: :ref:`String`\ ) |const| | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_eye_gaze_interaction_supported`\ (\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_foveation_supported`\ (\ ) |const| | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_hand_tracking_supported`\ (\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_action_set_active`\ (\ name\: :ref:`String`, active\: :ref:`bool`\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_motion_range`\ (\ hand\: :ref:`Hand`, motion_range\: :ref:`HandMotionRange`\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -103,7 +103,7 @@ Signals .. rst-class:: classref-signal -**pose_recentered** **(** **)** +**pose_recentered**\ (\ ) Informs the user queued a recenter of the player position. @@ -115,7 +115,7 @@ Informs the user queued a recenter of the player position. .. rst-class:: classref-signal -**session_begun** **(** **)** +**session_begun**\ (\ ) Informs our OpenXR session has been started. @@ -127,7 +127,7 @@ Informs our OpenXR session has been started. .. rst-class:: classref-signal -**session_focussed** **(** **)** +**session_focussed**\ (\ ) Informs our OpenXR session now has focus. @@ -139,7 +139,7 @@ Informs our OpenXR session now has focus. .. rst-class:: classref-signal -**session_stopping** **(** **)** +**session_stopping**\ (\ ) Informs our OpenXR session is stopping. @@ -151,7 +151,7 @@ Informs our OpenXR session is stopping. .. rst-class:: classref-signal -**session_visible** **(** **)** +**session_visible**\ (\ ) Informs our OpenXR session is now visible (output is being sent to the HMD). @@ -579,8 +579,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_display_refresh_rate** **(** :ref:`float` value **)** -- :ref:`float` **get_display_refresh_rate** **(** **)** +- |void| **set_display_refresh_rate**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_display_refresh_rate**\ (\ ) The display refresh rate for the current HMD. Only functional if this feature is supported by the OpenXR runtime and after the interface has been initialized. @@ -596,8 +596,8 @@ The display refresh rate for the current HMD. Only functional if this feature is .. rst-class:: classref-property-setget -- void **set_foveation_dynamic** **(** :ref:`bool` value **)** -- :ref:`bool` **get_foveation_dynamic** **(** **)** +- |void| **set_foveation_dynamic**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_foveation_dynamic**\ (\ ) Enable dynamic foveation adjustment, the interface must be initialized before this is accessible. If enabled foveation will automatically adjusted between low and :ref:`foveation_level`. @@ -615,8 +615,8 @@ Enable dynamic foveation adjustment, the interface must be initialized before th .. rst-class:: classref-property-setget -- void **set_foveation_level** **(** :ref:`int` value **)** -- :ref:`int` **get_foveation_level** **(** **)** +- |void| **set_foveation_level**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_foveation_level**\ (\ ) Set foveation level from 0 (off) to 3 (high), the interface must be initialized before this is accessible. @@ -634,8 +634,8 @@ Set foveation level from 0 (off) to 3 (high), the interface must be initialized .. rst-class:: classref-property-setget -- void **set_render_target_size_multiplier** **(** :ref:`float` value **)** -- :ref:`float` **get_render_target_size_multiplier** **(** **)** +- |void| **set_render_target_size_multiplier**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_render_target_size_multiplier**\ (\ ) The render size multiplier for the current HMD. Must be set before the interface has been initialized. @@ -652,7 +652,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array` **get_action_sets** **(** **)** |const| +:ref:`Array` **get_action_sets**\ (\ ) |const| Returns a list of action sets registered with Godot (loaded from the action map at runtime). @@ -664,7 +664,7 @@ Returns a list of action sets registered with Godot (loaded from the action map .. rst-class:: classref-method -:ref:`Array` **get_available_display_refresh_rates** **(** **)** |const| +:ref:`Array` **get_available_display_refresh_rates**\ (\ ) |const| Returns display refresh rates supported by the current HMD. Only returned if this feature is supported by the OpenXR runtime and after the interface has been initialized. @@ -676,7 +676,9 @@ Returns display refresh rates supported by the current HMD. Only returned if thi .. rst-class:: classref-method -:ref:`Vector3` **get_hand_joint_angular_velocity** **(** :ref:`Hand` hand, :ref:`HandJoints` joint **)** |const| +:ref:`Vector3` **get_hand_joint_angular_velocity**\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| + +**Deprecated:** Use :ref:`XRHandTracker.get_hand_joint_angular_velocity` obtained from :ref:`XRServer.get_hand_tracker` instead. If handtracking is enabled, returns the angular velocity of a joint (``joint``) of a hand (``hand``) as provided by OpenXR. This is relative to :ref:`XROrigin3D`! @@ -688,7 +690,9 @@ If handtracking is enabled, returns the angular velocity of a joint (``joint``) .. rst-class:: classref-method -|bitfield|\<:ref:`HandJointFlags`\> **get_hand_joint_flags** **(** :ref:`Hand` hand, :ref:`HandJoints` joint **)** |const| +|bitfield|\[:ref:`HandJointFlags`\] **get_hand_joint_flags**\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| + +**Deprecated:** Use :ref:`XRHandTracker.get_hand_joint_flags` obtained from :ref:`XRServer.get_hand_tracker` instead. If handtracking is enabled, returns flags that inform us of the validity of the tracking data. @@ -700,7 +704,9 @@ If handtracking is enabled, returns flags that inform us of the validity of the .. rst-class:: classref-method -:ref:`Vector3` **get_hand_joint_linear_velocity** **(** :ref:`Hand` hand, :ref:`HandJoints` joint **)** |const| +:ref:`Vector3` **get_hand_joint_linear_velocity**\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| + +**Deprecated:** Use :ref:`XRHandTracker.get_hand_joint_linear_velocity` obtained from :ref:`XRServer.get_hand_tracker` instead. If handtracking is enabled, returns the linear velocity of a joint (``joint``) of a hand (``hand``) as provided by OpenXR. This is relative to :ref:`XROrigin3D` without worldscale applied! @@ -712,7 +718,9 @@ If handtracking is enabled, returns the linear velocity of a joint (``joint``) o .. rst-class:: classref-method -:ref:`Vector3` **get_hand_joint_position** **(** :ref:`Hand` hand, :ref:`HandJoints` joint **)** |const| +:ref:`Vector3` **get_hand_joint_position**\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| + +**Deprecated:** Use :ref:`XRHandTracker.get_hand_joint_transform` obtained from :ref:`XRServer.get_hand_tracker` instead. If handtracking is enabled, returns the position of a joint (``joint``) of a hand (``hand``) as provided by OpenXR. This is relative to :ref:`XROrigin3D` without worldscale applied! @@ -724,7 +732,9 @@ If handtracking is enabled, returns the position of a joint (``joint``) of a han .. rst-class:: classref-method -:ref:`float` **get_hand_joint_radius** **(** :ref:`Hand` hand, :ref:`HandJoints` joint **)** |const| +:ref:`float` **get_hand_joint_radius**\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| + +**Deprecated:** Use :ref:`XRHandTracker.get_hand_joint_radius` obtained from :ref:`XRServer.get_hand_tracker` instead. If handtracking is enabled, returns the radius of a joint (``joint``) of a hand (``hand``) as provided by OpenXR. This is without worldscale applied! @@ -736,7 +746,9 @@ If handtracking is enabled, returns the radius of a joint (``joint``) of a hand .. rst-class:: classref-method -:ref:`Quaternion` **get_hand_joint_rotation** **(** :ref:`Hand` hand, :ref:`HandJoints` joint **)** |const| +:ref:`Quaternion` **get_hand_joint_rotation**\ (\ hand\: :ref:`Hand`, joint\: :ref:`HandJoints`\ ) |const| + +**Deprecated:** Use :ref:`XRHandTracker.get_hand_joint_transform` obtained from :ref:`XRServer.get_hand_tracker` instead. If handtracking is enabled, returns the rotation of a joint (``joint``) of a hand (``hand``) as provided by OpenXR. @@ -748,7 +760,9 @@ If handtracking is enabled, returns the rotation of a joint (``joint``) of a han .. rst-class:: classref-method -:ref:`HandTrackedSource` **get_hand_tracking_source** **(** :ref:`Hand` hand **)** |const| +:ref:`HandTrackedSource` **get_hand_tracking_source**\ (\ hand\: :ref:`Hand`\ ) |const| + +**Deprecated:** Use :ref:`XRHandTracker.hand_tracking_source` obtained from :ref:`XRServer.get_hand_tracker` instead. If handtracking is enabled and hand tracking source is supported, gets the source of the hand tracking data for ``hand``. @@ -760,7 +774,7 @@ If handtracking is enabled and hand tracking source is supported, gets the sourc .. rst-class:: classref-method -:ref:`HandMotionRange` **get_motion_range** **(** :ref:`Hand` hand **)** |const| +:ref:`HandMotionRange` **get_motion_range**\ (\ hand\: :ref:`Hand`\ ) |const| If handtracking is enabled and motion range is supported, gets the currently configured motion range for ``hand``. @@ -772,7 +786,7 @@ If handtracking is enabled and motion range is supported, gets the currently con .. rst-class:: classref-method -:ref:`bool` **is_action_set_active** **(** :ref:`String` name **)** |const| +:ref:`bool` **is_action_set_active**\ (\ name\: :ref:`String`\ ) |const| Returns ``true`` if the given action set is active. @@ -784,7 +798,7 @@ Returns ``true`` if the given action set is active. .. rst-class:: classref-method -:ref:`bool` **is_eye_gaze_interaction_supported** **(** **)** +:ref:`bool` **is_eye_gaze_interaction_supported**\ (\ ) Returns the capabilities of the eye gaze interaction extension. @@ -798,7 +812,7 @@ Returns the capabilities of the eye gaze interaction extension. .. rst-class:: classref-method -:ref:`bool` **is_foveation_supported** **(** **)** |const| +:ref:`bool` **is_foveation_supported**\ (\ ) |const| Returns ``true`` if OpenXR's foveation extension is supported, the interface must be initialized before this returns a valid value. @@ -812,7 +826,7 @@ Returns ``true`` if OpenXR's foveation extension is supported, the interface mus .. rst-class:: classref-method -:ref:`bool` **is_hand_tracking_supported** **(** **)** +:ref:`bool` **is_hand_tracking_supported**\ (\ ) Returns ``true`` if OpenXR's hand tracking is supported and enabled. @@ -826,7 +840,7 @@ Returns ``true`` if OpenXR's hand tracking is supported and enabled. .. rst-class:: classref-method -void **set_action_set_active** **(** :ref:`String` name, :ref:`bool` active **)** +|void| **set_action_set_active**\ (\ name\: :ref:`String`, active\: :ref:`bool`\ ) Sets the given action set as active or inactive. @@ -838,7 +852,7 @@ Sets the given action set as active or inactive. .. rst-class:: classref-method -void **set_motion_range** **(** :ref:`Hand` hand, :ref:`HandMotionRange` motion_range **)** +|void| **set_motion_range**\ (\ hand\: :ref:`Hand`, motion_range\: :ref:`HandMotionRange`\ ) If handtracking is enabled and motion range is supported, sets the currently configured motion range for ``hand`` to ``motion_range``. @@ -849,3 +863,4 @@ If handtracking is enabled and motion range is supported, sets the currently con .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_openxripbinding.rst b/classes/class_openxripbinding.rst index 1a1385fb1be..159c821b115 100644 --- a/classes/class_openxripbinding.rst +++ b/classes/class_openxripbinding.rst @@ -43,15 +43,15 @@ Methods .. table:: :widths: auto - +-------------------------+-------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_path` **(** :ref:`String` path **)** | - +-------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_path_count` **(** **)** |const| | - +-------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_path` **(** :ref:`String` path **)** |const| | - +-------------------------+-------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_path` **(** :ref:`String` path **)** | - +-------------------------+-------------------------------------------------------------------------------------------------------------+ + +-------------------------+----------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_path`\ (\ path\: :ref:`String`\ ) | + +-------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_path_count`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_path`\ (\ path\: :ref:`String`\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_path`\ (\ path\: :ref:`String`\ ) | + +-------------------------+----------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -70,8 +70,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_action** **(** :ref:`OpenXRAction` value **)** -- :ref:`OpenXRAction` **get_action** **(** **)** +- |void| **set_action**\ (\ value\: :ref:`OpenXRAction`\ ) +- :ref:`OpenXRAction` **get_action**\ (\ ) :ref:`OpenXRAction` that is bound to these paths. @@ -87,8 +87,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_paths** **(** :ref:`PackedStringArray` value **)** -- :ref:`PackedStringArray` **get_paths** **(** **)** +- |void| **set_paths**\ (\ value\: :ref:`PackedStringArray`\ ) +- :ref:`PackedStringArray` **get_paths**\ (\ ) Paths that define the inputs or outputs bound on the device. @@ -105,7 +105,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_path** **(** :ref:`String` path **)** +|void| **add_path**\ (\ path\: :ref:`String`\ ) Add an input/output path to this binding. @@ -117,7 +117,7 @@ Add an input/output path to this binding. .. rst-class:: classref-method -:ref:`int` **get_path_count** **(** **)** |const| +:ref:`int` **get_path_count**\ (\ ) |const| Get the number of input/output paths in this binding. @@ -129,7 +129,7 @@ Get the number of input/output paths in this binding. .. rst-class:: classref-method -:ref:`bool` **has_path** **(** :ref:`String` path **)** |const| +:ref:`bool` **has_path**\ (\ path\: :ref:`String`\ ) |const| Returns ``true`` if this input/output path is part of this binding. @@ -141,7 +141,7 @@ Returns ``true`` if this input/output path is part of this binding. .. rst-class:: classref-method -void **remove_path** **(** :ref:`String` path **)** +|void| **remove_path**\ (\ path\: :ref:`String`\ ) Removes this input/output path from this binding. @@ -152,3 +152,4 @@ Removes this input/output path from this binding. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_optimizedtranslation.rst b/classes/class_optimizedtranslation.rst index e404d60ac74..d30e0ed31ee 100644 --- a/classes/class_optimizedtranslation.rst +++ b/classes/class_optimizedtranslation.rst @@ -29,9 +29,9 @@ Methods .. table:: :widths: auto - +------+--------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`generate` **(** :ref:`Translation` from **)** | - +------+--------------------------------------------------------------------------------------------------------------------+ + +--------+-----------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`generate`\ (\ from\: :ref:`Translation`\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -46,7 +46,7 @@ Method Descriptions .. rst-class:: classref-method -void **generate** **(** :ref:`Translation` from **)** +|void| **generate**\ (\ from\: :ref:`Translation`\ ) Generates and sets an optimized translation from the given :ref:`Translation` resource. @@ -57,3 +57,4 @@ Generates and sets an optimized translation from the given :ref:`Translation` **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1 **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1 **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_separator` **(** :ref:`String` text="" **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_item_icon` **(** :ref:`int` idx **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PopupMenu` | :ref:`get_popup` **(** **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selectable_item` **(** :ref:`bool` from_last=false **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selected_id` **(** **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_selected_metadata` **(** **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_selectable_items` **(** **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` idx **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_item` **(** :ref:`int` idx **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`select` **(** :ref:`int` idx **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_disable_shortcuts` **(** :ref:`bool` disabled **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture2D` texture **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`show_popup` **(** **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1\ ) | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1\ ) | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_separator`\ (\ text\: :ref:`String` = ""\ ) | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_item_icon`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_id`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_index`\ (\ id\: :ref:`int`\ ) |const| | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_item_metadata`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_text`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_tooltip`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PopupMenu` | :ref:`get_popup`\ (\ ) |const| | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selectable_item`\ (\ from_last\: :ref:`bool` = false\ ) |const| | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selected_id`\ (\ ) |const| | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_selected_metadata`\ (\ ) |const| | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_selectable_items`\ (\ ) |const| | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_disabled`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_separator`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_item`\ (\ idx\: :ref:`int`\ ) | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select`\ (\ idx\: :ref:`int`\ ) | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_disable_shortcuts`\ (\ disabled\: :ref:`bool`\ ) | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_disabled`\ (\ idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon`\ (\ idx\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_id`\ (\ idx\: :ref:`int`, id\: :ref:`int`\ ) | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_metadata`\ (\ idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_text`\ (\ idx\: :ref:`int`, text\: :ref:`String`\ ) | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_tooltip`\ (\ idx\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`show_popup`\ (\ ) | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -144,7 +147,7 @@ Signals .. rst-class:: classref-signal -**item_focused** **(** :ref:`int` index **)** +**item_focused**\ (\ index\: :ref:`int`\ ) Emitted when the user navigates to an item using the :ref:`ProjectSettings.input/ui_up` or :ref:`ProjectSettings.input/ui_down` input actions. The index of the item selected is passed as argument. @@ -156,7 +159,7 @@ Emitted when the user navigates to an item using the :ref:`ProjectSettings.input .. rst-class:: classref-signal -**item_selected** **(** :ref:`int` index **)** +**item_selected**\ (\ index\: :ref:`int`\ ) Emitted when the current item has been changed by the user. The index of the item selected is passed as argument. @@ -179,8 +182,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_allow_reselect** **(** :ref:`bool` value **)** -- :ref:`bool` **get_allow_reselect** **(** **)** +- |void| **set_allow_reselect**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_allow_reselect**\ (\ ) If ``true``, the currently selected item can be selected again. @@ -196,8 +199,8 @@ If ``true``, the currently selected item can be selected again. .. rst-class:: classref-property-setget -- void **set_fit_to_longest_item** **(** :ref:`bool` value **)** -- :ref:`bool` **is_fit_to_longest_item** **(** **)** +- |void| **set_fit_to_longest_item**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_fit_to_longest_item**\ (\ ) If ``true``, minimum size will be determined by the longest item's text, instead of the currently selected one's. @@ -215,8 +218,8 @@ If ``true``, minimum size will be determined by the longest item's text, instead .. rst-class:: classref-property-setget -- void **set_item_count** **(** :ref:`int` value **)** -- :ref:`int` **get_item_count** **(** **)** +- |void| **set_item_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_item_count**\ (\ ) The number of items to select from. @@ -232,7 +235,7 @@ The number of items to select from. .. rst-class:: classref-property-setget -- :ref:`int` **get_selected** **(** **)** +- :ref:`int` **get_selected**\ (\ ) The index of the currently selected item, or ``-1`` if no item is selected. @@ -249,7 +252,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_icon_item** **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1 **)** +|void| **add_icon_item**\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1\ ) Adds an item, with a ``texture`` icon, text ``label`` and (optionally) ``id``. If no ``id`` is passed, the item index will be used as the item's ID. New items are appended at the end. @@ -261,7 +264,7 @@ Adds an item, with a ``texture`` icon, text ``label`` and (optionally) ``id``. I .. rst-class:: classref-method -void **add_item** **(** :ref:`String` label, :ref:`int` id=-1 **)** +|void| **add_item**\ (\ label\: :ref:`String`, id\: :ref:`int` = -1\ ) Adds an item, with text ``label`` and (optionally) ``id``. If no ``id`` is passed, the item index will be used as the item's ID. New items are appended at the end. @@ -273,7 +276,7 @@ Adds an item, with text ``label`` and (optionally) ``id``. If no ``id`` is passe .. rst-class:: classref-method -void **add_separator** **(** :ref:`String` text="" **)** +|void| **add_separator**\ (\ text\: :ref:`String` = ""\ ) Adds a separator to the list of items. Separators help to group items, and can optionally be given a ``text`` header. A separator also gets an index assigned, and is appended at the end of the item list. @@ -285,7 +288,7 @@ Adds a separator to the list of items. Separators help to group items, and can o .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears all the items in the **OptionButton**. @@ -297,7 +300,7 @@ Clears all the items in the **OptionButton**. .. rst-class:: classref-method -:ref:`Texture2D` **get_item_icon** **(** :ref:`int` idx **)** |const| +:ref:`Texture2D` **get_item_icon**\ (\ idx\: :ref:`int`\ ) |const| Returns the icon of the item at index ``idx``. @@ -309,7 +312,7 @@ Returns the icon of the item at index ``idx``. .. rst-class:: classref-method -:ref:`int` **get_item_id** **(** :ref:`int` idx **)** |const| +:ref:`int` **get_item_id**\ (\ idx\: :ref:`int`\ ) |const| Returns the ID of the item at index ``idx``. @@ -321,7 +324,7 @@ Returns the ID of the item at index ``idx``. .. rst-class:: classref-method -:ref:`int` **get_item_index** **(** :ref:`int` id **)** |const| +:ref:`int` **get_item_index**\ (\ id\: :ref:`int`\ ) |const| Returns the index of the item with the given ``id``. @@ -333,7 +336,7 @@ Returns the index of the item with the given ``id``. .. rst-class:: classref-method -:ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** |const| +:ref:`Variant` **get_item_metadata**\ (\ idx\: :ref:`int`\ ) |const| Retrieves the metadata of an item. Metadata may be any type and can be used to store extra information about an item, such as an external string ID. @@ -345,7 +348,7 @@ Retrieves the metadata of an item. Metadata may be any type and can be used to s .. rst-class:: classref-method -:ref:`String` **get_item_text** **(** :ref:`int` idx **)** |const| +:ref:`String` **get_item_text**\ (\ idx\: :ref:`int`\ ) |const| Returns the text of the item at index ``idx``. @@ -357,7 +360,7 @@ Returns the text of the item at index ``idx``. .. rst-class:: classref-method -:ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** |const| +:ref:`String` **get_item_tooltip**\ (\ idx\: :ref:`int`\ ) |const| Returns the tooltip of the item at index ``idx``. @@ -369,7 +372,7 @@ Returns the tooltip of the item at index ``idx``. .. rst-class:: classref-method -:ref:`PopupMenu` **get_popup** **(** **)** |const| +:ref:`PopupMenu` **get_popup**\ (\ ) |const| Returns the :ref:`PopupMenu` contained in this button. @@ -383,7 +386,7 @@ Returns the :ref:`PopupMenu` contained in this button. .. rst-class:: classref-method -:ref:`int` **get_selectable_item** **(** :ref:`bool` from_last=false **)** |const| +:ref:`int` **get_selectable_item**\ (\ from_last\: :ref:`bool` = false\ ) |const| Returns the index of the first item which is not disabled, or marked as a separator. If ``from_last`` is ``true``, the items will be searched in reverse order. @@ -397,7 +400,7 @@ Returns ``-1`` if no item is found. .. rst-class:: classref-method -:ref:`int` **get_selected_id** **(** **)** |const| +:ref:`int` **get_selected_id**\ (\ ) |const| Returns the ID of the selected item, or ``-1`` if no item is selected. @@ -409,7 +412,7 @@ Returns the ID of the selected item, or ``-1`` if no item is selected. .. rst-class:: classref-method -:ref:`Variant` **get_selected_metadata** **(** **)** |const| +:ref:`Variant` **get_selected_metadata**\ (\ ) |const| Gets the metadata of the selected item. Metadata for items can be set using :ref:`set_item_metadata`. @@ -421,7 +424,7 @@ Gets the metadata of the selected item. Metadata for items can be set using :ref .. rst-class:: classref-method -:ref:`bool` **has_selectable_items** **(** **)** |const| +:ref:`bool` **has_selectable_items**\ (\ ) |const| Returns ``true`` if this button contains at least one item which is not disabled, or marked as a separator. @@ -433,7 +436,7 @@ Returns ``true`` if this button contains at least one item which is not disabled .. rst-class:: classref-method -:ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** |const| +:ref:`bool` **is_item_disabled**\ (\ idx\: :ref:`int`\ ) |const| Returns ``true`` if the item at index ``idx`` is disabled. @@ -445,7 +448,7 @@ Returns ``true`` if the item at index ``idx`` is disabled. .. rst-class:: classref-method -:ref:`bool` **is_item_separator** **(** :ref:`int` idx **)** |const| +:ref:`bool` **is_item_separator**\ (\ idx\: :ref:`int`\ ) |const| Returns ``true`` if the item at index ``idx`` is marked as a separator. @@ -457,7 +460,7 @@ Returns ``true`` if the item at index ``idx`` is marked as a separator. .. rst-class:: classref-method -void **remove_item** **(** :ref:`int` idx **)** +|void| **remove_item**\ (\ idx\: :ref:`int`\ ) Removes the item at index ``idx``. @@ -469,7 +472,7 @@ Removes the item at index ``idx``. .. rst-class:: classref-method -void **select** **(** :ref:`int` idx **)** +|void| **select**\ (\ idx\: :ref:`int`\ ) Selects an item by index and makes it the current item. This will work even if the item is disabled. @@ -483,7 +486,7 @@ Passing ``-1`` as the index deselects any currently selected item. .. rst-class:: classref-method -void **set_disable_shortcuts** **(** :ref:`bool` disabled **)** +|void| **set_disable_shortcuts**\ (\ disabled\: :ref:`bool`\ ) If ``true``, shortcuts are disabled and cannot be used to trigger the button. @@ -495,7 +498,7 @@ If ``true``, shortcuts are disabled and cannot be used to trigger the button. .. rst-class:: classref-method -void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** +|void| **set_item_disabled**\ (\ idx\: :ref:`int`, disabled\: :ref:`bool`\ ) Sets whether the item at index ``idx`` is disabled. @@ -509,7 +512,7 @@ Disabled items are drawn differently in the dropdown and are not selectable by t .. rst-class:: classref-method -void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture2D` texture **)** +|void| **set_item_icon**\ (\ idx\: :ref:`int`, texture\: :ref:`Texture2D`\ ) Sets the icon of the item at index ``idx``. @@ -521,7 +524,7 @@ Sets the icon of the item at index ``idx``. .. rst-class:: classref-method -void **set_item_id** **(** :ref:`int` idx, :ref:`int` id **)** +|void| **set_item_id**\ (\ idx\: :ref:`int`, id\: :ref:`int`\ ) Sets the ID of the item at index ``idx``. @@ -533,7 +536,7 @@ Sets the ID of the item at index ``idx``. .. rst-class:: classref-method -void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** +|void| **set_item_metadata**\ (\ idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) Sets the metadata of an item. Metadata may be of any type and can be used to store extra information about an item, such as an external string ID. @@ -545,7 +548,7 @@ Sets the metadata of an item. Metadata may be of any type and can be used to sto .. rst-class:: classref-method -void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** +|void| **set_item_text**\ (\ idx\: :ref:`int`, text\: :ref:`String`\ ) Sets the text of the item at index ``idx``. @@ -557,7 +560,7 @@ Sets the text of the item at index ``idx``. .. rst-class:: classref-method -void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** +|void| **set_item_tooltip**\ (\ idx\: :ref:`int`, tooltip\: :ref:`String`\ ) Sets the tooltip of the item at index ``idx``. @@ -569,7 +572,7 @@ Sets the tooltip of the item at index ``idx``. .. rst-class:: classref-method -void **show_popup** **(** **)** +|void| **show_popup**\ (\ ) Adjusts popup position and sizing for the **OptionButton**, then shows the :ref:`PopupMenu`. Prefer this over using ``get_popup().popup()``. @@ -621,3 +624,4 @@ The arrow icon to be drawn on the right end of the button. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_ormmaterial3d.rst b/classes/class_ormmaterial3d.rst index d4d90b5ba9e..be989b52dc0 100644 --- a/classes/class_ormmaterial3d.rst +++ b/classes/class_ormmaterial3d.rst @@ -35,3 +35,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_os.rst b/classes/class_os.rst index d9c5e4978f2..2d554371fd8 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -54,135 +54,135 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`alert` **(** :ref:`String` text, :ref:`String` title="Alert!" **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`close_midi_inputs` **(** **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`crash` **(** :ref:`String` message **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`create_instance` **(** :ref:`PackedStringArray` arguments **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`create_process` **(** :ref:`String` path, :ref:`PackedStringArray` arguments, :ref:`bool` open_console=false **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`delay_msec` **(** :ref:`int` msec **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`delay_usec` **(** :ref:`int` usec **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PackedStringArray` arguments, :ref:`Array` output=[], :ref:`bool` read_stderr=false, :ref:`bool` open_console=false **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Key` | :ref:`find_keycode_from_string` **(** :ref:`String` string **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_cache_dir` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_cmdline_args` **(** **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_cmdline_user_args` **(** **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_config_dir` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_connected_midi_inputs` **(** **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_data_dir` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_distribution_name` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_environment` **(** :ref:`String` variable **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_executable_path` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_granted_permissions` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_keycode_string` **(** :ref:`Key` code **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_locale` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_locale_language` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_main_thread_id` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_memory_info` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_model_name` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_name` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_process_id` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_processor_count` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_processor_name` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_restart_on_exit_arguments` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_static_memory_peak_usage` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_static_memory_usage` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_system_dir` **(** :ref:`SystemDir` dir, :ref:`bool` shared_storage=true **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_system_font_path` **(** :ref:`String` font_name, :ref:`int` weight=400, :ref:`int` stretch=100, :ref:`bool` italic=false **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_system_font_path_for_text` **(** :ref:`String` font_name, :ref:`String` text, :ref:`String` locale="", :ref:`String` script="", :ref:`int` weight=400, :ref:`int` stretch=100, :ref:`bool` italic=false **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_system_fonts` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_thread_caller_id` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_unique_id` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_user_data_dir` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_version` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_video_adapter_driver_info` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_environment` **(** :ref:`String` variable **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_feature` **(** :ref:`String` tag_name **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_debug_build` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_keycode_unicode` **(** :ref:`int` code **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_process_running` **(** :ref:`int` pid **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_restart_on_exit_set` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_sandboxed` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_stdout_verbose` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_userfs_persistent` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`kill` **(** :ref:`int` pid **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`move_to_trash` **(** :ref:`String` path **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`open_midi_inputs` **(** **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`read_string_from_stdin` **(** **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`request_permission` **(** :ref:`String` name **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`request_permissions` **(** **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`revoke_granted_permissions` **(** **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_environment` **(** :ref:`String` variable, :ref:`String` value **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_restart_on_exit` **(** :ref:`bool` restart, :ref:`PackedStringArray` arguments=PackedStringArray() **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`set_thread_name` **(** :ref:`String` name **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_use_file_access_save_and_swap` **(** :ref:`bool` enabled **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`shell_open` **(** :ref:`String` uri **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`shell_show_in_file_manager` **(** :ref:`String` file_or_dir_path, :ref:`bool` open_folder=true **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`unset_environment` **(** :ref:`String` variable **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`alert`\ (\ text\: :ref:`String`, title\: :ref:`String` = "Alert!"\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`close_midi_inputs`\ (\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`crash`\ (\ message\: :ref:`String`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`create_instance`\ (\ arguments\: :ref:`PackedStringArray`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`create_process`\ (\ path\: :ref:`String`, arguments\: :ref:`PackedStringArray`, open_console\: :ref:`bool` = false\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`delay_msec`\ (\ msec\: :ref:`int`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`delay_usec`\ (\ usec\: :ref:`int`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`execute`\ (\ path\: :ref:`String`, arguments\: :ref:`PackedStringArray`, output\: :ref:`Array` = [], read_stderr\: :ref:`bool` = false, open_console\: :ref:`bool` = false\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Key` | :ref:`find_keycode_from_string`\ (\ string\: :ref:`String`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_cache_dir`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_cmdline_args`\ (\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_cmdline_user_args`\ (\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_config_dir`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_connected_midi_inputs`\ (\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_data_dir`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_distribution_name`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_environment`\ (\ variable\: :ref:`String`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_executable_path`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_granted_permissions`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_keycode_string`\ (\ code\: :ref:`Key`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_locale`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_locale_language`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_main_thread_id`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_memory_info`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_model_name`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_name`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_process_id`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_processor_count`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_processor_name`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_restart_on_exit_arguments`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_static_memory_peak_usage`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_static_memory_usage`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_system_dir`\ (\ dir\: :ref:`SystemDir`, shared_storage\: :ref:`bool` = true\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_system_font_path`\ (\ font_name\: :ref:`String`, weight\: :ref:`int` = 400, stretch\: :ref:`int` = 100, italic\: :ref:`bool` = false\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_system_font_path_for_text`\ (\ font_name\: :ref:`String`, text\: :ref:`String`, locale\: :ref:`String` = "", script\: :ref:`String` = "", weight\: :ref:`int` = 400, stretch\: :ref:`int` = 100, italic\: :ref:`bool` = false\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_system_fonts`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_thread_caller_id`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_unique_id`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_user_data_dir`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_version`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_video_adapter_driver_info`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_environment`\ (\ variable\: :ref:`String`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_feature`\ (\ tag_name\: :ref:`String`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_debug_build`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_keycode_unicode`\ (\ code\: :ref:`int`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_process_running`\ (\ pid\: :ref:`int`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_restart_on_exit_set`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_sandboxed`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_stdout_verbose`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_userfs_persistent`\ (\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`kill`\ (\ pid\: :ref:`int`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`move_to_trash`\ (\ path\: :ref:`String`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`open_midi_inputs`\ (\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`read_string_from_stdin`\ (\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`request_permission`\ (\ name\: :ref:`String`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`request_permissions`\ (\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`revoke_granted_permissions`\ (\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_environment`\ (\ variable\: :ref:`String`, value\: :ref:`String`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_restart_on_exit`\ (\ restart\: :ref:`bool`, arguments\: :ref:`PackedStringArray` = PackedStringArray()\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`set_thread_name`\ (\ name\: :ref:`String`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_use_file_access_save_and_swap`\ (\ enabled\: :ref:`bool`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`shell_open`\ (\ uri\: :ref:`String`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`shell_show_in_file_manager`\ (\ file_or_dir_path\: :ref:`String`, open_folder\: :ref:`bool` = true\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unset_environment`\ (\ variable\: :ref:`String`\ ) |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -314,8 +314,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_delta_smoothing** **(** :ref:`bool` value **)** -- :ref:`bool` **is_delta_smoothing_enabled** **(** **)** +- |void| **set_delta_smoothing**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_delta_smoothing_enabled**\ (\ ) If ``true``, the engine filters the time delta measured between each frame, and attempts to compensate for random variation. This only works on systems where V-Sync is active. @@ -333,8 +333,8 @@ If ``true``, the engine filters the time delta measured between each frame, and .. rst-class:: classref-property-setget -- void **set_low_processor_usage_mode** **(** :ref:`bool` value **)** -- :ref:`bool` **is_in_low_processor_usage_mode** **(** **)** +- |void| **set_low_processor_usage_mode**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_in_low_processor_usage_mode**\ (\ ) If ``true``, the engine optimizes for low processor usage by only refreshing the screen if needed. Can improve battery consumption on mobile. @@ -352,8 +352,8 @@ If ``true``, the engine optimizes for low processor usage by only refreshing the .. rst-class:: classref-property-setget -- void **set_low_processor_usage_mode_sleep_usec** **(** :ref:`int` value **)** -- :ref:`int` **get_low_processor_usage_mode_sleep_usec** **(** **)** +- |void| **set_low_processor_usage_mode_sleep_usec**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_low_processor_usage_mode_sleep_usec**\ (\ ) The amount of sleeping between frames when the low-processor usage mode is enabled, in microseconds. Higher values will result in lower CPU usage. See also :ref:`low_processor_usage_mode`. @@ -372,7 +372,7 @@ Method Descriptions .. rst-class:: classref-method -void **alert** **(** :ref:`String` text, :ref:`String` title="Alert!" **)** +|void| **alert**\ (\ text\: :ref:`String`, title\: :ref:`String` = "Alert!"\ ) Displays a modal dialog box using the host platform's implementation. The engine execution is blocked until the dialog is closed. @@ -384,7 +384,7 @@ Displays a modal dialog box using the host platform's implementation. The engine .. rst-class:: classref-method -void **close_midi_inputs** **(** **)** +|void| **close_midi_inputs**\ (\ ) Shuts down the system MIDI driver. Godot will no longer receive :ref:`InputEventMIDI`. See also :ref:`open_midi_inputs` and :ref:`get_connected_midi_inputs`. @@ -398,7 +398,7 @@ Shuts down the system MIDI driver. Godot will no longer receive :ref:`InputEvent .. rst-class:: classref-method -void **crash** **(** :ref:`String` message **)** +|void| **crash**\ (\ message\: :ref:`String`\ ) Crashes the engine (or the editor if called within a ``@tool`` script). See also :ref:`kill`. @@ -412,7 +412,7 @@ Crashes the engine (or the editor if called within a ``@tool`` script). See also .. rst-class:: classref-method -:ref:`int` **create_instance** **(** :ref:`PackedStringArray` arguments **)** +:ref:`int` **create_instance**\ (\ arguments\: :ref:`PackedStringArray`\ ) Creates a new instance of Godot that runs independently. The ``arguments`` are used in the given order and separated by a space. @@ -430,7 +430,7 @@ See :ref:`create_process` if you wish to run a d .. rst-class:: classref-method -:ref:`int` **create_process** **(** :ref:`String` path, :ref:`PackedStringArray` arguments, :ref:`bool` open_console=false **)** +:ref:`int` **create_process**\ (\ path\: :ref:`String`, arguments\: :ref:`PackedStringArray`, open_console\: :ref:`bool` = false\ ) Creates a new process that runs independently of Godot. It will not terminate when Godot terminates. The path specified in ``path`` must exist and be executable file or macOS .app bundle. Platform path resolution will be used. The ``arguments`` are used in the given order and separated by a space. @@ -467,7 +467,7 @@ See :ref:`execute` if you wish to run an external comma .. rst-class:: classref-method -void **delay_msec** **(** :ref:`int` msec **)** |const| +|void| **delay_msec**\ (\ msec\: :ref:`int`\ ) |const| Delays execution of the current thread by ``msec`` milliseconds. ``msec`` must be greater than or equal to ``0``. Otherwise, :ref:`delay_msec` does nothing and prints an error message. @@ -483,7 +483,7 @@ Delays execution of the current thread by ``msec`` milliseconds. ``msec`` must b .. rst-class:: classref-method -void **delay_usec** **(** :ref:`int` usec **)** |const| +|void| **delay_usec**\ (\ usec\: :ref:`int`\ ) |const| Delays execution of the current thread by ``usec`` microseconds. ``usec`` must be greater than or equal to ``0``. Otherwise, :ref:`delay_usec` does nothing and prints an error message. @@ -499,7 +499,7 @@ Delays execution of the current thread by ``usec`` microseconds. ``usec`` must b .. rst-class:: classref-method -:ref:`int` **execute** **(** :ref:`String` path, :ref:`PackedStringArray` arguments, :ref:`Array` output=[], :ref:`bool` read_stderr=false, :ref:`bool` open_console=false **)** +:ref:`int` **execute**\ (\ path\: :ref:`String`, arguments\: :ref:`PackedStringArray`, output\: :ref:`Array` = [], read_stderr\: :ref:`bool` = false, open_console\: :ref:`bool` = false\ ) Executes the given process in a *blocking* way. The file specified in ``path`` must exist and be executable. The system path resolution will be used. The ``arguments`` are used in the given order, separated by spaces, and wrapped in quotes. @@ -565,7 +565,7 @@ If you wish to access a shell built-in or execute a composite command, a platfor .. rst-class:: classref-method -:ref:`Key` **find_keycode_from_string** **(** :ref:`String` string **)** |const| +:ref:`Key` **find_keycode_from_string**\ (\ string\: :ref:`String`\ ) |const| Finds the keycode for the given string. The returned values are equivalent to the :ref:`Key` constants. @@ -598,7 +598,7 @@ See also :ref:`get_keycode_string`. .. rst-class:: classref-method -:ref:`String` **get_cache_dir** **(** **)** |const| +:ref:`String` **get_cache_dir**\ (\ ) |const| Returns the *global* cache data directory according to the operating system's standards. @@ -614,7 +614,7 @@ Not to be confused with :ref:`get_user_data_dir` **get_cmdline_args** **(** **)** +:ref:`PackedStringArray` **get_cmdline_args**\ (\ ) Returns the command-line arguments passed to the engine. @@ -671,7 +671,7 @@ Here's a minimal example on how to parse command-line arguments into a :ref:`Dic .. rst-class:: classref-method -:ref:`PackedStringArray` **get_cmdline_user_args** **(** **)** +:ref:`PackedStringArray` **get_cmdline_user_args**\ (\ ) Returns the command-line user arguments passed to the engine. User arguments are ignored by the engine and reserved for the user. They are passed after the double dash ``--`` argument. ``++`` may be used when ``--`` is intercepted by another program (such as ``startx``). @@ -693,7 +693,7 @@ To get all passed arguments, use :ref:`get_cmdline_args` **get_config_dir** **(** **)** |const| +:ref:`String` **get_config_dir**\ (\ ) |const| Returns the *global* user configuration directory according to the operating system's standards. @@ -709,7 +709,7 @@ Not to be confused with :ref:`get_user_data_dir` **get_connected_midi_inputs** **(** **)** +:ref:`PackedStringArray` **get_connected_midi_inputs**\ (\ ) Returns an array of connected MIDI device names, if they exist. Returns an empty array if the system MIDI driver has not previously been initialized with :ref:`open_midi_inputs`. See also :ref:`close_midi_inputs`. @@ -723,7 +723,7 @@ Returns an array of connected MIDI device names, if they exist. Returns an empty .. rst-class:: classref-method -:ref:`String` **get_data_dir** **(** **)** |const| +:ref:`String` **get_data_dir**\ (\ ) |const| Returns the *global* user data directory according to the operating system's standards. @@ -739,7 +739,7 @@ Not to be confused with :ref:`get_user_data_dir` **get_distribution_name** **(** **)** |const| +:ref:`String` **get_distribution_name**\ (\ ) |const| Returns the name of the distribution for Linux and BSD platforms (e.g. "Ubuntu", "Manjaro", "OpenBSD", etc.). @@ -757,7 +757,7 @@ Returns the same value as :ref:`get_name` for other pl .. rst-class:: classref-method -:ref:`String` **get_environment** **(** :ref:`String` variable **)** |const| +:ref:`String` **get_environment**\ (\ variable\: :ref:`String`\ ) |const| Returns the value of the given environment variable, or an empty string if ``variable`` doesn't exist. @@ -773,7 +773,7 @@ Returns the value of the given environment variable, or an empty string if ``var .. rst-class:: classref-method -:ref:`String` **get_executable_path** **(** **)** |const| +:ref:`String` **get_executable_path**\ (\ ) |const| Returns the file path to the current engine executable. @@ -787,7 +787,7 @@ Returns the file path to the current engine executable. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_granted_permissions** **(** **)** |const| +:ref:`PackedStringArray` **get_granted_permissions**\ (\ ) |const| On Android devices: Returns the list of dangerous permissions that have been granted. @@ -801,7 +801,7 @@ On macOS: Returns the list of user selected folders accessible to the applicatio .. rst-class:: classref-method -:ref:`String` **get_keycode_string** **(** :ref:`Key` code **)** |const| +:ref:`String` **get_keycode_string**\ (\ code\: :ref:`Key`\ ) |const| Returns the given keycode as a :ref:`String`. @@ -832,7 +832,7 @@ See also :ref:`find_keycode_from_string` **get_locale** **(** **)** |const| +:ref:`String` **get_locale**\ (\ ) |const| Returns the host OS locale as a :ref:`String` of the form ``language_Script_COUNTRY_VARIANT@extra``. Every substring after ``language`` is optional and may not exist. @@ -856,7 +856,7 @@ If you want only the language code and not the fully specified locale from the O .. rst-class:: classref-method -:ref:`String` **get_locale_language** **(** **)** |const| +:ref:`String` **get_locale_language**\ (\ ) |const| Returns the host OS locale's 2 or 3-letter `language code `__ as a string which should be consistent on all platforms. This is equivalent to extracting the ``language`` part of the :ref:`get_locale` string. @@ -870,7 +870,7 @@ This can be used to narrow down fully specified locale strings to only the "comm .. rst-class:: classref-method -:ref:`int` **get_main_thread_id** **(** **)** |const| +:ref:`int` **get_main_thread_id**\ (\ ) |const| Returns the ID of the main thread. See :ref:`get_thread_caller_id`. @@ -884,7 +884,7 @@ Returns the ID of the main thread. See :ref:`get_thread_caller_id` **get_memory_info** **(** **)** |const| +:ref:`Dictionary` **get_memory_info**\ (\ ) |const| Returns a :ref:`Dictionary` containing information about the current memory with the following entries: @@ -906,7 +906,7 @@ Returns a :ref:`Dictionary` containing information about the c .. rst-class:: classref-method -:ref:`String` **get_model_name** **(** **)** |const| +:ref:`String` **get_model_name**\ (\ ) |const| Returns the model name of the current device. @@ -920,7 +920,7 @@ Returns the model name of the current device. .. rst-class:: classref-method -:ref:`String` **get_name** **(** **)** |const| +:ref:`String` **get_name**\ (\ ) |const| Returns the name of the host platform. @@ -999,7 +999,7 @@ Returns the name of the host platform. .. rst-class:: classref-method -:ref:`int` **get_process_id** **(** **)** |const| +:ref:`int` **get_process_id**\ (\ ) |const| Returns the number used by the host machine to uniquely identify this application. @@ -1013,7 +1013,7 @@ Returns the number used by the host machine to uniquely identify this applicatio .. rst-class:: classref-method -:ref:`int` **get_processor_count** **(** **)** |const| +:ref:`int` **get_processor_count**\ (\ ) |const| Returns the number of *logical* CPU cores available on the host machine. On CPUs with HyperThreading enabled, this number will be greater than the number of *physical* CPU cores. @@ -1025,7 +1025,7 @@ Returns the number of *logical* CPU cores available on the host machine. On CPUs .. rst-class:: classref-method -:ref:`String` **get_processor_name** **(** **)** |const| +:ref:`String` **get_processor_name**\ (\ ) |const| Returns the full name of the CPU model on the host machine (e.g. ``"Intel(R) Core(TM) i7-6700K CPU @ 4.00GHz"``). @@ -1039,7 +1039,7 @@ Returns the full name of the CPU model on the host machine (e.g. ``"Intel(R) Cor .. rst-class:: classref-method -:ref:`PackedStringArray` **get_restart_on_exit_arguments** **(** **)** |const| +:ref:`PackedStringArray` **get_restart_on_exit_arguments**\ (\ ) |const| Returns the list of command line arguments that will be used when the project automatically restarts using :ref:`set_restart_on_exit`. See also :ref:`is_restart_on_exit_set`. @@ -1051,7 +1051,7 @@ Returns the list of command line arguments that will be used when the project au .. rst-class:: classref-method -:ref:`int` **get_static_memory_peak_usage** **(** **)** |const| +:ref:`int` **get_static_memory_peak_usage**\ (\ ) |const| Returns the maximum amount of static memory used. Only works in debug builds. @@ -1063,7 +1063,7 @@ Returns the maximum amount of static memory used. Only works in debug builds. .. rst-class:: classref-method -:ref:`int` **get_static_memory_usage** **(** **)** |const| +:ref:`int` **get_static_memory_usage**\ (\ ) |const| Returns the amount of static memory being used by the program in bytes. Only works in debug builds. @@ -1075,7 +1075,7 @@ Returns the amount of static memory being used by the program in bytes. Only wor .. rst-class:: classref-method -:ref:`String` **get_system_dir** **(** :ref:`SystemDir` dir, :ref:`bool` shared_storage=true **)** |const| +:ref:`String` **get_system_dir**\ (\ dir\: :ref:`SystemDir`, shared_storage\: :ref:`bool` = true\ ) |const| Returns the path to commonly used folders across different platforms, as defined by ``dir``. See the :ref:`SystemDir` constants for available locations. @@ -1091,7 +1091,7 @@ Returns the path to commonly used folders across different platforms, as defined .. rst-class:: classref-method -:ref:`String` **get_system_font_path** **(** :ref:`String` font_name, :ref:`int` weight=400, :ref:`int` stretch=100, :ref:`bool` italic=false **)** |const| +:ref:`String` **get_system_font_path**\ (\ font_name\: :ref:`String`, weight\: :ref:`int` = 400, stretch\: :ref:`int` = 100, italic\: :ref:`bool` = false\ ) |const| Returns the path to the system font file with ``font_name`` and style. Returns an empty string if no matching fonts found. @@ -1109,7 +1109,7 @@ The following aliases can be used to request default fonts: "sans-serif", "serif .. rst-class:: classref-method -:ref:`PackedStringArray` **get_system_font_path_for_text** **(** :ref:`String` font_name, :ref:`String` text, :ref:`String` locale="", :ref:`String` script="", :ref:`int` weight=400, :ref:`int` stretch=100, :ref:`bool` italic=false **)** |const| +:ref:`PackedStringArray` **get_system_font_path_for_text**\ (\ font_name\: :ref:`String`, text\: :ref:`String`, locale\: :ref:`String` = "", script\: :ref:`String` = "", weight\: :ref:`int` = 400, stretch\: :ref:`int` = 100, italic\: :ref:`bool` = false\ ) |const| Returns an array of the system substitute font file paths, which are similar to the font with ``font_name`` and style for the specified text, locale, and script. Returns an empty array if no matching fonts found. @@ -1129,7 +1129,7 @@ The following aliases can be used to request default fonts: "sans-serif", "serif .. rst-class:: classref-method -:ref:`PackedStringArray` **get_system_fonts** **(** **)** |const| +:ref:`PackedStringArray` **get_system_fonts**\ (\ ) |const| Returns the list of font family names available. @@ -1143,7 +1143,7 @@ Returns the list of font family names available. .. rst-class:: classref-method -:ref:`int` **get_thread_caller_id** **(** **)** |const| +:ref:`int` **get_thread_caller_id**\ (\ ) |const| Returns the ID of the current thread. This can be used in logs to ease debugging of multi-threaded applications. @@ -1157,7 +1157,7 @@ Returns the ID of the current thread. This can be used in logs to ease debugging .. rst-class:: classref-method -:ref:`String` **get_unique_id** **(** **)** |const| +:ref:`String` **get_unique_id**\ (\ ) |const| Returns a string that is unique to the device. @@ -1173,7 +1173,7 @@ Returns a string that is unique to the device. .. rst-class:: classref-method -:ref:`String` **get_user_data_dir** **(** **)** |const| +:ref:`String` **get_user_data_dir**\ (\ ) |const| Returns the absolute directory path where user data is written (the ``user://`` directory in Godot). The path depends on the project name and :ref:`ProjectSettings.application/config/use_custom_user_dir`. @@ -1199,7 +1199,7 @@ Not to be confused with :ref:`get_data_dir`, which .. rst-class:: classref-method -:ref:`String` **get_version** **(** **)** |const| +:ref:`String` **get_version**\ (\ ) |const| Returns the exact production and build version of the operating system. This is different from the branded version used in marketing. This helps to distinguish between different releases of operating systems, including minor versions, and insider and custom builds. @@ -1221,7 +1221,7 @@ Returns the exact production and build version of the operating system. This is .. rst-class:: classref-method -:ref:`PackedStringArray` **get_video_adapter_driver_info** **(** **)** |const| +:ref:`PackedStringArray` **get_video_adapter_driver_info**\ (\ ) |const| Returns the video adapter driver name and version for the user's currently active graphics card, as a :ref:`PackedStringArray`. See also :ref:`RenderingServer.get_video_adapter_api_version`. @@ -1239,7 +1239,7 @@ The second element holds the driver version. For example, on the ``nvidia`` driv .. rst-class:: classref-method -:ref:`bool` **has_environment** **(** :ref:`String` variable **)** |const| +:ref:`bool` **has_environment**\ (\ variable\: :ref:`String`\ ) |const| Returns ``true`` if the environment variable with the name ``variable`` exists. @@ -1253,7 +1253,7 @@ Returns ``true`` if the environment variable with the name ``variable`` exists. .. rst-class:: classref-method -:ref:`bool` **has_feature** **(** :ref:`String` tag_name **)** |const| +:ref:`bool` **has_feature**\ (\ tag_name\: :ref:`String`\ ) |const| Returns ``true`` if the feature for the given feature tag is supported in the currently running instance, depending on the platform, build, etc. Can be used to check whether you're currently running a debug build, on a certain platform or arch, etc. Refer to the :doc:`Feature Tags <../tutorials/export/feature_tags>` documentation for more details. @@ -1269,7 +1269,7 @@ Returns ``true`` if the feature for the given feature tag is supported in the cu .. rst-class:: classref-method -:ref:`bool` **is_debug_build** **(** **)** |const| +:ref:`bool` **is_debug_build**\ (\ ) |const| Returns ``true`` if the Godot binary used to run the project is a *debug* export template, or when running in the editor. @@ -1285,7 +1285,7 @@ Returns ``false`` if the Godot binary used to run the project is a *release* exp .. rst-class:: classref-method -:ref:`bool` **is_keycode_unicode** **(** :ref:`int` code **)** |const| +:ref:`bool` **is_keycode_unicode**\ (\ code\: :ref:`int`\ ) |const| Returns ``true`` if the input keycode corresponds to a Unicode character. For a list of codes, see the :ref:`Key` constants. @@ -1316,7 +1316,7 @@ Returns ``true`` if the input keycode corresponds to a Unicode character. For a .. rst-class:: classref-method -:ref:`bool` **is_process_running** **(** :ref:`int` pid **)** |const| +:ref:`bool` **is_process_running**\ (\ pid\: :ref:`int`\ ) |const| Returns ``true`` if the child process ID (``pid``) is still running or ``false`` if it has terminated. ``pid`` must be a valid ID generated from :ref:`create_process`. @@ -1330,7 +1330,7 @@ Returns ``true`` if the child process ID (``pid``) is still running or ``false`` .. rst-class:: classref-method -:ref:`bool` **is_restart_on_exit_set** **(** **)** |const| +:ref:`bool` **is_restart_on_exit_set**\ (\ ) |const| Returns ``true`` if the project will automatically restart when it exits for any reason, ``false`` otherwise. See also :ref:`set_restart_on_exit` and :ref:`get_restart_on_exit_arguments`. @@ -1342,7 +1342,7 @@ Returns ``true`` if the project will automatically restart when it exits for any .. rst-class:: classref-method -:ref:`bool` **is_sandboxed** **(** **)** |const| +:ref:`bool` **is_sandboxed**\ (\ ) |const| Returns ``true`` if the application is running in the sandbox. @@ -1356,7 +1356,7 @@ Returns ``true`` if the application is running in the sandbox. .. rst-class:: classref-method -:ref:`bool` **is_stdout_verbose** **(** **)** |const| +:ref:`bool` **is_stdout_verbose**\ (\ ) |const| Returns ``true`` if the engine was executed with the ``--verbose`` or ``-v`` command line argument, or if :ref:`ProjectSettings.debug/settings/stdout/verbose_stdout` is ``true``. See also :ref:`@GlobalScope.print_verbose`. @@ -1368,7 +1368,7 @@ Returns ``true`` if the engine was executed with the ``--verbose`` or ``-v`` com .. rst-class:: classref-method -:ref:`bool` **is_userfs_persistent** **(** **)** |const| +:ref:`bool` **is_userfs_persistent**\ (\ ) |const| Returns ``true`` if the ``user://`` file system is persistent, that is, its state is the same after a player quits and starts the game again. Relevant to the Web platform, where this persistence may be unavailable. @@ -1380,7 +1380,7 @@ Returns ``true`` if the ``user://`` file system is persistent, that is, its stat .. rst-class:: classref-method -:ref:`Error` **kill** **(** :ref:`int` pid **)** +:ref:`Error` **kill**\ (\ pid\: :ref:`int`\ ) Kill (terminate) the process identified by the given process ID (``pid``), such as the ID returned by :ref:`execute` in non-blocking mode. See also :ref:`crash`. @@ -1396,7 +1396,7 @@ Kill (terminate) the process identified by the given process ID (``pid``), such .. rst-class:: classref-method -:ref:`Error` **move_to_trash** **(** :ref:`String` path **)** |const| +:ref:`Error` **move_to_trash**\ (\ path\: :ref:`String`\ ) |const| Moves the file or directory at the given ``path`` to the system's recycle bin. See also :ref:`DirAccess.remove`. @@ -1431,7 +1431,7 @@ Returns :ref:`@GlobalScope.FAILED` if the fi .. rst-class:: classref-method -void **open_midi_inputs** **(** **)** +|void| **open_midi_inputs**\ (\ ) Initializes the singleton for the system MIDI driver, allowing Godot to receive :ref:`InputEventMIDI`. See also :ref:`get_connected_midi_inputs` and :ref:`close_midi_inputs`. @@ -1445,7 +1445,7 @@ Initializes the singleton for the system MIDI driver, allowing Godot to receive .. rst-class:: classref-method -:ref:`String` **read_string_from_stdin** **(** **)** +:ref:`String` **read_string_from_stdin**\ (\ ) Reads a user input string from the standard input (usually the terminal). This operation is *blocking*, which causes the window to freeze if :ref:`read_string_from_stdin` is called on the main thread. The thread calling :ref:`read_string_from_stdin` will block until the program receives a line break in standard input (usually by the user pressing :kbd:`Enter`). @@ -1461,7 +1461,7 @@ Reads a user input string from the standard input (usually the terminal). This o .. rst-class:: classref-method -:ref:`bool` **request_permission** **(** :ref:`String` name **)** +:ref:`bool` **request_permission**\ (\ name\: :ref:`String`\ ) Requests permission from the OS for the given ``name``. Returns ``true`` if the permission has been successfully granted. @@ -1475,7 +1475,7 @@ Requests permission from the OS for the given ``name``. Returns ``true`` if the .. rst-class:: classref-method -:ref:`bool` **request_permissions** **(** **)** +:ref:`bool` **request_permissions**\ (\ ) Requests *dangerous* permissions from the OS. Returns ``true`` if permissions have been successfully granted. @@ -1489,7 +1489,7 @@ Requests *dangerous* permissions from the OS. Returns ``true`` if permissions ha .. rst-class:: classref-method -void **revoke_granted_permissions** **(** **)** +|void| **revoke_granted_permissions**\ (\ ) On macOS (sandboxed applications only), this function clears list of user selected folders accessible to the application. @@ -1501,7 +1501,7 @@ On macOS (sandboxed applications only), this function clears list of user select .. rst-class:: classref-method -void **set_environment** **(** :ref:`String` variable, :ref:`String` value **)** |const| +|void| **set_environment**\ (\ variable\: :ref:`String`, value\: :ref:`String`\ ) |const| Sets the value of the environment variable ``variable`` to ``value``. The environment variable will be set for the Godot process and any process executed with :ref:`execute` after running :ref:`set_environment`. The environment variable will *not* persist to processes run after the Godot process was terminated. @@ -1515,7 +1515,7 @@ Sets the value of the environment variable ``variable`` to ``value``. The enviro .. rst-class:: classref-method -void **set_restart_on_exit** **(** :ref:`bool` restart, :ref:`PackedStringArray` arguments=PackedStringArray() **)** +|void| **set_restart_on_exit**\ (\ restart\: :ref:`bool`, arguments\: :ref:`PackedStringArray` = PackedStringArray()\ ) If ``restart`` is ``true``, restarts the project automatically when it is exited with :ref:`SceneTree.quit` or :ref:`Node.NOTIFICATION_WM_CLOSE_REQUEST`. Command-line ``arguments`` can be supplied. To restart the project with the same command line arguments as originally used to run the project, pass :ref:`get_cmdline_args` as the value for ``arguments``. @@ -1533,7 +1533,7 @@ This method can be used to apply setting changes that require a restart. See als .. rst-class:: classref-method -:ref:`Error` **set_thread_name** **(** :ref:`String` name **)** +:ref:`Error` **set_thread_name**\ (\ name\: :ref:`String`\ ) Assigns the given name to the current thread. Returns :ref:`@GlobalScope.ERR_UNAVAILABLE` if unavailable on the current platform. @@ -1545,7 +1545,7 @@ Assigns the given name to the current thread. Returns :ref:`@GlobalScope.ERR_UNA .. rst-class:: classref-method -void **set_use_file_access_save_and_swap** **(** :ref:`bool` enabled **)** +|void| **set_use_file_access_save_and_swap**\ (\ enabled\: :ref:`bool`\ ) If ``enabled`` is ``true``, when opening a file for writing, a temporary file is used in its place. When closed, it is automatically applied to the target file. @@ -1559,7 +1559,7 @@ This can useful when files may be opened by other applications, such as antiviru .. rst-class:: classref-method -:ref:`Error` **shell_open** **(** :ref:`String` uri **)** +:ref:`Error` **shell_open**\ (\ uri\: :ref:`String`\ ) Requests the OS to open a resource identified by ``uri`` with the most appropriate program. For example: @@ -1583,7 +1583,7 @@ Use :ref:`ProjectSettings.globalize_path` **shell_show_in_file_manager** **(** :ref:`String` file_or_dir_path, :ref:`bool` open_folder=true **)** +:ref:`Error` **shell_show_in_file_manager**\ (\ file_or_dir_path\: :ref:`String`, open_folder\: :ref:`bool` = true\ ) Requests the OS to open the file manager, navigate to the given ``file_or_dir_path`` and select the target file or folder. @@ -1601,7 +1601,7 @@ Use :ref:`ProjectSettings.globalize_path` variable **)** |const| +|void| **unset_environment**\ (\ variable\: :ref:`String`\ ) |const| Removes the given environment variable from the current environment, if it exists. The ``variable`` name cannot be empty or include the ``=`` character. The environment variable will be removed for the Godot process and any process executed with :ref:`execute` after running :ref:`unset_environment`. The removal of the environment variable will *not* persist to processes run after the Godot process was terminated. @@ -1614,3 +1614,4 @@ Removes the given environment variable from the current environment, if it exist .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_packedbytearray.rst b/classes/class_packedbytearray.rst index a88faac2bba..7a5333ddcfe 100644 --- a/classes/class_packedbytearray.rst +++ b/classes/class_packedbytearray.rst @@ -33,13 +33,13 @@ Constructors .. table:: :widths: auto - +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`PackedByteArray` **(** **)** | - +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`PackedByteArray` **(** :ref:`PackedByteArray` from **)** | - +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`PackedByteArray` **(** :ref:`Array` from **)** | - +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`PackedByteArray`\ (\ ) | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`PackedByteArray`\ (\ from\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`PackedByteArray`\ (\ from\: :ref:`Array`\ ) | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -49,125 +49,125 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`append` **(** :ref:`int` value **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`append_array` **(** :ref:`PackedByteArray` array **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch` **(** :ref:`int` value, :ref:`bool` before=true **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`compress` **(** :ref:`int` compression_mode=0 **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count` **(** :ref:`int` value **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`decode_double` **(** :ref:`int` byte_offset **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`decode_float` **(** :ref:`int` byte_offset **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`decode_half` **(** :ref:`int` byte_offset **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`decode_s8` **(** :ref:`int` byte_offset **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`decode_s16` **(** :ref:`int` byte_offset **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`decode_s32` **(** :ref:`int` byte_offset **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`decode_s64` **(** :ref:`int` byte_offset **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`decode_u8` **(** :ref:`int` byte_offset **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`decode_u16` **(** :ref:`int` byte_offset **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`decode_u32` **(** :ref:`int` byte_offset **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`decode_u64` **(** :ref:`int` byte_offset **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`decode_var` **(** :ref:`int` byte_offset, :ref:`bool` allow_objects=false **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`decode_var_size` **(** :ref:`int` byte_offset, :ref:`bool` allow_objects=false **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`decompress` **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`decompress_dynamic` **(** :ref:`int` max_output_size, :ref:`int` compression_mode=0 **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`duplicate` **(** **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`encode_double` **(** :ref:`int` byte_offset, :ref:`float` value **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`encode_float` **(** :ref:`int` byte_offset, :ref:`float` value **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`encode_half` **(** :ref:`int` byte_offset, :ref:`float` value **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`encode_s8` **(** :ref:`int` byte_offset, :ref:`int` value **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`encode_s16` **(** :ref:`int` byte_offset, :ref:`int` value **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`encode_s32` **(** :ref:`int` byte_offset, :ref:`int` value **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`encode_s64` **(** :ref:`int` byte_offset, :ref:`int` value **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`encode_u8` **(** :ref:`int` byte_offset, :ref:`int` value **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`encode_u16` **(** :ref:`int` byte_offset, :ref:`int` value **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`encode_u32` **(** :ref:`int` byte_offset, :ref:`int` value **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`encode_u64` **(** :ref:`int` byte_offset, :ref:`int` value **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`encode_var` **(** :ref:`int` byte_offset, :ref:`Variant` value, :ref:`bool` allow_objects=false **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fill` **(** :ref:`int` value **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find` **(** :ref:`int` value, :ref:`int` from=0 **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_string_from_ascii` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_string_from_utf8` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_string_from_utf16` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_string_from_utf32` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_string_from_wchar` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has` **(** :ref:`int` value **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_encoded_var` **(** :ref:`int` byte_offset, :ref:`bool` allow_objects=false **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`hex_encode` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`insert` **(** :ref:`int` at_index, :ref:`int` value **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_back` **(** :ref:`int` value **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_at` **(** :ref:`int` index **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reverse` **(** **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind` **(** :ref:`int` value, :ref:`int` from=-1 **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set` **(** :ref:`int` index, :ref:`int` value **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`slice` **(** :ref:`int` begin, :ref:`int` end=2147483647 **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`sort` **(** **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`to_float32_array` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat64Array` | :ref:`to_float64_array` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`to_int32_array` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`to_int64_array` **(** **)** |const| | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`compress`\ (\ compression_mode\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`decode_double`\ (\ byte_offset\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`decode_float`\ (\ byte_offset\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`decode_half`\ (\ byte_offset\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`decode_s8`\ (\ byte_offset\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`decode_s16`\ (\ byte_offset\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`decode_s32`\ (\ byte_offset\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`decode_s64`\ (\ byte_offset\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`decode_u8`\ (\ byte_offset\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`decode_u16`\ (\ byte_offset\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`decode_u32`\ (\ byte_offset\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`decode_u64`\ (\ byte_offset\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`decode_var`\ (\ byte_offset\: :ref:`int`, allow_objects\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`decode_var_size`\ (\ byte_offset\: :ref:`int`, allow_objects\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`decompress`\ (\ buffer_size\: :ref:`int`, compression_mode\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`decompress_dynamic`\ (\ max_output_size\: :ref:`int`, compression_mode\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`duplicate`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`encode_double`\ (\ byte_offset\: :ref:`int`, value\: :ref:`float`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`encode_float`\ (\ byte_offset\: :ref:`int`, value\: :ref:`float`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`encode_half`\ (\ byte_offset\: :ref:`int`, value\: :ref:`float`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`encode_s8`\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`encode_s16`\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`encode_s32`\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`encode_s64`\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`encode_u8`\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`encode_u16`\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`encode_u32`\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`encode_u64`\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`encode_var`\ (\ byte_offset\: :ref:`int`, value\: :ref:`Variant`, allow_objects\: :ref:`bool` = false\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_string_from_ascii`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_string_from_utf8`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_string_from_utf16`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_string_from_utf32`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_string_from_wchar`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_encoded_var`\ (\ byte_offset\: :ref:`int`, allow_objects\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`hex_encode`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`int`, from\: :ref:`int` = -1\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sort`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`to_float32_array`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat64Array` | :ref:`to_float64_array`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`to_int32_array`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`to_int64_array`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -177,15 +177,15 @@ Operators .. table:: :widths: auto - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`PackedByteArray` right **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`operator +` **(** :ref:`PackedByteArray` right **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`PackedByteArray` right **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator []` **(** :ref:`int` index **)** | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`operator +`\ (\ right\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -200,7 +200,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedByteArray` **PackedByteArray** **(** **)** +:ref:`PackedByteArray` **PackedByteArray**\ (\ ) Constructs an empty **PackedByteArray**. @@ -210,7 +210,7 @@ Constructs an empty **PackedByteArray**. .. rst-class:: classref-constructor -:ref:`PackedByteArray` **PackedByteArray** **(** :ref:`PackedByteArray` from **)** +:ref:`PackedByteArray` **PackedByteArray**\ (\ from\: :ref:`PackedByteArray`\ ) Constructs a **PackedByteArray** as a copy of the given **PackedByteArray**. @@ -220,7 +220,7 @@ Constructs a **PackedByteArray** as a copy of the given **PackedByteArray**. .. rst-class:: classref-constructor -:ref:`PackedByteArray` **PackedByteArray** **(** :ref:`Array` from **)** +:ref:`PackedByteArray` **PackedByteArray**\ (\ from\: :ref:`Array`\ ) Constructs a new **PackedByteArray**. Optionally, you can pass in a generic :ref:`Array` that will be converted. @@ -237,7 +237,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append** **(** :ref:`int` value **)** +:ref:`bool` **append**\ (\ value\: :ref:`int`\ ) Appends an element at the end of the array (alias of :ref:`push_back`). @@ -249,7 +249,7 @@ Appends an element at the end of the array (alias of :ref:`push_back` array **)** +|void| **append_array**\ (\ array\: :ref:`PackedByteArray`\ ) Appends a **PackedByteArray** at the end of this array. @@ -261,7 +261,7 @@ Appends a **PackedByteArray** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch** **(** :ref:`int` value, :ref:`bool` before=true **)** +:ref:`int` **bsearch**\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -275,7 +275,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -287,7 +287,7 @@ Clears the array. This is equivalent to using :ref:`resize` **compress** **(** :ref:`int` compression_mode=0 **)** |const| +:ref:`PackedByteArray` **compress**\ (\ compression_mode\: :ref:`int` = 0\ ) |const| Returns a new **PackedByteArray** with the data compressed. Set the compression mode using one of :ref:`CompressionMode`'s constants. @@ -299,7 +299,7 @@ Returns a new **PackedByteArray** with the data compressed. Set the compression .. rst-class:: classref-method -:ref:`int` **count** **(** :ref:`int` value **)** |const| +:ref:`int` **count**\ (\ value\: :ref:`int`\ ) |const| Returns the number of times an element is in the array. @@ -311,7 +311,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`float` **decode_double** **(** :ref:`int` byte_offset **)** |const| +:ref:`float` **decode_double**\ (\ byte_offset\: :ref:`int`\ ) |const| Decodes a 64-bit floating point number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0.0`` if a valid number can't be decoded. @@ -323,7 +323,7 @@ Decodes a 64-bit floating point number from the bytes starting at ``byte_offset` .. rst-class:: classref-method -:ref:`float` **decode_float** **(** :ref:`int` byte_offset **)** |const| +:ref:`float` **decode_float**\ (\ byte_offset\: :ref:`int`\ ) |const| Decodes a 32-bit floating point number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0.0`` if a valid number can't be decoded. @@ -335,7 +335,7 @@ Decodes a 32-bit floating point number from the bytes starting at ``byte_offset` .. rst-class:: classref-method -:ref:`float` **decode_half** **(** :ref:`int` byte_offset **)** |const| +:ref:`float` **decode_half**\ (\ byte_offset\: :ref:`int`\ ) |const| Decodes a 16-bit floating point number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0.0`` if a valid number can't be decoded. @@ -347,7 +347,7 @@ Decodes a 16-bit floating point number from the bytes starting at ``byte_offset` .. rst-class:: classref-method -:ref:`int` **decode_s8** **(** :ref:`int` byte_offset **)** |const| +:ref:`int` **decode_s8**\ (\ byte_offset\: :ref:`int`\ ) |const| Decodes a 8-bit signed integer number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0`` if a valid number can't be decoded. @@ -359,7 +359,7 @@ Decodes a 8-bit signed integer number from the bytes starting at ``byte_offset`` .. rst-class:: classref-method -:ref:`int` **decode_s16** **(** :ref:`int` byte_offset **)** |const| +:ref:`int` **decode_s16**\ (\ byte_offset\: :ref:`int`\ ) |const| Decodes a 16-bit signed integer number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0`` if a valid number can't be decoded. @@ -371,7 +371,7 @@ Decodes a 16-bit signed integer number from the bytes starting at ``byte_offset` .. rst-class:: classref-method -:ref:`int` **decode_s32** **(** :ref:`int` byte_offset **)** |const| +:ref:`int` **decode_s32**\ (\ byte_offset\: :ref:`int`\ ) |const| Decodes a 32-bit signed integer number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0`` if a valid number can't be decoded. @@ -383,7 +383,7 @@ Decodes a 32-bit signed integer number from the bytes starting at ``byte_offset` .. rst-class:: classref-method -:ref:`int` **decode_s64** **(** :ref:`int` byte_offset **)** |const| +:ref:`int` **decode_s64**\ (\ byte_offset\: :ref:`int`\ ) |const| Decodes a 64-bit signed integer number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0`` if a valid number can't be decoded. @@ -395,7 +395,7 @@ Decodes a 64-bit signed integer number from the bytes starting at ``byte_offset` .. rst-class:: classref-method -:ref:`int` **decode_u8** **(** :ref:`int` byte_offset **)** |const| +:ref:`int` **decode_u8**\ (\ byte_offset\: :ref:`int`\ ) |const| Decodes a 8-bit unsigned integer number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0`` if a valid number can't be decoded. @@ -407,7 +407,7 @@ Decodes a 8-bit unsigned integer number from the bytes starting at ``byte_offset .. rst-class:: classref-method -:ref:`int` **decode_u16** **(** :ref:`int` byte_offset **)** |const| +:ref:`int` **decode_u16**\ (\ byte_offset\: :ref:`int`\ ) |const| Decodes a 16-bit unsigned integer number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0`` if a valid number can't be decoded. @@ -419,7 +419,7 @@ Decodes a 16-bit unsigned integer number from the bytes starting at ``byte_offse .. rst-class:: classref-method -:ref:`int` **decode_u32** **(** :ref:`int` byte_offset **)** |const| +:ref:`int` **decode_u32**\ (\ byte_offset\: :ref:`int`\ ) |const| Decodes a 32-bit unsigned integer number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0`` if a valid number can't be decoded. @@ -431,7 +431,7 @@ Decodes a 32-bit unsigned integer number from the bytes starting at ``byte_offse .. rst-class:: classref-method -:ref:`int` **decode_u64** **(** :ref:`int` byte_offset **)** |const| +:ref:`int` **decode_u64**\ (\ byte_offset\: :ref:`int`\ ) |const| Decodes a 64-bit unsigned integer number from the bytes starting at ``byte_offset``. Fails if the byte count is insufficient. Returns ``0`` if a valid number can't be decoded. @@ -443,7 +443,7 @@ Decodes a 64-bit unsigned integer number from the bytes starting at ``byte_offse .. rst-class:: classref-method -:ref:`Variant` **decode_var** **(** :ref:`int` byte_offset, :ref:`bool` allow_objects=false **)** |const| +:ref:`Variant` **decode_var**\ (\ byte_offset\: :ref:`int`, allow_objects\: :ref:`bool` = false\ ) |const| Decodes a :ref:`Variant` from the bytes starting at ``byte_offset``. Returns ``null`` if a valid variant can't be decoded or the value is :ref:`Object`-derived and ``allow_objects`` is ``false``. @@ -455,7 +455,7 @@ Decodes a :ref:`Variant` from the bytes starting at ``byte_offset .. rst-class:: classref-method -:ref:`int` **decode_var_size** **(** :ref:`int` byte_offset, :ref:`bool` allow_objects=false **)** |const| +:ref:`int` **decode_var_size**\ (\ byte_offset\: :ref:`int`, allow_objects\: :ref:`bool` = false\ ) |const| Decodes a size of a :ref:`Variant` from the bytes starting at ``byte_offset``. Requires at least 4 bytes of data starting at the offset, otherwise fails. @@ -467,7 +467,7 @@ Decodes a size of a :ref:`Variant` from the bytes starting at ``b .. rst-class:: classref-method -:ref:`PackedByteArray` **decompress** **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** |const| +:ref:`PackedByteArray` **decompress**\ (\ buffer_size\: :ref:`int`, compression_mode\: :ref:`int` = 0\ ) |const| 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`'s constants. @@ -481,7 +481,7 @@ Returns a new **PackedByteArray** with the data decompressed. Set ``buffer_size` .. rst-class:: classref-method -:ref:`PackedByteArray` **decompress_dynamic** **(** :ref:`int` max_output_size, :ref:`int` compression_mode=0 **)** |const| +:ref:`PackedByteArray` **decompress_dynamic**\ (\ max_output_size\: :ref:`int`, compression_mode\: :ref:`int` = 0\ ) |const| Returns a new **PackedByteArray** with the data decompressed. Set the compression mode using one of :ref:`CompressionMode`'s constants. **This method only accepts brotli, gzip, and deflate compression modes.**\ @@ -499,7 +499,7 @@ GZIP has a maximal compression ratio of 1032:1, meaning it's very possible for a .. rst-class:: classref-method -:ref:`PackedByteArray` **duplicate** **(** **)** +:ref:`PackedByteArray` **duplicate**\ (\ ) Creates a copy of the array, and returns it. @@ -511,7 +511,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -void **encode_double** **(** :ref:`int` byte_offset, :ref:`float` value **)** +|void| **encode_double**\ (\ byte_offset\: :ref:`int`, value\: :ref:`float`\ ) Encodes a 64-bit floating point number as bytes at the index of ``byte_offset`` bytes. The array must have at least 8 bytes of allocated space, starting at the offset. @@ -523,7 +523,7 @@ Encodes a 64-bit floating point number as bytes at the index of ``byte_offset`` .. rst-class:: classref-method -void **encode_float** **(** :ref:`int` byte_offset, :ref:`float` value **)** +|void| **encode_float**\ (\ byte_offset\: :ref:`int`, value\: :ref:`float`\ ) Encodes a 32-bit floating point number as bytes at the index of ``byte_offset`` bytes. The array must have at least 4 bytes of space, starting at the offset. @@ -535,7 +535,7 @@ Encodes a 32-bit floating point number as bytes at the index of ``byte_offset`` .. rst-class:: classref-method -void **encode_half** **(** :ref:`int` byte_offset, :ref:`float` value **)** +|void| **encode_half**\ (\ byte_offset\: :ref:`int`, value\: :ref:`float`\ ) Encodes a 16-bit floating point number as bytes at the index of ``byte_offset`` bytes. The array must have at least 2 bytes of space, starting at the offset. @@ -547,7 +547,7 @@ Encodes a 16-bit floating point number as bytes at the index of ``byte_offset`` .. rst-class:: classref-method -void **encode_s8** **(** :ref:`int` byte_offset, :ref:`int` value **)** +|void| **encode_s8**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) Encodes a 8-bit signed integer number (signed byte) at the index of ``byte_offset`` bytes. The array must have at least 1 byte of space, starting at the offset. @@ -559,7 +559,7 @@ Encodes a 8-bit signed integer number (signed byte) at the index of ``byte_offse .. rst-class:: classref-method -void **encode_s16** **(** :ref:`int` byte_offset, :ref:`int` value **)** +|void| **encode_s16**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) Encodes a 16-bit signed integer number as bytes at the index of ``byte_offset`` bytes. The array must have at least 2 bytes of space, starting at the offset. @@ -571,7 +571,7 @@ Encodes a 16-bit signed integer number as bytes at the index of ``byte_offset`` .. rst-class:: classref-method -void **encode_s32** **(** :ref:`int` byte_offset, :ref:`int` value **)** +|void| **encode_s32**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) Encodes a 32-bit signed integer number as bytes at the index of ``byte_offset`` bytes. The array must have at least 4 bytes of space, starting at the offset. @@ -583,7 +583,7 @@ Encodes a 32-bit signed integer number as bytes at the index of ``byte_offset`` .. rst-class:: classref-method -void **encode_s64** **(** :ref:`int` byte_offset, :ref:`int` value **)** +|void| **encode_s64**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) Encodes a 64-bit signed integer number as bytes at the index of ``byte_offset`` bytes. The array must have at least 8 bytes of space, starting at the offset. @@ -595,7 +595,7 @@ Encodes a 64-bit signed integer number as bytes at the index of ``byte_offset`` .. rst-class:: classref-method -void **encode_u8** **(** :ref:`int` byte_offset, :ref:`int` value **)** +|void| **encode_u8**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) Encodes a 8-bit unsigned integer number (byte) at the index of ``byte_offset`` bytes. The array must have at least 1 byte of space, starting at the offset. @@ -607,7 +607,7 @@ Encodes a 8-bit unsigned integer number (byte) at the index of ``byte_offset`` b .. rst-class:: classref-method -void **encode_u16** **(** :ref:`int` byte_offset, :ref:`int` value **)** +|void| **encode_u16**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) Encodes a 16-bit unsigned integer number as bytes at the index of ``byte_offset`` bytes. The array must have at least 2 bytes of space, starting at the offset. @@ -619,7 +619,7 @@ Encodes a 16-bit unsigned integer number as bytes at the index of ``byte_offset` .. rst-class:: classref-method -void **encode_u32** **(** :ref:`int` byte_offset, :ref:`int` value **)** +|void| **encode_u32**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) Encodes a 32-bit unsigned integer number as bytes at the index of ``byte_offset`` bytes. The array must have at least 4 bytes of space, starting at the offset. @@ -631,7 +631,7 @@ Encodes a 32-bit unsigned integer number as bytes at the index of ``byte_offset` .. rst-class:: classref-method -void **encode_u64** **(** :ref:`int` byte_offset, :ref:`int` value **)** +|void| **encode_u64**\ (\ byte_offset\: :ref:`int`, value\: :ref:`int`\ ) Encodes a 64-bit unsigned integer number as bytes at the index of ``byte_offset`` bytes. The array must have at least 8 bytes of space, starting at the offset. @@ -643,7 +643,7 @@ Encodes a 64-bit unsigned integer number as bytes at the index of ``byte_offset` .. rst-class:: classref-method -:ref:`int` **encode_var** **(** :ref:`int` byte_offset, :ref:`Variant` value, :ref:`bool` allow_objects=false **)** +:ref:`int` **encode_var**\ (\ byte_offset\: :ref:`int`, value\: :ref:`Variant`, allow_objects\: :ref:`bool` = false\ ) Encodes a :ref:`Variant` at the index of ``byte_offset`` bytes. A sufficient space must be allocated, depending on the encoded variant's size. If ``allow_objects`` is ``false``, :ref:`Object`-derived values are not permitted and will instead be serialized as ID-only. @@ -655,7 +655,7 @@ Encodes a :ref:`Variant` at the index of ``byte_offset`` bytes. A .. rst-class:: classref-method -void **fill** **(** :ref:`int` value **)** +|void| **fill**\ (\ value\: :ref:`int`\ ) Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -667,7 +667,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find** **(** :ref:`int` value, :ref:`int` from=0 **)** |const| +:ref:`int` **find**\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -679,7 +679,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`String` **get_string_from_ascii** **(** **)** |const| +:ref:`String` **get_string_from_ascii**\ (\ ) |const| Converts ASCII/Latin-1 encoded array to :ref:`String`. Fast alternative to :ref:`get_string_from_utf8` if the content is ASCII/Latin-1 only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use :ref:`get_string_from_utf8`. This is the inverse of :ref:`String.to_ascii_buffer`. @@ -691,7 +691,7 @@ Converts ASCII/Latin-1 encoded array to :ref:`String`. Fast altern .. rst-class:: classref-method -:ref:`String` **get_string_from_utf8** **(** **)** |const| +:ref:`String` **get_string_from_utf8**\ (\ ) |const| Converts UTF-8 encoded array to :ref:`String`. Slower than :ref:`get_string_from_ascii` but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. Returns empty string if source array is not valid UTF-8 string. This is the inverse of :ref:`String.to_utf8_buffer`. @@ -703,7 +703,7 @@ Converts UTF-8 encoded array to :ref:`String`. Slower than :ref:`g .. rst-class:: classref-method -:ref:`String` **get_string_from_utf16** **(** **)** |const| +:ref:`String` **get_string_from_utf16**\ (\ ) |const| Converts UTF-16 encoded array to :ref:`String`. If the BOM is missing, system endianness is assumed. Returns empty string if source array is not valid UTF-16 string. This is the inverse of :ref:`String.to_utf16_buffer`. @@ -715,7 +715,7 @@ Converts UTF-16 encoded array to :ref:`String`. If the BOM is miss .. rst-class:: classref-method -:ref:`String` **get_string_from_utf32** **(** **)** |const| +:ref:`String` **get_string_from_utf32**\ (\ ) |const| Converts UTF-32 encoded array to :ref:`String`. System endianness is assumed. Returns empty string if source array is not valid UTF-32 string. This is the inverse of :ref:`String.to_utf32_buffer`. @@ -727,7 +727,7 @@ Converts UTF-32 encoded array to :ref:`String`. System endianness .. rst-class:: classref-method -:ref:`String` **get_string_from_wchar** **(** **)** |const| +:ref:`String` **get_string_from_wchar**\ (\ ) |const| Converts wide character (``wchar_t``, UTF-16 on Windows, UTF-32 on other platforms) encoded array to :ref:`String`. Returns empty string if source array is not valid wide string. This is the inverse of :ref:`String.to_wchar_buffer`. @@ -739,7 +739,7 @@ Converts wide character (``wchar_t``, UTF-16 on Windows, UTF-32 on other platfor .. rst-class:: classref-method -:ref:`bool` **has** **(** :ref:`int` value **)** |const| +:ref:`bool` **has**\ (\ value\: :ref:`int`\ ) |const| Returns ``true`` if the array contains ``value``. @@ -751,7 +751,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`bool` **has_encoded_var** **(** :ref:`int` byte_offset, :ref:`bool` allow_objects=false **)** |const| +:ref:`bool` **has_encoded_var**\ (\ byte_offset\: :ref:`int`, allow_objects\: :ref:`bool` = false\ ) |const| Returns ``true`` if a valid :ref:`Variant` value can be decoded at the ``byte_offset``. Returns ``false`` otherwise or when the value is :ref:`Object`-derived and ``allow_objects`` is ``false``. @@ -763,7 +763,7 @@ Returns ``true`` if a valid :ref:`Variant` value can be decoded a .. rst-class:: classref-method -:ref:`String` **hex_encode** **(** **)** |const| +:ref:`String` **hex_encode**\ (\ ) |const| Returns a hexadecimal representation of this array as a :ref:`String`. @@ -790,7 +790,7 @@ Returns a hexadecimal representation of this array as a :ref:`String` **insert** **(** :ref:`int` at_index, :ref:`int` value **)** +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`int`\ ) Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -802,7 +802,7 @@ Inserts a new element at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty** **(** **)** |const| +:ref:`bool` **is_empty**\ (\ ) |const| Returns ``true`` if the array is empty. @@ -814,7 +814,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back** **(** :ref:`int` value **)** +:ref:`bool` **push_back**\ (\ value\: :ref:`int`\ ) Appends an element at the end of the array. @@ -826,7 +826,7 @@ Appends an element at the end of the array. .. rst-class:: classref-method -void **remove_at** **(** :ref:`int` index **)** +|void| **remove_at**\ (\ index\: :ref:`int`\ ) Removes an element from the array by index. @@ -838,7 +838,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize** **(** :ref:`int` new_size **)** +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) 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` once and assigning the new values is faster than adding new elements one by one. @@ -850,7 +850,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -void **reverse** **(** **)** +|void| **reverse**\ (\ ) Reverses the order of the elements in the array. @@ -862,7 +862,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind** **(** :ref:`int` value, :ref:`int` from=-1 **)** |const| +:ref:`int` **rfind**\ (\ value\: :ref:`int`, from\: :ref:`int` = -1\ ) |const| Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -874,7 +874,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -void **set** **(** :ref:`int` index, :ref:`int` value **)** +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`int`\ ) Changes the byte at the given index. @@ -886,7 +886,7 @@ Changes the byte at the given index. .. rst-class:: classref-method -:ref:`int` **size** **(** **)** |const| +:ref:`int` **size**\ (\ ) |const| Returns the number of elements in the array. @@ -898,7 +898,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedByteArray` **slice** **(** :ref:`int` begin, :ref:`int` end=2147483647 **)** |const| +:ref:`PackedByteArray` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| Returns the slice of the **PackedByteArray**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedByteArray**. @@ -914,7 +914,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -void **sort** **(** **)** +|void| **sort**\ (\ ) Sorts the elements of the array in ascending order. @@ -926,7 +926,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedFloat32Array` **to_float32_array** **(** **)** |const| +:ref:`PackedFloat32Array` **to_float32_array**\ (\ ) |const| Returns a copy of the data converted to a :ref:`PackedFloat32Array`, where each block of 4 bytes has been converted to a 32-bit float (C++ ``float``). @@ -942,7 +942,7 @@ If the original data can't be converted to 32-bit floats, the resulting data is .. rst-class:: classref-method -:ref:`PackedFloat64Array` **to_float64_array** **(** **)** |const| +:ref:`PackedFloat64Array` **to_float64_array**\ (\ ) |const| Returns a copy of the data converted to a :ref:`PackedFloat64Array`, where each block of 8 bytes has been converted to a 64-bit float (C++ ``double``, Godot :ref:`float`). @@ -958,7 +958,7 @@ If the original data can't be converted to 64-bit floats, the resulting data is .. rst-class:: classref-method -:ref:`PackedInt32Array` **to_int32_array** **(** **)** |const| +:ref:`PackedInt32Array` **to_int32_array**\ (\ ) |const| Returns a copy of the data converted to a :ref:`PackedInt32Array`, where each block of 4 bytes has been converted to a signed 32-bit integer (C++ ``int32_t``). @@ -974,7 +974,7 @@ If the original data can't be converted to signed 32-bit integers, the resulting .. rst-class:: classref-method -:ref:`PackedInt64Array` **to_int64_array** **(** **)** |const| +:ref:`PackedInt64Array` **to_int64_array**\ (\ ) |const| Returns a copy of the data converted to a :ref:`PackedInt64Array`, where each block of 8 bytes has been converted to a signed 64-bit integer (C++ ``int64_t``, Godot :ref:`int`). @@ -995,7 +995,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`PackedByteArray` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedByteArray`\ ) Returns ``true`` if contents of the arrays differ. @@ -1007,7 +1007,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedByteArray` **operator +** **(** :ref:`PackedByteArray` right **)** +:ref:`PackedByteArray` **operator +**\ (\ right\: :ref:`PackedByteArray`\ ) Returns a new **PackedByteArray** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -1019,7 +1019,7 @@ Returns a new **PackedByteArray** with contents of ``right`` added at the end of .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`PackedByteArray` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedByteArray`\ ) Returns ``true`` if contents of both arrays are the same, i.e. they have all equal bytes at the corresponding indices. @@ -1031,7 +1031,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`int` **operator []** **(** :ref:`int` index **)** +:ref:`int` **operator []**\ (\ index\: :ref:`int`\ ) Returns the byte at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. @@ -1044,3 +1044,4 @@ Note that the byte is returned as a 64-bit :ref:`int`. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_packedcolorarray.rst b/classes/class_packedcolorarray.rst index 93ff37a789c..e3b1eb2c242 100644 --- a/classes/class_packedcolorarray.rst +++ b/classes/class_packedcolorarray.rst @@ -31,13 +31,13 @@ Constructors .. table:: :widths: auto - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedColorArray` | :ref:`PackedColorArray` **(** **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedColorArray` | :ref:`PackedColorArray` **(** :ref:`PackedColorArray` from **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedColorArray` | :ref:`PackedColorArray` **(** :ref:`Array` from **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedColorArray` | :ref:`PackedColorArray`\ (\ ) | + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedColorArray` | :ref:`PackedColorArray`\ (\ from\: :ref:`PackedColorArray`\ ) | + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedColorArray` | :ref:`PackedColorArray`\ (\ from\: :ref:`Array`\ ) | + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -47,49 +47,49 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`append` **(** :ref:`Color` value **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`append_array` **(** :ref:`PackedColorArray` array **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch` **(** :ref:`Color` value, :ref:`bool` before=true **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count` **(** :ref:`Color` value **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedColorArray` | :ref:`duplicate` **(** **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fill` **(** :ref:`Color` value **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find` **(** :ref:`Color` value, :ref:`int` from=0 **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has` **(** :ref:`Color` value **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`insert` **(** :ref:`int` at_index, :ref:`Color` value **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty` **(** **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_back` **(** :ref:`Color` value **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_at` **(** :ref:`int` index **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reverse` **(** **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind` **(** :ref:`Color` value, :ref:`int` from=-1 **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set` **(** :ref:`int` index, :ref:`Color` value **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size` **(** **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedColorArray` | :ref:`slice` **(** :ref:`int` begin, :ref:`int` end=2147483647 **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`sort` **(** **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`Color`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedColorArray`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`Color`, before\: :ref:`bool` = true\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`Color`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedColorArray` | :ref:`duplicate`\ (\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`Color`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`Color`, from\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`Color`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`Color`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`Color`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`Color`, from\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`Color`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedColorArray` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sort`\ (\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_byte_array`\ (\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -99,15 +99,15 @@ Operators .. table:: :widths: auto - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`PackedColorArray` right **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedColorArray` | :ref:`operator +` **(** :ref:`PackedColorArray` right **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`PackedColorArray` right **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`operator []` **(** :ref:`int` index **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`PackedColorArray`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedColorArray` | :ref:`operator +`\ (\ right\: :ref:`PackedColorArray`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`PackedColorArray`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -122,7 +122,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedColorArray` **PackedColorArray** **(** **)** +:ref:`PackedColorArray` **PackedColorArray**\ (\ ) Constructs an empty **PackedColorArray**. @@ -132,7 +132,7 @@ Constructs an empty **PackedColorArray**. .. rst-class:: classref-constructor -:ref:`PackedColorArray` **PackedColorArray** **(** :ref:`PackedColorArray` from **)** +:ref:`PackedColorArray` **PackedColorArray**\ (\ from\: :ref:`PackedColorArray`\ ) Constructs a **PackedColorArray** as a copy of the given **PackedColorArray**. @@ -142,7 +142,7 @@ Constructs a **PackedColorArray** as a copy of the given **PackedColorArray**. .. rst-class:: classref-constructor -:ref:`PackedColorArray` **PackedColorArray** **(** :ref:`Array` from **)** +:ref:`PackedColorArray` **PackedColorArray**\ (\ from\: :ref:`Array`\ ) Constructs a new **PackedColorArray**. Optionally, you can pass in a generic :ref:`Array` that will be converted. @@ -165,7 +165,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append** **(** :ref:`Color` value **)** +:ref:`bool` **append**\ (\ value\: :ref:`Color`\ ) Appends an element at the end of the array (alias of :ref:`push_back`). @@ -177,7 +177,7 @@ Appends an element at the end of the array (alias of :ref:`push_back` array **)** +|void| **append_array**\ (\ array\: :ref:`PackedColorArray`\ ) Appends a **PackedColorArray** at the end of this array. @@ -189,7 +189,7 @@ Appends a **PackedColorArray** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch** **(** :ref:`Color` value, :ref:`bool` before=true **)** +:ref:`int` **bsearch**\ (\ value\: :ref:`Color`, before\: :ref:`bool` = true\ ) Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -203,7 +203,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -215,7 +215,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count** **(** :ref:`Color` value **)** |const| +:ref:`int` **count**\ (\ value\: :ref:`Color`\ ) |const| Returns the number of times an element is in the array. @@ -227,7 +227,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`PackedColorArray` **duplicate** **(** **)** +:ref:`PackedColorArray` **duplicate**\ (\ ) Creates a copy of the array, and returns it. @@ -239,7 +239,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -void **fill** **(** :ref:`Color` value **)** +|void| **fill**\ (\ value\: :ref:`Color`\ ) Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -251,7 +251,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find** **(** :ref:`Color` value, :ref:`int` from=0 **)** |const| +:ref:`int` **find**\ (\ value\: :ref:`Color`, from\: :ref:`int` = 0\ ) |const| Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -263,7 +263,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`bool` **has** **(** :ref:`Color` value **)** |const| +:ref:`bool` **has**\ (\ value\: :ref:`Color`\ ) |const| Returns ``true`` if the array contains ``value``. @@ -275,7 +275,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`int` **insert** **(** :ref:`int` at_index, :ref:`Color` value **)** +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`Color`\ ) Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -287,7 +287,7 @@ Inserts a new element at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty** **(** **)** |const| +:ref:`bool` **is_empty**\ (\ ) |const| Returns ``true`` if the array is empty. @@ -299,7 +299,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back** **(** :ref:`Color` value **)** +:ref:`bool` **push_back**\ (\ value\: :ref:`Color`\ ) Appends a value to the array. @@ -311,7 +311,7 @@ Appends a value to the array. .. rst-class:: classref-method -void **remove_at** **(** :ref:`int` index **)** +|void| **remove_at**\ (\ index\: :ref:`int`\ ) Removes an element from the array by index. @@ -323,7 +323,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize** **(** :ref:`int` new_size **)** +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) 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` once and assigning the new values is faster than adding new elements one by one. @@ -335,7 +335,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -void **reverse** **(** **)** +|void| **reverse**\ (\ ) Reverses the order of the elements in the array. @@ -347,7 +347,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind** **(** :ref:`Color` value, :ref:`int` from=-1 **)** |const| +:ref:`int` **rfind**\ (\ value\: :ref:`Color`, from\: :ref:`int` = -1\ ) |const| Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -359,7 +359,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -void **set** **(** :ref:`int` index, :ref:`Color` value **)** +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`Color`\ ) Changes the :ref:`Color` at the given index. @@ -371,7 +371,7 @@ Changes the :ref:`Color` at the given index. .. rst-class:: classref-method -:ref:`int` **size** **(** **)** |const| +:ref:`int` **size**\ (\ ) |const| Returns the number of elements in the array. @@ -383,7 +383,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedColorArray` **slice** **(** :ref:`int` begin, :ref:`int` end=2147483647 **)** |const| +:ref:`PackedColorArray` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| Returns the slice of the **PackedColorArray**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedColorArray**. @@ -399,7 +399,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -void **sort** **(** **)** +|void| **sort**\ (\ ) Sorts the elements of the array in ascending order. @@ -411,7 +411,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_byte_array** **(** **)** |const| +:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| Returns a :ref:`PackedByteArray` with each color encoded as bytes. @@ -428,7 +428,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`PackedColorArray` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedColorArray`\ ) Returns ``true`` if contents of the arrays differ. @@ -440,7 +440,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedColorArray` **operator +** **(** :ref:`PackedColorArray` right **)** +:ref:`PackedColorArray` **operator +**\ (\ right\: :ref:`PackedColorArray`\ ) Returns a new **PackedColorArray** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -452,7 +452,7 @@ Returns a new **PackedColorArray** with contents of ``right`` added at the end o .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`PackedColorArray` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedColorArray`\ ) Returns ``true`` if contents of both arrays are the same, i.e. they have all equal :ref:`Color`\ s at the corresponding indices. @@ -464,7 +464,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`Color` **operator []** **(** :ref:`int` index **)** +:ref:`Color` **operator []**\ (\ index\: :ref:`int`\ ) Returns the :ref:`Color` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. @@ -475,3 +475,4 @@ Returns the :ref:`Color` at index ``index``. Negative indices can b .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index 01c94c60695..150848cd731 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -51,11 +51,11 @@ Methods .. table:: :widths: auto - +---------------------------------------+----------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`pack` **(** :ref:`Variant` value **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------+ + +---------------------------------------+-------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`pack`\ (\ value\: :ref:`Variant`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -70,7 +70,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **pack** **(** :ref:`Variant` value **)** +:ref:`Error` **pack**\ (\ value\: :ref:`Variant`\ ) Packs the given container into a binary representation. The ``value`` must be either :ref:`Array` or :ref:`Dictionary`, any other type will result in invalid data error. @@ -84,7 +84,7 @@ Packs the given container into a binary representation. The ``value`` must be ei .. rst-class:: classref-method -:ref:`int` **size** **(** **)** |const| +:ref:`int` **size**\ (\ ) |const| Returns the size of the packed container (see :ref:`Array.size` and :ref:`Dictionary.size`). @@ -95,3 +95,4 @@ Returns the size of the packed container (see :ref:`Array.size` | :ref:`size` **(** **)** |const| | - +-----------------------+---------------------------------------------------------------------------+ + +-----------------------+---------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-----------------------+---------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -68,7 +68,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **size** **(** **)** |const| +:ref:`int` **size**\ (\ ) |const| Returns the size of the packed container (see :ref:`Array.size` and :ref:`Dictionary.size`). @@ -79,3 +79,4 @@ Returns the size of the packed container (see :ref:`Array.size` | :ref:`PackedFloat32Array` **(** **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`PackedFloat32Array` **(** :ref:`PackedFloat32Array` from **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`PackedFloat32Array` **(** :ref:`Array` from **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`PackedFloat32Array`\ (\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`PackedFloat32Array`\ (\ from\: :ref:`PackedFloat32Array`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`PackedFloat32Array`\ (\ from\: :ref:`Array`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -49,49 +49,49 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`append` **(** :ref:`float` value **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`append_array` **(** :ref:`PackedFloat32Array` array **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch` **(** :ref:`float` value, :ref:`bool` before=true **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count` **(** :ref:`float` value **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`duplicate` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fill` **(** :ref:`float` value **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find` **(** :ref:`float` value, :ref:`int` from=0 **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has` **(** :ref:`float` value **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`insert` **(** :ref:`int` at_index, :ref:`float` value **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty` **(** **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_back` **(** :ref:`float` value **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_at` **(** :ref:`int` index **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reverse` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind` **(** :ref:`float` value, :ref:`int` from=-1 **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set` **(** :ref:`int` index, :ref:`float` value **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size` **(** **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`slice` **(** :ref:`int` begin, :ref:`int` end=2147483647 **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`sort` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`float`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedFloat32Array`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`float`, before\: :ref:`bool` = true\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`float`\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`duplicate`\ (\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`float`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`float`, from\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`float`\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`float`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`float`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`float`, from\: :ref:`int` = -1\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`float`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sort`\ (\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_byte_array`\ (\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -101,15 +101,15 @@ Operators .. table:: :widths: auto - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`PackedFloat32Array` right **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`operator +` **(** :ref:`PackedFloat32Array` right **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`PackedFloat32Array` right **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator []` **(** :ref:`int` index **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`PackedFloat32Array`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`operator +`\ (\ right\: :ref:`PackedFloat32Array`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`PackedFloat32Array`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -124,7 +124,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedFloat32Array` **PackedFloat32Array** **(** **)** +:ref:`PackedFloat32Array` **PackedFloat32Array**\ (\ ) Constructs an empty **PackedFloat32Array**. @@ -134,7 +134,7 @@ Constructs an empty **PackedFloat32Array**. .. rst-class:: classref-constructor -:ref:`PackedFloat32Array` **PackedFloat32Array** **(** :ref:`PackedFloat32Array` from **)** +:ref:`PackedFloat32Array` **PackedFloat32Array**\ (\ from\: :ref:`PackedFloat32Array`\ ) Constructs a **PackedFloat32Array** as a copy of the given **PackedFloat32Array**. @@ -144,7 +144,7 @@ Constructs a **PackedFloat32Array** as a copy of the given **PackedFloat32Array* .. rst-class:: classref-constructor -:ref:`PackedFloat32Array` **PackedFloat32Array** **(** :ref:`Array` from **)** +:ref:`PackedFloat32Array` **PackedFloat32Array**\ (\ from\: :ref:`Array`\ ) Constructs a new **PackedFloat32Array**. Optionally, you can pass in a generic :ref:`Array` that will be converted. @@ -161,7 +161,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append** **(** :ref:`float` value **)** +:ref:`bool` **append**\ (\ value\: :ref:`float`\ ) Appends an element at the end of the array (alias of :ref:`push_back`). @@ -173,7 +173,7 @@ Appends an element at the end of the array (alias of :ref:`push_back` array **)** +|void| **append_array**\ (\ array\: :ref:`PackedFloat32Array`\ ) Appends a **PackedFloat32Array** at the end of this array. @@ -185,7 +185,7 @@ Appends a **PackedFloat32Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch** **(** :ref:`float` value, :ref:`bool` before=true **)** +:ref:`int` **bsearch**\ (\ value\: :ref:`float`, before\: :ref:`bool` = true\ ) Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -201,7 +201,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -213,7 +213,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count** **(** :ref:`float` value **)** |const| +:ref:`int` **count**\ (\ value\: :ref:`float`\ ) |const| Returns the number of times an element is in the array. @@ -227,7 +227,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`PackedFloat32Array` **duplicate** **(** **)** +:ref:`PackedFloat32Array` **duplicate**\ (\ ) Creates a copy of the array, and returns it. @@ -239,7 +239,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -void **fill** **(** :ref:`float` value **)** +|void| **fill**\ (\ value\: :ref:`float`\ ) Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -251,7 +251,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find** **(** :ref:`float` value, :ref:`int` from=0 **)** |const| +:ref:`int` **find**\ (\ value\: :ref:`float`, from\: :ref:`int` = 0\ ) |const| Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -265,7 +265,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`bool` **has** **(** :ref:`float` value **)** |const| +:ref:`bool` **has**\ (\ value\: :ref:`float`\ ) |const| Returns ``true`` if the array contains ``value``. @@ -279,7 +279,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`int` **insert** **(** :ref:`int` at_index, :ref:`float` value **)** +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`float`\ ) Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -291,7 +291,7 @@ Inserts a new element at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty** **(** **)** |const| +:ref:`bool` **is_empty**\ (\ ) |const| Returns ``true`` if the array is empty. @@ -303,7 +303,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back** **(** :ref:`float` value **)** +:ref:`bool` **push_back**\ (\ value\: :ref:`float`\ ) Appends an element at the end of the array. @@ -315,7 +315,7 @@ Appends an element at the end of the array. .. rst-class:: classref-method -void **remove_at** **(** :ref:`int` index **)** +|void| **remove_at**\ (\ index\: :ref:`int`\ ) Removes an element from the array by index. @@ -327,7 +327,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize** **(** :ref:`int` new_size **)** +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) 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` once and assigning the new values is faster than adding new elements one by one. @@ -339,7 +339,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -void **reverse** **(** **)** +|void| **reverse**\ (\ ) Reverses the order of the elements in the array. @@ -351,7 +351,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind** **(** :ref:`float` value, :ref:`int` from=-1 **)** |const| +:ref:`int` **rfind**\ (\ value\: :ref:`float`, from\: :ref:`int` = -1\ ) |const| Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -365,7 +365,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -void **set** **(** :ref:`int` index, :ref:`float` value **)** +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`float`\ ) Changes the float at the given index. @@ -377,7 +377,7 @@ Changes the float at the given index. .. rst-class:: classref-method -:ref:`int` **size** **(** **)** |const| +:ref:`int` **size**\ (\ ) |const| Returns the number of elements in the array. @@ -389,7 +389,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedFloat32Array` **slice** **(** :ref:`int` begin, :ref:`int` end=2147483647 **)** |const| +:ref:`PackedFloat32Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| Returns the slice of the **PackedFloat32Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedFloat32Array**. @@ -405,7 +405,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -void **sort** **(** **)** +|void| **sort**\ (\ ) Sorts the elements of the array in ascending order. @@ -419,7 +419,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_byte_array** **(** **)** |const| +:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| Returns a copy of the data converted to a :ref:`PackedByteArray`, where each element have been encoded as 4 bytes. @@ -438,7 +438,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`PackedFloat32Array` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedFloat32Array`\ ) Returns ``true`` if contents of the arrays differ. @@ -450,7 +450,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedFloat32Array` **operator +** **(** :ref:`PackedFloat32Array` right **)** +:ref:`PackedFloat32Array` **operator +**\ (\ right\: :ref:`PackedFloat32Array`\ ) Returns a new **PackedFloat32Array** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -462,7 +462,7 @@ Returns a new **PackedFloat32Array** with contents of ``right`` added at the end .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`PackedFloat32Array` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedFloat32Array`\ ) Returns ``true`` if contents of both arrays are the same, i.e. they have all equal floats at the corresponding indices. @@ -474,7 +474,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`float` **operator []** **(** :ref:`int` index **)** +:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) Returns the :ref:`float` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. @@ -487,3 +487,4 @@ Note that :ref:`float` type is 64-bit, unlike the values stored in .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_packedfloat64array.rst b/classes/class_packedfloat64array.rst index 7a2ba0512a7..25bd8bc1dd4 100644 --- a/classes/class_packedfloat64array.rst +++ b/classes/class_packedfloat64array.rst @@ -33,13 +33,13 @@ Constructors .. table:: :widths: auto - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat64Array` | :ref:`PackedFloat64Array` **(** **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat64Array` | :ref:`PackedFloat64Array` **(** :ref:`PackedFloat64Array` from **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat64Array` | :ref:`PackedFloat64Array` **(** :ref:`Array` from **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat64Array` | :ref:`PackedFloat64Array`\ (\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat64Array` | :ref:`PackedFloat64Array`\ (\ from\: :ref:`PackedFloat64Array`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat64Array` | :ref:`PackedFloat64Array`\ (\ from\: :ref:`Array`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -49,49 +49,49 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`append` **(** :ref:`float` value **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`append_array` **(** :ref:`PackedFloat64Array` array **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch` **(** :ref:`float` value, :ref:`bool` before=true **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count` **(** :ref:`float` value **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat64Array` | :ref:`duplicate` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fill` **(** :ref:`float` value **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find` **(** :ref:`float` value, :ref:`int` from=0 **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has` **(** :ref:`float` value **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`insert` **(** :ref:`int` at_index, :ref:`float` value **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty` **(** **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_back` **(** :ref:`float` value **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_at` **(** :ref:`int` index **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reverse` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind` **(** :ref:`float` value, :ref:`int` from=-1 **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set` **(** :ref:`int` index, :ref:`float` value **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size` **(** **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat64Array` | :ref:`slice` **(** :ref:`int` begin, :ref:`int` end=2147483647 **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`sort` **(** **)** | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | - +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`float`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedFloat64Array`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`float`, before\: :ref:`bool` = true\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`float`\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat64Array` | :ref:`duplicate`\ (\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`float`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`float`, from\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`float`\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`float`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`float`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`float`, from\: :ref:`int` = -1\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`float`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat64Array` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sort`\ (\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_byte_array`\ (\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -101,15 +101,15 @@ Operators .. table:: :widths: auto - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`PackedFloat64Array` right **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat64Array` | :ref:`operator +` **(** :ref:`PackedFloat64Array` right **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`PackedFloat64Array` right **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator []` **(** :ref:`int` index **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`PackedFloat64Array`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat64Array` | :ref:`operator +`\ (\ right\: :ref:`PackedFloat64Array`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`PackedFloat64Array`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -124,7 +124,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedFloat64Array` **PackedFloat64Array** **(** **)** +:ref:`PackedFloat64Array` **PackedFloat64Array**\ (\ ) Constructs an empty **PackedFloat64Array**. @@ -134,7 +134,7 @@ Constructs an empty **PackedFloat64Array**. .. rst-class:: classref-constructor -:ref:`PackedFloat64Array` **PackedFloat64Array** **(** :ref:`PackedFloat64Array` from **)** +:ref:`PackedFloat64Array` **PackedFloat64Array**\ (\ from\: :ref:`PackedFloat64Array`\ ) Constructs a **PackedFloat64Array** as a copy of the given **PackedFloat64Array**. @@ -144,7 +144,7 @@ Constructs a **PackedFloat64Array** as a copy of the given **PackedFloat64Array* .. rst-class:: classref-constructor -:ref:`PackedFloat64Array` **PackedFloat64Array** **(** :ref:`Array` from **)** +:ref:`PackedFloat64Array` **PackedFloat64Array**\ (\ from\: :ref:`Array`\ ) Constructs a new **PackedFloat64Array**. Optionally, you can pass in a generic :ref:`Array` that will be converted. @@ -161,7 +161,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append** **(** :ref:`float` value **)** +:ref:`bool` **append**\ (\ value\: :ref:`float`\ ) Appends an element at the end of the array (alias of :ref:`push_back`). @@ -173,7 +173,7 @@ Appends an element at the end of the array (alias of :ref:`push_back` array **)** +|void| **append_array**\ (\ array\: :ref:`PackedFloat64Array`\ ) Appends a **PackedFloat64Array** at the end of this array. @@ -185,7 +185,7 @@ Appends a **PackedFloat64Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch** **(** :ref:`float` value, :ref:`bool` before=true **)** +:ref:`int` **bsearch**\ (\ value\: :ref:`float`, before\: :ref:`bool` = true\ ) Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -201,7 +201,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -213,7 +213,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count** **(** :ref:`float` value **)** |const| +:ref:`int` **count**\ (\ value\: :ref:`float`\ ) |const| Returns the number of times an element is in the array. @@ -227,7 +227,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`PackedFloat64Array` **duplicate** **(** **)** +:ref:`PackedFloat64Array` **duplicate**\ (\ ) Creates a copy of the array, and returns it. @@ -239,7 +239,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -void **fill** **(** :ref:`float` value **)** +|void| **fill**\ (\ value\: :ref:`float`\ ) Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -251,7 +251,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find** **(** :ref:`float` value, :ref:`int` from=0 **)** |const| +:ref:`int` **find**\ (\ value\: :ref:`float`, from\: :ref:`int` = 0\ ) |const| Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -265,7 +265,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`bool` **has** **(** :ref:`float` value **)** |const| +:ref:`bool` **has**\ (\ value\: :ref:`float`\ ) |const| Returns ``true`` if the array contains ``value``. @@ -279,7 +279,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`int` **insert** **(** :ref:`int` at_index, :ref:`float` value **)** +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`float`\ ) Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -291,7 +291,7 @@ Inserts a new element at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty** **(** **)** |const| +:ref:`bool` **is_empty**\ (\ ) |const| Returns ``true`` if the array is empty. @@ -303,7 +303,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back** **(** :ref:`float` value **)** +:ref:`bool` **push_back**\ (\ value\: :ref:`float`\ ) Appends an element at the end of the array. @@ -315,7 +315,7 @@ Appends an element at the end of the array. .. rst-class:: classref-method -void **remove_at** **(** :ref:`int` index **)** +|void| **remove_at**\ (\ index\: :ref:`int`\ ) Removes an element from the array by index. @@ -327,7 +327,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize** **(** :ref:`int` new_size **)** +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) 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` once and assigning the new values is faster than adding new elements one by one. @@ -339,7 +339,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -void **reverse** **(** **)** +|void| **reverse**\ (\ ) Reverses the order of the elements in the array. @@ -351,7 +351,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind** **(** :ref:`float` value, :ref:`int` from=-1 **)** |const| +:ref:`int` **rfind**\ (\ value\: :ref:`float`, from\: :ref:`int` = -1\ ) |const| Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -365,7 +365,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -void **set** **(** :ref:`int` index, :ref:`float` value **)** +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`float`\ ) Changes the float at the given index. @@ -377,7 +377,7 @@ Changes the float at the given index. .. rst-class:: classref-method -:ref:`int` **size** **(** **)** |const| +:ref:`int` **size**\ (\ ) |const| Returns the number of elements in the array. @@ -389,7 +389,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedFloat64Array` **slice** **(** :ref:`int` begin, :ref:`int` end=2147483647 **)** |const| +:ref:`PackedFloat64Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| Returns the slice of the **PackedFloat64Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedFloat64Array**. @@ -405,7 +405,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -void **sort** **(** **)** +|void| **sort**\ (\ ) Sorts the elements of the array in ascending order. @@ -419,7 +419,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_byte_array** **(** **)** |const| +:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| Returns a copy of the data converted to a :ref:`PackedByteArray`, where each element have been encoded as 8 bytes. @@ -438,7 +438,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`PackedFloat64Array` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedFloat64Array`\ ) Returns ``true`` if contents of the arrays differ. @@ -450,7 +450,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedFloat64Array` **operator +** **(** :ref:`PackedFloat64Array` right **)** +:ref:`PackedFloat64Array` **operator +**\ (\ right\: :ref:`PackedFloat64Array`\ ) Returns a new **PackedFloat64Array** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -462,7 +462,7 @@ Returns a new **PackedFloat64Array** with contents of ``right`` added at the end .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`PackedFloat64Array` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedFloat64Array`\ ) Returns ``true`` if contents of both arrays are the same, i.e. they have all equal doubles at the corresponding indices. @@ -474,7 +474,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`float` **operator []** **(** :ref:`int` index **)** +:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) Returns the :ref:`float` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. @@ -485,3 +485,4 @@ Returns the :ref:`float` at index ``index``. Negative indices can b .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_packedint32array.rst b/classes/class_packedint32array.rst index 24144df2108..024f6d9cd82 100644 --- a/classes/class_packedint32array.rst +++ b/classes/class_packedint32array.rst @@ -33,13 +33,13 @@ Constructors .. table:: :widths: auto - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`PackedInt32Array` **(** **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`PackedInt32Array` **(** :ref:`PackedInt32Array` from **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`PackedInt32Array` **(** :ref:`Array` from **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`PackedInt32Array`\ (\ ) | + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`PackedInt32Array`\ (\ from\: :ref:`PackedInt32Array`\ ) | + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`PackedInt32Array`\ (\ from\: :ref:`Array`\ ) | + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -49,49 +49,49 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`append` **(** :ref:`int` value **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`append_array` **(** :ref:`PackedInt32Array` array **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch` **(** :ref:`int` value, :ref:`bool` before=true **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count` **(** :ref:`int` value **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`duplicate` **(** **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fill` **(** :ref:`int` value **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find` **(** :ref:`int` value, :ref:`int` from=0 **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has` **(** :ref:`int` value **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`insert` **(** :ref:`int` at_index, :ref:`int` value **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty` **(** **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_back` **(** :ref:`int` value **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_at` **(** :ref:`int` index **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reverse` **(** **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind` **(** :ref:`int` value, :ref:`int` from=-1 **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set` **(** :ref:`int` index, :ref:`int` value **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size` **(** **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`slice` **(** :ref:`int` begin, :ref:`int` end=2147483647 **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`sort` **(** **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedInt32Array`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`duplicate`\ (\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`int`, from\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sort`\ (\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_byte_array`\ (\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -101,15 +101,15 @@ Operators .. table:: :widths: auto - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`PackedInt32Array` right **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`operator +` **(** :ref:`PackedInt32Array` right **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`PackedInt32Array` right **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator []` **(** :ref:`int` index **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`PackedInt32Array`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`operator +`\ (\ right\: :ref:`PackedInt32Array`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`PackedInt32Array`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -124,7 +124,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedInt32Array` **PackedInt32Array** **(** **)** +:ref:`PackedInt32Array` **PackedInt32Array**\ (\ ) Constructs an empty **PackedInt32Array**. @@ -134,7 +134,7 @@ Constructs an empty **PackedInt32Array**. .. rst-class:: classref-constructor -:ref:`PackedInt32Array` **PackedInt32Array** **(** :ref:`PackedInt32Array` from **)** +:ref:`PackedInt32Array` **PackedInt32Array**\ (\ from\: :ref:`PackedInt32Array`\ ) Constructs a **PackedInt32Array** as a copy of the given **PackedInt32Array**. @@ -144,7 +144,7 @@ Constructs a **PackedInt32Array** as a copy of the given **PackedInt32Array**. .. rst-class:: classref-constructor -:ref:`PackedInt32Array` **PackedInt32Array** **(** :ref:`Array` from **)** +:ref:`PackedInt32Array` **PackedInt32Array**\ (\ from\: :ref:`Array`\ ) Constructs a new **PackedInt32Array**. Optionally, you can pass in a generic :ref:`Array` that will be converted. @@ -161,7 +161,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append** **(** :ref:`int` value **)** +:ref:`bool` **append**\ (\ value\: :ref:`int`\ ) Appends an element at the end of the array (alias of :ref:`push_back`). @@ -173,7 +173,7 @@ Appends an element at the end of the array (alias of :ref:`push_back` array **)** +|void| **append_array**\ (\ array\: :ref:`PackedInt32Array`\ ) Appends a **PackedInt32Array** at the end of this array. @@ -185,7 +185,7 @@ Appends a **PackedInt32Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch** **(** :ref:`int` value, :ref:`bool` before=true **)** +:ref:`int` **bsearch**\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -199,7 +199,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -211,7 +211,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count** **(** :ref:`int` value **)** |const| +:ref:`int` **count**\ (\ value\: :ref:`int`\ ) |const| Returns the number of times an element is in the array. @@ -223,7 +223,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`PackedInt32Array` **duplicate** **(** **)** +:ref:`PackedInt32Array` **duplicate**\ (\ ) Creates a copy of the array, and returns it. @@ -235,7 +235,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -void **fill** **(** :ref:`int` value **)** +|void| **fill**\ (\ value\: :ref:`int`\ ) Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -247,7 +247,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find** **(** :ref:`int` value, :ref:`int` from=0 **)** |const| +:ref:`int` **find**\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -259,7 +259,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`bool` **has** **(** :ref:`int` value **)** |const| +:ref:`bool` **has**\ (\ value\: :ref:`int`\ ) |const| Returns ``true`` if the array contains ``value``. @@ -271,7 +271,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`int` **insert** **(** :ref:`int` at_index, :ref:`int` value **)** +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`int`\ ) Inserts a new integer at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -283,7 +283,7 @@ Inserts a new integer at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty** **(** **)** |const| +:ref:`bool` **is_empty**\ (\ ) |const| Returns ``true`` if the array is empty. @@ -295,7 +295,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back** **(** :ref:`int` value **)** +:ref:`bool` **push_back**\ (\ value\: :ref:`int`\ ) Appends a value to the array. @@ -307,7 +307,7 @@ Appends a value to the array. .. rst-class:: classref-method -void **remove_at** **(** :ref:`int` index **)** +|void| **remove_at**\ (\ index\: :ref:`int`\ ) Removes an element from the array by index. @@ -319,7 +319,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize** **(** :ref:`int` new_size **)** +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) 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` once and assigning the new values is faster than adding new elements one by one. @@ -331,7 +331,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -void **reverse** **(** **)** +|void| **reverse**\ (\ ) Reverses the order of the elements in the array. @@ -343,7 +343,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind** **(** :ref:`int` value, :ref:`int` from=-1 **)** |const| +:ref:`int` **rfind**\ (\ value\: :ref:`int`, from\: :ref:`int` = -1\ ) |const| Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -355,7 +355,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -void **set** **(** :ref:`int` index, :ref:`int` value **)** +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`int`\ ) Changes the integer at the given index. @@ -367,7 +367,7 @@ Changes the integer at the given index. .. rst-class:: classref-method -:ref:`int` **size** **(** **)** |const| +:ref:`int` **size**\ (\ ) |const| Returns the number of elements in the array. @@ -379,7 +379,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedInt32Array` **slice** **(** :ref:`int` begin, :ref:`int` end=2147483647 **)** |const| +:ref:`PackedInt32Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| Returns the slice of the **PackedInt32Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedInt32Array**. @@ -395,7 +395,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -void **sort** **(** **)** +|void| **sort**\ (\ ) Sorts the elements of the array in ascending order. @@ -407,7 +407,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_byte_array** **(** **)** |const| +:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| Returns a copy of the data converted to a :ref:`PackedByteArray`, where each element have been encoded as 4 bytes. @@ -426,7 +426,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`PackedInt32Array` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedInt32Array`\ ) Returns ``true`` if contents of the arrays differ. @@ -438,7 +438,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedInt32Array` **operator +** **(** :ref:`PackedInt32Array` right **)** +:ref:`PackedInt32Array` **operator +**\ (\ right\: :ref:`PackedInt32Array`\ ) Returns a new **PackedInt32Array** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -450,7 +450,7 @@ Returns a new **PackedInt32Array** with contents of ``right`` added at the end o .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`PackedInt32Array` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedInt32Array`\ ) Returns ``true`` if contents of both arrays are the same, i.e. they have all equal ints at the corresponding indices. @@ -462,7 +462,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`int` **operator []** **(** :ref:`int` index **)** +:ref:`int` **operator []**\ (\ index\: :ref:`int`\ ) Returns the :ref:`int` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. @@ -475,3 +475,4 @@ Note that :ref:`int` type is 64-bit, unlike the values stored in the .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_packedint64array.rst b/classes/class_packedint64array.rst index 419993dafa0..692e9c25164 100644 --- a/classes/class_packedint64array.rst +++ b/classes/class_packedint64array.rst @@ -33,13 +33,13 @@ Constructors .. table:: :widths: auto - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`PackedInt64Array` **(** **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`PackedInt64Array` **(** :ref:`PackedInt64Array` from **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`PackedInt64Array` **(** :ref:`Array` from **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`PackedInt64Array`\ (\ ) | + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`PackedInt64Array`\ (\ from\: :ref:`PackedInt64Array`\ ) | + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`PackedInt64Array`\ (\ from\: :ref:`Array`\ ) | + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -49,49 +49,49 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`append` **(** :ref:`int` value **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`append_array` **(** :ref:`PackedInt64Array` array **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch` **(** :ref:`int` value, :ref:`bool` before=true **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count` **(** :ref:`int` value **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`duplicate` **(** **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fill` **(** :ref:`int` value **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find` **(** :ref:`int` value, :ref:`int` from=0 **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has` **(** :ref:`int` value **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`insert` **(** :ref:`int` at_index, :ref:`int` value **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty` **(** **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_back` **(** :ref:`int` value **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_at` **(** :ref:`int` index **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reverse` **(** **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind` **(** :ref:`int` value, :ref:`int` from=-1 **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set` **(** :ref:`int` index, :ref:`int` value **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size` **(** **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`slice` **(** :ref:`int` begin, :ref:`int` end=2147483647 **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`sort` **(** **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedInt64Array`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`duplicate`\ (\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`int`\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`int`, from\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sort`\ (\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_byte_array`\ (\ ) |const| | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -101,15 +101,15 @@ Operators .. table:: :widths: auto - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`PackedInt64Array` right **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`operator +` **(** :ref:`PackedInt64Array` right **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`PackedInt64Array` right **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator []` **(** :ref:`int` index **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`PackedInt64Array`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`operator +`\ (\ right\: :ref:`PackedInt64Array`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`PackedInt64Array`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -124,7 +124,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedInt64Array` **PackedInt64Array** **(** **)** +:ref:`PackedInt64Array` **PackedInt64Array**\ (\ ) Constructs an empty **PackedInt64Array**. @@ -134,7 +134,7 @@ Constructs an empty **PackedInt64Array**. .. rst-class:: classref-constructor -:ref:`PackedInt64Array` **PackedInt64Array** **(** :ref:`PackedInt64Array` from **)** +:ref:`PackedInt64Array` **PackedInt64Array**\ (\ from\: :ref:`PackedInt64Array`\ ) Constructs a **PackedInt64Array** as a copy of the given **PackedInt64Array**. @@ -144,7 +144,7 @@ Constructs a **PackedInt64Array** as a copy of the given **PackedInt64Array**. .. rst-class:: classref-constructor -:ref:`PackedInt64Array` **PackedInt64Array** **(** :ref:`Array` from **)** +:ref:`PackedInt64Array` **PackedInt64Array**\ (\ from\: :ref:`Array`\ ) Constructs a new **PackedInt64Array**. Optionally, you can pass in a generic :ref:`Array` that will be converted. @@ -161,7 +161,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append** **(** :ref:`int` value **)** +:ref:`bool` **append**\ (\ value\: :ref:`int`\ ) Appends an element at the end of the array (alias of :ref:`push_back`). @@ -173,7 +173,7 @@ Appends an element at the end of the array (alias of :ref:`push_back` array **)** +|void| **append_array**\ (\ array\: :ref:`PackedInt64Array`\ ) Appends a **PackedInt64Array** at the end of this array. @@ -185,7 +185,7 @@ Appends a **PackedInt64Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch** **(** :ref:`int` value, :ref:`bool` before=true **)** +:ref:`int` **bsearch**\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -199,7 +199,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -211,7 +211,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count** **(** :ref:`int` value **)** |const| +:ref:`int` **count**\ (\ value\: :ref:`int`\ ) |const| Returns the number of times an element is in the array. @@ -223,7 +223,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`PackedInt64Array` **duplicate** **(** **)** +:ref:`PackedInt64Array` **duplicate**\ (\ ) Creates a copy of the array, and returns it. @@ -235,7 +235,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -void **fill** **(** :ref:`int` value **)** +|void| **fill**\ (\ value\: :ref:`int`\ ) Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -247,7 +247,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find** **(** :ref:`int` value, :ref:`int` from=0 **)** |const| +:ref:`int` **find**\ (\ value\: :ref:`int`, from\: :ref:`int` = 0\ ) |const| Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -259,7 +259,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`bool` **has** **(** :ref:`int` value **)** |const| +:ref:`bool` **has**\ (\ value\: :ref:`int`\ ) |const| Returns ``true`` if the array contains ``value``. @@ -271,7 +271,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`int` **insert** **(** :ref:`int` at_index, :ref:`int` value **)** +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`int`\ ) Inserts a new integer at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -283,7 +283,7 @@ Inserts a new integer at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty** **(** **)** |const| +:ref:`bool` **is_empty**\ (\ ) |const| Returns ``true`` if the array is empty. @@ -295,7 +295,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back** **(** :ref:`int` value **)** +:ref:`bool` **push_back**\ (\ value\: :ref:`int`\ ) Appends a value to the array. @@ -307,7 +307,7 @@ Appends a value to the array. .. rst-class:: classref-method -void **remove_at** **(** :ref:`int` index **)** +|void| **remove_at**\ (\ index\: :ref:`int`\ ) Removes an element from the array by index. @@ -319,7 +319,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize** **(** :ref:`int` new_size **)** +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) 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` once and assigning the new values is faster than adding new elements one by one. @@ -331,7 +331,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -void **reverse** **(** **)** +|void| **reverse**\ (\ ) Reverses the order of the elements in the array. @@ -343,7 +343,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind** **(** :ref:`int` value, :ref:`int` from=-1 **)** |const| +:ref:`int` **rfind**\ (\ value\: :ref:`int`, from\: :ref:`int` = -1\ ) |const| Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -355,7 +355,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -void **set** **(** :ref:`int` index, :ref:`int` value **)** +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`int`\ ) Changes the integer at the given index. @@ -367,7 +367,7 @@ Changes the integer at the given index. .. rst-class:: classref-method -:ref:`int` **size** **(** **)** |const| +:ref:`int` **size**\ (\ ) |const| Returns the number of elements in the array. @@ -379,7 +379,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedInt64Array` **slice** **(** :ref:`int` begin, :ref:`int` end=2147483647 **)** |const| +:ref:`PackedInt64Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| Returns the slice of the **PackedInt64Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedInt64Array**. @@ -395,7 +395,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -void **sort** **(** **)** +|void| **sort**\ (\ ) Sorts the elements of the array in ascending order. @@ -407,7 +407,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_byte_array** **(** **)** |const| +:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| Returns a copy of the data converted to a :ref:`PackedByteArray`, where each element have been encoded as 8 bytes. @@ -426,7 +426,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`PackedInt64Array` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedInt64Array`\ ) Returns ``true`` if contents of the arrays differ. @@ -438,7 +438,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedInt64Array` **operator +** **(** :ref:`PackedInt64Array` right **)** +:ref:`PackedInt64Array` **operator +**\ (\ right\: :ref:`PackedInt64Array`\ ) Returns a new **PackedInt64Array** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -450,7 +450,7 @@ Returns a new **PackedInt64Array** with contents of ``right`` added at the end o .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`PackedInt64Array` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedInt64Array`\ ) Returns ``true`` if contents of both arrays are the same, i.e. they have all equal ints at the corresponding indices. @@ -462,7 +462,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`int` **operator []** **(** :ref:`int` index **)** +:ref:`int` **operator []**\ (\ index\: :ref:`int`\ ) Returns the :ref:`int` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. @@ -473,3 +473,4 @@ Returns the :ref:`int` at index ``index``. Negative indices can be us .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index be4503e48ff..841fd918bdc 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -128,15 +128,15 @@ Methods .. table:: :widths: auto - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`can_instantiate` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SceneState` | :ref:`get_state` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`instantiate` **(** :ref:`GenEditState` edit_state=0 **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`pack` **(** :ref:`Node` path **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`can_instantiate`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SceneState` | :ref:`get_state`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`instantiate`\ (\ edit_state\: :ref:`GenEditState` = 0\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`pack`\ (\ path\: :ref:`Node`\ ) | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -223,7 +223,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **can_instantiate** **(** **)** |const| +:ref:`bool` **can_instantiate**\ (\ ) |const| Returns ``true`` if the scene file has nodes. @@ -235,7 +235,7 @@ Returns ``true`` if the scene file has nodes. .. rst-class:: classref-method -:ref:`SceneState` **get_state** **(** **)** |const| +:ref:`SceneState` **get_state**\ (\ ) |const| Returns the :ref:`SceneState` representing the scene file contents. @@ -247,7 +247,7 @@ Returns the :ref:`SceneState` representing the scene file cont .. rst-class:: classref-method -:ref:`Node` **instantiate** **(** :ref:`GenEditState` edit_state=0 **)** |const| +:ref:`Node` **instantiate**\ (\ edit_state\: :ref:`GenEditState` = 0\ ) |const| Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers a :ref:`Node.NOTIFICATION_SCENE_INSTANTIATED` notification on the root node. @@ -259,7 +259,7 @@ Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). .. rst-class:: classref-method -:ref:`Error` **pack** **(** :ref:`Node` path **)** +:ref:`Error` **pack**\ (\ path\: :ref:`Node`\ ) Pack will ignore any sub-nodes not owned by given node. See :ref:`Node.owner`. @@ -270,3 +270,4 @@ Pack will ignore any sub-nodes not owned by given node. See :ref:`Node.owner` | :ref:`PackedStringArray` **(** **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`PackedStringArray` **(** :ref:`PackedStringArray` from **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`PackedStringArray` **(** :ref:`Array` from **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`PackedStringArray`\ (\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`PackedStringArray`\ (\ from\: :ref:`PackedStringArray`\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`PackedStringArray`\ (\ from\: :ref:`Array`\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -62,49 +62,49 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`append` **(** :ref:`String` value **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`append_array` **(** :ref:`PackedStringArray` array **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch` **(** :ref:`String` value, :ref:`bool` before=true **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count` **(** :ref:`String` value **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`duplicate` **(** **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fill` **(** :ref:`String` value **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find` **(** :ref:`String` value, :ref:`int` from=0 **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has` **(** :ref:`String` value **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`insert` **(** :ref:`int` at_index, :ref:`String` value **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_back` **(** :ref:`String` value **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_at` **(** :ref:`int` index **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reverse` **(** **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind` **(** :ref:`String` value, :ref:`int` from=-1 **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set` **(** :ref:`int` index, :ref:`String` value **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`slice` **(** :ref:`int` begin, :ref:`int` end=2147483647 **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`sort` **(** **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`String`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedStringArray`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`String`, before\: :ref:`bool` = true\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`String`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`duplicate`\ (\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`String`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`String`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`String`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`String`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`String`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sort`\ (\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_byte_array`\ (\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -114,15 +114,15 @@ Operators .. table:: :widths: auto - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`PackedStringArray` right **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`operator +` **(** :ref:`PackedStringArray` right **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`PackedStringArray` right **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`operator []` **(** :ref:`int` index **)** | - +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`PackedStringArray`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`operator +`\ (\ right\: :ref:`PackedStringArray`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`PackedStringArray`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -137,7 +137,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedStringArray` **PackedStringArray** **(** **)** +:ref:`PackedStringArray` **PackedStringArray**\ (\ ) Constructs an empty **PackedStringArray**. @@ -147,7 +147,7 @@ Constructs an empty **PackedStringArray**. .. rst-class:: classref-constructor -:ref:`PackedStringArray` **PackedStringArray** **(** :ref:`PackedStringArray` from **)** +:ref:`PackedStringArray` **PackedStringArray**\ (\ from\: :ref:`PackedStringArray`\ ) Constructs a **PackedStringArray** as a copy of the given **PackedStringArray**. @@ -157,7 +157,7 @@ Constructs a **PackedStringArray** as a copy of the given **PackedStringArray**. .. rst-class:: classref-constructor -:ref:`PackedStringArray` **PackedStringArray** **(** :ref:`Array` from **)** +:ref:`PackedStringArray` **PackedStringArray**\ (\ from\: :ref:`Array`\ ) Constructs a new **PackedStringArray**. Optionally, you can pass in a generic :ref:`Array` that will be converted. @@ -174,7 +174,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append** **(** :ref:`String` value **)** +:ref:`bool` **append**\ (\ value\: :ref:`String`\ ) Appends an element at the end of the array (alias of :ref:`push_back`). @@ -186,7 +186,7 @@ Appends an element at the end of the array (alias of :ref:`push_back` array **)** +|void| **append_array**\ (\ array\: :ref:`PackedStringArray`\ ) Appends a **PackedStringArray** at the end of this array. @@ -198,7 +198,7 @@ Appends a **PackedStringArray** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch** **(** :ref:`String` value, :ref:`bool` before=true **)** +:ref:`int` **bsearch**\ (\ value\: :ref:`String`, before\: :ref:`bool` = true\ ) Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -212,7 +212,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -224,7 +224,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count** **(** :ref:`String` value **)** |const| +:ref:`int` **count**\ (\ value\: :ref:`String`\ ) |const| Returns the number of times an element is in the array. @@ -236,7 +236,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`PackedStringArray` **duplicate** **(** **)** +:ref:`PackedStringArray` **duplicate**\ (\ ) Creates a copy of the array, and returns it. @@ -248,7 +248,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -void **fill** **(** :ref:`String` value **)** +|void| **fill**\ (\ value\: :ref:`String`\ ) Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -260,7 +260,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find** **(** :ref:`String` value, :ref:`int` from=0 **)** |const| +:ref:`int` **find**\ (\ value\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -272,7 +272,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`bool` **has** **(** :ref:`String` value **)** |const| +:ref:`bool` **has**\ (\ value\: :ref:`String`\ ) |const| Returns ``true`` if the array contains ``value``. @@ -284,7 +284,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`int` **insert** **(** :ref:`int` at_index, :ref:`String` value **)** +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`String`\ ) Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -296,7 +296,7 @@ Inserts a new element at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty** **(** **)** |const| +:ref:`bool` **is_empty**\ (\ ) |const| Returns ``true`` if the array is empty. @@ -308,7 +308,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back** **(** :ref:`String` value **)** +:ref:`bool` **push_back**\ (\ value\: :ref:`String`\ ) Appends a string element at end of the array. @@ -320,7 +320,7 @@ Appends a string element at end of the array. .. rst-class:: classref-method -void **remove_at** **(** :ref:`int` index **)** +|void| **remove_at**\ (\ index\: :ref:`int`\ ) Removes an element from the array by index. @@ -332,7 +332,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize** **(** :ref:`int` new_size **)** +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) 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` once and assigning the new values is faster than adding new elements one by one. @@ -344,7 +344,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -void **reverse** **(** **)** +|void| **reverse**\ (\ ) Reverses the order of the elements in the array. @@ -356,7 +356,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind** **(** :ref:`String` value, :ref:`int` from=-1 **)** |const| +:ref:`int` **rfind**\ (\ value\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -368,7 +368,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -void **set** **(** :ref:`int` index, :ref:`String` value **)** +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`String`\ ) Changes the :ref:`String` at the given index. @@ -380,7 +380,7 @@ Changes the :ref:`String` at the given index. .. rst-class:: classref-method -:ref:`int` **size** **(** **)** |const| +:ref:`int` **size**\ (\ ) |const| Returns the number of elements in the array. @@ -392,7 +392,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedStringArray` **slice** **(** :ref:`int` begin, :ref:`int` end=2147483647 **)** |const| +:ref:`PackedStringArray` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| Returns the slice of the **PackedStringArray**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedStringArray**. @@ -408,7 +408,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -void **sort** **(** **)** +|void| **sort**\ (\ ) Sorts the elements of the array in ascending order. @@ -420,7 +420,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_byte_array** **(** **)** |const| +:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| Returns a :ref:`PackedByteArray` with each string encoded as bytes. @@ -437,7 +437,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`PackedStringArray` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedStringArray`\ ) Returns ``true`` if contents of the arrays differ. @@ -449,7 +449,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedStringArray` **operator +** **(** :ref:`PackedStringArray` right **)** +:ref:`PackedStringArray` **operator +**\ (\ right\: :ref:`PackedStringArray`\ ) Returns a new **PackedStringArray** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -461,7 +461,7 @@ Returns a new **PackedStringArray** with contents of ``right`` added at the end .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`PackedStringArray` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedStringArray`\ ) Returns ``true`` if contents of both arrays are the same, i.e. they have all equal :ref:`String`\ s at the corresponding indices. @@ -473,7 +473,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`String` **operator []** **(** :ref:`int` index **)** +:ref:`String` **operator []**\ (\ index\: :ref:`int`\ ) Returns the :ref:`String` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. @@ -484,3 +484,4 @@ Returns the :ref:`String` at index ``index``. Negative indices can .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_packedvector2array.rst b/classes/class_packedvector2array.rst index 1f961c694eb..4954e2fc3f0 100644 --- a/classes/class_packedvector2array.rst +++ b/classes/class_packedvector2array.rst @@ -38,13 +38,13 @@ Constructors .. table:: :widths: auto - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`PackedVector2Array` **(** **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`PackedVector2Array` **(** :ref:`PackedVector2Array` from **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`PackedVector2Array` **(** :ref:`Array` from **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`PackedVector2Array`\ (\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`PackedVector2Array`\ (\ from\: :ref:`PackedVector2Array`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`PackedVector2Array`\ (\ from\: :ref:`Array`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -54,49 +54,49 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`append` **(** :ref:`Vector2` value **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`append_array` **(** :ref:`PackedVector2Array` array **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch` **(** :ref:`Vector2` value, :ref:`bool` before=true **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count` **(** :ref:`Vector2` value **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`duplicate` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fill` **(** :ref:`Vector2` value **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find` **(** :ref:`Vector2` value, :ref:`int` from=0 **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has` **(** :ref:`Vector2` value **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`insert` **(** :ref:`int` at_index, :ref:`Vector2` value **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_back` **(** :ref:`Vector2` value **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_at` **(** :ref:`int` index **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reverse` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind` **(** :ref:`Vector2` value, :ref:`int` from=-1 **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set` **(** :ref:`int` index, :ref:`Vector2` value **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`slice` **(** :ref:`int` begin, :ref:`int` end=2147483647 **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`sort` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedVector2Array`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`Vector2`, before\: :ref:`bool` = true\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`Vector2`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`duplicate`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`Vector2`, from\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`Vector2`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`Vector2`, from\: :ref:`int` = -1\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sort`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_byte_array`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -106,17 +106,17 @@ Operators .. table:: :widths: auto - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`PackedVector2Array` right **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`operator *` **(** :ref:`Transform2D` right **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`operator +` **(** :ref:`PackedVector2Array` right **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`PackedVector2Array` right **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator []` **(** :ref:`int` index **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`PackedVector2Array`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`operator *`\ (\ right\: :ref:`Transform2D`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`operator +`\ (\ right\: :ref:`PackedVector2Array`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`PackedVector2Array`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -131,7 +131,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedVector2Array` **PackedVector2Array** **(** **)** +:ref:`PackedVector2Array` **PackedVector2Array**\ (\ ) Constructs an empty **PackedVector2Array**. @@ -141,7 +141,7 @@ Constructs an empty **PackedVector2Array**. .. rst-class:: classref-constructor -:ref:`PackedVector2Array` **PackedVector2Array** **(** :ref:`PackedVector2Array` from **)** +:ref:`PackedVector2Array` **PackedVector2Array**\ (\ from\: :ref:`PackedVector2Array`\ ) Constructs a **PackedVector2Array** as a copy of the given **PackedVector2Array**. @@ -151,7 +151,7 @@ Constructs a **PackedVector2Array** as a copy of the given **PackedVector2Array* .. rst-class:: classref-constructor -:ref:`PackedVector2Array` **PackedVector2Array** **(** :ref:`Array` from **)** +:ref:`PackedVector2Array` **PackedVector2Array**\ (\ from\: :ref:`Array`\ ) Constructs a new **PackedVector2Array**. Optionally, you can pass in a generic :ref:`Array` that will be converted. @@ -174,7 +174,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append** **(** :ref:`Vector2` value **)** +:ref:`bool` **append**\ (\ value\: :ref:`Vector2`\ ) Appends an element at the end of the array (alias of :ref:`push_back`). @@ -186,7 +186,7 @@ Appends an element at the end of the array (alias of :ref:`push_back` array **)** +|void| **append_array**\ (\ array\: :ref:`PackedVector2Array`\ ) Appends a **PackedVector2Array** at the end of this array. @@ -198,7 +198,7 @@ Appends a **PackedVector2Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch** **(** :ref:`Vector2` value, :ref:`bool` before=true **)** +:ref:`int` **bsearch**\ (\ value\: :ref:`Vector2`, before\: :ref:`bool` = true\ ) Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -214,7 +214,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -226,7 +226,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count** **(** :ref:`Vector2` value **)** |const| +:ref:`int` **count**\ (\ value\: :ref:`Vector2`\ ) |const| Returns the number of times an element is in the array. @@ -240,7 +240,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`PackedVector2Array` **duplicate** **(** **)** +:ref:`PackedVector2Array` **duplicate**\ (\ ) Creates a copy of the array, and returns it. @@ -252,7 +252,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -void **fill** **(** :ref:`Vector2` value **)** +|void| **fill**\ (\ value\: :ref:`Vector2`\ ) Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -264,7 +264,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find** **(** :ref:`Vector2` value, :ref:`int` from=0 **)** |const| +:ref:`int` **find**\ (\ value\: :ref:`Vector2`, from\: :ref:`int` = 0\ ) |const| Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -278,7 +278,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`bool` **has** **(** :ref:`Vector2` value **)** |const| +:ref:`bool` **has**\ (\ value\: :ref:`Vector2`\ ) |const| Returns ``true`` if the array contains ``value``. @@ -292,7 +292,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`int` **insert** **(** :ref:`int` at_index, :ref:`Vector2` value **)** +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`Vector2`\ ) Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -304,7 +304,7 @@ Inserts a new element at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty** **(** **)** |const| +:ref:`bool` **is_empty**\ (\ ) |const| Returns ``true`` if the array is empty. @@ -316,7 +316,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back** **(** :ref:`Vector2` value **)** +:ref:`bool` **push_back**\ (\ value\: :ref:`Vector2`\ ) Inserts a :ref:`Vector2` at the end. @@ -328,7 +328,7 @@ Inserts a :ref:`Vector2` at the end. .. rst-class:: classref-method -void **remove_at** **(** :ref:`int` index **)** +|void| **remove_at**\ (\ index\: :ref:`int`\ ) Removes an element from the array by index. @@ -340,7 +340,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize** **(** :ref:`int` new_size **)** +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) 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` once and assigning the new values is faster than adding new elements one by one. @@ -352,7 +352,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -void **reverse** **(** **)** +|void| **reverse**\ (\ ) Reverses the order of the elements in the array. @@ -364,7 +364,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind** **(** :ref:`Vector2` value, :ref:`int` from=-1 **)** |const| +:ref:`int` **rfind**\ (\ value\: :ref:`Vector2`, from\: :ref:`int` = -1\ ) |const| Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -378,7 +378,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -void **set** **(** :ref:`int` index, :ref:`Vector2` value **)** +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`Vector2`\ ) Changes the :ref:`Vector2` at the given index. @@ -390,7 +390,7 @@ Changes the :ref:`Vector2` at the given index. .. rst-class:: classref-method -:ref:`int` **size** **(** **)** |const| +:ref:`int` **size**\ (\ ) |const| Returns the number of elements in the array. @@ -402,7 +402,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedVector2Array` **slice** **(** :ref:`int` begin, :ref:`int` end=2147483647 **)** |const| +:ref:`PackedVector2Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| Returns the slice of the **PackedVector2Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedVector2Array**. @@ -418,7 +418,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -void **sort** **(** **)** +|void| **sort**\ (\ ) Sorts the elements of the array in ascending order. @@ -432,7 +432,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_byte_array** **(** **)** |const| +:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| Returns a :ref:`PackedByteArray` with each vector encoded as bytes. @@ -449,7 +449,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`PackedVector2Array` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedVector2Array`\ ) Returns ``true`` if contents of the arrays differ. @@ -461,7 +461,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedVector2Array` **operator *** **(** :ref:`Transform2D` right **)** +:ref:`PackedVector2Array` **operator ***\ (\ right\: :ref:`Transform2D`\ ) Returns a new **PackedVector2Array** with all vectors in this array inversely transformed (multiplied) by the given :ref:`Transform2D` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). @@ -477,7 +477,7 @@ For transforming by inverse of an affine transformation (e.g. with scaling) ``tr .. rst-class:: classref-operator -:ref:`PackedVector2Array` **operator +** **(** :ref:`PackedVector2Array` right **)** +:ref:`PackedVector2Array` **operator +**\ (\ right\: :ref:`PackedVector2Array`\ ) Returns a new **PackedVector2Array** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -489,7 +489,7 @@ Returns a new **PackedVector2Array** with contents of ``right`` added at the end .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`PackedVector2Array` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedVector2Array`\ ) Returns ``true`` if contents of both arrays are the same, i.e. they have all equal :ref:`Vector2`\ s at the corresponding indices. @@ -501,7 +501,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`Vector2` **operator []** **(** :ref:`int` index **)** +:ref:`Vector2` **operator []**\ (\ index\: :ref:`int`\ ) Returns the :ref:`Vector2` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. @@ -512,3 +512,4 @@ Returns the :ref:`Vector2` at index ``index``. Negative indices c .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_packedvector3array.rst b/classes/class_packedvector3array.rst index d2e7b0e3fb1..93b983409b2 100644 --- a/classes/class_packedvector3array.rst +++ b/classes/class_packedvector3array.rst @@ -31,13 +31,13 @@ Constructors .. table:: :widths: auto - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`PackedVector3Array` **(** **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`PackedVector3Array` **(** :ref:`PackedVector3Array` from **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`PackedVector3Array` **(** :ref:`Array` from **)** | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`PackedVector3Array`\ (\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`PackedVector3Array`\ (\ from\: :ref:`PackedVector3Array`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`PackedVector3Array`\ (\ from\: :ref:`Array`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -47,49 +47,49 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`append` **(** :ref:`Vector3` value **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`append_array` **(** :ref:`PackedVector3Array` array **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bsearch` **(** :ref:`Vector3` value, :ref:`bool` before=true **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count` **(** :ref:`Vector3` value **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`duplicate` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fill` **(** :ref:`Vector3` value **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find` **(** :ref:`Vector3` value, :ref:`int` from=0 **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has` **(** :ref:`Vector3` value **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`insert` **(** :ref:`int` at_index, :ref:`Vector3` value **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`push_back` **(** :ref:`Vector3` value **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_at` **(** :ref:`int` index **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`resize` **(** :ref:`int` new_size **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reverse` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind` **(** :ref:`Vector3` value, :ref:`int` from=-1 **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set` **(** :ref:`int` index, :ref:`Vector3` value **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`size` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`slice` **(** :ref:`int` begin, :ref:`int` end=2147483647 **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`sort` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_byte_array` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`append`\ (\ value\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_array`\ (\ array\: :ref:`PackedVector3Array`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`Vector3`, before\: :ref:`bool` = true\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ value\: :ref:`Vector3`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`duplicate`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fill`\ (\ value\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ value\: :ref:`Vector3`, from\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ value\: :ref:`Vector3`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`insert`\ (\ at_index\: :ref:`int`, value\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`push_back`\ (\ value\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_at`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`resize`\ (\ new_size\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reverse`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ value\: :ref:`Vector3`, from\: :ref:`int` = -1\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set`\ (\ index\: :ref:`int`, value\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`slice`\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sort`\ (\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_byte_array`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -99,17 +99,17 @@ Operators .. table:: :widths: auto - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`PackedVector3Array` right **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`operator *` **(** :ref:`Transform3D` right **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`operator +` **(** :ref:`PackedVector3Array` right **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`PackedVector3Array` right **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator []` **(** :ref:`int` index **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`PackedVector3Array`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`operator *`\ (\ right\: :ref:`Transform3D`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`operator +`\ (\ right\: :ref:`PackedVector3Array`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`PackedVector3Array`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -124,7 +124,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`PackedVector3Array` **PackedVector3Array** **(** **)** +:ref:`PackedVector3Array` **PackedVector3Array**\ (\ ) Constructs an empty **PackedVector3Array**. @@ -134,7 +134,7 @@ Constructs an empty **PackedVector3Array**. .. rst-class:: classref-constructor -:ref:`PackedVector3Array` **PackedVector3Array** **(** :ref:`PackedVector3Array` from **)** +:ref:`PackedVector3Array` **PackedVector3Array**\ (\ from\: :ref:`PackedVector3Array`\ ) Constructs a **PackedVector3Array** as a copy of the given **PackedVector3Array**. @@ -144,7 +144,7 @@ Constructs a **PackedVector3Array** as a copy of the given **PackedVector3Array* .. rst-class:: classref-constructor -:ref:`PackedVector3Array` **PackedVector3Array** **(** :ref:`Array` from **)** +:ref:`PackedVector3Array` **PackedVector3Array**\ (\ from\: :ref:`Array`\ ) Constructs a new **PackedVector3Array**. Optionally, you can pass in a generic :ref:`Array` that will be converted. @@ -167,7 +167,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **append** **(** :ref:`Vector3` value **)** +:ref:`bool` **append**\ (\ value\: :ref:`Vector3`\ ) Appends an element at the end of the array (alias of :ref:`push_back`). @@ -179,7 +179,7 @@ Appends an element at the end of the array (alias of :ref:`push_back` array **)** +|void| **append_array**\ (\ array\: :ref:`PackedVector3Array`\ ) Appends a **PackedVector3Array** at the end of this array. @@ -191,7 +191,7 @@ Appends a **PackedVector3Array** at the end of this array. .. rst-class:: classref-method -:ref:`int` **bsearch** **(** :ref:`Vector3` value, :ref:`bool` before=true **)** +:ref:`int` **bsearch**\ (\ value\: :ref:`Vector3`, before\: :ref:`bool` = true\ ) Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -207,7 +207,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the array. This is equivalent to using :ref:`resize` with a size of ``0``. @@ -219,7 +219,7 @@ Clears the array. This is equivalent to using :ref:`resize` **count** **(** :ref:`Vector3` value **)** |const| +:ref:`int` **count**\ (\ value\: :ref:`Vector3`\ ) |const| Returns the number of times an element is in the array. @@ -233,7 +233,7 @@ Returns the number of times an element is in the array. .. rst-class:: classref-method -:ref:`PackedVector3Array` **duplicate** **(** **)** +:ref:`PackedVector3Array` **duplicate**\ (\ ) Creates a copy of the array, and returns it. @@ -245,7 +245,7 @@ Creates a copy of the array, and returns it. .. rst-class:: classref-method -void **fill** **(** :ref:`Vector3` value **)** +|void| **fill**\ (\ value\: :ref:`Vector3`\ ) Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize` to create an array with a given size and initialized elements. @@ -257,7 +257,7 @@ Assigns the given value to all elements in the array. This can typically be used .. rst-class:: classref-method -:ref:`int` **find** **(** :ref:`Vector3` value, :ref:`int` from=0 **)** |const| +:ref:`int` **find**\ (\ value\: :ref:`Vector3`, from\: :ref:`int` = 0\ ) |const| Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed. @@ -271,7 +271,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt .. rst-class:: classref-method -:ref:`bool` **has** **(** :ref:`Vector3` value **)** |const| +:ref:`bool` **has**\ (\ value\: :ref:`Vector3`\ ) |const| Returns ``true`` if the array contains ``value``. @@ -285,7 +285,7 @@ Returns ``true`` if the array contains ``value``. .. rst-class:: classref-method -:ref:`int` **insert** **(** :ref:`int` at_index, :ref:`Vector3` value **)** +:ref:`int` **insert**\ (\ at_index\: :ref:`int`, value\: :ref:`Vector3`\ ) Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). @@ -297,7 +297,7 @@ Inserts a new element at a given position in the array. The position must be val .. rst-class:: classref-method -:ref:`bool` **is_empty** **(** **)** |const| +:ref:`bool` **is_empty**\ (\ ) |const| Returns ``true`` if the array is empty. @@ -309,7 +309,7 @@ Returns ``true`` if the array is empty. .. rst-class:: classref-method -:ref:`bool` **push_back** **(** :ref:`Vector3` value **)** +:ref:`bool` **push_back**\ (\ value\: :ref:`Vector3`\ ) Inserts a :ref:`Vector3` at the end. @@ -321,7 +321,7 @@ Inserts a :ref:`Vector3` at the end. .. rst-class:: classref-method -void **remove_at** **(** :ref:`int` index **)** +|void| **remove_at**\ (\ index\: :ref:`int`\ ) Removes an element from the array by index. @@ -333,7 +333,7 @@ Removes an element from the array by index. .. rst-class:: classref-method -:ref:`int` **resize** **(** :ref:`int` new_size **)** +:ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) 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` once and assigning the new values is faster than adding new elements one by one. @@ -345,7 +345,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end .. rst-class:: classref-method -void **reverse** **(** **)** +|void| **reverse**\ (\ ) Reverses the order of the elements in the array. @@ -357,7 +357,7 @@ Reverses the order of the elements in the array. .. rst-class:: classref-method -:ref:`int` **rfind** **(** :ref:`Vector3` value, :ref:`int` from=-1 **)** |const| +:ref:`int` **rfind**\ (\ value\: :ref:`Vector3`, from\: :ref:`int` = -1\ ) |const| Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -371,7 +371,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas .. rst-class:: classref-method -void **set** **(** :ref:`int` index, :ref:`Vector3` value **)** +|void| **set**\ (\ index\: :ref:`int`, value\: :ref:`Vector3`\ ) Changes the :ref:`Vector3` at the given index. @@ -383,7 +383,7 @@ Changes the :ref:`Vector3` at the given index. .. rst-class:: classref-method -:ref:`int` **size** **(** **)** |const| +:ref:`int` **size**\ (\ ) |const| Returns the number of elements in the array. @@ -395,7 +395,7 @@ Returns the number of elements in the array. .. rst-class:: classref-method -:ref:`PackedVector3Array` **slice** **(** :ref:`int` begin, :ref:`int` end=2147483647 **)** |const| +:ref:`PackedVector3Array` **slice**\ (\ begin\: :ref:`int`, end\: :ref:`int` = 2147483647\ ) |const| Returns the slice of the **PackedVector3Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedVector3Array**. @@ -411,7 +411,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of .. rst-class:: classref-method -void **sort** **(** **)** +|void| **sort**\ (\ ) Sorts the elements of the array in ascending order. @@ -425,7 +425,7 @@ Sorts the elements of the array in ascending order. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_byte_array** **(** **)** |const| +:ref:`PackedByteArray` **to_byte_array**\ (\ ) |const| Returns a :ref:`PackedByteArray` with each vector encoded as bytes. @@ -442,7 +442,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`PackedVector3Array` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`PackedVector3Array`\ ) Returns ``true`` if contents of the arrays differ. @@ -454,7 +454,7 @@ Returns ``true`` if contents of the arrays differ. .. rst-class:: classref-operator -:ref:`PackedVector3Array` **operator *** **(** :ref:`Transform3D` right **)** +:ref:`PackedVector3Array` **operator ***\ (\ right\: :ref:`Transform3D`\ ) Returns a new **PackedVector3Array** with all vectors in this array inversely transformed (multiplied) by the given :ref:`Transform3D` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). @@ -470,7 +470,7 @@ For transforming by inverse of an affine transformation (e.g. with scaling) ``tr .. rst-class:: classref-operator -:ref:`PackedVector3Array` **operator +** **(** :ref:`PackedVector3Array` right **)** +:ref:`PackedVector3Array` **operator +**\ (\ right\: :ref:`PackedVector3Array`\ ) Returns a new **PackedVector3Array** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array` instead. @@ -482,7 +482,7 @@ Returns a new **PackedVector3Array** with contents of ``right`` added at the end .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`PackedVector3Array` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`PackedVector3Array`\ ) Returns ``true`` if contents of both arrays are the same, i.e. they have all equal :ref:`Vector3`\ s at the corresponding indices. @@ -494,7 +494,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ .. rst-class:: classref-operator -:ref:`Vector3` **operator []** **(** :ref:`int` index **)** +:ref:`Vector3` **operator []**\ (\ index\: :ref:`int`\ ) Returns the :ref:`Vector3` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error. @@ -505,3 +505,4 @@ Returns the :ref:`Vector3` at index ``index``. Negative indices c .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index e929aa53a4e..e82251d7b00 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -45,19 +45,19 @@ Methods .. table:: :widths: auto - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_available_packet_count` **(** **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`get_packet` **(** **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`get_packet_error` **(** **)** |const| | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_var` **(** :ref:`bool` allow_objects=false **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`put_packet` **(** :ref:`PackedByteArray` buffer **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`put_var` **(** :ref:`Variant` var, :ref:`bool` full_objects=false **)** | - +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_available_packet_count`\ (\ ) |const| | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`get_packet`\ (\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`get_packet_error`\ (\ ) |const| | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_var`\ (\ allow_objects\: :ref:`bool` = false\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`put_packet`\ (\ buffer\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`put_var`\ (\ var\: :ref:`Variant`, full_objects\: :ref:`bool` = false\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -76,8 +76,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_encode_buffer_max_size** **(** :ref:`int` value **)** -- :ref:`int` **get_encode_buffer_max_size** **(** **)** +- |void| **set_encode_buffer_max_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_encode_buffer_max_size**\ (\ ) Maximum buffer size allowed when encoding :ref:`Variant`\ s. Raise this value to support heavier memory allocations. @@ -96,7 +96,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_available_packet_count** **(** **)** |const| +:ref:`int` **get_available_packet_count**\ (\ ) |const| Returns the number of packets currently available in the ring-buffer. @@ -108,7 +108,7 @@ Returns the number of packets currently available in the ring-buffer. .. rst-class:: classref-method -:ref:`PackedByteArray` **get_packet** **(** **)** +:ref:`PackedByteArray` **get_packet**\ (\ ) Gets a raw packet. @@ -120,7 +120,7 @@ Gets a raw packet. .. rst-class:: classref-method -:ref:`Error` **get_packet_error** **(** **)** |const| +:ref:`Error` **get_packet_error**\ (\ ) |const| Returns the error state of the last packet received (via :ref:`get_packet` and :ref:`get_var`). @@ -132,7 +132,7 @@ Returns the error state of the last packet received (via :ref:`get_packet` **get_var** **(** :ref:`bool` allow_objects=false **)** +:ref:`Variant` **get_var**\ (\ allow_objects\: :ref:`bool` = false\ ) Gets a Variant. If ``allow_objects`` is ``true``, decoding objects is allowed. @@ -148,7 +148,7 @@ Internally, this uses the same decoding mechanism as the :ref:`@GlobalScope.byte .. rst-class:: classref-method -:ref:`Error` **put_packet** **(** :ref:`PackedByteArray` buffer **)** +:ref:`Error` **put_packet**\ (\ buffer\: :ref:`PackedByteArray`\ ) Sends a raw packet. @@ -160,7 +160,7 @@ Sends a raw packet. .. rst-class:: classref-method -:ref:`Error` **put_var** **(** :ref:`Variant` var, :ref:`bool` full_objects=false **)** +:ref:`Error` **put_var**\ (\ var\: :ref:`Variant`, full_objects\: :ref:`bool` = false\ ) Sends a :ref:`Variant` as a packet. If ``full_objects`` is ``true``, encoding objects is allowed (and can potentially include code). @@ -173,3 +173,4 @@ Internally, this uses the same encoding mechanism as the :ref:`@GlobalScope.var_ .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_packetpeerdtls.rst b/classes/class_packetpeerdtls.rst index b9551d35313..36833923807 100644 --- a/classes/class_packetpeerdtls.rst +++ b/classes/class_packetpeerdtls.rst @@ -33,15 +33,15 @@ Methods .. table:: :widths: auto - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`connect_to_peer` **(** :ref:`PacketPeerUDP` packet_peer, :ref:`String` hostname, :ref:`TLSOptions` client_options=null **)** | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`disconnect_from_peer` **(** **)** | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Status` | :ref:`get_status` **(** **)** |const| | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`poll` **(** **)** | - +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`connect_to_peer`\ (\ packet_peer\: :ref:`PacketPeerUDP`, hostname\: :ref:`String`, client_options\: :ref:`TLSOptions` = null\ ) | + +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`disconnect_from_peer`\ (\ ) | + +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Status` | :ref:`get_status`\ (\ ) |const| | + +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`poll`\ (\ ) | + +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -111,7 +111,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **connect_to_peer** **(** :ref:`PacketPeerUDP` packet_peer, :ref:`String` hostname, :ref:`TLSOptions` client_options=null **)** +:ref:`Error` **connect_to_peer**\ (\ packet_peer\: :ref:`PacketPeerUDP`, hostname\: :ref:`String`, client_options\: :ref:`TLSOptions` = null\ ) Connects a ``packet_peer`` beginning the DTLS handshake using the underlying :ref:`PacketPeerUDP` which must be connected (see :ref:`PacketPeerUDP.connect_to_host`). You can optionally specify the ``client_options`` to be used while verifying the TLS connections. See :ref:`TLSOptions.client` and :ref:`TLSOptions.client_unsafe`. @@ -123,7 +123,7 @@ Connects a ``packet_peer`` beginning the DTLS handshake using the underlying :re .. rst-class:: classref-method -void **disconnect_from_peer** **(** **)** +|void| **disconnect_from_peer**\ (\ ) Disconnects this peer, terminating the DTLS session. @@ -135,7 +135,7 @@ Disconnects this peer, terminating the DTLS session. .. rst-class:: classref-method -:ref:`Status` **get_status** **(** **)** |const| +:ref:`Status` **get_status**\ (\ ) |const| Returns the status of the connection. See :ref:`Status` for values. @@ -147,7 +147,7 @@ Returns the status of the connection. See :ref:`Status` | :ref:`_get_available_packet_count` **(** **)** |virtual| |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_max_packet_size` **(** **)** |virtual| |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_get_packet` **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_put_packet` **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_available_packet_count`\ (\ ) |virtual| |const| | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_max_packet_size`\ (\ ) |virtual| |const| | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_get_packet`\ (\ r_buffer\: ``const uint8_t **``, r_buffer_size\: ``int32_t*``\ ) |virtual| | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_put_packet`\ (\ p_buffer\: ``const uint8_t*``, p_buffer_size\: :ref:`int`\ ) |virtual| | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -47,7 +47,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_available_packet_count** **(** **)** |virtual| |const| +:ref:`int` **_get_available_packet_count**\ (\ ) |virtual| |const| .. container:: contribute @@ -61,7 +61,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_max_packet_size** **(** **)** |virtual| |const| +:ref:`int` **_get_max_packet_size**\ (\ ) |virtual| |const| .. container:: contribute @@ -75,7 +75,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_get_packet** **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| +:ref:`Error` **_get_packet**\ (\ r_buffer\: ``const uint8_t **``, r_buffer_size\: ``int32_t*``\ ) |virtual| .. container:: contribute @@ -89,7 +89,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_put_packet** **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| +:ref:`Error` **_put_packet**\ (\ p_buffer\: ``const uint8_t*``, p_buffer_size\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -102,3 +102,4 @@ Method Descriptions .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index 1de903a9ccd..d5da79923f3 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -56,8 +56,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_input_buffer_max_size** **(** :ref:`int` value **)** -- :ref:`int` **get_input_buffer_max_size** **(** **)** +- |void| **set_input_buffer_max_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_input_buffer_max_size**\ (\ ) .. container:: contribute @@ -75,8 +75,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_output_buffer_max_size** **(** :ref:`int` value **)** -- :ref:`int` **get_output_buffer_max_size** **(** **)** +- |void| **set_output_buffer_max_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_output_buffer_max_size**\ (\ ) .. container:: contribute @@ -94,8 +94,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_stream_peer** **(** :ref:`StreamPeer` value **)** -- :ref:`StreamPeer` **get_stream_peer** **(** **)** +- |void| **set_stream_peer**\ (\ value\: :ref:`StreamPeer`\ ) +- :ref:`StreamPeer` **get_stream_peer**\ (\ ) The wrapped :ref:`StreamPeer` object. @@ -106,3 +106,4 @@ The wrapped :ref:`StreamPeer` object. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index 08595acba54..511e373f188 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -31,33 +31,33 @@ Methods .. table:: :widths: auto - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`bind` **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`close` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_local_port` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_packet_ip` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_packet_port` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_bound` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_socket_connected` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`join_multicast_group` **(** :ref:`String` multicast_address, :ref:`String` interface_name **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`leave_multicast_group` **(** :ref:`String` multicast_address, :ref:`String` interface_name **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_broadcast_enabled` **(** :ref:`bool` enabled **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`set_dest_address` **(** :ref:`String` host, :ref:`int` port **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`wait` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`bind`\ (\ port\: :ref:`int`, bind_address\: :ref:`String` = "*", recv_buf_size\: :ref:`int` = 65536\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`close`\ (\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`connect_to_host`\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_local_port`\ (\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_packet_ip`\ (\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_packet_port`\ (\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_bound`\ (\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_socket_connected`\ (\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`join_multicast_group`\ (\ multicast_address\: :ref:`String`, interface_name\: :ref:`String`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`leave_multicast_group`\ (\ multicast_address\: :ref:`String`, interface_name\: :ref:`String`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_broadcast_enabled`\ (\ enabled\: :ref:`bool`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`set_dest_address`\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`wait`\ (\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -72,7 +72,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **bind** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** +:ref:`Error` **bind**\ (\ port\: :ref:`int`, bind_address\: :ref:`String` = "*", recv_buf_size\: :ref:`int` = 65536\ ) Binds this **PacketPeerUDP** to the specified ``port`` and ``bind_address`` with a buffer size ``recv_buf_size``, allowing it to receive incoming packets. @@ -90,7 +90,7 @@ If ``bind_address`` is set to any valid address (e.g. ``"192.168.1.101"``, ``":: .. rst-class:: classref-method -void **close** **(** **)** +|void| **close**\ (\ ) Closes the **PacketPeerUDP**'s underlying UDP socket. @@ -102,7 +102,7 @@ Closes the **PacketPeerUDP**'s underlying UDP socket. .. rst-class:: classref-method -:ref:`Error` **connect_to_host** **(** :ref:`String` host, :ref:`int` port **)** +:ref:`Error` **connect_to_host**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) Calling this method connects this UDP peer to the given ``host``/``port`` pair. UDP is in reality connectionless, so this option only means that incoming packets from different addresses are automatically discarded, and that outgoing packets are always sent to the connected address (future calls to :ref:`set_dest_address` are not allowed). This method does not send any data to the remote peer, to do that, use :ref:`PacketPeer.put_var` or :ref:`PacketPeer.put_packet` as usual. See also :ref:`UDPServer`. @@ -116,7 +116,7 @@ Calling this method connects this UDP peer to the given ``host``/``port`` pair. .. rst-class:: classref-method -:ref:`int` **get_local_port** **(** **)** |const| +:ref:`int` **get_local_port**\ (\ ) |const| Returns the local port to which this peer is bound. @@ -128,7 +128,7 @@ Returns the local port to which this peer is bound. .. rst-class:: classref-method -:ref:`String` **get_packet_ip** **(** **)** |const| +:ref:`String` **get_packet_ip**\ (\ ) |const| Returns the IP of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet` or :ref:`PacketPeer.get_var`). @@ -140,7 +140,7 @@ Returns the IP of the remote peer that sent the last packet(that was received wi .. rst-class:: classref-method -:ref:`int` **get_packet_port** **(** **)** |const| +:ref:`int` **get_packet_port**\ (\ ) |const| Returns the port of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet` or :ref:`PacketPeer.get_var`). @@ -152,7 +152,7 @@ Returns the port of the remote peer that sent the last packet(that was received .. rst-class:: classref-method -:ref:`bool` **is_bound** **(** **)** |const| +:ref:`bool` **is_bound**\ (\ ) |const| Returns whether this **PacketPeerUDP** is bound to an address and can receive packets. @@ -164,7 +164,7 @@ Returns whether this **PacketPeerUDP** is bound to an address and can receive pa .. rst-class:: classref-method -:ref:`bool` **is_socket_connected** **(** **)** |const| +:ref:`bool` **is_socket_connected**\ (\ ) |const| Returns ``true`` if the UDP socket is open and has been connected to a remote address. See :ref:`connect_to_host`. @@ -176,7 +176,7 @@ Returns ``true`` if the UDP socket is open and has been connected to a remote ad .. rst-class:: classref-method -:ref:`Error` **join_multicast_group** **(** :ref:`String` multicast_address, :ref:`String` interface_name **)** +:ref:`Error` **join_multicast_group**\ (\ multicast_address\: :ref:`String`, interface_name\: :ref:`String`\ ) Joins the multicast group specified by ``multicast_address`` using the interface identified by ``interface_name``. @@ -192,7 +192,7 @@ You can join the same multicast group with multiple interfaces. Use :ref:`IP.get .. rst-class:: classref-method -:ref:`Error` **leave_multicast_group** **(** :ref:`String` multicast_address, :ref:`String` interface_name **)** +:ref:`Error` **leave_multicast_group**\ (\ multicast_address\: :ref:`String`, interface_name\: :ref:`String`\ ) Removes the interface identified by ``interface_name`` from the multicast group specified by ``multicast_address``. @@ -204,7 +204,7 @@ Removes the interface identified by ``interface_name`` from the multicast group .. rst-class:: classref-method -void **set_broadcast_enabled** **(** :ref:`bool` enabled **)** +|void| **set_broadcast_enabled**\ (\ enabled\: :ref:`bool`\ ) Enable or disable sending of broadcast packets (e.g. ``set_dest_address("255.255.255.255", 4343)``. This option is disabled by default. @@ -218,7 +218,7 @@ Enable or disable sending of broadcast packets (e.g. ``set_dest_address("255.255 .. rst-class:: classref-method -:ref:`Error` **set_dest_address** **(** :ref:`String` host, :ref:`int` port **)** +:ref:`Error` **set_dest_address**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) Sets the destination address and port for sending packets and variables. A hostname will be resolved using DNS if needed. @@ -232,7 +232,7 @@ Sets the destination address and port for sending packets and variables. A hostn .. rst-class:: classref-method -:ref:`Error` **wait** **(** **)** +:ref:`Error` **wait**\ (\ ) Waits for a packet to arrive on the bound address. See :ref:`bind`. @@ -280,3 +280,4 @@ Waits for a packet to arrive on the bound address. See :ref:`bind` of this control. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_panelcontainer.rst b/classes/class_panelcontainer.rst index 67886a98cbb..a96efac04f6 100644 --- a/classes/class_panelcontainer.rst +++ b/classes/class_panelcontainer.rst @@ -80,3 +80,4 @@ The style of **PanelContainer**'s background. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_panoramaskymaterial.rst b/classes/class_panoramaskymaterial.rst index 865d2dfa9cd..b719114b091 100644 --- a/classes/class_panoramaskymaterial.rst +++ b/classes/class_panoramaskymaterial.rst @@ -58,8 +58,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_energy_multiplier** **(** :ref:`float` value **)** -- :ref:`float` **get_energy_multiplier** **(** **)** +- |void| **set_energy_multiplier**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_energy_multiplier**\ (\ ) The sky's overall brightness multiplier. Higher values result in a brighter sky. @@ -75,8 +75,8 @@ The sky's overall brightness multiplier. Higher values result in a brighter sky. .. rst-class:: classref-property-setget -- void **set_filtering_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_filtering_enabled** **(** **)** +- |void| **set_filtering_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_filtering_enabled**\ (\ ) A boolean value to determine if the background texture should be filtered or not. @@ -92,8 +92,8 @@ A boolean value to determine if the background texture should be filtered or not .. rst-class:: classref-property-setget -- void **set_panorama** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_panorama** **(** **)** +- |void| **set_panorama**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_panorama**\ (\ ) :ref:`Texture2D` to be applied to the **PanoramaSkyMaterial**. @@ -104,3 +104,4 @@ A boolean value to determine if the background texture should be filtered or not .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index fcab0d205bc..175ea0f5581 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -64,8 +64,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_scroll_base_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_scroll_base_offset** **(** **)** +- |void| **set_scroll_base_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_scroll_base_offset**\ (\ ) The base position offset for all :ref:`ParallaxLayer` children. @@ -81,8 +81,8 @@ The base position offset for all :ref:`ParallaxLayer` child .. rst-class:: classref-property-setget -- void **set_scroll_base_scale** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_scroll_base_scale** **(** **)** +- |void| **set_scroll_base_scale**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_scroll_base_scale**\ (\ ) The base motion scale for all :ref:`ParallaxLayer` children. @@ -98,8 +98,8 @@ The base motion scale for all :ref:`ParallaxLayer` children .. rst-class:: classref-property-setget -- void **set_ignore_camera_zoom** **(** :ref:`bool` value **)** -- :ref:`bool` **is_ignore_camera_zoom** **(** **)** +- |void| **set_ignore_camera_zoom**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_ignore_camera_zoom**\ (\ ) If ``true``, elements in :ref:`ParallaxLayer` child aren't affected by the zoom level of the camera. @@ -115,8 +115,8 @@ If ``true``, elements in :ref:`ParallaxLayer` child aren't .. rst-class:: classref-property-setget -- void **set_limit_begin** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_limit_begin** **(** **)** +- |void| **set_limit_begin**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_limit_begin**\ (\ ) Top-left limits for scrolling to begin. If the camera is outside of this limit, the background will stop scrolling. Must be lower than :ref:`scroll_limit_end` to work. @@ -132,8 +132,8 @@ Top-left limits for scrolling to begin. If the camera is outside of this limit, .. rst-class:: classref-property-setget -- void **set_limit_end** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_limit_end** **(** **)** +- |void| **set_limit_end**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_limit_end**\ (\ ) Bottom-right limits for scrolling to end. If the camera is outside of this limit, the background will stop scrolling. Must be higher than :ref:`scroll_limit_begin` to work. @@ -149,8 +149,8 @@ Bottom-right limits for scrolling to end. If the camera is outside of this limit .. rst-class:: classref-property-setget -- void **set_scroll_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_scroll_offset** **(** **)** +- |void| **set_scroll_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_scroll_offset**\ (\ ) The ParallaxBackground's scroll value. Calculated automatically when using a :ref:`Camera2D`, but can be used to manually manage scrolling when no camera is present. @@ -161,3 +161,4 @@ The ParallaxBackground's scroll value. Calculated automatically when using a :re .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index 174a4f9b166..915a843ee3a 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -58,8 +58,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_mirroring** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_mirroring** **(** **)** +- |void| **set_mirroring**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_mirroring**\ (\ ) 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. @@ -81,8 +81,8 @@ The interval, in pixels, at which the **ParallaxLayer** is drawn repeatedly. Use .. rst-class:: classref-property-setget -- void **set_motion_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_motion_offset** **(** **)** +- |void| **set_motion_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_motion_offset**\ (\ ) The ParallaxLayer's offset relative to the parent ParallaxBackground's :ref:`ParallaxBackground.scroll_offset`. @@ -98,8 +98,8 @@ The ParallaxLayer's offset relative to the parent ParallaxBackground's :ref:`Par .. rst-class:: classref-property-setget -- void **set_motion_scale** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_motion_scale** **(** **)** +- |void| **set_motion_scale**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_motion_scale**\ (\ ) Multiplies the ParallaxLayer's motion. If an axis is set to ``0``, it will not scroll. @@ -110,3 +110,4 @@ Multiplies the ParallaxLayer's motion. If an axis is set to ``0``, it will not s .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_particleprocessmaterial.rst b/classes/class_particleprocessmaterial.rst index ae102348b81..bcde4f7ef75 100644 --- a/classes/class_particleprocessmaterial.rst +++ b/classes/class_particleprocessmaterial.rst @@ -227,27 +227,27 @@ Methods .. table:: :widths: auto - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_param` **(** :ref:`Parameter` param **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_param_max` **(** :ref:`Parameter` param **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_param_min` **(** :ref:`Parameter` param **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_param_texture` **(** :ref:`Parameter` param **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_particle_flag` **(** :ref:`ParticleFlags` particle_flag **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_param` **(** :ref:`Parameter` param, :ref:`Vector2` value **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_param_max` **(** :ref:`Parameter` param, :ref:`float` value **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_param_min` **(** :ref:`Parameter` param, :ref:`float` value **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_param_texture` **(** :ref:`Parameter` param, :ref:`Texture2D` texture **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_particle_flag` **(** :ref:`ParticleFlags` particle_flag, :ref:`bool` enable **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_param`\ (\ param\: :ref:`Parameter`\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_param_max`\ (\ param\: :ref:`Parameter`\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_param_min`\ (\ param\: :ref:`Parameter`\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_param_texture`\ (\ param\: :ref:`Parameter`\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_particle_flag`\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_param`\ (\ param\: :ref:`Parameter`, value\: :ref:`Vector2`\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_param_max`\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_param_min`\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_param_texture`\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_particle_flag`\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -669,8 +669,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_alpha_curve** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_alpha_curve** **(** **)** +- |void| **set_alpha_curve**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_alpha_curve**\ (\ ) The alpha value of each particle's color will be multiplied by this :ref:`CurveTexture` over its lifetime. @@ -686,8 +686,8 @@ The alpha value of each particle's color will be multiplied by this :ref:`CurveT .. rst-class:: classref-property-setget -- void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_texture**\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_param_texture**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's rotation will be animated along this :ref:`CurveTexture`. @@ -703,8 +703,8 @@ Each particle's rotation will be animated along this :ref:`CurveTexture` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum initial rotation applied to each particle, in degrees. @@ -722,8 +722,8 @@ Only applied when :ref:`particle_flag_disable_z` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`angle_max`. @@ -739,8 +739,8 @@ Minimum equivalent of :ref:`angle_max` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_texture**\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_param_texture**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's angular velocity (rotation speed) will vary along this :ref:`CurveTexture` over its lifetime. @@ -756,8 +756,8 @@ Each particle's angular velocity (rotation speed) will vary along this :ref:`Cur .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum initial angular velocity (rotation speed) applied to each particle in *degrees* per second. @@ -775,8 +775,8 @@ Only applied when :ref:`particle_flag_disable_z` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`angular_velocity_max`. @@ -792,8 +792,8 @@ Minimum equivalent of :ref:`angular_velocity_max` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_texture**\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_param_texture**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's animation offset will vary along this :ref:`CurveTexture`. @@ -809,8 +809,8 @@ Each particle's animation offset will vary along this :ref:`CurveTexture` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum animation offset that corresponds to frame index in the texture. ``0`` is the first frame, ``1`` is the last one. See :ref:`CanvasItemMaterial.particles_animation`. @@ -826,8 +826,8 @@ Maximum animation offset that corresponds to frame index in the texture. ``0`` i .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`anim_offset_max`. @@ -843,8 +843,8 @@ Minimum equivalent of :ref:`anim_offset_max` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_texture**\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_param_texture**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's animation speed will vary along this :ref:`CurveTexture`. @@ -860,8 +860,8 @@ Each particle's animation speed will vary along this :ref:`CurveTexture` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum particle animation speed. Animation speed of ``1`` means that the particles will make full ``0`` to ``1`` offset cycle during lifetime, ``2`` means ``2`` cycles etc. @@ -879,8 +879,8 @@ With animation speed greater than ``1``, remember to enable :ref:`CanvasItemMate .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`anim_speed_max`. @@ -896,8 +896,8 @@ Minimum equivalent of :ref:`anim_speed_max` value **)** -- :ref:`bool` **is_attractor_interaction_enabled** **(** **)** +- |void| **set_attractor_interaction_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_attractor_interaction_enabled**\ (\ ) If ``true``, interaction with particle attractors is enabled. In 3D, attraction only occurs within the area defined by the :ref:`GPUParticles3D` node's :ref:`GPUParticles3D.visibility_aabb`. @@ -913,8 +913,8 @@ If ``true``, interaction with particle attractors is enabled. In 3D, attraction .. rst-class:: classref-property-setget -- void **set_collision_bounce** **(** :ref:`float` value **)** -- :ref:`float` **get_collision_bounce** **(** **)** +- |void| **set_collision_bounce**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_collision_bounce**\ (\ ) The particles' bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). Only effective if :ref:`collision_mode` is :ref:`COLLISION_RIGID`. @@ -930,8 +930,8 @@ The particles' bounciness. Values range from ``0`` (no bounce) to ``1`` (full bo .. rst-class:: classref-property-setget -- void **set_collision_friction** **(** :ref:`float` value **)** -- :ref:`float` **get_collision_friction** **(** **)** +- |void| **set_collision_friction**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_collision_friction**\ (\ ) The particles' friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Only effective if :ref:`collision_mode` is :ref:`COLLISION_RIGID`. @@ -947,8 +947,8 @@ The particles' friction. Values range from ``0`` (frictionless) to ``1`` (maximu .. rst-class:: classref-property-setget -- void **set_collision_mode** **(** :ref:`CollisionMode` value **)** -- :ref:`CollisionMode` **get_collision_mode** **(** **)** +- |void| **set_collision_mode**\ (\ value\: :ref:`CollisionMode`\ ) +- :ref:`CollisionMode` **get_collision_mode**\ (\ ) The particles' collision mode. @@ -968,8 +968,8 @@ The particles' collision mode. .. rst-class:: classref-property-setget -- void **set_collision_use_scale** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collision_using_scale** **(** **)** +- |void| **set_collision_use_scale**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collision_using_scale**\ (\ ) If ``true``, :ref:`GPUParticles3D.collision_base_size` is multiplied by the particle's effective scale (see :ref:`scale_min`, :ref:`scale_max`, :ref:`scale_curve`, and :ref:`scale_over_velocity_curve`). @@ -985,8 +985,8 @@ If ``true``, :ref:`GPUParticles3D.collision_base_size` value **)** -- :ref:`Color` **get_color** **(** **)** +- |void| **set_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_color**\ (\ ) Each particle's initial color. If the :ref:`GPUParticles2D`'s ``texture`` is defined, it will be multiplied by this color. @@ -1004,8 +1004,8 @@ Each particle's initial color. If the :ref:`GPUParticles2D .. rst-class:: classref-property-setget -- void **set_color_initial_ramp** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_color_initial_ramp** **(** **)** +- |void| **set_color_initial_ramp**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_color_initial_ramp**\ (\ ) Each particle's initial color will vary along this :ref:`GradientTexture1D` (multiplied with :ref:`color`). @@ -1023,8 +1023,8 @@ Each particle's initial color will vary along this :ref:`GradientTexture1D` value **)** -- :ref:`Texture2D` **get_color_ramp** **(** **)** +- |void| **set_color_ramp**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_color_ramp**\ (\ ) Each particle's color will vary along this :ref:`GradientTexture1D` over its lifetime (multiplied with :ref:`color`). @@ -1042,8 +1042,8 @@ Each particle's color will vary along this :ref:`GradientTexture1D` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_texture**\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_param_texture**\ (\ param\: :ref:`Parameter`\ ) |const| Damping will vary along this :ref:`CurveTexture`. @@ -1059,8 +1059,8 @@ Damping will vary along this :ref:`CurveTexture`. .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| The maximum rate at which particles lose velocity. For example value of ``100`` means that the particle will go from ``100`` velocity to ``0`` in ``1`` second. @@ -1076,8 +1076,8 @@ The maximum rate at which particles lose velocity. For example value of ``100`` .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`damping_max`. @@ -1093,8 +1093,8 @@ Minimum equivalent of :ref:`damping_max` value **)** -- :ref:`Vector3` **get_direction** **(** **)** +- |void| **set_direction**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_direction**\ (\ ) Unit vector specifying the particles' emission direction. @@ -1110,8 +1110,8 @@ Unit vector specifying the particles' emission direction. .. rst-class:: classref-property-setget -- void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_texture**\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_param_texture**\ (\ param\: :ref:`Parameter`\ ) |const| A curve that specifies the velocity along each of the axes of the particle system along its lifetime. @@ -1129,8 +1129,8 @@ A curve that specifies the velocity along each of the axes of the particle syste .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum directional velocity value, which is multiplied by :ref:`directional_velocity_curve`. @@ -1148,8 +1148,8 @@ Maximum directional velocity value, which is multiplied by :ref:`directional_vel .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum directional velocity value, which is multiplied by :ref:`directional_velocity_curve`. @@ -1167,8 +1167,8 @@ Minimum directional velocity value, which is multiplied by :ref:`directional_vel .. rst-class:: classref-property-setget -- void **set_emission_box_extents** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_emission_box_extents** **(** **)** +- |void| **set_emission_box_extents**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_emission_box_extents**\ (\ ) The box's extents if :ref:`emission_shape` is set to :ref:`EMISSION_SHAPE_BOX`. @@ -1184,8 +1184,8 @@ The box's extents if :ref:`emission_shape` value **)** -- :ref:`Texture2D` **get_emission_color_texture** **(** **)** +- |void| **set_emission_color_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_emission_color_texture**\ (\ ) Particle color will be modulated by color determined by sampling this texture at the same point as the :ref:`emission_point_texture`. @@ -1203,8 +1203,8 @@ Particle color will be modulated by color determined by sampling this texture at .. rst-class:: classref-property-setget -- void **set_emission_curve** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_emission_curve** **(** **)** +- |void| **set_emission_curve**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_emission_curve**\ (\ ) Each particle's color will be multiplied by this :ref:`CurveTexture` over its lifetime. @@ -1222,8 +1222,8 @@ Each particle's color will be multiplied by this :ref:`CurveTexture` value **)** -- :ref:`Texture2D` **get_emission_normal_texture** **(** **)** +- |void| **set_emission_normal_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_emission_normal_texture**\ (\ ) Particle velocity and rotation will be set by sampling this texture at the same point as the :ref:`emission_point_texture`. Used only in :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar. @@ -1239,8 +1239,8 @@ Particle velocity and rotation will be set by sampling this texture at the same .. rst-class:: classref-property-setget -- void **set_emission_point_count** **(** :ref:`int` value **)** -- :ref:`int` **get_emission_point_count** **(** **)** +- |void| **set_emission_point_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_emission_point_count**\ (\ ) The number of emission points if :ref:`emission_shape` is set to :ref:`EMISSION_SHAPE_POINTS` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. @@ -1256,8 +1256,8 @@ The number of emission points if :ref:`emission_shape` value **)** -- :ref:`Texture2D` **get_emission_point_texture** **(** **)** +- |void| **set_emission_point_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_emission_point_texture**\ (\ ) Particles will be emitted at positions determined by sampling this texture at a random position. Used with :ref:`EMISSION_SHAPE_POINTS` and :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar. @@ -1273,8 +1273,8 @@ Particles will be emitted at positions determined by sampling this texture at a .. rst-class:: classref-property-setget -- void **set_emission_ring_axis** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_emission_ring_axis** **(** **)** +- |void| **set_emission_ring_axis**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_emission_ring_axis**\ (\ ) The axis of the ring when using the emitter :ref:`EMISSION_SHAPE_RING`. @@ -1290,8 +1290,8 @@ The axis of the ring when using the emitter :ref:`EMISSION_SHAPE_RING` value **)** -- :ref:`float` **get_emission_ring_height** **(** **)** +- |void| **set_emission_ring_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_emission_ring_height**\ (\ ) The height of the ring when using the emitter :ref:`EMISSION_SHAPE_RING`. @@ -1307,8 +1307,8 @@ The height of the ring when using the emitter :ref:`EMISSION_SHAPE_RING` value **)** -- :ref:`float` **get_emission_ring_inner_radius** **(** **)** +- |void| **set_emission_ring_inner_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_emission_ring_inner_radius**\ (\ ) The inner radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING`. @@ -1324,8 +1324,8 @@ The inner radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING` value **)** -- :ref:`float` **get_emission_ring_radius** **(** **)** +- |void| **set_emission_ring_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_emission_ring_radius**\ (\ ) The radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING`. @@ -1341,8 +1341,8 @@ The radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING` value **)** -- :ref:`EmissionShape` **get_emission_shape** **(** **)** +- |void| **set_emission_shape**\ (\ value\: :ref:`EmissionShape`\ ) +- :ref:`EmissionShape` **get_emission_shape**\ (\ ) Particles will be emitted inside this region. Use :ref:`EmissionShape` constants for values. @@ -1358,8 +1358,8 @@ Particles will be emitted inside this region. Use :ref:`EmissionShape` value **)** -- :ref:`Vector3` **get_emission_shape_offset** **(** **)** +- |void| **set_emission_shape_offset**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_emission_shape_offset**\ (\ ) The offset for the :ref:`emission_shape`, in local space. @@ -1375,8 +1375,8 @@ The offset for the :ref:`emission_shape` value **)** -- :ref:`Vector3` **get_emission_shape_scale** **(** **)** +- |void| **set_emission_shape_scale**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_emission_shape_scale**\ (\ ) The scale of the :ref:`emission_shape`, in local space. @@ -1392,8 +1392,8 @@ The scale of the :ref:`emission_shape` value **)** -- :ref:`float` **get_emission_sphere_radius** **(** **)** +- |void| **set_emission_sphere_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_emission_sphere_radius**\ (\ ) The sphere's radius if :ref:`emission_shape` is set to :ref:`EMISSION_SHAPE_SPHERE`. @@ -1409,8 +1409,8 @@ The sphere's radius if :ref:`emission_shape` value **)** -- :ref:`float` **get_flatness** **(** **)** +- |void| **set_flatness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_flatness**\ (\ ) Amount of :ref:`spread` along the Y axis. @@ -1426,8 +1426,8 @@ Amount of :ref:`spread` along the .. rst-class:: classref-property-setget -- void **set_gravity** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_gravity** **(** **)** +- |void| **set_gravity**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_gravity**\ (\ ) Gravity applied to every particle. @@ -1443,8 +1443,8 @@ Gravity applied to every particle. .. rst-class:: classref-property-setget -- void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_texture**\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_param_texture**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's hue will vary along this :ref:`CurveTexture`. @@ -1460,8 +1460,8 @@ Each particle's hue will vary along this :ref:`CurveTexture` .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum initial hue variation applied to each particle. It will shift the particle color's hue. @@ -1477,8 +1477,8 @@ Maximum initial hue variation applied to each particle. It will shift the partic .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`hue_variation_max`. @@ -1494,8 +1494,8 @@ Minimum equivalent of :ref:`hue_variation_max` value **)** -- :ref:`float` **get_inherit_velocity_ratio** **(** **)** +- |void| **set_inherit_velocity_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_inherit_velocity_ratio**\ (\ ) Percentage of the velocity of the respective :ref:`GPUParticles2D` or :ref:`GPUParticles3D` inherited by each particle when spawning. @@ -1511,8 +1511,8 @@ Percentage of the velocity of the respective :ref:`GPUParticles2D` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum initial velocity magnitude for each particle. Direction comes from :ref:`direction` and :ref:`spread`. @@ -1528,8 +1528,8 @@ Maximum initial velocity magnitude for each particle. Direction comes from :ref: .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`initial_velocity_max`. @@ -1545,8 +1545,8 @@ Minimum equivalent of :ref:`initial_velocity_max` value **)** -- :ref:`float` **get_lifetime_randomness** **(** **)** +- |void| **set_lifetime_randomness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_lifetime_randomness**\ (\ ) Particle lifetime randomness ratio. The equation for the lifetime of a particle is ``lifetime * (1.0 - randf() * lifetime_randomness)``. For example, a :ref:`lifetime_randomness` of ``0.4`` scales the lifetime between ``0.6`` to ``1.0`` of its original value. @@ -1562,8 +1562,8 @@ Particle lifetime randomness ratio. The equation for the lifetime of a particle .. rst-class:: classref-property-setget -- void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_texture**\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_param_texture**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's linear acceleration will vary along this :ref:`CurveTexture`. @@ -1579,8 +1579,8 @@ Each particle's linear acceleration will vary along this :ref:`CurveTexture` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum linear acceleration applied to each particle in the direction of motion. @@ -1596,8 +1596,8 @@ Maximum linear acceleration applied to each particle in the direction of motion. .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`linear_accel_max`. @@ -1613,8 +1613,8 @@ Minimum equivalent of :ref:`linear_accel_max` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_texture**\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_param_texture**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's orbital velocity will vary along this :ref:`CurveTexture`. @@ -1634,8 +1634,8 @@ Each particle's orbital velocity will vary along this :ref:`CurveTexture` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second. @@ -1653,8 +1653,8 @@ Maximum orbital velocity applied to each particle. Makes the particles circle ar .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`orbit_velocity_max`. @@ -1672,8 +1672,8 @@ Minimum equivalent of :ref:`orbit_velocity_max` particle_flag, :ref:`bool` enable **)** -- :ref:`bool` **get_particle_flag** **(** :ref:`ParticleFlags` particle_flag **)** |const| +- |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| Align Y axis of particle with the direction of its velocity. @@ -1689,8 +1689,8 @@ Align Y axis of particle with the direction of its velocity. .. rst-class:: classref-property-setget -- void **set_particle_flag** **(** :ref:`ParticleFlags` particle_flag, :ref:`bool` enable **)** -- :ref:`bool` **get_particle_flag** **(** :ref:`ParticleFlags` particle_flag **)** |const| +- |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| Changes the behavior of the damping properties from a linear deceleration to a deceleration based on speed percentage. @@ -1706,8 +1706,8 @@ Changes the behavior of the damping properties from a linear deceleration to a d .. rst-class:: classref-property-setget -- void **set_particle_flag** **(** :ref:`ParticleFlags` particle_flag, :ref:`bool` enable **)** -- :ref:`bool` **get_particle_flag** **(** :ref:`ParticleFlags` particle_flag **)** |const| +- |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| If ``true``, particles will not move on the z axis. @@ -1723,8 +1723,8 @@ If ``true``, particles will not move on the z axis. .. rst-class:: classref-property-setget -- void **set_particle_flag** **(** :ref:`ParticleFlags` particle_flag, :ref:`bool` enable **)** -- :ref:`bool` **get_particle_flag** **(** :ref:`ParticleFlags` particle_flag **)** |const| +- |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) +- :ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| If ``true``, particles rotate around Y axis by :ref:`angle_min`. @@ -1740,8 +1740,8 @@ If ``true``, particles rotate around Y axis by :ref:`angle_min` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_texture**\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_param_texture**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's radial acceleration will vary along this :ref:`CurveTexture`. @@ -1757,8 +1757,8 @@ Each particle's radial acceleration will vary along this :ref:`CurveTexture` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum radial acceleration applied to each particle. Makes particle accelerate away from the origin or towards it if negative. @@ -1774,8 +1774,8 @@ Maximum radial acceleration applied to each particle. Makes particle accelerate .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`radial_accel_max`. @@ -1791,8 +1791,8 @@ Minimum equivalent of :ref:`radial_accel_max` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_texture**\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_param_texture**\ (\ param\: :ref:`Parameter`\ ) |const| A :ref:`CurveTexture` that defines the velocity over the particle's lifetime away (or toward) the :ref:`velocity_pivot`. @@ -1810,8 +1810,8 @@ A :ref:`CurveTexture` that defines the velocity over the par .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum radial velocity applied to each particle. Makes particles move away from the :ref:`velocity_pivot`, or toward it if negative. @@ -1829,8 +1829,8 @@ Maximum radial velocity applied to each particle. Makes particles move away from .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum radial velocity applied to each particle. Makes particles move away from the :ref:`velocity_pivot`, or toward it if negative. @@ -1848,10 +1848,10 @@ Minimum radial velocity applied to each particle. Makes particles move away from .. rst-class:: classref-property-setget -- void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_texture**\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_param_texture**\ (\ param\: :ref:`Parameter`\ ) |const| -Each particle's scale will vary along this :ref:`CurveTexture`. If a :ref:`CurveXYZTexture` is supplied instead, the scale will be separated per-axis. +Each particle's scale will vary along this :ref:`CurveTexture` over its lifetime. If a :ref:`CurveXYZTexture` is supplied instead, the scale will be separated per-axis. .. rst-class:: classref-item-separator @@ -1865,8 +1865,8 @@ Each particle's scale will vary along this :ref:`CurveTexture` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum initial scale applied to each particle. @@ -1882,8 +1882,8 @@ Maximum initial scale applied to each particle. .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`scale_max`. @@ -1899,8 +1899,8 @@ Minimum equivalent of :ref:`scale_max` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_texture**\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_param_texture**\ (\ param\: :ref:`Parameter`\ ) |const| Either a :ref:`CurveTexture` or a :ref:`CurveXYZTexture` that scales each particle based on its velocity. @@ -1916,8 +1916,8 @@ Either a :ref:`CurveTexture` or a :ref:`CurveXYZTexture` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum velocity value reference for :ref:`scale_over_velocity_curve`. @@ -1935,8 +1935,8 @@ Maximum velocity value reference for :ref:`scale_over_velocity_curve` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum velocity value reference for :ref:`scale_over_velocity_curve`. @@ -1954,8 +1954,8 @@ Minimum velocity value reference for :ref:`scale_over_velocity_curve` value **)** -- :ref:`float` **get_spread** **(** **)** +- |void| **set_spread**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_spread**\ (\ ) Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. @@ -1971,8 +1971,8 @@ Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. .. rst-class:: classref-property-setget -- void **set_sub_emitter_amount_at_collision** **(** :ref:`int` value **)** -- :ref:`int` **get_sub_emitter_amount_at_collision** **(** **)** +- |void| **set_sub_emitter_amount_at_collision**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_sub_emitter_amount_at_collision**\ (\ ) The amount of particles to spawn from the subemitter node when a collision occurs. When combined with :ref:`COLLISION_HIDE_ON_CONTACT` on the main particles material, this can be used to achieve effects such as raindrops hitting the ground. @@ -1990,8 +1990,8 @@ The amount of particles to spawn from the subemitter node when a collision occur .. rst-class:: classref-property-setget -- void **set_sub_emitter_amount_at_end** **(** :ref:`int` value **)** -- :ref:`int` **get_sub_emitter_amount_at_end** **(** **)** +- |void| **set_sub_emitter_amount_at_end**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_sub_emitter_amount_at_end**\ (\ ) The amount of particles to spawn from the subemitter node when the particle expires. @@ -2009,8 +2009,8 @@ The amount of particles to spawn from the subemitter node when the particle expi .. rst-class:: classref-property-setget -- void **set_sub_emitter_frequency** **(** :ref:`float` value **)** -- :ref:`float` **get_sub_emitter_frequency** **(** **)** +- |void| **set_sub_emitter_frequency**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_sub_emitter_frequency**\ (\ ) The frequency at which particles should be emitted from the subemitter node. One particle will be spawned every :ref:`sub_emitter_frequency` seconds. @@ -2028,8 +2028,8 @@ The frequency at which particles should be emitted from the subemitter node. One .. rst-class:: classref-property-setget -- void **set_sub_emitter_keep_velocity** **(** :ref:`bool` value **)** -- :ref:`bool` **get_sub_emitter_keep_velocity** **(** **)** +- |void| **set_sub_emitter_keep_velocity**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_sub_emitter_keep_velocity**\ (\ ) If ``true``, the subemitter inherits the parent particle's velocity when it spawns. @@ -2045,8 +2045,8 @@ If ``true``, the subemitter inherits the parent particle's velocity when it spaw .. rst-class:: classref-property-setget -- void **set_sub_emitter_mode** **(** :ref:`SubEmitterMode` value **)** -- :ref:`SubEmitterMode` **get_sub_emitter_mode** **(** **)** +- |void| **set_sub_emitter_mode**\ (\ value\: :ref:`SubEmitterMode`\ ) +- :ref:`SubEmitterMode` **get_sub_emitter_mode**\ (\ ) The particle subemitter mode (see :ref:`GPUParticles2D.sub_emitter` and :ref:`GPUParticles3D.sub_emitter`). @@ -2062,8 +2062,8 @@ The particle subemitter mode (see :ref:`GPUParticles2D.sub_emitter` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_texture**\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_param_texture**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's tangential acceleration will vary along this :ref:`CurveTexture`. @@ -2079,8 +2079,8 @@ Each particle's tangential acceleration will vary along this :ref:`CurveTexture< .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. @@ -2096,8 +2096,8 @@ Maximum tangential acceleration applied to each particle. Tangential acceleratio .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`tangential_accel_max`. @@ -2113,8 +2113,8 @@ Minimum equivalent of :ref:`tangential_accel_max` value **)** -- :ref:`bool` **get_turbulence_enabled** **(** **)** +- |void| **set_turbulence_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_turbulence_enabled**\ (\ ) If ``true``, enables turbulence for the particle system. Turbulence can be used to vary particle movement according to its position (based on a 3D noise pattern). In 3D, :ref:`GPUParticlesAttractorVectorField3D` with :ref:`NoiseTexture3D` can be used as an alternative to turbulence that works in world space and with multiple particle systems reacting in the same way. @@ -2132,8 +2132,8 @@ If ``true``, enables turbulence for the particle system. Turbulence can be used .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum turbulence influence on each particle. @@ -2151,8 +2151,8 @@ The actual amount of turbulence influence on each particle is calculated as a ra .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum turbulence influence on each particle. @@ -2170,8 +2170,8 @@ The actual amount of turbulence influence on each particle is calculated as a ra .. rst-class:: classref-property-setget -- void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture2D` texture **)** -- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_texture**\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_param_texture**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's amount of turbulence will be influenced along this :ref:`CurveTexture` over its life time. @@ -2187,8 +2187,8 @@ Each particle's amount of turbulence will be influenced along this :ref:`CurveTe .. rst-class:: classref-property-setget -- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum displacement of each particle's spawn position by the turbulence. @@ -2206,8 +2206,8 @@ The actual amount of displacement will be a factor of the underlying turbulence .. rst-class:: classref-property-setget -- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** -- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +- |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) +- :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum displacement of each particle's spawn position by the turbulence. @@ -2225,8 +2225,8 @@ The actual amount of displacement will be a factor of the underlying turbulence .. rst-class:: classref-property-setget -- void **set_turbulence_noise_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_turbulence_noise_scale** **(** **)** +- |void| **set_turbulence_noise_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_turbulence_noise_scale**\ (\ ) This value controls the overall scale/frequency of the turbulence noise pattern. @@ -2244,8 +2244,8 @@ A small scale will result in smaller features with more detail while a high scal .. rst-class:: classref-property-setget -- void **set_turbulence_noise_speed** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_turbulence_noise_speed** **(** **)** +- |void| **set_turbulence_noise_speed**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_turbulence_noise_speed**\ (\ ) A scrolling velocity for the turbulence field. This sets a directional trend for the pattern to move in over time. @@ -2263,8 +2263,8 @@ The default value of ``Vector3(0, 0, 0)`` turns off the scrolling. .. rst-class:: classref-property-setget -- void **set_turbulence_noise_speed_random** **(** :ref:`float` value **)** -- :ref:`float` **get_turbulence_noise_speed_random** **(** **)** +- |void| **set_turbulence_noise_speed_random**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_turbulence_noise_speed_random**\ (\ ) The in-place rate of change of the turbulence field. This defines how quickly the noise pattern varies over time. @@ -2282,8 +2282,8 @@ A value of 0.0 will result in a fixed pattern. .. rst-class:: classref-property-setget -- void **set_turbulence_noise_strength** **(** :ref:`float` value **)** -- :ref:`float` **get_turbulence_noise_strength** **(** **)** +- |void| **set_turbulence_noise_strength**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_turbulence_noise_strength**\ (\ ) The turbulence noise strength. Increasing this will result in a stronger, more contrasting, flow pattern. @@ -2299,8 +2299,8 @@ The turbulence noise strength. Increasing this will result in a stronger, more c .. rst-class:: classref-property-setget -- void **set_velocity_limit_curve** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_velocity_limit_curve** **(** **)** +- |void| **set_velocity_limit_curve**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_velocity_limit_curve**\ (\ ) A :ref:`CurveTexture` that defines the maximum velocity of a particle during its lifetime. @@ -2316,8 +2316,8 @@ A :ref:`CurveTexture` that defines the maximum velocity of a .. rst-class:: classref-property-setget -- void **set_velocity_pivot** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_velocity_pivot** **(** **)** +- |void| **set_velocity_pivot**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_velocity_pivot**\ (\ ) A pivot point used to calculate radial and orbital velocity of particles. @@ -2334,7 +2334,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector2` **get_param** **(** :ref:`Parameter` param **)** |const| +:ref:`Vector2` **get_param**\ (\ param\: :ref:`Parameter`\ ) |const| Returns the minimum and maximum values of the given ``param`` as a vector. @@ -2348,7 +2348,7 @@ The ``x`` component of the returned vector corresponds to minimum and the ``y`` .. rst-class:: classref-method -:ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| +:ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Returns the maximum value range for the given parameter. @@ -2360,7 +2360,7 @@ Returns the maximum value range for the given parameter. .. rst-class:: classref-method -:ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| +:ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Returns the minimum value range for the given parameter. @@ -2372,7 +2372,7 @@ Returns the minimum value range for the given parameter. .. rst-class:: classref-method -:ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| +:ref:`Texture2D` **get_param_texture**\ (\ param\: :ref:`Parameter`\ ) |const| Returns the :ref:`Texture2D` used by the specified parameter. @@ -2384,7 +2384,7 @@ Returns the :ref:`Texture2D` used by the specified parameter. .. rst-class:: classref-method -:ref:`bool` **get_particle_flag** **(** :ref:`ParticleFlags` particle_flag **)** |const| +:ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| Returns ``true`` if the specified particle flag is enabled. See :ref:`ParticleFlags` for options. @@ -2396,7 +2396,7 @@ Returns ``true`` if the specified particle flag is enabled. See :ref:`ParticleFl .. rst-class:: classref-method -void **set_param** **(** :ref:`Parameter` param, :ref:`Vector2` value **)** +|void| **set_param**\ (\ param\: :ref:`Parameter`, value\: :ref:`Vector2`\ ) Sets the minimum and maximum values of the given ``param``. @@ -2410,7 +2410,7 @@ The ``x`` component of the argument vector corresponds to minimum and the ``y`` .. rst-class:: classref-method -void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** +|void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) Sets the maximum value range for the given parameter. @@ -2422,7 +2422,7 @@ Sets the maximum value range for the given parameter. .. rst-class:: classref-method -void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** +|void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) Sets the minimum value range for the given parameter. @@ -2434,7 +2434,7 @@ Sets the minimum value range for the given parameter. .. rst-class:: classref-method -void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture2D` texture **)** +|void| **set_param_texture**\ (\ param\: :ref:`Parameter`, texture\: :ref:`Texture2D`\ ) Sets the :ref:`Texture2D` for the specified :ref:`Parameter`. @@ -2446,7 +2446,7 @@ Sets the :ref:`Texture2D` for the specified :ref:`Parameter` particle_flag, :ref:`bool` enable **)** +|void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) If ``true``, enables the specified particle flag. See :ref:`ParticleFlags` for options. @@ -2457,3 +2457,4 @@ If ``true``, enables the specified particle flag. See :ref:`ParticleFlags` value **)** -- :ref:`Curve2D` **get_curve** **(** **)** +- |void| **set_curve**\ (\ value\: :ref:`Curve2D`\ ) +- :ref:`Curve2D` **get_curve**\ (\ ) A :ref:`Curve2D` describing the path. @@ -64,3 +64,4 @@ A :ref:`Curve2D` describing the path. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_path3d.rst b/classes/class_path3d.rst index dd9b3e1e5b9..e0865f08bee 100644 --- a/classes/class_path3d.rst +++ b/classes/class_path3d.rst @@ -48,7 +48,7 @@ Signals .. rst-class:: classref-signal -**curve_changed** **(** **)** +**curve_changed**\ (\ ) Emitted when the :ref:`curve` changes. @@ -69,8 +69,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_curve** **(** :ref:`Curve3D` value **)** -- :ref:`Curve3D` **get_curve** **(** **)** +- |void| **set_curve**\ (\ value\: :ref:`Curve3D`\ ) +- :ref:`Curve3D` **get_curve**\ (\ ) A :ref:`Curve3D` describing the path. @@ -81,3 +81,4 @@ A :ref:`Curve3D` describing the path. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_pathfollow2d.rst b/classes/class_pathfollow2d.rst index c6de58a0b89..ade30c030f0 100644 --- a/classes/class_pathfollow2d.rst +++ b/classes/class_pathfollow2d.rst @@ -64,8 +64,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_cubic_interpolation** **(** :ref:`bool` value **)** -- :ref:`bool` **get_cubic_interpolation** **(** **)** +- |void| **set_cubic_interpolation**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_cubic_interpolation**\ (\ ) If ``true``, the position between two cached points is interpolated cubically, and linearly otherwise. @@ -85,8 +85,8 @@ There are two answers to this problem: either increase the number of cached poin .. rst-class:: classref-property-setget -- void **set_h_offset** **(** :ref:`float` value **)** -- :ref:`float` **get_h_offset** **(** **)** +- |void| **set_h_offset**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_h_offset**\ (\ ) The node's offset along the curve. @@ -102,8 +102,8 @@ The node's offset along the curve. .. rst-class:: classref-property-setget -- void **set_loop** **(** :ref:`bool` value **)** -- :ref:`bool` **has_loop** **(** **)** +- |void| **set_loop**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **has_loop**\ (\ ) If ``true``, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths. @@ -119,8 +119,8 @@ If ``true``, any offset outside the path's length will wrap around, instead of s .. rst-class:: classref-property-setget -- void **set_progress** **(** :ref:`float` value **)** -- :ref:`float` **get_progress** **(** **)** +- |void| **set_progress**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_progress**\ (\ ) The distance along the path, in pixels. Changing this value sets this node's position to a point within the path. @@ -136,8 +136,8 @@ The distance along the path, in pixels. Changing this value sets this node's pos .. rst-class:: classref-property-setget -- void **set_progress_ratio** **(** :ref:`float` value **)** -- :ref:`float` **get_progress_ratio** **(** **)** +- |void| **set_progress_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_progress_ratio**\ (\ ) The distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). This is just another way of expressing the progress within the path, as the offset supplied is multiplied internally by the path's length. @@ -153,8 +153,8 @@ The distance along the path as a number in the range 0.0 (for the first vertex) .. rst-class:: classref-property-setget -- void **set_rotates** **(** :ref:`bool` value **)** -- :ref:`bool` **is_rotating** **(** **)** +- |void| **set_rotates**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_rotating**\ (\ ) If ``true``, this node rotates to follow the path, with the +X direction facing forward on the path. @@ -170,8 +170,8 @@ If ``true``, this node rotates to follow the path, with the +X direction facing .. rst-class:: classref-property-setget -- void **set_v_offset** **(** :ref:`float` value **)** -- :ref:`float` **get_v_offset** **(** **)** +- |void| **set_v_offset**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_v_offset**\ (\ ) The node's offset perpendicular to the curve. @@ -182,3 +182,4 @@ The node's offset perpendicular to the curve. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_pathfollow3d.rst b/classes/class_pathfollow3d.rst index 2b8455ddf2d..37222b21b8b 100644 --- a/classes/class_pathfollow3d.rst +++ b/classes/class_pathfollow3d.rst @@ -59,9 +59,9 @@ Methods .. table:: :widths: auto - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`correct_posture` **(** :ref:`Transform3D` transform, :ref:`RotationMode` rotation_mode **)** |static| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`correct_posture`\ (\ transform\: :ref:`Transform3D`, rotation_mode\: :ref:`RotationMode`\ ) |static| | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -135,8 +135,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_cubic_interpolation** **(** :ref:`bool` value **)** -- :ref:`bool` **get_cubic_interpolation** **(** **)** +- |void| **set_cubic_interpolation**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_cubic_interpolation**\ (\ ) If ``true``, the position between two cached points is interpolated cubically, and linearly otherwise. @@ -156,8 +156,8 @@ There are two answers to this problem: either increase the number of cached poin .. rst-class:: classref-property-setget -- void **set_h_offset** **(** :ref:`float` value **)** -- :ref:`float` **get_h_offset** **(** **)** +- |void| **set_h_offset**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_h_offset**\ (\ ) The node's offset along the curve. @@ -173,8 +173,8 @@ The node's offset along the curve. .. rst-class:: classref-property-setget -- void **set_loop** **(** :ref:`bool` value **)** -- :ref:`bool` **has_loop** **(** **)** +- |void| **set_loop**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **has_loop**\ (\ ) If ``true``, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths. @@ -190,8 +190,8 @@ If ``true``, any offset outside the path's length will wrap around, instead of s .. rst-class:: classref-property-setget -- void **set_progress** **(** :ref:`float` value **)** -- :ref:`float` **get_progress** **(** **)** +- |void| **set_progress**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_progress**\ (\ ) The distance from the first vertex, measured in 3D units along the path. Changing this value sets this node's position to a point within the path. @@ -207,8 +207,8 @@ The distance from the first vertex, measured in 3D units along the path. Changin .. rst-class:: classref-property-setget -- void **set_progress_ratio** **(** :ref:`float` value **)** -- :ref:`float` **get_progress_ratio** **(** **)** +- |void| **set_progress_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_progress_ratio**\ (\ ) The distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the progress within the path, as the progress supplied is multiplied internally by the path's length. @@ -224,8 +224,8 @@ The distance from the first vertex, considering 0.0 as the first vertex and 1.0 .. rst-class:: classref-property-setget -- void **set_rotation_mode** **(** :ref:`RotationMode` value **)** -- :ref:`RotationMode` **get_rotation_mode** **(** **)** +- |void| **set_rotation_mode**\ (\ value\: :ref:`RotationMode`\ ) +- :ref:`RotationMode` **get_rotation_mode**\ (\ ) Allows or forbids rotation on one or more axes, depending on the :ref:`RotationMode` constants being used. @@ -241,8 +241,8 @@ Allows or forbids rotation on one or more axes, depending on the :ref:`RotationM .. rst-class:: classref-property-setget -- void **set_tilt_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_tilt_enabled** **(** **)** +- |void| **set_tilt_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_tilt_enabled**\ (\ ) If ``true``, the tilt property of :ref:`Curve3D` takes effect. @@ -258,8 +258,8 @@ If ``true``, the tilt property of :ref:`Curve3D` takes effect. .. rst-class:: classref-property-setget -- void **set_use_model_front** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_model_front** **(** **)** +- |void| **set_use_model_front**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_model_front**\ (\ ) If ``true``, the node moves on the travel path with orienting the +Z axis as forward. See also :ref:`Vector3.FORWARD` and :ref:`Vector3.MODEL_FRONT`. @@ -275,8 +275,8 @@ If ``true``, the node moves on the travel path with orienting the +Z axis as for .. rst-class:: classref-property-setget -- void **set_v_offset** **(** :ref:`float` value **)** -- :ref:`float` **get_v_offset** **(** **)** +- |void| **set_v_offset**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_v_offset**\ (\ ) The node's offset perpendicular to the curve. @@ -293,7 +293,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Transform3D` **correct_posture** **(** :ref:`Transform3D` transform, :ref:`RotationMode` rotation_mode **)** |static| +:ref:`Transform3D` **correct_posture**\ (\ transform\: :ref:`Transform3D`, rotation_mode\: :ref:`RotationMode`\ ) |static| Correct the ``transform``. ``rotation_mode`` implicitly specifies how posture (forward, up and sideway direction) is calculated. @@ -304,3 +304,4 @@ Correct the ``transform``. ``rotation_mode`` implicitly specifies how posture (f .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_pckpacker.rst b/classes/class_pckpacker.rst index 0b78762ad92..d0e9865f311 100644 --- a/classes/class_pckpacker.rst +++ b/classes/class_pckpacker.rst @@ -50,13 +50,13 @@ Methods .. table:: :widths: auto - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`add_file` **(** :ref:`String` pck_path, :ref:`String` source_path, :ref:`bool` encrypt=false **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`flush` **(** :ref:`bool` verbose=false **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`pck_start` **(** :ref:`String` pck_name, :ref:`int` alignment=32, :ref:`String` key="0000000000000000000000000000000000000000000000000000000000000000", :ref:`bool` encrypt_directory=false **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`add_file`\ (\ pck_path\: :ref:`String`, source_path\: :ref:`String`, encrypt\: :ref:`bool` = false\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`flush`\ (\ verbose\: :ref:`bool` = false\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`pck_start`\ (\ pck_name\: :ref:`String`, alignment\: :ref:`int` = 32, key\: :ref:`String` = "0000000000000000000000000000000000000000000000000000000000000000", encrypt_directory\: :ref:`bool` = false\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -71,7 +71,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **add_file** **(** :ref:`String` pck_path, :ref:`String` source_path, :ref:`bool` encrypt=false **)** +:ref:`Error` **add_file**\ (\ pck_path\: :ref:`String`, source_path\: :ref:`String`, encrypt\: :ref:`bool` = false\ ) Adds the ``source_path`` file to the current PCK package at the ``pck_path`` internal path (should start with ``res://``). @@ -83,7 +83,7 @@ Adds the ``source_path`` file to the current PCK package at the ``pck_path`` int .. rst-class:: classref-method -:ref:`Error` **flush** **(** :ref:`bool` verbose=false **)** +:ref:`Error` **flush**\ (\ verbose\: :ref:`bool` = false\ ) Writes the files specified using all :ref:`add_file` calls since the last flush. If ``verbose`` is ``true``, a list of files added will be printed to the console for easier debugging. @@ -95,7 +95,7 @@ Writes the files specified using all :ref:`add_file` **pck_start** **(** :ref:`String` pck_name, :ref:`int` alignment=32, :ref:`String` key="0000000000000000000000000000000000000000000000000000000000000000", :ref:`bool` encrypt_directory=false **)** +:ref:`Error` **pck_start**\ (\ pck_name\: :ref:`String`, alignment\: :ref:`int` = 32, key\: :ref:`String` = "0000000000000000000000000000000000000000000000000000000000000000", encrypt_directory\: :ref:`bool` = false\ ) Creates a new PCK file with the name ``pck_name``. The ``.pck`` file extension isn't added automatically, so it should be part of ``pck_name`` (even though it's not required). @@ -106,3 +106,4 @@ Creates a new PCK file with the name ``pck_name``. The ``.pck`` file extension i .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_performance.rst b/classes/class_performance.rst index 2edaf727c00..d0db64cf46c 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -37,21 +37,21 @@ Methods .. table:: :widths: auto - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_custom_monitor` **(** :ref:`StringName` id, :ref:`Callable` callable, :ref:`Array` arguments=[] **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_custom_monitor` **(** :ref:`StringName` id **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName[]` | :ref:`get_custom_monitor_names` **(** **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_monitor` **(** :ref:`Monitor` monitor **)** |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_monitor_modification_time` **(** **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_custom_monitor` **(** :ref:`StringName` id **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_custom_monitor` **(** :ref:`StringName` id **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_custom_monitor`\ (\ id\: :ref:`StringName`, callable\: :ref:`Callable`, arguments\: :ref:`Array` = []\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_custom_monitor`\ (\ id\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`StringName`\] | :ref:`get_custom_monitor_names`\ (\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_monitor`\ (\ monitor\: :ref:`Monitor`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_monitor_modification_time`\ (\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_custom_monitor`\ (\ id\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_custom_monitor`\ (\ id\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -353,7 +353,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_custom_monitor** **(** :ref:`StringName` id, :ref:`Callable` callable, :ref:`Array` arguments=[] **)** +|void| **add_custom_monitor**\ (\ id\: :ref:`StringName`, callable\: :ref:`Callable`, arguments\: :ref:`Array` = []\ ) Adds a custom monitor with the name ``id``. You can specify the category of the monitor using slash delimiters in ``id`` (for example: ``"Game/NumberOfNPCs"``). If there is more than one slash delimiter, then the default category is used. The default category is ``"Custom"``. Prints an error if given ``id`` is already present. @@ -421,7 +421,7 @@ Callables are called with arguments supplied in argument array. .. rst-class:: classref-method -:ref:`Variant` **get_custom_monitor** **(** :ref:`StringName` id **)** +:ref:`Variant` **get_custom_monitor**\ (\ id\: :ref:`StringName`\ ) Returns the value of custom monitor with given ``id``. The callable is called to get the value of custom monitor. See also :ref:`has_custom_monitor`. Prints an error if the given ``id`` is absent. @@ -433,7 +433,7 @@ Returns the value of custom monitor with given ``id``. The callable is called to .. rst-class:: classref-method -:ref:`StringName[]` **get_custom_monitor_names** **(** **)** +:ref:`Array`\[:ref:`StringName`\] **get_custom_monitor_names**\ (\ ) Returns the names of active custom monitors in an :ref:`Array`. @@ -445,7 +445,7 @@ Returns the names of active custom monitors in an :ref:`Array`. .. rst-class:: classref-method -:ref:`float` **get_monitor** **(** :ref:`Monitor` monitor **)** |const| +:ref:`float` **get_monitor**\ (\ monitor\: :ref:`Monitor`\ ) |const| Returns the value of one of the available built-in monitors. You should provide one of the :ref:`Monitor` constants as the argument, like this: @@ -472,7 +472,7 @@ See :ref:`get_custom_monitor` to qu .. rst-class:: classref-method -:ref:`int` **get_monitor_modification_time** **(** **)** +:ref:`int` **get_monitor_modification_time**\ (\ ) Returns the last tick in which custom monitor was added/removed (in microseconds since the engine started). This is set to :ref:`Time.get_ticks_usec` when the monitor is updated. @@ -484,7 +484,7 @@ Returns the last tick in which custom monitor was added/removed (in microseconds .. rst-class:: classref-method -:ref:`bool` **has_custom_monitor** **(** :ref:`StringName` id **)** +:ref:`bool` **has_custom_monitor**\ (\ id\: :ref:`StringName`\ ) Returns ``true`` if custom monitor with the given ``id`` is present, ``false`` otherwise. @@ -496,7 +496,7 @@ Returns ``true`` if custom monitor with the given ``id`` is present, ``false`` o .. rst-class:: classref-method -void **remove_custom_monitor** **(** :ref:`StringName` id **)** +|void| **remove_custom_monitor**\ (\ id\: :ref:`StringName`\ ) Removes the custom monitor with given ``id``. Prints an error if the given ``id`` is already absent. @@ -507,3 +507,4 @@ Removes the custom monitor with given ``id``. Prints an error if the given ``id` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicalbone2d.rst b/classes/class_physicalbone2d.rst index 3a5678ef1cf..73230e89704 100644 --- a/classes/class_physicalbone2d.rst +++ b/classes/class_physicalbone2d.rst @@ -56,11 +56,11 @@ Methods .. table:: :widths: auto - +-------------------------------+-----------------------------------------------------------------------------------------------------+ - | :ref:`Joint2D` | :ref:`get_joint` **(** **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_simulating_physics` **(** **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------+ + +-------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`Joint2D` | :ref:`get_joint`\ (\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_simulating_physics`\ (\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -79,8 +79,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_auto_configure_joint** **(** :ref:`bool` value **)** -- :ref:`bool` **get_auto_configure_joint** **(** **)** +- |void| **set_auto_configure_joint**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_auto_configure_joint**\ (\ ) If ``true``, the **PhysicalBone2D** will automatically configure the first :ref:`Joint2D` child node. The automatic configuration is limited to setting up the node properties and positioning the :ref:`Joint2D`. @@ -96,8 +96,8 @@ If ``true``, the **PhysicalBone2D** will automatically configure the first :ref: .. rst-class:: classref-property-setget -- void **set_bone2d_index** **(** :ref:`int` value **)** -- :ref:`int` **get_bone2d_index** **(** **)** +- |void| **set_bone2d_index**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_bone2d_index**\ (\ ) The index of the :ref:`Bone2D` that this **PhysicalBone2D** should simulate. @@ -113,8 +113,8 @@ The index of the :ref:`Bone2D` that this **PhysicalBone2D** should .. rst-class:: classref-property-setget -- void **set_bone2d_nodepath** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_bone2d_nodepath** **(** **)** +- |void| **set_bone2d_nodepath**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_bone2d_nodepath**\ (\ ) The :ref:`NodePath` to the :ref:`Bone2D` that this **PhysicalBone2D** should simulate. @@ -130,8 +130,8 @@ The :ref:`NodePath` to the :ref:`Bone2D` that this .. rst-class:: classref-property-setget -- void **set_follow_bone_when_simulating** **(** :ref:`bool` value **)** -- :ref:`bool` **get_follow_bone_when_simulating** **(** **)** +- |void| **set_follow_bone_when_simulating**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_follow_bone_when_simulating**\ (\ ) If ``true``, the **PhysicalBone2D** will keep the transform of the bone it is bound to when simulating physics. @@ -147,8 +147,8 @@ If ``true``, the **PhysicalBone2D** will keep the transform of the bone it is bo .. rst-class:: classref-property-setget -- void **set_simulate_physics** **(** :ref:`bool` value **)** -- :ref:`bool` **get_simulate_physics** **(** **)** +- |void| **set_simulate_physics**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_simulate_physics**\ (\ ) If ``true``, the **PhysicalBone2D** will start simulating using physics. If ``false``, the **PhysicalBone2D** will follow the transform of the :ref:`Bone2D` node. @@ -167,7 +167,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Joint2D` **get_joint** **(** **)** |const| +:ref:`Joint2D` **get_joint**\ (\ ) |const| Returns the first :ref:`Joint2D` child node, if one exists. This is mainly a helper function to make it easier to get the :ref:`Joint2D` that the **PhysicalBone2D** is autoconfiguring. @@ -179,7 +179,7 @@ Returns the first :ref:`Joint2D` child node, if one exists. This .. rst-class:: classref-method -:ref:`bool` **is_simulating_physics** **(** **)** |const| +:ref:`bool` **is_simulating_physics**\ (\ ) |const| Returns a boolean that indicates whether the **PhysicalBone2D** is running and simulating using the Godot 2D physics engine. When ``true``, the PhysicalBone2D node is using physics. @@ -190,3 +190,4 @@ Returns a boolean that indicates whether the **PhysicalBone2D** is running and s .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicalbone3d.rst b/classes/class_physicalbone3d.rst index 5bcd78d6c72..db31a519c60 100644 --- a/classes/class_physicalbone3d.rst +++ b/classes/class_physicalbone3d.rst @@ -75,17 +75,17 @@ Methods :widths: auto +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_integrate_forces` **(** :ref:`PhysicsDirectBodyState3D` state **)** |virtual| | + | |void| | :ref:`_integrate_forces`\ (\ state\: :ref:`PhysicsDirectBodyState3D`\ ) |virtual| | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_central_impulse` **(** :ref:`Vector3` impulse **)** | + | |void| | :ref:`apply_central_impulse`\ (\ impulse\: :ref:`Vector3`\ ) | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_impulse` **(** :ref:`Vector3` impulse, :ref:`Vector3` position=Vector3(0, 0, 0) **)** | + | |void| | :ref:`apply_impulse`\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_bone_id` **(** **)** |const| | + | :ref:`int` | :ref:`get_bone_id`\ (\ ) |const| | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_simulate_physics` **(** **)** | + | :ref:`bool` | :ref:`get_simulate_physics`\ (\ ) | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_simulating_physics` **(** **)** | + | :ref:`bool` | :ref:`is_simulating_physics`\ (\ ) | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -218,8 +218,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_angular_damp** **(** :ref:`float` value **)** -- :ref:`float` **get_angular_damp** **(** **)** +- |void| **set_angular_damp**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_angular_damp**\ (\ ) Damps the body's rotation. By default, the body will use the **Default Angular Damp** in **Project > Project Settings > Physics > 3d** or any value override set by an :ref:`Area3D` the body is in. Depending on :ref:`angular_damp_mode`, you can set :ref:`angular_damp` to be added to or to replace the body's damping value. @@ -237,8 +237,8 @@ See :ref:`ProjectSettings.physics/3d/default_angular_damp` value **)** -- :ref:`DampMode` **get_angular_damp_mode** **(** **)** +- |void| **set_angular_damp_mode**\ (\ value\: :ref:`DampMode`\ ) +- :ref:`DampMode` **get_angular_damp_mode**\ (\ ) Defines how :ref:`angular_damp` is applied. See :ref:`DampMode` for possible values. @@ -254,8 +254,8 @@ Defines how :ref:`angular_damp` is a .. rst-class:: classref-property-setget -- void **set_angular_velocity** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_angular_velocity** **(** **)** +- |void| **set_angular_velocity**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_angular_velocity**\ (\ ) The PhysicalBone3D's rotational velocity in *radians* per second. @@ -271,8 +271,8 @@ The PhysicalBone3D's rotational velocity in *radians* per second. .. rst-class:: classref-property-setget -- void **set_body_offset** **(** :ref:`Transform3D` value **)** -- :ref:`Transform3D` **get_body_offset** **(** **)** +- |void| **set_body_offset**\ (\ value\: :ref:`Transform3D`\ ) +- :ref:`Transform3D` **get_body_offset**\ (\ ) Sets the body's transform. @@ -288,8 +288,8 @@ Sets the body's transform. .. rst-class:: classref-property-setget -- void **set_bounce** **(** :ref:`float` value **)** -- :ref:`float` **get_bounce** **(** **)** +- |void| **set_bounce**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_bounce**\ (\ ) The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). @@ -305,8 +305,8 @@ The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounci .. rst-class:: classref-property-setget -- void **set_can_sleep** **(** :ref:`bool` value **)** -- :ref:`bool` **is_able_to_sleep** **(** **)** +- |void| **set_can_sleep**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_able_to_sleep**\ (\ ) If ``true``, the body is deactivated when there is no movement, so it will not take part in the simulation until it is awakened by an external force. @@ -322,8 +322,8 @@ If ``true``, the body is deactivated when there is no movement, so it will not t .. rst-class:: classref-property-setget -- void **set_use_custom_integrator** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_custom_integrator** **(** **)** +- |void| **set_use_custom_integrator**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_custom_integrator**\ (\ ) If ``true``, internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the :ref:`_integrate_forces` function, if defined. @@ -339,8 +339,8 @@ If ``true``, internal force integration will be disabled (like gravity or air fr .. rst-class:: classref-property-setget -- void **set_friction** **(** :ref:`float` value **)** -- :ref:`float` **get_friction** **(** **)** +- |void| **set_friction**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_friction**\ (\ ) The body's friction, from ``0`` (frictionless) to ``1`` (max friction). @@ -356,8 +356,8 @@ The body's friction, from ``0`` (frictionless) to ``1`` (max friction). .. rst-class:: classref-property-setget -- void **set_gravity_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_gravity_scale** **(** **)** +- |void| **set_gravity_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_gravity_scale**\ (\ ) This is multiplied by the global 3D gravity setting found in **Project > Project Settings > Physics > 3d** to produce the body's gravity. For example, a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object. @@ -373,8 +373,8 @@ This is multiplied by the global 3D gravity setting found in **Project > Project .. rst-class:: classref-property-setget -- void **set_joint_offset** **(** :ref:`Transform3D` value **)** -- :ref:`Transform3D` **get_joint_offset** **(** **)** +- |void| **set_joint_offset**\ (\ value\: :ref:`Transform3D`\ ) +- :ref:`Transform3D` **get_joint_offset**\ (\ ) Sets the joint's transform. @@ -390,8 +390,8 @@ Sets the joint's transform. .. rst-class:: classref-property-setget -- void **set_joint_rotation** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_joint_rotation** **(** **)** +- |void| **set_joint_rotation**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_joint_rotation**\ (\ ) Sets the joint's rotation in radians. @@ -407,8 +407,8 @@ Sets the joint's rotation in radians. .. rst-class:: classref-property-setget -- void **set_joint_type** **(** :ref:`JointType` value **)** -- :ref:`JointType` **get_joint_type** **(** **)** +- |void| **set_joint_type**\ (\ value\: :ref:`JointType`\ ) +- :ref:`JointType` **get_joint_type**\ (\ ) Sets the joint type. See :ref:`JointType` for possible values. @@ -424,8 +424,8 @@ Sets the joint type. See :ref:`JointType` for pos .. rst-class:: classref-property-setget -- void **set_linear_damp** **(** :ref:`float` value **)** -- :ref:`float` **get_linear_damp** **(** **)** +- |void| **set_linear_damp**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_linear_damp**\ (\ ) Damps the body's movement. By default, the body will use the **Default Linear Damp** in **Project > Project Settings > Physics > 3d** or any value override set by an :ref:`Area3D` the body is in. Depending on :ref:`linear_damp_mode`, you can set :ref:`linear_damp` to be added to or to replace the body's damping value. @@ -443,8 +443,8 @@ See :ref:`ProjectSettings.physics/3d/default_linear_damp` value **)** -- :ref:`DampMode` **get_linear_damp_mode** **(** **)** +- |void| **set_linear_damp_mode**\ (\ value\: :ref:`DampMode`\ ) +- :ref:`DampMode` **get_linear_damp_mode**\ (\ ) Defines how :ref:`linear_damp` is applied. See :ref:`DampMode` for possible values. @@ -460,8 +460,8 @@ Defines how :ref:`linear_damp` is app .. rst-class:: classref-property-setget -- void **set_linear_velocity** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_linear_velocity** **(** **)** +- |void| **set_linear_velocity**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_linear_velocity**\ (\ ) The body's linear velocity in units per second. Can be used sporadically, but **don't set this every frame**, because physics may run in another thread and runs at a different granularity. Use :ref:`_integrate_forces` as your process loop for precise control of the body state. @@ -477,8 +477,8 @@ The body's linear velocity in units per second. Can be used sporadically, but ** .. rst-class:: classref-property-setget -- void **set_mass** **(** :ref:`float` value **)** -- :ref:`float` **get_mass** **(** **)** +- |void| **set_mass**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_mass**\ (\ ) The body's mass. @@ -495,7 +495,7 @@ Method Descriptions .. rst-class:: classref-method -void **_integrate_forces** **(** :ref:`PhysicsDirectBodyState3D` state **)** |virtual| +|void| **_integrate_forces**\ (\ state\: :ref:`PhysicsDirectBodyState3D`\ ) |virtual| Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default, it works in addition to the usual physics behavior, but the :ref:`custom_integrator` property allows you to disable the default behavior and do fully custom force integration for a body. @@ -507,7 +507,7 @@ Called during physics processing, allowing you to read and safely modify the sim .. rst-class:: classref-method -void **apply_central_impulse** **(** :ref:`Vector3` impulse **)** +|void| **apply_central_impulse**\ (\ impulse\: :ref:`Vector3`\ ) .. container:: contribute @@ -521,7 +521,7 @@ void **apply_central_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -void **apply_impulse** **(** :ref:`Vector3` impulse, :ref:`Vector3` position=Vector3(0, 0, 0) **)** +|void| **apply_impulse**\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) .. container:: contribute @@ -535,7 +535,7 @@ void **apply_impulse** **(** :ref:`Vector3` impulse, :ref:`Vector .. rst-class:: classref-method -:ref:`int` **get_bone_id** **(** **)** |const| +:ref:`int` **get_bone_id**\ (\ ) |const| .. container:: contribute @@ -549,7 +549,7 @@ void **apply_impulse** **(** :ref:`Vector3` impulse, :ref:`Vector .. rst-class:: classref-method -:ref:`bool` **get_simulate_physics** **(** **)** +:ref:`bool` **get_simulate_physics**\ (\ ) .. container:: contribute @@ -563,7 +563,7 @@ void **apply_impulse** **(** :ref:`Vector3` impulse, :ref:`Vector .. rst-class:: classref-method -:ref:`bool` **is_simulating_physics** **(** **)** +:ref:`bool` **is_simulating_physics**\ (\ ) .. container:: contribute @@ -576,3 +576,4 @@ void **apply_impulse** **(** :ref:`Vector3` impulse, :ref:`Vector .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicalskymaterial.rst b/classes/class_physicalskymaterial.rst index ca537a470cc..33fbb719da5 100644 --- a/classes/class_physicalskymaterial.rst +++ b/classes/class_physicalskymaterial.rst @@ -74,8 +74,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_energy_multiplier** **(** :ref:`float` value **)** -- :ref:`float` **get_energy_multiplier** **(** **)** +- |void| **set_energy_multiplier**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_energy_multiplier**\ (\ ) The sky's overall brightness multiplier. Higher values result in a brighter sky. @@ -91,8 +91,8 @@ The sky's overall brightness multiplier. Higher values result in a brighter sky. .. rst-class:: classref-property-setget -- void **set_ground_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_ground_color** **(** **)** +- |void| **set_ground_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_ground_color**\ (\ ) Modulates the :ref:`Color` on the bottom half of the sky to represent the ground. @@ -108,8 +108,8 @@ Modulates the :ref:`Color` on the bottom half of the sky to represe .. rst-class:: classref-property-setget -- void **set_mie_coefficient** **(** :ref:`float` value **)** -- :ref:`float` **get_mie_coefficient** **(** **)** +- |void| **set_mie_coefficient**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_mie_coefficient**\ (\ ) Controls the strength of `Mie scattering `__ for the sky. Mie scattering results from light colliding with larger particles (like water). On earth, Mie scattering results in a whitish color around the sun and horizon. @@ -125,8 +125,8 @@ Controls the strength of `Mie scattering ` value **)** -- :ref:`Color` **get_mie_color** **(** **)** +- |void| **set_mie_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_mie_color**\ (\ ) Controls the :ref:`Color` of the `Mie scattering `__ effect. While not physically accurate, this allows for the creation of alien-looking planets. @@ -142,8 +142,8 @@ Controls the :ref:`Color` of the `Mie scattering ` value **)** -- :ref:`float` **get_mie_eccentricity** **(** **)** +- |void| **set_mie_eccentricity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_mie_eccentricity**\ (\ ) Controls the direction of the `Mie scattering `__. A value of ``1`` means that when light hits a particle it's passing through straight forward. A value of ``-1`` means that all light is scatter backwards. @@ -159,8 +159,8 @@ Controls the direction of the `Mie scattering ` value **)** -- :ref:`Texture2D` **get_night_sky** **(** **)** +- |void| **set_night_sky**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_night_sky**\ (\ ) :ref:`Texture2D` for the night sky. This is added to the sky, so if it is bright enough, it may be visible during the day. @@ -176,8 +176,8 @@ Controls the direction of the `Mie scattering ` value **)** -- :ref:`float` **get_rayleigh_coefficient** **(** **)** +- |void| **set_rayleigh_coefficient**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_rayleigh_coefficient**\ (\ ) Controls the strength of the `Rayleigh scattering `__. Rayleigh scattering results from light colliding with small particles. It is responsible for the blue color of the sky. @@ -193,8 +193,8 @@ Controls the strength of the `Rayleigh scattering ` value **)** -- :ref:`Color` **get_rayleigh_color** **(** **)** +- |void| **set_rayleigh_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_rayleigh_color**\ (\ ) Controls the :ref:`Color` of the `Rayleigh scattering `__. While not physically accurate, this allows for the creation of alien-looking planets. For example, setting this to a red :ref:`Color` results in a Mars-looking atmosphere with a corresponding blue sunset. @@ -210,8 +210,8 @@ Controls the :ref:`Color` of the `Rayleigh scattering ` value **)** -- :ref:`float` **get_sun_disk_scale** **(** **)** +- |void| **set_sun_disk_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_sun_disk_scale**\ (\ ) Sets the size of the sun disk. Default value is based on Sol's perceived size from Earth. @@ -227,8 +227,8 @@ Sets the size of the sun disk. Default value is based on Sol's perceived size fr .. rst-class:: classref-property-setget -- void **set_turbidity** **(** :ref:`float` value **)** -- :ref:`float` **get_turbidity** **(** **)** +- |void| **set_turbidity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_turbidity**\ (\ ) Sets the thickness of the atmosphere. High turbidity creates a foggy-looking atmosphere, while a low turbidity results in a clearer atmosphere. @@ -244,8 +244,8 @@ Sets the thickness of the atmosphere. High turbidity creates a foggy-looking atm .. rst-class:: classref-property-setget -- void **set_use_debanding** **(** :ref:`bool` value **)** -- :ref:`bool` **get_use_debanding** **(** **)** +- |void| **set_use_debanding**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_debanding**\ (\ ) If ``true``, enables debanding. Debanding adds a small amount of noise which helps reduce banding that appears from the smooth changes in color in the sky. @@ -256,3 +256,4 @@ If ``true``, enables debanding. Debanding adds a small amount of noise which hel .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index 70c1a6dc711..d705de7b256 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -50,19 +50,19 @@ Methods .. table:: :widths: auto - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsBody2D[]` | :ref:`get_collision_exceptions` **(** **)** | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_gravity` **(** **)** |const| | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`KinematicCollision2D` | :ref:`move_and_collide` **(** :ref:`Vector2` motion, :ref:`bool` test_only=false, :ref:`float` safe_margin=0.08, :ref:`bool` recovery_as_collision=false **)** | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`KinematicCollision2D` collision=null, :ref:`float` safe_margin=0.08, :ref:`bool` recovery_as_collision=false **)** | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_collision_exception_with`\ (\ body\: :ref:`Node`\ ) | + +------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`PhysicsBody2D`\] | :ref:`get_collision_exceptions`\ (\ ) | + +------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_gravity`\ (\ ) |const| | + +------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`KinematicCollision2D` | :ref:`move_and_collide`\ (\ motion\: :ref:`Vector2`, test_only\: :ref:`bool` = false, safe_margin\: :ref:`float` = 0.08, recovery_as_collision\: :ref:`bool` = false\ ) | + +------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_collision_exception_with`\ (\ body\: :ref:`Node`\ ) | + +------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`test_move`\ (\ from\: :ref:`Transform2D`, motion\: :ref:`Vector2`, collision\: :ref:`KinematicCollision2D` = null, safe_margin\: :ref:`float` = 0.08, recovery_as_collision\: :ref:`bool` = false\ ) | + +------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -77,7 +77,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_collision_exception_with** **(** :ref:`Node` body **)** +|void| **add_collision_exception_with**\ (\ body\: :ref:`Node`\ ) Adds a body to the list of bodies that this body can't collide with. @@ -89,7 +89,7 @@ Adds a body to the list of bodies that this body can't collide with. .. rst-class:: classref-method -:ref:`PhysicsBody2D[]` **get_collision_exceptions** **(** **)** +:ref:`Array`\[:ref:`PhysicsBody2D`\] **get_collision_exceptions**\ (\ ) Returns an array of nodes that were added as collision exceptions for this body. @@ -101,7 +101,7 @@ Returns an array of nodes that were added as collision exceptions for this body. .. rst-class:: classref-method -:ref:`Vector2` **get_gravity** **(** **)** |const| +:ref:`Vector2` **get_gravity**\ (\ ) |const| Returns the gravity vector computed from all sources that can affect the body, including all gravity overrides from :ref:`Area2D` nodes and the global world gravity. @@ -113,7 +113,7 @@ Returns the gravity vector computed from all sources that can affect the body, i .. rst-class:: classref-method -:ref:`KinematicCollision2D` **move_and_collide** **(** :ref:`Vector2` motion, :ref:`bool` test_only=false, :ref:`float` safe_margin=0.08, :ref:`bool` recovery_as_collision=false **)** +:ref:`KinematicCollision2D` **move_and_collide**\ (\ motion\: :ref:`Vector2`, test_only\: :ref:`bool` = false, safe_margin\: :ref:`float` = 0.08, recovery_as_collision\: :ref:`bool` = false\ ) Moves the body along the vector ``motion``. In order to be frame rate independent in :ref:`Node._physics_process` or :ref:`Node._process`, ``motion`` should be computed using ``delta``. @@ -133,7 +133,7 @@ If ``recovery_as_collision`` is ``true``, any depenetration from the recovery ph .. rst-class:: classref-method -void **remove_collision_exception_with** **(** :ref:`Node` body **)** +|void| **remove_collision_exception_with**\ (\ body\: :ref:`Node`\ ) Removes a body from the list of bodies that this body can't collide with. @@ -145,7 +145,7 @@ Removes a body from the list of bodies that this body can't collide with. .. rst-class:: classref-method -:ref:`bool` **test_move** **(** :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`KinematicCollision2D` collision=null, :ref:`float` safe_margin=0.08, :ref:`bool` recovery_as_collision=false **)** +:ref:`bool` **test_move**\ (\ from\: :ref:`Transform2D`, motion\: :ref:`Vector2`, collision\: :ref:`KinematicCollision2D` = null, safe_margin\: :ref:`float` = 0.08, recovery_as_collision\: :ref:`bool` = false\ ) Checks for collisions without moving the body. In order to be frame rate independent in :ref:`Node._physics_process` or :ref:`Node._process`, ``motion`` should be computed using ``delta``. @@ -164,3 +164,4 @@ If ``recovery_as_collision`` is ``true``, any depenetration from the recovery ph .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsbody3d.rst b/classes/class_physicsbody3d.rst index cfa6fca355d..f9cb293abdf 100644 --- a/classes/class_physicsbody3d.rst +++ b/classes/class_physicsbody3d.rst @@ -62,23 +62,23 @@ Methods .. table:: :widths: auto - +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | - +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_axis_lock` **(** :ref:`BodyAxis` axis **)** |const| | - +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsBody3D[]` | :ref:`get_collision_exceptions` **(** **)** | - +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_gravity` **(** **)** |const| | - +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`KinematicCollision3D` | :ref:`move_and_collide` **(** :ref:`Vector3` motion, :ref:`bool` test_only=false, :ref:`float` safe_margin=0.001, :ref:`bool` recovery_as_collision=false, :ref:`int` max_collisions=1 **)** | - +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | - +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_axis_lock` **(** :ref:`BodyAxis` axis, :ref:`bool` lock **)** | - +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`test_move` **(** :ref:`Transform3D` from, :ref:`Vector3` motion, :ref:`KinematicCollision3D` collision=null, :ref:`float` safe_margin=0.001, :ref:`bool` recovery_as_collision=false, :ref:`int` max_collisions=1 **)** | - +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_collision_exception_with`\ (\ body\: :ref:`Node`\ ) | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_axis_lock`\ (\ axis\: :ref:`BodyAxis`\ ) |const| | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`PhysicsBody3D`\] | :ref:`get_collision_exceptions`\ (\ ) | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_gravity`\ (\ ) |const| | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`KinematicCollision3D` | :ref:`move_and_collide`\ (\ motion\: :ref:`Vector3`, test_only\: :ref:`bool` = false, safe_margin\: :ref:`float` = 0.001, recovery_as_collision\: :ref:`bool` = false, max_collisions\: :ref:`int` = 1\ ) | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_collision_exception_with`\ (\ body\: :ref:`Node`\ ) | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_axis_lock`\ (\ axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`test_move`\ (\ from\: :ref:`Transform3D`, motion\: :ref:`Vector3`, collision\: :ref:`KinematicCollision3D` = null, safe_margin\: :ref:`float` = 0.001, recovery_as_collision\: :ref:`bool` = false, max_collisions\: :ref:`int` = 1\ ) | + +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -97,8 +97,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_axis_lock** **(** :ref:`BodyAxis` axis, :ref:`bool` lock **)** -- :ref:`bool` **get_axis_lock** **(** :ref:`BodyAxis` axis **)** |const| +- |void| **set_axis_lock**\ (\ axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) +- :ref:`bool` **get_axis_lock**\ (\ axis\: :ref:`BodyAxis`\ ) |const| Lock the body's rotation in the X axis. @@ -114,8 +114,8 @@ Lock the body's rotation in the X axis. .. rst-class:: classref-property-setget -- void **set_axis_lock** **(** :ref:`BodyAxis` axis, :ref:`bool` lock **)** -- :ref:`bool` **get_axis_lock** **(** :ref:`BodyAxis` axis **)** |const| +- |void| **set_axis_lock**\ (\ axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) +- :ref:`bool` **get_axis_lock**\ (\ axis\: :ref:`BodyAxis`\ ) |const| Lock the body's rotation in the Y axis. @@ -131,8 +131,8 @@ Lock the body's rotation in the Y axis. .. rst-class:: classref-property-setget -- void **set_axis_lock** **(** :ref:`BodyAxis` axis, :ref:`bool` lock **)** -- :ref:`bool` **get_axis_lock** **(** :ref:`BodyAxis` axis **)** |const| +- |void| **set_axis_lock**\ (\ axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) +- :ref:`bool` **get_axis_lock**\ (\ axis\: :ref:`BodyAxis`\ ) |const| Lock the body's rotation in the Z axis. @@ -148,8 +148,8 @@ Lock the body's rotation in the Z axis. .. rst-class:: classref-property-setget -- void **set_axis_lock** **(** :ref:`BodyAxis` axis, :ref:`bool` lock **)** -- :ref:`bool` **get_axis_lock** **(** :ref:`BodyAxis` axis **)** |const| +- |void| **set_axis_lock**\ (\ axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) +- :ref:`bool` **get_axis_lock**\ (\ axis\: :ref:`BodyAxis`\ ) |const| Lock the body's linear movement in the X axis. @@ -165,8 +165,8 @@ Lock the body's linear movement in the X axis. .. rst-class:: classref-property-setget -- void **set_axis_lock** **(** :ref:`BodyAxis` axis, :ref:`bool` lock **)** -- :ref:`bool` **get_axis_lock** **(** :ref:`BodyAxis` axis **)** |const| +- |void| **set_axis_lock**\ (\ axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) +- :ref:`bool` **get_axis_lock**\ (\ axis\: :ref:`BodyAxis`\ ) |const| Lock the body's linear movement in the Y axis. @@ -182,8 +182,8 @@ Lock the body's linear movement in the Y axis. .. rst-class:: classref-property-setget -- void **set_axis_lock** **(** :ref:`BodyAxis` axis, :ref:`bool` lock **)** -- :ref:`bool` **get_axis_lock** **(** :ref:`BodyAxis` axis **)** |const| +- |void| **set_axis_lock**\ (\ axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) +- :ref:`bool` **get_axis_lock**\ (\ axis\: :ref:`BodyAxis`\ ) |const| Lock the body's linear movement in the Z axis. @@ -200,7 +200,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_collision_exception_with** **(** :ref:`Node` body **)** +|void| **add_collision_exception_with**\ (\ body\: :ref:`Node`\ ) Adds a body to the list of bodies that this body can't collide with. @@ -212,7 +212,7 @@ Adds a body to the list of bodies that this body can't collide with. .. rst-class:: classref-method -:ref:`bool` **get_axis_lock** **(** :ref:`BodyAxis` axis **)** |const| +:ref:`bool` **get_axis_lock**\ (\ axis\: :ref:`BodyAxis`\ ) |const| Returns ``true`` if the specified linear or rotational ``axis`` is locked. @@ -224,7 +224,7 @@ Returns ``true`` if the specified linear or rotational ``axis`` is locked. .. rst-class:: classref-method -:ref:`PhysicsBody3D[]` **get_collision_exceptions** **(** **)** +:ref:`Array`\[:ref:`PhysicsBody3D`\] **get_collision_exceptions**\ (\ ) Returns an array of nodes that were added as collision exceptions for this body. @@ -236,7 +236,7 @@ Returns an array of nodes that were added as collision exceptions for this body. .. rst-class:: classref-method -:ref:`Vector3` **get_gravity** **(** **)** |const| +:ref:`Vector3` **get_gravity**\ (\ ) |const| Returns the gravity vector computed from all sources that can affect the body, including all gravity overrides from :ref:`Area3D` nodes and the global world gravity. @@ -248,7 +248,7 @@ Returns the gravity vector computed from all sources that can affect the body, i .. rst-class:: classref-method -:ref:`KinematicCollision3D` **move_and_collide** **(** :ref:`Vector3` motion, :ref:`bool` test_only=false, :ref:`float` safe_margin=0.001, :ref:`bool` recovery_as_collision=false, :ref:`int` max_collisions=1 **)** +:ref:`KinematicCollision3D` **move_and_collide**\ (\ motion\: :ref:`Vector3`, test_only\: :ref:`bool` = false, safe_margin\: :ref:`float` = 0.001, recovery_as_collision\: :ref:`bool` = false, max_collisions\: :ref:`int` = 1\ ) Moves the body along the vector ``motion``. In order to be frame rate independent in :ref:`Node._physics_process` or :ref:`Node._process`, ``motion`` should be computed using ``delta``. @@ -270,7 +270,7 @@ If ``recovery_as_collision`` is ``true``, any depenetration from the recovery ph .. rst-class:: classref-method -void **remove_collision_exception_with** **(** :ref:`Node` body **)** +|void| **remove_collision_exception_with**\ (\ body\: :ref:`Node`\ ) Removes a body from the list of bodies that this body can't collide with. @@ -282,7 +282,7 @@ Removes a body from the list of bodies that this body can't collide with. .. rst-class:: classref-method -void **set_axis_lock** **(** :ref:`BodyAxis` axis, :ref:`bool` lock **)** +|void| **set_axis_lock**\ (\ axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) Locks or unlocks the specified linear or rotational ``axis`` depending on the value of ``lock``. @@ -294,7 +294,7 @@ Locks or unlocks the specified linear or rotational ``axis`` depending on the va .. rst-class:: classref-method -:ref:`bool` **test_move** **(** :ref:`Transform3D` from, :ref:`Vector3` motion, :ref:`KinematicCollision3D` collision=null, :ref:`float` safe_margin=0.001, :ref:`bool` recovery_as_collision=false, :ref:`int` max_collisions=1 **)** +:ref:`bool` **test_move**\ (\ from\: :ref:`Transform3D`, motion\: :ref:`Vector3`, collision\: :ref:`KinematicCollision3D` = null, safe_margin\: :ref:`float` = 0.001, recovery_as_collision\: :ref:`bool` = false, max_collisions\: :ref:`int` = 1\ ) Checks for collisions without moving the body. In order to be frame rate independent in :ref:`Node._physics_process` or :ref:`Node._process`, ``motion`` should be computed using ``delta``. @@ -315,3 +315,4 @@ If ``recovery_as_collision`` is ``true``, any depenetration from the recovery ph .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsdirectbodystate2d.rst b/classes/class_physicsdirectbodystate2d.rst index 6c8f678bf65..9166dde02a3 100644 --- a/classes/class_physicsdirectbodystate2d.rst +++ b/classes/class_physicsdirectbodystate2d.rst @@ -74,63 +74,63 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_constant_central_force` **(** :ref:`Vector2` force=Vector2(0, 0) **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_constant_force` **(** :ref:`Vector2` force, :ref:`Vector2` position=Vector2(0, 0) **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_constant_torque` **(** :ref:`float` torque **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_central_force` **(** :ref:`Vector2` force=Vector2(0, 0) **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_central_impulse` **(** :ref:`Vector2` impulse **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_force` **(** :ref:`Vector2` force, :ref:`Vector2` position=Vector2(0, 0) **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_impulse` **(** :ref:`Vector2` impulse, :ref:`Vector2` position=Vector2(0, 0) **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_torque` **(** :ref:`float` torque **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_torque_impulse` **(** :ref:`float` impulse **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_constant_force` **(** **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_constant_torque` **(** **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_contact_collider_id` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_contact_collider_position` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_contact_collider_shape` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_contact_count` **(** **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_contact_impulse` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_contact_local_position` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_contact_local_velocity_at_position` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectSpaceState2D` | :ref:`get_space_state` **(** **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_velocity_at_local_position` **(** :ref:`Vector2` local_position **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`integrate_forces` **(** **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_constant_force` **(** :ref:`Vector2` force **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_constant_torque` **(** :ref:`float` torque **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_constant_central_force`\ (\ force\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_constant_force`\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_constant_torque`\ (\ torque\: :ref:`float`\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_central_force`\ (\ force\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_central_impulse`\ (\ impulse\: :ref:`Vector2`\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_force`\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_impulse`\ (\ impulse\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_torque`\ (\ torque\: :ref:`float`\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_torque_impulse`\ (\ impulse\: :ref:`float`\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_constant_force`\ (\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_constant_torque`\ (\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_contact_collider`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_contact_collider_id`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_contact_collider_object`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_contact_collider_position`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_contact_collider_shape`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_contact_collider_velocity_at_position`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_contact_count`\ (\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_contact_impulse`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_contact_local_normal`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_contact_local_position`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_contact_local_shape`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_contact_local_velocity_at_position`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectSpaceState2D` | :ref:`get_space_state`\ (\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_velocity_at_local_position`\ (\ local_position\: :ref:`Vector2`\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`integrate_forces`\ (\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_constant_force`\ (\ force\: :ref:`Vector2`\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_constant_torque`\ (\ torque\: :ref:`float`\ ) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -149,8 +149,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_angular_velocity** **(** :ref:`float` value **)** -- :ref:`float` **get_angular_velocity** **(** **)** +- |void| **set_angular_velocity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_angular_velocity**\ (\ ) The body's rotational velocity in *radians* per second. @@ -166,7 +166,7 @@ The body's rotational velocity in *radians* per second. .. rst-class:: classref-property-setget -- :ref:`Vector2` **get_center_of_mass** **(** **)** +- :ref:`Vector2` **get_center_of_mass**\ (\ ) The body's center of mass position relative to the body's center in the global coordinate system. @@ -182,7 +182,7 @@ The body's center of mass position relative to the body's center in the global c .. rst-class:: classref-property-setget -- :ref:`Vector2` **get_center_of_mass_local** **(** **)** +- :ref:`Vector2` **get_center_of_mass_local**\ (\ ) The body's center of mass position in the body's local coordinate system. @@ -198,7 +198,7 @@ The body's center of mass position in the body's local coordinate system. .. rst-class:: classref-property-setget -- :ref:`float` **get_inverse_inertia** **(** **)** +- :ref:`float` **get_inverse_inertia**\ (\ ) The inverse of the inertia of the body. @@ -214,7 +214,7 @@ The inverse of the inertia of the body. .. rst-class:: classref-property-setget -- :ref:`float` **get_inverse_mass** **(** **)** +- :ref:`float` **get_inverse_mass**\ (\ ) The inverse of the mass of the body. @@ -230,8 +230,8 @@ The inverse of the mass of the body. .. rst-class:: classref-property-setget -- void **set_linear_velocity** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_linear_velocity** **(** **)** +- |void| **set_linear_velocity**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_linear_velocity**\ (\ ) The body's linear velocity in pixels per second. @@ -247,8 +247,8 @@ The body's linear velocity in pixels per second. .. rst-class:: classref-property-setget -- void **set_sleep_state** **(** :ref:`bool` value **)** -- :ref:`bool` **is_sleeping** **(** **)** +- |void| **set_sleep_state**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_sleeping**\ (\ ) If ``true``, this body is currently sleeping (not active). @@ -264,7 +264,7 @@ If ``true``, this body is currently sleeping (not active). .. rst-class:: classref-property-setget -- :ref:`float` **get_step** **(** **)** +- :ref:`float` **get_step**\ (\ ) The timestep (delta) used for the simulation. @@ -280,7 +280,7 @@ The timestep (delta) used for the simulation. .. rst-class:: classref-property-setget -- :ref:`float` **get_total_angular_damp** **(** **)** +- :ref:`float` **get_total_angular_damp**\ (\ ) The rate at which the body stops rotating, if there are not any other forces moving it. @@ -296,7 +296,7 @@ The rate at which the body stops rotating, if there are not any other forces mov .. rst-class:: classref-property-setget -- :ref:`Vector2` **get_total_gravity** **(** **)** +- :ref:`Vector2` **get_total_gravity**\ (\ ) The total gravity vector being currently applied to this body. @@ -312,7 +312,7 @@ The total gravity vector being currently applied to this body. .. rst-class:: classref-property-setget -- :ref:`float` **get_total_linear_damp** **(** **)** +- :ref:`float` **get_total_linear_damp**\ (\ ) The rate at which the body stops moving, if there are not any other forces moving it. @@ -328,8 +328,8 @@ The rate at which the body stops moving, if there are not any other forces movin .. rst-class:: classref-property-setget -- void **set_transform** **(** :ref:`Transform2D` value **)** -- :ref:`Transform2D` **get_transform** **(** **)** +- |void| **set_transform**\ (\ value\: :ref:`Transform2D`\ ) +- :ref:`Transform2D` **get_transform**\ (\ ) The body's transformation matrix. @@ -346,7 +346,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_constant_central_force** **(** :ref:`Vector2` force=Vector2(0, 0) **)** +|void| **add_constant_central_force**\ (\ force\: :ref:`Vector2` = Vector2(0, 0)\ ) Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with ``constant_force = Vector2(0, 0)``. @@ -360,7 +360,7 @@ This is equivalent to using :ref:`add_constant_force` force, :ref:`Vector2` position=Vector2(0, 0) **)** +|void| **add_constant_force**\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) Adds a constant positioned force to the body that keeps being applied over time until cleared with ``constant_force = Vector2(0, 0)``. @@ -374,7 +374,7 @@ Adds a constant positioned force to the body that keeps being applied over time .. rst-class:: classref-method -void **add_constant_torque** **(** :ref:`float` torque **)** +|void| **add_constant_torque**\ (\ torque\: :ref:`float`\ ) Adds a constant rotational force without affecting position that keeps being applied over time until cleared with ``constant_torque = 0``. @@ -386,7 +386,7 @@ Adds a constant rotational force without affecting position that keeps being app .. rst-class:: classref-method -void **apply_central_force** **(** :ref:`Vector2` force=Vector2(0, 0) **)** +|void| **apply_central_force**\ (\ force\: :ref:`Vector2` = Vector2(0, 0)\ ) Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. @@ -400,7 +400,7 @@ This is equivalent to using :ref:`apply_force` impulse **)** +|void| **apply_central_impulse**\ (\ impulse\: :ref:`Vector2`\ ) Applies a directional impulse without affecting rotation. @@ -416,7 +416,7 @@ This is equivalent to using :ref:`apply_impulse` force, :ref:`Vector2` position=Vector2(0, 0) **)** +|void| **apply_force**\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. @@ -430,7 +430,7 @@ Applies a positioned force to the body. A force is time dependent and meant to b .. rst-class:: classref-method -void **apply_impulse** **(** :ref:`Vector2` impulse, :ref:`Vector2` position=Vector2(0, 0) **)** +|void| **apply_impulse**\ (\ impulse\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) Applies a positioned impulse to the body. @@ -446,7 +446,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -void **apply_torque** **(** :ref:`float` torque **)** +|void| **apply_torque**\ (\ torque\: :ref:`float`\ ) Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. @@ -460,7 +460,7 @@ Applies a rotational force without affecting position. A force is time dependent .. rst-class:: classref-method -void **apply_torque_impulse** **(** :ref:`float` impulse **)** +|void| **apply_torque_impulse**\ (\ impulse\: :ref:`float`\ ) Applies a rotational impulse to the body without affecting the position. @@ -476,7 +476,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -:ref:`Vector2` **get_constant_force** **(** **)** |const| +:ref:`Vector2` **get_constant_force**\ (\ ) |const| Returns the body's total constant positional forces applied during each physics update. @@ -490,7 +490,7 @@ See :ref:`add_constant_force` **get_constant_torque** **(** **)** |const| +:ref:`float` **get_constant_torque**\ (\ ) |const| Returns the body's total constant rotational forces applied during each physics update. @@ -504,7 +504,7 @@ See :ref:`add_constant_torque` **get_contact_collider** **(** :ref:`int` contact_idx **)** |const| +:ref:`RID` **get_contact_collider**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the collider's :ref:`RID`. @@ -516,7 +516,7 @@ Returns the collider's :ref:`RID`. .. rst-class:: classref-method -:ref:`int` **get_contact_collider_id** **(** :ref:`int` contact_idx **)** |const| +:ref:`int` **get_contact_collider_id**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the collider's object id. @@ -528,7 +528,7 @@ Returns the collider's object id. .. rst-class:: classref-method -:ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** |const| +:ref:`Object` **get_contact_collider_object**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the collider object. This depends on how it was created (will return a scene node if such was used to create it). @@ -540,7 +540,7 @@ Returns the collider object. This depends on how it was created (will return a s .. rst-class:: classref-method -:ref:`Vector2` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** |const| +:ref:`Vector2` **get_contact_collider_position**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the position of the contact point on the collider in the global coordinate system. @@ -552,7 +552,7 @@ Returns the position of the contact point on the collider in the global coordina .. rst-class:: classref-method -:ref:`int` **get_contact_collider_shape** **(** :ref:`int` contact_idx **)** |const| +:ref:`int` **get_contact_collider_shape**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the collider's shape index. @@ -564,7 +564,7 @@ Returns the collider's shape index. .. rst-class:: classref-method -:ref:`Vector2` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** |const| +:ref:`Vector2` **get_contact_collider_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the velocity vector at the collider's contact point. @@ -576,7 +576,7 @@ Returns the velocity vector at the collider's contact point. .. rst-class:: classref-method -:ref:`int` **get_contact_count** **(** **)** |const| +:ref:`int` **get_contact_count**\ (\ ) |const| Returns the number of contacts this body has with other bodies. @@ -590,7 +590,7 @@ Returns the number of contacts this body has with other bodies. .. rst-class:: classref-method -:ref:`Vector2` **get_contact_impulse** **(** :ref:`int` contact_idx **)** |const| +:ref:`Vector2` **get_contact_impulse**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the impulse created by the contact. @@ -602,7 +602,7 @@ Returns the impulse created by the contact. .. rst-class:: classref-method -:ref:`Vector2` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** |const| +:ref:`Vector2` **get_contact_local_normal**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the local normal at the contact point. @@ -614,7 +614,7 @@ Returns the local normal at the contact point. .. rst-class:: classref-method -:ref:`Vector2` **get_contact_local_position** **(** :ref:`int` contact_idx **)** |const| +:ref:`Vector2` **get_contact_local_position**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the position of the contact point on the body in the global coordinate system. @@ -626,7 +626,7 @@ Returns the position of the contact point on the body in the global coordinate s .. rst-class:: classref-method -:ref:`int` **get_contact_local_shape** **(** :ref:`int` contact_idx **)** |const| +:ref:`int` **get_contact_local_shape**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the local shape index of the collision. @@ -638,7 +638,7 @@ Returns the local shape index of the collision. .. rst-class:: classref-method -:ref:`Vector2` **get_contact_local_velocity_at_position** **(** :ref:`int` contact_idx **)** |const| +:ref:`Vector2` **get_contact_local_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the velocity vector at the body's contact point. @@ -650,7 +650,7 @@ Returns the velocity vector at the body's contact point. .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState2D` **get_space_state** **(** **)** +:ref:`PhysicsDirectSpaceState2D` **get_space_state**\ (\ ) Returns the current state of the space, useful for queries. @@ -662,7 +662,7 @@ Returns the current state of the space, useful for queries. .. rst-class:: classref-method -:ref:`Vector2` **get_velocity_at_local_position** **(** :ref:`Vector2` local_position **)** |const| +:ref:`Vector2` **get_velocity_at_local_position**\ (\ local_position\: :ref:`Vector2`\ ) |const| Returns the body's velocity at the given relative position, including both translation and rotation. @@ -674,7 +674,7 @@ Returns the body's velocity at the given relative position, including both trans .. rst-class:: classref-method -void **integrate_forces** **(** **)** +|void| **integrate_forces**\ (\ ) Calls the built-in force integration code. @@ -686,7 +686,7 @@ Calls the built-in force integration code. .. rst-class:: classref-method -void **set_constant_force** **(** :ref:`Vector2` force **)** +|void| **set_constant_force**\ (\ force\: :ref:`Vector2`\ ) Sets the body's total constant positional forces applied during each physics update. @@ -700,7 +700,7 @@ See :ref:`add_constant_force` torque **)** +|void| **set_constant_torque**\ (\ torque\: :ref:`float`\ ) Sets the body's total constant rotational forces applied during each physics update. @@ -713,3 +713,4 @@ See :ref:`add_constant_torque` **(** :ref:`Vector2` force **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_add_constant_force` **(** :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_add_constant_torque` **(** :ref:`float` torque **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_apply_central_force` **(** :ref:`Vector2` force **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_apply_central_impulse` **(** :ref:`Vector2` impulse **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_apply_force` **(** :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_apply_impulse` **(** :ref:`Vector2` impulse, :ref:`Vector2` position **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_apply_torque` **(** :ref:`float` torque **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_apply_torque_impulse` **(** :ref:`float` impulse **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_angular_velocity` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_center_of_mass` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_center_of_mass_local` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_constant_force` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_constant_torque` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_get_contact_collider` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_contact_collider_id` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`_get_contact_collider_object` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_contact_collider_position` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_contact_collider_shape` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_contact_count` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_contact_impulse` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_contact_local_normal` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_contact_local_position` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_contact_local_shape` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_contact_local_velocity_at_position` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_inverse_inertia` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_inverse_mass` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_linear_velocity` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectSpaceState2D` | :ref:`_get_space_state` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_step` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_total_angular_damp` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_total_gravity` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_total_linear_damp` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`_get_transform` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_velocity_at_local_position` **(** :ref:`Vector2` local_position **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_integrate_forces` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_sleeping` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_angular_velocity` **(** :ref:`float` velocity **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_constant_force` **(** :ref:`Vector2` force **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_constant_torque` **(** :ref:`float` torque **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_linear_velocity` **(** :ref:`Vector2` velocity **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_sleep_state` **(** :ref:`bool` enabled **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_transform` **(** :ref:`Transform2D` transform **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_add_constant_central_force`\ (\ force\: :ref:`Vector2`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_add_constant_force`\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_add_constant_torque`\ (\ torque\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_central_force`\ (\ force\: :ref:`Vector2`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_central_impulse`\ (\ impulse\: :ref:`Vector2`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_force`\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_impulse`\ (\ impulse\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_torque`\ (\ torque\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_torque_impulse`\ (\ impulse\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_angular_velocity`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_center_of_mass`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_center_of_mass_local`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_constant_force`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_constant_torque`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_get_contact_collider`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_contact_collider_id`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`_get_contact_collider_object`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_contact_collider_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_contact_collider_shape`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_contact_collider_velocity_at_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_contact_count`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_contact_impulse`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_contact_local_normal`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_contact_local_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_contact_local_shape`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_contact_local_velocity_at_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_inverse_inertia`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_inverse_mass`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_linear_velocity`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectSpaceState2D` | :ref:`_get_space_state`\ (\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_step`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_total_angular_damp`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_total_gravity`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_total_linear_damp`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`_get_transform`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_velocity_at_local_position`\ (\ local_position\: :ref:`Vector2`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_integrate_forces`\ (\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_sleeping`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_angular_velocity`\ (\ velocity\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_constant_force`\ (\ force\: :ref:`Vector2`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_constant_torque`\ (\ torque\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_linear_velocity`\ (\ velocity\: :ref:`Vector2`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_sleep_state`\ (\ enabled\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_transform`\ (\ transform\: :ref:`Transform2D`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -134,7 +134,7 @@ Method Descriptions .. rst-class:: classref-method -void **_add_constant_central_force** **(** :ref:`Vector2` force **)** |virtual| +|void| **_add_constant_central_force**\ (\ force\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -148,7 +148,7 @@ void **_add_constant_central_force** **(** :ref:`Vector2` force * .. rst-class:: classref-method -void **_add_constant_force** **(** :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| +|void| **_add_constant_force**\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -162,7 +162,7 @@ void **_add_constant_force** **(** :ref:`Vector2` force, :ref:`Ve .. rst-class:: classref-method -void **_add_constant_torque** **(** :ref:`float` torque **)** |virtual| +|void| **_add_constant_torque**\ (\ torque\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -176,7 +176,7 @@ void **_add_constant_torque** **(** :ref:`float` torque **)** |virt .. rst-class:: classref-method -void **_apply_central_force** **(** :ref:`Vector2` force **)** |virtual| +|void| **_apply_central_force**\ (\ force\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -190,7 +190,7 @@ void **_apply_central_force** **(** :ref:`Vector2` force **)** |v .. rst-class:: classref-method -void **_apply_central_impulse** **(** :ref:`Vector2` impulse **)** |virtual| +|void| **_apply_central_impulse**\ (\ impulse\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -204,7 +204,7 @@ void **_apply_central_impulse** **(** :ref:`Vector2` impulse **)* .. rst-class:: classref-method -void **_apply_force** **(** :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| +|void| **_apply_force**\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -218,7 +218,7 @@ void **_apply_force** **(** :ref:`Vector2` force, :ref:`Vector2` impulse, :ref:`Vector2` position **)** |virtual| +|void| **_apply_impulse**\ (\ impulse\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -232,7 +232,7 @@ void **_apply_impulse** **(** :ref:`Vector2` impulse, :ref:`Vecto .. rst-class:: classref-method -void **_apply_torque** **(** :ref:`float` torque **)** |virtual| +|void| **_apply_torque**\ (\ torque\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -246,7 +246,7 @@ void **_apply_torque** **(** :ref:`float` torque **)** |virtual| .. rst-class:: classref-method -void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |virtual| +|void| **_apply_torque_impulse**\ (\ impulse\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -260,7 +260,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`float` **_get_angular_velocity** **(** **)** |virtual| |const| +:ref:`float` **_get_angular_velocity**\ (\ ) |virtual| |const| .. container:: contribute @@ -274,7 +274,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`Vector2` **_get_center_of_mass** **(** **)** |virtual| |const| +:ref:`Vector2` **_get_center_of_mass**\ (\ ) |virtual| |const| .. container:: contribute @@ -288,7 +288,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`Vector2` **_get_center_of_mass_local** **(** **)** |virtual| |const| +:ref:`Vector2` **_get_center_of_mass_local**\ (\ ) |virtual| |const| .. container:: contribute @@ -302,7 +302,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`Vector2` **_get_constant_force** **(** **)** |virtual| |const| +:ref:`Vector2` **_get_constant_force**\ (\ ) |virtual| |const| .. container:: contribute @@ -316,7 +316,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`float` **_get_constant_torque** **(** **)** |virtual| |const| +:ref:`float` **_get_constant_torque**\ (\ ) |virtual| |const| .. container:: contribute @@ -330,7 +330,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`RID` **_get_contact_collider** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`RID` **_get_contact_collider**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -344,7 +344,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`int` **_get_contact_collider_id** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`int` **_get_contact_collider_id**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -358,7 +358,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`Object` **_get_contact_collider_object** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`Object` **_get_contact_collider_object**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -372,7 +372,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`Vector2` **_get_contact_collider_position** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`Vector2` **_get_contact_collider_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -386,7 +386,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`int` **_get_contact_collider_shape** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`int` **_get_contact_collider_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -400,7 +400,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`Vector2` **_get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`Vector2` **_get_contact_collider_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -414,7 +414,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`int` **_get_contact_count** **(** **)** |virtual| |const| +:ref:`int` **_get_contact_count**\ (\ ) |virtual| |const| .. container:: contribute @@ -428,7 +428,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`Vector2` **_get_contact_impulse** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`Vector2` **_get_contact_impulse**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -442,7 +442,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`Vector2` **_get_contact_local_normal** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`Vector2` **_get_contact_local_normal**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -456,7 +456,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`Vector2` **_get_contact_local_position** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`Vector2` **_get_contact_local_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -470,7 +470,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`int` **_get_contact_local_shape** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`int` **_get_contact_local_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -484,7 +484,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`Vector2` **_get_contact_local_velocity_at_position** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`Vector2` **_get_contact_local_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -498,7 +498,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`float` **_get_inverse_inertia** **(** **)** |virtual| |const| +:ref:`float` **_get_inverse_inertia**\ (\ ) |virtual| |const| .. container:: contribute @@ -512,7 +512,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`float` **_get_inverse_mass** **(** **)** |virtual| |const| +:ref:`float` **_get_inverse_mass**\ (\ ) |virtual| |const| .. container:: contribute @@ -526,7 +526,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`Vector2` **_get_linear_velocity** **(** **)** |virtual| |const| +:ref:`Vector2` **_get_linear_velocity**\ (\ ) |virtual| |const| .. container:: contribute @@ -540,7 +540,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState2D` **_get_space_state** **(** **)** |virtual| +:ref:`PhysicsDirectSpaceState2D` **_get_space_state**\ (\ ) |virtual| .. container:: contribute @@ -554,7 +554,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`float` **_get_step** **(** **)** |virtual| |const| +:ref:`float` **_get_step**\ (\ ) |virtual| |const| .. container:: contribute @@ -568,7 +568,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`float` **_get_total_angular_damp** **(** **)** |virtual| |const| +:ref:`float` **_get_total_angular_damp**\ (\ ) |virtual| |const| .. container:: contribute @@ -582,7 +582,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`Vector2` **_get_total_gravity** **(** **)** |virtual| |const| +:ref:`Vector2` **_get_total_gravity**\ (\ ) |virtual| |const| .. container:: contribute @@ -596,7 +596,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`float` **_get_total_linear_damp** **(** **)** |virtual| |const| +:ref:`float` **_get_total_linear_damp**\ (\ ) |virtual| |const| .. container:: contribute @@ -610,7 +610,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`Transform2D` **_get_transform** **(** **)** |virtual| |const| +:ref:`Transform2D` **_get_transform**\ (\ ) |virtual| |const| .. container:: contribute @@ -624,7 +624,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -:ref:`Vector2` **_get_velocity_at_local_position** **(** :ref:`Vector2` local_position **)** |virtual| |const| +:ref:`Vector2` **_get_velocity_at_local_position**\ (\ local_position\: :ref:`Vector2`\ ) |virtual| |const| .. container:: contribute @@ -638,7 +638,7 @@ void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |vi .. rst-class:: classref-method -void **_integrate_forces** **(** **)** |virtual| +|void| **_integrate_forces**\ (\ ) |virtual| .. container:: contribute @@ -652,7 +652,7 @@ void **_integrate_forces** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_is_sleeping** **(** **)** |virtual| |const| +:ref:`bool` **_is_sleeping**\ (\ ) |virtual| |const| .. container:: contribute @@ -666,7 +666,7 @@ void **_integrate_forces** **(** **)** |virtual| .. rst-class:: classref-method -void **_set_angular_velocity** **(** :ref:`float` velocity **)** |virtual| +|void| **_set_angular_velocity**\ (\ velocity\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -680,7 +680,7 @@ void **_set_angular_velocity** **(** :ref:`float` velocity **)** |v .. rst-class:: classref-method -void **_set_constant_force** **(** :ref:`Vector2` force **)** |virtual| +|void| **_set_constant_force**\ (\ force\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -694,7 +694,7 @@ void **_set_constant_force** **(** :ref:`Vector2` force **)** |vi .. rst-class:: classref-method -void **_set_constant_torque** **(** :ref:`float` torque **)** |virtual| +|void| **_set_constant_torque**\ (\ torque\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -708,7 +708,7 @@ void **_set_constant_torque** **(** :ref:`float` torque **)** |virt .. rst-class:: classref-method -void **_set_linear_velocity** **(** :ref:`Vector2` velocity **)** |virtual| +|void| **_set_linear_velocity**\ (\ velocity\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -722,7 +722,7 @@ void **_set_linear_velocity** **(** :ref:`Vector2` velocity **)** .. rst-class:: classref-method -void **_set_sleep_state** **(** :ref:`bool` enabled **)** |virtual| +|void| **_set_sleep_state**\ (\ enabled\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -736,7 +736,7 @@ void **_set_sleep_state** **(** :ref:`bool` enabled **)** |virtual| .. rst-class:: classref-method -void **_set_transform** **(** :ref:`Transform2D` transform **)** |virtual| +|void| **_set_transform**\ (\ transform\: :ref:`Transform2D`\ ) |virtual| .. container:: contribute @@ -749,3 +749,4 @@ void **_set_transform** **(** :ref:`Transform2D` transform ** .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsdirectbodystate3d.rst b/classes/class_physicsdirectbodystate3d.rst index 703731a4e9e..5daee5c2d27 100644 --- a/classes/class_physicsdirectbodystate3d.rst +++ b/classes/class_physicsdirectbodystate3d.rst @@ -78,63 +78,63 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_constant_central_force` **(** :ref:`Vector3` force=Vector3(0, 0, 0) **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_constant_force` **(** :ref:`Vector3` force, :ref:`Vector3` position=Vector3(0, 0, 0) **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_constant_torque` **(** :ref:`Vector3` torque **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_central_force` **(** :ref:`Vector3` force=Vector3(0, 0, 0) **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_central_impulse` **(** :ref:`Vector3` impulse=Vector3(0, 0, 0) **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_force` **(** :ref:`Vector3` force, :ref:`Vector3` position=Vector3(0, 0, 0) **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_impulse` **(** :ref:`Vector3` impulse, :ref:`Vector3` position=Vector3(0, 0, 0) **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_torque` **(** :ref:`Vector3` torque **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_torque_impulse` **(** :ref:`Vector3` impulse **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_constant_force` **(** **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_constant_torque` **(** **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_contact_collider_id` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_contact_collider_position` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_contact_collider_shape` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_contact_count` **(** **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_contact_impulse` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_contact_local_position` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_contact_local_velocity_at_position` **(** :ref:`int` contact_idx **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectSpaceState3D` | :ref:`get_space_state` **(** **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_velocity_at_local_position` **(** :ref:`Vector3` local_position **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`integrate_forces` **(** **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_constant_force` **(** :ref:`Vector3` force **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_constant_torque` **(** :ref:`Vector3` torque **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_constant_central_force`\ (\ force\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_constant_force`\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_constant_torque`\ (\ torque\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_central_force`\ (\ force\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_central_impulse`\ (\ impulse\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_force`\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_impulse`\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_torque`\ (\ torque\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_torque_impulse`\ (\ impulse\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_constant_force`\ (\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_constant_torque`\ (\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_contact_collider`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_contact_collider_id`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_contact_collider_object`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_contact_collider_position`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_contact_collider_shape`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_contact_collider_velocity_at_position`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_contact_count`\ (\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_contact_impulse`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_contact_local_normal`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_contact_local_position`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_contact_local_shape`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_contact_local_velocity_at_position`\ (\ contact_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectSpaceState3D` | :ref:`get_space_state`\ (\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_velocity_at_local_position`\ (\ local_position\: :ref:`Vector3`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`integrate_forces`\ (\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_constant_force`\ (\ force\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_constant_torque`\ (\ torque\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -153,8 +153,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_angular_velocity** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_angular_velocity** **(** **)** +- |void| **set_angular_velocity**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_angular_velocity**\ (\ ) The body's rotational velocity in *radians* per second. @@ -170,7 +170,7 @@ The body's rotational velocity in *radians* per second. .. rst-class:: classref-property-setget -- :ref:`Vector3` **get_center_of_mass** **(** **)** +- :ref:`Vector3` **get_center_of_mass**\ (\ ) The body's center of mass position relative to the body's center in the global coordinate system. @@ -186,7 +186,7 @@ The body's center of mass position relative to the body's center in the global c .. rst-class:: classref-property-setget -- :ref:`Vector3` **get_center_of_mass_local** **(** **)** +- :ref:`Vector3` **get_center_of_mass_local**\ (\ ) The body's center of mass position in the body's local coordinate system. @@ -202,7 +202,7 @@ The body's center of mass position in the body's local coordinate system. .. rst-class:: classref-property-setget -- :ref:`Vector3` **get_inverse_inertia** **(** **)** +- :ref:`Vector3` **get_inverse_inertia**\ (\ ) The inverse of the inertia of the body. @@ -218,7 +218,7 @@ The inverse of the inertia of the body. .. rst-class:: classref-property-setget -- :ref:`Basis` **get_inverse_inertia_tensor** **(** **)** +- :ref:`Basis` **get_inverse_inertia_tensor**\ (\ ) The inverse of the inertia tensor of the body. @@ -234,7 +234,7 @@ The inverse of the inertia tensor of the body. .. rst-class:: classref-property-setget -- :ref:`float` **get_inverse_mass** **(** **)** +- :ref:`float` **get_inverse_mass**\ (\ ) The inverse of the mass of the body. @@ -250,8 +250,8 @@ The inverse of the mass of the body. .. rst-class:: classref-property-setget -- void **set_linear_velocity** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_linear_velocity** **(** **)** +- |void| **set_linear_velocity**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_linear_velocity**\ (\ ) The body's linear velocity in units per second. @@ -267,7 +267,7 @@ The body's linear velocity in units per second. .. rst-class:: classref-property-setget -- :ref:`Basis` **get_principal_inertia_axes** **(** **)** +- :ref:`Basis` **get_principal_inertia_axes**\ (\ ) .. container:: contribute @@ -285,8 +285,8 @@ The body's linear velocity in units per second. .. rst-class:: classref-property-setget -- void **set_sleep_state** **(** :ref:`bool` value **)** -- :ref:`bool` **is_sleeping** **(** **)** +- |void| **set_sleep_state**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_sleeping**\ (\ ) If ``true``, this body is currently sleeping (not active). @@ -302,7 +302,7 @@ If ``true``, this body is currently sleeping (not active). .. rst-class:: classref-property-setget -- :ref:`float` **get_step** **(** **)** +- :ref:`float` **get_step**\ (\ ) The timestep (delta) used for the simulation. @@ -318,7 +318,7 @@ The timestep (delta) used for the simulation. .. rst-class:: classref-property-setget -- :ref:`float` **get_total_angular_damp** **(** **)** +- :ref:`float` **get_total_angular_damp**\ (\ ) The rate at which the body stops rotating, if there are not any other forces moving it. @@ -334,7 +334,7 @@ The rate at which the body stops rotating, if there are not any other forces mov .. rst-class:: classref-property-setget -- :ref:`Vector3` **get_total_gravity** **(** **)** +- :ref:`Vector3` **get_total_gravity**\ (\ ) The total gravity vector being currently applied to this body. @@ -350,7 +350,7 @@ The total gravity vector being currently applied to this body. .. rst-class:: classref-property-setget -- :ref:`float` **get_total_linear_damp** **(** **)** +- :ref:`float` **get_total_linear_damp**\ (\ ) The rate at which the body stops moving, if there are not any other forces moving it. @@ -366,8 +366,8 @@ The rate at which the body stops moving, if there are not any other forces movin .. rst-class:: classref-property-setget -- void **set_transform** **(** :ref:`Transform3D` value **)** -- :ref:`Transform3D` **get_transform** **(** **)** +- |void| **set_transform**\ (\ value\: :ref:`Transform3D`\ ) +- :ref:`Transform3D` **get_transform**\ (\ ) The body's transformation matrix. @@ -384,7 +384,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_constant_central_force** **(** :ref:`Vector3` force=Vector3(0, 0, 0) **)** +|void| **add_constant_central_force**\ (\ force\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with ``constant_force = Vector3(0, 0, 0)``. @@ -398,7 +398,7 @@ This is equivalent to using :ref:`add_constant_force` force, :ref:`Vector3` position=Vector3(0, 0, 0) **)** +|void| **add_constant_force**\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) Adds a constant positioned force to the body that keeps being applied over time until cleared with ``constant_force = Vector3(0, 0, 0)``. @@ -412,7 +412,7 @@ Adds a constant positioned force to the body that keeps being applied over time .. rst-class:: classref-method -void **add_constant_torque** **(** :ref:`Vector3` torque **)** +|void| **add_constant_torque**\ (\ torque\: :ref:`Vector3`\ ) Adds a constant rotational force without affecting position that keeps being applied over time until cleared with ``constant_torque = Vector3(0, 0, 0)``. @@ -424,7 +424,7 @@ Adds a constant rotational force without affecting position that keeps being app .. rst-class:: classref-method -void **apply_central_force** **(** :ref:`Vector3` force=Vector3(0, 0, 0) **)** +|void| **apply_central_force**\ (\ force\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. @@ -438,7 +438,7 @@ This is equivalent to using :ref:`apply_force` impulse=Vector3(0, 0, 0) **)** +|void| **apply_central_impulse**\ (\ impulse\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) Applies a directional impulse without affecting rotation. @@ -454,7 +454,7 @@ This is equivalent to using :ref:`apply_impulse` force, :ref:`Vector3` position=Vector3(0, 0, 0) **)** +|void| **apply_force**\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. @@ -468,7 +468,7 @@ Applies a positioned force to the body. A force is time dependent and meant to b .. rst-class:: classref-method -void **apply_impulse** **(** :ref:`Vector3` impulse, :ref:`Vector3` position=Vector3(0, 0, 0) **)** +|void| **apply_impulse**\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) Applies a positioned impulse to the body. @@ -484,7 +484,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -void **apply_torque** **(** :ref:`Vector3` torque **)** +|void| **apply_torque**\ (\ torque\: :ref:`Vector3`\ ) Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. @@ -498,7 +498,7 @@ Applies a rotational force without affecting position. A force is time dependent .. rst-class:: classref-method -void **apply_torque_impulse** **(** :ref:`Vector3` impulse **)** +|void| **apply_torque_impulse**\ (\ impulse\: :ref:`Vector3`\ ) Applies a rotational impulse to the body without affecting the position. @@ -514,7 +514,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -:ref:`Vector3` **get_constant_force** **(** **)** |const| +:ref:`Vector3` **get_constant_force**\ (\ ) |const| Returns the body's total constant positional forces applied during each physics update. @@ -528,7 +528,7 @@ See :ref:`add_constant_force` **get_constant_torque** **(** **)** |const| +:ref:`Vector3` **get_constant_torque**\ (\ ) |const| Returns the body's total constant rotational forces applied during each physics update. @@ -542,7 +542,7 @@ See :ref:`add_constant_torque` **get_contact_collider** **(** :ref:`int` contact_idx **)** |const| +:ref:`RID` **get_contact_collider**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the collider's :ref:`RID`. @@ -554,7 +554,7 @@ Returns the collider's :ref:`RID`. .. rst-class:: classref-method -:ref:`int` **get_contact_collider_id** **(** :ref:`int` contact_idx **)** |const| +:ref:`int` **get_contact_collider_id**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the collider's object id. @@ -566,7 +566,7 @@ Returns the collider's object id. .. rst-class:: classref-method -:ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** |const| +:ref:`Object` **get_contact_collider_object**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the collider object. @@ -578,7 +578,7 @@ Returns the collider object. .. rst-class:: classref-method -:ref:`Vector3` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** |const| +:ref:`Vector3` **get_contact_collider_position**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the position of the contact point on the collider in the global coordinate system. @@ -590,7 +590,7 @@ Returns the position of the contact point on the collider in the global coordina .. rst-class:: classref-method -:ref:`int` **get_contact_collider_shape** **(** :ref:`int` contact_idx **)** |const| +:ref:`int` **get_contact_collider_shape**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the collider's shape index. @@ -602,7 +602,7 @@ Returns the collider's shape index. .. rst-class:: classref-method -:ref:`Vector3` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** |const| +:ref:`Vector3` **get_contact_collider_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the linear velocity vector at the collider's contact point. @@ -614,7 +614,7 @@ Returns the linear velocity vector at the collider's contact point. .. rst-class:: classref-method -:ref:`int` **get_contact_count** **(** **)** |const| +:ref:`int` **get_contact_count**\ (\ ) |const| Returns the number of contacts this body has with other bodies. @@ -628,7 +628,7 @@ Returns the number of contacts this body has with other bodies. .. rst-class:: classref-method -:ref:`Vector3` **get_contact_impulse** **(** :ref:`int` contact_idx **)** |const| +:ref:`Vector3` **get_contact_impulse**\ (\ contact_idx\: :ref:`int`\ ) |const| Impulse created by the contact. @@ -640,7 +640,7 @@ Impulse created by the contact. .. rst-class:: classref-method -:ref:`Vector3` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** |const| +:ref:`Vector3` **get_contact_local_normal**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the local normal at the contact point. @@ -652,7 +652,7 @@ Returns the local normal at the contact point. .. rst-class:: classref-method -:ref:`Vector3` **get_contact_local_position** **(** :ref:`int` contact_idx **)** |const| +:ref:`Vector3` **get_contact_local_position**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the position of the contact point on the body in the global coordinate system. @@ -664,7 +664,7 @@ Returns the position of the contact point on the body in the global coordinate s .. rst-class:: classref-method -:ref:`int` **get_contact_local_shape** **(** :ref:`int` contact_idx **)** |const| +:ref:`int` **get_contact_local_shape**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the local shape index of the collision. @@ -676,7 +676,7 @@ Returns the local shape index of the collision. .. rst-class:: classref-method -:ref:`Vector3` **get_contact_local_velocity_at_position** **(** :ref:`int` contact_idx **)** |const| +:ref:`Vector3` **get_contact_local_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |const| Returns the linear velocity vector at the body's contact point. @@ -688,7 +688,7 @@ Returns the linear velocity vector at the body's contact point. .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState3D` **get_space_state** **(** **)** +:ref:`PhysicsDirectSpaceState3D` **get_space_state**\ (\ ) Returns the current state of the space, useful for queries. @@ -700,7 +700,7 @@ Returns the current state of the space, useful for queries. .. rst-class:: classref-method -:ref:`Vector3` **get_velocity_at_local_position** **(** :ref:`Vector3` local_position **)** |const| +:ref:`Vector3` **get_velocity_at_local_position**\ (\ local_position\: :ref:`Vector3`\ ) |const| Returns the body's velocity at the given relative position, including both translation and rotation. @@ -712,7 +712,7 @@ Returns the body's velocity at the given relative position, including both trans .. rst-class:: classref-method -void **integrate_forces** **(** **)** +|void| **integrate_forces**\ (\ ) Calls the built-in force integration code. @@ -724,7 +724,7 @@ Calls the built-in force integration code. .. rst-class:: classref-method -void **set_constant_force** **(** :ref:`Vector3` force **)** +|void| **set_constant_force**\ (\ force\: :ref:`Vector3`\ ) Sets the body's total constant positional forces applied during each physics update. @@ -738,7 +738,7 @@ See :ref:`add_constant_force` torque **)** +|void| **set_constant_torque**\ (\ torque\: :ref:`Vector3`\ ) Sets the body's total constant rotational forces applied during each physics update. @@ -751,3 +751,4 @@ See :ref:`add_constant_torque` **(** :ref:`Vector3` force **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_add_constant_force` **(** :ref:`Vector3` force, :ref:`Vector3` position **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_add_constant_torque` **(** :ref:`Vector3` torque **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_apply_central_force` **(** :ref:`Vector3` force **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_apply_central_impulse` **(** :ref:`Vector3` impulse **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_apply_force` **(** :ref:`Vector3` force, :ref:`Vector3` position **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_apply_impulse` **(** :ref:`Vector3` impulse, :ref:`Vector3` position **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_apply_torque` **(** :ref:`Vector3` torque **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_apply_torque_impulse` **(** :ref:`Vector3` impulse **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_angular_velocity` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_center_of_mass` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_center_of_mass_local` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_constant_force` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_constant_torque` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_get_contact_collider` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_contact_collider_id` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`_get_contact_collider_object` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_contact_collider_position` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_contact_collider_shape` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_contact_count` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_contact_impulse` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_contact_local_normal` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_contact_local_position` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_contact_local_shape` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_contact_local_velocity_at_position` **(** :ref:`int` contact_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_inverse_inertia` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`_get_inverse_inertia_tensor` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_inverse_mass` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_linear_velocity` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`_get_principal_inertia_axes` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectSpaceState3D` | :ref:`_get_space_state` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_step` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_total_angular_damp` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_total_gravity` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_total_linear_damp` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`_get_transform` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_velocity_at_local_position` **(** :ref:`Vector3` local_position **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_integrate_forces` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_sleeping` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_angular_velocity` **(** :ref:`Vector3` velocity **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_constant_force` **(** :ref:`Vector3` force **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_constant_torque` **(** :ref:`Vector3` torque **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_linear_velocity` **(** :ref:`Vector3` velocity **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_sleep_state` **(** :ref:`bool` enabled **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_transform` **(** :ref:`Transform3D` transform **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_add_constant_central_force`\ (\ force\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_add_constant_force`\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_add_constant_torque`\ (\ torque\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_central_force`\ (\ force\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_central_impulse`\ (\ impulse\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_force`\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_impulse`\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_torque`\ (\ torque\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_apply_torque_impulse`\ (\ impulse\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_angular_velocity`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_center_of_mass`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_center_of_mass_local`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_constant_force`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_constant_torque`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_get_contact_collider`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_contact_collider_id`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`_get_contact_collider_object`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_contact_collider_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_contact_collider_shape`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_contact_collider_velocity_at_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_contact_count`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_contact_impulse`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_contact_local_normal`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_contact_local_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_contact_local_shape`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_contact_local_velocity_at_position`\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_inverse_inertia`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`_get_inverse_inertia_tensor`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_inverse_mass`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_linear_velocity`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`_get_principal_inertia_axes`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectSpaceState3D` | :ref:`_get_space_state`\ (\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_step`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_total_angular_damp`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_total_gravity`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_total_linear_damp`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`_get_transform`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_velocity_at_local_position`\ (\ local_position\: :ref:`Vector3`\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_integrate_forces`\ (\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_sleeping`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_angular_velocity`\ (\ velocity\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_constant_force`\ (\ force\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_constant_torque`\ (\ torque\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_linear_velocity`\ (\ velocity\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_sleep_state`\ (\ enabled\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_transform`\ (\ transform\: :ref:`Transform3D`\ ) |virtual| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -138,7 +138,7 @@ Method Descriptions .. rst-class:: classref-method -void **_add_constant_central_force** **(** :ref:`Vector3` force **)** |virtual| +|void| **_add_constant_central_force**\ (\ force\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -152,7 +152,7 @@ void **_add_constant_central_force** **(** :ref:`Vector3` force * .. rst-class:: classref-method -void **_add_constant_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** |virtual| +|void| **_add_constant_force**\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -166,7 +166,7 @@ void **_add_constant_force** **(** :ref:`Vector3` force, :ref:`Ve .. rst-class:: classref-method -void **_add_constant_torque** **(** :ref:`Vector3` torque **)** |virtual| +|void| **_add_constant_torque**\ (\ torque\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -180,7 +180,7 @@ void **_add_constant_torque** **(** :ref:`Vector3` torque **)** | .. rst-class:: classref-method -void **_apply_central_force** **(** :ref:`Vector3` force **)** |virtual| +|void| **_apply_central_force**\ (\ force\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -194,7 +194,7 @@ void **_apply_central_force** **(** :ref:`Vector3` force **)** |v .. rst-class:: classref-method -void **_apply_central_impulse** **(** :ref:`Vector3` impulse **)** |virtual| +|void| **_apply_central_impulse**\ (\ impulse\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -208,7 +208,7 @@ void **_apply_central_impulse** **(** :ref:`Vector3` impulse **)* .. rst-class:: classref-method -void **_apply_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** |virtual| +|void| **_apply_force**\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -222,7 +222,7 @@ void **_apply_force** **(** :ref:`Vector3` force, :ref:`Vector3` impulse, :ref:`Vector3` position **)** |virtual| +|void| **_apply_impulse**\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -236,7 +236,7 @@ void **_apply_impulse** **(** :ref:`Vector3` impulse, :ref:`Vecto .. rst-class:: classref-method -void **_apply_torque** **(** :ref:`Vector3` torque **)** |virtual| +|void| **_apply_torque**\ (\ torque\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -250,7 +250,7 @@ void **_apply_torque** **(** :ref:`Vector3` torque **)** |virtual .. rst-class:: classref-method -void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** |virtual| +|void| **_apply_torque_impulse**\ (\ impulse\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -264,7 +264,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Vector3` **_get_angular_velocity** **(** **)** |virtual| |const| +:ref:`Vector3` **_get_angular_velocity**\ (\ ) |virtual| |const| .. container:: contribute @@ -278,7 +278,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Vector3` **_get_center_of_mass** **(** **)** |virtual| |const| +:ref:`Vector3` **_get_center_of_mass**\ (\ ) |virtual| |const| .. container:: contribute @@ -292,7 +292,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Vector3` **_get_center_of_mass_local** **(** **)** |virtual| |const| +:ref:`Vector3` **_get_center_of_mass_local**\ (\ ) |virtual| |const| .. container:: contribute @@ -306,7 +306,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Vector3` **_get_constant_force** **(** **)** |virtual| |const| +:ref:`Vector3` **_get_constant_force**\ (\ ) |virtual| |const| .. container:: contribute @@ -320,7 +320,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Vector3` **_get_constant_torque** **(** **)** |virtual| |const| +:ref:`Vector3` **_get_constant_torque**\ (\ ) |virtual| |const| .. container:: contribute @@ -334,7 +334,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`RID` **_get_contact_collider** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`RID` **_get_contact_collider**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -348,7 +348,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`int` **_get_contact_collider_id** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`int` **_get_contact_collider_id**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -362,7 +362,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Object` **_get_contact_collider_object** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`Object` **_get_contact_collider_object**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -376,7 +376,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Vector3` **_get_contact_collider_position** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`Vector3` **_get_contact_collider_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -390,7 +390,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`int` **_get_contact_collider_shape** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`int` **_get_contact_collider_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -404,7 +404,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Vector3` **_get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`Vector3` **_get_contact_collider_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -418,7 +418,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`int` **_get_contact_count** **(** **)** |virtual| |const| +:ref:`int` **_get_contact_count**\ (\ ) |virtual| |const| .. container:: contribute @@ -432,7 +432,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Vector3` **_get_contact_impulse** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`Vector3` **_get_contact_impulse**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -446,7 +446,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Vector3` **_get_contact_local_normal** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`Vector3` **_get_contact_local_normal**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -460,7 +460,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Vector3` **_get_contact_local_position** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`Vector3` **_get_contact_local_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -474,7 +474,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`int` **_get_contact_local_shape** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`int` **_get_contact_local_shape**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -488,7 +488,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Vector3` **_get_contact_local_velocity_at_position** **(** :ref:`int` contact_idx **)** |virtual| |const| +:ref:`Vector3` **_get_contact_local_velocity_at_position**\ (\ contact_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -502,7 +502,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Vector3` **_get_inverse_inertia** **(** **)** |virtual| |const| +:ref:`Vector3` **_get_inverse_inertia**\ (\ ) |virtual| |const| .. container:: contribute @@ -516,7 +516,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Basis` **_get_inverse_inertia_tensor** **(** **)** |virtual| |const| +:ref:`Basis` **_get_inverse_inertia_tensor**\ (\ ) |virtual| |const| .. container:: contribute @@ -530,7 +530,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`float` **_get_inverse_mass** **(** **)** |virtual| |const| +:ref:`float` **_get_inverse_mass**\ (\ ) |virtual| |const| .. container:: contribute @@ -544,7 +544,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Vector3` **_get_linear_velocity** **(** **)** |virtual| |const| +:ref:`Vector3` **_get_linear_velocity**\ (\ ) |virtual| |const| .. container:: contribute @@ -558,7 +558,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Basis` **_get_principal_inertia_axes** **(** **)** |virtual| |const| +:ref:`Basis` **_get_principal_inertia_axes**\ (\ ) |virtual| |const| .. container:: contribute @@ -572,7 +572,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState3D` **_get_space_state** **(** **)** |virtual| +:ref:`PhysicsDirectSpaceState3D` **_get_space_state**\ (\ ) |virtual| .. container:: contribute @@ -586,7 +586,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`float` **_get_step** **(** **)** |virtual| |const| +:ref:`float` **_get_step**\ (\ ) |virtual| |const| .. container:: contribute @@ -600,7 +600,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`float` **_get_total_angular_damp** **(** **)** |virtual| |const| +:ref:`float` **_get_total_angular_damp**\ (\ ) |virtual| |const| .. container:: contribute @@ -614,7 +614,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Vector3` **_get_total_gravity** **(** **)** |virtual| |const| +:ref:`Vector3` **_get_total_gravity**\ (\ ) |virtual| |const| .. container:: contribute @@ -628,7 +628,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`float` **_get_total_linear_damp** **(** **)** |virtual| |const| +:ref:`float` **_get_total_linear_damp**\ (\ ) |virtual| |const| .. container:: contribute @@ -642,7 +642,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Transform3D` **_get_transform** **(** **)** |virtual| |const| +:ref:`Transform3D` **_get_transform**\ (\ ) |virtual| |const| .. container:: contribute @@ -656,7 +656,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -:ref:`Vector3` **_get_velocity_at_local_position** **(** :ref:`Vector3` local_position **)** |virtual| |const| +:ref:`Vector3` **_get_velocity_at_local_position**\ (\ local_position\: :ref:`Vector3`\ ) |virtual| |const| .. container:: contribute @@ -670,7 +670,7 @@ void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** .. rst-class:: classref-method -void **_integrate_forces** **(** **)** |virtual| +|void| **_integrate_forces**\ (\ ) |virtual| .. container:: contribute @@ -684,7 +684,7 @@ void **_integrate_forces** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_is_sleeping** **(** **)** |virtual| |const| +:ref:`bool` **_is_sleeping**\ (\ ) |virtual| |const| .. container:: contribute @@ -698,7 +698,7 @@ void **_integrate_forces** **(** **)** |virtual| .. rst-class:: classref-method -void **_set_angular_velocity** **(** :ref:`Vector3` velocity **)** |virtual| +|void| **_set_angular_velocity**\ (\ velocity\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -712,7 +712,7 @@ void **_set_angular_velocity** **(** :ref:`Vector3` velocity **)* .. rst-class:: classref-method -void **_set_constant_force** **(** :ref:`Vector3` force **)** |virtual| +|void| **_set_constant_force**\ (\ force\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -726,7 +726,7 @@ void **_set_constant_force** **(** :ref:`Vector3` force **)** |vi .. rst-class:: classref-method -void **_set_constant_torque** **(** :ref:`Vector3` torque **)** |virtual| +|void| **_set_constant_torque**\ (\ torque\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -740,7 +740,7 @@ void **_set_constant_torque** **(** :ref:`Vector3` torque **)** | .. rst-class:: classref-method -void **_set_linear_velocity** **(** :ref:`Vector3` velocity **)** |virtual| +|void| **_set_linear_velocity**\ (\ velocity\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -754,7 +754,7 @@ void **_set_linear_velocity** **(** :ref:`Vector3` velocity **)** .. rst-class:: classref-method -void **_set_sleep_state** **(** :ref:`bool` enabled **)** |virtual| +|void| **_set_sleep_state**\ (\ enabled\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -768,7 +768,7 @@ void **_set_sleep_state** **(** :ref:`bool` enabled **)** |virtual| .. rst-class:: classref-method -void **_set_transform** **(** :ref:`Transform3D` transform **)** |virtual| +|void| **_set_transform**\ (\ transform\: :ref:`Transform3D`\ ) |virtual| .. container:: contribute @@ -781,3 +781,4 @@ void **_set_transform** **(** :ref:`Transform3D` transform ** .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsdirectspacestate2d.rst b/classes/class_physicsdirectspacestate2d.rst index 25f7b87d0b7..408315066b6 100644 --- a/classes/class_physicsdirectspacestate2d.rst +++ b/classes/class_physicsdirectspacestate2d.rst @@ -40,19 +40,19 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters2D` parameters **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2[]` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters2D` parameters, :ref:`int` max_results=32 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters2D` parameters **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`intersect_point` **(** :ref:`PhysicsPointQueryParameters2D` parameters, :ref:`int` max_results=32 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`PhysicsRayQueryParameters2D` parameters **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters2D` parameters, :ref:`int` max_results=32 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`cast_motion`\ (\ parameters\: :ref:`PhysicsShapeQueryParameters2D`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2`\] | :ref:`collide_shape`\ (\ parameters\: :ref:`PhysicsShapeQueryParameters2D`, max_results\: :ref:`int` = 32\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_rest_info`\ (\ parameters\: :ref:`PhysicsShapeQueryParameters2D`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`intersect_point`\ (\ parameters\: :ref:`PhysicsPointQueryParameters2D`, max_results\: :ref:`int` = 32\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`intersect_ray`\ (\ parameters\: :ref:`PhysicsRayQueryParameters2D`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`intersect_shape`\ (\ parameters\: :ref:`PhysicsShapeQueryParameters2D`, max_results\: :ref:`int` = 32\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -67,7 +67,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedFloat32Array` **cast_motion** **(** :ref:`PhysicsShapeQueryParameters2D` parameters **)** +:ref:`PackedFloat32Array` **cast_motion**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters2D`\ ) Checks how far a :ref:`Shape2D` can move without colliding. All the parameters for the query, including the shape and the motion, are supplied through a :ref:`PhysicsShapeQueryParameters2D` object. @@ -83,7 +83,7 @@ Returns an array with the safe and unsafe proportions (between 0 and 1) of the m .. rst-class:: classref-method -:ref:`Vector2[]` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters2D` parameters, :ref:`int` max_results=32 **)** +:ref:`Array`\[:ref:`Vector2`\] **collide_shape**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters2D`, max_results\: :ref:`int` = 32\ ) Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters2D` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape`, the number of returned results can be limited to save processing time. @@ -97,7 +97,7 @@ Returned points are a list of pairs of contact points. For each pair the first o .. rst-class:: classref-method -:ref:`Dictionary` **get_rest_info** **(** :ref:`PhysicsShapeQueryParameters2D` parameters **)** +:ref:`Dictionary` **get_rest_info**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters2D`\ ) Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters2D` object, against the space. If it collides with more than one shape, the nearest one is selected. If the shape did not intersect anything, then an empty dictionary is returned instead. @@ -123,7 +123,7 @@ Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryPara .. rst-class:: classref-method -:ref:`Dictionary[]` **intersect_point** **(** :ref:`PhysicsPointQueryParameters2D` parameters, :ref:`int` max_results=32 **)** +:ref:`Array`\[:ref:`Dictionary`\] **intersect_point**\ (\ parameters\: :ref:`PhysicsPointQueryParameters2D`, max_results\: :ref:`int` = 32\ ) Checks whether a point is inside any solid shape. Position and other parameters are defined through :ref:`PhysicsPointQueryParameters2D`. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: @@ -147,7 +147,7 @@ The number of intersections can be limited with the ``max_results`` parameter, t .. rst-class:: classref-method -:ref:`Dictionary` **intersect_ray** **(** :ref:`PhysicsRayQueryParameters2D` parameters **)** +:ref:`Dictionary` **intersect_ray**\ (\ parameters\: :ref:`PhysicsRayQueryParameters2D`\ ) Intersects a ray in a given space. Ray position and other parameters are defined through :ref:`PhysicsRayQueryParameters2D`. The returned object is a dictionary with the following fields: @@ -173,7 +173,7 @@ If the ray did not intersect anything, then an empty dictionary is returned inst .. rst-class:: classref-method -:ref:`Dictionary[]` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters2D` parameters, :ref:`int` max_results=32 **)** +:ref:`Array`\[:ref:`Dictionary`\] **intersect_shape**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters2D`, max_results\: :ref:`int` = 32\ ) Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters2D` object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: @@ -194,3 +194,4 @@ The number of intersections can be limited with the ``max_results`` parameter, t .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsdirectspacestate2dextension.rst b/classes/class_physicsdirectspacestate2dextension.rst index 6f97168f7c6..4a42684ced4 100644 --- a/classes/class_physicsdirectspacestate2dextension.rst +++ b/classes/class_physicsdirectspacestate2dextension.rst @@ -31,21 +31,21 @@ Methods .. table:: :widths: auto - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_cast_motion` **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, float* closest_safe, float* closest_unsafe **)** |virtual| | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_collide_shape` **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, void* results, :ref:`int` max_results, int32_t* result_count **)** |virtual| | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_intersect_point` **(** :ref:`Vector2` position, :ref:`int` canvas_instance_id, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer2DExtensionShapeResult* results, :ref:`int` max_results **)** |virtual| | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_intersect_ray` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, :ref:`bool` hit_from_inside, PhysicsServer2DExtensionRayResult* result **)** |virtual| | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_intersect_shape` **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer2DExtensionShapeResult* result, :ref:`int` max_results **)** |virtual| | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_rest_info` **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer2DExtensionShapeRestInfo* rest_info **)** |virtual| | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_body_excluded_from_query` **(** :ref:`RID` body **)** |const| | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_cast_motion`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, closest_safe\: ``float*``, closest_unsafe\: ``float*``\ ) |virtual| | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_collide_shape`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``void*``, max_results\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_intersect_point`\ (\ position\: :ref:`Vector2`, canvas_instance_id\: :ref:`int`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_intersect_ray`\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, hit_from_inside\: :ref:`bool`, result\: ``PhysicsServer2DExtensionRayResult*``\ ) |virtual| | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_intersect_shape`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, result\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_rest_info`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, rest_info\: ``PhysicsServer2DExtensionShapeRestInfo*``\ ) |virtual| | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_body_excluded_from_query`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -60,7 +60,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_cast_motion** **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, float* closest_safe, float* closest_unsafe **)** |virtual| +:ref:`bool` **_cast_motion**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, closest_safe\: ``float*``, closest_unsafe\: ``float*``\ ) |virtual| .. container:: contribute @@ -74,7 +74,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_collide_shape** **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, void* results, :ref:`int` max_results, int32_t* result_count **)** |virtual| +:ref:`bool` **_collide_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``void*``, max_results\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| .. container:: contribute @@ -88,7 +88,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_intersect_point** **(** :ref:`Vector2` position, :ref:`int` canvas_instance_id, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer2DExtensionShapeResult* results, :ref:`int` max_results **)** |virtual| +:ref:`int` **_intersect_point**\ (\ position\: :ref:`Vector2`, canvas_instance_id\: :ref:`int`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -102,7 +102,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_intersect_ray** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, :ref:`bool` hit_from_inside, PhysicsServer2DExtensionRayResult* result **)** |virtual| +:ref:`bool` **_intersect_ray**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, hit_from_inside\: :ref:`bool`, result\: ``PhysicsServer2DExtensionRayResult*``\ ) |virtual| .. container:: contribute @@ -116,7 +116,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_intersect_shape** **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer2DExtensionShapeResult* result, :ref:`int` max_results **)** |virtual| +:ref:`int` **_intersect_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, result\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -130,7 +130,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_rest_info** **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer2DExtensionShapeRestInfo* rest_info **)** |virtual| +:ref:`bool` **_rest_info**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, rest_info\: ``PhysicsServer2DExtensionShapeRestInfo*``\ ) |virtual| .. container:: contribute @@ -144,7 +144,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_body_excluded_from_query** **(** :ref:`RID` body **)** |const| +:ref:`bool` **is_body_excluded_from_query**\ (\ body\: :ref:`RID`\ ) |const| .. container:: contribute @@ -157,3 +157,4 @@ Method Descriptions .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsdirectspacestate3d.rst b/classes/class_physicsdirectspacestate3d.rst index 6bf2c855e8d..6423345582a 100644 --- a/classes/class_physicsdirectspacestate3d.rst +++ b/classes/class_physicsdirectspacestate3d.rst @@ -40,19 +40,19 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters3D` parameters **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3[]` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters3D` parameters, :ref:`int` max_results=32 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters3D` parameters **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`intersect_point` **(** :ref:`PhysicsPointQueryParameters3D` parameters, :ref:`int` max_results=32 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`PhysicsRayQueryParameters3D` parameters **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters3D` parameters, :ref:`int` max_results=32 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`cast_motion`\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector3`\] | :ref:`collide_shape`\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`, max_results\: :ref:`int` = 32\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_rest_info`\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`intersect_point`\ (\ parameters\: :ref:`PhysicsPointQueryParameters3D`, max_results\: :ref:`int` = 32\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`intersect_ray`\ (\ parameters\: :ref:`PhysicsRayQueryParameters3D`\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`intersect_shape`\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`, max_results\: :ref:`int` = 32\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -67,7 +67,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedFloat32Array` **cast_motion** **(** :ref:`PhysicsShapeQueryParameters3D` parameters **)** +:ref:`PackedFloat32Array` **cast_motion**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`\ ) Checks how far a :ref:`Shape3D` can move without colliding. All the parameters for the query, including the shape, are supplied through a :ref:`PhysicsShapeQueryParameters3D` object. @@ -83,7 +83,7 @@ Returns an array with the safe and unsafe proportions (between 0 and 1) of the m .. rst-class:: classref-method -:ref:`Vector3[]` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters3D` parameters, :ref:`int` max_results=32 **)** +:ref:`Array`\[:ref:`Vector3`\] **collide_shape**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`, max_results\: :ref:`int` = 32\ ) Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters3D` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape`, the number of returned results can be limited to save processing time. @@ -99,7 +99,7 @@ Returned points are a list of pairs of contact points. For each pair the first o .. rst-class:: classref-method -:ref:`Dictionary` **get_rest_info** **(** :ref:`PhysicsShapeQueryParameters3D` parameters **)** +:ref:`Dictionary` **get_rest_info**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`\ ) Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters3D` object, against the space. If it collides with more than one shape, the nearest one is selected. The returned object is a dictionary containing the following fields: @@ -127,7 +127,7 @@ If the shape did not intersect anything, then an empty dictionary is returned in .. rst-class:: classref-method -:ref:`Dictionary[]` **intersect_point** **(** :ref:`PhysicsPointQueryParameters3D` parameters, :ref:`int` max_results=32 **)** +:ref:`Array`\[:ref:`Dictionary`\] **intersect_point**\ (\ parameters\: :ref:`PhysicsPointQueryParameters3D`, max_results\: :ref:`int` = 32\ ) Checks whether a point is inside any solid shape. Position and other parameters are defined through :ref:`PhysicsPointQueryParameters3D`. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: @@ -149,7 +149,7 @@ The number of intersections can be limited with the ``max_results`` parameter, t .. rst-class:: classref-method -:ref:`Dictionary` **intersect_ray** **(** :ref:`PhysicsRayQueryParameters3D` parameters **)** +:ref:`Dictionary` **intersect_ray**\ (\ parameters\: :ref:`PhysicsRayQueryParameters3D`\ ) Intersects a ray in a given space. Ray position and other parameters are defined through :ref:`PhysicsRayQueryParameters3D`. The returned object is a dictionary with the following fields: @@ -179,7 +179,7 @@ If the ray did not intersect anything, then an empty dictionary is returned inst .. rst-class:: classref-method -:ref:`Dictionary[]` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters3D` parameters, :ref:`int` max_results=32 **)** +:ref:`Array`\[:ref:`Dictionary`\] **intersect_shape**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`, max_results\: :ref:`int` = 32\ ) Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters3D` object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: @@ -202,3 +202,4 @@ The number of intersections can be limited with the ``max_results`` parameter, t .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsdirectspacestate3dextension.rst b/classes/class_physicsdirectspacestate3dextension.rst index ca1db845721..59bc58aaccd 100644 --- a/classes/class_physicsdirectspacestate3dextension.rst +++ b/classes/class_physicsdirectspacestate3dextension.rst @@ -31,23 +31,23 @@ Methods .. table:: :widths: auto - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_cast_motion` **(** :ref:`RID` shape_rid, :ref:`Transform3D` transform, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, float* closest_safe, float* closest_unsafe, PhysicsServer3DExtensionShapeRestInfo* info **)** |virtual| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_collide_shape` **(** :ref:`RID` shape_rid, :ref:`Transform3D` transform, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, void* results, :ref:`int` max_results, int32_t* result_count **)** |virtual| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_get_closest_point_to_object_volume` **(** :ref:`RID` object, :ref:`Vector3` point **)** |virtual| |const| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_intersect_point` **(** :ref:`Vector3` position, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer3DExtensionShapeResult* results, :ref:`int` max_results **)** |virtual| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_intersect_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, :ref:`bool` hit_from_inside, :ref:`bool` hit_back_faces, :ref:`bool` pick_ray, PhysicsServer3DExtensionRayResult* result **)** |virtual| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_intersect_shape` **(** :ref:`RID` shape_rid, :ref:`Transform3D` transform, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer3DExtensionShapeResult* result_count, :ref:`int` max_results **)** |virtual| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_rest_info` **(** :ref:`RID` shape_rid, :ref:`Transform3D` transform, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer3DExtensionShapeRestInfo* rest_info **)** |virtual| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_body_excluded_from_query` **(** :ref:`RID` body **)** |const| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_cast_motion`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, closest_safe\: ``float*``, closest_unsafe\: ``float*``, info\: ``PhysicsServer3DExtensionShapeRestInfo*``\ ) |virtual| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_collide_shape`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``void*``, max_results\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_closest_point_to_object_volume`\ (\ object\: :ref:`RID`, point\: :ref:`Vector3`\ ) |virtual| |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_intersect_point`\ (\ position\: :ref:`Vector3`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``PhysicsServer3DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_intersect_ray`\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, hit_from_inside\: :ref:`bool`, hit_back_faces\: :ref:`bool`, pick_ray\: :ref:`bool`, result\: ``PhysicsServer3DExtensionRayResult*``\ ) |virtual| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_intersect_shape`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, result_count\: ``PhysicsServer3DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_rest_info`\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, rest_info\: ``PhysicsServer3DExtensionShapeRestInfo*``\ ) |virtual| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_body_excluded_from_query`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -62,7 +62,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_cast_motion** **(** :ref:`RID` shape_rid, :ref:`Transform3D` transform, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, float* closest_safe, float* closest_unsafe, PhysicsServer3DExtensionShapeRestInfo* info **)** |virtual| +:ref:`bool` **_cast_motion**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, closest_safe\: ``float*``, closest_unsafe\: ``float*``, info\: ``PhysicsServer3DExtensionShapeRestInfo*``\ ) |virtual| .. container:: contribute @@ -76,7 +76,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_collide_shape** **(** :ref:`RID` shape_rid, :ref:`Transform3D` transform, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, void* results, :ref:`int` max_results, int32_t* result_count **)** |virtual| +:ref:`bool` **_collide_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``void*``, max_results\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| .. container:: contribute @@ -90,7 +90,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **_get_closest_point_to_object_volume** **(** :ref:`RID` object, :ref:`Vector3` point **)** |virtual| |const| +:ref:`Vector3` **_get_closest_point_to_object_volume**\ (\ object\: :ref:`RID`, point\: :ref:`Vector3`\ ) |virtual| |const| .. container:: contribute @@ -104,7 +104,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_intersect_point** **(** :ref:`Vector3` position, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer3DExtensionShapeResult* results, :ref:`int` max_results **)** |virtual| +:ref:`int` **_intersect_point**\ (\ position\: :ref:`Vector3`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, results\: ``PhysicsServer3DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -118,7 +118,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, :ref:`bool` hit_from_inside, :ref:`bool` hit_back_faces, :ref:`bool` pick_ray, PhysicsServer3DExtensionRayResult* result **)** |virtual| +:ref:`bool` **_intersect_ray**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, hit_from_inside\: :ref:`bool`, hit_back_faces\: :ref:`bool`, pick_ray\: :ref:`bool`, result\: ``PhysicsServer3DExtensionRayResult*``\ ) |virtual| .. container:: contribute @@ -132,7 +132,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_intersect_shape** **(** :ref:`RID` shape_rid, :ref:`Transform3D` transform, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer3DExtensionShapeResult* result_count, :ref:`int` max_results **)** |virtual| +:ref:`int` **_intersect_shape**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, result_count\: ``PhysicsServer3DExtensionShapeResult*``, max_results\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -146,7 +146,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_rest_info** **(** :ref:`RID` shape_rid, :ref:`Transform3D` transform, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer3DExtensionShapeRestInfo* rest_info **)** |virtual| +:ref:`bool` **_rest_info**\ (\ shape_rid\: :ref:`RID`, transform\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, collision_mask\: :ref:`int`, collide_with_bodies\: :ref:`bool`, collide_with_areas\: :ref:`bool`, rest_info\: ``PhysicsServer3DExtensionShapeRestInfo*``\ ) |virtual| .. container:: contribute @@ -160,7 +160,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_body_excluded_from_query** **(** :ref:`RID` body **)** |const| +:ref:`bool` **is_body_excluded_from_query**\ (\ body\: :ref:`RID`\ ) |const| .. container:: contribute @@ -173,3 +173,4 @@ Method Descriptions .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsmaterial.rst b/classes/class_physicsmaterial.rst index 9a13ede9df4..742d55d2dc6 100644 --- a/classes/class_physicsmaterial.rst +++ b/classes/class_physicsmaterial.rst @@ -56,8 +56,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_absorbent** **(** :ref:`bool` value **)** -- :ref:`bool` **is_absorbent** **(** **)** +- |void| **set_absorbent**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_absorbent**\ (\ ) If ``true``, subtracts the bounciness from the colliding object's bounciness instead of adding it. @@ -73,8 +73,8 @@ If ``true``, subtracts the bounciness from the colliding object's bounciness ins .. rst-class:: classref-property-setget -- void **set_bounce** **(** :ref:`float` value **)** -- :ref:`float` **get_bounce** **(** **)** +- |void| **set_bounce**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_bounce**\ (\ ) The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). @@ -90,8 +90,8 @@ The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounci .. rst-class:: classref-property-setget -- void **set_friction** **(** :ref:`float` value **)** -- :ref:`float` **get_friction** **(** **)** +- |void| **set_friction**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_friction**\ (\ ) The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). @@ -107,8 +107,8 @@ The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum fr .. rst-class:: classref-property-setget -- void **set_rough** **(** :ref:`bool` value **)** -- :ref:`bool` **is_rough** **(** **)** +- |void| **set_rough**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_rough**\ (\ ) If ``true``, the physics engine will use the friction of the object marked as "rough" when two objects collide. If ``false``, the physics engine will use the lowest friction of all colliding objects instead. If ``true`` for both colliding objects, the physics engine will use the highest friction. @@ -119,3 +119,4 @@ If ``true``, the physics engine will use the friction of the object marked as "r .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicspointqueryparameters2d.rst b/classes/class_physicspointqueryparameters2d.rst index c3376a8bf0b..219ee10bc72 100644 --- a/classes/class_physicspointqueryparameters2d.rst +++ b/classes/class_physicspointqueryparameters2d.rst @@ -29,19 +29,19 @@ Properties .. table:: :widths: auto - +-------------------------------+----------------------------------------------------------------------------------------------+-------------------+ - | :ref:`int` | :ref:`canvas_instance_id` | ``0`` | - +-------------------------------+----------------------------------------------------------------------------------------------+-------------------+ - | :ref:`bool` | :ref:`collide_with_areas` | ``false`` | - +-------------------------------+----------------------------------------------------------------------------------------------+-------------------+ - | :ref:`bool` | :ref:`collide_with_bodies` | ``true`` | - +-------------------------------+----------------------------------------------------------------------------------------------+-------------------+ - | :ref:`int` | :ref:`collision_mask` | ``4294967295`` | - +-------------------------------+----------------------------------------------------------------------------------------------+-------------------+ - | :ref:`RID[]` | :ref:`exclude` | ``[]`` | - +-------------------------------+----------------------------------------------------------------------------------------------+-------------------+ - | :ref:`Vector2` | :ref:`position` | ``Vector2(0, 0)`` | - +-------------------------------+----------------------------------------------------------------------------------------------+-------------------+ + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ + | :ref:`int` | :ref:`canvas_instance_id` | ``0`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ + | :ref:`bool` | :ref:`collide_with_areas` | ``false`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ + | :ref:`bool` | :ref:`collide_with_bodies` | ``true`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ + | :ref:`int` | :ref:`collision_mask` | ``4294967295`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`exclude` | ``[]`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ + | :ref:`Vector2` | :ref:`position` | ``Vector2(0, 0)`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ .. rst-class:: classref-section-separator @@ -60,8 +60,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_canvas_instance_id** **(** :ref:`int` value **)** -- :ref:`int` **get_canvas_instance_id** **(** **)** +- |void| **set_canvas_instance_id**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_canvas_instance_id**\ (\ ) If different from ``0``, restricts the query to a specific canvas layer specified by its instance ID. See :ref:`Object.get_instance_id`. @@ -79,8 +79,8 @@ If ``0``, restricts the query to the Viewport's default canvas layer. .. rst-class:: classref-property-setget -- void **set_collide_with_areas** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_areas_enabled** **(** **)** +- |void| **set_collide_with_areas**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_areas_enabled**\ (\ ) If ``true``, the query will take :ref:`Area2D`\ s into account. @@ -96,8 +96,8 @@ If ``true``, the query will take :ref:`Area2D`\ s into account. .. rst-class:: classref-property-setget -- void **set_collide_with_bodies** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_bodies_enabled** **(** **)** +- |void| **set_collide_with_bodies**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_bodies_enabled**\ (\ ) If ``true``, the query will take :ref:`PhysicsBody2D`\ s into account. @@ -113,8 +113,8 @@ If ``true``, the query will take :ref:`PhysicsBody2D`\ s in .. rst-class:: classref-property-setget -- void **set_collision_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_mask** **(** **)** +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information. @@ -126,12 +126,12 @@ The physics layers the query will detect (as a bitmask). By default, all collisi .. rst-class:: classref-property -:ref:`RID[]` **exclude** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **exclude** = ``[]`` .. rst-class:: classref-property-setget -- void **set_exclude** **(** :ref:`RID[]` value **)** -- :ref:`RID[]` **get_exclude** **(** **)** +- |void| **set_exclude**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) +- :ref:`Array`\[:ref:`RID`\] **get_exclude**\ (\ ) The list of object :ref:`RID`\ s that will be excluded from collisions. Use :ref:`CollisionObject2D.get_rid` to get the :ref:`RID` associated with a :ref:`CollisionObject2D`-derived node. @@ -147,8 +147,8 @@ The list of object :ref:`RID`\ s that will be excluded from collision .. rst-class:: classref-property-setget -- void **set_position** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_position** **(** **)** +- |void| **set_position**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_position**\ (\ ) The position being queried for, in global coordinates. @@ -159,3 +159,4 @@ The position being queried for, in global coordinates. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicspointqueryparameters3d.rst b/classes/class_physicspointqueryparameters3d.rst index 13aa056a93b..85345983199 100644 --- a/classes/class_physicspointqueryparameters3d.rst +++ b/classes/class_physicspointqueryparameters3d.rst @@ -29,17 +29,17 @@ Properties .. table:: :widths: auto - +-------------------------------+----------------------------------------------------------------------------------------------+----------------------+ - | :ref:`bool` | :ref:`collide_with_areas` | ``false`` | - +-------------------------------+----------------------------------------------------------------------------------------------+----------------------+ - | :ref:`bool` | :ref:`collide_with_bodies` | ``true`` | - +-------------------------------+----------------------------------------------------------------------------------------------+----------------------+ - | :ref:`int` | :ref:`collision_mask` | ``4294967295`` | - +-------------------------------+----------------------------------------------------------------------------------------------+----------------------+ - | :ref:`RID[]` | :ref:`exclude` | ``[]`` | - +-------------------------------+----------------------------------------------------------------------------------------------+----------------------+ - | :ref:`Vector3` | :ref:`position` | ``Vector3(0, 0, 0)`` | - +-------------------------------+----------------------------------------------------------------------------------------------+----------------------+ + +----------------------------------------------------+----------------------------------------------------------------------------------------------+----------------------+ + | :ref:`bool` | :ref:`collide_with_areas` | ``false`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+----------------------+ + | :ref:`bool` | :ref:`collide_with_bodies` | ``true`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+----------------------+ + | :ref:`int` | :ref:`collision_mask` | ``4294967295`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+----------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`exclude` | ``[]`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+----------------------+ + | :ref:`Vector3` | :ref:`position` | ``Vector3(0, 0, 0)`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+----------------------+ .. rst-class:: classref-section-separator @@ -58,8 +58,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_collide_with_areas** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_areas_enabled** **(** **)** +- |void| **set_collide_with_areas**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_areas_enabled**\ (\ ) If ``true``, the query will take :ref:`Area3D`\ s into account. @@ -75,8 +75,8 @@ If ``true``, the query will take :ref:`Area3D`\ s into account. .. rst-class:: classref-property-setget -- void **set_collide_with_bodies** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_bodies_enabled** **(** **)** +- |void| **set_collide_with_bodies**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_bodies_enabled**\ (\ ) If ``true``, the query will take :ref:`PhysicsBody3D`\ s into account. @@ -92,8 +92,8 @@ If ``true``, the query will take :ref:`PhysicsBody3D`\ s in .. rst-class:: classref-property-setget -- void **set_collision_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_mask** **(** **)** +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information. @@ -105,12 +105,12 @@ The physics layers the query will detect (as a bitmask). By default, all collisi .. rst-class:: classref-property -:ref:`RID[]` **exclude** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **exclude** = ``[]`` .. rst-class:: classref-property-setget -- void **set_exclude** **(** :ref:`RID[]` value **)** -- :ref:`RID[]` **get_exclude** **(** **)** +- |void| **set_exclude**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) +- :ref:`Array`\[:ref:`RID`\] **get_exclude**\ (\ ) The list of object :ref:`RID`\ s that will be excluded from collisions. Use :ref:`CollisionObject3D.get_rid` to get the :ref:`RID` associated with a :ref:`CollisionObject3D`-derived node. @@ -126,8 +126,8 @@ The list of object :ref:`RID`\ s that will be excluded from collision .. rst-class:: classref-property-setget -- void **set_position** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_position** **(** **)** +- |void| **set_position**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_position**\ (\ ) The position being queried for, in global coordinates. @@ -138,3 +138,4 @@ The position being queried for, in global coordinates. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsrayqueryparameters2d.rst b/classes/class_physicsrayqueryparameters2d.rst index 25bcc0d6a7f..83a6f22772d 100644 --- a/classes/class_physicsrayqueryparameters2d.rst +++ b/classes/class_physicsrayqueryparameters2d.rst @@ -29,21 +29,21 @@ Properties .. table:: :widths: auto - +-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ - | :ref:`bool` | :ref:`collide_with_areas` | ``false`` | - +-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ - | :ref:`bool` | :ref:`collide_with_bodies` | ``true`` | - +-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ - | :ref:`int` | :ref:`collision_mask` | ``4294967295`` | - +-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ - | :ref:`RID[]` | :ref:`exclude` | ``[]`` | - +-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ - | :ref:`Vector2` | :ref:`from` | ``Vector2(0, 0)`` | - +-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ - | :ref:`bool` | :ref:`hit_from_inside` | ``false`` | - +-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ - | :ref:`Vector2` | :ref:`to` | ``Vector2(0, 0)`` | - +-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ + +----------------------------------------------------+--------------------------------------------------------------------------------------------+-------------------+ + | :ref:`bool` | :ref:`collide_with_areas` | ``false`` | + +----------------------------------------------------+--------------------------------------------------------------------------------------------+-------------------+ + | :ref:`bool` | :ref:`collide_with_bodies` | ``true`` | + +----------------------------------------------------+--------------------------------------------------------------------------------------------+-------------------+ + | :ref:`int` | :ref:`collision_mask` | ``4294967295`` | + +----------------------------------------------------+--------------------------------------------------------------------------------------------+-------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`exclude` | ``[]`` | + +----------------------------------------------------+--------------------------------------------------------------------------------------------+-------------------+ + | :ref:`Vector2` | :ref:`from` | ``Vector2(0, 0)`` | + +----------------------------------------------------+--------------------------------------------------------------------------------------------+-------------------+ + | :ref:`bool` | :ref:`hit_from_inside` | ``false`` | + +----------------------------------------------------+--------------------------------------------------------------------------------------------+-------------------+ + | :ref:`Vector2` | :ref:`to` | ``Vector2(0, 0)`` | + +----------------------------------------------------+--------------------------------------------------------------------------------------------+-------------------+ .. rst-class:: classref-reftable-group @@ -53,9 +53,9 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsRayQueryParameters2D` | :ref:`create` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`int` collision_mask=4294967295, :ref:`RID[]` exclude=[] **)** |static| | - +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsRayQueryParameters2D` | :ref:`create`\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, collision_mask\: :ref:`int` = 4294967295, exclude\: :ref:`Array`\[:ref:`RID`\] = []\ ) |static| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -74,8 +74,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_collide_with_areas** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_areas_enabled** **(** **)** +- |void| **set_collide_with_areas**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_areas_enabled**\ (\ ) If ``true``, the query will take :ref:`Area2D`\ s into account. @@ -91,8 +91,8 @@ If ``true``, the query will take :ref:`Area2D`\ s into account. .. rst-class:: classref-property-setget -- void **set_collide_with_bodies** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_bodies_enabled** **(** **)** +- |void| **set_collide_with_bodies**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_bodies_enabled**\ (\ ) If ``true``, the query will take :ref:`PhysicsBody2D`\ s into account. @@ -108,8 +108,8 @@ If ``true``, the query will take :ref:`PhysicsBody2D`\ s in .. rst-class:: classref-property-setget -- void **set_collision_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_mask** **(** **)** +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information. @@ -121,12 +121,12 @@ The physics layers the query will detect (as a bitmask). By default, all collisi .. rst-class:: classref-property -:ref:`RID[]` **exclude** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **exclude** = ``[]`` .. rst-class:: classref-property-setget -- void **set_exclude** **(** :ref:`RID[]` value **)** -- :ref:`RID[]` **get_exclude** **(** **)** +- |void| **set_exclude**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) +- :ref:`Array`\[:ref:`RID`\] **get_exclude**\ (\ ) The list of object :ref:`RID`\ s that will be excluded from collisions. Use :ref:`CollisionObject2D.get_rid` to get the :ref:`RID` associated with a :ref:`CollisionObject2D`-derived node. @@ -142,8 +142,8 @@ The list of object :ref:`RID`\ s that will be excluded from collision .. rst-class:: classref-property-setget -- void **set_from** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_from** **(** **)** +- |void| **set_from**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_from**\ (\ ) The starting point of the ray being queried for, in global coordinates. @@ -159,8 +159,8 @@ The starting point of the ray being queried for, in global coordinates. .. rst-class:: classref-property-setget -- void **set_hit_from_inside** **(** :ref:`bool` value **)** -- :ref:`bool` **is_hit_from_inside_enabled** **(** **)** +- |void| **set_hit_from_inside**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_hit_from_inside_enabled**\ (\ ) If ``true``, the query will detect a hit when starting inside shapes. In this case the collision normal will be ``Vector2(0, 0)``. Does not affect concave polygon shapes. @@ -176,8 +176,8 @@ If ``true``, the query will detect a hit when starting inside shapes. In this ca .. rst-class:: classref-property-setget -- void **set_to** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_to** **(** **)** +- |void| **set_to**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_to**\ (\ ) The ending point of the ray being queried for, in global coordinates. @@ -194,7 +194,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PhysicsRayQueryParameters2D` **create** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`int` collision_mask=4294967295, :ref:`RID[]` exclude=[] **)** |static| +:ref:`PhysicsRayQueryParameters2D` **create**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, collision_mask\: :ref:`int` = 4294967295, exclude\: :ref:`Array`\[:ref:`RID`\] = []\ ) |static| Returns a new, pre-configured **PhysicsRayQueryParameters2D** object. Use it to quickly create query parameters using the most common options. @@ -210,3 +210,4 @@ Returns a new, pre-configured **PhysicsRayQueryParameters2D** object. Use it to .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsrayqueryparameters3d.rst b/classes/class_physicsrayqueryparameters3d.rst index 7699e26c05a..f773c8cb726 100644 --- a/classes/class_physicsrayqueryparameters3d.rst +++ b/classes/class_physicsrayqueryparameters3d.rst @@ -29,23 +29,23 @@ Properties .. table:: :widths: auto - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------+ - | :ref:`bool` | :ref:`collide_with_areas` | ``false`` | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------+ - | :ref:`bool` | :ref:`collide_with_bodies` | ``true`` | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------+ - | :ref:`int` | :ref:`collision_mask` | ``4294967295`` | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------+ - | :ref:`RID[]` | :ref:`exclude` | ``[]`` | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------+ - | :ref:`Vector3` | :ref:`from` | ``Vector3(0, 0, 0)`` | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------+ - | :ref:`bool` | :ref:`hit_back_faces` | ``true`` | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------+ - | :ref:`bool` | :ref:`hit_from_inside` | ``false`` | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------+ - | :ref:`Vector3` | :ref:`to` | ``Vector3(0, 0, 0)`` | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------+ + +----------------------------------------------------+--------------------------------------------------------------------------------------------+----------------------+ + | :ref:`bool` | :ref:`collide_with_areas` | ``false`` | + +----------------------------------------------------+--------------------------------------------------------------------------------------------+----------------------+ + | :ref:`bool` | :ref:`collide_with_bodies` | ``true`` | + +----------------------------------------------------+--------------------------------------------------------------------------------------------+----------------------+ + | :ref:`int` | :ref:`collision_mask` | ``4294967295`` | + +----------------------------------------------------+--------------------------------------------------------------------------------------------+----------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`exclude` | ``[]`` | + +----------------------------------------------------+--------------------------------------------------------------------------------------------+----------------------+ + | :ref:`Vector3` | :ref:`from` | ``Vector3(0, 0, 0)`` | + +----------------------------------------------------+--------------------------------------------------------------------------------------------+----------------------+ + | :ref:`bool` | :ref:`hit_back_faces` | ``true`` | + +----------------------------------------------------+--------------------------------------------------------------------------------------------+----------------------+ + | :ref:`bool` | :ref:`hit_from_inside` | ``false`` | + +----------------------------------------------------+--------------------------------------------------------------------------------------------+----------------------+ + | :ref:`Vector3` | :ref:`to` | ``Vector3(0, 0, 0)`` | + +----------------------------------------------------+--------------------------------------------------------------------------------------------+----------------------+ .. rst-class:: classref-reftable-group @@ -55,9 +55,9 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsRayQueryParameters3D` | :ref:`create` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`int` collision_mask=4294967295, :ref:`RID[]` exclude=[] **)** |static| | - +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsRayQueryParameters3D` | :ref:`create`\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, collision_mask\: :ref:`int` = 4294967295, exclude\: :ref:`Array`\[:ref:`RID`\] = []\ ) |static| | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -76,8 +76,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_collide_with_areas** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_areas_enabled** **(** **)** +- |void| **set_collide_with_areas**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_areas_enabled**\ (\ ) If ``true``, the query will take :ref:`Area3D`\ s into account. @@ -93,8 +93,8 @@ If ``true``, the query will take :ref:`Area3D`\ s into account. .. rst-class:: classref-property-setget -- void **set_collide_with_bodies** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_bodies_enabled** **(** **)** +- |void| **set_collide_with_bodies**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_bodies_enabled**\ (\ ) If ``true``, the query will take :ref:`PhysicsBody3D`\ s into account. @@ -110,8 +110,8 @@ If ``true``, the query will take :ref:`PhysicsBody3D`\ s in .. rst-class:: classref-property-setget -- void **set_collision_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_mask** **(** **)** +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information. @@ -123,12 +123,12 @@ The physics layers the query will detect (as a bitmask). By default, all collisi .. rst-class:: classref-property -:ref:`RID[]` **exclude** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **exclude** = ``[]`` .. rst-class:: classref-property-setget -- void **set_exclude** **(** :ref:`RID[]` value **)** -- :ref:`RID[]` **get_exclude** **(** **)** +- |void| **set_exclude**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) +- :ref:`Array`\[:ref:`RID`\] **get_exclude**\ (\ ) The list of object :ref:`RID`\ s that will be excluded from collisions. Use :ref:`CollisionObject3D.get_rid` to get the :ref:`RID` associated with a :ref:`CollisionObject3D`-derived node. @@ -144,8 +144,8 @@ The list of object :ref:`RID`\ s that will be excluded from collision .. rst-class:: classref-property-setget -- void **set_from** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_from** **(** **)** +- |void| **set_from**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_from**\ (\ ) The starting point of the ray being queried for, in global coordinates. @@ -161,8 +161,8 @@ The starting point of the ray being queried for, in global coordinates. .. rst-class:: classref-property-setget -- void **set_hit_back_faces** **(** :ref:`bool` value **)** -- :ref:`bool` **is_hit_back_faces_enabled** **(** **)** +- |void| **set_hit_back_faces**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_hit_back_faces_enabled**\ (\ ) If ``true``, the query will hit back faces with concave polygon shapes with back face enabled or heightmap shapes. @@ -178,8 +178,8 @@ If ``true``, the query will hit back faces with concave polygon shapes with back .. rst-class:: classref-property-setget -- void **set_hit_from_inside** **(** :ref:`bool` value **)** -- :ref:`bool` **is_hit_from_inside_enabled** **(** **)** +- |void| **set_hit_from_inside**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_hit_from_inside_enabled**\ (\ ) If ``true``, the query will detect a hit when starting inside shapes. In this case the collision normal will be ``Vector3(0, 0, 0)``. Does not affect concave polygon shapes or heightmap shapes. @@ -195,8 +195,8 @@ If ``true``, the query will detect a hit when starting inside shapes. In this ca .. rst-class:: classref-property-setget -- void **set_to** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_to** **(** **)** +- |void| **set_to**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_to**\ (\ ) The ending point of the ray being queried for, in global coordinates. @@ -213,7 +213,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PhysicsRayQueryParameters3D` **create** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`int` collision_mask=4294967295, :ref:`RID[]` exclude=[] **)** |static| +:ref:`PhysicsRayQueryParameters3D` **create**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, collision_mask\: :ref:`int` = 4294967295, exclude\: :ref:`Array`\[:ref:`RID`\] = []\ ) |static| Returns a new, pre-configured **PhysicsRayQueryParameters3D** object. Use it to quickly create query parameters using the most common options. @@ -229,3 +229,4 @@ Returns a new, pre-configured **PhysicsRayQueryParameters3D** object. Use it to .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsserver2d.rst b/classes/class_physicsserver2d.rst index 4999e439af8..20254a92133 100644 --- a/classes/class_physicsserver2d.rst +++ b/classes/class_physicsserver2d.rst @@ -45,243 +45,243 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`bool` disabled=false **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_attach_canvas_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`area_create` **(** **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`area_get_canvas_instance_id` **(** :ref:`RID` area **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`area_get_collision_layer` **(** :ref:`RID` area **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`area_get_collision_mask` **(** :ref:`RID` area **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`area_get_object_instance_id` **(** :ref:`RID` area **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`AreaParameter` param **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`area_get_transform` **(** :ref:`RID` area **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Callable` callback **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Callable` callback **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_monitorable` **(** :ref:`RID` area, :ref:`bool` monitorable **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_shape_disabled` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disabled **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform2D` transform **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_add_constant_central_force` **(** :ref:`RID` body, :ref:`Vector2` force **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_add_constant_force` **(** :ref:`RID` body, :ref:`Vector2` force, :ref:`Vector2` position=Vector2(0, 0) **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_add_constant_torque` **(** :ref:`RID` body, :ref:`float` torque **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`bool` disabled=false **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_apply_central_force` **(** :ref:`RID` body, :ref:`Vector2` force **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector2` impulse **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_apply_force` **(** :ref:`RID` body, :ref:`Vector2` force, :ref:`Vector2` position=Vector2(0, 0) **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` impulse, :ref:`Vector2` position=Vector2(0, 0) **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_apply_torque` **(** :ref:`RID` body, :ref:`float` torque **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`float` impulse **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_attach_canvas_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`body_create` **(** **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`body_get_canvas_instance_id` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`body_get_collision_priority` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`body_get_constant_force` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`body_get_constant_torque` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`CCDMode` | :ref:`body_get_continuous_collision_detection_mode` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectBodyState2D` | :ref:`body_get_direct_state` **(** :ref:`RID` body **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`BodyMode` | :ref:`body_get_mode` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`body_get_object_instance_id` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`BodyParameter` param **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_reset_mass_properties` **(** :ref:`RID` body **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_collision_priority` **(** :ref:`RID` body, :ref:`float` priority **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_constant_force` **(** :ref:`RID` body, :ref:`Vector2` force **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_constant_torque` **(** :ref:`RID` body, :ref:`float` torque **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_continuous_collision_detection_mode` **(** :ref:`RID` body, :ref:`CCDMode` mode **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Callable` callable, :ref:`Variant` userdata=null **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`BodyMode` mode **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`Variant` value **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_shape_as_one_way_collision` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable, :ref:`float` margin **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_shape_disabled` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disabled **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`PhysicsTestMotionParameters2D` parameters, :ref:`PhysicsTestMotionResult2D` result=null **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`capsule_shape_create` **(** **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`circle_shape_create` **(** **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`concave_polygon_shape_create` **(** **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`convex_polygon_shape_create` **(** **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`damped_spring_joint_get_param` **(** :ref:`RID` joint, :ref:`DampedSpringParam` param **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`damped_spring_joint_set_param` **(** :ref:`RID` joint, :ref:`DampedSpringParam` param, :ref:`float` value **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`free_rid` **(** :ref:`RID` rid **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_process_info` **(** :ref:`ProcessInfo` process_info **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`joint_clear` **(** :ref:`RID` joint **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`joint_create` **(** **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`joint_disable_collisions_between_bodies` **(** :ref:`RID` joint, :ref:`bool` disable **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`joint_get_param` **(** :ref:`RID` joint, :ref:`JointParam` param **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`JointType` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`joint_is_disabled_collisions_between_bodies` **(** :ref:`RID` joint **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`joint_make_damped_spring` **(** :ref:`RID` joint, :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`joint_make_groove` **(** :ref:`RID` joint, :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a=RID(), :ref:`RID` body_b=RID() **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`joint_make_pin` **(** :ref:`RID` joint, :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`JointParam` param, :ref:`float` value **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`pin_joint_get_flag` **(** :ref:`RID` joint, :ref:`PinJointFlag` flag **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`pin_joint_get_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`pin_joint_set_flag` **(** :ref:`RID` joint, :ref:`PinJointFlag` flag, :ref:`bool` enabled **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`pin_joint_set_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`rectangle_shape_create` **(** **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`segment_shape_create` **(** **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`separation_ray_shape_create` **(** **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_active` **(** :ref:`bool` active **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`shape_get_data` **(** :ref:`RID` shape **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ShapeType` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`space_create` **(** **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectSpaceState2D` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`world_boundary_shape_create` **(** **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_add_shape`\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), disabled\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_attach_canvas_instance_id`\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_attach_object_instance_id`\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_clear_shapes`\ (\ area\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`area_create`\ (\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`area_get_canvas_instance_id`\ (\ area\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`area_get_collision_layer`\ (\ area\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`area_get_collision_mask`\ (\ area\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`area_get_object_instance_id`\ (\ area\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`area_get_param`\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`area_get_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`area_get_shape_count`\ (\ area\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`area_get_shape_transform`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`area_get_space`\ (\ area\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`area_get_transform`\ (\ area\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_remove_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_area_monitor_callback`\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_collision_layer`\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_collision_mask`\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_monitor_callback`\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_monitorable`\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_param`\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_shape_disabled`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_shape_transform`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_space`\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_transform`\ (\ area\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_add_collision_exception`\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_add_constant_central_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_add_constant_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_add_constant_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_add_shape`\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), disabled\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_apply_central_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_apply_central_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_apply_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_apply_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_apply_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_apply_torque_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_attach_canvas_instance_id`\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_attach_object_instance_id`\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_clear_shapes`\ (\ body\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`body_create`\ (\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`body_get_canvas_instance_id`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`body_get_collision_layer`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`body_get_collision_mask`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`body_get_collision_priority`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`body_get_constant_force`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`body_get_constant_torque`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CCDMode` | :ref:`body_get_continuous_collision_detection_mode`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectBodyState2D` | :ref:`body_get_direct_state`\ (\ body\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`body_get_max_contacts_reported`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`BodyMode` | :ref:`body_get_mode`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`body_get_object_instance_id`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`body_get_param`\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`body_get_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`body_get_shape_count`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`body_get_shape_transform`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`body_get_space`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`body_get_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`body_is_omitting_force_integration`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_remove_collision_exception`\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_remove_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_reset_mass_properties`\ (\ body\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_axis_velocity`\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector2`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_collision_layer`\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_collision_mask`\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_collision_priority`\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_constant_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_constant_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_continuous_collision_detection_mode`\ (\ body\: :ref:`RID`, mode\: :ref:`CCDMode`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_force_integration_callback`\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant` = null\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_max_contacts_reported`\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_mode`\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_omit_force_integration`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_param`\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_shape_as_one_way_collision`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, enable\: :ref:`bool`, margin\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_shape_disabled`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_shape_transform`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_space`\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`body_test_motion`\ (\ body\: :ref:`RID`, parameters\: :ref:`PhysicsTestMotionParameters2D`, result\: :ref:`PhysicsTestMotionResult2D` = null\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`capsule_shape_create`\ (\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`circle_shape_create`\ (\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`concave_polygon_shape_create`\ (\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`convex_polygon_shape_create`\ (\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`damped_spring_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`damped_spring_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`, value\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`free_rid`\ (\ rid\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_process_info`\ (\ process_info\: :ref:`ProcessInfo`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`joint_clear`\ (\ joint\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`joint_create`\ (\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`joint_disable_collisions_between_bodies`\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`JointType` | :ref:`joint_get_type`\ (\ joint\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`joint_is_disabled_collisions_between_bodies`\ (\ joint\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`joint_make_damped_spring`\ (\ joint\: :ref:`RID`, anchor_a\: :ref:`Vector2`, anchor_b\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID` = RID()\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`joint_make_groove`\ (\ joint\: :ref:`RID`, groove1_a\: :ref:`Vector2`, groove2_a\: :ref:`Vector2`, anchor_b\: :ref:`Vector2`, body_a\: :ref:`RID` = RID(), body_b\: :ref:`RID` = RID()\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`joint_make_pin`\ (\ joint\: :ref:`RID`, anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID` = RID()\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`, value\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`pin_joint_get_flag`\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`pin_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`pin_joint_set_flag`\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`, enabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`pin_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`rectangle_shape_create`\ (\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`segment_shape_create`\ (\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`separation_ray_shape_create`\ (\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_active`\ (\ active\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`shape_get_data`\ (\ shape\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ShapeType` | :ref:`shape_get_type`\ (\ shape\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_set_data`\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`space_create`\ (\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectSpaceState2D` | :ref:`space_get_direct_state`\ (\ space\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`space_get_param`\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`space_is_active`\ (\ space\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`space_set_active`\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`space_set_param`\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`world_boundary_shape_create`\ (\ ) | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -1105,7 +1105,7 @@ Method Descriptions .. rst-class:: classref-method -void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`bool` disabled=false **)** +|void| **area_add_shape**\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), disabled\: :ref:`bool` = false\ ) Adds a shape to the area, with the given local transform. The shape (together with its ``transform`` and ``disabled`` properties) is added to an array of shapes, and the shapes of an area are usually referenced by their index in this array. @@ -1117,7 +1117,7 @@ Adds a shape to the area, with the given local transform. The shape (together wi .. rst-class:: classref-method -void **area_attach_canvas_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** +|void| **area_attach_canvas_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) Attaches the ``ObjectID`` of a canvas to the area. Use :ref:`Object.get_instance_id` to get the ``ObjectID`` of a :ref:`CanvasLayer`. @@ -1129,7 +1129,7 @@ Attaches the ``ObjectID`` of a canvas to the area. Use :ref:`Object.get_instance .. rst-class:: classref-method -void **area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** +|void| **area_attach_object_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) Attaches the ``ObjectID`` of an :ref:`Object` to the area. Use :ref:`Object.get_instance_id` to get the ``ObjectID`` of a :ref:`CollisionObject2D`. @@ -1141,7 +1141,7 @@ Attaches the ``ObjectID`` of an :ref:`Object` to the area. Use :re .. rst-class:: classref-method -void **area_clear_shapes** **(** :ref:`RID` area **)** +|void| **area_clear_shapes**\ (\ area\: :ref:`RID`\ ) Removes all shapes from the area. This does not delete the shapes themselves, so they can continue to be used elsewhere or added back later. @@ -1153,7 +1153,7 @@ Removes all shapes from the area. This does not delete the shapes themselves, so .. rst-class:: classref-method -:ref:`RID` **area_create** **(** **)** +:ref:`RID` **area_create**\ (\ ) Creates a 2D area object in the physics server, and returns the :ref:`RID` that identifies it. Use :ref:`area_add_shape` to add shapes to it, use :ref:`area_set_transform` to set its transform, and use :ref:`area_set_space` to add the area to a space. @@ -1165,7 +1165,7 @@ Creates a 2D area object in the physics server, and returns the :ref:`RID` **area_get_canvas_instance_id** **(** :ref:`RID` area **)** |const| +:ref:`int` **area_get_canvas_instance_id**\ (\ area\: :ref:`RID`\ ) |const| Returns the ``ObjectID`` of the canvas attached to the area. Use :ref:`@GlobalScope.instance_from_id` to retrieve a :ref:`CanvasLayer` from a nonzero ``ObjectID``. @@ -1177,7 +1177,7 @@ Returns the ``ObjectID`` of the canvas attached to the area. Use :ref:`@GlobalSc .. rst-class:: classref-method -:ref:`int` **area_get_collision_layer** **(** :ref:`RID` area **)** |const| +:ref:`int` **area_get_collision_layer**\ (\ area\: :ref:`RID`\ ) |const| Returns the physics layer or layers the area belongs to, as a bitmask. @@ -1189,7 +1189,7 @@ Returns the physics layer or layers the area belongs to, as a bitmask. .. rst-class:: classref-method -:ref:`int` **area_get_collision_mask** **(** :ref:`RID` area **)** |const| +:ref:`int` **area_get_collision_mask**\ (\ area\: :ref:`RID`\ ) |const| Returns the physics layer or layers the area can contact with, as a bitmask. @@ -1201,7 +1201,7 @@ Returns the physics layer or layers the area can contact with, as a bitmask. .. rst-class:: classref-method -:ref:`int` **area_get_object_instance_id** **(** :ref:`RID` area **)** |const| +:ref:`int` **area_get_object_instance_id**\ (\ area\: :ref:`RID`\ ) |const| Returns the ``ObjectID`` attached to the area. Use :ref:`@GlobalScope.instance_from_id` to retrieve an :ref:`Object` from a nonzero ``ObjectID``. @@ -1213,7 +1213,7 @@ Returns the ``ObjectID`` attached to the area. Use :ref:`@GlobalScope.instance_f .. rst-class:: classref-method -:ref:`Variant` **area_get_param** **(** :ref:`RID` area, :ref:`AreaParameter` param **)** |const| +:ref:`Variant` **area_get_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |const| Returns the value of the given area parameter. See :ref:`AreaParameter` for the list of available parameters. @@ -1225,7 +1225,7 @@ Returns the value of the given area parameter. See :ref:`AreaParameter` **area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |const| +:ref:`RID` **area_get_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| Returns the :ref:`RID` of the shape with the given index in the area's array of shapes. @@ -1237,7 +1237,7 @@ Returns the :ref:`RID` of the shape with the given index in the area' .. rst-class:: classref-method -:ref:`int` **area_get_shape_count** **(** :ref:`RID` area **)** |const| +:ref:`int` **area_get_shape_count**\ (\ area\: :ref:`RID`\ ) |const| Returns the number of shapes added to the area. @@ -1249,7 +1249,7 @@ Returns the number of shapes added to the area. .. rst-class:: classref-method -:ref:`Transform2D` **area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |const| +:ref:`Transform2D` **area_get_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| Returns the local transform matrix of the shape with the given index in the area's array of shapes. @@ -1261,7 +1261,7 @@ Returns the local transform matrix of the shape with the given index in the area .. rst-class:: classref-method -:ref:`RID` **area_get_space** **(** :ref:`RID` area **)** |const| +:ref:`RID` **area_get_space**\ (\ area\: :ref:`RID`\ ) |const| Returns the :ref:`RID` of the space assigned to the area. Returns an empty :ref:`RID` if no space is assigned. @@ -1273,7 +1273,7 @@ Returns the :ref:`RID` of the space assigned to the area. Returns an .. rst-class:: classref-method -:ref:`Transform2D` **area_get_transform** **(** :ref:`RID` area **)** |const| +:ref:`Transform2D` **area_get_transform**\ (\ area\: :ref:`RID`\ ) |const| Returns the transform matrix of the area. @@ -1285,7 +1285,7 @@ Returns the transform matrix of the area. .. rst-class:: classref-method -void **area_remove_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** +|void| **area_remove_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) Removes the shape with the given index from the area's array of shapes. The shape itself is not deleted, so it can continue to be used elsewhere or added back later. As a result of this operation, the area's shapes which used to have indices higher than ``shape_idx`` will have their index decreased by one. @@ -1297,7 +1297,7 @@ Removes the shape with the given index from the area's array of shapes. The shap .. rst-class:: classref-method -void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Callable` callback **)** +|void| **area_set_area_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) Sets the area's area monitor callback. This callback will be called when any other (shape of an) area enters or exits (a shape of) the given area, and must take the following five parameters: @@ -1321,7 +1321,7 @@ By counting (or keeping track of) the shapes that enter and exit, it can be dete .. rst-class:: classref-method -void **area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** +|void| **area_set_collision_layer**\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) Assigns the area to one or many physics layers, via a bitmask. @@ -1333,7 +1333,7 @@ Assigns the area to one or many physics layers, via a bitmask. .. rst-class:: classref-method -void **area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** +|void| **area_set_collision_mask**\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) Sets which physics layers the area will monitor, via a bitmask. @@ -1345,7 +1345,7 @@ Sets which physics layers the area will monitor, via a bitmask. .. rst-class:: classref-method -void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Callable` callback **)** +|void| **area_set_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) Sets the area's body monitor callback. This callback will be called when any other (shape of a) body enters or exits (a shape of) the given area, and must take the following five parameters: @@ -1369,7 +1369,7 @@ By counting (or keeping track of) the shapes that enter and exit, it can be dete .. rst-class:: classref-method -void **area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** +|void| **area_set_monitorable**\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) Sets whether the area is monitorable or not. If ``monitorable`` is ``true``, the area monitoring callback of other areas will be called when this area enters or exits them. @@ -1381,7 +1381,7 @@ Sets whether the area is monitorable or not. If ``monitorable`` is ``true``, the .. rst-class:: classref-method -void **area_set_param** **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** +|void| **area_set_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) Sets the value of the given area parameter. See :ref:`AreaParameter` for the list of available parameters. @@ -1393,7 +1393,7 @@ Sets the value of the given area parameter. See :ref:`AreaParameter` area, :ref:`int` shape_idx, :ref:`RID` shape **)** +|void| **area_set_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) Replaces the area's shape at the given index by another shape, while not affecting the ``transform`` and ``disabled`` properties at the same index. @@ -1405,7 +1405,7 @@ Replaces the area's shape at the given index by another shape, while not affecti .. rst-class:: classref-method -void **area_set_shape_disabled** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disabled **)** +|void| **area_set_shape_disabled**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) Sets the disabled property of the area's shape with the given index. If ``disabled`` is ``true``, then the shape will not detect any other shapes entering or exiting it. @@ -1417,7 +1417,7 @@ Sets the disabled property of the area's shape with the given index. If ``disabl .. rst-class:: classref-method -void **area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** +|void| **area_set_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) Sets the local transform matrix of the area's shape with the given index. @@ -1429,7 +1429,7 @@ Sets the local transform matrix of the area's shape with the given index. .. rst-class:: classref-method -void **area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** +|void| **area_set_space**\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) Adds the area to the given space, after removing the area from the previously assigned space (if any). @@ -1443,7 +1443,7 @@ Adds the area to the given space, after removing the area from the previously as .. rst-class:: classref-method -void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform2D` transform **)** +|void| **area_set_transform**\ (\ area\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) Sets the transform matrix of the area. @@ -1455,7 +1455,7 @@ Sets the transform matrix of the area. .. rst-class:: classref-method -void **body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** +|void| **body_add_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) Adds ``excepted_body`` to the body's list of collision exceptions, so that collisions with it are ignored. @@ -1467,7 +1467,7 @@ Adds ``excepted_body`` to the body's list of collision exceptions, so that colli .. rst-class:: classref-method -void **body_add_constant_central_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** +|void| **body_add_constant_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) Adds a constant directional force to the body. The force does not affect rotation. The force remains applied over time until cleared with ``PhysicsServer2D.body_set_constant_force(body, Vector2(0, 0))``. @@ -1481,7 +1481,7 @@ This is equivalent to using :ref:`body_add_constant_force` body, :ref:`Vector2` force, :ref:`Vector2` position=Vector2(0, 0) **)** +|void| **body_add_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) Adds a constant positioned force to the body. The force can affect rotation if ``position`` is different from the body's center of mass. The force remains applied over time until cleared with ``PhysicsServer2D.body_set_constant_force(body, Vector2(0, 0))``. @@ -1495,7 +1495,7 @@ Adds a constant positioned force to the body. The force can affect rotation if ` .. rst-class:: classref-method -void **body_add_constant_torque** **(** :ref:`RID` body, :ref:`float` torque **)** +|void| **body_add_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) Adds a constant rotational force to the body. The force does not affect position. The force remains applied over time until cleared with ``PhysicsServer2D.body_set_constant_torque(body, 0)``. @@ -1507,7 +1507,7 @@ Adds a constant rotational force to the body. The force does not affect position .. rst-class:: classref-method -void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`bool` disabled=false **)** +|void| **body_add_shape**\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), disabled\: :ref:`bool` = false\ ) Adds a shape to the area, with the given local transform. The shape (together with its ``transform`` and ``disabled`` properties) is added to an array of shapes, and the shapes of a body are usually referenced by their index in this array. @@ -1519,7 +1519,7 @@ Adds a shape to the area, with the given local transform. The shape (together wi .. rst-class:: classref-method -void **body_apply_central_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** +|void| **body_apply_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) Applies a directional force to the body, at the body's center of mass. The force does not affect rotation. A force is time dependent and meant to be applied every physics update. @@ -1533,7 +1533,7 @@ This is equivalent to using :ref:`body_apply_force` body, :ref:`Vector2` impulse **)** +|void| **body_apply_central_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`\ ) Applies a directional impulse to the body, at the body's center of mass. The impulse does not affect rotation. @@ -1549,7 +1549,7 @@ This is equivalent to using :ref:`body_apply_impulse` body, :ref:`Vector2` force, :ref:`Vector2` position=Vector2(0, 0) **)** +|void| **body_apply_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) Applies a positioned force to the body. The force can affect rotation if ``position`` is different from the body's center of mass. A force is time dependent and meant to be applied every physics update. @@ -1563,7 +1563,7 @@ Applies a positioned force to the body. The force can affect rotation if ``posit .. rst-class:: classref-method -void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector2` impulse, :ref:`Vector2` position=Vector2(0, 0) **)** +|void| **body_apply_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) Applies a positioned impulse to the body. The impulse can affect rotation if ``position`` is different from the body's center of mass. @@ -1579,7 +1579,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -void **body_apply_torque** **(** :ref:`RID` body, :ref:`float` torque **)** +|void| **body_apply_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) Applies a rotational force to the body. The force does not affect position. A force is time dependent and meant to be applied every physics update. @@ -1591,7 +1591,7 @@ Applies a rotational force to the body. The force does not affect position. A fo .. rst-class:: classref-method -void **body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`float` impulse **)** +|void| **body_apply_torque_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`float`\ ) Applies a rotational impulse to the body. The impulse does not affect position. @@ -1605,7 +1605,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -void **body_attach_canvas_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** +|void| **body_attach_canvas_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) Attaches the ``ObjectID`` of a canvas to the body. Use :ref:`Object.get_instance_id` to get the ``ObjectID`` of a :ref:`CanvasLayer`. @@ -1617,7 +1617,7 @@ Attaches the ``ObjectID`` of a canvas to the body. Use :ref:`Object.get_instance .. rst-class:: classref-method -void **body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** +|void| **body_attach_object_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) Attaches the ``ObjectID`` of an :ref:`Object` to the body. Use :ref:`Object.get_instance_id` to get the ``ObjectID`` of a :ref:`CollisionObject2D`. @@ -1629,7 +1629,7 @@ Attaches the ``ObjectID`` of an :ref:`Object` to the body. Use :re .. rst-class:: classref-method -void **body_clear_shapes** **(** :ref:`RID` body **)** +|void| **body_clear_shapes**\ (\ body\: :ref:`RID`\ ) Removes all shapes from the body. This does not delete the shapes themselves, so they can continue to be used elsewhere or added back later. @@ -1641,7 +1641,7 @@ Removes all shapes from the body. This does not delete the shapes themselves, so .. rst-class:: classref-method -:ref:`RID` **body_create** **(** **)** +:ref:`RID` **body_create**\ (\ ) Creates a 2D body object in the physics server, and returns the :ref:`RID` that identifies it. Use :ref:`body_add_shape` to add shapes to it, use :ref:`body_set_state` to set its transform, and use :ref:`body_set_space` to add the body to a space. @@ -1653,7 +1653,7 @@ Creates a 2D body object in the physics server, and returns the :ref:`RID` **body_get_canvas_instance_id** **(** :ref:`RID` body **)** |const| +:ref:`int` **body_get_canvas_instance_id**\ (\ body\: :ref:`RID`\ ) |const| Returns the ``ObjectID`` of the canvas attached to the body. Use :ref:`@GlobalScope.instance_from_id` to retrieve a :ref:`CanvasLayer` from a nonzero ``ObjectID``. @@ -1665,7 +1665,7 @@ Returns the ``ObjectID`` of the canvas attached to the body. Use :ref:`@GlobalSc .. rst-class:: classref-method -:ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** |const| +:ref:`int` **body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |const| Returns the physics layer or layers the body belongs to, as a bitmask. @@ -1677,7 +1677,7 @@ Returns the physics layer or layers the body belongs to, as a bitmask. .. rst-class:: classref-method -:ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** |const| +:ref:`int` **body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |const| Returns the physics layer or layers the body can collide with, as a bitmask. @@ -1689,7 +1689,7 @@ Returns the physics layer or layers the body can collide with, as a bitmask. .. rst-class:: classref-method -:ref:`float` **body_get_collision_priority** **(** :ref:`RID` body **)** |const| +:ref:`float` **body_get_collision_priority**\ (\ body\: :ref:`RID`\ ) |const| Returns the body's collision priority. This is used in the depenetration phase of :ref:`body_test_motion`. The higher the priority is, the lower the penetration into the body will be. @@ -1701,7 +1701,7 @@ Returns the body's collision priority. This is used in the depenetration phase o .. rst-class:: classref-method -:ref:`Vector2` **body_get_constant_force** **(** :ref:`RID` body **)** |const| +:ref:`Vector2` **body_get_constant_force**\ (\ body\: :ref:`RID`\ ) |const| Returns the body's total constant positional force applied during each physics update. @@ -1715,7 +1715,7 @@ See :ref:`body_add_constant_force` **body_get_constant_torque** **(** :ref:`RID` body **)** |const| +:ref:`float` **body_get_constant_torque**\ (\ body\: :ref:`RID`\ ) |const| Returns the body's total constant rotational force applied during each physics update. @@ -1729,7 +1729,7 @@ See :ref:`body_add_constant_torque` **body_get_continuous_collision_detection_mode** **(** :ref:`RID` body **)** |const| +:ref:`CCDMode` **body_get_continuous_collision_detection_mode**\ (\ body\: :ref:`RID`\ ) |const| Returns the body's continuous collision detection mode (see :ref:`CCDMode`). @@ -1741,7 +1741,7 @@ Returns the body's continuous collision detection mode (see :ref:`CCDMode` **body_get_direct_state** **(** :ref:`RID` body **)** +:ref:`PhysicsDirectBodyState2D` **body_get_direct_state**\ (\ body\: :ref:`RID`\ ) Returns the :ref:`PhysicsDirectBodyState2D` of the body. Returns ``null`` if the body is destroyed or not assigned to a space. @@ -1753,7 +1753,7 @@ Returns the :ref:`PhysicsDirectBodyState2D` of t .. rst-class:: classref-method -:ref:`int` **body_get_max_contacts_reported** **(** :ref:`RID` body **)** |const| +:ref:`int` **body_get_max_contacts_reported**\ (\ body\: :ref:`RID`\ ) |const| Returns the maximum number of contacts that the body can report. See :ref:`body_set_max_contacts_reported`. @@ -1765,7 +1765,7 @@ Returns the maximum number of contacts that the body can report. See :ref:`body_ .. rst-class:: classref-method -:ref:`BodyMode` **body_get_mode** **(** :ref:`RID` body **)** |const| +:ref:`BodyMode` **body_get_mode**\ (\ body\: :ref:`RID`\ ) |const| Returns the body's mode (see :ref:`BodyMode`). @@ -1777,7 +1777,7 @@ Returns the body's mode (see :ref:`BodyMode`). .. rst-class:: classref-method -:ref:`int` **body_get_object_instance_id** **(** :ref:`RID` body **)** |const| +:ref:`int` **body_get_object_instance_id**\ (\ body\: :ref:`RID`\ ) |const| Returns the ``ObjectID`` attached to the body. Use :ref:`@GlobalScope.instance_from_id` to retrieve an :ref:`Object` from a nonzero ``ObjectID``. @@ -1789,7 +1789,7 @@ Returns the ``ObjectID`` attached to the body. Use :ref:`@GlobalScope.instance_f .. rst-class:: classref-method -:ref:`Variant` **body_get_param** **(** :ref:`RID` body, :ref:`BodyParameter` param **)** |const| +:ref:`Variant` **body_get_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |const| Returns the value of the given body parameter. See :ref:`BodyParameter` for the list of available parameters. @@ -1801,7 +1801,7 @@ Returns the value of the given body parameter. See :ref:`BodyParameter` **body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |const| +:ref:`RID` **body_get_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| Returns the :ref:`RID` of the shape with the given index in the body's array of shapes. @@ -1813,7 +1813,7 @@ Returns the :ref:`RID` of the shape with the given index in the body' .. rst-class:: classref-method -:ref:`int` **body_get_shape_count** **(** :ref:`RID` body **)** |const| +:ref:`int` **body_get_shape_count**\ (\ body\: :ref:`RID`\ ) |const| Returns the number of shapes added to the body. @@ -1825,7 +1825,7 @@ Returns the number of shapes added to the body. .. rst-class:: classref-method -:ref:`Transform2D` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |const| +:ref:`Transform2D` **body_get_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| Returns the local transform matrix of the shape with the given index in the area's array of shapes. @@ -1837,7 +1837,7 @@ Returns the local transform matrix of the shape with the given index in the area .. rst-class:: classref-method -:ref:`RID` **body_get_space** **(** :ref:`RID` body **)** |const| +:ref:`RID` **body_get_space**\ (\ body\: :ref:`RID`\ ) |const| Returns the :ref:`RID` of the space assigned to the body. Returns an empty :ref:`RID` if no space is assigned. @@ -1849,7 +1849,7 @@ Returns the :ref:`RID` of the space assigned to the body. Returns an .. rst-class:: classref-method -:ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** |const| +:ref:`Variant` **body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |const| Returns the value of the given state of the body. See :ref:`BodyState` for the list of available states. @@ -1861,7 +1861,7 @@ Returns the value of the given state of the body. See :ref:`BodyState` **body_is_omitting_force_integration** **(** :ref:`RID` body **)** |const| +:ref:`bool` **body_is_omitting_force_integration**\ (\ body\: :ref:`RID`\ ) |const| Returns ``true`` if the body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). @@ -1873,7 +1873,7 @@ Returns ``true`` if the body uses a callback function to calculate its own physi .. rst-class:: classref-method -void **body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** +|void| **body_remove_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) Removes ``excepted_body`` from the body's list of collision exceptions, so that collisions with it are no longer ignored. @@ -1885,7 +1885,7 @@ Removes ``excepted_body`` from the body's list of collision exceptions, so that .. rst-class:: classref-method -void **body_remove_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** +|void| **body_remove_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) Removes the shape with the given index from the body's array of shapes. The shape itself is not deleted, so it can continue to be used elsewhere or added back later. As a result of this operation, the body's shapes which used to have indices higher than ``shape_idx`` will have their index decreased by one. @@ -1897,7 +1897,7 @@ Removes the shape with the given index from the body's array of shapes. The shap .. rst-class:: classref-method -void **body_reset_mass_properties** **(** :ref:`RID` body **)** +|void| **body_reset_mass_properties**\ (\ body\: :ref:`RID`\ ) Restores the default inertia and center of mass of the body based on its shapes. This undoes any custom values previously set using :ref:`body_set_param`. @@ -1909,7 +1909,7 @@ Restores the default inertia and center of mass of the body based on its shapes. .. rst-class:: classref-method -void **body_set_axis_velocity** **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** +|void| **body_set_axis_velocity**\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector2`\ ) Modifies the body's linear velocity so that its projection to the axis ``axis_velocity.normalized()`` is exactly ``axis_velocity.length()``. This is useful for jumping behavior. @@ -1921,7 +1921,7 @@ Modifies the body's linear velocity so that its projection to the axis ``axis_ve .. rst-class:: classref-method -void **body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** +|void| **body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) Sets the physics layer or layers the body belongs to, via a bitmask. @@ -1933,7 +1933,7 @@ Sets the physics layer or layers the body belongs to, via a bitmask. .. rst-class:: classref-method -void **body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** +|void| **body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) Sets the physics layer or layers the body can collide with, via a bitmask. @@ -1945,7 +1945,7 @@ Sets the physics layer or layers the body can collide with, via a bitmask. .. rst-class:: classref-method -void **body_set_collision_priority** **(** :ref:`RID` body, :ref:`float` priority **)** +|void| **body_set_collision_priority**\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) Sets the body's collision priority. This is used in the depenetration phase of :ref:`body_test_motion`. The higher the priority is, the lower the penetration into the body will be. @@ -1957,7 +1957,7 @@ Sets the body's collision priority. This is used in the depenetration phase of : .. rst-class:: classref-method -void **body_set_constant_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** +|void| **body_set_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) Sets the body's total constant positional force applied during each physics update. @@ -1971,7 +1971,7 @@ See :ref:`body_add_constant_force` body, :ref:`float` torque **)** +|void| **body_set_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) Sets the body's total constant rotational force applied during each physics update. @@ -1985,7 +1985,7 @@ See :ref:`body_add_constant_torque` body, :ref:`CCDMode` mode **)** +|void| **body_set_continuous_collision_detection_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`CCDMode`\ ) Sets the continuous collision detection mode using one of the :ref:`CCDMode` constants. @@ -1999,7 +1999,7 @@ Continuous collision detection tries to predict where a moving body would collid .. rst-class:: classref-method -void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Callable` callable, :ref:`Variant` userdata=null **)** +|void| **body_set_force_integration_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant` = null\ ) Sets the function used to calculate physics for the body, if that body allows it (see :ref:`body_set_omit_force_integration`). @@ -2019,7 +2019,7 @@ The force integration function takes the following two parameters: .. rst-class:: classref-method -void **body_set_max_contacts_reported** **(** :ref:`RID` body, :ref:`int` amount **)** +|void| **body_set_max_contacts_reported**\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) Sets the maximum number of contacts that the body can report. If ``amount`` is greater than zero, then the body will keep track of at most this many contacts with other bodies. @@ -2031,7 +2031,7 @@ Sets the maximum number of contacts that the body can report. If ``amount`` is g .. rst-class:: classref-method -void **body_set_mode** **(** :ref:`RID` body, :ref:`BodyMode` mode **)** +|void| **body_set_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) Sets the body's mode. See :ref:`BodyMode` for the list of available modes. @@ -2043,7 +2043,7 @@ Sets the body's mode. See :ref:`BodyMode` for the .. rst-class:: classref-method -void **body_set_omit_force_integration** **(** :ref:`RID` body, :ref:`bool` enable **)** +|void| **body_set_omit_force_integration**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) Sets whether the body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). @@ -2055,7 +2055,7 @@ Sets whether the body uses a callback function to calculate its own physics (see .. rst-class:: classref-method -void **body_set_param** **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`Variant` value **)** +|void| **body_set_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) Sets the value of the given body parameter. See :ref:`BodyParameter` for the list of available parameters. @@ -2067,7 +2067,7 @@ Sets the value of the given body parameter. See :ref:`BodyParameter` body, :ref:`int` shape_idx, :ref:`RID` shape **)** +|void| **body_set_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) Replaces the body's shape at the given index by another shape, while not affecting the ``transform``, ``disabled``, and one-way collision properties at the same index. @@ -2079,7 +2079,7 @@ Replaces the body's shape at the given index by another shape, while not affecti .. rst-class:: classref-method -void **body_set_shape_as_one_way_collision** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable, :ref:`float` margin **)** +|void| **body_set_shape_as_one_way_collision**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, enable\: :ref:`bool`, margin\: :ref:`float`\ ) Sets the one-way collision properties of the body's shape with the given index. If ``enable`` is ``true``, the one-way collision direction given by the shape's local upward axis ``body_get_shape_transform(body, shape_idx).y`` will be used to ignore collisions with the shape in the opposite direction, and to ensure depenetration of kinematic bodies happens in this direction. @@ -2091,7 +2091,7 @@ Sets the one-way collision properties of the body's shape with the given index. .. rst-class:: classref-method -void **body_set_shape_disabled** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disabled **)** +|void| **body_set_shape_disabled**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) Sets the disabled property of the body's shape with the given index. If ``disabled`` is ``true``, then the shape will be ignored in all collision detection. @@ -2103,7 +2103,7 @@ Sets the disabled property of the body's shape with the given index. If ``disabl .. rst-class:: classref-method -void **body_set_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** +|void| **body_set_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) Sets the local transform matrix of the body's shape with the given index. @@ -2115,7 +2115,7 @@ Sets the local transform matrix of the body's shape with the given index. .. rst-class:: classref-method -void **body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** +|void| **body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) Adds the body to the given space, after removing the body from the previously assigned space (if any). If the body's mode is set to :ref:`BODY_MODE_RIGID`, then adding the body to a space will have the following additional effects: @@ -2133,7 +2133,7 @@ Adds the body to the given space, after removing the body from the previously as .. rst-class:: classref-method -void **body_set_state** **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** +|void| **body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) Sets the value of a body's state. See :ref:`BodyState` for the list of available states. @@ -2147,7 +2147,7 @@ Sets the value of a body's state. See :ref:`BodyState` **body_test_motion** **(** :ref:`RID` body, :ref:`PhysicsTestMotionParameters2D` parameters, :ref:`PhysicsTestMotionResult2D` result=null **)** +:ref:`bool` **body_test_motion**\ (\ body\: :ref:`RID`, parameters\: :ref:`PhysicsTestMotionParameters2D`, result\: :ref:`PhysicsTestMotionResult2D` = null\ ) Returns ``true`` if a collision would result from moving the body along a motion vector from a given point in space. See :ref:`PhysicsTestMotionParameters2D` for the available motion parameters. Optionally a :ref:`PhysicsTestMotionResult2D` object can be passed, which will be used to store the information about the resulting collision. @@ -2159,7 +2159,7 @@ Returns ``true`` if a collision would result from moving the body along a motion .. rst-class:: classref-method -:ref:`RID` **capsule_shape_create** **(** **)** +:ref:`RID` **capsule_shape_create**\ (\ ) Creates a 2D capsule shape in the physics server, and returns the :ref:`RID` that identifies it. Use :ref:`shape_set_data` to set the capsule's height and radius. @@ -2171,7 +2171,7 @@ Creates a 2D capsule shape in the physics server, and returns the :ref:`RID` **circle_shape_create** **(** **)** +:ref:`RID` **circle_shape_create**\ (\ ) Creates a 2D circle shape in the physics server, and returns the :ref:`RID` that identifies it. Use :ref:`shape_set_data` to set the circle's radius. @@ -2183,7 +2183,7 @@ Creates a 2D circle shape in the physics server, and returns the :ref:`RID` **concave_polygon_shape_create** **(** **)** +:ref:`RID` **concave_polygon_shape_create**\ (\ ) Creates a 2D concave polygon shape in the physics server, and returns the :ref:`RID` that identifies it. Use :ref:`shape_set_data` to set the concave polygon's segments. @@ -2195,7 +2195,7 @@ Creates a 2D concave polygon shape in the physics server, and returns the :ref:` .. rst-class:: classref-method -:ref:`RID` **convex_polygon_shape_create** **(** **)** +:ref:`RID` **convex_polygon_shape_create**\ (\ ) Creates a 2D convex polygon shape in the physics server, and returns the :ref:`RID` that identifies it. Use :ref:`shape_set_data` to set the convex polygon's points. @@ -2207,7 +2207,7 @@ Creates a 2D convex polygon shape in the physics server, and returns the :ref:`R .. rst-class:: classref-method -:ref:`float` **damped_spring_joint_get_param** **(** :ref:`RID` joint, :ref:`DampedSpringParam` param **)** |const| +:ref:`float` **damped_spring_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`\ ) |const| Returns the value of the given damped spring joint parameter. See :ref:`DampedSpringParam` for the list of available parameters. @@ -2219,7 +2219,7 @@ Returns the value of the given damped spring joint parameter. See :ref:`DampedSp .. rst-class:: classref-method -void **damped_spring_joint_set_param** **(** :ref:`RID` joint, :ref:`DampedSpringParam` param, :ref:`float` value **)** +|void| **damped_spring_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`, value\: :ref:`float`\ ) Sets the value of the given damped spring joint parameter. See :ref:`DampedSpringParam` for the list of available parameters. @@ -2231,7 +2231,7 @@ Sets the value of the given damped spring joint parameter. See :ref:`DampedSprin .. rst-class:: classref-method -void **free_rid** **(** :ref:`RID` rid **)** +|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) Destroys any of the objects created by PhysicsServer2D. If the :ref:`RID` passed is not one of the objects that can be created by PhysicsServer2D, an error will be printed to the console. @@ -2243,7 +2243,7 @@ Destroys any of the objects created by PhysicsServer2D. If the :ref:`RID` **get_process_info** **(** :ref:`ProcessInfo` process_info **)** +:ref:`int` **get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) Returns information about the current state of the 2D physics engine. See :ref:`ProcessInfo` for the list of available states. @@ -2255,7 +2255,7 @@ Returns information about the current state of the 2D physics engine. See :ref:` .. rst-class:: classref-method -void **joint_clear** **(** :ref:`RID` joint **)** +|void| **joint_clear**\ (\ joint\: :ref:`RID`\ ) Destroys the joint with the given :ref:`RID`, creates a new uninitialized joint, and makes the :ref:`RID` refer to this new joint. @@ -2267,7 +2267,7 @@ Destroys the joint with the given :ref:`RID`, creates a new uninitial .. rst-class:: classref-method -:ref:`RID` **joint_create** **(** **)** +:ref:`RID` **joint_create**\ (\ ) Creates a 2D joint in the physics server, and returns the :ref:`RID` that identifies it. To set the joint type, use :ref:`joint_make_damped_spring`, :ref:`joint_make_groove` or :ref:`joint_make_pin`. Use :ref:`joint_set_param` to set generic joint parameters. @@ -2279,7 +2279,7 @@ Creates a 2D joint in the physics server, and returns the :ref:`RID` .. rst-class:: classref-method -void **joint_disable_collisions_between_bodies** **(** :ref:`RID` joint, :ref:`bool` disable **)** +|void| **joint_disable_collisions_between_bodies**\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) Sets whether the bodies attached to the :ref:`Joint2D` will collide with each other. @@ -2291,7 +2291,7 @@ Sets whether the bodies attached to the :ref:`Joint2D` will colli .. rst-class:: classref-method -:ref:`float` **joint_get_param** **(** :ref:`RID` joint, :ref:`JointParam` param **)** |const| +:ref:`float` **joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`\ ) |const| Returns the value of the given joint parameter. See :ref:`JointParam` for the list of available parameters. @@ -2303,7 +2303,7 @@ Returns the value of the given joint parameter. See :ref:`JointParam` **joint_get_type** **(** :ref:`RID` joint **)** |const| +:ref:`JointType` **joint_get_type**\ (\ joint\: :ref:`RID`\ ) |const| Returns the joint's type (see :ref:`JointType`). @@ -2315,7 +2315,7 @@ Returns the joint's type (see :ref:`JointType`). .. rst-class:: classref-method -:ref:`bool` **joint_is_disabled_collisions_between_bodies** **(** :ref:`RID` joint **)** |const| +:ref:`bool` **joint_is_disabled_collisions_between_bodies**\ (\ joint\: :ref:`RID`\ ) |const| Returns whether the bodies attached to the :ref:`Joint2D` will collide with each other. @@ -2327,7 +2327,7 @@ Returns whether the bodies attached to the :ref:`Joint2D` will co .. rst-class:: classref-method -void **joint_make_damped_spring** **(** :ref:`RID` joint, :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** +|void| **joint_make_damped_spring**\ (\ joint\: :ref:`RID`, anchor_a\: :ref:`Vector2`, anchor_b\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID` = RID()\ ) Makes the joint a damped spring joint, attached at the point ``anchor_a`` (given in global coordinates) on the body ``body_a`` and at the point ``anchor_b`` (given in global coordinates) on the body ``body_b``. To set the parameters which are specific to the damped spring, see :ref:`damped_spring_joint_set_param`. @@ -2339,7 +2339,7 @@ Makes the joint a damped spring joint, attached at the point ``anchor_a`` (given .. rst-class:: classref-method -void **joint_make_groove** **(** :ref:`RID` joint, :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a=RID(), :ref:`RID` body_b=RID() **)** +|void| **joint_make_groove**\ (\ joint\: :ref:`RID`, groove1_a\: :ref:`Vector2`, groove2_a\: :ref:`Vector2`, anchor_b\: :ref:`Vector2`, body_a\: :ref:`RID` = RID(), body_b\: :ref:`RID` = RID()\ ) Makes the joint a groove joint. @@ -2351,7 +2351,7 @@ Makes the joint a groove joint. .. rst-class:: classref-method -void **joint_make_pin** **(** :ref:`RID` joint, :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** +|void| **joint_make_pin**\ (\ joint\: :ref:`RID`, anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID` = RID()\ ) Makes the joint a pin joint. If ``body_b`` is an empty :ref:`RID`, then ``body_a`` is pinned to the point ``anchor`` (given in global coordinates); otherwise, ``body_a`` is pinned to ``body_b`` at the point ``anchor`` (given in global coordinates). To set the parameters which are specific to the pin joint, see :ref:`pin_joint_set_param`. @@ -2363,7 +2363,7 @@ Makes the joint a pin joint. If ``body_b`` is an empty :ref:`RID`, th .. rst-class:: classref-method -void **joint_set_param** **(** :ref:`RID` joint, :ref:`JointParam` param, :ref:`float` value **)** +|void| **joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`, value\: :ref:`float`\ ) Sets the value of the given joint parameter. See :ref:`JointParam` for the list of available parameters. @@ -2375,7 +2375,7 @@ Sets the value of the given joint parameter. See :ref:`JointParam` **pin_joint_get_flag** **(** :ref:`RID` joint, :ref:`PinJointFlag` flag **)** |const| +:ref:`bool` **pin_joint_get_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`\ ) |const| Gets a pin joint flag (see :ref:`PinJointFlag` constants). @@ -2387,7 +2387,7 @@ Gets a pin joint flag (see :ref:`PinJointFlag .. rst-class:: classref-method -:ref:`float` **pin_joint_get_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** |const| +:ref:`float` **pin_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |const| Returns the value of a pin joint parameter. See :ref:`PinJointParam` for a list of available parameters. @@ -2399,7 +2399,7 @@ Returns the value of a pin joint parameter. See :ref:`PinJointParam` joint, :ref:`PinJointFlag` flag, :ref:`bool` enabled **)** +|void| **pin_joint_set_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`, enabled\: :ref:`bool`\ ) Sets a pin joint flag (see :ref:`PinJointFlag` constants). @@ -2411,7 +2411,7 @@ Sets a pin joint flag (see :ref:`PinJointFlag .. rst-class:: classref-method -void **pin_joint_set_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** +|void| **pin_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) Sets a pin joint parameter. See :ref:`PinJointParam` for a list of available parameters. @@ -2423,7 +2423,7 @@ Sets a pin joint parameter. See :ref:`PinJointParam` **rectangle_shape_create** **(** **)** +:ref:`RID` **rectangle_shape_create**\ (\ ) Creates a 2D rectangle shape in the physics server, and returns the :ref:`RID` that identifies it. Use :ref:`shape_set_data` to set the rectangle's half-extents. @@ -2435,7 +2435,7 @@ Creates a 2D rectangle shape in the physics server, and returns the :ref:`RID` **segment_shape_create** **(** **)** +:ref:`RID` **segment_shape_create**\ (\ ) Creates a 2D segment shape in the physics server, and returns the :ref:`RID` that identifies it. Use :ref:`shape_set_data` to set the segment's start and end points. @@ -2447,7 +2447,7 @@ Creates a 2D segment shape in the physics server, and returns the :ref:`RID` **separation_ray_shape_create** **(** **)** +:ref:`RID` **separation_ray_shape_create**\ (\ ) Creates a 2D separation ray shape in the physics server, and returns the :ref:`RID` that identifies it. Use :ref:`shape_set_data` to set the shape's ``length`` and ``slide_on_slope`` properties. @@ -2459,7 +2459,7 @@ Creates a 2D separation ray shape in the physics server, and returns the :ref:`R .. rst-class:: classref-method -void **set_active** **(** :ref:`bool` active **)** +|void| **set_active**\ (\ active\: :ref:`bool`\ ) Activates or deactivates the 2D physics server. If ``active`` is ``false``, then the physics server will not do anything in its physics step. @@ -2471,7 +2471,7 @@ Activates or deactivates the 2D physics server. If ``active`` is ``false``, then .. rst-class:: classref-method -:ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** |const| +:ref:`Variant` **shape_get_data**\ (\ shape\: :ref:`RID`\ ) |const| Returns the shape data that defines the configuration of the shape, such as the half-extents of a rectangle or the segments of a concave shape. See :ref:`shape_set_data` for the precise format of this data in each case. @@ -2483,7 +2483,7 @@ Returns the shape data that defines the configuration of the shape, such as the .. rst-class:: classref-method -:ref:`ShapeType` **shape_get_type** **(** :ref:`RID` shape **)** |const| +:ref:`ShapeType` **shape_get_type**\ (\ shape\: :ref:`RID`\ ) |const| Returns the shape's type (see :ref:`ShapeType`). @@ -2495,7 +2495,7 @@ Returns the shape's type (see :ref:`ShapeType`). .. rst-class:: classref-method -void **shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` data **)** +|void| **shape_set_data**\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) Sets the shape data that defines the configuration of the shape. The ``data`` to be passed depends on the shape's type (see :ref:`shape_get_type`): @@ -2525,7 +2525,7 @@ Sets the shape data that defines the configuration of the shape. The ``data`` to .. rst-class:: classref-method -:ref:`RID` **space_create** **(** **)** +:ref:`RID` **space_create**\ (\ ) Creates a 2D space in the physics server, and returns the :ref:`RID` that identifies it. A space contains bodies and areas, and controls the stepping of the physics simulation of the objects in it. @@ -2537,7 +2537,7 @@ Creates a 2D space in the physics server, and returns the :ref:`RID` .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState2D` **space_get_direct_state** **(** :ref:`RID` space **)** +:ref:`PhysicsDirectSpaceState2D` **space_get_direct_state**\ (\ space\: :ref:`RID`\ ) Returns the state of a space, a :ref:`PhysicsDirectSpaceState2D`. This object can be used for collision/intersection queries. @@ -2549,7 +2549,7 @@ Returns the state of a space, a :ref:`PhysicsDirectSpaceState2D` **space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** |const| +:ref:`float` **space_get_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |const| Returns the value of the given space parameter. See :ref:`SpaceParameter` for the list of available parameters. @@ -2561,7 +2561,7 @@ Returns the value of the given space parameter. See :ref:`SpaceParameter` **space_is_active** **(** :ref:`RID` space **)** |const| +:ref:`bool` **space_is_active**\ (\ space\: :ref:`RID`\ ) |const| Returns ``true`` if the space is active. @@ -2573,7 +2573,7 @@ Returns ``true`` if the space is active. .. rst-class:: classref-method -void **space_set_active** **(** :ref:`RID` space, :ref:`bool` active **)** +|void| **space_set_active**\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) Activates or deactivates the space. If ``active`` is ``false``, then the physics server will not do anything with this space in its physics step. @@ -2585,7 +2585,7 @@ Activates or deactivates the space. If ``active`` is ``false``, then the physics .. rst-class:: classref-method -void **space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** +|void| **space_set_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) Sets the value of the given space parameter. See :ref:`SpaceParameter` for the list of available parameters. @@ -2597,7 +2597,7 @@ Sets the value of the given space parameter. See :ref:`SpaceParameter` **world_boundary_shape_create** **(** **)** +:ref:`RID` **world_boundary_shape_create**\ (\ ) Creates a 2D world boundary shape in the physics server, and returns the :ref:`RID` that identifies it. Use :ref:`shape_set_data` to set the shape's normal direction and distance properties. @@ -2608,3 +2608,4 @@ Creates a 2D world boundary shape in the physics server, and returns the :ref:`R .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsserver2dextension.rst b/classes/class_physicsserver2dextension.rst index 1287a45b8ef..066de7755af 100644 --- a/classes/class_physicsserver2dextension.rst +++ b/classes/class_physicsserver2dextension.rst @@ -31,287 +31,287 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform, :ref:`bool` disabled **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_attach_canvas_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_clear_shapes` **(** :ref:`RID` area **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_area_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_canvas_instance_id` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_collision_layer` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_collision_mask` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_object_instance_id` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_area_get_param` **(** :ref:`RID` area, :ref:`AreaParameter` param **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_shape_count` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`_area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_area_get_space` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`_area_get_transform` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Callable` callback **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Callable` callback **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_monitorable` **(** :ref:`RID` area, :ref:`bool` monitorable **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_param` **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_pickable` **(** :ref:`RID` area, :ref:`bool` pickable **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_shape_disabled` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_transform` **(** :ref:`RID` area, :ref:`Transform2D` transform **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_add_constant_central_force` **(** :ref:`RID` body, :ref:`Vector2` force **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_add_constant_force` **(** :ref:`RID` body, :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_add_constant_torque` **(** :ref:`RID` body, :ref:`float` torque **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform, :ref:`bool` disabled **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_apply_central_force` **(** :ref:`RID` body, :ref:`Vector2` force **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector2` impulse **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_apply_force` **(** :ref:`RID` body, :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` impulse, :ref:`Vector2` position **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_apply_torque` **(** :ref:`RID` body, :ref:`float` torque **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`float` impulse **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_attach_canvas_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_clear_shapes` **(** :ref:`RID` body **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_body_collide_shape` **(** :ref:`RID` body, :ref:`int` body_shape, :ref:`RID` shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` motion, void* results, :ref:`int` result_max, int32_t* result_count **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_body_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_canvas_instance_id` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`_body_get_collision_exceptions` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_collision_layer` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_collision_mask` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_body_get_collision_priority` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_body_get_constant_force` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_body_get_constant_torque` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_body_get_contacts_reported_depth_threshold` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`CCDMode` | :ref:`_body_get_continuous_collision_detection_mode` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectBodyState2D` | :ref:`_body_get_direct_state` **(** :ref:`RID` body **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_max_contacts_reported` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`BodyMode` | :ref:`_body_get_mode` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_object_instance_id` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_body_get_param` **(** :ref:`RID` body, :ref:`BodyParameter` param **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_shape_count` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`_body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_body_get_space` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_body_is_omitting_force_integration` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_reset_mass_properties` **(** :ref:`RID` body **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_collision_priority` **(** :ref:`RID` body, :ref:`float` priority **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_constant_force` **(** :ref:`RID` body, :ref:`Vector2` force **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_constant_torque` **(** :ref:`RID` body, :ref:`float` torque **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_contacts_reported_depth_threshold` **(** :ref:`RID` body, :ref:`float` threshold **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_continuous_collision_detection_mode` **(** :ref:`RID` body, :ref:`CCDMode` mode **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Callable` callable, :ref:`Variant` userdata **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_mode` **(** :ref:`RID` body, :ref:`BodyMode` mode **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_param` **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`Variant` value **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_pickable` **(** :ref:`RID` body, :ref:`bool` pickable **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_shape_as_one_way_collision` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable, :ref:`float` margin **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_shape_disabled` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_state_sync_callback` **(** :ref:`RID` body, :ref:`Callable` callable **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_body_test_motion` **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin, :ref:`bool` collide_separation_ray, :ref:`bool` recovery_as_collision, PhysicsServer2DExtensionMotionResult* result **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_capsule_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_circle_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_concave_polygon_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_convex_polygon_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_damped_spring_joint_get_param` **(** :ref:`RID` joint, :ref:`DampedSpringParam` param **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_damped_spring_joint_set_param` **(** :ref:`RID` joint, :ref:`DampedSpringParam` param, :ref:`float` value **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_end_sync` **(** **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_finish` **(** **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_flush_queries` **(** **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_free_rid` **(** :ref:`RID` rid **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_process_info` **(** :ref:`ProcessInfo` process_info **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_init` **(** **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_flushing_queries` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_clear` **(** :ref:`RID` joint **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_joint_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_disable_collisions_between_bodies` **(** :ref:`RID` joint, :ref:`bool` disable **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_joint_get_param` **(** :ref:`RID` joint, :ref:`JointParam` param **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`JointType` | :ref:`_joint_get_type` **(** :ref:`RID` joint **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_joint_is_disabled_collisions_between_bodies` **(** :ref:`RID` joint **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_make_damped_spring` **(** :ref:`RID` joint, :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_make_groove` **(** :ref:`RID` joint, :ref:`Vector2` a_groove1, :ref:`Vector2` a_groove2, :ref:`Vector2` b_anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_make_pin` **(** :ref:`RID` joint, :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_set_param` **(** :ref:`RID` joint, :ref:`JointParam` param, :ref:`float` value **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_pin_joint_get_flag` **(** :ref:`RID` joint, :ref:`PinJointFlag` flag **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_pin_joint_get_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_pin_joint_set_flag` **(** :ref:`RID` joint, :ref:`PinJointFlag` flag, :ref:`bool` enabled **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_pin_joint_set_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_rectangle_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_segment_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_separation_ray_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_active` **(** :ref:`bool` active **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shape_collide` **(** :ref:`RID` shape_A, :ref:`Transform2D` xform_A, :ref:`Vector2` motion_A, :ref:`RID` shape_B, :ref:`Transform2D` xform_B, :ref:`Vector2` motion_B, void* results, :ref:`int` result_max, int32_t* result_count **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shape_get_custom_solver_bias` **(** :ref:`RID` shape **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_shape_get_data` **(** :ref:`RID` shape **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ShapeType` | :ref:`_shape_get_type` **(** :ref:`RID` shape **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shape_set_custom_solver_bias` **(** :ref:`RID` shape, :ref:`float` bias **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_space_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_space_get_contact_count` **(** :ref:`RID` space **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`_space_get_contacts` **(** :ref:`RID` space **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectSpaceState2D` | :ref:`_space_get_direct_state` **(** :ref:`RID` space **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_space_is_active` **(** :ref:`RID` space **)** |virtual| |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_space_set_debug_contacts` **(** :ref:`RID` space, :ref:`int` max_contacts **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_space_set_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_step` **(** :ref:`float` step **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_sync` **(** **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_world_boundary_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`body_test_motion_is_excluding_body` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`body_test_motion_is_excluding_object` **(** :ref:`int` object **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_add_shape`\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D`, disabled\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_attach_canvas_instance_id`\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_attach_object_instance_id`\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_clear_shapes`\ (\ area\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_area_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_canvas_instance_id`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_collision_layer`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_collision_mask`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_object_instance_id`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_area_get_param`\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_area_get_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_shape_count`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`_area_get_shape_transform`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_area_get_space`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`_area_get_transform`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_remove_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_area_monitor_callback`\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_collision_layer`\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_collision_mask`\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_monitor_callback`\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_monitorable`\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_param`\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_pickable`\ (\ area\: :ref:`RID`, pickable\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_shape_disabled`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_shape_transform`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_space`\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_transform`\ (\ area\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_collision_exception`\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_constant_central_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_constant_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_constant_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_shape`\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D`, disabled\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_central_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_central_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_torque_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_attach_canvas_instance_id`\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_attach_object_instance_id`\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_clear_shapes`\ (\ body\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_body_collide_shape`\ (\ body\: :ref:`RID`, body_shape\: :ref:`int`, shape\: :ref:`RID`, shape_xform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, results\: ``void*``, result_max\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_body_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_canvas_instance_id`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`_body_get_collision_exceptions`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_collision_layer`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_collision_mask`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_body_get_collision_priority`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_body_get_constant_force`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_body_get_constant_torque`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_body_get_contacts_reported_depth_threshold`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CCDMode` | :ref:`_body_get_continuous_collision_detection_mode`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectBodyState2D` | :ref:`_body_get_direct_state`\ (\ body\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_max_contacts_reported`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`BodyMode` | :ref:`_body_get_mode`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_object_instance_id`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_body_get_param`\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_body_get_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_shape_count`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`_body_get_shape_transform`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_body_get_space`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_body_get_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_body_is_omitting_force_integration`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_remove_collision_exception`\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_remove_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_reset_mass_properties`\ (\ body\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_axis_velocity`\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector2`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_collision_layer`\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_collision_mask`\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_collision_priority`\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_constant_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_constant_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_contacts_reported_depth_threshold`\ (\ body\: :ref:`RID`, threshold\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_continuous_collision_detection_mode`\ (\ body\: :ref:`RID`, mode\: :ref:`CCDMode`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_force_integration_callback`\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_max_contacts_reported`\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_mode`\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_omit_force_integration`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_param`\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_pickable`\ (\ body\: :ref:`RID`, pickable\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_shape_as_one_way_collision`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, enable\: :ref:`bool`, margin\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_shape_disabled`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_shape_transform`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_space`\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_state_sync_callback`\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_body_test_motion`\ (\ body\: :ref:`RID`, from\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collide_separation_ray\: :ref:`bool`, recovery_as_collision\: :ref:`bool`, result\: ``PhysicsServer2DExtensionMotionResult*``\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_capsule_shape_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_circle_shape_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_concave_polygon_shape_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_convex_polygon_shape_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_damped_spring_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_damped_spring_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`, value\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_end_sync`\ (\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_finish`\ (\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_flush_queries`\ (\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_free_rid`\ (\ rid\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_process_info`\ (\ process_info\: :ref:`ProcessInfo`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_init`\ (\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_flushing_queries`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_clear`\ (\ joint\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_joint_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_disable_collisions_between_bodies`\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`JointType` | :ref:`_joint_get_type`\ (\ joint\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_joint_is_disabled_collisions_between_bodies`\ (\ joint\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_make_damped_spring`\ (\ joint\: :ref:`RID`, anchor_a\: :ref:`Vector2`, anchor_b\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_make_groove`\ (\ joint\: :ref:`RID`, a_groove1\: :ref:`Vector2`, a_groove2\: :ref:`Vector2`, b_anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_make_pin`\ (\ joint\: :ref:`RID`, anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`, value\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_pin_joint_get_flag`\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_pin_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_pin_joint_set_flag`\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`, enabled\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_pin_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_rectangle_shape_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_segment_shape_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_separation_ray_shape_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_active`\ (\ active\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shape_collide`\ (\ shape_A\: :ref:`RID`, xform_A\: :ref:`Transform2D`, motion_A\: :ref:`Vector2`, shape_B\: :ref:`RID`, xform_B\: :ref:`Transform2D`, motion_B\: :ref:`Vector2`, results\: ``void*``, result_max\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shape_get_custom_solver_bias`\ (\ shape\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_shape_get_data`\ (\ shape\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ShapeType` | :ref:`_shape_get_type`\ (\ shape\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shape_set_custom_solver_bias`\ (\ shape\: :ref:`RID`, bias\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shape_set_data`\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_space_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_space_get_contact_count`\ (\ space\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`_space_get_contacts`\ (\ space\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectSpaceState2D` | :ref:`_space_get_direct_state`\ (\ space\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_space_get_param`\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_space_is_active`\ (\ space\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_space_set_active`\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_space_set_debug_contacts`\ (\ space\: :ref:`RID`, max_contacts\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_space_set_param`\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_step`\ (\ step\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_sync`\ (\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_world_boundary_shape_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`body_test_motion_is_excluding_body`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`body_test_motion_is_excluding_object`\ (\ object\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -326,7 +326,7 @@ Method Descriptions .. rst-class:: classref-method -void **_area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform, :ref:`bool` disabled **)** |virtual| +|void| **_area_add_shape**\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D`, disabled\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -340,7 +340,7 @@ void **_area_add_shape** **(** :ref:`RID` area, :ref:`RID` .. rst-class:: classref-method -void **_area_attach_canvas_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** |virtual| +|void| **_area_attach_canvas_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -354,7 +354,7 @@ void **_area_attach_canvas_instance_id** **(** :ref:`RID` area, :ref: .. rst-class:: classref-method -void **_area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** |virtual| +|void| **_area_attach_object_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -368,7 +368,7 @@ void **_area_attach_object_instance_id** **(** :ref:`RID` area, :ref: .. rst-class:: classref-method -void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| +|void| **_area_clear_shapes**\ (\ area\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -382,7 +382,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_area_create** **(** **)** |virtual| +:ref:`RID` **_area_create**\ (\ ) |virtual| .. container:: contribute @@ -396,7 +396,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_area_get_canvas_instance_id** **(** :ref:`RID` area **)** |virtual| |const| +:ref:`int` **_area_get_canvas_instance_id**\ (\ area\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -410,7 +410,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_area_get_collision_layer** **(** :ref:`RID` area **)** |virtual| |const| +:ref:`int` **_area_get_collision_layer**\ (\ area\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -424,7 +424,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_area_get_collision_mask** **(** :ref:`RID` area **)** |virtual| |const| +:ref:`int` **_area_get_collision_mask**\ (\ area\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -438,7 +438,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_area_get_object_instance_id** **(** :ref:`RID` area **)** |virtual| |const| +:ref:`int` **_area_get_object_instance_id**\ (\ area\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -452,7 +452,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`Variant` **_area_get_param** **(** :ref:`RID` area, :ref:`AreaParameter` param **)** |virtual| |const| +:ref:`Variant` **_area_get_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |virtual| |const| .. container:: contribute @@ -466,7 +466,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| +:ref:`RID` **_area_get_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -480,7 +480,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_area_get_shape_count** **(** :ref:`RID` area **)** |virtual| |const| +:ref:`int` **_area_get_shape_count**\ (\ area\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -494,7 +494,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`Transform2D` **_area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| +:ref:`Transform2D` **_area_get_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -508,7 +508,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_area_get_space** **(** :ref:`RID` area **)** |virtual| |const| +:ref:`RID` **_area_get_space**\ (\ area\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -522,7 +522,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`Transform2D` **_area_get_transform** **(** :ref:`RID` area **)** |virtual| |const| +:ref:`Transform2D` **_area_get_transform**\ (\ area\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -536,7 +536,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -void **_area_remove_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| +|void| **_area_remove_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -550,7 +550,7 @@ void **_area_remove_shape** **(** :ref:`RID` area, :ref:`int` area, :ref:`Callable` callback **)** |virtual| +|void| **_area_set_area_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| .. container:: contribute @@ -564,7 +564,7 @@ void **_area_set_area_monitor_callback** **(** :ref:`RID` area, :ref: .. rst-class:: classref-method -void **_area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** |virtual| +|void| **_area_set_collision_layer**\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -578,7 +578,7 @@ void **_area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` area, :ref:`int` mask **)** |virtual| +|void| **_area_set_collision_mask**\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -592,7 +592,7 @@ void **_area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` area, :ref:`Callable` callback **)** |virtual| +|void| **_area_set_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| .. container:: contribute @@ -606,7 +606,7 @@ void **_area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Call .. rst-class:: classref-method -void **_area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** |virtual| +|void| **_area_set_monitorable**\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -620,7 +620,7 @@ void **_area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** |virtual| +|void| **_area_set_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) |virtual| .. container:: contribute @@ -634,7 +634,7 @@ void **_area_set_param** **(** :ref:`RID` area, :ref:`AreaParameter` area, :ref:`bool` pickable **)** |virtual| +|void| **_area_set_pickable**\ (\ area\: :ref:`RID`, pickable\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -648,7 +648,7 @@ void **_area_set_pickable** **(** :ref:`RID` area, :ref:`bool` area, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| +|void| **_area_set_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -662,7 +662,7 @@ void **_area_set_shape** **(** :ref:`RID` area, :ref:`int` .. rst-class:: classref-method -void **_area_set_shape_disabled** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| +|void| **_area_set_shape_disabled**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -676,7 +676,7 @@ void **_area_set_shape_disabled** **(** :ref:`RID` area, :ref:`int` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** |virtual| +|void| **_area_set_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) |virtual| .. container:: contribute @@ -690,7 +690,7 @@ void **_area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` area, :ref:`RID` space **)** |virtual| +|void| **_area_set_space**\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -704,7 +704,7 @@ void **_area_set_space** **(** :ref:`RID` area, :ref:`RID` .. rst-class:: classref-method -void **_area_set_transform** **(** :ref:`RID` area, :ref:`Transform2D` transform **)** |virtual| +|void| **_area_set_transform**\ (\ area\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) |virtual| .. container:: contribute @@ -718,7 +718,7 @@ void **_area_set_transform** **(** :ref:`RID` area, :ref:`Transform2D .. rst-class:: classref-method -void **_body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| +|void| **_body_add_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -732,7 +732,7 @@ void **_body_add_collision_exception** **(** :ref:`RID` body, :ref:`R .. rst-class:: classref-method -void **_body_add_constant_central_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** |virtual| +|void| **_body_add_constant_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -746,7 +746,7 @@ void **_body_add_constant_central_force** **(** :ref:`RID` body, :ref .. rst-class:: classref-method -void **_body_add_constant_force** **(** :ref:`RID` body, :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| +|void| **_body_add_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -760,7 +760,7 @@ void **_body_add_constant_force** **(** :ref:`RID` body, :ref:`Vector .. rst-class:: classref-method -void **_body_add_constant_torque** **(** :ref:`RID` body, :ref:`float` torque **)** |virtual| +|void| **_body_add_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -774,7 +774,7 @@ void **_body_add_constant_torque** **(** :ref:`RID` body, :ref:`float .. rst-class:: classref-method -void **_body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform, :ref:`bool` disabled **)** |virtual| +|void| **_body_add_shape**\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform2D`, disabled\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -788,7 +788,7 @@ void **_body_add_shape** **(** :ref:`RID` body, :ref:`RID` .. rst-class:: classref-method -void **_body_apply_central_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** |virtual| +|void| **_body_apply_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -802,7 +802,7 @@ void **_body_apply_central_force** **(** :ref:`RID` body, :ref:`Vecto .. rst-class:: classref-method -void **_body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector2` impulse **)** |virtual| +|void| **_body_apply_central_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -816,7 +816,7 @@ void **_body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vec .. rst-class:: classref-method -void **_body_apply_force** **(** :ref:`RID` body, :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| +|void| **_body_apply_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -830,7 +830,7 @@ void **_body_apply_force** **(** :ref:`RID` body, :ref:`Vector2` body, :ref:`Vector2` impulse, :ref:`Vector2` position **)** |virtual| +|void| **_body_apply_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector2`, position\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -844,7 +844,7 @@ void **_body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector2` body, :ref:`float` torque **)** |virtual| +|void| **_body_apply_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -858,7 +858,7 @@ void **_body_apply_torque** **(** :ref:`RID` body, :ref:`float` body, :ref:`float` impulse **)** |virtual| +|void| **_body_apply_torque_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -872,7 +872,7 @@ void **_body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`floa .. rst-class:: classref-method -void **_body_attach_canvas_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** |virtual| +|void| **_body_attach_canvas_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -886,7 +886,7 @@ void **_body_attach_canvas_instance_id** **(** :ref:`RID` body, :ref: .. rst-class:: classref-method -void **_body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** |virtual| +|void| **_body_attach_object_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -900,7 +900,7 @@ void **_body_attach_object_instance_id** **(** :ref:`RID` body, :ref: .. rst-class:: classref-method -void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| +|void| **_body_clear_shapes**\ (\ body\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -914,7 +914,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_body_collide_shape** **(** :ref:`RID` body, :ref:`int` body_shape, :ref:`RID` shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` motion, void* results, :ref:`int` result_max, int32_t* result_count **)** |virtual| +:ref:`bool` **_body_collide_shape**\ (\ body\: :ref:`RID`, body_shape\: :ref:`int`, shape\: :ref:`RID`, shape_xform\: :ref:`Transform2D`, motion\: :ref:`Vector2`, results\: ``void*``, result_max\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| .. container:: contribute @@ -928,7 +928,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_body_create** **(** **)** |virtual| +:ref:`RID` **_body_create**\ (\ ) |virtual| .. container:: contribute @@ -942,7 +942,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_body_get_canvas_instance_id** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`int` **_body_get_canvas_instance_id**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -956,7 +956,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`RID[]` **_body_get_collision_exceptions** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`Array`\[:ref:`RID`\] **_body_get_collision_exceptions**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -970,7 +970,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_body_get_collision_layer** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`int` **_body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -984,7 +984,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_body_get_collision_mask** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`int` **_body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -998,7 +998,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`float` **_body_get_collision_priority** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`float` **_body_get_collision_priority**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1012,7 +1012,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`Vector2` **_body_get_constant_force** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`Vector2` **_body_get_constant_force**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1026,7 +1026,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`float` **_body_get_constant_torque** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`float` **_body_get_constant_torque**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1040,7 +1040,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`float` **_body_get_contacts_reported_depth_threshold** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`float` **_body_get_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1054,7 +1054,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`CCDMode` **_body_get_continuous_collision_detection_mode** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`CCDMode` **_body_get_continuous_collision_detection_mode**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1068,7 +1068,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`PhysicsDirectBodyState2D` **_body_get_direct_state** **(** :ref:`RID` body **)** |virtual| +:ref:`PhysicsDirectBodyState2D` **_body_get_direct_state**\ (\ body\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -1082,7 +1082,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_body_get_max_contacts_reported** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`int` **_body_get_max_contacts_reported**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1096,7 +1096,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`BodyMode` **_body_get_mode** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`BodyMode` **_body_get_mode**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1110,7 +1110,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_body_get_object_instance_id** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`int` **_body_get_object_instance_id**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1124,7 +1124,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`Variant` **_body_get_param** **(** :ref:`RID` body, :ref:`BodyParameter` param **)** |virtual| |const| +:ref:`Variant` **_body_get_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |virtual| |const| .. container:: contribute @@ -1138,7 +1138,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| +:ref:`RID` **_body_get_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -1152,7 +1152,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_body_get_shape_count** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`int` **_body_get_shape_count**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1166,7 +1166,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`Transform2D` **_body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| +:ref:`Transform2D` **_body_get_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -1180,7 +1180,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_body_get_space** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`RID` **_body_get_space**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1194,7 +1194,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`Variant` **_body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** |virtual| |const| +:ref:`Variant` **_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |const| .. container:: contribute @@ -1208,7 +1208,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_body_is_omitting_force_integration** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`bool` **_body_is_omitting_force_integration**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1222,7 +1222,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -void **_body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| +|void| **_body_remove_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -1236,7 +1236,7 @@ void **_body_remove_collision_exception** **(** :ref:`RID` body, :ref .. rst-class:: classref-method -void **_body_remove_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| +|void| **_body_remove_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1250,7 +1250,7 @@ void **_body_remove_shape** **(** :ref:`RID` body, :ref:`int` body **)** |virtual| +|void| **_body_reset_mass_properties**\ (\ body\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -1264,7 +1264,7 @@ void **_body_reset_mass_properties** **(** :ref:`RID` body **)** |vir .. rst-class:: classref-method -void **_body_set_axis_velocity** **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** |virtual| +|void| **_body_set_axis_velocity**\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -1278,7 +1278,7 @@ void **_body_set_axis_velocity** **(** :ref:`RID` body, :ref:`Vector2 .. rst-class:: classref-method -void **_body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** |virtual| +|void| **_body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1292,7 +1292,7 @@ void **_body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` body, :ref:`int` mask **)** |virtual| +|void| **_body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1306,7 +1306,7 @@ void **_body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` body, :ref:`float` priority **)** |virtual| +|void| **_body_set_collision_priority**\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1320,7 +1320,7 @@ void **_body_set_collision_priority** **(** :ref:`RID` body, :ref:`fl .. rst-class:: classref-method -void **_body_set_constant_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** |virtual| +|void| **_body_set_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -1334,7 +1334,7 @@ void **_body_set_constant_force** **(** :ref:`RID` body, :ref:`Vector .. rst-class:: classref-method -void **_body_set_constant_torque** **(** :ref:`RID` body, :ref:`float` torque **)** |virtual| +|void| **_body_set_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1348,7 +1348,7 @@ void **_body_set_constant_torque** **(** :ref:`RID` body, :ref:`float .. rst-class:: classref-method -void **_body_set_contacts_reported_depth_threshold** **(** :ref:`RID` body, :ref:`float` threshold **)** |virtual| +|void| **_body_set_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`, threshold\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1362,7 +1362,7 @@ void **_body_set_contacts_reported_depth_threshold** **(** :ref:`RID` .. rst-class:: classref-method -void **_body_set_continuous_collision_detection_mode** **(** :ref:`RID` body, :ref:`CCDMode` mode **)** |virtual| +|void| **_body_set_continuous_collision_detection_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`CCDMode`\ ) |virtual| .. container:: contribute @@ -1376,7 +1376,7 @@ void **_body_set_continuous_collision_detection_mode** **(** :ref:`RID` body, :ref:`Callable` callable, :ref:`Variant` userdata **)** |virtual| +|void| **_body_set_force_integration_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant`\ ) |virtual| .. container:: contribute @@ -1390,7 +1390,7 @@ void **_body_set_force_integration_callback** **(** :ref:`RID` body, .. rst-class:: classref-method -void **_body_set_max_contacts_reported** **(** :ref:`RID` body, :ref:`int` amount **)** |virtual| +|void| **_body_set_max_contacts_reported**\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1404,7 +1404,7 @@ void **_body_set_max_contacts_reported** **(** :ref:`RID` body, :ref: .. rst-class:: classref-method -void **_body_set_mode** **(** :ref:`RID` body, :ref:`BodyMode` mode **)** |virtual| +|void| **_body_set_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) |virtual| .. container:: contribute @@ -1418,7 +1418,7 @@ void **_body_set_mode** **(** :ref:`RID` body, :ref:`BodyMode` body, :ref:`bool` enable **)** |virtual| +|void| **_body_set_omit_force_integration**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1432,7 +1432,7 @@ void **_body_set_omit_force_integration** **(** :ref:`RID` body, :ref .. rst-class:: classref-method -void **_body_set_param** **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`Variant` value **)** |virtual| +|void| **_body_set_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) |virtual| .. container:: contribute @@ -1446,7 +1446,7 @@ void **_body_set_param** **(** :ref:`RID` body, :ref:`BodyParameter` body, :ref:`bool` pickable **)** |virtual| +|void| **_body_set_pickable**\ (\ body\: :ref:`RID`, pickable\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1460,7 +1460,7 @@ void **_body_set_pickable** **(** :ref:`RID` body, :ref:`bool` body, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| +|void| **_body_set_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -1474,7 +1474,7 @@ void **_body_set_shape** **(** :ref:`RID` body, :ref:`int` .. rst-class:: classref-method -void **_body_set_shape_as_one_way_collision** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable, :ref:`float` margin **)** |virtual| +|void| **_body_set_shape_as_one_way_collision**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, enable\: :ref:`bool`, margin\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1488,7 +1488,7 @@ void **_body_set_shape_as_one_way_collision** **(** :ref:`RID` body, .. rst-class:: classref-method -void **_body_set_shape_disabled** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| +|void| **_body_set_shape_disabled**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1502,7 +1502,7 @@ void **_body_set_shape_disabled** **(** :ref:`RID` body, :ref:`int` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** |virtual| +|void| **_body_set_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform2D`\ ) |virtual| .. container:: contribute @@ -1516,7 +1516,7 @@ void **_body_set_shape_transform** **(** :ref:`RID` body, :ref:`int` body, :ref:`RID` space **)** |virtual| +|void| **_body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -1530,7 +1530,7 @@ void **_body_set_space** **(** :ref:`RID` body, :ref:`RID` .. rst-class:: classref-method -void **_body_set_state** **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** |virtual| +|void| **_body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) |virtual| .. container:: contribute @@ -1544,7 +1544,7 @@ void **_body_set_state** **(** :ref:`RID` body, :ref:`BodyState` body, :ref:`Callable` callable **)** |virtual| +|void| **_body_set_state_sync_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`\ ) |virtual| .. container:: contribute @@ -1558,7 +1558,7 @@ void **_body_set_state_sync_callback** **(** :ref:`RID` body, :ref:`C .. rst-class:: classref-method -:ref:`bool` **_body_test_motion** **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin, :ref:`bool` collide_separation_ray, :ref:`bool` recovery_as_collision, PhysicsServer2DExtensionMotionResult* result **)** |virtual| |const| +:ref:`bool` **_body_test_motion**\ (\ body\: :ref:`RID`, from\: :ref:`Transform2D`, motion\: :ref:`Vector2`, margin\: :ref:`float`, collide_separation_ray\: :ref:`bool`, recovery_as_collision\: :ref:`bool`, result\: ``PhysicsServer2DExtensionMotionResult*``\ ) |virtual| |const| .. container:: contribute @@ -1572,7 +1572,7 @@ void **_body_set_state_sync_callback** **(** :ref:`RID` body, :ref:`C .. rst-class:: classref-method -:ref:`RID` **_capsule_shape_create** **(** **)** |virtual| +:ref:`RID` **_capsule_shape_create**\ (\ ) |virtual| .. container:: contribute @@ -1586,7 +1586,7 @@ void **_body_set_state_sync_callback** **(** :ref:`RID` body, :ref:`C .. rst-class:: classref-method -:ref:`RID` **_circle_shape_create** **(** **)** |virtual| +:ref:`RID` **_circle_shape_create**\ (\ ) |virtual| .. container:: contribute @@ -1600,7 +1600,7 @@ void **_body_set_state_sync_callback** **(** :ref:`RID` body, :ref:`C .. rst-class:: classref-method -:ref:`RID` **_concave_polygon_shape_create** **(** **)** |virtual| +:ref:`RID` **_concave_polygon_shape_create**\ (\ ) |virtual| .. container:: contribute @@ -1614,7 +1614,7 @@ void **_body_set_state_sync_callback** **(** :ref:`RID` body, :ref:`C .. rst-class:: classref-method -:ref:`RID` **_convex_polygon_shape_create** **(** **)** |virtual| +:ref:`RID` **_convex_polygon_shape_create**\ (\ ) |virtual| .. container:: contribute @@ -1628,7 +1628,7 @@ void **_body_set_state_sync_callback** **(** :ref:`RID` body, :ref:`C .. rst-class:: classref-method -:ref:`float` **_damped_spring_joint_get_param** **(** :ref:`RID` joint, :ref:`DampedSpringParam` param **)** |virtual| |const| +:ref:`float` **_damped_spring_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`\ ) |virtual| |const| .. container:: contribute @@ -1642,7 +1642,7 @@ void **_body_set_state_sync_callback** **(** :ref:`RID` body, :ref:`C .. rst-class:: classref-method -void **_damped_spring_joint_set_param** **(** :ref:`RID` joint, :ref:`DampedSpringParam` param, :ref:`float` value **)** |virtual| +|void| **_damped_spring_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`DampedSpringParam`, value\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1656,7 +1656,7 @@ void **_damped_spring_joint_set_param** **(** :ref:`RID` joint, :ref: .. rst-class:: classref-method -void **_end_sync** **(** **)** |virtual| +|void| **_end_sync**\ (\ ) |virtual| .. container:: contribute @@ -1670,7 +1670,7 @@ void **_end_sync** **(** **)** |virtual| .. rst-class:: classref-method -void **_finish** **(** **)** |virtual| +|void| **_finish**\ (\ ) |virtual| .. container:: contribute @@ -1684,7 +1684,7 @@ void **_finish** **(** **)** |virtual| .. rst-class:: classref-method -void **_flush_queries** **(** **)** |virtual| +|void| **_flush_queries**\ (\ ) |virtual| .. container:: contribute @@ -1698,7 +1698,7 @@ void **_flush_queries** **(** **)** |virtual| .. rst-class:: classref-method -void **_free_rid** **(** :ref:`RID` rid **)** |virtual| +|void| **_free_rid**\ (\ rid\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -1712,7 +1712,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_get_process_info** **(** :ref:`ProcessInfo` process_info **)** |virtual| +:ref:`int` **_get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) |virtual| .. container:: contribute @@ -1726,7 +1726,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -void **_init** **(** **)** |virtual| +|void| **_init**\ (\ ) |virtual| .. container:: contribute @@ -1740,7 +1740,7 @@ void **_init** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_is_flushing_queries** **(** **)** |virtual| |const| +:ref:`bool` **_is_flushing_queries**\ (\ ) |virtual| |const| .. container:: contribute @@ -1754,7 +1754,7 @@ void **_init** **(** **)** |virtual| .. rst-class:: classref-method -void **_joint_clear** **(** :ref:`RID` joint **)** |virtual| +|void| **_joint_clear**\ (\ joint\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -1768,7 +1768,7 @@ void **_joint_clear** **(** :ref:`RID` joint **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_joint_create** **(** **)** |virtual| +:ref:`RID` **_joint_create**\ (\ ) |virtual| .. container:: contribute @@ -1782,7 +1782,7 @@ void **_joint_clear** **(** :ref:`RID` joint **)** |virtual| .. rst-class:: classref-method -void **_joint_disable_collisions_between_bodies** **(** :ref:`RID` joint, :ref:`bool` disable **)** |virtual| +|void| **_joint_disable_collisions_between_bodies**\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1796,7 +1796,7 @@ void **_joint_disable_collisions_between_bodies** **(** :ref:`RID` jo .. rst-class:: classref-method -:ref:`float` **_joint_get_param** **(** :ref:`RID` joint, :ref:`JointParam` param **)** |virtual| |const| +:ref:`float` **_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`\ ) |virtual| |const| .. container:: contribute @@ -1810,7 +1810,7 @@ void **_joint_disable_collisions_between_bodies** **(** :ref:`RID` jo .. rst-class:: classref-method -:ref:`JointType` **_joint_get_type** **(** :ref:`RID` joint **)** |virtual| |const| +:ref:`JointType` **_joint_get_type**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1824,7 +1824,7 @@ void **_joint_disable_collisions_between_bodies** **(** :ref:`RID` jo .. rst-class:: classref-method -:ref:`bool` **_joint_is_disabled_collisions_between_bodies** **(** :ref:`RID` joint **)** |virtual| |const| +:ref:`bool` **_joint_is_disabled_collisions_between_bodies**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1838,7 +1838,7 @@ void **_joint_disable_collisions_between_bodies** **(** :ref:`RID` jo .. rst-class:: classref-method -void **_joint_make_damped_spring** **(** :ref:`RID` joint, :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** |virtual| +|void| **_joint_make_damped_spring**\ (\ joint\: :ref:`RID`, anchor_a\: :ref:`Vector2`, anchor_b\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -1852,7 +1852,7 @@ void **_joint_make_damped_spring** **(** :ref:`RID` joint, :ref:`Vect .. rst-class:: classref-method -void **_joint_make_groove** **(** :ref:`RID` joint, :ref:`Vector2` a_groove1, :ref:`Vector2` a_groove2, :ref:`Vector2` b_anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** |virtual| +|void| **_joint_make_groove**\ (\ joint\: :ref:`RID`, a_groove1\: :ref:`Vector2`, a_groove2\: :ref:`Vector2`, b_anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -1866,7 +1866,7 @@ void **_joint_make_groove** **(** :ref:`RID` joint, :ref:`Vector2` joint, :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** |virtual| +|void| **_joint_make_pin**\ (\ joint\: :ref:`RID`, anchor\: :ref:`Vector2`, body_a\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -1880,7 +1880,7 @@ void **_joint_make_pin** **(** :ref:`RID` joint, :ref:`Vector2` joint, :ref:`JointParam` param, :ref:`float` value **)** |virtual| +|void| **_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`JointParam`, value\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1894,7 +1894,7 @@ void **_joint_set_param** **(** :ref:`RID` joint, :ref:`JointParam` **_pin_joint_get_flag** **(** :ref:`RID` joint, :ref:`PinJointFlag` flag **)** |virtual| |const| +:ref:`bool` **_pin_joint_get_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`\ ) |virtual| |const| .. container:: contribute @@ -1908,7 +1908,7 @@ void **_joint_set_param** **(** :ref:`RID` joint, :ref:`JointParam` **_pin_joint_get_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** |virtual| |const| +:ref:`float` **_pin_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |virtual| |const| .. container:: contribute @@ -1922,7 +1922,7 @@ void **_joint_set_param** **(** :ref:`RID` joint, :ref:`JointParam` joint, :ref:`PinJointFlag` flag, :ref:`bool` enabled **)** |virtual| +|void| **_pin_joint_set_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`PinJointFlag`, enabled\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1936,7 +1936,7 @@ void **_pin_joint_set_flag** **(** :ref:`RID` joint, :ref:`PinJointFl .. rst-class:: classref-method -void **_pin_joint_set_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** |virtual| +|void| **_pin_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1950,7 +1950,7 @@ void **_pin_joint_set_param** **(** :ref:`RID` joint, :ref:`PinJointP .. rst-class:: classref-method -:ref:`RID` **_rectangle_shape_create** **(** **)** |virtual| +:ref:`RID` **_rectangle_shape_create**\ (\ ) |virtual| .. container:: contribute @@ -1964,7 +1964,7 @@ void **_pin_joint_set_param** **(** :ref:`RID` joint, :ref:`PinJointP .. rst-class:: classref-method -:ref:`RID` **_segment_shape_create** **(** **)** |virtual| +:ref:`RID` **_segment_shape_create**\ (\ ) |virtual| .. container:: contribute @@ -1978,7 +1978,7 @@ void **_pin_joint_set_param** **(** :ref:`RID` joint, :ref:`PinJointP .. rst-class:: classref-method -:ref:`RID` **_separation_ray_shape_create** **(** **)** |virtual| +:ref:`RID` **_separation_ray_shape_create**\ (\ ) |virtual| .. container:: contribute @@ -1992,7 +1992,7 @@ void **_pin_joint_set_param** **(** :ref:`RID` joint, :ref:`PinJointP .. rst-class:: classref-method -void **_set_active** **(** :ref:`bool` active **)** |virtual| +|void| **_set_active**\ (\ active\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -2006,7 +2006,7 @@ void **_set_active** **(** :ref:`bool` active **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_shape_collide** **(** :ref:`RID` shape_A, :ref:`Transform2D` xform_A, :ref:`Vector2` motion_A, :ref:`RID` shape_B, :ref:`Transform2D` xform_B, :ref:`Vector2` motion_B, void* results, :ref:`int` result_max, int32_t* result_count **)** |virtual| +:ref:`bool` **_shape_collide**\ (\ shape_A\: :ref:`RID`, xform_A\: :ref:`Transform2D`, motion_A\: :ref:`Vector2`, shape_B\: :ref:`RID`, xform_B\: :ref:`Transform2D`, motion_B\: :ref:`Vector2`, results\: ``void*``, result_max\: :ref:`int`, result_count\: ``int32_t*``\ ) |virtual| .. container:: contribute @@ -2020,7 +2020,7 @@ void **_set_active** **(** :ref:`bool` active **)** |virtual| .. rst-class:: classref-method -:ref:`float` **_shape_get_custom_solver_bias** **(** :ref:`RID` shape **)** |virtual| |const| +:ref:`float` **_shape_get_custom_solver_bias**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2034,7 +2034,7 @@ void **_set_active** **(** :ref:`bool` active **)** |virtual| .. rst-class:: classref-method -:ref:`Variant` **_shape_get_data** **(** :ref:`RID` shape **)** |virtual| |const| +:ref:`Variant` **_shape_get_data**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2048,7 +2048,7 @@ void **_set_active** **(** :ref:`bool` active **)** |virtual| .. rst-class:: classref-method -:ref:`ShapeType` **_shape_get_type** **(** :ref:`RID` shape **)** |virtual| |const| +:ref:`ShapeType` **_shape_get_type**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2062,7 +2062,7 @@ void **_set_active** **(** :ref:`bool` active **)** |virtual| .. rst-class:: classref-method -void **_shape_set_custom_solver_bias** **(** :ref:`RID` shape, :ref:`float` bias **)** |virtual| +|void| **_shape_set_custom_solver_bias**\ (\ shape\: :ref:`RID`, bias\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -2076,7 +2076,7 @@ void **_shape_set_custom_solver_bias** **(** :ref:`RID` shape, :ref:` .. rst-class:: classref-method -void **_shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` data **)** |virtual| +|void| **_shape_set_data**\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) |virtual| .. container:: contribute @@ -2090,7 +2090,7 @@ void **_shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` **_space_create** **(** **)** |virtual| +:ref:`RID` **_space_create**\ (\ ) |virtual| .. container:: contribute @@ -2104,7 +2104,7 @@ void **_shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` **_space_get_contact_count** **(** :ref:`RID` space **)** |virtual| |const| +:ref:`int` **_space_get_contact_count**\ (\ space\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2118,7 +2118,7 @@ void **_shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` **_space_get_contacts** **(** :ref:`RID` space **)** |virtual| |const| +:ref:`PackedVector2Array` **_space_get_contacts**\ (\ space\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2132,7 +2132,7 @@ void **_shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` **_space_get_direct_state** **(** :ref:`RID` space **)** |virtual| +:ref:`PhysicsDirectSpaceState2D` **_space_get_direct_state**\ (\ space\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -2146,7 +2146,7 @@ void **_shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` **_space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** |virtual| |const| +:ref:`float` **_space_get_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |virtual| |const| .. container:: contribute @@ -2160,7 +2160,7 @@ void **_shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` **_space_is_active** **(** :ref:`RID` space **)** |virtual| |const| +:ref:`bool` **_space_is_active**\ (\ space\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2174,7 +2174,7 @@ void **_shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` space, :ref:`bool` active **)** |virtual| +|void| **_space_set_active**\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -2188,7 +2188,7 @@ void **_space_set_active** **(** :ref:`RID` space, :ref:`bool` space, :ref:`int` max_contacts **)** |virtual| +|void| **_space_set_debug_contacts**\ (\ space\: :ref:`RID`, max_contacts\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -2202,7 +2202,7 @@ void **_space_set_debug_contacts** **(** :ref:`RID` space, :ref:`int< .. rst-class:: classref-method -void **_space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** |virtual| +|void| **_space_set_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -2216,7 +2216,7 @@ void **_space_set_param** **(** :ref:`RID` space, :ref:`SpaceParamete .. rst-class:: classref-method -void **_step** **(** :ref:`float` step **)** |virtual| +|void| **_step**\ (\ step\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -2230,7 +2230,7 @@ void **_step** **(** :ref:`float` step **)** |virtual| .. rst-class:: classref-method -void **_sync** **(** **)** |virtual| +|void| **_sync**\ (\ ) |virtual| .. container:: contribute @@ -2244,7 +2244,7 @@ void **_sync** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_world_boundary_shape_create** **(** **)** |virtual| +:ref:`RID` **_world_boundary_shape_create**\ (\ ) |virtual| .. container:: contribute @@ -2258,7 +2258,7 @@ void **_sync** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **body_test_motion_is_excluding_body** **(** :ref:`RID` body **)** |const| +:ref:`bool` **body_test_motion_is_excluding_body**\ (\ body\: :ref:`RID`\ ) |const| .. container:: contribute @@ -2272,7 +2272,7 @@ void **_sync** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **body_test_motion_is_excluding_object** **(** :ref:`int` object **)** |const| +:ref:`bool` **body_test_motion_is_excluding_object**\ (\ object\: :ref:`int`\ ) |const| .. container:: contribute @@ -2285,3 +2285,4 @@ void **_sync** **(** **)** |virtual| .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsserver2dmanager.rst b/classes/class_physicsserver2dmanager.rst index 2e640ef9e28..0af8d163b9f 100644 --- a/classes/class_physicsserver2dmanager.rst +++ b/classes/class_physicsserver2dmanager.rst @@ -31,11 +31,11 @@ Methods .. table:: :widths: auto - +------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`register_server` **(** :ref:`String` name, :ref:`Callable` create_callback **)** | - +------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_default_server` **(** :ref:`String` name, :ref:`int` priority **)** | - +------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_server`\ (\ name\: :ref:`String`, create_callback\: :ref:`Callable`\ ) | + +--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_default_server`\ (\ name\: :ref:`String`, priority\: :ref:`int`\ ) | + +--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -50,7 +50,7 @@ Method Descriptions .. rst-class:: classref-method -void **register_server** **(** :ref:`String` name, :ref:`Callable` create_callback **)** +|void| **register_server**\ (\ name\: :ref:`String`, create_callback\: :ref:`Callable`\ ) Register a :ref:`PhysicsServer2D` implementation by passing a ``name`` and a :ref:`Callable` that returns a :ref:`PhysicsServer2D` object. @@ -62,7 +62,7 @@ Register a :ref:`PhysicsServer2D` implementation by passi .. rst-class:: classref-method -void **set_default_server** **(** :ref:`String` name, :ref:`int` priority **)** +|void| **set_default_server**\ (\ name\: :ref:`String`, priority\: :ref:`int`\ ) Set the default :ref:`PhysicsServer2D` implementation to the one identified by ``name``, if ``priority`` is greater than the priority of the current default implementation. @@ -73,3 +73,4 @@ Set the default :ref:`PhysicsServer2D` implementation to .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsserver3d.rst b/classes/class_physicsserver3d.rst index ed0f2850cb5..a6749212442 100644 --- a/classes/class_physicsserver3d.rst +++ b/classes/class_physicsserver3d.rst @@ -45,339 +45,339 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform3D` transform=Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), :ref:`bool` disabled=false **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`area_create` **(** **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`area_get_collision_layer` **(** :ref:`RID` area **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`area_get_collision_mask` **(** :ref:`RID` area **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`area_get_object_instance_id` **(** :ref:`RID` area **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`AreaParameter` param **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`area_get_transform` **(** :ref:`RID` area **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Callable` callback **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Callable` callback **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_monitorable` **(** :ref:`RID` area, :ref:`bool` monitorable **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_ray_pickable` **(** :ref:`RID` area, :ref:`bool` enable **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_shape_disabled` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disabled **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform3D` transform **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform3D` transform **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_add_constant_central_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_add_constant_force` **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position=Vector3(0, 0, 0) **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_add_constant_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform3D` transform=Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), :ref:`bool` disabled=false **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_apply_central_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_apply_force` **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position=Vector3(0, 0, 0) **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse, :ref:`Vector3` position=Vector3(0, 0, 0) **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_apply_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`body_create` **(** **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`body_get_collision_priority` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`body_get_constant_force` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`body_get_constant_torque` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectBodyState3D` | :ref:`body_get_direct_state` **(** :ref:`RID` body **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`BodyMode` | :ref:`body_get_mode` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`body_get_object_instance_id` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`BodyParameter` param **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`body_is_axis_locked` **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`body_is_continuous_collision_detection_enabled` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_reset_mass_properties` **(** :ref:`RID` body **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_axis_lock` **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_collision_priority` **(** :ref:`RID` body, :ref:`float` priority **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_constant_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_constant_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_enable_continuous_collision_detection` **(** :ref:`RID` body, :ref:`bool` enable **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Callable` callable, :ref:`Variant` userdata=null **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`BodyMode` mode **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`Variant` value **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_ray_pickable` **(** :ref:`RID` body, :ref:`bool` enable **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_shape_disabled` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disabled **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform3D` transform **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`PhysicsTestMotionParameters3D` parameters, :ref:`PhysicsTestMotionResult3D` result=null **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`box_shape_create` **(** **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`capsule_shape_create` **(** **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`concave_polygon_shape_create` **(** **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`cone_twist_joint_get_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`cone_twist_joint_set_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param, :ref:`float` value **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`convex_polygon_shape_create` **(** **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`custom_shape_create` **(** **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`cylinder_shape_create` **(** **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`free_rid` **(** :ref:`RID` rid **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`generic_6dof_joint_get_flag` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`generic_6dof_joint_get_param` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`generic_6dof_joint_set_flag` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag, :ref:`bool` enable **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`generic_6dof_joint_set_param` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param, :ref:`float` value **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_process_info` **(** :ref:`ProcessInfo` process_info **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`heightmap_shape_create` **(** **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`hinge_joint_get_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`hinge_joint_get_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`hinge_joint_set_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag, :ref:`bool` enabled **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`hinge_joint_set_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param, :ref:`float` value **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`joint_clear` **(** :ref:`RID` joint **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`joint_create` **(** **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`joint_disable_collisions_between_bodies` **(** :ref:`RID` joint, :ref:`bool` disable **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`joint_get_solver_priority` **(** :ref:`RID` joint **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`JointType` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`joint_is_disabled_collisions_between_bodies` **(** :ref:`RID` joint **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`joint_make_cone_twist` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`joint_make_generic_6dof` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`joint_make_hinge` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` hinge_A, :ref:`RID` body_B, :ref:`Transform3D` hinge_B **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`joint_make_pin` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`joint_make_slider` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`joint_set_solver_priority` **(** :ref:`RID` joint, :ref:`int` priority **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`pin_joint_get_local_a` **(** :ref:`RID` joint **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`pin_joint_get_local_b` **(** :ref:`RID` joint **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`pin_joint_get_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`pin_joint_set_local_a` **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`pin_joint_set_local_b` **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`pin_joint_set_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`separation_ray_shape_create` **(** **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_active` **(** :ref:`bool` active **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`shape_get_data` **(** :ref:`RID` shape **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ShapeType` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`slider_joint_get_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`slider_joint_set_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param, :ref:`float` value **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` body_b **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`soft_body_create` **(** **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`soft_body_get_bounds` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`soft_body_get_collision_layer` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`soft_body_get_collision_mask` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`soft_body_get_damping_coefficient` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`soft_body_get_drag_coefficient` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`soft_body_get_linear_stiffness` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`soft_body_get_point_global_position` **(** :ref:`RID` body, :ref:`int` point_index **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`soft_body_get_pressure_coefficient` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`soft_body_get_simulation_precision` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`soft_body_get_space` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`soft_body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`soft_body_get_total_mass` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`soft_body_is_point_pinned` **(** :ref:`RID` body, :ref:`int` point_index **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_move_point` **(** :ref:`RID` body, :ref:`int` point_index, :ref:`Vector3` global_position **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_pin_point` **(** :ref:`RID` body, :ref:`int` point_index, :ref:`bool` pin **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_remove_all_pinned_points` **(** :ref:`RID` body **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` body_b **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_set_damping_coefficient` **(** :ref:`RID` body, :ref:`float` damping_coefficient **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_set_drag_coefficient` **(** :ref:`RID` body, :ref:`float` drag_coefficient **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_set_linear_stiffness` **(** :ref:`RID` body, :ref:`float` stiffness **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_set_mesh` **(** :ref:`RID` body, :ref:`RID` mesh **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_set_pressure_coefficient` **(** :ref:`RID` body, :ref:`float` pressure_coefficient **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_set_ray_pickable` **(** :ref:`RID` body, :ref:`bool` enable **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_set_simulation_precision` **(** :ref:`RID` body, :ref:`int` simulation_precision **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` variant **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_set_total_mass` **(** :ref:`RID` body, :ref:`float` total_mass **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_set_transform` **(** :ref:`RID` body, :ref:`Transform3D` transform **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`soft_body_update_rendering_server` **(** :ref:`RID` body, :ref:`PhysicsServer3DRenderingServerHandler` rendering_server_handler **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`space_create` **(** **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectSpaceState3D` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** |const| | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`sphere_shape_create` **(** **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`world_boundary_shape_create` **(** **)** | - +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_add_shape`\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), disabled\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_attach_object_instance_id`\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_clear_shapes`\ (\ area\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`area_create`\ (\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`area_get_collision_layer`\ (\ area\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`area_get_collision_mask`\ (\ area\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`area_get_object_instance_id`\ (\ area\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`area_get_param`\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`area_get_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`area_get_shape_count`\ (\ area\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`area_get_shape_transform`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`area_get_space`\ (\ area\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`area_get_transform`\ (\ area\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_remove_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_area_monitor_callback`\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_collision_layer`\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_collision_mask`\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_monitor_callback`\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_monitorable`\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_param`\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_ray_pickable`\ (\ area\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_shape_disabled`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_shape_transform`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_space`\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`area_set_transform`\ (\ area\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_add_collision_exception`\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_add_constant_central_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_add_constant_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_add_constant_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_add_shape`\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), disabled\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_apply_central_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_apply_central_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_apply_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_apply_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_apply_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_apply_torque_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_attach_object_instance_id`\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_clear_shapes`\ (\ body\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`body_create`\ (\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`body_get_collision_layer`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`body_get_collision_mask`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`body_get_collision_priority`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`body_get_constant_force`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`body_get_constant_torque`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectBodyState3D` | :ref:`body_get_direct_state`\ (\ body\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`body_get_max_contacts_reported`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`BodyMode` | :ref:`body_get_mode`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`body_get_object_instance_id`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`body_get_param`\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`body_get_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`body_get_shape_count`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`body_get_shape_transform`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`body_get_space`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`body_get_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`body_is_axis_locked`\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`body_is_continuous_collision_detection_enabled`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`body_is_omitting_force_integration`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_remove_collision_exception`\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_remove_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_reset_mass_properties`\ (\ body\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_axis_lock`\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_axis_velocity`\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_collision_layer`\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_collision_mask`\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_collision_priority`\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_constant_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_constant_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_enable_continuous_collision_detection`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_force_integration_callback`\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant` = null\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_max_contacts_reported`\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_mode`\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_omit_force_integration`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_param`\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_ray_pickable`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_shape_disabled`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_shape_transform`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_space`\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`body_set_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`body_test_motion`\ (\ body\: :ref:`RID`, parameters\: :ref:`PhysicsTestMotionParameters3D`, result\: :ref:`PhysicsTestMotionResult3D` = null\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`box_shape_create`\ (\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`capsule_shape_create`\ (\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`concave_polygon_shape_create`\ (\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`cone_twist_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cone_twist_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`, value\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`convex_polygon_shape_create`\ (\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`custom_shape_create`\ (\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`cylinder_shape_create`\ (\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`free_rid`\ (\ rid\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`generic_6dof_joint_get_flag`\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`generic_6dof_joint_get_param`\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`generic_6dof_joint_set_flag`\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`generic_6dof_joint_set_param`\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam`, value\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_process_info`\ (\ process_info\: :ref:`ProcessInfo`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`heightmap_shape_create`\ (\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`hinge_joint_get_flag`\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`hinge_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`hinge_joint_set_flag`\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`, enabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`hinge_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`, value\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`joint_clear`\ (\ joint\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`joint_create`\ (\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`joint_disable_collisions_between_bodies`\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`joint_get_solver_priority`\ (\ joint\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`JointType` | :ref:`joint_get_type`\ (\ joint\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`joint_is_disabled_collisions_between_bodies`\ (\ joint\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`joint_make_cone_twist`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`joint_make_generic_6dof`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`joint_make_hinge`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, hinge_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, hinge_B\: :ref:`Transform3D`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`joint_make_pin`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_A\: :ref:`Vector3`, body_B\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`joint_make_slider`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`joint_set_solver_priority`\ (\ joint\: :ref:`RID`, priority\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`pin_joint_get_local_a`\ (\ joint\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`pin_joint_get_local_b`\ (\ joint\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`pin_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`pin_joint_set_local_a`\ (\ joint\: :ref:`RID`, local_A\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`pin_joint_set_local_b`\ (\ joint\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`pin_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`separation_ray_shape_create`\ (\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_active`\ (\ active\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`shape_get_data`\ (\ shape\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ShapeType` | :ref:`shape_get_type`\ (\ shape\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shape_set_data`\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`slider_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`slider_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`, value\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_add_collision_exception`\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`soft_body_create`\ (\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`soft_body_get_bounds`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`soft_body_get_collision_layer`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`soft_body_get_collision_mask`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`soft_body_get_damping_coefficient`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`soft_body_get_drag_coefficient`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`soft_body_get_linear_stiffness`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`soft_body_get_point_global_position`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`soft_body_get_pressure_coefficient`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`soft_body_get_simulation_precision`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`soft_body_get_space`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`soft_body_get_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`soft_body_get_total_mass`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`soft_body_is_point_pinned`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_move_point`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, global_position\: :ref:`Vector3`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_pin_point`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, pin\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_remove_all_pinned_points`\ (\ body\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_remove_collision_exception`\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_set_collision_layer`\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_set_collision_mask`\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_set_damping_coefficient`\ (\ body\: :ref:`RID`, damping_coefficient\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_set_drag_coefficient`\ (\ body\: :ref:`RID`, drag_coefficient\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_set_linear_stiffness`\ (\ body\: :ref:`RID`, stiffness\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_set_mesh`\ (\ body\: :ref:`RID`, mesh\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_set_pressure_coefficient`\ (\ body\: :ref:`RID`, pressure_coefficient\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_set_ray_pickable`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_set_simulation_precision`\ (\ body\: :ref:`RID`, simulation_precision\: :ref:`int`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_set_space`\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_set_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, variant\: :ref:`Variant`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_set_total_mass`\ (\ body\: :ref:`RID`, total_mass\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_set_transform`\ (\ body\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`soft_body_update_rendering_server`\ (\ body\: :ref:`RID`, rendering_server_handler\: :ref:`PhysicsServer3DRenderingServerHandler`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`space_create`\ (\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectSpaceState3D` | :ref:`space_get_direct_state`\ (\ space\: :ref:`RID`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`space_get_param`\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`space_is_active`\ (\ space\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`space_set_active`\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`space_set_param`\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`sphere_shape_create`\ (\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`world_boundary_shape_create`\ (\ ) | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -1735,7 +1735,7 @@ Method Descriptions .. rst-class:: classref-method -void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform3D` transform=Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), :ref:`bool` disabled=false **)** +|void| **area_add_shape**\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), disabled\: :ref:`bool` = false\ ) Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. @@ -1747,7 +1747,7 @@ Adds a shape to the area, along with a transform matrix. Shapes are usually refe .. rst-class:: classref-method -void **area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** +|void| **area_attach_object_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. @@ -1759,7 +1759,7 @@ Assigns the area to a descendant of :ref:`Object`, so it can exist .. rst-class:: classref-method -void **area_clear_shapes** **(** :ref:`RID` area **)** +|void| **area_clear_shapes**\ (\ area\: :ref:`RID`\ ) Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later. @@ -1771,7 +1771,7 @@ Removes all shapes from an area. It does not delete the shapes, so they can be r .. rst-class:: classref-method -:ref:`RID` **area_create** **(** **)** +:ref:`RID` **area_create**\ (\ ) Creates an :ref:`Area3D`. @@ -1783,7 +1783,7 @@ Creates an :ref:`Area3D`. .. rst-class:: classref-method -:ref:`int` **area_get_collision_layer** **(** :ref:`RID` area **)** |const| +:ref:`int` **area_get_collision_layer**\ (\ area\: :ref:`RID`\ ) |const| Returns the physics layer or layers an area belongs to. @@ -1795,7 +1795,7 @@ Returns the physics layer or layers an area belongs to. .. rst-class:: classref-method -:ref:`int` **area_get_collision_mask** **(** :ref:`RID` area **)** |const| +:ref:`int` **area_get_collision_mask**\ (\ area\: :ref:`RID`\ ) |const| Returns the physics layer or layers an area can contact with. @@ -1807,7 +1807,7 @@ Returns the physics layer or layers an area can contact with. .. rst-class:: classref-method -:ref:`int` **area_get_object_instance_id** **(** :ref:`RID` area **)** |const| +:ref:`int` **area_get_object_instance_id**\ (\ area\: :ref:`RID`\ ) |const| Gets the instance ID of the object the area is assigned to. @@ -1819,7 +1819,7 @@ Gets the instance ID of the object the area is assigned to. .. rst-class:: classref-method -:ref:`Variant` **area_get_param** **(** :ref:`RID` area, :ref:`AreaParameter` param **)** |const| +:ref:`Variant` **area_get_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |const| Returns an area parameter value. A list of available parameters is on the :ref:`AreaParameter` constants. @@ -1831,7 +1831,7 @@ Returns an area parameter value. A list of available parameters is on the :ref:` .. rst-class:: classref-method -:ref:`RID` **area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |const| +:ref:`RID` **area_get_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| Returns the :ref:`RID` of the nth shape of an area. @@ -1843,7 +1843,7 @@ Returns the :ref:`RID` of the nth shape of an area. .. rst-class:: classref-method -:ref:`int` **area_get_shape_count** **(** :ref:`RID` area **)** |const| +:ref:`int` **area_get_shape_count**\ (\ area\: :ref:`RID`\ ) |const| Returns the number of shapes assigned to an area. @@ -1855,7 +1855,7 @@ Returns the number of shapes assigned to an area. .. rst-class:: classref-method -:ref:`Transform3D` **area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |const| +:ref:`Transform3D` **area_get_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| Returns the transform matrix of a shape within an area. @@ -1867,7 +1867,7 @@ Returns the transform matrix of a shape within an area. .. rst-class:: classref-method -:ref:`RID` **area_get_space** **(** :ref:`RID` area **)** |const| +:ref:`RID` **area_get_space**\ (\ area\: :ref:`RID`\ ) |const| Returns the space assigned to the area. @@ -1879,7 +1879,7 @@ Returns the space assigned to the area. .. rst-class:: classref-method -:ref:`Transform3D` **area_get_transform** **(** :ref:`RID` area **)** |const| +:ref:`Transform3D` **area_get_transform**\ (\ area\: :ref:`RID`\ ) |const| Returns the transform matrix for an area. @@ -1891,7 +1891,7 @@ Returns the transform matrix for an area. .. rst-class:: classref-method -void **area_remove_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** +|void| **area_remove_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) Removes a shape from an area. It does not delete the shape, so it can be reassigned later. @@ -1903,7 +1903,7 @@ Removes a shape from an area. It does not delete the shape, so it can be reassig .. rst-class:: classref-method -void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Callable` callback **)** +|void| **area_set_area_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) Sets the area's area monitor callback. This callback will be called when any other (shape of an) area enters or exits (a shape of) the given area, and must take the following five parameters: @@ -1927,7 +1927,7 @@ By counting (or keeping track of) the shapes that enter and exit, it can be dete .. rst-class:: classref-method -void **area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** +|void| **area_set_collision_layer**\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) Assigns the area to one or many physics layers. @@ -1939,7 +1939,7 @@ Assigns the area to one or many physics layers. .. rst-class:: classref-method -void **area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** +|void| **area_set_collision_mask**\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) Sets which physics layers the area will monitor. @@ -1951,7 +1951,7 @@ Sets which physics layers the area will monitor. .. rst-class:: classref-method -void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Callable` callback **)** +|void| **area_set_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) Sets the area's body monitor callback. This callback will be called when any other (shape of a) body enters or exits (a shape of) the given area, and must take the following five parameters: @@ -1975,7 +1975,7 @@ By counting (or keeping track of) the shapes that enter and exit, it can be dete .. rst-class:: classref-method -void **area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** +|void| **area_set_monitorable**\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) .. container:: contribute @@ -1989,7 +1989,7 @@ void **area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** +|void| **area_set_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) Sets the value for an area parameter. A list of available parameters is on the :ref:`AreaParameter` constants. @@ -2001,7 +2001,7 @@ Sets the value for an area parameter. A list of available parameters is on the : .. rst-class:: classref-method -void **area_set_ray_pickable** **(** :ref:`RID` area, :ref:`bool` enable **)** +|void| **area_set_ray_pickable**\ (\ area\: :ref:`RID`, enable\: :ref:`bool`\ ) Sets object pickable with rays. @@ -2013,7 +2013,7 @@ Sets object pickable with rays. .. rst-class:: classref-method -void **area_set_shape** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** +|void| **area_set_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. @@ -2025,7 +2025,7 @@ Substitutes a given area shape by another. The old shape is selected by its inde .. rst-class:: classref-method -void **area_set_shape_disabled** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disabled **)** +|void| **area_set_shape_disabled**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) .. container:: contribute @@ -2039,7 +2039,7 @@ void **area_set_shape_disabled** **(** :ref:`RID` area, :ref:`int` area, :ref:`int` shape_idx, :ref:`Transform3D` transform **)** +|void| **area_set_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) Sets the transform matrix for an area shape. @@ -2051,7 +2051,7 @@ Sets the transform matrix for an area shape. .. rst-class:: classref-method -void **area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** +|void| **area_set_space**\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) Assigns a space to the area. @@ -2063,7 +2063,7 @@ Assigns a space to the area. .. rst-class:: classref-method -void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform3D` transform **)** +|void| **area_set_transform**\ (\ area\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) Sets the transform matrix for an area. @@ -2075,7 +2075,7 @@ Sets the transform matrix for an area. .. rst-class:: classref-method -void **body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** +|void| **body_add_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) Adds a body to the list of bodies exempt from collisions. @@ -2087,7 +2087,7 @@ Adds a body to the list of bodies exempt from collisions. .. rst-class:: classref-method -void **body_add_constant_central_force** **(** :ref:`RID` body, :ref:`Vector3` force **)** +|void| **body_add_constant_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with ``body_set_constant_force(body, Vector3(0, 0, 0))``. @@ -2101,7 +2101,7 @@ This is equivalent to using :ref:`body_add_constant_force` body, :ref:`Vector3` force, :ref:`Vector3` position=Vector3(0, 0, 0) **)** +|void| **body_add_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) Adds a constant positioned force to the body that keeps being applied over time until cleared with ``body_set_constant_force(body, Vector3(0, 0, 0))``. @@ -2115,7 +2115,7 @@ Adds a constant positioned force to the body that keeps being applied over time .. rst-class:: classref-method -void **body_add_constant_torque** **(** :ref:`RID` body, :ref:`Vector3` torque **)** +|void| **body_add_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) Adds a constant rotational force without affecting position that keeps being applied over time until cleared with ``body_set_constant_torque(body, Vector3(0, 0, 0))``. @@ -2127,7 +2127,7 @@ Adds a constant rotational force without affecting position that keeps being app .. rst-class:: classref-method -void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform3D` transform=Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), :ref:`bool` disabled=false **)** +|void| **body_add_shape**\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D` = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), disabled\: :ref:`bool` = false\ ) Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. @@ -2139,7 +2139,7 @@ Adds a shape to the body, along with a transform matrix. Shapes are usually refe .. rst-class:: classref-method -void **body_apply_central_force** **(** :ref:`RID` body, :ref:`Vector3` force **)** +|void| **body_apply_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. @@ -2153,7 +2153,7 @@ This is equivalent to using :ref:`body_apply_force` body, :ref:`Vector3` impulse **)** +|void| **body_apply_central_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) Applies a directional impulse without affecting rotation. @@ -2169,7 +2169,7 @@ This is equivalent to using :ref:`body_apply_impulse` body, :ref:`Vector3` force, :ref:`Vector3` position=Vector3(0, 0, 0) **)** +|void| **body_apply_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. @@ -2183,7 +2183,7 @@ Applies a positioned force to the body. A force is time dependent and meant to b .. rst-class:: classref-method -void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse, :ref:`Vector3` position=Vector3(0, 0, 0) **)** +|void| **body_apply_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) Applies a positioned impulse to the body. @@ -2199,7 +2199,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -void **body_apply_torque** **(** :ref:`RID` body, :ref:`Vector3` torque **)** +|void| **body_apply_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. @@ -2211,7 +2211,7 @@ Applies a rotational force without affecting position. A force is time dependent .. rst-class:: classref-method -void **body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** +|void| **body_apply_torque_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) Applies a rotational impulse to the body without affecting the position. @@ -2225,7 +2225,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -void **body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** +|void| **body_attach_object_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. @@ -2237,7 +2237,7 @@ Assigns the area to a descendant of :ref:`Object`, so it can exist .. rst-class:: classref-method -void **body_clear_shapes** **(** :ref:`RID` body **)** +|void| **body_clear_shapes**\ (\ body\: :ref:`RID`\ ) Removes all shapes from a body. @@ -2249,7 +2249,7 @@ Removes all shapes from a body. .. rst-class:: classref-method -:ref:`RID` **body_create** **(** **)** +:ref:`RID` **body_create**\ (\ ) .. container:: contribute @@ -2263,7 +2263,7 @@ Removes all shapes from a body. .. rst-class:: classref-method -:ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** |const| +:ref:`int` **body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |const| Returns the physics layer or layers a body belongs to. @@ -2275,7 +2275,7 @@ Returns the physics layer or layers a body belongs to. .. rst-class:: classref-method -:ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** |const| +:ref:`int` **body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |const| Returns the physics layer or layers a body can collide with. @@ -2287,7 +2287,7 @@ Returns the physics layer or layers a body can collide with. .. rst-class:: classref-method -:ref:`float` **body_get_collision_priority** **(** :ref:`RID` body **)** |const| +:ref:`float` **body_get_collision_priority**\ (\ body\: :ref:`RID`\ ) |const| Returns the body's collision priority. @@ -2299,7 +2299,7 @@ Returns the body's collision priority. .. rst-class:: classref-method -:ref:`Vector3` **body_get_constant_force** **(** :ref:`RID` body **)** |const| +:ref:`Vector3` **body_get_constant_force**\ (\ body\: :ref:`RID`\ ) |const| Returns the body's total constant positional forces applied during each physics update. @@ -2313,7 +2313,7 @@ See :ref:`body_add_constant_force` **body_get_constant_torque** **(** :ref:`RID` body **)** |const| +:ref:`Vector3` **body_get_constant_torque**\ (\ body\: :ref:`RID`\ ) |const| Returns the body's total constant rotational forces applied during each physics update. @@ -2327,7 +2327,7 @@ See :ref:`body_add_constant_torque` **body_get_direct_state** **(** :ref:`RID` body **)** +:ref:`PhysicsDirectBodyState3D` **body_get_direct_state**\ (\ body\: :ref:`RID`\ ) Returns the :ref:`PhysicsDirectBodyState3D` of the body. Returns ``null`` if the body is destroyed or removed from the physics space. @@ -2339,7 +2339,7 @@ Returns the :ref:`PhysicsDirectBodyState3D` of t .. rst-class:: classref-method -:ref:`int` **body_get_max_contacts_reported** **(** :ref:`RID` body **)** |const| +:ref:`int` **body_get_max_contacts_reported**\ (\ body\: :ref:`RID`\ ) |const| Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported`. @@ -2351,7 +2351,7 @@ Returns the maximum contacts that can be reported. See :ref:`body_set_max_contac .. rst-class:: classref-method -:ref:`BodyMode` **body_get_mode** **(** :ref:`RID` body **)** |const| +:ref:`BodyMode` **body_get_mode**\ (\ body\: :ref:`RID`\ ) |const| Returns the body mode. @@ -2363,7 +2363,7 @@ Returns the body mode. .. rst-class:: classref-method -:ref:`int` **body_get_object_instance_id** **(** :ref:`RID` body **)** |const| +:ref:`int` **body_get_object_instance_id**\ (\ body\: :ref:`RID`\ ) |const| Gets the instance ID of the object the area is assigned to. @@ -2375,7 +2375,7 @@ Gets the instance ID of the object the area is assigned to. .. rst-class:: classref-method -:ref:`Variant` **body_get_param** **(** :ref:`RID` body, :ref:`BodyParameter` param **)** |const| +:ref:`Variant` **body_get_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |const| Returns the value of a body parameter. A list of available parameters is on the :ref:`BodyParameter` constants. @@ -2387,7 +2387,7 @@ Returns the value of a body parameter. A list of available parameters is on the .. rst-class:: classref-method -:ref:`RID` **body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |const| +:ref:`RID` **body_get_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| Returns the :ref:`RID` of the nth shape of a body. @@ -2399,7 +2399,7 @@ Returns the :ref:`RID` of the nth shape of a body. .. rst-class:: classref-method -:ref:`int` **body_get_shape_count** **(** :ref:`RID` body **)** |const| +:ref:`int` **body_get_shape_count**\ (\ body\: :ref:`RID`\ ) |const| Returns the number of shapes assigned to a body. @@ -2411,7 +2411,7 @@ Returns the number of shapes assigned to a body. .. rst-class:: classref-method -:ref:`Transform3D` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |const| +:ref:`Transform3D` **body_get_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |const| Returns the transform matrix of a body shape. @@ -2423,7 +2423,7 @@ Returns the transform matrix of a body shape. .. rst-class:: classref-method -:ref:`RID` **body_get_space** **(** :ref:`RID` body **)** |const| +:ref:`RID` **body_get_space**\ (\ body\: :ref:`RID`\ ) |const| Returns the :ref:`RID` of the space assigned to a body. @@ -2435,7 +2435,7 @@ Returns the :ref:`RID` of the space assigned to a body. .. rst-class:: classref-method -:ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** |const| +:ref:`Variant` **body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |const| Returns a body state. @@ -2447,7 +2447,7 @@ Returns a body state. .. rst-class:: classref-method -:ref:`bool` **body_is_axis_locked** **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** |const| +:ref:`bool` **body_is_axis_locked**\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`\ ) |const| .. container:: contribute @@ -2461,7 +2461,7 @@ Returns a body state. .. rst-class:: classref-method -:ref:`bool` **body_is_continuous_collision_detection_enabled** **(** :ref:`RID` body **)** |const| +:ref:`bool` **body_is_continuous_collision_detection_enabled**\ (\ body\: :ref:`RID`\ ) |const| If ``true``, the continuous collision detection mode is enabled. @@ -2473,7 +2473,7 @@ If ``true``, the continuous collision detection mode is enabled. .. rst-class:: classref-method -:ref:`bool` **body_is_omitting_force_integration** **(** :ref:`RID` body **)** |const| +:ref:`bool` **body_is_omitting_force_integration**\ (\ body\: :ref:`RID`\ ) |const| Returns whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). @@ -2485,7 +2485,7 @@ Returns whether a body uses a callback function to calculate its own physics (se .. rst-class:: classref-method -void **body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** +|void| **body_remove_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) Removes a body from the list of bodies exempt from collisions. @@ -2499,7 +2499,7 @@ Continuous collision detection tries to predict where a moving body will collide .. rst-class:: classref-method -void **body_remove_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** +|void| **body_remove_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) Removes a shape from a body. The shape is not deleted, so it can be reused afterwards. @@ -2511,7 +2511,7 @@ Removes a shape from a body. The shape is not deleted, so it can be reused after .. rst-class:: classref-method -void **body_reset_mass_properties** **(** :ref:`RID` body **)** +|void| **body_reset_mass_properties**\ (\ body\: :ref:`RID`\ ) Restores the default inertia and center of mass based on shapes to cancel any custom values previously set using :ref:`body_set_param`. @@ -2523,7 +2523,7 @@ Restores the default inertia and center of mass based on shapes to cancel any cu .. rst-class:: classref-method -void **body_set_axis_lock** **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** +|void| **body_set_axis_lock**\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) .. container:: contribute @@ -2537,7 +2537,7 @@ void **body_set_axis_lock** **(** :ref:`RID` body, :ref:`BodyAxis` body, :ref:`Vector3` axis_velocity **)** +|void| **body_set_axis_velocity**\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector3`\ ) Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. @@ -2549,7 +2549,7 @@ Sets an axis velocity. The velocity in the given vector axis will be set as the .. rst-class:: classref-method -void **body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** +|void| **body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) Sets the physics layer or layers a body belongs to. @@ -2561,7 +2561,7 @@ Sets the physics layer or layers a body belongs to. .. rst-class:: classref-method -void **body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** +|void| **body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) Sets the physics layer or layers a body can collide with. @@ -2573,7 +2573,7 @@ Sets the physics layer or layers a body can collide with. .. rst-class:: classref-method -void **body_set_collision_priority** **(** :ref:`RID` body, :ref:`float` priority **)** +|void| **body_set_collision_priority**\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) Sets the body's collision priority. @@ -2585,7 +2585,7 @@ Sets the body's collision priority. .. rst-class:: classref-method -void **body_set_constant_force** **(** :ref:`RID` body, :ref:`Vector3` force **)** +|void| **body_set_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) Sets the body's total constant positional forces applied during each physics update. @@ -2599,7 +2599,7 @@ See :ref:`body_add_constant_force` body, :ref:`Vector3` torque **)** +|void| **body_set_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) Sets the body's total constant rotational forces applied during each physics update. @@ -2613,7 +2613,7 @@ See :ref:`body_add_constant_torque` body, :ref:`bool` enable **)** +|void| **body_set_enable_continuous_collision_detection**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) If ``true``, the continuous collision detection mode is enabled. @@ -2627,7 +2627,7 @@ Continuous collision detection tries to predict where a moving body will collide .. rst-class:: classref-method -void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Callable` callable, :ref:`Variant` userdata=null **)** +|void| **body_set_force_integration_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant` = null\ ) Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force_integration`). The force integration function takes 2 arguments: @@ -2643,7 +2643,7 @@ Sets the function used to calculate physics for an object, if that object allows .. rst-class:: classref-method -void **body_set_max_contacts_reported** **(** :ref:`RID` body, :ref:`int` amount **)** +|void| **body_set_max_contacts_reported**\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies. This is enabled by setting the maximum number of contacts reported to a number greater than 0. @@ -2655,7 +2655,7 @@ Sets the maximum contacts to report. Bodies can keep a log of the contacts with .. rst-class:: classref-method -void **body_set_mode** **(** :ref:`RID` body, :ref:`BodyMode` mode **)** +|void| **body_set_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) Sets the body mode, from one of the :ref:`BodyMode` constants. @@ -2667,7 +2667,7 @@ Sets the body mode, from one of the :ref:`BodyMode` body, :ref:`bool` enable **)** +|void| **body_set_omit_force_integration**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) Sets whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). @@ -2679,7 +2679,7 @@ Sets whether a body uses a callback function to calculate its own physics (see : .. rst-class:: classref-method -void **body_set_param** **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`Variant` value **)** +|void| **body_set_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) Sets a body parameter. A list of available parameters is on the :ref:`BodyParameter` constants. @@ -2691,7 +2691,7 @@ Sets a body parameter. A list of available parameters is on the :ref:`BodyParame .. rst-class:: classref-method -void **body_set_ray_pickable** **(** :ref:`RID` body, :ref:`bool` enable **)** +|void| **body_set_ray_pickable**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) Sets the body pickable with rays if ``enable`` is set. @@ -2703,7 +2703,7 @@ Sets the body pickable with rays if ``enable`` is set. .. rst-class:: classref-method -void **body_set_shape** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** +|void| **body_set_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. @@ -2715,7 +2715,7 @@ Substitutes a given body shape by another. The old shape is selected by its inde .. rst-class:: classref-method -void **body_set_shape_disabled** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disabled **)** +|void| **body_set_shape_disabled**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) .. container:: contribute @@ -2729,7 +2729,7 @@ void **body_set_shape_disabled** **(** :ref:`RID` body, :ref:`int` body, :ref:`int` shape_idx, :ref:`Transform3D` transform **)** +|void| **body_set_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) Sets the transform matrix for a body shape. @@ -2741,7 +2741,7 @@ Sets the transform matrix for a body shape. .. rst-class:: classref-method -void **body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** +|void| **body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) Assigns a space to the body (see :ref:`space_create`). @@ -2753,7 +2753,7 @@ Assigns a space to the body (see :ref:`space_create` body, :ref:`BodyState` state, :ref:`Variant` value **)** +|void| **body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) Sets a body state (see :ref:`BodyState` constants). @@ -2765,7 +2765,7 @@ Sets a body state (see :ref:`BodyState` constant .. rst-class:: classref-method -:ref:`bool` **body_test_motion** **(** :ref:`RID` body, :ref:`PhysicsTestMotionParameters3D` parameters, :ref:`PhysicsTestMotionResult3D` result=null **)** +:ref:`bool` **body_test_motion**\ (\ body\: :ref:`RID`, parameters\: :ref:`PhysicsTestMotionParameters3D`, result\: :ref:`PhysicsTestMotionResult3D` = null\ ) Returns ``true`` if a collision would result from moving along a motion vector from a given point in space. :ref:`PhysicsTestMotionParameters3D` is passed to set motion parameters. :ref:`PhysicsTestMotionResult3D` can be passed to return additional information. @@ -2777,7 +2777,7 @@ Returns ``true`` if a collision would result from moving along a motion vector f .. rst-class:: classref-method -:ref:`RID` **box_shape_create** **(** **)** +:ref:`RID` **box_shape_create**\ (\ ) .. container:: contribute @@ -2791,7 +2791,7 @@ Returns ``true`` if a collision would result from moving along a motion vector f .. rst-class:: classref-method -:ref:`RID` **capsule_shape_create** **(** **)** +:ref:`RID` **capsule_shape_create**\ (\ ) .. container:: contribute @@ -2805,7 +2805,7 @@ Returns ``true`` if a collision would result from moving along a motion vector f .. rst-class:: classref-method -:ref:`RID` **concave_polygon_shape_create** **(** **)** +:ref:`RID` **concave_polygon_shape_create**\ (\ ) .. container:: contribute @@ -2819,7 +2819,7 @@ Returns ``true`` if a collision would result from moving along a motion vector f .. rst-class:: classref-method -:ref:`float` **cone_twist_joint_get_param** **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** |const| +:ref:`float` **cone_twist_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`\ ) |const| Gets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam` constants). @@ -2831,7 +2831,7 @@ Gets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam` joint, :ref:`ConeTwistJointParam` param, :ref:`float` value **)** +|void| **cone_twist_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`, value\: :ref:`float`\ ) Sets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam` constants). @@ -2843,7 +2843,7 @@ Sets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam` **convex_polygon_shape_create** **(** **)** +:ref:`RID` **convex_polygon_shape_create**\ (\ ) .. container:: contribute @@ -2857,7 +2857,7 @@ Sets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam` **custom_shape_create** **(** **)** +:ref:`RID` **custom_shape_create**\ (\ ) .. container:: contribute @@ -2871,7 +2871,7 @@ Sets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam` **cylinder_shape_create** **(** **)** +:ref:`RID` **cylinder_shape_create**\ (\ ) .. container:: contribute @@ -2885,7 +2885,7 @@ Sets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam` rid **)** +|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) Destroys any of the objects created by PhysicsServer3D. If the :ref:`RID` passed is not one of the objects that can be created by PhysicsServer3D, an error will be sent to the console. @@ -2897,7 +2897,7 @@ Destroys any of the objects created by PhysicsServer3D. If the :ref:`RID` **generic_6dof_joint_get_flag** **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag **)** |const| +:ref:`bool` **generic_6dof_joint_get_flag**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag`\ ) |const| Gets a generic_6_DOF_joint flag (see :ref:`G6DOFJointAxisFlag` constants). @@ -2909,7 +2909,7 @@ Gets a generic_6_DOF_joint flag (see :ref:`G6DOFJointAxisFlag` **generic_6dof_joint_get_param** **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param **)** |const| +:ref:`float` **generic_6dof_joint_get_param**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam`\ ) |const| Gets a generic_6_DOF_joint parameter (see :ref:`G6DOFJointAxisParam` constants). @@ -2921,7 +2921,7 @@ Gets a generic_6_DOF_joint parameter (see :ref:`G6DOFJointAxisParam` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag, :ref:`bool` enable **)** +|void| **generic_6dof_joint_set_flag**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag`, enable\: :ref:`bool`\ ) Sets a generic_6_DOF_joint flag (see :ref:`G6DOFJointAxisFlag` constants). @@ -2933,7 +2933,7 @@ Sets a generic_6_DOF_joint flag (see :ref:`G6DOFJointAxisFlag` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param, :ref:`float` value **)** +|void| **generic_6dof_joint_set_param**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam`, value\: :ref:`float`\ ) Sets a generic_6_DOF_joint parameter (see :ref:`G6DOFJointAxisParam` constants). @@ -2945,7 +2945,7 @@ Sets a generic_6_DOF_joint parameter (see :ref:`G6DOFJointAxisParam` **get_process_info** **(** :ref:`ProcessInfo` process_info **)** +:ref:`int` **get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) Returns information about the current state of the 3D physics engine. See :ref:`ProcessInfo` for a list of available states. @@ -2957,7 +2957,7 @@ Returns information about the current state of the 3D physics engine. See :ref:` .. rst-class:: classref-method -:ref:`RID` **heightmap_shape_create** **(** **)** +:ref:`RID` **heightmap_shape_create**\ (\ ) .. container:: contribute @@ -2971,7 +2971,7 @@ Returns information about the current state of the 3D physics engine. See :ref:` .. rst-class:: classref-method -:ref:`bool` **hinge_joint_get_flag** **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** |const| +:ref:`bool` **hinge_joint_get_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`\ ) |const| Gets a hinge_joint flag (see :ref:`HingeJointFlag` constants). @@ -2983,7 +2983,7 @@ Gets a hinge_joint flag (see :ref:`HingeJointFlag` **hinge_joint_get_param** **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** |const| +:ref:`float` **hinge_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`\ ) |const| Gets a hinge_joint parameter (see :ref:`HingeJointParam`). @@ -2995,7 +2995,7 @@ Gets a hinge_joint parameter (see :ref:`HingeJointParam` joint, :ref:`HingeJointFlag` flag, :ref:`bool` enabled **)** +|void| **hinge_joint_set_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`, enabled\: :ref:`bool`\ ) Sets a hinge_joint flag (see :ref:`HingeJointFlag` constants). @@ -3007,7 +3007,7 @@ Sets a hinge_joint flag (see :ref:`HingeJointFlag` joint, :ref:`HingeJointParam` param, :ref:`float` value **)** +|void| **hinge_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`, value\: :ref:`float`\ ) Sets a hinge_joint parameter (see :ref:`HingeJointParam` constants). @@ -3019,7 +3019,7 @@ Sets a hinge_joint parameter (see :ref:`HingeJointParam` joint **)** +|void| **joint_clear**\ (\ joint\: :ref:`RID`\ ) .. container:: contribute @@ -3033,7 +3033,7 @@ void **joint_clear** **(** :ref:`RID` joint **)** .. rst-class:: classref-method -:ref:`RID` **joint_create** **(** **)** +:ref:`RID` **joint_create**\ (\ ) .. container:: contribute @@ -3047,7 +3047,7 @@ void **joint_clear** **(** :ref:`RID` joint **)** .. rst-class:: classref-method -void **joint_disable_collisions_between_bodies** **(** :ref:`RID` joint, :ref:`bool` disable **)** +|void| **joint_disable_collisions_between_bodies**\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) Sets whether the bodies attached to the :ref:`Joint3D` will collide with each other. @@ -3059,7 +3059,7 @@ Sets whether the bodies attached to the :ref:`Joint3D` will colli .. rst-class:: classref-method -:ref:`int` **joint_get_solver_priority** **(** :ref:`RID` joint **)** |const| +:ref:`int` **joint_get_solver_priority**\ (\ joint\: :ref:`RID`\ ) |const| Gets the priority value of the Joint3D. @@ -3071,7 +3071,7 @@ Gets the priority value of the Joint3D. .. rst-class:: classref-method -:ref:`JointType` **joint_get_type** **(** :ref:`RID` joint **)** |const| +:ref:`JointType` **joint_get_type**\ (\ joint\: :ref:`RID`\ ) |const| Returns the type of the Joint3D. @@ -3083,7 +3083,7 @@ Returns the type of the Joint3D. .. rst-class:: classref-method -:ref:`bool` **joint_is_disabled_collisions_between_bodies** **(** :ref:`RID` joint **)** |const| +:ref:`bool` **joint_is_disabled_collisions_between_bodies**\ (\ joint\: :ref:`RID`\ ) |const| Returns whether the bodies attached to the :ref:`Joint3D` will collide with each other. @@ -3095,7 +3095,7 @@ Returns whether the bodies attached to the :ref:`Joint3D` will co .. rst-class:: classref-method -void **joint_make_cone_twist** **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** +|void| **joint_make_cone_twist**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) .. container:: contribute @@ -3109,7 +3109,7 @@ void **joint_make_cone_twist** **(** :ref:`RID` joint, :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** +|void| **joint_make_generic_6dof**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) .. container:: contribute @@ -3123,7 +3123,7 @@ void **joint_make_generic_6dof** **(** :ref:`RID` joint, :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` hinge_A, :ref:`RID` body_B, :ref:`Transform3D` hinge_B **)** +|void| **joint_make_hinge**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, hinge_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, hinge_B\: :ref:`Transform3D`\ ) .. container:: contribute @@ -3137,7 +3137,7 @@ void **joint_make_hinge** **(** :ref:`RID` joint, :ref:`RID` joint, :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** +|void| **joint_make_pin**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_A\: :ref:`Vector3`, body_B\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) .. container:: contribute @@ -3151,7 +3151,7 @@ void **joint_make_pin** **(** :ref:`RID` joint, :ref:`RID` .. rst-class:: classref-method -void **joint_make_slider** **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** +|void| **joint_make_slider**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) .. container:: contribute @@ -3165,7 +3165,7 @@ void **joint_make_slider** **(** :ref:`RID` joint, :ref:`RID` joint, :ref:`int` priority **)** +|void| **joint_set_solver_priority**\ (\ joint\: :ref:`RID`, priority\: :ref:`int`\ ) Sets the priority value of the Joint3D. @@ -3177,7 +3177,7 @@ Sets the priority value of the Joint3D. .. rst-class:: classref-method -:ref:`Vector3` **pin_joint_get_local_a** **(** :ref:`RID` joint **)** |const| +:ref:`Vector3` **pin_joint_get_local_a**\ (\ joint\: :ref:`RID`\ ) |const| Returns position of the joint in the local space of body a of the joint. @@ -3189,7 +3189,7 @@ Returns position of the joint in the local space of body a of the joint. .. rst-class:: classref-method -:ref:`Vector3` **pin_joint_get_local_b** **(** :ref:`RID` joint **)** |const| +:ref:`Vector3` **pin_joint_get_local_b**\ (\ joint\: :ref:`RID`\ ) |const| Returns position of the joint in the local space of body b of the joint. @@ -3201,7 +3201,7 @@ Returns position of the joint in the local space of body b of the joint. .. rst-class:: classref-method -:ref:`float` **pin_joint_get_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** |const| +:ref:`float` **pin_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |const| Gets a pin_joint parameter (see :ref:`PinJointParam` constants). @@ -3213,7 +3213,7 @@ Gets a pin_joint parameter (see :ref:`PinJointParam` joint, :ref:`Vector3` local_A **)** +|void| **pin_joint_set_local_a**\ (\ joint\: :ref:`RID`, local_A\: :ref:`Vector3`\ ) Sets position of the joint in the local space of body a of the joint. @@ -3225,7 +3225,7 @@ Sets position of the joint in the local space of body a of the joint. .. rst-class:: classref-method -void **pin_joint_set_local_b** **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** +|void| **pin_joint_set_local_b**\ (\ joint\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) Sets position of the joint in the local space of body b of the joint. @@ -3237,7 +3237,7 @@ Sets position of the joint in the local space of body b of the joint. .. rst-class:: classref-method -void **pin_joint_set_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** +|void| **pin_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) Sets a pin_joint parameter (see :ref:`PinJointParam` constants). @@ -3249,7 +3249,7 @@ Sets a pin_joint parameter (see :ref:`PinJointParam` **separation_ray_shape_create** **(** **)** +:ref:`RID` **separation_ray_shape_create**\ (\ ) .. container:: contribute @@ -3263,7 +3263,7 @@ Sets a pin_joint parameter (see :ref:`PinJointParam` active **)** +|void| **set_active**\ (\ active\: :ref:`bool`\ ) Activates or deactivates the 3D physics engine. @@ -3275,7 +3275,7 @@ Activates or deactivates the 3D physics engine. .. rst-class:: classref-method -:ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** |const| +:ref:`Variant` **shape_get_data**\ (\ shape\: :ref:`RID`\ ) |const| Returns the shape data. @@ -3287,7 +3287,7 @@ Returns the shape data. .. rst-class:: classref-method -:ref:`ShapeType` **shape_get_type** **(** :ref:`RID` shape **)** |const| +:ref:`ShapeType` **shape_get_type**\ (\ shape\: :ref:`RID`\ ) |const| Returns the type of shape (see :ref:`ShapeType` constants). @@ -3299,7 +3299,7 @@ Returns the type of shape (see :ref:`ShapeType` .. rst-class:: classref-method -void **shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` data **)** +|void| **shape_set_data**\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created :ref:`shape_get_type`. @@ -3311,7 +3311,7 @@ Sets the shape data that defines its shape and size. The data to be passed depen .. rst-class:: classref-method -:ref:`float` **slider_joint_get_param** **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** |const| +:ref:`float` **slider_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`\ ) |const| Gets a slider_joint parameter (see :ref:`SliderJointParam` constants). @@ -3323,7 +3323,7 @@ Gets a slider_joint parameter (see :ref:`SliderJointParam` joint, :ref:`SliderJointParam` param, :ref:`float` value **)** +|void| **slider_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`, value\: :ref:`float`\ ) Gets a slider_joint parameter (see :ref:`SliderJointParam` constants). @@ -3335,7 +3335,7 @@ Gets a slider_joint parameter (see :ref:`SliderJointParam` body, :ref:`RID` body_b **)** +|void| **soft_body_add_collision_exception**\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) Adds the given body to the list of bodies exempt from collisions. @@ -3347,7 +3347,7 @@ Adds the given body to the list of bodies exempt from collisions. .. rst-class:: classref-method -:ref:`RID` **soft_body_create** **(** **)** +:ref:`RID` **soft_body_create**\ (\ ) Creates a new soft body and returns its internal :ref:`RID`. @@ -3359,7 +3359,7 @@ Creates a new soft body and returns its internal :ref:`RID`. .. rst-class:: classref-method -:ref:`AABB` **soft_body_get_bounds** **(** :ref:`RID` body **)** |const| +:ref:`AABB` **soft_body_get_bounds**\ (\ body\: :ref:`RID`\ ) |const| Returns the bounds of the given soft body in global coordinates. @@ -3371,7 +3371,7 @@ Returns the bounds of the given soft body in global coordinates. .. rst-class:: classref-method -:ref:`int` **soft_body_get_collision_layer** **(** :ref:`RID` body **)** |const| +:ref:`int` **soft_body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |const| Returns the physics layer or layers that the given soft body belongs to. @@ -3383,7 +3383,7 @@ Returns the physics layer or layers that the given soft body belongs to. .. rst-class:: classref-method -:ref:`int` **soft_body_get_collision_mask** **(** :ref:`RID` body **)** |const| +:ref:`int` **soft_body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |const| Returns the physics layer or layers that the given soft body can collide with. @@ -3395,7 +3395,7 @@ Returns the physics layer or layers that the given soft body can collide with. .. rst-class:: classref-method -:ref:`float` **soft_body_get_damping_coefficient** **(** :ref:`RID` body **)** |const| +:ref:`float` **soft_body_get_damping_coefficient**\ (\ body\: :ref:`RID`\ ) |const| Returns the damping coefficient of the given soft body. @@ -3407,7 +3407,7 @@ Returns the damping coefficient of the given soft body. .. rst-class:: classref-method -:ref:`float` **soft_body_get_drag_coefficient** **(** :ref:`RID` body **)** |const| +:ref:`float` **soft_body_get_drag_coefficient**\ (\ body\: :ref:`RID`\ ) |const| Returns the drag coefficient of the given soft body. @@ -3419,7 +3419,7 @@ Returns the drag coefficient of the given soft body. .. rst-class:: classref-method -:ref:`float` **soft_body_get_linear_stiffness** **(** :ref:`RID` body **)** |const| +:ref:`float` **soft_body_get_linear_stiffness**\ (\ body\: :ref:`RID`\ ) |const| Returns the linear stiffness of the given soft body. @@ -3431,7 +3431,7 @@ Returns the linear stiffness of the given soft body. .. rst-class:: classref-method -:ref:`Vector3` **soft_body_get_point_global_position** **(** :ref:`RID` body, :ref:`int` point_index **)** |const| +:ref:`Vector3` **soft_body_get_point_global_position**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |const| Returns the current position of the given soft body point in global coordinates. @@ -3443,7 +3443,7 @@ Returns the current position of the given soft body point in global coordinates. .. rst-class:: classref-method -:ref:`float` **soft_body_get_pressure_coefficient** **(** :ref:`RID` body **)** |const| +:ref:`float` **soft_body_get_pressure_coefficient**\ (\ body\: :ref:`RID`\ ) |const| Returns the pressure coefficient of the given soft body. @@ -3455,7 +3455,7 @@ Returns the pressure coefficient of the given soft body. .. rst-class:: classref-method -:ref:`int` **soft_body_get_simulation_precision** **(** :ref:`RID` body **)** |const| +:ref:`int` **soft_body_get_simulation_precision**\ (\ body\: :ref:`RID`\ ) |const| Returns the simulation precision of the given soft body. @@ -3467,7 +3467,7 @@ Returns the simulation precision of the given soft body. .. rst-class:: classref-method -:ref:`RID` **soft_body_get_space** **(** :ref:`RID` body **)** |const| +:ref:`RID` **soft_body_get_space**\ (\ body\: :ref:`RID`\ ) |const| Returns the :ref:`RID` of the space assigned to the given soft body. @@ -3479,7 +3479,7 @@ Returns the :ref:`RID` of the space assigned to the given soft body. .. rst-class:: classref-method -:ref:`Variant` **soft_body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** |const| +:ref:`Variant` **soft_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |const| Returns the given soft body state (see :ref:`BodyState` constants). @@ -3493,7 +3493,7 @@ Returns the given soft body state (see :ref:`BodyState` **soft_body_get_total_mass** **(** :ref:`RID` body **)** |const| +:ref:`float` **soft_body_get_total_mass**\ (\ body\: :ref:`RID`\ ) |const| Returns the total mass assigned to the given soft body. @@ -3505,7 +3505,7 @@ Returns the total mass assigned to the given soft body. .. rst-class:: classref-method -:ref:`bool` **soft_body_is_point_pinned** **(** :ref:`RID` body, :ref:`int` point_index **)** |const| +:ref:`bool` **soft_body_is_point_pinned**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |const| Returns whether the given soft body point is pinned. @@ -3517,7 +3517,7 @@ Returns whether the given soft body point is pinned. .. rst-class:: classref-method -void **soft_body_move_point** **(** :ref:`RID` body, :ref:`int` point_index, :ref:`Vector3` global_position **)** +|void| **soft_body_move_point**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, global_position\: :ref:`Vector3`\ ) Moves the given soft body point to a position in global coordinates. @@ -3529,7 +3529,7 @@ Moves the given soft body point to a position in global coordinates. .. rst-class:: classref-method -void **soft_body_pin_point** **(** :ref:`RID` body, :ref:`int` point_index, :ref:`bool` pin **)** +|void| **soft_body_pin_point**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, pin\: :ref:`bool`\ ) Pins or unpins the given soft body point based on the value of ``pin``. @@ -3543,7 +3543,7 @@ Pins or unpins the given soft body point based on the value of ``pin``. .. rst-class:: classref-method -void **soft_body_remove_all_pinned_points** **(** :ref:`RID` body **)** +|void| **soft_body_remove_all_pinned_points**\ (\ body\: :ref:`RID`\ ) Unpins all points of the given soft body. @@ -3555,7 +3555,7 @@ Unpins all points of the given soft body. .. rst-class:: classref-method -void **soft_body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` body_b **)** +|void| **soft_body_remove_collision_exception**\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) Removes the given body from the list of bodies exempt from collisions. @@ -3567,7 +3567,7 @@ Removes the given body from the list of bodies exempt from collisions. .. rst-class:: classref-method -void **soft_body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** +|void| **soft_body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) Sets the physics layer or layers the given soft body belongs to. @@ -3579,7 +3579,7 @@ Sets the physics layer or layers the given soft body belongs to. .. rst-class:: classref-method -void **soft_body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** +|void| **soft_body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) Sets the physics layer or layers the given soft body can collide with. @@ -3591,7 +3591,7 @@ Sets the physics layer or layers the given soft body can collide with. .. rst-class:: classref-method -void **soft_body_set_damping_coefficient** **(** :ref:`RID` body, :ref:`float` damping_coefficient **)** +|void| **soft_body_set_damping_coefficient**\ (\ body\: :ref:`RID`, damping_coefficient\: :ref:`float`\ ) Sets the damping coefficient of the given soft body. Higher values will slow down the body more noticeably when forces are applied. @@ -3603,7 +3603,7 @@ Sets the damping coefficient of the given soft body. Higher values will slow dow .. rst-class:: classref-method -void **soft_body_set_drag_coefficient** **(** :ref:`RID` body, :ref:`float` drag_coefficient **)** +|void| **soft_body_set_drag_coefficient**\ (\ body\: :ref:`RID`, drag_coefficient\: :ref:`float`\ ) Sets the drag coefficient of the given soft body. Higher values increase this body's air resistance. @@ -3617,7 +3617,7 @@ Sets the drag coefficient of the given soft body. Higher values increase this bo .. rst-class:: classref-method -void **soft_body_set_linear_stiffness** **(** :ref:`RID` body, :ref:`float` stiffness **)** +|void| **soft_body_set_linear_stiffness**\ (\ body\: :ref:`RID`, stiffness\: :ref:`float`\ ) Sets the linear stiffness of the given soft body. Higher values will result in a stiffer body, while lower values will increase the body's ability to bend. The value can be between ``0.0`` and ``1.0`` (inclusive). @@ -3629,7 +3629,7 @@ Sets the linear stiffness of the given soft body. Higher values will result in a .. rst-class:: classref-method -void **soft_body_set_mesh** **(** :ref:`RID` body, :ref:`RID` mesh **)** +|void| **soft_body_set_mesh**\ (\ body\: :ref:`RID`, mesh\: :ref:`RID`\ ) Sets the mesh of the given soft body. @@ -3641,7 +3641,7 @@ Sets the mesh of the given soft body. .. rst-class:: classref-method -void **soft_body_set_pressure_coefficient** **(** :ref:`RID` body, :ref:`float` pressure_coefficient **)** +|void| **soft_body_set_pressure_coefficient**\ (\ body\: :ref:`RID`, pressure_coefficient\: :ref:`float`\ ) Sets the pressure coefficient of the given soft body. Simulates pressure build-up from inside this body. Higher values increase the strength of this effect. @@ -3653,7 +3653,7 @@ Sets the pressure coefficient of the given soft body. Simulates pressure build-u .. rst-class:: classref-method -void **soft_body_set_ray_pickable** **(** :ref:`RID` body, :ref:`bool` enable **)** +|void| **soft_body_set_ray_pickable**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) Sets whether the given soft body will be pickable when using object picking. @@ -3665,7 +3665,7 @@ Sets whether the given soft body will be pickable when using object picking. .. rst-class:: classref-method -void **soft_body_set_simulation_precision** **(** :ref:`RID` body, :ref:`int` simulation_precision **)** +|void| **soft_body_set_simulation_precision**\ (\ body\: :ref:`RID`, simulation_precision\: :ref:`int`\ ) Sets the simulation precision of the given soft body. Increasing this value will improve the resulting simulation, but can affect performance. Use with care. @@ -3677,7 +3677,7 @@ Sets the simulation precision of the given soft body. Increasing this value will .. rst-class:: classref-method -void **soft_body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** +|void| **soft_body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) Assigns a space to the given soft body (see :ref:`space_create`). @@ -3689,7 +3689,7 @@ Assigns a space to the given soft body (see :ref:`space_create` body, :ref:`BodyState` state, :ref:`Variant` variant **)** +|void| **soft_body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, variant\: :ref:`Variant`\ ) Sets the given body state for the given body (see :ref:`BodyState` constants). @@ -3703,7 +3703,7 @@ Sets the given body state for the given body (see :ref:`BodyState` body, :ref:`float` total_mass **)** +|void| **soft_body_set_total_mass**\ (\ body\: :ref:`RID`, total_mass\: :ref:`float`\ ) Sets the total mass for the given soft body. @@ -3715,7 +3715,7 @@ Sets the total mass for the given soft body. .. rst-class:: classref-method -void **soft_body_set_transform** **(** :ref:`RID` body, :ref:`Transform3D` transform **)** +|void| **soft_body_set_transform**\ (\ body\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) Sets the global transform of the given soft body. @@ -3727,7 +3727,7 @@ Sets the global transform of the given soft body. .. rst-class:: classref-method -void **soft_body_update_rendering_server** **(** :ref:`RID` body, :ref:`PhysicsServer3DRenderingServerHandler` rendering_server_handler **)** +|void| **soft_body_update_rendering_server**\ (\ body\: :ref:`RID`, rendering_server_handler\: :ref:`PhysicsServer3DRenderingServerHandler`\ ) Requests that the physics server updates the rendering server with the latest positions of the given soft body's points through the ``rendering_server_handler`` interface. @@ -3739,7 +3739,7 @@ Requests that the physics server updates the rendering server with the latest po .. rst-class:: classref-method -:ref:`RID` **space_create** **(** **)** +:ref:`RID` **space_create**\ (\ ) Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with :ref:`area_set_space`, or to a body with :ref:`body_set_space`. @@ -3751,7 +3751,7 @@ Creates a space. A space is a collection of parameters for the physics engine th .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState3D` **space_get_direct_state** **(** :ref:`RID` space **)** +:ref:`PhysicsDirectSpaceState3D` **space_get_direct_state**\ (\ space\: :ref:`RID`\ ) Returns the state of a space, a :ref:`PhysicsDirectSpaceState3D`. This object can be used to make collision/intersection queries. @@ -3763,7 +3763,7 @@ Returns the state of a space, a :ref:`PhysicsDirectSpaceState3D` **space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** |const| +:ref:`float` **space_get_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |const| Returns the value of a space parameter. @@ -3775,7 +3775,7 @@ Returns the value of a space parameter. .. rst-class:: classref-method -:ref:`bool` **space_is_active** **(** :ref:`RID` space **)** |const| +:ref:`bool` **space_is_active**\ (\ space\: :ref:`RID`\ ) |const| Returns whether the space is active. @@ -3787,7 +3787,7 @@ Returns whether the space is active. .. rst-class:: classref-method -void **space_set_active** **(** :ref:`RID` space, :ref:`bool` active **)** +|void| **space_set_active**\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) Marks a space as active. It will not have an effect, unless it is assigned to an area or body. @@ -3799,7 +3799,7 @@ Marks a space as active. It will not have an effect, unless it is assigned to an .. rst-class:: classref-method -void **space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** +|void| **space_set_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) Sets the value for a space parameter. A list of available parameters is on the :ref:`SpaceParameter` constants. @@ -3811,7 +3811,7 @@ Sets the value for a space parameter. A list of available parameters is on the : .. rst-class:: classref-method -:ref:`RID` **sphere_shape_create** **(** **)** +:ref:`RID` **sphere_shape_create**\ (\ ) .. container:: contribute @@ -3825,7 +3825,7 @@ Sets the value for a space parameter. A list of available parameters is on the : .. rst-class:: classref-method -:ref:`RID` **world_boundary_shape_create** **(** **)** +:ref:`RID` **world_boundary_shape_create**\ (\ ) .. container:: contribute @@ -3838,3 +3838,4 @@ Sets the value for a space parameter. A list of available parameters is on the : .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsserver3dextension.rst b/classes/class_physicsserver3dextension.rst index 8fa9d1087cb..420e8cffe98 100644 --- a/classes/class_physicsserver3dextension.rst +++ b/classes/class_physicsserver3dextension.rst @@ -31,387 +31,387 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform3D` transform, :ref:`bool` disabled **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_clear_shapes` **(** :ref:`RID` area **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_area_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_collision_layer` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_collision_mask` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_object_instance_id` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_area_get_param` **(** :ref:`RID` area, :ref:`AreaParameter` param **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_area_get_shape_count` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`_area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_area_get_space` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`_area_get_transform` **(** :ref:`RID` area **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Callable` callback **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Callable` callback **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_monitorable` **(** :ref:`RID` area, :ref:`bool` monitorable **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_param` **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_ray_pickable` **(** :ref:`RID` area, :ref:`bool` enable **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_shape_disabled` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform3D` transform **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_area_set_transform` **(** :ref:`RID` area, :ref:`Transform3D` transform **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_add_constant_central_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_add_constant_force` **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_add_constant_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform3D` transform, :ref:`bool` disabled **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_apply_central_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_apply_force` **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse, :ref:`Vector3` position **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_apply_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_clear_shapes` **(** :ref:`RID` body **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_body_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`_body_get_collision_exceptions` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_collision_layer` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_collision_mask` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_body_get_collision_priority` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_body_get_constant_force` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_body_get_constant_torque` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_body_get_contacts_reported_depth_threshold` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectBodyState3D` | :ref:`_body_get_direct_state` **(** :ref:`RID` body **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_max_contacts_reported` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`BodyMode` | :ref:`_body_get_mode` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_object_instance_id` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_body_get_param` **(** :ref:`RID` body, :ref:`BodyParameter` param **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_shape_count` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`_body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_body_get_space` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_body_get_user_flags` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_body_is_axis_locked` **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_body_is_continuous_collision_detection_enabled` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_body_is_omitting_force_integration` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_reset_mass_properties` **(** :ref:`RID` body **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_axis_lock` **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_collision_priority` **(** :ref:`RID` body, :ref:`float` priority **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_constant_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_constant_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_contacts_reported_depth_threshold` **(** :ref:`RID` body, :ref:`float` threshold **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_enable_continuous_collision_detection` **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Callable` callable, :ref:`Variant` userdata **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_mode` **(** :ref:`RID` body, :ref:`BodyMode` mode **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_param` **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`Variant` value **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_ray_pickable` **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_shape_disabled` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform3D` transform **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_state_sync_callback` **(** :ref:`RID` body, :ref:`Callable` callable **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_body_set_user_flags` **(** :ref:`RID` body, :ref:`int` flags **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_body_test_motion` **(** :ref:`RID` body, :ref:`Transform3D` from, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` max_collisions, :ref:`bool` collide_separation_ray, :ref:`bool` recovery_as_collision, PhysicsServer3DExtensionMotionResult* result **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_box_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_capsule_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_concave_polygon_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_cone_twist_joint_get_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_cone_twist_joint_set_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param, :ref:`float` value **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_convex_polygon_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_custom_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_cylinder_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_end_sync` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_finish` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_flush_queries` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_free_rid` **(** :ref:`RID` rid **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_generic_6dof_joint_get_flag` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_generic_6dof_joint_get_param` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_generic_6dof_joint_set_flag` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag, :ref:`bool` enable **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_generic_6dof_joint_set_param` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param, :ref:`float` value **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_process_info` **(** :ref:`ProcessInfo` process_info **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_heightmap_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_hinge_joint_get_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_hinge_joint_get_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_hinge_joint_set_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag, :ref:`bool` enabled **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_hinge_joint_set_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param, :ref:`float` value **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_init` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_flushing_queries` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_clear` **(** :ref:`RID` joint **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_joint_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_disable_collisions_between_bodies` **(** :ref:`RID` joint, :ref:`bool` disable **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_joint_get_solver_priority` **(** :ref:`RID` joint **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`JointType` | :ref:`_joint_get_type` **(** :ref:`RID` joint **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_joint_is_disabled_collisions_between_bodies` **(** :ref:`RID` joint **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_make_cone_twist` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_make_generic_6dof` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_make_hinge` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` hinge_A, :ref:`RID` body_B, :ref:`Transform3D` hinge_B **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_make_hinge_simple` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Vector3` pivot_A, :ref:`Vector3` axis_A, :ref:`RID` body_B, :ref:`Vector3` pivot_B, :ref:`Vector3` axis_B **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_make_pin` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_make_slider` **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_joint_set_solver_priority` **(** :ref:`RID` joint, :ref:`int` priority **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_pin_joint_get_local_a` **(** :ref:`RID` joint **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_pin_joint_get_local_b` **(** :ref:`RID` joint **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_pin_joint_get_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_pin_joint_set_local_a` **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_pin_joint_set_local_b` **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_pin_joint_set_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_separation_ray_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_active` **(** :ref:`bool` active **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shape_get_custom_solver_bias` **(** :ref:`RID` shape **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_shape_get_data` **(** :ref:`RID` shape **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shape_get_margin` **(** :ref:`RID` shape **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ShapeType` | :ref:`_shape_get_type` **(** :ref:`RID` shape **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shape_set_custom_solver_bias` **(** :ref:`RID` shape, :ref:`float` bias **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shape_set_margin` **(** :ref:`RID` shape, :ref:`float` margin **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_slider_joint_get_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_slider_joint_set_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param, :ref:`float` value **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` body_b **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_soft_body_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`_soft_body_get_bounds` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`_soft_body_get_collision_exceptions` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_soft_body_get_collision_layer` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_soft_body_get_collision_mask` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_soft_body_get_damping_coefficient` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_soft_body_get_drag_coefficient` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_soft_body_get_linear_stiffness` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`_soft_body_get_point_global_position` **(** :ref:`RID` body, :ref:`int` point_index **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_soft_body_get_pressure_coefficient` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_soft_body_get_simulation_precision` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_soft_body_get_space` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_soft_body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_soft_body_get_total_mass` **(** :ref:`RID` body **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_soft_body_is_point_pinned` **(** :ref:`RID` body, :ref:`int` point_index **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_move_point` **(** :ref:`RID` body, :ref:`int` point_index, :ref:`Vector3` global_position **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_pin_point` **(** :ref:`RID` body, :ref:`int` point_index, :ref:`bool` pin **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_remove_all_pinned_points` **(** :ref:`RID` body **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` body_b **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_damping_coefficient` **(** :ref:`RID` body, :ref:`float` damping_coefficient **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_drag_coefficient` **(** :ref:`RID` body, :ref:`float` drag_coefficient **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_linear_stiffness` **(** :ref:`RID` body, :ref:`float` linear_stiffness **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_mesh` **(** :ref:`RID` body, :ref:`RID` mesh **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_pressure_coefficient` **(** :ref:`RID` body, :ref:`float` pressure_coefficient **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_ray_pickable` **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_simulation_precision` **(** :ref:`RID` body, :ref:`int` simulation_precision **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` variant **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_total_mass` **(** :ref:`RID` body, :ref:`float` total_mass **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_set_transform` **(** :ref:`RID` body, :ref:`Transform3D` transform **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_soft_body_update_rendering_server` **(** :ref:`RID` body, :ref:`PhysicsServer3DRenderingServerHandler` rendering_server_handler **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_space_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_space_get_contact_count` **(** :ref:`RID` space **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`_space_get_contacts` **(** :ref:`RID` space **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsDirectSpaceState3D` | :ref:`_space_get_direct_state` **(** :ref:`RID` space **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_space_is_active` **(** :ref:`RID` space **)** |virtual| |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_space_set_debug_contacts` **(** :ref:`RID` space, :ref:`int` max_contacts **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_space_set_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_sphere_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_step` **(** :ref:`float` step **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_sync` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_world_boundary_shape_create` **(** **)** |virtual| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`body_test_motion_is_excluding_body` **(** :ref:`RID` body **)** |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`body_test_motion_is_excluding_object` **(** :ref:`int` object **)** |const| | - +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_add_shape`\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D`, disabled\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_attach_object_instance_id`\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_clear_shapes`\ (\ area\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_area_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_collision_layer`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_collision_mask`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_object_instance_id`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_area_get_param`\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_area_get_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_area_get_shape_count`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`_area_get_shape_transform`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_area_get_space`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`_area_get_transform`\ (\ area\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_remove_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_area_monitor_callback`\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_collision_layer`\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_collision_mask`\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_monitor_callback`\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_monitorable`\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_param`\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_ray_pickable`\ (\ area\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_shape`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_shape_disabled`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_shape_transform`\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_space`\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_area_set_transform`\ (\ area\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_collision_exception`\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_constant_central_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_constant_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_constant_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_add_shape`\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D`, disabled\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_central_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_central_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_apply_torque_impulse`\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_attach_object_instance_id`\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_clear_shapes`\ (\ body\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_body_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`_body_get_collision_exceptions`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_collision_layer`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_collision_mask`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_body_get_collision_priority`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_body_get_constant_force`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_body_get_constant_torque`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_body_get_contacts_reported_depth_threshold`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectBodyState3D` | :ref:`_body_get_direct_state`\ (\ body\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_max_contacts_reported`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`BodyMode` | :ref:`_body_get_mode`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_object_instance_id`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_body_get_param`\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_body_get_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_shape_count`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`_body_get_shape_transform`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_body_get_space`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_body_get_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_body_get_user_flags`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_body_is_axis_locked`\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_body_is_continuous_collision_detection_enabled`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_body_is_omitting_force_integration`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_remove_collision_exception`\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_remove_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_reset_mass_properties`\ (\ body\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_axis_lock`\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_axis_velocity`\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_collision_layer`\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_collision_mask`\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_collision_priority`\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_constant_force`\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_constant_torque`\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_contacts_reported_depth_threshold`\ (\ body\: :ref:`RID`, threshold\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_enable_continuous_collision_detection`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_force_integration_callback`\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_max_contacts_reported`\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_mode`\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_omit_force_integration`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_param`\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_ray_pickable`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_shape`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_shape_disabled`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_shape_transform`\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_space`\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_state_sync_callback`\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_body_set_user_flags`\ (\ body\: :ref:`RID`, flags\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_body_test_motion`\ (\ body\: :ref:`RID`, from\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, max_collisions\: :ref:`int`, collide_separation_ray\: :ref:`bool`, recovery_as_collision\: :ref:`bool`, result\: ``PhysicsServer3DExtensionMotionResult*``\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_box_shape_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_capsule_shape_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_concave_polygon_shape_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_cone_twist_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_cone_twist_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`, value\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_convex_polygon_shape_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_custom_shape_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_cylinder_shape_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_end_sync`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_finish`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_flush_queries`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_free_rid`\ (\ rid\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_generic_6dof_joint_get_flag`\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_generic_6dof_joint_get_param`\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_generic_6dof_joint_set_flag`\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag`, enable\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_generic_6dof_joint_set_param`\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam`, value\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_process_info`\ (\ process_info\: :ref:`ProcessInfo`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_heightmap_shape_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_hinge_joint_get_flag`\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_hinge_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_hinge_joint_set_flag`\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`, enabled\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_hinge_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`, value\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_init`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_flushing_queries`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_clear`\ (\ joint\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_joint_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_disable_collisions_between_bodies`\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_joint_get_solver_priority`\ (\ joint\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`JointType` | :ref:`_joint_get_type`\ (\ joint\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_joint_is_disabled_collisions_between_bodies`\ (\ joint\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_make_cone_twist`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_make_generic_6dof`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_make_hinge`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, hinge_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, hinge_B\: :ref:`Transform3D`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_make_hinge_simple`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, pivot_A\: :ref:`Vector3`, axis_A\: :ref:`Vector3`, body_B\: :ref:`RID`, pivot_B\: :ref:`Vector3`, axis_B\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_make_pin`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_A\: :ref:`Vector3`, body_B\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_make_slider`\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_joint_set_solver_priority`\ (\ joint\: :ref:`RID`, priority\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_pin_joint_get_local_a`\ (\ joint\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_pin_joint_get_local_b`\ (\ joint\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_pin_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_pin_joint_set_local_a`\ (\ joint\: :ref:`RID`, local_A\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_pin_joint_set_local_b`\ (\ joint\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_pin_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_separation_ray_shape_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_active`\ (\ active\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shape_get_custom_solver_bias`\ (\ shape\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_shape_get_data`\ (\ shape\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shape_get_margin`\ (\ shape\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ShapeType` | :ref:`_shape_get_type`\ (\ shape\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shape_set_custom_solver_bias`\ (\ shape\: :ref:`RID`, bias\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shape_set_data`\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shape_set_margin`\ (\ shape\: :ref:`RID`, margin\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_slider_joint_get_param`\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_slider_joint_set_param`\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`, value\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_add_collision_exception`\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_soft_body_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`_soft_body_get_bounds`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`_soft_body_get_collision_exceptions`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_soft_body_get_collision_layer`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_soft_body_get_collision_mask`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_soft_body_get_damping_coefficient`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_soft_body_get_drag_coefficient`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_soft_body_get_linear_stiffness`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_soft_body_get_point_global_position`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_soft_body_get_pressure_coefficient`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_soft_body_get_simulation_precision`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_soft_body_get_space`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_soft_body_get_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_soft_body_get_total_mass`\ (\ body\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_soft_body_is_point_pinned`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_move_point`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, global_position\: :ref:`Vector3`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_pin_point`\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, pin\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_remove_all_pinned_points`\ (\ body\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_remove_collision_exception`\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_collision_layer`\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_collision_mask`\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_damping_coefficient`\ (\ body\: :ref:`RID`, damping_coefficient\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_drag_coefficient`\ (\ body\: :ref:`RID`, drag_coefficient\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_linear_stiffness`\ (\ body\: :ref:`RID`, linear_stiffness\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_mesh`\ (\ body\: :ref:`RID`, mesh\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_pressure_coefficient`\ (\ body\: :ref:`RID`, pressure_coefficient\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_ray_pickable`\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_simulation_precision`\ (\ body\: :ref:`RID`, simulation_precision\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_space`\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_state`\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, variant\: :ref:`Variant`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_total_mass`\ (\ body\: :ref:`RID`, total_mass\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_set_transform`\ (\ body\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_soft_body_update_rendering_server`\ (\ body\: :ref:`RID`, rendering_server_handler\: :ref:`PhysicsServer3DRenderingServerHandler`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_space_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_space_get_contact_count`\ (\ space\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`_space_get_contacts`\ (\ space\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsDirectSpaceState3D` | :ref:`_space_get_direct_state`\ (\ space\: :ref:`RID`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_space_get_param`\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_space_is_active`\ (\ space\: :ref:`RID`\ ) |virtual| |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_space_set_active`\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_space_set_debug_contacts`\ (\ space\: :ref:`RID`, max_contacts\: :ref:`int`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_space_set_param`\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_sphere_shape_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_step`\ (\ step\: :ref:`float`\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_sync`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_world_boundary_shape_create`\ (\ ) |virtual| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`body_test_motion_is_excluding_body`\ (\ body\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`body_test_motion_is_excluding_object`\ (\ object\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -426,7 +426,7 @@ Method Descriptions .. rst-class:: classref-method -void **_area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform3D` transform, :ref:`bool` disabled **)** |virtual| +|void| **_area_add_shape**\ (\ area\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D`, disabled\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -440,7 +440,7 @@ void **_area_add_shape** **(** :ref:`RID` area, :ref:`RID` .. rst-class:: classref-method -void **_area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** |virtual| +|void| **_area_attach_object_instance_id**\ (\ area\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -454,7 +454,7 @@ void **_area_attach_object_instance_id** **(** :ref:`RID` area, :ref: .. rst-class:: classref-method -void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| +|void| **_area_clear_shapes**\ (\ area\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -468,7 +468,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_area_create** **(** **)** |virtual| +:ref:`RID` **_area_create**\ (\ ) |virtual| .. container:: contribute @@ -482,7 +482,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_area_get_collision_layer** **(** :ref:`RID` area **)** |virtual| |const| +:ref:`int` **_area_get_collision_layer**\ (\ area\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -496,7 +496,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_area_get_collision_mask** **(** :ref:`RID` area **)** |virtual| |const| +:ref:`int` **_area_get_collision_mask**\ (\ area\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -510,7 +510,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_area_get_object_instance_id** **(** :ref:`RID` area **)** |virtual| |const| +:ref:`int` **_area_get_object_instance_id**\ (\ area\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -524,7 +524,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`Variant` **_area_get_param** **(** :ref:`RID` area, :ref:`AreaParameter` param **)** |virtual| |const| +:ref:`Variant` **_area_get_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`\ ) |virtual| |const| .. container:: contribute @@ -538,7 +538,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| +:ref:`RID` **_area_get_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -552,7 +552,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_area_get_shape_count** **(** :ref:`RID` area **)** |virtual| |const| +:ref:`int` **_area_get_shape_count**\ (\ area\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -566,7 +566,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`Transform3D` **_area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| +:ref:`Transform3D` **_area_get_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -580,7 +580,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_area_get_space** **(** :ref:`RID` area **)** |virtual| |const| +:ref:`RID` **_area_get_space**\ (\ area\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -594,7 +594,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -:ref:`Transform3D` **_area_get_transform** **(** :ref:`RID` area **)** |virtual| |const| +:ref:`Transform3D` **_area_get_transform**\ (\ area\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -608,7 +608,7 @@ void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| .. rst-class:: classref-method -void **_area_remove_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| +|void| **_area_remove_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -622,7 +622,7 @@ void **_area_remove_shape** **(** :ref:`RID` area, :ref:`int` area, :ref:`Callable` callback **)** |virtual| +|void| **_area_set_area_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| .. container:: contribute @@ -636,7 +636,7 @@ void **_area_set_area_monitor_callback** **(** :ref:`RID` area, :ref: .. rst-class:: classref-method -void **_area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** |virtual| +|void| **_area_set_collision_layer**\ (\ area\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -650,7 +650,7 @@ void **_area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` area, :ref:`int` mask **)** |virtual| +|void| **_area_set_collision_mask**\ (\ area\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -664,7 +664,7 @@ void **_area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` area, :ref:`Callable` callback **)** |virtual| +|void| **_area_set_monitor_callback**\ (\ area\: :ref:`RID`, callback\: :ref:`Callable`\ ) |virtual| .. container:: contribute @@ -678,7 +678,7 @@ void **_area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Call .. rst-class:: classref-method -void **_area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** |virtual| +|void| **_area_set_monitorable**\ (\ area\: :ref:`RID`, monitorable\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -692,7 +692,7 @@ void **_area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** |virtual| +|void| **_area_set_param**\ (\ area\: :ref:`RID`, param\: :ref:`AreaParameter`, value\: :ref:`Variant`\ ) |virtual| .. container:: contribute @@ -706,7 +706,7 @@ void **_area_set_param** **(** :ref:`RID` area, :ref:`AreaParameter` area, :ref:`bool` enable **)** |virtual| +|void| **_area_set_ray_pickable**\ (\ area\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -720,7 +720,7 @@ void **_area_set_ray_pickable** **(** :ref:`RID` area, :ref:`bool` area, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| +|void| **_area_set_shape**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -734,7 +734,7 @@ void **_area_set_shape** **(** :ref:`RID` area, :ref:`int` .. rst-class:: classref-method -void **_area_set_shape_disabled** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| +|void| **_area_set_shape_disabled**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -748,7 +748,7 @@ void **_area_set_shape_disabled** **(** :ref:`RID` area, :ref:`int` area, :ref:`int` shape_idx, :ref:`Transform3D` transform **)** |virtual| +|void| **_area_set_shape_transform**\ (\ area\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| .. container:: contribute @@ -762,7 +762,7 @@ void **_area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` area, :ref:`RID` space **)** |virtual| +|void| **_area_set_space**\ (\ area\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -776,7 +776,7 @@ void **_area_set_space** **(** :ref:`RID` area, :ref:`RID` .. rst-class:: classref-method -void **_area_set_transform** **(** :ref:`RID` area, :ref:`Transform3D` transform **)** |virtual| +|void| **_area_set_transform**\ (\ area\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) |virtual| .. container:: contribute @@ -790,7 +790,7 @@ void **_area_set_transform** **(** :ref:`RID` area, :ref:`Transform3D .. rst-class:: classref-method -void **_body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| +|void| **_body_add_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -804,7 +804,7 @@ void **_body_add_collision_exception** **(** :ref:`RID` body, :ref:`R .. rst-class:: classref-method -void **_body_add_constant_central_force** **(** :ref:`RID` body, :ref:`Vector3` force **)** |virtual| +|void| **_body_add_constant_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -818,7 +818,7 @@ void **_body_add_constant_central_force** **(** :ref:`RID` body, :ref .. rst-class:: classref-method -void **_body_add_constant_force** **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** |virtual| +|void| **_body_add_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -832,7 +832,7 @@ void **_body_add_constant_force** **(** :ref:`RID` body, :ref:`Vector .. rst-class:: classref-method -void **_body_add_constant_torque** **(** :ref:`RID` body, :ref:`Vector3` torque **)** |virtual| +|void| **_body_add_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -846,7 +846,7 @@ void **_body_add_constant_torque** **(** :ref:`RID` body, :ref:`Vecto .. rst-class:: classref-method -void **_body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform3D` transform, :ref:`bool` disabled **)** |virtual| +|void| **_body_add_shape**\ (\ body\: :ref:`RID`, shape\: :ref:`RID`, transform\: :ref:`Transform3D`, disabled\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -860,7 +860,7 @@ void **_body_add_shape** **(** :ref:`RID` body, :ref:`RID` .. rst-class:: classref-method -void **_body_apply_central_force** **(** :ref:`RID` body, :ref:`Vector3` force **)** |virtual| +|void| **_body_apply_central_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -874,7 +874,7 @@ void **_body_apply_central_force** **(** :ref:`RID` body, :ref:`Vecto .. rst-class:: classref-method -void **_body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** |virtual| +|void| **_body_apply_central_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -888,7 +888,7 @@ void **_body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vec .. rst-class:: classref-method -void **_body_apply_force** **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** |virtual| +|void| **_body_apply_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -902,7 +902,7 @@ void **_body_apply_force** **(** :ref:`RID` body, :ref:`Vector3` body, :ref:`Vector3` impulse, :ref:`Vector3` position **)** |virtual| +|void| **_body_apply_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`, position\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -916,7 +916,7 @@ void **_body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector3` body, :ref:`Vector3` torque **)** |virtual| +|void| **_body_apply_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -930,7 +930,7 @@ void **_body_apply_torque** **(** :ref:`RID` body, :ref:`Vector3` body, :ref:`Vector3` impulse **)** |virtual| +|void| **_body_apply_torque_impulse**\ (\ body\: :ref:`RID`, impulse\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -944,7 +944,7 @@ void **_body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`Vect .. rst-class:: classref-method -void **_body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** |virtual| +|void| **_body_attach_object_instance_id**\ (\ body\: :ref:`RID`, id\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -958,7 +958,7 @@ void **_body_attach_object_instance_id** **(** :ref:`RID` body, :ref: .. rst-class:: classref-method -void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| +|void| **_body_clear_shapes**\ (\ body\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -972,7 +972,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_body_create** **(** **)** |virtual| +:ref:`RID` **_body_create**\ (\ ) |virtual| .. container:: contribute @@ -986,7 +986,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`RID[]` **_body_get_collision_exceptions** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`Array`\[:ref:`RID`\] **_body_get_collision_exceptions**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1000,7 +1000,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_body_get_collision_layer** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`int` **_body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1014,7 +1014,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_body_get_collision_mask** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`int` **_body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1028,7 +1028,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`float` **_body_get_collision_priority** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`float` **_body_get_collision_priority**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1042,7 +1042,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`Vector3` **_body_get_constant_force** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`Vector3` **_body_get_constant_force**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1056,7 +1056,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`Vector3` **_body_get_constant_torque** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`Vector3` **_body_get_constant_torque**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1070,7 +1070,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`float` **_body_get_contacts_reported_depth_threshold** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`float` **_body_get_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1084,7 +1084,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`PhysicsDirectBodyState3D` **_body_get_direct_state** **(** :ref:`RID` body **)** |virtual| +:ref:`PhysicsDirectBodyState3D` **_body_get_direct_state**\ (\ body\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -1098,7 +1098,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_body_get_max_contacts_reported** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`int` **_body_get_max_contacts_reported**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1112,7 +1112,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`BodyMode` **_body_get_mode** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`BodyMode` **_body_get_mode**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1126,7 +1126,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_body_get_object_instance_id** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`int` **_body_get_object_instance_id**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1140,7 +1140,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`Variant` **_body_get_param** **(** :ref:`RID` body, :ref:`BodyParameter` param **)** |virtual| |const| +:ref:`Variant` **_body_get_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`\ ) |virtual| |const| .. container:: contribute @@ -1154,7 +1154,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| +:ref:`RID` **_body_get_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -1168,7 +1168,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_body_get_shape_count** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`int` **_body_get_shape_count**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1182,7 +1182,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`Transform3D` **_body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| +:ref:`Transform3D` **_body_get_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -1196,7 +1196,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_body_get_space** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`RID` **_body_get_space**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1210,7 +1210,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`Variant` **_body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** |virtual| |const| +:ref:`Variant` **_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |const| .. container:: contribute @@ -1224,7 +1224,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_body_get_user_flags** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`int` **_body_get_user_flags**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1238,7 +1238,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_body_is_axis_locked** **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** |virtual| |const| +:ref:`bool` **_body_is_axis_locked**\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`\ ) |virtual| |const| .. container:: contribute @@ -1252,7 +1252,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_body_is_continuous_collision_detection_enabled** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`bool` **_body_is_continuous_collision_detection_enabled**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1266,7 +1266,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_body_is_omitting_force_integration** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`bool` **_body_is_omitting_force_integration**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1280,7 +1280,7 @@ void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| .. rst-class:: classref-method -void **_body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| +|void| **_body_remove_collision_exception**\ (\ body\: :ref:`RID`, excepted_body\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -1294,7 +1294,7 @@ void **_body_remove_collision_exception** **(** :ref:`RID` body, :ref .. rst-class:: classref-method -void **_body_remove_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| +|void| **_body_remove_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1308,7 +1308,7 @@ void **_body_remove_shape** **(** :ref:`RID` body, :ref:`int` body **)** |virtual| +|void| **_body_reset_mass_properties**\ (\ body\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -1322,7 +1322,7 @@ void **_body_reset_mass_properties** **(** :ref:`RID` body **)** |vir .. rst-class:: classref-method -void **_body_set_axis_lock** **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** |virtual| +|void| **_body_set_axis_lock**\ (\ body\: :ref:`RID`, axis\: :ref:`BodyAxis`, lock\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1336,7 +1336,7 @@ void **_body_set_axis_lock** **(** :ref:`RID` body, :ref:`BodyAxis` body, :ref:`Vector3` axis_velocity **)** |virtual| +|void| **_body_set_axis_velocity**\ (\ body\: :ref:`RID`, axis_velocity\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -1350,7 +1350,7 @@ void **_body_set_axis_velocity** **(** :ref:`RID` body, :ref:`Vector3 .. rst-class:: classref-method -void **_body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** |virtual| +|void| **_body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1364,7 +1364,7 @@ void **_body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` body, :ref:`int` mask **)** |virtual| +|void| **_body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1378,7 +1378,7 @@ void **_body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` body, :ref:`float` priority **)** |virtual| +|void| **_body_set_collision_priority**\ (\ body\: :ref:`RID`, priority\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1392,7 +1392,7 @@ void **_body_set_collision_priority** **(** :ref:`RID` body, :ref:`fl .. rst-class:: classref-method -void **_body_set_constant_force** **(** :ref:`RID` body, :ref:`Vector3` force **)** |virtual| +|void| **_body_set_constant_force**\ (\ body\: :ref:`RID`, force\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -1406,7 +1406,7 @@ void **_body_set_constant_force** **(** :ref:`RID` body, :ref:`Vector .. rst-class:: classref-method -void **_body_set_constant_torque** **(** :ref:`RID` body, :ref:`Vector3` torque **)** |virtual| +|void| **_body_set_constant_torque**\ (\ body\: :ref:`RID`, torque\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -1420,7 +1420,7 @@ void **_body_set_constant_torque** **(** :ref:`RID` body, :ref:`Vecto .. rst-class:: classref-method -void **_body_set_contacts_reported_depth_threshold** **(** :ref:`RID` body, :ref:`float` threshold **)** |virtual| +|void| **_body_set_contacts_reported_depth_threshold**\ (\ body\: :ref:`RID`, threshold\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1434,7 +1434,7 @@ void **_body_set_contacts_reported_depth_threshold** **(** :ref:`RID` .. rst-class:: classref-method -void **_body_set_enable_continuous_collision_detection** **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| +|void| **_body_set_enable_continuous_collision_detection**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1448,7 +1448,7 @@ void **_body_set_enable_continuous_collision_detection** **(** :ref:`RID` body, :ref:`Callable` callable, :ref:`Variant` userdata **)** |virtual| +|void| **_body_set_force_integration_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`, userdata\: :ref:`Variant`\ ) |virtual| .. container:: contribute @@ -1462,7 +1462,7 @@ void **_body_set_force_integration_callback** **(** :ref:`RID` body, .. rst-class:: classref-method -void **_body_set_max_contacts_reported** **(** :ref:`RID` body, :ref:`int` amount **)** |virtual| +|void| **_body_set_max_contacts_reported**\ (\ body\: :ref:`RID`, amount\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1476,7 +1476,7 @@ void **_body_set_max_contacts_reported** **(** :ref:`RID` body, :ref: .. rst-class:: classref-method -void **_body_set_mode** **(** :ref:`RID` body, :ref:`BodyMode` mode **)** |virtual| +|void| **_body_set_mode**\ (\ body\: :ref:`RID`, mode\: :ref:`BodyMode`\ ) |virtual| .. container:: contribute @@ -1490,7 +1490,7 @@ void **_body_set_mode** **(** :ref:`RID` body, :ref:`BodyMode` body, :ref:`bool` enable **)** |virtual| +|void| **_body_set_omit_force_integration**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1504,7 +1504,7 @@ void **_body_set_omit_force_integration** **(** :ref:`RID` body, :ref .. rst-class:: classref-method -void **_body_set_param** **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`Variant` value **)** |virtual| +|void| **_body_set_param**\ (\ body\: :ref:`RID`, param\: :ref:`BodyParameter`, value\: :ref:`Variant`\ ) |virtual| .. container:: contribute @@ -1518,7 +1518,7 @@ void **_body_set_param** **(** :ref:`RID` body, :ref:`BodyParameter` body, :ref:`bool` enable **)** |virtual| +|void| **_body_set_ray_pickable**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1532,7 +1532,7 @@ void **_body_set_ray_pickable** **(** :ref:`RID` body, :ref:`bool` body, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| +|void| **_body_set_shape**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, shape\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -1546,7 +1546,7 @@ void **_body_set_shape** **(** :ref:`RID` body, :ref:`int` .. rst-class:: classref-method -void **_body_set_shape_disabled** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| +|void| **_body_set_shape_disabled**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1560,7 +1560,7 @@ void **_body_set_shape_disabled** **(** :ref:`RID` body, :ref:`int` body, :ref:`int` shape_idx, :ref:`Transform3D` transform **)** |virtual| +|void| **_body_set_shape_transform**\ (\ body\: :ref:`RID`, shape_idx\: :ref:`int`, transform\: :ref:`Transform3D`\ ) |virtual| .. container:: contribute @@ -1574,7 +1574,7 @@ void **_body_set_shape_transform** **(** :ref:`RID` body, :ref:`int` body, :ref:`RID` space **)** |virtual| +|void| **_body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -1588,7 +1588,7 @@ void **_body_set_space** **(** :ref:`RID` body, :ref:`RID` .. rst-class:: classref-method -void **_body_set_state** **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** |virtual| +|void| **_body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, value\: :ref:`Variant`\ ) |virtual| .. container:: contribute @@ -1602,7 +1602,7 @@ void **_body_set_state** **(** :ref:`RID` body, :ref:`BodyState` body, :ref:`Callable` callable **)** |virtual| +|void| **_body_set_state_sync_callback**\ (\ body\: :ref:`RID`, callable\: :ref:`Callable`\ ) |virtual| .. container:: contribute @@ -1616,7 +1616,7 @@ void **_body_set_state_sync_callback** **(** :ref:`RID` body, :ref:`C .. rst-class:: classref-method -void **_body_set_user_flags** **(** :ref:`RID` body, :ref:`int` flags **)** |virtual| +|void| **_body_set_user_flags**\ (\ body\: :ref:`RID`, flags\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1630,7 +1630,7 @@ void **_body_set_user_flags** **(** :ref:`RID` body, :ref:`int` **_body_test_motion** **(** :ref:`RID` body, :ref:`Transform3D` from, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` max_collisions, :ref:`bool` collide_separation_ray, :ref:`bool` recovery_as_collision, PhysicsServer3DExtensionMotionResult* result **)** |virtual| |const| +:ref:`bool` **_body_test_motion**\ (\ body\: :ref:`RID`, from\: :ref:`Transform3D`, motion\: :ref:`Vector3`, margin\: :ref:`float`, max_collisions\: :ref:`int`, collide_separation_ray\: :ref:`bool`, recovery_as_collision\: :ref:`bool`, result\: ``PhysicsServer3DExtensionMotionResult*``\ ) |virtual| |const| .. container:: contribute @@ -1644,7 +1644,7 @@ void **_body_set_user_flags** **(** :ref:`RID` body, :ref:`int` **_box_shape_create** **(** **)** |virtual| +:ref:`RID` **_box_shape_create**\ (\ ) |virtual| .. container:: contribute @@ -1658,7 +1658,7 @@ void **_body_set_user_flags** **(** :ref:`RID` body, :ref:`int` **_capsule_shape_create** **(** **)** |virtual| +:ref:`RID` **_capsule_shape_create**\ (\ ) |virtual| .. container:: contribute @@ -1672,7 +1672,7 @@ void **_body_set_user_flags** **(** :ref:`RID` body, :ref:`int` **_concave_polygon_shape_create** **(** **)** |virtual| +:ref:`RID` **_concave_polygon_shape_create**\ (\ ) |virtual| .. container:: contribute @@ -1686,7 +1686,7 @@ void **_body_set_user_flags** **(** :ref:`RID` body, :ref:`int` **_cone_twist_joint_get_param** **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** |virtual| |const| +:ref:`float` **_cone_twist_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`\ ) |virtual| |const| .. container:: contribute @@ -1700,7 +1700,7 @@ void **_body_set_user_flags** **(** :ref:`RID` body, :ref:`int` joint, :ref:`ConeTwistJointParam` param, :ref:`float` value **)** |virtual| +|void| **_cone_twist_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`ConeTwistJointParam`, value\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1714,7 +1714,7 @@ void **_cone_twist_joint_set_param** **(** :ref:`RID` joint, :ref:`Co .. rst-class:: classref-method -:ref:`RID` **_convex_polygon_shape_create** **(** **)** |virtual| +:ref:`RID` **_convex_polygon_shape_create**\ (\ ) |virtual| .. container:: contribute @@ -1728,7 +1728,7 @@ void **_cone_twist_joint_set_param** **(** :ref:`RID` joint, :ref:`Co .. rst-class:: classref-method -:ref:`RID` **_custom_shape_create** **(** **)** |virtual| +:ref:`RID` **_custom_shape_create**\ (\ ) |virtual| .. container:: contribute @@ -1742,7 +1742,7 @@ void **_cone_twist_joint_set_param** **(** :ref:`RID` joint, :ref:`Co .. rst-class:: classref-method -:ref:`RID` **_cylinder_shape_create** **(** **)** |virtual| +:ref:`RID` **_cylinder_shape_create**\ (\ ) |virtual| .. container:: contribute @@ -1756,7 +1756,7 @@ void **_cone_twist_joint_set_param** **(** :ref:`RID` joint, :ref:`Co .. rst-class:: classref-method -void **_end_sync** **(** **)** |virtual| +|void| **_end_sync**\ (\ ) |virtual| .. container:: contribute @@ -1770,7 +1770,7 @@ void **_end_sync** **(** **)** |virtual| .. rst-class:: classref-method -void **_finish** **(** **)** |virtual| +|void| **_finish**\ (\ ) |virtual| .. container:: contribute @@ -1784,7 +1784,7 @@ void **_finish** **(** **)** |virtual| .. rst-class:: classref-method -void **_flush_queries** **(** **)** |virtual| +|void| **_flush_queries**\ (\ ) |virtual| .. container:: contribute @@ -1798,7 +1798,7 @@ void **_flush_queries** **(** **)** |virtual| .. rst-class:: classref-method -void **_free_rid** **(** :ref:`RID` rid **)** |virtual| +|void| **_free_rid**\ (\ rid\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -1812,7 +1812,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_generic_6dof_joint_get_flag** **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag **)** |virtual| |const| +:ref:`bool` **_generic_6dof_joint_get_flag**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag`\ ) |virtual| |const| .. container:: contribute @@ -1826,7 +1826,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`float` **_generic_6dof_joint_get_param** **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param **)** |virtual| |const| +:ref:`float` **_generic_6dof_joint_get_param**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam`\ ) |virtual| |const| .. container:: contribute @@ -1840,7 +1840,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -void **_generic_6dof_joint_set_flag** **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag, :ref:`bool` enable **)** |virtual| +|void| **_generic_6dof_joint_set_flag**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, flag\: :ref:`G6DOFJointAxisFlag`, enable\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1854,7 +1854,7 @@ void **_generic_6dof_joint_set_flag** **(** :ref:`RID` joint, Vector3 .. rst-class:: classref-method -void **_generic_6dof_joint_set_param** **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param, :ref:`float` value **)** |virtual| +|void| **_generic_6dof_joint_set_param**\ (\ joint\: :ref:`RID`, axis\: Vector3.Axis, param\: :ref:`G6DOFJointAxisParam`, value\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1868,7 +1868,7 @@ void **_generic_6dof_joint_set_param** **(** :ref:`RID` joint, Vector .. rst-class:: classref-method -:ref:`int` **_get_process_info** **(** :ref:`ProcessInfo` process_info **)** |virtual| +:ref:`int` **_get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) |virtual| .. container:: contribute @@ -1882,7 +1882,7 @@ void **_generic_6dof_joint_set_param** **(** :ref:`RID` joint, Vector .. rst-class:: classref-method -:ref:`RID` **_heightmap_shape_create** **(** **)** |virtual| +:ref:`RID` **_heightmap_shape_create**\ (\ ) |virtual| .. container:: contribute @@ -1896,7 +1896,7 @@ void **_generic_6dof_joint_set_param** **(** :ref:`RID` joint, Vector .. rst-class:: classref-method -:ref:`bool` **_hinge_joint_get_flag** **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** |virtual| |const| +:ref:`bool` **_hinge_joint_get_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`\ ) |virtual| |const| .. container:: contribute @@ -1910,7 +1910,7 @@ void **_generic_6dof_joint_set_param** **(** :ref:`RID` joint, Vector .. rst-class:: classref-method -:ref:`float` **_hinge_joint_get_param** **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** |virtual| |const| +:ref:`float` **_hinge_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`\ ) |virtual| |const| .. container:: contribute @@ -1924,7 +1924,7 @@ void **_generic_6dof_joint_set_param** **(** :ref:`RID` joint, Vector .. rst-class:: classref-method -void **_hinge_joint_set_flag** **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag, :ref:`bool` enabled **)** |virtual| +|void| **_hinge_joint_set_flag**\ (\ joint\: :ref:`RID`, flag\: :ref:`HingeJointFlag`, enabled\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1938,7 +1938,7 @@ void **_hinge_joint_set_flag** **(** :ref:`RID` joint, :ref:`HingeJoi .. rst-class:: classref-method -void **_hinge_joint_set_param** **(** :ref:`RID` joint, :ref:`HingeJointParam` param, :ref:`float` value **)** |virtual| +|void| **_hinge_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`HingeJointParam`, value\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1952,7 +1952,7 @@ void **_hinge_joint_set_param** **(** :ref:`RID` joint, :ref:`HingeJo .. rst-class:: classref-method -void **_init** **(** **)** |virtual| +|void| **_init**\ (\ ) |virtual| .. container:: contribute @@ -1966,7 +1966,7 @@ void **_init** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_is_flushing_queries** **(** **)** |virtual| |const| +:ref:`bool` **_is_flushing_queries**\ (\ ) |virtual| |const| .. container:: contribute @@ -1980,7 +1980,7 @@ void **_init** **(** **)** |virtual| .. rst-class:: classref-method -void **_joint_clear** **(** :ref:`RID` joint **)** |virtual| +|void| **_joint_clear**\ (\ joint\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -1994,7 +1994,7 @@ void **_joint_clear** **(** :ref:`RID` joint **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_joint_create** **(** **)** |virtual| +:ref:`RID` **_joint_create**\ (\ ) |virtual| .. container:: contribute @@ -2008,7 +2008,7 @@ void **_joint_clear** **(** :ref:`RID` joint **)** |virtual| .. rst-class:: classref-method -void **_joint_disable_collisions_between_bodies** **(** :ref:`RID` joint, :ref:`bool` disable **)** |virtual| +|void| **_joint_disable_collisions_between_bodies**\ (\ joint\: :ref:`RID`, disable\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -2022,7 +2022,7 @@ void **_joint_disable_collisions_between_bodies** **(** :ref:`RID` jo .. rst-class:: classref-method -:ref:`int` **_joint_get_solver_priority** **(** :ref:`RID` joint **)** |virtual| |const| +:ref:`int` **_joint_get_solver_priority**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2036,7 +2036,7 @@ void **_joint_disable_collisions_between_bodies** **(** :ref:`RID` jo .. rst-class:: classref-method -:ref:`JointType` **_joint_get_type** **(** :ref:`RID` joint **)** |virtual| |const| +:ref:`JointType` **_joint_get_type**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2050,7 +2050,7 @@ void **_joint_disable_collisions_between_bodies** **(** :ref:`RID` jo .. rst-class:: classref-method -:ref:`bool` **_joint_is_disabled_collisions_between_bodies** **(** :ref:`RID` joint **)** |virtual| |const| +:ref:`bool` **_joint_is_disabled_collisions_between_bodies**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2064,7 +2064,7 @@ void **_joint_disable_collisions_between_bodies** **(** :ref:`RID` jo .. rst-class:: classref-method -void **_joint_make_cone_twist** **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** |virtual| +|void| **_joint_make_cone_twist**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| .. container:: contribute @@ -2078,7 +2078,7 @@ void **_joint_make_cone_twist** **(** :ref:`RID` joint, :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** |virtual| +|void| **_joint_make_generic_6dof**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| .. container:: contribute @@ -2092,7 +2092,7 @@ void **_joint_make_generic_6dof** **(** :ref:`RID` joint, :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` hinge_A, :ref:`RID` body_B, :ref:`Transform3D` hinge_B **)** |virtual| +|void| **_joint_make_hinge**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, hinge_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, hinge_B\: :ref:`Transform3D`\ ) |virtual| .. container:: contribute @@ -2106,7 +2106,7 @@ void **_joint_make_hinge** **(** :ref:`RID` joint, :ref:`RID` joint, :ref:`RID` body_A, :ref:`Vector3` pivot_A, :ref:`Vector3` axis_A, :ref:`RID` body_B, :ref:`Vector3` pivot_B, :ref:`Vector3` axis_B **)** |virtual| +|void| **_joint_make_hinge_simple**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, pivot_A\: :ref:`Vector3`, axis_A\: :ref:`Vector3`, body_B\: :ref:`RID`, pivot_B\: :ref:`Vector3`, axis_B\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -2120,7 +2120,7 @@ void **_joint_make_hinge_simple** **(** :ref:`RID` joint, :ref:`RID` joint, :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** |virtual| +|void| **_joint_make_pin**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_A\: :ref:`Vector3`, body_B\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -2134,7 +2134,7 @@ void **_joint_make_pin** **(** :ref:`RID` joint, :ref:`RID .. rst-class:: classref-method -void **_joint_make_slider** **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** |virtual| +|void| **_joint_make_slider**\ (\ joint\: :ref:`RID`, body_A\: :ref:`RID`, local_ref_A\: :ref:`Transform3D`, body_B\: :ref:`RID`, local_ref_B\: :ref:`Transform3D`\ ) |virtual| .. container:: contribute @@ -2148,7 +2148,7 @@ void **_joint_make_slider** **(** :ref:`RID` joint, :ref:`RID` joint, :ref:`int` priority **)** |virtual| +|void| **_joint_set_solver_priority**\ (\ joint\: :ref:`RID`, priority\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -2162,7 +2162,7 @@ void **_joint_set_solver_priority** **(** :ref:`RID` joint, :ref:`int .. rst-class:: classref-method -:ref:`Vector3` **_pin_joint_get_local_a** **(** :ref:`RID` joint **)** |virtual| |const| +:ref:`Vector3` **_pin_joint_get_local_a**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2176,7 +2176,7 @@ void **_joint_set_solver_priority** **(** :ref:`RID` joint, :ref:`int .. rst-class:: classref-method -:ref:`Vector3` **_pin_joint_get_local_b** **(** :ref:`RID` joint **)** |virtual| |const| +:ref:`Vector3` **_pin_joint_get_local_b**\ (\ joint\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2190,7 +2190,7 @@ void **_joint_set_solver_priority** **(** :ref:`RID` joint, :ref:`int .. rst-class:: classref-method -:ref:`float` **_pin_joint_get_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** |virtual| |const| +:ref:`float` **_pin_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`\ ) |virtual| |const| .. container:: contribute @@ -2204,7 +2204,7 @@ void **_joint_set_solver_priority** **(** :ref:`RID` joint, :ref:`int .. rst-class:: classref-method -void **_pin_joint_set_local_a** **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** |virtual| +|void| **_pin_joint_set_local_a**\ (\ joint\: :ref:`RID`, local_A\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -2218,7 +2218,7 @@ void **_pin_joint_set_local_a** **(** :ref:`RID` joint, :ref:`Vector3 .. rst-class:: classref-method -void **_pin_joint_set_local_b** **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** |virtual| +|void| **_pin_joint_set_local_b**\ (\ joint\: :ref:`RID`, local_B\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -2232,7 +2232,7 @@ void **_pin_joint_set_local_b** **(** :ref:`RID` joint, :ref:`Vector3 .. rst-class:: classref-method -void **_pin_joint_set_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** |virtual| +|void| **_pin_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`PinJointParam`, value\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -2246,7 +2246,7 @@ void **_pin_joint_set_param** **(** :ref:`RID` joint, :ref:`PinJointP .. rst-class:: classref-method -:ref:`RID` **_separation_ray_shape_create** **(** **)** |virtual| +:ref:`RID` **_separation_ray_shape_create**\ (\ ) |virtual| .. container:: contribute @@ -2260,7 +2260,7 @@ void **_pin_joint_set_param** **(** :ref:`RID` joint, :ref:`PinJointP .. rst-class:: classref-method -void **_set_active** **(** :ref:`bool` active **)** |virtual| +|void| **_set_active**\ (\ active\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -2274,7 +2274,7 @@ void **_set_active** **(** :ref:`bool` active **)** |virtual| .. rst-class:: classref-method -:ref:`float` **_shape_get_custom_solver_bias** **(** :ref:`RID` shape **)** |virtual| |const| +:ref:`float` **_shape_get_custom_solver_bias**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2288,7 +2288,7 @@ void **_set_active** **(** :ref:`bool` active **)** |virtual| .. rst-class:: classref-method -:ref:`Variant` **_shape_get_data** **(** :ref:`RID` shape **)** |virtual| |const| +:ref:`Variant` **_shape_get_data**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2302,7 +2302,7 @@ void **_set_active** **(** :ref:`bool` active **)** |virtual| .. rst-class:: classref-method -:ref:`float` **_shape_get_margin** **(** :ref:`RID` shape **)** |virtual| |const| +:ref:`float` **_shape_get_margin**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2316,7 +2316,7 @@ void **_set_active** **(** :ref:`bool` active **)** |virtual| .. rst-class:: classref-method -:ref:`ShapeType` **_shape_get_type** **(** :ref:`RID` shape **)** |virtual| |const| +:ref:`ShapeType` **_shape_get_type**\ (\ shape\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2330,7 +2330,7 @@ void **_set_active** **(** :ref:`bool` active **)** |virtual| .. rst-class:: classref-method -void **_shape_set_custom_solver_bias** **(** :ref:`RID` shape, :ref:`float` bias **)** |virtual| +|void| **_shape_set_custom_solver_bias**\ (\ shape\: :ref:`RID`, bias\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -2344,7 +2344,7 @@ void **_shape_set_custom_solver_bias** **(** :ref:`RID` shape, :ref:` .. rst-class:: classref-method -void **_shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` data **)** |virtual| +|void| **_shape_set_data**\ (\ shape\: :ref:`RID`, data\: :ref:`Variant`\ ) |virtual| .. container:: contribute @@ -2358,7 +2358,7 @@ void **_shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` shape, :ref:`float` margin **)** |virtual| +|void| **_shape_set_margin**\ (\ shape\: :ref:`RID`, margin\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -2372,7 +2372,7 @@ void **_shape_set_margin** **(** :ref:`RID` shape, :ref:`float` **_slider_joint_get_param** **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** |virtual| |const| +:ref:`float` **_slider_joint_get_param**\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`\ ) |virtual| |const| .. container:: contribute @@ -2386,7 +2386,7 @@ void **_shape_set_margin** **(** :ref:`RID` shape, :ref:`float` joint, :ref:`SliderJointParam` param, :ref:`float` value **)** |virtual| +|void| **_slider_joint_set_param**\ (\ joint\: :ref:`RID`, param\: :ref:`SliderJointParam`, value\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -2400,7 +2400,7 @@ void **_slider_joint_set_param** **(** :ref:`RID` joint, :ref:`Slider .. rst-class:: classref-method -void **_soft_body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` body_b **)** |virtual| +|void| **_soft_body_add_collision_exception**\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -2414,7 +2414,7 @@ void **_soft_body_add_collision_exception** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`RID` **_soft_body_create** **(** **)** |virtual| +:ref:`RID` **_soft_body_create**\ (\ ) |virtual| .. container:: contribute @@ -2428,7 +2428,7 @@ void **_soft_body_add_collision_exception** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`AABB` **_soft_body_get_bounds** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`AABB` **_soft_body_get_bounds**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2442,7 +2442,7 @@ void **_soft_body_add_collision_exception** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`RID[]` **_soft_body_get_collision_exceptions** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`Array`\[:ref:`RID`\] **_soft_body_get_collision_exceptions**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2456,7 +2456,7 @@ void **_soft_body_add_collision_exception** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`int` **_soft_body_get_collision_layer** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`int` **_soft_body_get_collision_layer**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2470,7 +2470,7 @@ void **_soft_body_add_collision_exception** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`int` **_soft_body_get_collision_mask** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`int` **_soft_body_get_collision_mask**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2484,7 +2484,7 @@ void **_soft_body_add_collision_exception** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`float` **_soft_body_get_damping_coefficient** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`float` **_soft_body_get_damping_coefficient**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2498,7 +2498,7 @@ void **_soft_body_add_collision_exception** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`float` **_soft_body_get_drag_coefficient** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`float` **_soft_body_get_drag_coefficient**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2512,7 +2512,7 @@ void **_soft_body_add_collision_exception** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`float` **_soft_body_get_linear_stiffness** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`float` **_soft_body_get_linear_stiffness**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2526,7 +2526,7 @@ void **_soft_body_add_collision_exception** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`Vector3` **_soft_body_get_point_global_position** **(** :ref:`RID` body, :ref:`int` point_index **)** |virtual| |const| +:ref:`Vector3` **_soft_body_get_point_global_position**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -2540,7 +2540,7 @@ void **_soft_body_add_collision_exception** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`float` **_soft_body_get_pressure_coefficient** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`float` **_soft_body_get_pressure_coefficient**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2554,7 +2554,7 @@ void **_soft_body_add_collision_exception** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`int` **_soft_body_get_simulation_precision** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`int` **_soft_body_get_simulation_precision**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2568,7 +2568,7 @@ void **_soft_body_add_collision_exception** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`RID` **_soft_body_get_space** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`RID` **_soft_body_get_space**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2582,7 +2582,7 @@ void **_soft_body_add_collision_exception** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`Variant` **_soft_body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** |virtual| |const| +:ref:`Variant` **_soft_body_get_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`\ ) |virtual| |const| .. container:: contribute @@ -2596,7 +2596,7 @@ void **_soft_body_add_collision_exception** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`float` **_soft_body_get_total_mass** **(** :ref:`RID` body **)** |virtual| |const| +:ref:`float` **_soft_body_get_total_mass**\ (\ body\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2610,7 +2610,7 @@ void **_soft_body_add_collision_exception** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`bool` **_soft_body_is_point_pinned** **(** :ref:`RID` body, :ref:`int` point_index **)** |virtual| |const| +:ref:`bool` **_soft_body_is_point_pinned**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -2624,7 +2624,7 @@ void **_soft_body_add_collision_exception** **(** :ref:`RID` body, :r .. rst-class:: classref-method -void **_soft_body_move_point** **(** :ref:`RID` body, :ref:`int` point_index, :ref:`Vector3` global_position **)** |virtual| +|void| **_soft_body_move_point**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, global_position\: :ref:`Vector3`\ ) |virtual| .. container:: contribute @@ -2638,7 +2638,7 @@ void **_soft_body_move_point** **(** :ref:`RID` body, :ref:`int` body, :ref:`int` point_index, :ref:`bool` pin **)** |virtual| +|void| **_soft_body_pin_point**\ (\ body\: :ref:`RID`, point_index\: :ref:`int`, pin\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -2652,7 +2652,7 @@ void **_soft_body_pin_point** **(** :ref:`RID` body, :ref:`int` body **)** |virtual| +|void| **_soft_body_remove_all_pinned_points**\ (\ body\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -2666,7 +2666,7 @@ void **_soft_body_remove_all_pinned_points** **(** :ref:`RID` body ** .. rst-class:: classref-method -void **_soft_body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` body_b **)** |virtual| +|void| **_soft_body_remove_collision_exception**\ (\ body\: :ref:`RID`, body_b\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -2680,7 +2680,7 @@ void **_soft_body_remove_collision_exception** **(** :ref:`RID` body, .. rst-class:: classref-method -void **_soft_body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** |virtual| +|void| **_soft_body_set_collision_layer**\ (\ body\: :ref:`RID`, layer\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -2694,7 +2694,7 @@ void **_soft_body_set_collision_layer** **(** :ref:`RID` body, :ref:` .. rst-class:: classref-method -void **_soft_body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** |virtual| +|void| **_soft_body_set_collision_mask**\ (\ body\: :ref:`RID`, mask\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -2708,7 +2708,7 @@ void **_soft_body_set_collision_mask** **(** :ref:`RID` body, :ref:`i .. rst-class:: classref-method -void **_soft_body_set_damping_coefficient** **(** :ref:`RID` body, :ref:`float` damping_coefficient **)** |virtual| +|void| **_soft_body_set_damping_coefficient**\ (\ body\: :ref:`RID`, damping_coefficient\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -2722,7 +2722,7 @@ void **_soft_body_set_damping_coefficient** **(** :ref:`RID` body, :r .. rst-class:: classref-method -void **_soft_body_set_drag_coefficient** **(** :ref:`RID` body, :ref:`float` drag_coefficient **)** |virtual| +|void| **_soft_body_set_drag_coefficient**\ (\ body\: :ref:`RID`, drag_coefficient\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -2736,7 +2736,7 @@ void **_soft_body_set_drag_coefficient** **(** :ref:`RID` body, :ref: .. rst-class:: classref-method -void **_soft_body_set_linear_stiffness** **(** :ref:`RID` body, :ref:`float` linear_stiffness **)** |virtual| +|void| **_soft_body_set_linear_stiffness**\ (\ body\: :ref:`RID`, linear_stiffness\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -2750,7 +2750,7 @@ void **_soft_body_set_linear_stiffness** **(** :ref:`RID` body, :ref: .. rst-class:: classref-method -void **_soft_body_set_mesh** **(** :ref:`RID` body, :ref:`RID` mesh **)** |virtual| +|void| **_soft_body_set_mesh**\ (\ body\: :ref:`RID`, mesh\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -2764,7 +2764,7 @@ void **_soft_body_set_mesh** **(** :ref:`RID` body, :ref:`RID` body, :ref:`float` pressure_coefficient **)** |virtual| +|void| **_soft_body_set_pressure_coefficient**\ (\ body\: :ref:`RID`, pressure_coefficient\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -2778,7 +2778,7 @@ void **_soft_body_set_pressure_coefficient** **(** :ref:`RID` body, : .. rst-class:: classref-method -void **_soft_body_set_ray_pickable** **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| +|void| **_soft_body_set_ray_pickable**\ (\ body\: :ref:`RID`, enable\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -2792,7 +2792,7 @@ void **_soft_body_set_ray_pickable** **(** :ref:`RID` body, :ref:`boo .. rst-class:: classref-method -void **_soft_body_set_simulation_precision** **(** :ref:`RID` body, :ref:`int` simulation_precision **)** |virtual| +|void| **_soft_body_set_simulation_precision**\ (\ body\: :ref:`RID`, simulation_precision\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -2806,7 +2806,7 @@ void **_soft_body_set_simulation_precision** **(** :ref:`RID` body, : .. rst-class:: classref-method -void **_soft_body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** |virtual| +|void| **_soft_body_set_space**\ (\ body\: :ref:`RID`, space\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -2820,7 +2820,7 @@ void **_soft_body_set_space** **(** :ref:`RID` body, :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` variant **)** |virtual| +|void| **_soft_body_set_state**\ (\ body\: :ref:`RID`, state\: :ref:`BodyState`, variant\: :ref:`Variant`\ ) |virtual| .. container:: contribute @@ -2834,7 +2834,7 @@ void **_soft_body_set_state** **(** :ref:`RID` body, :ref:`BodyState< .. rst-class:: classref-method -void **_soft_body_set_total_mass** **(** :ref:`RID` body, :ref:`float` total_mass **)** |virtual| +|void| **_soft_body_set_total_mass**\ (\ body\: :ref:`RID`, total_mass\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -2848,7 +2848,7 @@ void **_soft_body_set_total_mass** **(** :ref:`RID` body, :ref:`float .. rst-class:: classref-method -void **_soft_body_set_transform** **(** :ref:`RID` body, :ref:`Transform3D` transform **)** |virtual| +|void| **_soft_body_set_transform**\ (\ body\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) |virtual| .. container:: contribute @@ -2862,7 +2862,7 @@ void **_soft_body_set_transform** **(** :ref:`RID` body, :ref:`Transf .. rst-class:: classref-method -void **_soft_body_update_rendering_server** **(** :ref:`RID` body, :ref:`PhysicsServer3DRenderingServerHandler` rendering_server_handler **)** |virtual| +|void| **_soft_body_update_rendering_server**\ (\ body\: :ref:`RID`, rendering_server_handler\: :ref:`PhysicsServer3DRenderingServerHandler`\ ) |virtual| .. container:: contribute @@ -2876,7 +2876,7 @@ void **_soft_body_update_rendering_server** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`RID` **_space_create** **(** **)** |virtual| +:ref:`RID` **_space_create**\ (\ ) |virtual| .. container:: contribute @@ -2890,7 +2890,7 @@ void **_soft_body_update_rendering_server** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`int` **_space_get_contact_count** **(** :ref:`RID` space **)** |virtual| |const| +:ref:`int` **_space_get_contact_count**\ (\ space\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2904,7 +2904,7 @@ void **_soft_body_update_rendering_server** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`PackedVector3Array` **_space_get_contacts** **(** :ref:`RID` space **)** |virtual| |const| +:ref:`PackedVector3Array` **_space_get_contacts**\ (\ space\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2918,7 +2918,7 @@ void **_soft_body_update_rendering_server** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`PhysicsDirectSpaceState3D` **_space_get_direct_state** **(** :ref:`RID` space **)** |virtual| +:ref:`PhysicsDirectSpaceState3D` **_space_get_direct_state**\ (\ space\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -2932,7 +2932,7 @@ void **_soft_body_update_rendering_server** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`float` **_space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** |virtual| |const| +:ref:`float` **_space_get_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`\ ) |virtual| |const| .. container:: contribute @@ -2946,7 +2946,7 @@ void **_soft_body_update_rendering_server** **(** :ref:`RID` body, :r .. rst-class:: classref-method -:ref:`bool` **_space_is_active** **(** :ref:`RID` space **)** |virtual| |const| +:ref:`bool` **_space_is_active**\ (\ space\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2960,7 +2960,7 @@ void **_soft_body_update_rendering_server** **(** :ref:`RID` body, :r .. rst-class:: classref-method -void **_space_set_active** **(** :ref:`RID` space, :ref:`bool` active **)** |virtual| +|void| **_space_set_active**\ (\ space\: :ref:`RID`, active\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -2974,7 +2974,7 @@ void **_space_set_active** **(** :ref:`RID` space, :ref:`bool` space, :ref:`int` max_contacts **)** |virtual| +|void| **_space_set_debug_contacts**\ (\ space\: :ref:`RID`, max_contacts\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -2988,7 +2988,7 @@ void **_space_set_debug_contacts** **(** :ref:`RID` space, :ref:`int< .. rst-class:: classref-method -void **_space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** |virtual| +|void| **_space_set_param**\ (\ space\: :ref:`RID`, param\: :ref:`SpaceParameter`, value\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -3002,7 +3002,7 @@ void **_space_set_param** **(** :ref:`RID` space, :ref:`SpaceParamete .. rst-class:: classref-method -:ref:`RID` **_sphere_shape_create** **(** **)** |virtual| +:ref:`RID` **_sphere_shape_create**\ (\ ) |virtual| .. container:: contribute @@ -3016,7 +3016,7 @@ void **_space_set_param** **(** :ref:`RID` space, :ref:`SpaceParamete .. rst-class:: classref-method -void **_step** **(** :ref:`float` step **)** |virtual| +|void| **_step**\ (\ step\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -3030,7 +3030,7 @@ void **_step** **(** :ref:`float` step **)** |virtual| .. rst-class:: classref-method -void **_sync** **(** **)** |virtual| +|void| **_sync**\ (\ ) |virtual| .. container:: contribute @@ -3044,7 +3044,7 @@ void **_sync** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_world_boundary_shape_create** **(** **)** |virtual| +:ref:`RID` **_world_boundary_shape_create**\ (\ ) |virtual| .. container:: contribute @@ -3058,7 +3058,7 @@ void **_sync** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **body_test_motion_is_excluding_body** **(** :ref:`RID` body **)** |const| +:ref:`bool` **body_test_motion_is_excluding_body**\ (\ body\: :ref:`RID`\ ) |const| .. container:: contribute @@ -3072,7 +3072,7 @@ void **_sync** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **body_test_motion_is_excluding_object** **(** :ref:`int` object **)** |const| +:ref:`bool` **body_test_motion_is_excluding_object**\ (\ object\: :ref:`int`\ ) |const| .. container:: contribute @@ -3085,3 +3085,4 @@ void **_sync** **(** **)** |virtual| .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsserver3dmanager.rst b/classes/class_physicsserver3dmanager.rst index 5f8e76585b2..618e2214e66 100644 --- a/classes/class_physicsserver3dmanager.rst +++ b/classes/class_physicsserver3dmanager.rst @@ -31,11 +31,11 @@ Methods .. table:: :widths: auto - +------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`register_server` **(** :ref:`String` name, :ref:`Callable` create_callback **)** | - +------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_default_server` **(** :ref:`String` name, :ref:`int` priority **)** | - +------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_server`\ (\ name\: :ref:`String`, create_callback\: :ref:`Callable`\ ) | + +--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_default_server`\ (\ name\: :ref:`String`, priority\: :ref:`int`\ ) | + +--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -50,7 +50,7 @@ Method Descriptions .. rst-class:: classref-method -void **register_server** **(** :ref:`String` name, :ref:`Callable` create_callback **)** +|void| **register_server**\ (\ name\: :ref:`String`, create_callback\: :ref:`Callable`\ ) Register a :ref:`PhysicsServer3D` implementation by passing a ``name`` and a :ref:`Callable` that returns a :ref:`PhysicsServer3D` object. @@ -62,7 +62,7 @@ Register a :ref:`PhysicsServer3D` implementation by passi .. rst-class:: classref-method -void **set_default_server** **(** :ref:`String` name, :ref:`int` priority **)** +|void| **set_default_server**\ (\ name\: :ref:`String`, priority\: :ref:`int`\ ) Set the default :ref:`PhysicsServer3D` implementation to the one identified by ``name``, if ``priority`` is greater than the priority of the current default implementation. @@ -73,3 +73,4 @@ Set the default :ref:`PhysicsServer3D` implementation to .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsserver3drenderingserverhandler.rst b/classes/class_physicsserver3drenderingserverhandler.rst index 16b352f7f3b..c2eb526306e 100644 --- a/classes/class_physicsserver3drenderingserverhandler.rst +++ b/classes/class_physicsserver3drenderingserverhandler.rst @@ -22,19 +22,19 @@ Methods .. table:: :widths: auto - +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_aabb` **(** :ref:`AABB` aabb **)** |virtual| | - +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_normal` **(** :ref:`int` vertex_id, :ref:`Vector3` normal **)** |virtual| | - +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_vertex` **(** :ref:`int` vertex_id, :ref:`Vector3` vertex **)** |virtual| | - +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_aabb` **(** :ref:`AABB` aabb **)** | - +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_normal` **(** :ref:`int` vertex_id, :ref:`Vector3` normal **)** | - +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_vertex` **(** :ref:`int` vertex_id, :ref:`Vector3` vertex **)** | - +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_aabb`\ (\ aabb\: :ref:`AABB`\ ) |virtual| | + +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_normal`\ (\ vertex_id\: :ref:`int`, normal\: :ref:`Vector3`\ ) |virtual| | + +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_vertex`\ (\ vertex_id\: :ref:`int`, vertex\: :ref:`Vector3`\ ) |virtual| | + +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_aabb`\ (\ aabb\: :ref:`AABB`\ ) | + +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_normal`\ (\ vertex_id\: :ref:`int`, normal\: :ref:`Vector3`\ ) | + +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_vertex`\ (\ vertex_id\: :ref:`int`, vertex\: :ref:`Vector3`\ ) | + +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -49,7 +49,7 @@ Method Descriptions .. rst-class:: classref-method -void **_set_aabb** **(** :ref:`AABB` aabb **)** |virtual| +|void| **_set_aabb**\ (\ aabb\: :ref:`AABB`\ ) |virtual| Called by the :ref:`PhysicsServer3D` to set the bounding box for the :ref:`SoftBody3D`. @@ -61,7 +61,7 @@ Called by the :ref:`PhysicsServer3D` to set the bounding .. rst-class:: classref-method -void **_set_normal** **(** :ref:`int` vertex_id, :ref:`Vector3` normal **)** |virtual| +|void| **_set_normal**\ (\ vertex_id\: :ref:`int`, normal\: :ref:`Vector3`\ ) |virtual| Called by the :ref:`PhysicsServer3D` to set the normal for the :ref:`SoftBody3D` vertex at the index specified by ``vertex_id``. @@ -75,7 +75,7 @@ Called by the :ref:`PhysicsServer3D` to set the normal fo .. rst-class:: classref-method -void **_set_vertex** **(** :ref:`int` vertex_id, :ref:`Vector3` vertex **)** |virtual| +|void| **_set_vertex**\ (\ vertex_id\: :ref:`int`, vertex\: :ref:`Vector3`\ ) |virtual| Called by the :ref:`PhysicsServer3D` to set the position for the :ref:`SoftBody3D` vertex at the index specified by ``vertex_id``. @@ -89,7 +89,7 @@ Called by the :ref:`PhysicsServer3D` to set the position .. rst-class:: classref-method -void **set_aabb** **(** :ref:`AABB` aabb **)** +|void| **set_aabb**\ (\ aabb\: :ref:`AABB`\ ) Sets the bounding box for the :ref:`SoftBody3D`. @@ -101,7 +101,7 @@ Sets the bounding box for the :ref:`SoftBody3D`. .. rst-class:: classref-method -void **set_normal** **(** :ref:`int` vertex_id, :ref:`Vector3` normal **)** +|void| **set_normal**\ (\ vertex_id\: :ref:`int`, normal\: :ref:`Vector3`\ ) Sets the normal for the :ref:`SoftBody3D` vertex at the index specified by ``vertex_id``. @@ -113,7 +113,7 @@ Sets the normal for the :ref:`SoftBody3D` vertex at the index .. rst-class:: classref-method -void **set_vertex** **(** :ref:`int` vertex_id, :ref:`Vector3` vertex **)** +|void| **set_vertex**\ (\ vertex_id\: :ref:`int`, vertex\: :ref:`Vector3`\ ) Sets the position for the :ref:`SoftBody3D` vertex at the index specified by ``vertex_id``. @@ -124,3 +124,4 @@ Sets the position for the :ref:`SoftBody3D` vertex at the inde .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsshapequeryparameters2d.rst b/classes/class_physicsshapequeryparameters2d.rst index 1b146102c78..a33959d4a60 100644 --- a/classes/class_physicsshapequeryparameters2d.rst +++ b/classes/class_physicsshapequeryparameters2d.rst @@ -29,25 +29,25 @@ Properties .. table:: :widths: auto - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`bool` | :ref:`collide_with_areas` | ``false`` | - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`bool` | :ref:`collide_with_bodies` | ``true`` | - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`int` | :ref:`collision_mask` | ``4294967295`` | - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`RID[]` | :ref:`exclude` | ``[]`` | - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`float` | :ref:`margin` | ``0.0`` | - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Vector2` | :ref:`motion` | ``Vector2(0, 0)`` | - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Resource` | :ref:`shape` | | - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`RID` | :ref:`shape_rid` | ``RID()`` | - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Transform2D` | :ref:`transform` | ``Transform2D(1, 0, 0, 1, 0, 0)`` | - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`bool` | :ref:`collide_with_areas` | ``false`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`bool` | :ref:`collide_with_bodies` | ``true`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`collision_mask` | ``4294967295`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`exclude` | ``[]`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`float` | :ref:`margin` | ``0.0`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Vector2` | :ref:`motion` | ``Vector2(0, 0)`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Resource` | :ref:`shape` | | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`RID` | :ref:`shape_rid` | ``RID()`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Transform2D` | :ref:`transform` | ``Transform2D(1, 0, 0, 1, 0, 0)`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ .. rst-class:: classref-section-separator @@ -66,8 +66,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_collide_with_areas** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_areas_enabled** **(** **)** +- |void| **set_collide_with_areas**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_areas_enabled**\ (\ ) If ``true``, the query will take :ref:`Area2D`\ s into account. @@ -83,8 +83,8 @@ If ``true``, the query will take :ref:`Area2D`\ s into account. .. rst-class:: classref-property-setget -- void **set_collide_with_bodies** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_bodies_enabled** **(** **)** +- |void| **set_collide_with_bodies**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_bodies_enabled**\ (\ ) If ``true``, the query will take :ref:`PhysicsBody2D`\ s into account. @@ -100,8 +100,8 @@ If ``true``, the query will take :ref:`PhysicsBody2D`\ s in .. rst-class:: classref-property-setget -- void **set_collision_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_mask** **(** **)** +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information. @@ -113,12 +113,12 @@ The physics layers the query will detect (as a bitmask). By default, all collisi .. rst-class:: classref-property -:ref:`RID[]` **exclude** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **exclude** = ``[]`` .. rst-class:: classref-property-setget -- void **set_exclude** **(** :ref:`RID[]` value **)** -- :ref:`RID[]` **get_exclude** **(** **)** +- |void| **set_exclude**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) +- :ref:`Array`\[:ref:`RID`\] **get_exclude**\ (\ ) The list of object :ref:`RID`\ s that will be excluded from collisions. Use :ref:`CollisionObject2D.get_rid` to get the :ref:`RID` associated with a :ref:`CollisionObject2D`-derived node. @@ -134,8 +134,8 @@ The list of object :ref:`RID`\ s that will be excluded from collision .. rst-class:: classref-property-setget -- void **set_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_margin** **(** **)** +- |void| **set_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_margin**\ (\ ) The collision margin for the shape. @@ -151,8 +151,8 @@ The collision margin for the shape. .. rst-class:: classref-property-setget -- void **set_motion** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_motion** **(** **)** +- |void| **set_motion**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_motion**\ (\ ) The motion of the shape being queried for. @@ -168,8 +168,8 @@ The motion of the shape being queried for. .. rst-class:: classref-property-setget -- void **set_shape** **(** :ref:`Resource` value **)** -- :ref:`Resource` **get_shape** **(** **)** +- |void| **set_shape**\ (\ value\: :ref:`Resource`\ ) +- :ref:`Resource` **get_shape**\ (\ ) The :ref:`Shape2D` that will be used for collision/intersection queries. This stores the actual reference which avoids the shape to be released while being used for queries, so always prefer using this over :ref:`shape_rid`. @@ -185,8 +185,8 @@ The :ref:`Shape2D` that will be used for collision/intersection q .. rst-class:: classref-property-setget -- void **set_shape_rid** **(** :ref:`RID` value **)** -- :ref:`RID` **get_shape_rid** **(** **)** +- |void| **set_shape_rid**\ (\ value\: :ref:`RID`\ ) +- :ref:`RID` **get_shape_rid**\ (\ ) The queried shape's :ref:`RID` that will be used for collision/intersection queries. Use this over :ref:`shape` if you want to optimize for performance using the Servers API: @@ -235,8 +235,8 @@ The queried shape's :ref:`RID` that will be used for collision/inters .. rst-class:: classref-property-setget -- void **set_transform** **(** :ref:`Transform2D` value **)** -- :ref:`Transform2D` **get_transform** **(** **)** +- |void| **set_transform**\ (\ value\: :ref:`Transform2D`\ ) +- :ref:`Transform2D` **get_transform**\ (\ ) The queried shape's transform matrix. @@ -247,3 +247,4 @@ The queried shape's transform matrix. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicsshapequeryparameters3d.rst b/classes/class_physicsshapequeryparameters3d.rst index e78180dc995..9a5f4c0e08f 100644 --- a/classes/class_physicsshapequeryparameters3d.rst +++ b/classes/class_physicsshapequeryparameters3d.rst @@ -29,25 +29,25 @@ Properties .. table:: :widths: auto - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`bool` | :ref:`collide_with_areas` | ``false`` | - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`bool` | :ref:`collide_with_bodies` | ``true`` | - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`int` | :ref:`collision_mask` | ``4294967295`` | - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`RID[]` | :ref:`exclude` | ``[]`` | - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`float` | :ref:`margin` | ``0.0`` | - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`Vector3` | :ref:`motion` | ``Vector3(0, 0, 0)`` | - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`Resource` | :ref:`shape` | | - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`RID` | :ref:`shape_rid` | ``RID()`` | - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`Transform3D` | :ref:`transform` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | - +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`bool` | :ref:`collide_with_areas` | ``false`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`bool` | :ref:`collide_with_bodies` | ``true`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`int` | :ref:`collision_mask` | ``4294967295`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`exclude` | ``[]`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`float` | :ref:`margin` | ``0.0`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Vector3` | :ref:`motion` | ``Vector3(0, 0, 0)`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Resource` | :ref:`shape` | | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`RID` | :ref:`shape_rid` | ``RID()`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Transform3D` | :ref:`transform` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------------------------+ .. rst-class:: classref-section-separator @@ -66,8 +66,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_collide_with_areas** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_areas_enabled** **(** **)** +- |void| **set_collide_with_areas**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_areas_enabled**\ (\ ) If ``true``, the query will take :ref:`Area3D`\ s into account. @@ -83,8 +83,8 @@ If ``true``, the query will take :ref:`Area3D`\ s into account. .. rst-class:: classref-property-setget -- void **set_collide_with_bodies** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_bodies_enabled** **(** **)** +- |void| **set_collide_with_bodies**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_bodies_enabled**\ (\ ) If ``true``, the query will take :ref:`PhysicsBody3D`\ s into account. @@ -100,8 +100,8 @@ If ``true``, the query will take :ref:`PhysicsBody3D`\ s in .. rst-class:: classref-property-setget -- void **set_collision_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_mask** **(** **)** +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information. @@ -113,12 +113,12 @@ The physics layers the query will detect (as a bitmask). By default, all collisi .. rst-class:: classref-property -:ref:`RID[]` **exclude** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **exclude** = ``[]`` .. rst-class:: classref-property-setget -- void **set_exclude** **(** :ref:`RID[]` value **)** -- :ref:`RID[]` **get_exclude** **(** **)** +- |void| **set_exclude**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) +- :ref:`Array`\[:ref:`RID`\] **get_exclude**\ (\ ) The list of object :ref:`RID`\ s that will be excluded from collisions. Use :ref:`CollisionObject3D.get_rid` to get the :ref:`RID` associated with a :ref:`CollisionObject3D`-derived node. @@ -134,8 +134,8 @@ The list of object :ref:`RID`\ s that will be excluded from collision .. rst-class:: classref-property-setget -- void **set_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_margin** **(** **)** +- |void| **set_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_margin**\ (\ ) The collision margin for the shape. @@ -151,8 +151,8 @@ The collision margin for the shape. .. rst-class:: classref-property-setget -- void **set_motion** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_motion** **(** **)** +- |void| **set_motion**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_motion**\ (\ ) The motion of the shape being queried for. @@ -168,8 +168,8 @@ The motion of the shape being queried for. .. rst-class:: classref-property-setget -- void **set_shape** **(** :ref:`Resource` value **)** -- :ref:`Resource` **get_shape** **(** **)** +- |void| **set_shape**\ (\ value\: :ref:`Resource`\ ) +- :ref:`Resource` **get_shape**\ (\ ) The :ref:`Shape3D` that will be used for collision/intersection queries. This stores the actual reference which avoids the shape to be released while being used for queries, so always prefer using this over :ref:`shape_rid`. @@ -185,8 +185,8 @@ The :ref:`Shape3D` that will be used for collision/intersection q .. rst-class:: classref-property-setget -- void **set_shape_rid** **(** :ref:`RID` value **)** -- :ref:`RID` **get_shape_rid** **(** **)** +- |void| **set_shape_rid**\ (\ value\: :ref:`RID`\ ) +- :ref:`RID` **get_shape_rid**\ (\ ) The queried shape's :ref:`RID` that will be used for collision/intersection queries. Use this over :ref:`shape` if you want to optimize for performance using the Servers API: @@ -235,8 +235,8 @@ The queried shape's :ref:`RID` that will be used for collision/inters .. rst-class:: classref-property-setget -- void **set_transform** **(** :ref:`Transform3D` value **)** -- :ref:`Transform3D` **get_transform** **(** **)** +- |void| **set_transform**\ (\ value\: :ref:`Transform3D`\ ) +- :ref:`Transform3D` **get_transform**\ (\ ) The queried shape's transform matrix. @@ -247,3 +247,4 @@ The queried shape's transform matrix. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicstestmotionparameters2d.rst b/classes/class_physicstestmotionparameters2d.rst index be979a5cc98..ed19581fe64 100644 --- a/classes/class_physicstestmotionparameters2d.rst +++ b/classes/class_physicstestmotionparameters2d.rst @@ -29,21 +29,21 @@ Properties .. table:: :widths: auto - +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`bool` | :ref:`collide_separation_ray` | ``false`` | - +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`RID[]` | :ref:`exclude_bodies` | ``[]`` | - +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`int[]` | :ref:`exclude_objects` | ``[]`` | - +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Transform2D` | :ref:`from` | ``Transform2D(1, 0, 0, 1, 0, 0)`` | - +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`float` | :ref:`margin` | ``0.08`` | - +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`Vector2` | :ref:`motion` | ``Vector2(0, 0)`` | - +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ - | :ref:`bool` | :ref:`recovery_as_collision` | ``false`` | - +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + +----------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`bool` | :ref:`collide_separation_ray` | ``false`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`exclude_bodies` | ``[]`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Array`\[:ref:`int`\] | :ref:`exclude_objects` | ``[]`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Transform2D` | :ref:`from` | ``Transform2D(1, 0, 0, 1, 0, 0)`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`float` | :ref:`margin` | ``0.08`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Vector2` | :ref:`motion` | ``Vector2(0, 0)`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`bool` | :ref:`recovery_as_collision` | ``false`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ .. rst-class:: classref-section-separator @@ -62,8 +62,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_collide_separation_ray_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_separation_ray_enabled** **(** **)** +- |void| **set_collide_separation_ray_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_separation_ray_enabled**\ (\ ) If set to ``true``, shapes of type :ref:`PhysicsServer2D.SHAPE_SEPARATION_RAY` are used to detect collisions and can stop the motion. Can be useful when snapping to the ground. @@ -77,12 +77,12 @@ If set to ``false``, shapes of type :ref:`PhysicsServer2D.SHAPE_SEPARATION_RAY` **exclude_bodies** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **exclude_bodies** = ``[]`` .. rst-class:: classref-property-setget -- void **set_exclude_bodies** **(** :ref:`RID[]` value **)** -- :ref:`RID[]` **get_exclude_bodies** **(** **)** +- |void| **set_exclude_bodies**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) +- :ref:`Array`\[:ref:`RID`\] **get_exclude_bodies**\ (\ ) Optional array of body :ref:`RID` to exclude from collision. Use :ref:`CollisionObject2D.get_rid` to get the :ref:`RID` associated with a :ref:`CollisionObject2D`-derived node. @@ -94,12 +94,12 @@ Optional array of body :ref:`RID` to exclude from collision. Use :ref .. rst-class:: classref-property -:ref:`int[]` **exclude_objects** = ``[]`` +:ref:`Array`\[:ref:`int`\] **exclude_objects** = ``[]`` .. rst-class:: classref-property-setget -- void **set_exclude_objects** **(** :ref:`int[]` value **)** -- :ref:`int[]` **get_exclude_objects** **(** **)** +- |void| **set_exclude_objects**\ (\ value\: :ref:`Array`\[:ref:`int`\]\ ) +- :ref:`Array`\[:ref:`int`\] **get_exclude_objects**\ (\ ) Optional array of object unique instance ID to exclude from collision. See :ref:`Object.get_instance_id`. @@ -115,8 +115,8 @@ Optional array of object unique instance ID to exclude from collision. See :ref: .. rst-class:: classref-property-setget -- void **set_from** **(** :ref:`Transform2D` value **)** -- :ref:`Transform2D` **get_from** **(** **)** +- |void| **set_from**\ (\ value\: :ref:`Transform2D`\ ) +- :ref:`Transform2D` **get_from**\ (\ ) Transform in global space where the motion should start. Usually set to :ref:`Node2D.global_transform` for the current body's transform. @@ -132,8 +132,8 @@ Transform in global space where the motion should start. Usually set to :ref:`No .. rst-class:: classref-property-setget -- void **set_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_margin** **(** **)** +- |void| **set_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_margin**\ (\ ) Increases the size of the shapes involved in the collision detection. @@ -149,8 +149,8 @@ Increases the size of the shapes involved in the collision detection. .. rst-class:: classref-property-setget -- void **set_motion** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_motion** **(** **)** +- |void| **set_motion**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_motion**\ (\ ) Motion vector to define the length and direction of the motion to test. @@ -166,8 +166,8 @@ Motion vector to define the length and direction of the motion to test. .. rst-class:: classref-property-setget -- void **set_recovery_as_collision_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_recovery_as_collision_enabled** **(** **)** +- |void| **set_recovery_as_collision_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_recovery_as_collision_enabled**\ (\ ) If set to ``true``, any depenetration from the recovery phase is reported as a collision; this is used e.g. by :ref:`CharacterBody2D` for improving floor detection during floor snapping. @@ -180,3 +180,4 @@ If set to ``false``, only collisions resulting from the motion are reported, whi .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicstestmotionparameters3d.rst b/classes/class_physicstestmotionparameters3d.rst index f3387458df8..f41eeb262a8 100644 --- a/classes/class_physicstestmotionparameters3d.rst +++ b/classes/class_physicstestmotionparameters3d.rst @@ -29,23 +29,23 @@ Properties .. table:: :widths: auto - +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`bool` | :ref:`collide_separation_ray` | ``false`` | - +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`RID[]` | :ref:`exclude_bodies` | ``[]`` | - +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`int[]` | :ref:`exclude_objects` | ``[]`` | - +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`Transform3D` | :ref:`from` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | - +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`float` | :ref:`margin` | ``0.001`` | - +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`int` | :ref:`max_collisions` | ``1`` | - +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`Vector3` | :ref:`motion` | ``Vector3(0, 0, 0)`` | - +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`bool` | :ref:`recovery_as_collision` | ``false`` | - +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ + +----------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`bool` | :ref:`collide_separation_ray` | ``false`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`exclude_bodies` | ``[]`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Array`\[:ref:`int`\] | :ref:`exclude_objects` | ``[]`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Transform3D` | :ref:`from` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`float` | :ref:`margin` | ``0.001`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`int` | :ref:`max_collisions` | ``1`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Vector3` | :ref:`motion` | ``Vector3(0, 0, 0)`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`bool` | :ref:`recovery_as_collision` | ``false`` | + +----------------------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ .. rst-class:: classref-section-separator @@ -64,8 +64,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_collide_separation_ray_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_separation_ray_enabled** **(** **)** +- |void| **set_collide_separation_ray_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_separation_ray_enabled**\ (\ ) If set to ``true``, shapes of type :ref:`PhysicsServer3D.SHAPE_SEPARATION_RAY` are used to detect collisions and can stop the motion. Can be useful when snapping to the ground. @@ -79,12 +79,12 @@ If set to ``false``, shapes of type :ref:`PhysicsServer3D.SHAPE_SEPARATION_RAY` **exclude_bodies** = ``[]`` +:ref:`Array`\[:ref:`RID`\] **exclude_bodies** = ``[]`` .. rst-class:: classref-property-setget -- void **set_exclude_bodies** **(** :ref:`RID[]` value **)** -- :ref:`RID[]` **get_exclude_bodies** **(** **)** +- |void| **set_exclude_bodies**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) +- :ref:`Array`\[:ref:`RID`\] **get_exclude_bodies**\ (\ ) Optional array of body :ref:`RID` to exclude from collision. Use :ref:`CollisionObject3D.get_rid` to get the :ref:`RID` associated with a :ref:`CollisionObject3D`-derived node. @@ -96,12 +96,12 @@ Optional array of body :ref:`RID` to exclude from collision. Use :ref .. rst-class:: classref-property -:ref:`int[]` **exclude_objects** = ``[]`` +:ref:`Array`\[:ref:`int`\] **exclude_objects** = ``[]`` .. rst-class:: classref-property-setget -- void **set_exclude_objects** **(** :ref:`int[]` value **)** -- :ref:`int[]` **get_exclude_objects** **(** **)** +- |void| **set_exclude_objects**\ (\ value\: :ref:`Array`\[:ref:`int`\]\ ) +- :ref:`Array`\[:ref:`int`\] **get_exclude_objects**\ (\ ) Optional array of object unique instance ID to exclude from collision. See :ref:`Object.get_instance_id`. @@ -117,8 +117,8 @@ Optional array of object unique instance ID to exclude from collision. See :ref: .. rst-class:: classref-property-setget -- void **set_from** **(** :ref:`Transform3D` value **)** -- :ref:`Transform3D` **get_from** **(** **)** +- |void| **set_from**\ (\ value\: :ref:`Transform3D`\ ) +- :ref:`Transform3D` **get_from**\ (\ ) Transform in global space where the motion should start. Usually set to :ref:`Node3D.global_transform` for the current body's transform. @@ -134,8 +134,8 @@ Transform in global space where the motion should start. Usually set to :ref:`No .. rst-class:: classref-property-setget -- void **set_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_margin** **(** **)** +- |void| **set_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_margin**\ (\ ) Increases the size of the shapes involved in the collision detection. @@ -151,8 +151,8 @@ Increases the size of the shapes involved in the collision detection. .. rst-class:: classref-property-setget -- void **set_max_collisions** **(** :ref:`int` value **)** -- :ref:`int` **get_max_collisions** **(** **)** +- |void| **set_max_collisions**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_collisions**\ (\ ) Maximum number of returned collisions, between ``1`` and ``32``. Always returns the deepest detected collisions. @@ -168,8 +168,8 @@ Maximum number of returned collisions, between ``1`` and ``32``. Always returns .. rst-class:: classref-property-setget -- void **set_motion** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_motion** **(** **)** +- |void| **set_motion**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_motion**\ (\ ) Motion vector to define the length and direction of the motion to test. @@ -185,8 +185,8 @@ Motion vector to define the length and direction of the motion to test. .. rst-class:: classref-property-setget -- void **set_recovery_as_collision_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_recovery_as_collision_enabled** **(** **)** +- |void| **set_recovery_as_collision_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_recovery_as_collision_enabled**\ (\ ) If set to ``true``, any depenetration from the recovery phase is reported as a collision; this is used e.g. by :ref:`CharacterBody3D` for improving floor detection during floor snapping. @@ -199,3 +199,4 @@ If set to ``false``, only collisions resulting from the motion are reported, whi .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicstestmotionresult2d.rst b/classes/class_physicstestmotionresult2d.rst index aa08bf5e5df..03d61822c50 100644 --- a/classes/class_physicstestmotionresult2d.rst +++ b/classes/class_physicstestmotionresult2d.rst @@ -29,33 +29,33 @@ Methods .. table:: :widths: auto - +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_collider` **(** **)** |const| | - +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collider_id` **(** **)** |const| | - +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_collider_rid` **(** **)** |const| | - +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collider_shape` **(** **)** |const| | - +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_collider_velocity` **(** **)** |const| | - +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_collision_depth` **(** **)** |const| | - +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collision_local_shape` **(** **)** |const| | - +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** |const| | - +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_collision_point` **(** **)** |const| | - +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_collision_safe_fraction` **(** **)** |const| | - +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_collision_unsafe_fraction` **(** **)** |const| | - +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_remainder` **(** **)** |const| | - +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_travel` **(** **)** |const| | - +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_collider`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collider_id`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_collider_rid`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collider_shape`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_collider_velocity`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_collision_depth`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collision_local_shape`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_collision_normal`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_collision_point`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_collision_safe_fraction`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_collision_unsafe_fraction`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_remainder`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_travel`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -70,7 +70,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Object` **get_collider** **(** **)** |const| +:ref:`Object` **get_collider**\ (\ ) |const| Returns the colliding body's attached :ref:`Object`, if a collision occurred. @@ -82,7 +82,7 @@ Returns the colliding body's attached :ref:`Object`, if a collisio .. rst-class:: classref-method -:ref:`int` **get_collider_id** **(** **)** |const| +:ref:`int` **get_collider_id**\ (\ ) |const| Returns the unique instance ID of the colliding body's attached :ref:`Object`, if a collision occurred. See :ref:`Object.get_instance_id`. @@ -94,7 +94,7 @@ Returns the unique instance ID of the colliding body's attached :ref:`Object` **get_collider_rid** **(** **)** |const| +:ref:`RID` **get_collider_rid**\ (\ ) |const| Returns the colliding body's :ref:`RID` used by the :ref:`PhysicsServer2D`, if a collision occurred. @@ -106,7 +106,7 @@ Returns the colliding body's :ref:`RID` used by the :ref:`PhysicsServ .. rst-class:: classref-method -:ref:`int` **get_collider_shape** **(** **)** |const| +:ref:`int` **get_collider_shape**\ (\ ) |const| Returns the colliding body's shape index, if a collision occurred. See :ref:`CollisionObject2D`. @@ -118,7 +118,7 @@ Returns the colliding body's shape index, if a collision occurred. See :ref:`Col .. rst-class:: classref-method -:ref:`Vector2` **get_collider_velocity** **(** **)** |const| +:ref:`Vector2` **get_collider_velocity**\ (\ ) |const| Returns the colliding body's velocity, if a collision occurred. @@ -130,7 +130,7 @@ Returns the colliding body's velocity, if a collision occurred. .. rst-class:: classref-method -:ref:`float` **get_collision_depth** **(** **)** |const| +:ref:`float` **get_collision_depth**\ (\ ) |const| Returns the length of overlap along the collision normal, if a collision occurred. @@ -142,7 +142,7 @@ Returns the length of overlap along the collision normal, if a collision occurre .. rst-class:: classref-method -:ref:`int` **get_collision_local_shape** **(** **)** |const| +:ref:`int` **get_collision_local_shape**\ (\ ) |const| Returns the moving object's colliding shape, if a collision occurred. @@ -154,7 +154,7 @@ Returns the moving object's colliding shape, if a collision occurred. .. rst-class:: classref-method -:ref:`Vector2` **get_collision_normal** **(** **)** |const| +:ref:`Vector2` **get_collision_normal**\ (\ ) |const| Returns the colliding body's shape's normal at the point of collision, if a collision occurred. @@ -166,7 +166,7 @@ Returns the colliding body's shape's normal at the point of collision, if a coll .. rst-class:: classref-method -:ref:`Vector2` **get_collision_point** **(** **)** |const| +:ref:`Vector2` **get_collision_point**\ (\ ) |const| Returns the point of collision in global coordinates, if a collision occurred. @@ -178,7 +178,7 @@ Returns the point of collision in global coordinates, if a collision occurred. .. rst-class:: classref-method -:ref:`float` **get_collision_safe_fraction** **(** **)** |const| +:ref:`float` **get_collision_safe_fraction**\ (\ ) |const| Returns the maximum fraction of the motion that can occur without a collision, between ``0`` and ``1``. @@ -190,7 +190,7 @@ Returns the maximum fraction of the motion that can occur without a collision, b .. rst-class:: classref-method -:ref:`float` **get_collision_unsafe_fraction** **(** **)** |const| +:ref:`float` **get_collision_unsafe_fraction**\ (\ ) |const| Returns the minimum fraction of the motion needed to collide, if a collision occurred, between ``0`` and ``1``. @@ -202,7 +202,7 @@ Returns the minimum fraction of the motion needed to collide, if a collision occ .. rst-class:: classref-method -:ref:`Vector2` **get_remainder** **(** **)** |const| +:ref:`Vector2` **get_remainder**\ (\ ) |const| Returns the moving object's remaining movement vector. @@ -214,7 +214,7 @@ Returns the moving object's remaining movement vector. .. rst-class:: classref-method -:ref:`Vector2` **get_travel** **(** **)** |const| +:ref:`Vector2` **get_travel**\ (\ ) |const| Returns the moving object's travel before collision. @@ -225,3 +225,4 @@ Returns the moving object's travel before collision. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_physicstestmotionresult3d.rst b/classes/class_physicstestmotionresult3d.rst index ff85e51dfa6..a34169f8eff 100644 --- a/classes/class_physicstestmotionresult3d.rst +++ b/classes/class_physicstestmotionresult3d.rst @@ -29,35 +29,35 @@ Methods .. table:: :widths: auto - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_collider` **(** :ref:`int` collision_index=0 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collider_id` **(** :ref:`int` collision_index=0 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_collider_rid` **(** :ref:`int` collision_index=0 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collider_shape` **(** :ref:`int` collision_index=0 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_collider_velocity` **(** :ref:`int` collision_index=0 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collision_count` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_collision_depth` **(** :ref:`int` collision_index=0 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collision_local_shape` **(** :ref:`int` collision_index=0 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_collision_normal` **(** :ref:`int` collision_index=0 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_collision_point` **(** :ref:`int` collision_index=0 **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_collision_safe_fraction` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_collision_unsafe_fraction` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_remainder` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_travel` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_collider`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collider_id`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_collider_rid`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collider_shape`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_collider_velocity`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collision_count`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_collision_depth`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collision_local_shape`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_collision_normal`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_collision_point`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_collision_safe_fraction`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_collision_unsafe_fraction`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_remainder`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_travel`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -72,7 +72,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Object` **get_collider** **(** :ref:`int` collision_index=0 **)** |const| +:ref:`Object` **get_collider**\ (\ collision_index\: :ref:`int` = 0\ ) |const| Returns the colliding body's attached :ref:`Object` given a collision index (the deepest collision by default), if a collision occurred. @@ -84,7 +84,7 @@ Returns the colliding body's attached :ref:`Object` given a collis .. rst-class:: classref-method -:ref:`int` **get_collider_id** **(** :ref:`int` collision_index=0 **)** |const| +:ref:`int` **get_collider_id**\ (\ collision_index\: :ref:`int` = 0\ ) |const| Returns the unique instance ID of the colliding body's attached :ref:`Object` given a collision index (the deepest collision by default), if a collision occurred. See :ref:`Object.get_instance_id`. @@ -96,7 +96,7 @@ Returns the unique instance ID of the colliding body's attached :ref:`Object` **get_collider_rid** **(** :ref:`int` collision_index=0 **)** |const| +:ref:`RID` **get_collider_rid**\ (\ collision_index\: :ref:`int` = 0\ ) |const| Returns the colliding body's :ref:`RID` used by the :ref:`PhysicsServer3D` given a collision index (the deepest collision by default), if a collision occurred. @@ -108,7 +108,7 @@ Returns the colliding body's :ref:`RID` used by the :ref:`PhysicsServ .. rst-class:: classref-method -:ref:`int` **get_collider_shape** **(** :ref:`int` collision_index=0 **)** |const| +:ref:`int` **get_collider_shape**\ (\ collision_index\: :ref:`int` = 0\ ) |const| Returns the colliding body's shape index given a collision index (the deepest collision by default), if a collision occurred. See :ref:`CollisionObject3D`. @@ -120,7 +120,7 @@ Returns the colliding body's shape index given a collision index (the deepest co .. rst-class:: classref-method -:ref:`Vector3` **get_collider_velocity** **(** :ref:`int` collision_index=0 **)** |const| +:ref:`Vector3` **get_collider_velocity**\ (\ collision_index\: :ref:`int` = 0\ ) |const| Returns the colliding body's velocity given a collision index (the deepest collision by default), if a collision occurred. @@ -132,7 +132,7 @@ Returns the colliding body's velocity given a collision index (the deepest colli .. rst-class:: classref-method -:ref:`int` **get_collision_count** **(** **)** |const| +:ref:`int` **get_collision_count**\ (\ ) |const| Returns the number of detected collisions. @@ -144,7 +144,7 @@ Returns the number of detected collisions. .. rst-class:: classref-method -:ref:`float` **get_collision_depth** **(** :ref:`int` collision_index=0 **)** |const| +:ref:`float` **get_collision_depth**\ (\ collision_index\: :ref:`int` = 0\ ) |const| Returns the length of overlap along the collision normal given a collision index (the deepest collision by default), if a collision occurred. @@ -156,7 +156,7 @@ Returns the length of overlap along the collision normal given a collision index .. rst-class:: classref-method -:ref:`int` **get_collision_local_shape** **(** :ref:`int` collision_index=0 **)** |const| +:ref:`int` **get_collision_local_shape**\ (\ collision_index\: :ref:`int` = 0\ ) |const| Returns the moving object's colliding shape given a collision index (the deepest collision by default), if a collision occurred. @@ -168,7 +168,7 @@ Returns the moving object's colliding shape given a collision index (the deepest .. rst-class:: classref-method -:ref:`Vector3` **get_collision_normal** **(** :ref:`int` collision_index=0 **)** |const| +:ref:`Vector3` **get_collision_normal**\ (\ collision_index\: :ref:`int` = 0\ ) |const| Returns the colliding body's shape's normal at the point of collision given a collision index (the deepest collision by default), if a collision occurred. @@ -180,7 +180,7 @@ Returns the colliding body's shape's normal at the point of collision given a co .. rst-class:: classref-method -:ref:`Vector3` **get_collision_point** **(** :ref:`int` collision_index=0 **)** |const| +:ref:`Vector3` **get_collision_point**\ (\ collision_index\: :ref:`int` = 0\ ) |const| Returns the point of collision in global coordinates given a collision index (the deepest collision by default), if a collision occurred. @@ -192,7 +192,7 @@ Returns the point of collision in global coordinates given a collision index (th .. rst-class:: classref-method -:ref:`float` **get_collision_safe_fraction** **(** **)** |const| +:ref:`float` **get_collision_safe_fraction**\ (\ ) |const| Returns the maximum fraction of the motion that can occur without a collision, between ``0`` and ``1``. @@ -204,7 +204,7 @@ Returns the maximum fraction of the motion that can occur without a collision, b .. rst-class:: classref-method -:ref:`float` **get_collision_unsafe_fraction** **(** **)** |const| +:ref:`float` **get_collision_unsafe_fraction**\ (\ ) |const| Returns the minimum fraction of the motion needed to collide, if a collision occurred, between ``0`` and ``1``. @@ -216,7 +216,7 @@ Returns the minimum fraction of the motion needed to collide, if a collision occ .. rst-class:: classref-method -:ref:`Vector3` **get_remainder** **(** **)** |const| +:ref:`Vector3` **get_remainder**\ (\ ) |const| Returns the moving object's remaining movement vector. @@ -228,7 +228,7 @@ Returns the moving object's remaining movement vector. .. rst-class:: classref-method -:ref:`Vector3` **get_travel** **(** **)** |const| +:ref:`Vector3` **get_travel**\ (\ ) |const| Returns the moving object's travel before collision. @@ -239,3 +239,4 @@ Returns the moving object's travel before collision. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index fd07b8f4c57..291e05434fc 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -60,8 +60,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_angular_limit_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_angular_limit_enabled** **(** **)** +- |void| **set_angular_limit_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_angular_limit_enabled**\ (\ ) If ``true``, the pin maximum and minimum rotation, defined by :ref:`angular_limit_lower` and :ref:`angular_limit_upper` are applied. @@ -77,8 +77,8 @@ If ``true``, the pin maximum and minimum rotation, defined by :ref:`angular_limi .. rst-class:: classref-property-setget -- void **set_angular_limit_lower** **(** :ref:`float` value **)** -- :ref:`float` **get_angular_limit_lower** **(** **)** +- |void| **set_angular_limit_lower**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_angular_limit_lower**\ (\ ) The minimum rotation. Only active if :ref:`angular_limit_enabled` is ``true``. @@ -94,8 +94,8 @@ The minimum rotation. Only active if :ref:`angular_limit_enabled` value **)** -- :ref:`float` **get_angular_limit_upper** **(** **)** +- |void| **set_angular_limit_upper**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_angular_limit_upper**\ (\ ) The maximum rotation. Only active if :ref:`angular_limit_enabled` is ``true``. @@ -111,8 +111,8 @@ The maximum rotation. Only active if :ref:`angular_limit_enabled` value **)** -- :ref:`bool` **is_motor_enabled** **(** **)** +- |void| **set_motor_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_motor_enabled**\ (\ ) When activated, a motor turns the pin. @@ -128,8 +128,8 @@ When activated, a motor turns the pin. .. rst-class:: classref-property-setget -- void **set_motor_target_velocity** **(** :ref:`float` value **)** -- :ref:`float` **get_motor_target_velocity** **(** **)** +- |void| **set_motor_target_velocity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_motor_target_velocity**\ (\ ) Target speed for the motor. In radians per second. @@ -145,8 +145,8 @@ Target speed for the motor. In radians per second. .. rst-class:: classref-property-setget -- void **set_softness** **(** :ref:`float` value **)** -- :ref:`float` **get_softness** **(** **)** +- |void| **set_softness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_softness**\ (\ ) The higher this value, the more the bond to the pinned partner can flex. @@ -157,3 +157,4 @@ The higher this value, the more the bond to the pinned partner can flex. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_pinjoint3d.rst b/classes/class_pinjoint3d.rst index 27c8bc9d2f9..f873e9266c2 100644 --- a/classes/class_pinjoint3d.rst +++ b/classes/class_pinjoint3d.rst @@ -45,11 +45,11 @@ Methods .. table:: :widths: auto - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_param` **(** :ref:`Param` param **)** |const| | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_param` **(** :ref:`Param` param, :ref:`float` value **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_param`\ (\ param\: :ref:`Param`\ ) |const| | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_param`\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -107,8 +107,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The force with which the pinned objects stay in positional relation to each other. The higher, the stronger. @@ -124,8 +124,8 @@ The force with which the pinned objects stay in positional relation to each othe .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger. @@ -141,8 +141,8 @@ The force with which the pinned objects stay in velocity relation to each other. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| If above 0, this value is the maximum value for an impulse that this Joint3D produces. @@ -159,7 +159,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +:ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| Returns the value of the specified parameter. @@ -171,7 +171,7 @@ Returns the value of the specified parameter. .. rst-class:: classref-method -void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** +|void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) Sets the value of the specified parameter. @@ -182,3 +182,4 @@ Sets the value of the specified parameter. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_placeholdercubemap.rst b/classes/class_placeholdercubemap.rst index 416c9c1633a..7ef72439ee3 100644 --- a/classes/class_placeholdercubemap.rst +++ b/classes/class_placeholdercubemap.rst @@ -34,3 +34,4 @@ This class replaces a :ref:`Cubemap` or a :ref:`Cubemap` or a :ref:`Cubemap .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_placeholdermaterial.rst b/classes/class_placeholdermaterial.rst index fa650d40940..f81701e0801 100644 --- a/classes/class_placeholdermaterial.rst +++ b/classes/class_placeholdermaterial.rst @@ -32,3 +32,4 @@ This class is used when loading a project that uses a :ref:`Material` value **)** -- :ref:`AABB` **get_aabb** **(** **)** +- |void| **set_aabb**\ (\ value\: :ref:`AABB`\ ) +- :ref:`AABB` **get_aabb**\ (\ ) The smallest :ref:`AABB` enclosing this mesh in local space. @@ -66,3 +66,4 @@ The smallest :ref:`AABB` enclosing this mesh in local space. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_placeholdertexture2d.rst b/classes/class_placeholdertexture2d.rst index 0a6200b5eb5..814cd46e520 100644 --- a/classes/class_placeholdertexture2d.rst +++ b/classes/class_placeholdertexture2d.rst @@ -58,8 +58,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_size**\ (\ ) The texture's size (in pixels). @@ -70,3 +70,4 @@ The texture's size (in pixels). .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_placeholdertexture2darray.rst b/classes/class_placeholdertexture2darray.rst index b4a2089227b..a4ccfb4f28d 100644 --- a/classes/class_placeholdertexture2darray.rst +++ b/classes/class_placeholdertexture2darray.rst @@ -34,3 +34,4 @@ This class is used when loading a project that uses a :ref:`Texture2D` value **)** -- :ref:`Vector3i` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector3i`\ ) +- :ref:`Vector3i` **get_size**\ (\ ) The texture's size (in pixels). @@ -68,3 +68,4 @@ The texture's size (in pixels). .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_placeholdertexturelayered.rst b/classes/class_placeholdertexturelayered.rst index af4141b6084..1b24e0f0261 100644 --- a/classes/class_placeholdertexturelayered.rst +++ b/classes/class_placeholdertexturelayered.rst @@ -60,8 +60,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_layers** **(** **)** +- |void| **set_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_layers**\ (\ ) The number of layers in the texture array. @@ -77,8 +77,8 @@ The number of layers in the texture array. .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`Vector2i` value **)** -- :ref:`Vector2i` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_size**\ (\ ) The size of each texture layer (in pixels). @@ -89,3 +89,4 @@ The size of each texture layer (in pixels). .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_plane.rst b/classes/class_plane.rst index 30c2675f7ed..7f865faf1b2 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -54,21 +54,21 @@ Constructors .. table:: :widths: auto - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Plane` | :ref:`Plane` **(** **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Plane` | :ref:`Plane` **(** :ref:`Plane` from **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Plane` | :ref:`Plane` **(** :ref:`float` a, :ref:`float` b, :ref:`float` c, :ref:`float` d **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` normal **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` normal, :ref:`float` d **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` normal, :ref:`Vector3` point **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` point1, :ref:`Vector3` point2, :ref:`Vector3` point3 **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Plane` | :ref:`Plane`\ (\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Plane` | :ref:`Plane`\ (\ from\: :ref:`Plane`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Plane` | :ref:`Plane`\ (\ a\: :ref:`float`, b\: :ref:`float`, c\: :ref:`float`, d\: :ref:`float`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Plane` | :ref:`Plane`\ (\ normal\: :ref:`Vector3`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Plane` | :ref:`Plane`\ (\ normal\: :ref:`Vector3`, d\: :ref:`float`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Plane` | :ref:`Plane`\ (\ normal\: :ref:`Vector3`, point\: :ref:`Vector3`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Plane` | :ref:`Plane`\ (\ point1\: :ref:`Vector3`, point2\: :ref:`Vector3`, point3\: :ref:`Vector3`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -78,29 +78,29 @@ Methods .. table:: :widths: auto - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3` point **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_center` **(** **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point, :ref:`float` tolerance=1e-05 **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`intersect_3` **(** :ref:`Plane` b, :ref:`Plane` c **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`intersects_ray` **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`intersects_segment` **(** :ref:`Vector3` from, :ref:`Vector3` to **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Plane` to_plane **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_finite` **(** **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_point_over` **(** :ref:`Vector3` point **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Plane` | :ref:`normalized` **(** **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`project` **(** :ref:`Vector3` point **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`distance_to`\ (\ point\: :ref:`Vector3`\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_center`\ (\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_point`\ (\ point\: :ref:`Vector3`, tolerance\: :ref:`float` = 1e-05\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`intersect_3`\ (\ b\: :ref:`Plane`, c\: :ref:`Plane`\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`intersects_ray`\ (\ from\: :ref:`Vector3`, dir\: :ref:`Vector3`\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`intersects_segment`\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equal_approx`\ (\ to_plane\: :ref:`Plane`\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_point_over`\ (\ point\: :ref:`Vector3`\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Plane` | :ref:`normalized`\ (\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`project`\ (\ point\: :ref:`Vector3`\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -110,17 +110,17 @@ Operators .. table:: :widths: auto - +---------------------------+-----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Plane` right **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+ - | :ref:`Plane` | :ref:`operator *` **(** :ref:`Transform3D` right **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Plane` right **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+ - | :ref:`Plane` | :ref:`operator unary+` **(** **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+ - | :ref:`Plane` | :ref:`operator unary-` **(** **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+ + +---------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Plane`\ ) | + +---------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`Plane` | :ref:`operator *`\ (\ right\: :ref:`Transform3D`\ ) | + +---------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Plane`\ ) | + +---------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`Plane` | :ref:`operator unary+`\ (\ ) | + +---------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`Plane` | :ref:`operator unary-`\ (\ ) | + +---------------------------+--------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -237,7 +237,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Plane` **Plane** **(** **)** +:ref:`Plane` **Plane**\ (\ ) Constructs a default-initialized **Plane** with all components set to ``0``. @@ -247,7 +247,7 @@ Constructs a default-initialized **Plane** with all components set to ``0``. .. rst-class:: classref-constructor -:ref:`Plane` **Plane** **(** :ref:`Plane` from **)** +:ref:`Plane` **Plane**\ (\ from\: :ref:`Plane`\ ) Constructs a **Plane** as a copy of the given **Plane**. @@ -257,7 +257,7 @@ Constructs a **Plane** as a copy of the given **Plane**. .. rst-class:: classref-constructor -:ref:`Plane` **Plane** **(** :ref:`float` a, :ref:`float` b, :ref:`float` c, :ref:`float` d **)** +:ref:`Plane` **Plane**\ (\ a\: :ref:`float`, b\: :ref:`float`, c\: :ref:`float`, d\: :ref:`float`\ ) Creates a plane from the four parameters. The three components of the resulting plane's :ref:`normal` are ``a``, ``b`` and ``c``, and the plane has a distance of ``d`` from the origin. @@ -267,7 +267,7 @@ Creates a plane from the four parameters. The three components of the resulting .. rst-class:: classref-constructor -:ref:`Plane` **Plane** **(** :ref:`Vector3` normal **)** +:ref:`Plane` **Plane**\ (\ normal\: :ref:`Vector3`\ ) Creates a plane from the normal vector. The plane will intersect the origin. @@ -279,7 +279,7 @@ The ``normal`` of the plane must be a unit vector. .. rst-class:: classref-constructor -:ref:`Plane` **Plane** **(** :ref:`Vector3` normal, :ref:`float` d **)** +:ref:`Plane` **Plane**\ (\ normal\: :ref:`Vector3`, d\: :ref:`float`\ ) Creates a plane from the normal vector and the plane's distance from the origin. @@ -291,7 +291,7 @@ The ``normal`` of the plane must be a unit vector. .. rst-class:: classref-constructor -:ref:`Plane` **Plane** **(** :ref:`Vector3` normal, :ref:`Vector3` point **)** +:ref:`Plane` **Plane**\ (\ normal\: :ref:`Vector3`, point\: :ref:`Vector3`\ ) Creates a plane from the normal vector and a point on the plane. @@ -303,7 +303,7 @@ The ``normal`` of the plane must be a unit vector. .. rst-class:: classref-constructor -:ref:`Plane` **Plane** **(** :ref:`Vector3` point1, :ref:`Vector3` point2, :ref:`Vector3` point3 **)** +:ref:`Plane` **Plane**\ (\ point1\: :ref:`Vector3`, point2\: :ref:`Vector3`, point3\: :ref:`Vector3`\ ) Creates a plane from the three points, given in clockwise order. @@ -320,7 +320,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **distance_to** **(** :ref:`Vector3` point **)** |const| +:ref:`float` **distance_to**\ (\ point\: :ref:`Vector3`\ ) |const| Returns the shortest distance from the plane to the position ``point``. If the point is above the plane, the distance will be positive. If below, the distance will be negative. @@ -332,7 +332,7 @@ Returns the shortest distance from the plane to the position ``point``. If the p .. rst-class:: classref-method -:ref:`Vector3` **get_center** **(** **)** |const| +:ref:`Vector3` **get_center**\ (\ ) |const| Returns the center of the plane. @@ -344,7 +344,7 @@ Returns the center of the plane. .. rst-class:: classref-method -:ref:`bool` **has_point** **(** :ref:`Vector3` point, :ref:`float` tolerance=1e-05 **)** |const| +:ref:`bool` **has_point**\ (\ point\: :ref:`Vector3`, tolerance\: :ref:`float` = 1e-05\ ) |const| Returns ``true`` if ``point`` is inside the plane. Comparison uses a custom minimum ``tolerance`` threshold. @@ -356,7 +356,7 @@ Returns ``true`` if ``point`` is inside the plane. Comparison uses a custom mini .. rst-class:: classref-method -:ref:`Variant` **intersect_3** **(** :ref:`Plane` b, :ref:`Plane` c **)** |const| +:ref:`Variant` **intersect_3**\ (\ b\: :ref:`Plane`, c\: :ref:`Plane`\ ) |const| Returns the intersection point of the three planes ``b``, ``c`` and this plane. If no intersection is found, ``null`` is returned. @@ -368,7 +368,7 @@ Returns the intersection point of the three planes ``b``, ``c`` and this plane. .. rst-class:: classref-method -:ref:`Variant` **intersects_ray** **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** |const| +:ref:`Variant` **intersects_ray**\ (\ from\: :ref:`Vector3`, dir\: :ref:`Vector3`\ ) |const| Returns the intersection point of a ray consisting of the position ``from`` and the direction normal ``dir`` with this plane. If no intersection is found, ``null`` is returned. @@ -380,7 +380,7 @@ Returns the intersection point of a ray consisting of the position ``from`` and .. rst-class:: classref-method -:ref:`Variant` **intersects_segment** **(** :ref:`Vector3` from, :ref:`Vector3` to **)** |const| +:ref:`Variant` **intersects_segment**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`\ ) |const| Returns the intersection point of a segment from position ``from`` to position ``to`` with this plane. If no intersection is found, ``null`` is returned. @@ -392,7 +392,7 @@ Returns the intersection point of a segment from position ``from`` to position ` .. rst-class:: classref-method -:ref:`bool` **is_equal_approx** **(** :ref:`Plane` to_plane **)** |const| +:ref:`bool` **is_equal_approx**\ (\ to_plane\: :ref:`Plane`\ ) |const| Returns ``true`` if this plane and ``to_plane`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. @@ -404,7 +404,7 @@ Returns ``true`` if this plane and ``to_plane`` are approximately equal, by runn .. rst-class:: classref-method -:ref:`bool` **is_finite** **(** **)** |const| +:ref:`bool` **is_finite**\ (\ ) |const| Returns ``true`` if this plane is finite, by calling :ref:`@GlobalScope.is_finite` on each component. @@ -416,7 +416,7 @@ Returns ``true`` if this plane is finite, by calling :ref:`@GlobalScope.is_finit .. rst-class:: classref-method -:ref:`bool` **is_point_over** **(** :ref:`Vector3` point **)** |const| +:ref:`bool` **is_point_over**\ (\ point\: :ref:`Vector3`\ ) |const| Returns ``true`` if ``point`` is located above the plane. @@ -428,7 +428,7 @@ Returns ``true`` if ``point`` is located above the plane. .. rst-class:: classref-method -:ref:`Plane` **normalized** **(** **)** |const| +:ref:`Plane` **normalized**\ (\ ) |const| Returns a copy of the plane, with normalized :ref:`normal` (so it's a unit vector). Returns ``Plane(0, 0, 0, 0)`` if :ref:`normal` can't be normalized (it has zero length). @@ -440,7 +440,7 @@ Returns a copy of the plane, with normalized :ref:`normal` **project** **(** :ref:`Vector3` point **)** |const| +:ref:`Vector3` **project**\ (\ point\: :ref:`Vector3`\ ) |const| Returns the orthogonal projection of ``point`` into a point in the plane. @@ -457,7 +457,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Plane` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Plane`\ ) Returns ``true`` if the planes are not equal. @@ -471,7 +471,7 @@ Returns ``true`` if the planes are not equal. .. rst-class:: classref-operator -:ref:`Plane` **operator *** **(** :ref:`Transform3D` right **)** +:ref:`Plane` **operator ***\ (\ right\: :ref:`Transform3D`\ ) Inversely transforms (multiplies) the **Plane** by the given :ref:`Transform3D` transformation matrix. @@ -485,7 +485,7 @@ Inversely transforms (multiplies) the **Plane** by the given :ref:`Transform3D` **operator ==** **(** :ref:`Plane` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Plane`\ ) Returns ``true`` if the planes are exactly equal. @@ -499,7 +499,7 @@ Returns ``true`` if the planes are exactly equal. .. rst-class:: classref-operator -:ref:`Plane` **operator unary+** **(** **)** +:ref:`Plane` **operator unary+**\ (\ ) Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -511,7 +511,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`Plane` **operator unary-** **(** **)** +:ref:`Plane` **operator unary-**\ (\ ) Returns the negative value of the **Plane**. This is the same as writing ``Plane(-p.normal, -p.d)``. This operation flips the direction of the normal vector and also flips the distance value, resulting in a Plane that is in the same place, but facing the opposite direction. @@ -522,3 +522,4 @@ Returns the negative value of the **Plane**. This is the same as writing ``Plane .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_planemesh.rst b/classes/class_planemesh.rst index d03789737a1..e4701fecf53 100644 --- a/classes/class_planemesh.rst +++ b/classes/class_planemesh.rst @@ -101,8 +101,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_center_offset** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_center_offset** **(** **)** +- |void| **set_center_offset**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_center_offset**\ (\ ) Offset of the generated plane. Useful for particles. @@ -118,8 +118,8 @@ Offset of the generated plane. Useful for particles. .. rst-class:: classref-property-setget -- void **set_orientation** **(** :ref:`Orientation` value **)** -- :ref:`Orientation` **get_orientation** **(** **)** +- |void| **set_orientation**\ (\ value\: :ref:`Orientation`\ ) +- :ref:`Orientation` **get_orientation**\ (\ ) Direction that the **PlaneMesh** is facing. See :ref:`Orientation` for options. @@ -135,8 +135,8 @@ Direction that the **PlaneMesh** is facing. See :ref:`Orientation` value **)** -- :ref:`Vector2` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_size**\ (\ ) Size of the generated plane. @@ -152,8 +152,8 @@ Size of the generated plane. .. rst-class:: classref-property-setget -- void **set_subdivide_depth** **(** :ref:`int` value **)** -- :ref:`int` **get_subdivide_depth** **(** **)** +- |void| **set_subdivide_depth**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_subdivide_depth**\ (\ ) Number of subdivision along the Z axis. @@ -169,8 +169,8 @@ Number of subdivision along the Z axis. .. rst-class:: classref-property-setget -- void **set_subdivide_width** **(** :ref:`int` value **)** -- :ref:`int` **get_subdivide_width** **(** **)** +- |void| **set_subdivide_width**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_subdivide_width**\ (\ ) Number of subdivision along the X axis. @@ -181,3 +181,4 @@ Number of subdivision along the X axis. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_pointlight2d.rst b/classes/class_pointlight2d.rst index 02376873015..99d1702e93a 100644 --- a/classes/class_pointlight2d.rst +++ b/classes/class_pointlight2d.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: omni, spot + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -63,8 +66,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_height** **(** :ref:`float` value **)** -- :ref:`float` **get_height** **(** **)** +- |void| **set_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_height**\ (\ ) The height of the light. Used with 2D normal mapping. The units are in pixels, e.g. if the height is 100, then it will illuminate an object 100 pixels away at a 45° angle to the plane. @@ -80,8 +83,8 @@ The height of the light. Used with 2D normal mapping. The units are in pixels, e .. rst-class:: classref-property-setget -- void **set_texture_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_texture_offset** **(** **)** +- |void| **set_texture_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_texture_offset**\ (\ ) The offset of the light's :ref:`texture`. @@ -97,8 +100,8 @@ The offset of the light's :ref:`texture`. .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ ) :ref:`Texture2D` used for the light's appearance. @@ -114,8 +117,8 @@ The offset of the light's :ref:`texture`. .. rst-class:: classref-property-setget -- void **set_texture_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_texture_scale** **(** **)** +- |void| **set_texture_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_texture_scale**\ (\ ) The :ref:`texture`'s scale factor. @@ -126,3 +129,4 @@ The :ref:`texture`'s scale factor. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_pointmesh.rst b/classes/class_pointmesh.rst index c49ce21d134..f8db8f2a2ba 100644 --- a/classes/class_pointmesh.rst +++ b/classes/class_pointmesh.rst @@ -32,3 +32,4 @@ When using PointMeshes, properties that normally alter vertices will be ignored, .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index 1ee8e73bfe6..343794e62ff 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -71,23 +71,23 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_bone` **(** :ref:`NodePath` path, :ref:`PackedFloat32Array` weights **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_bones` **(** **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`erase_bone` **(** :ref:`int` index **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_bone_count` **(** **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_bone_path` **(** :ref:`int` index **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`get_bone_weights` **(** :ref:`int` index **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bone_path` **(** :ref:`int` index, :ref:`NodePath` path **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bone_weights` **(** :ref:`int` index, :ref:`PackedFloat32Array` weights **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_bone`\ (\ path\: :ref:`NodePath`, weights\: :ref:`PackedFloat32Array`\ ) | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_bones`\ (\ ) | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`erase_bone`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_bone_count`\ (\ ) |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_bone_path`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`get_bone_weights`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bone_path`\ (\ index\: :ref:`int`, path\: :ref:`NodePath`\ ) | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bone_weights`\ (\ index\: :ref:`int`, weights\: :ref:`PackedFloat32Array`\ ) | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -106,8 +106,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_antialiased** **(** :ref:`bool` value **)** -- :ref:`bool` **get_antialiased** **(** **)** +- |void| **set_antialiased**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_antialiased**\ (\ ) If ``true``, polygon edges will be anti-aliased. @@ -135,8 +135,8 @@ Internal list of :ref:`Bone2D` nodes used by the assigned :ref:`sk .. rst-class:: classref-property-setget -- void **set_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_color** **(** **)** +- |void| **set_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_color**\ (\ ) The polygon's fill color. If :ref:`texture` is set, it will be multiplied by this color. It will also be the default color for vertices not set in :ref:`vertex_colors`. @@ -152,8 +152,8 @@ The polygon's fill color. If :ref:`texture` is .. rst-class:: classref-property-setget -- void **set_internal_vertex_count** **(** :ref:`int` value **)** -- :ref:`int` **get_internal_vertex_count** **(** **)** +- |void| **set_internal_vertex_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_internal_vertex_count**\ (\ ) Number of internal vertices, used for UV mapping. @@ -169,8 +169,8 @@ Number of internal vertices, used for UV mapping. .. rst-class:: classref-property-setget -- void **set_invert_border** **(** :ref:`float` value **)** -- :ref:`float` **get_invert_border** **(** **)** +- |void| **set_invert_border**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_invert_border**\ (\ ) Added padding applied to the bounding box when :ref:`invert_enabled` is set to ``true``. Setting this value too small may result in a "Bad Polygon" error. @@ -186,8 +186,8 @@ Added padding applied to the bounding box when :ref:`invert_enabled` value **)** -- :ref:`bool` **get_invert_enabled** **(** **)** +- |void| **set_invert_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_invert_enabled**\ (\ ) If ``true``, the polygon will be inverted, containing the area outside the defined points and extending to the :ref:`invert_border`. @@ -203,8 +203,8 @@ If ``true``, the polygon will be inverted, containing the area outside the defin .. rst-class:: classref-property-setget -- void **set_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_offset** **(** **)** +- |void| **set_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_offset**\ (\ ) The offset applied to each vertex. @@ -220,8 +220,8 @@ The offset applied to each vertex. .. rst-class:: classref-property-setget -- void **set_polygon** **(** :ref:`PackedVector2Array` value **)** -- :ref:`PackedVector2Array` **get_polygon** **(** **)** +- |void| **set_polygon**\ (\ value\: :ref:`PackedVector2Array`\ ) +- :ref:`PackedVector2Array` **get_polygon**\ (\ ) The polygon's list of vertices. The final point will be connected to the first. @@ -239,8 +239,8 @@ The polygon's list of vertices. The final point will be connected to the first. .. rst-class:: classref-property-setget -- void **set_polygons** **(** :ref:`Array` value **)** -- :ref:`Array` **get_polygons** **(** **)** +- |void| **set_polygons**\ (\ value\: :ref:`Array`\ ) +- :ref:`Array` **get_polygons**\ (\ ) The list of polygons, in case more than one is being represented. Every individual polygon is stored as a :ref:`PackedInt32Array` where each :ref:`int` is an index to a point in :ref:`polygon`. If empty, this property will be ignored, and the resulting single polygon will be composed of all points in :ref:`polygon`, using the order they are stored in. @@ -256,8 +256,8 @@ The list of polygons, in case more than one is being represented. Every individu .. rst-class:: classref-property-setget -- void **set_skeleton** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_skeleton** **(** **)** +- |void| **set_skeleton**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_skeleton**\ (\ ) Path to a :ref:`Skeleton2D` node used for skeleton-based deformations of this polygon. If empty or invalid, skeletal deformations will not be used. @@ -273,8 +273,8 @@ Path to a :ref:`Skeleton2D` node used for skeleton-based defor .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ ) The polygon's fill texture. Use :ref:`uv` to set texture coordinates. @@ -290,8 +290,8 @@ The polygon's fill texture. Use :ref:`uv` to set te .. rst-class:: classref-property-setget -- void **set_texture_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_texture_offset** **(** **)** +- |void| **set_texture_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_texture_offset**\ (\ ) Amount to offset the polygon's :ref:`texture`. If set to ``Vector2(0, 0)``, the texture's origin (its top-left corner) will be placed at the polygon's position. @@ -307,8 +307,8 @@ Amount to offset the polygon's :ref:`texture`. .. rst-class:: classref-property-setget -- void **set_texture_rotation** **(** :ref:`float` value **)** -- :ref:`float` **get_texture_rotation** **(** **)** +- |void| **set_texture_rotation**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_texture_rotation**\ (\ ) The texture's rotation in radians. @@ -324,8 +324,8 @@ The texture's rotation in radians. .. rst-class:: classref-property-setget -- void **set_texture_scale** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_texture_scale** **(** **)** +- |void| **set_texture_scale**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_texture_scale**\ (\ ) Amount to multiply the :ref:`uv` coordinates when using :ref:`texture`. Larger values make the texture smaller, and vice versa. @@ -341,8 +341,8 @@ Amount to multiply the :ref:`uv` coordinates when u .. rst-class:: classref-property-setget -- void **set_uv** **(** :ref:`PackedVector2Array` value **)** -- :ref:`PackedVector2Array` **get_uv** **(** **)** +- |void| **set_uv**\ (\ value\: :ref:`PackedVector2Array`\ ) +- :ref:`PackedVector2Array` **get_uv**\ (\ ) Texture coordinates for each vertex of the polygon. There should be one UV value per polygon vertex. If there are fewer, undefined vertices will use ``Vector2(0, 0)``. @@ -358,8 +358,8 @@ Texture coordinates for each vertex of the polygon. There should be one UV value .. rst-class:: classref-property-setget -- void **set_vertex_colors** **(** :ref:`PackedColorArray` value **)** -- :ref:`PackedColorArray` **get_vertex_colors** **(** **)** +- |void| **set_vertex_colors**\ (\ value\: :ref:`PackedColorArray`\ ) +- :ref:`PackedColorArray` **get_vertex_colors**\ (\ ) Color for each vertex. Colors are interpolated between vertices, resulting in smooth gradients. There should be one per polygon vertex. If there are fewer, undefined vertices will use :ref:`color`. @@ -376,7 +376,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_bone** **(** :ref:`NodePath` path, :ref:`PackedFloat32Array` weights **)** +|void| **add_bone**\ (\ path\: :ref:`NodePath`, weights\: :ref:`PackedFloat32Array`\ ) Adds a bone with the specified ``path`` and ``weights``. @@ -388,7 +388,7 @@ Adds a bone with the specified ``path`` and ``weights``. .. rst-class:: classref-method -void **clear_bones** **(** **)** +|void| **clear_bones**\ (\ ) Removes all bones from this **Polygon2D**. @@ -400,7 +400,7 @@ Removes all bones from this **Polygon2D**. .. rst-class:: classref-method -void **erase_bone** **(** :ref:`int` index **)** +|void| **erase_bone**\ (\ index\: :ref:`int`\ ) Removes the specified bone from this **Polygon2D**. @@ -412,7 +412,7 @@ Removes the specified bone from this **Polygon2D**. .. rst-class:: classref-method -:ref:`int` **get_bone_count** **(** **)** |const| +:ref:`int` **get_bone_count**\ (\ ) |const| Returns the number of bones in this **Polygon2D**. @@ -424,7 +424,7 @@ Returns the number of bones in this **Polygon2D**. .. rst-class:: classref-method -:ref:`NodePath` **get_bone_path** **(** :ref:`int` index **)** |const| +:ref:`NodePath` **get_bone_path**\ (\ index\: :ref:`int`\ ) |const| Returns the path to the node associated with the specified bone. @@ -436,7 +436,7 @@ Returns the path to the node associated with the specified bone. .. rst-class:: classref-method -:ref:`PackedFloat32Array` **get_bone_weights** **(** :ref:`int` index **)** |const| +:ref:`PackedFloat32Array` **get_bone_weights**\ (\ index\: :ref:`int`\ ) |const| Returns the weight values of the specified bone. @@ -448,7 +448,7 @@ Returns the weight values of the specified bone. .. rst-class:: classref-method -void **set_bone_path** **(** :ref:`int` index, :ref:`NodePath` path **)** +|void| **set_bone_path**\ (\ index\: :ref:`int`, path\: :ref:`NodePath`\ ) Sets the path to the node associated with the specified bone. @@ -460,7 +460,7 @@ Sets the path to the node associated with the specified bone. .. rst-class:: classref-method -void **set_bone_weights** **(** :ref:`int` index, :ref:`PackedFloat32Array` weights **)** +|void| **set_bone_weights**\ (\ index\: :ref:`int`, weights\: :ref:`PackedFloat32Array`\ ) Sets the weight values for the specified bone. @@ -471,3 +471,4 @@ Sets the weight values for the specified bone. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_polygonoccluder3d.rst b/classes/class_polygonoccluder3d.rst index a3882a80d6f..24fc094ec13 100644 --- a/classes/class_polygonoccluder3d.rst +++ b/classes/class_polygonoccluder3d.rst @@ -59,8 +59,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_polygon** **(** :ref:`PackedVector2Array` value **)** -- :ref:`PackedVector2Array` **get_polygon** **(** **)** +- |void| **set_polygon**\ (\ value\: :ref:`PackedVector2Array`\ ) +- :ref:`PackedVector2Array` **get_polygon**\ (\ ) The polygon to use for occlusion culling. The polygon can be convex or concave, but it should have as few points as possible to maximize performance. @@ -73,3 +73,4 @@ The polygon must *not* have intersecting lines. Otherwise, triangulation will fa .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index 950989059cc..480ab2cb910 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -24,23 +24,23 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`find_path` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_bounds` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` point **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`get_intersections` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_point_penalty` **(** :ref:`int` idx **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_point_inside` **(** :ref:`Vector2` point **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_penalty` **(** :ref:`int` idx, :ref:`float` penalty **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`setup` **(** :ref:`PackedVector2Array` points, :ref:`PackedInt32Array` connections **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`find_path`\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_bounds`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_closest_point`\ (\ point\: :ref:`Vector2`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`get_intersections`\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_point_penalty`\ (\ idx\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_point_inside`\ (\ point\: :ref:`Vector2`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_penalty`\ (\ idx\: :ref:`int`, penalty\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`setup`\ (\ points\: :ref:`PackedVector2Array`, connections\: :ref:`PackedInt32Array`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -55,7 +55,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedVector2Array` **find_path** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** +:ref:`PackedVector2Array` **find_path**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`\ ) .. container:: contribute @@ -69,7 +69,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Rect2` **get_bounds** **(** **)** |const| +:ref:`Rect2` **get_bounds**\ (\ ) |const| .. container:: contribute @@ -83,7 +83,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` point **)** |const| +:ref:`Vector2` **get_closest_point**\ (\ point\: :ref:`Vector2`\ ) |const| .. container:: contribute @@ -97,7 +97,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_intersections** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** |const| +:ref:`PackedVector2Array` **get_intersections**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`\ ) |const| .. container:: contribute @@ -111,7 +111,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_point_penalty** **(** :ref:`int` idx **)** |const| +:ref:`float` **get_point_penalty**\ (\ idx\: :ref:`int`\ ) |const| .. container:: contribute @@ -125,7 +125,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_point_inside** **(** :ref:`Vector2` point **)** |const| +:ref:`bool` **is_point_inside**\ (\ point\: :ref:`Vector2`\ ) |const| .. container:: contribute @@ -139,7 +139,7 @@ Method Descriptions .. rst-class:: classref-method -void **set_point_penalty** **(** :ref:`int` idx, :ref:`float` penalty **)** +|void| **set_point_penalty**\ (\ idx\: :ref:`int`, penalty\: :ref:`float`\ ) .. container:: contribute @@ -153,7 +153,7 @@ void **set_point_penalty** **(** :ref:`int` idx, :ref:`float` points, :ref:`PackedInt32Array` connections **)** +|void| **setup**\ (\ points\: :ref:`PackedVector2Array`, connections\: :ref:`PackedInt32Array`\ ) .. container:: contribute @@ -166,3 +166,4 @@ void **setup** **(** :ref:`PackedVector2Array` points, .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 3b567318ec5..4ba50d3273c 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -70,7 +70,7 @@ Signals .. rst-class:: classref-signal -**popup_hide** **(** **)** +**popup_hide**\ (\ ) Emitted when the popup is hidden. @@ -98,3 +98,4 @@ Default :ref:`StyleBox` for the **Popup**. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 9bfa003b795..1e7582c64c7 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -61,141 +61,147 @@ Methods .. table:: :widths: auto - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`activate_item_by_event` **(** :ref:`InputEvent` event, :ref:`bool` for_global_only=false **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_check_shortcut` **(** :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_icon_check_item` **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_icon_check_shortcut` **(** :ref:`Texture2D` texture, :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_icon_item` **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_icon_radio_check_item` **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_icon_radio_check_shortcut` **(** :ref:`Texture2D` texture, :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_icon_shortcut` **(** :ref:`Texture2D` texture, :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false, :ref:`bool` allow_echo=false **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_multistate_item` **(** :ref:`String` label, :ref:`int` max_states, :ref:`int` default_state=0, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_radio_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_radio_check_shortcut` **(** :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_separator` **(** :ref:`String` label="", :ref:`int` id=-1 **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_shortcut` **(** :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false, :ref:`bool` allow_echo=false **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** :ref:`bool` free_submenus=false **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_focused_item` **(** **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Key` | :ref:`get_item_accelerator` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_item_icon` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_icon_max_width` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_item_icon_modulate` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_id` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_indent` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_language` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_multistate` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_multistate_max` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Shortcut` | :ref:`get_item_shortcut` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_text` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TextDirection` | :ref:`get_item_text_direction` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_radio_checkable` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_shortcut_disabled` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_system_menu` **(** **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_item` **(** :ref:`int` index **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`scroll_to_item` **(** :ref:`int` index **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_focused_item` **(** :ref:`int` index **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_accelerator` **(** :ref:`int` index, :ref:`Key` accel **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_as_checkable` **(** :ref:`int` index, :ref:`bool` enable **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_as_radio_checkable` **(** :ref:`int` index, :ref:`bool` enable **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_as_separator` **(** :ref:`int` index, :ref:`bool` enable **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_checked` **(** :ref:`int` index, :ref:`bool` checked **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_disabled` **(** :ref:`int` index, :ref:`bool` disabled **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_icon` **(** :ref:`int` index, :ref:`Texture2D` icon **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_icon_max_width` **(** :ref:`int` index, :ref:`int` width **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_icon_modulate` **(** :ref:`int` index, :ref:`Color` modulate **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_id` **(** :ref:`int` index, :ref:`int` id **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_indent` **(** :ref:`int` index, :ref:`int` indent **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_language` **(** :ref:`int` index, :ref:`String` language **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_metadata` **(** :ref:`int` index, :ref:`Variant` metadata **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_multistate` **(** :ref:`int` index, :ref:`int` state **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_multistate_max` **(** :ref:`int` index, :ref:`int` max_states **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_shortcut` **(** :ref:`int` index, :ref:`Shortcut` shortcut, :ref:`bool` global=false **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_shortcut_disabled` **(** :ref:`int` index, :ref:`bool` disabled **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_submenu` **(** :ref:`int` index, :ref:`String` submenu **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_text` **(** :ref:`int` index, :ref:`String` text **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_text_direction` **(** :ref:`int` index, :ref:`TextDirection` direction **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_tooltip` **(** :ref:`int` index, :ref:`String` tooltip **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`toggle_item_checked` **(** :ref:`int` index **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`toggle_item_multistate` **(** :ref:`int` index **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`activate_item_by_event`\ (\ event\: :ref:`InputEvent`, for_global_only\: :ref:`bool` = false\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_check_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_check_shortcut`\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_check_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_check_shortcut`\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_radio_check_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_radio_check_shortcut`\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_shortcut`\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false, allow_echo\: :ref:`bool` = false\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_multistate_item`\ (\ label\: :ref:`String`, max_states\: :ref:`int`, default_state\: :ref:`int` = 0, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_radio_check_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_radio_check_shortcut`\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_separator`\ (\ label\: :ref:`String` = "", id\: :ref:`int` = -1\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_shortcut`\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false, allow_echo\: :ref:`bool` = false\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_submenu_item`\ (\ label\: :ref:`String`, submenu\: :ref:`String`, id\: :ref:`int` = -1\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_submenu_node_item`\ (\ label\: :ref:`String`, submenu\: :ref:`PopupMenu`, id\: :ref:`int` = -1\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ free_submenus\: :ref:`bool` = false\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_focused_item`\ (\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Key` | :ref:`get_item_accelerator`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_item_icon`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_icon_max_width`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_item_icon_modulate`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_id`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_indent`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_index`\ (\ id\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_language`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_item_metadata`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_multistate`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_multistate_max`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Shortcut` | :ref:`get_item_shortcut`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_submenu`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PopupMenu` | :ref:`get_item_submenu_node`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_text`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`get_item_text_direction`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_tooltip`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_checkable`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_checked`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_disabled`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_radio_checkable`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_separator`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_shortcut_disabled`\ (\ index\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_system_menu`\ (\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_item`\ (\ index\: :ref:`int`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`scroll_to_item`\ (\ index\: :ref:`int`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_focused_item`\ (\ index\: :ref:`int`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_accelerator`\ (\ index\: :ref:`int`, accel\: :ref:`Key`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_as_checkable`\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_as_radio_checkable`\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_as_separator`\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_checked`\ (\ index\: :ref:`int`, checked\: :ref:`bool`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_disabled`\ (\ index\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon`\ (\ index\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon_max_width`\ (\ index\: :ref:`int`, width\: :ref:`int`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon_modulate`\ (\ index\: :ref:`int`, modulate\: :ref:`Color`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_id`\ (\ index\: :ref:`int`, id\: :ref:`int`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_indent`\ (\ index\: :ref:`int`, indent\: :ref:`int`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_language`\ (\ index\: :ref:`int`, language\: :ref:`String`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_metadata`\ (\ index\: :ref:`int`, metadata\: :ref:`Variant`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_multistate`\ (\ index\: :ref:`int`, state\: :ref:`int`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_multistate_max`\ (\ index\: :ref:`int`, max_states\: :ref:`int`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_shortcut`\ (\ index\: :ref:`int`, shortcut\: :ref:`Shortcut`, global\: :ref:`bool` = false\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_shortcut_disabled`\ (\ index\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_submenu`\ (\ index\: :ref:`int`, submenu\: :ref:`String`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_submenu_node`\ (\ index\: :ref:`int`, submenu\: :ref:`PopupMenu`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_text`\ (\ index\: :ref:`int`, text\: :ref:`String`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_text_direction`\ (\ index\: :ref:`int`, direction\: :ref:`TextDirection`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_tooltip`\ (\ index\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`toggle_item_checked`\ (\ index\: :ref:`int`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`toggle_item_multistate`\ (\ index\: :ref:`int`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -286,7 +292,7 @@ Signals .. rst-class:: classref-signal -**id_focused** **(** :ref:`int` id **)** +**id_focused**\ (\ id\: :ref:`int`\ ) Emitted when the user navigated to an item of some ``id`` using the :ref:`ProjectSettings.input/ui_up` or :ref:`ProjectSettings.input/ui_down` input action. @@ -298,7 +304,7 @@ Emitted when the user navigated to an item of some ``id`` using the :ref:`Projec .. rst-class:: classref-signal -**id_pressed** **(** :ref:`int` id **)** +**id_pressed**\ (\ id\: :ref:`int`\ ) Emitted when an item of some ``id`` is pressed or its accelerator is activated. @@ -312,7 +318,7 @@ Emitted when an item of some ``id`` is pressed or its accelerator is activated. .. rst-class:: classref-signal -**index_pressed** **(** :ref:`int` index **)** +**index_pressed**\ (\ index\: :ref:`int`\ ) Emitted when an item of some ``index`` is pressed or its accelerator is activated. @@ -324,7 +330,7 @@ Emitted when an item of some ``index`` is pressed or its accelerator is activate .. rst-class:: classref-signal -**menu_changed** **(** **)** +**menu_changed**\ (\ ) Emitted when any item is added, modified or removed. @@ -345,8 +351,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_allow_search** **(** :ref:`bool` value **)** -- :ref:`bool` **get_allow_search** **(** **)** +- |void| **set_allow_search**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_allow_search**\ (\ ) If ``true``, allows navigating **PopupMenu** with letter keys. @@ -362,8 +368,8 @@ If ``true``, allows navigating **PopupMenu** with letter keys. .. rst-class:: classref-property-setget -- void **set_hide_on_checkable_item_selection** **(** :ref:`bool` value **)** -- :ref:`bool` **is_hide_on_checkable_item_selection** **(** **)** +- |void| **set_hide_on_checkable_item_selection**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_hide_on_checkable_item_selection**\ (\ ) If ``true``, hides the **PopupMenu** when a checkbox or radio button is selected. @@ -379,8 +385,8 @@ If ``true``, hides the **PopupMenu** when a checkbox or radio button is selected .. rst-class:: classref-property-setget -- void **set_hide_on_item_selection** **(** :ref:`bool` value **)** -- :ref:`bool` **is_hide_on_item_selection** **(** **)** +- |void| **set_hide_on_item_selection**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_hide_on_item_selection**\ (\ ) If ``true``, hides the **PopupMenu** when an item is selected. @@ -396,8 +402,8 @@ If ``true``, hides the **PopupMenu** when an item is selected. .. rst-class:: classref-property-setget -- void **set_hide_on_state_item_selection** **(** :ref:`bool` value **)** -- :ref:`bool` **is_hide_on_state_item_selection** **(** **)** +- |void| **set_hide_on_state_item_selection**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_hide_on_state_item_selection**\ (\ ) If ``true``, hides the **PopupMenu** when a state item is selected. @@ -413,8 +419,8 @@ If ``true``, hides the **PopupMenu** when a state item is selected. .. rst-class:: classref-property-setget -- void **set_item_count** **(** :ref:`int` value **)** -- :ref:`int` **get_item_count** **(** **)** +- |void| **set_item_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_item_count**\ (\ ) The number of items currently in the list. @@ -430,8 +436,8 @@ The number of items currently in the list. .. rst-class:: classref-property-setget -- void **set_submenu_popup_delay** **(** :ref:`float` value **)** -- :ref:`float` **get_submenu_popup_delay** **(** **)** +- |void| **set_submenu_popup_delay**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_submenu_popup_delay**\ (\ ) Sets the delay time in seconds for the submenu item to popup on mouse hovering. If the popup menu is added as a child of another (acting as a submenu), it will inherit the delay time of the parent menu item. @@ -447,8 +453,8 @@ Sets the delay time in seconds for the submenu item to popup on mouse hovering. .. rst-class:: classref-property-setget -- void **set_system_menu_root** **(** :ref:`String` value **)** -- :ref:`String` **get_system_menu_root** **(** **)** +- |void| **set_system_menu_root**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_system_menu_root**\ (\ ) If set to one of the values returned by :ref:`DisplayServer.global_menu_get_system_menu_roots`, this **PopupMenu** is bound to the special system menu. Only one **PopupMenu** can be bound to each special menu at a time. @@ -465,7 +471,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **activate_item_by_event** **(** :ref:`InputEvent` event, :ref:`bool` for_global_only=false **)** +:ref:`bool` **activate_item_by_event**\ (\ event\: :ref:`InputEvent`, for_global_only\: :ref:`bool` = false\ ) Checks the provided ``event`` against the **PopupMenu**'s shortcuts and accelerators, and activates the first item with matching events. If ``for_global_only`` is ``true``, only shortcuts and accelerators with ``global`` set to ``true`` will be called. @@ -481,7 +487,7 @@ Returns ``true`` if an item was successfully activated. .. rst-class:: classref-method -void **add_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** +|void| **add_check_item**\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) Adds a new checkable item with text ``label``. @@ -497,7 +503,7 @@ An ``id`` can optionally be provided, as well as an accelerator (``accel``). If .. rst-class:: classref-method -void **add_check_shortcut** **(** :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +|void| **add_check_shortcut**\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) Adds a new checkable item and assigns the specified :ref:`Shortcut` to it. Sets the label of the checkbox to the :ref:`Shortcut`'s name. @@ -513,7 +519,7 @@ An ``id`` can optionally be provided. If no ``id`` is provided, one will be crea .. rst-class:: classref-method -void **add_icon_check_item** **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** +|void| **add_icon_check_item**\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) Adds a new checkable item with text ``label`` and icon ``texture``. @@ -529,7 +535,7 @@ An ``id`` can optionally be provided, as well as an accelerator (``accel``). If .. rst-class:: classref-method -void **add_icon_check_shortcut** **(** :ref:`Texture2D` texture, :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +|void| **add_icon_check_shortcut**\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) Adds a new checkable item and assigns the specified :ref:`Shortcut` and icon ``texture`` to it. Sets the label of the checkbox to the :ref:`Shortcut`'s name. @@ -545,7 +551,7 @@ An ``id`` can optionally be provided. If no ``id`` is provided, one will be crea .. rst-class:: classref-method -void **add_icon_item** **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** +|void| **add_icon_item**\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) Adds a new item with text ``label`` and icon ``texture``. @@ -559,7 +565,7 @@ An ``id`` can optionally be provided, as well as an accelerator (``accel``). If .. rst-class:: classref-method -void **add_icon_radio_check_item** **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** +|void| **add_icon_radio_check_item**\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) Same as :ref:`add_icon_check_item`, but uses a radio check button. @@ -571,7 +577,7 @@ Same as :ref:`add_icon_check_item`, .. rst-class:: classref-method -void **add_icon_radio_check_shortcut** **(** :ref:`Texture2D` texture, :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +|void| **add_icon_radio_check_shortcut**\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) Same as :ref:`add_icon_check_shortcut`, but uses a radio check button. @@ -583,7 +589,7 @@ Same as :ref:`add_icon_check_shortcut` texture, :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false, :ref:`bool` allow_echo=false **)** +|void| **add_icon_shortcut**\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false, allow_echo\: :ref:`bool` = false\ ) Adds a new item and assigns the specified :ref:`Shortcut` and icon ``texture`` to it. Sets the label of the checkbox to the :ref:`Shortcut`'s name. @@ -599,7 +605,7 @@ If ``allow_echo`` is ``true``, the shortcut can be activated with echo events. .. rst-class:: classref-method -void **add_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** +|void| **add_item**\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) Adds a new item with text ``label``. @@ -615,7 +621,7 @@ An ``id`` can optionally be provided, as well as an accelerator (``accel``). If .. rst-class:: classref-method -void **add_multistate_item** **(** :ref:`String` label, :ref:`int` max_states, :ref:`int` default_state=0, :ref:`int` id=-1, :ref:`Key` accel=0 **)** +|void| **add_multistate_item**\ (\ label\: :ref:`String`, max_states\: :ref:`int`, default_state\: :ref:`int` = 0, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) Adds a new multistate item with text ``label``. @@ -651,7 +657,7 @@ Example usage: .. rst-class:: classref-method -void **add_radio_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** +|void| **add_radio_check_item**\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) Adds a new radio check button with text ``label``. @@ -667,7 +673,7 @@ An ``id`` can optionally be provided, as well as an accelerator (``accel``). If .. rst-class:: classref-method -void **add_radio_check_shortcut** **(** :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +|void| **add_radio_check_shortcut**\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) Adds a new radio check button and assigns a :ref:`Shortcut` to it. Sets the label of the checkbox to the :ref:`Shortcut`'s name. @@ -683,7 +689,7 @@ An ``id`` can optionally be provided. If no ``id`` is provided, one will be crea .. rst-class:: classref-method -void **add_separator** **(** :ref:`String` label="", :ref:`int` id=-1 **)** +|void| **add_separator**\ (\ label\: :ref:`String` = "", id\: :ref:`int` = -1\ ) Adds a separator between items. Separators also occupy an index, which you can set by using the ``id`` parameter. @@ -697,7 +703,7 @@ A ``label`` can optionally be provided, which will appear at the center of the s .. rst-class:: classref-method -void **add_shortcut** **(** :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false, :ref:`bool` allow_echo=false **)** +|void| **add_shortcut**\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false, allow_echo\: :ref:`bool` = false\ ) Adds a :ref:`Shortcut`. @@ -713,7 +719,9 @@ If ``allow_echo`` is ``true``, the shortcut can be activated with echo events. .. rst-class:: classref-method -void **add_submenu_item** **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** +|void| **add_submenu_item**\ (\ label\: :ref:`String`, submenu\: :ref:`String`, id\: :ref:`int` = -1\ ) + +**Deprecated:** Prefer using :ref:`add_submenu_node_item` instead. Adds an item that will act as a submenu of the parent **PopupMenu** node when clicked. The ``submenu`` argument must be the name of an existing **PopupMenu** that has been added as a child to this node. This submenu will be shown when the item is clicked, hovered for long enough, or activated using the ``ui_select`` or ``ui_right`` input actions. @@ -723,11 +731,27 @@ An ``id`` can optionally be provided. If no ``id`` is provided, one will be crea ---- +.. _class_PopupMenu_method_add_submenu_node_item: + +.. rst-class:: classref-method + +|void| **add_submenu_node_item**\ (\ label\: :ref:`String`, submenu\: :ref:`PopupMenu`, id\: :ref:`int` = -1\ ) + +Adds an item that will act as a submenu of the parent **PopupMenu** node when clicked. This submenu will be shown when the item is clicked, hovered for long enough, or activated using the ``ui_select`` or ``ui_right`` input actions. + +\ ``submenu`` must be either child of this **PopupMenu** or has no parent node (in which case it will be automatically added as a child). If the ``submenu`` popup has another parent, this method will fail. + +An ``id`` can optionally be provided. If no ``id`` is provided, one will be created from the index. + +.. rst-class:: classref-item-separator + +---- + .. _class_PopupMenu_method_clear: .. rst-class:: classref-method -void **clear** **(** :ref:`bool` free_submenus=false **)** +|void| **clear**\ (\ free_submenus\: :ref:`bool` = false\ ) Removes all items from the **PopupMenu**. If ``free_submenus`` is ``true``, the submenu nodes are automatically freed. @@ -739,7 +763,7 @@ Removes all items from the **PopupMenu**. If ``free_submenus`` is ``true``, the .. rst-class:: classref-method -:ref:`int` **get_focused_item** **(** **)** |const| +:ref:`int` **get_focused_item**\ (\ ) |const| Returns the index of the currently focused item. Returns ``-1`` if no item is focused. @@ -751,7 +775,7 @@ Returns the index of the currently focused item. Returns ``-1`` if no item is fo .. rst-class:: classref-method -:ref:`Key` **get_item_accelerator** **(** :ref:`int` index **)** |const| +:ref:`Key` **get_item_accelerator**\ (\ index\: :ref:`int`\ ) |const| Returns the accelerator of the item at the given ``index``. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The return value is an integer which is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). If no accelerator is defined for the specified ``index``, :ref:`get_item_accelerator` returns ``0`` (corresponding to :ref:`@GlobalScope.KEY_NONE`). @@ -763,7 +787,7 @@ Returns the accelerator of the item at the given ``index``. An accelerator is a .. rst-class:: classref-method -:ref:`Texture2D` **get_item_icon** **(** :ref:`int` index **)** |const| +:ref:`Texture2D` **get_item_icon**\ (\ index\: :ref:`int`\ ) |const| Returns the icon of the item at the given ``index``. @@ -775,7 +799,7 @@ Returns the icon of the item at the given ``index``. .. rst-class:: classref-method -:ref:`int` **get_item_icon_max_width** **(** :ref:`int` index **)** |const| +:ref:`int` **get_item_icon_max_width**\ (\ index\: :ref:`int`\ ) |const| Returns the maximum allowed width of the icon for the item at the given ``index``. @@ -787,7 +811,7 @@ Returns the maximum allowed width of the icon for the item at the given ``index` .. rst-class:: classref-method -:ref:`Color` **get_item_icon_modulate** **(** :ref:`int` index **)** |const| +:ref:`Color` **get_item_icon_modulate**\ (\ index\: :ref:`int`\ ) |const| Returns a :ref:`Color` modulating the item's icon at the given ``index``. @@ -799,7 +823,7 @@ Returns a :ref:`Color` modulating the item's icon at the given ``in .. rst-class:: classref-method -:ref:`int` **get_item_id** **(** :ref:`int` index **)** |const| +:ref:`int` **get_item_id**\ (\ index\: :ref:`int`\ ) |const| Returns the ID of the item at the given ``index``. ``id`` can be manually assigned, while index can not. @@ -811,7 +835,7 @@ Returns the ID of the item at the given ``index``. ``id`` can be manually assign .. rst-class:: classref-method -:ref:`int` **get_item_indent** **(** :ref:`int` index **)** |const| +:ref:`int` **get_item_indent**\ (\ index\: :ref:`int`\ ) |const| Returns the horizontal offset of the item at the given ``index``. @@ -823,7 +847,7 @@ Returns the horizontal offset of the item at the given ``index``. .. rst-class:: classref-method -:ref:`int` **get_item_index** **(** :ref:`int` id **)** |const| +:ref:`int` **get_item_index**\ (\ id\: :ref:`int`\ ) |const| Returns the index of the item containing the specified ``id``. Index is automatically assigned to each item by the engine and can not be set manually. @@ -835,7 +859,7 @@ Returns the index of the item containing the specified ``id``. Index is automati .. rst-class:: classref-method -:ref:`String` **get_item_language** **(** :ref:`int` index **)** |const| +:ref:`String` **get_item_language**\ (\ index\: :ref:`int`\ ) |const| Returns item's text language code. @@ -847,7 +871,7 @@ Returns item's text language code. .. rst-class:: classref-method -:ref:`Variant` **get_item_metadata** **(** :ref:`int` index **)** |const| +:ref:`Variant` **get_item_metadata**\ (\ index\: :ref:`int`\ ) |const| Returns the metadata of the specified item, which might be of any type. You can set it with :ref:`set_item_metadata`, which provides a simple way of assigning context data to items. @@ -859,7 +883,7 @@ Returns the metadata of the specified item, which might be of any type. You can .. rst-class:: classref-method -:ref:`int` **get_item_multistate** **(** :ref:`int` index **)** |const| +:ref:`int` **get_item_multistate**\ (\ index\: :ref:`int`\ ) |const| Returns the state of the item at the given ``index``. @@ -871,7 +895,7 @@ Returns the state of the item at the given ``index``. .. rst-class:: classref-method -:ref:`int` **get_item_multistate_max** **(** :ref:`int` index **)** |const| +:ref:`int` **get_item_multistate_max**\ (\ index\: :ref:`int`\ ) |const| Returns the max states of the item at the given ``index``. @@ -883,7 +907,7 @@ Returns the max states of the item at the given ``index``. .. rst-class:: classref-method -:ref:`Shortcut` **get_item_shortcut** **(** :ref:`int` index **)** |const| +:ref:`Shortcut` **get_item_shortcut**\ (\ index\: :ref:`int`\ ) |const| Returns the :ref:`Shortcut` associated with the item at the given ``index``. @@ -895,7 +919,9 @@ Returns the :ref:`Shortcut` associated with the item at the give .. rst-class:: classref-method -:ref:`String` **get_item_submenu** **(** :ref:`int` index **)** |const| +:ref:`String` **get_item_submenu**\ (\ index\: :ref:`int`\ ) |const| + +**Deprecated:** Prefer using :ref:`get_item_submenu_node` instead. Returns the submenu name of the item at the given ``index``. See :ref:`add_submenu_item` for more info on how to add a submenu. @@ -903,11 +929,23 @@ Returns the submenu name of the item at the given ``index``. See :ref:`add_subme ---- +.. _class_PopupMenu_method_get_item_submenu_node: + +.. rst-class:: classref-method + +:ref:`PopupMenu` **get_item_submenu_node**\ (\ index\: :ref:`int`\ ) |const| + +Returns the submenu of the item at the given ``index``, or ``null`` if no submenu was added. See :ref:`add_submenu_node_item` for more info on how to add a submenu. + +.. rst-class:: classref-item-separator + +---- + .. _class_PopupMenu_method_get_item_text: .. rst-class:: classref-method -:ref:`String` **get_item_text** **(** :ref:`int` index **)** |const| +:ref:`String` **get_item_text**\ (\ index\: :ref:`int`\ ) |const| Returns the text of the item at the given ``index``. @@ -919,7 +957,7 @@ Returns the text of the item at the given ``index``. .. rst-class:: classref-method -:ref:`TextDirection` **get_item_text_direction** **(** :ref:`int` index **)** |const| +:ref:`TextDirection` **get_item_text_direction**\ (\ index\: :ref:`int`\ ) |const| Returns item's text base writing direction. @@ -931,7 +969,7 @@ Returns item's text base writing direction. .. rst-class:: classref-method -:ref:`String` **get_item_tooltip** **(** :ref:`int` index **)** |const| +:ref:`String` **get_item_tooltip**\ (\ index\: :ref:`int`\ ) |const| Returns the tooltip associated with the item at the given ``index``. @@ -943,7 +981,7 @@ Returns the tooltip associated with the item at the given ``index``. .. rst-class:: classref-method -:ref:`bool` **is_item_checkable** **(** :ref:`int` index **)** |const| +:ref:`bool` **is_item_checkable**\ (\ index\: :ref:`int`\ ) |const| Returns ``true`` if the item at the given ``index`` is checkable in some way, i.e. if it has a checkbox or radio button. @@ -957,7 +995,7 @@ Returns ``true`` if the item at the given ``index`` is checkable in some way, i. .. rst-class:: classref-method -:ref:`bool` **is_item_checked** **(** :ref:`int` index **)** |const| +:ref:`bool` **is_item_checked**\ (\ index\: :ref:`int`\ ) |const| Returns ``true`` if the item at the given ``index`` is checked. @@ -969,7 +1007,7 @@ Returns ``true`` if the item at the given ``index`` is checked. .. rst-class:: classref-method -:ref:`bool` **is_item_disabled** **(** :ref:`int` index **)** |const| +:ref:`bool` **is_item_disabled**\ (\ index\: :ref:`int`\ ) |const| Returns ``true`` if the item at the given ``index`` is disabled. When it is disabled it can't be selected, or its action invoked. @@ -983,7 +1021,7 @@ See :ref:`set_item_disabled` for more .. rst-class:: classref-method -:ref:`bool` **is_item_radio_checkable** **(** :ref:`int` index **)** |const| +:ref:`bool` **is_item_radio_checkable**\ (\ index\: :ref:`int`\ ) |const| Returns ``true`` if the item at the given ``index`` has radio button-style checkability. @@ -997,7 +1035,7 @@ Returns ``true`` if the item at the given ``index`` has radio button-style check .. rst-class:: classref-method -:ref:`bool` **is_item_separator** **(** :ref:`int` index **)** |const| +:ref:`bool` **is_item_separator**\ (\ index\: :ref:`int`\ ) |const| Returns ``true`` if the item is a separator. If it is, it will be displayed as a line. See :ref:`add_separator` for more info on how to add a separator. @@ -1009,7 +1047,7 @@ Returns ``true`` if the item is a separator. If it is, it will be displayed as a .. rst-class:: classref-method -:ref:`bool` **is_item_shortcut_disabled** **(** :ref:`int` index **)** |const| +:ref:`bool` **is_item_shortcut_disabled**\ (\ index\: :ref:`int`\ ) |const| Returns ``true`` if the specified item's shortcut is disabled. @@ -1021,7 +1059,7 @@ Returns ``true`` if the specified item's shortcut is disabled. .. rst-class:: classref-method -:ref:`bool` **is_system_menu** **(** **)** |const| +:ref:`bool` **is_system_menu**\ (\ ) |const| Returns ``true`` if the menu is bound to the special system menu. @@ -1033,7 +1071,7 @@ Returns ``true`` if the menu is bound to the special system menu. .. rst-class:: classref-method -void **remove_item** **(** :ref:`int` index **)** +|void| **remove_item**\ (\ index\: :ref:`int`\ ) Removes the item at the given ``index`` from the menu. @@ -1047,7 +1085,7 @@ Removes the item at the given ``index`` from the menu. .. rst-class:: classref-method -void **scroll_to_item** **(** :ref:`int` index **)** +|void| **scroll_to_item**\ (\ index\: :ref:`int`\ ) Moves the scroll view to make the item at the given ``index`` visible. @@ -1059,7 +1097,7 @@ Moves the scroll view to make the item at the given ``index`` visible. .. rst-class:: classref-method -void **set_focused_item** **(** :ref:`int` index **)** +|void| **set_focused_item**\ (\ index\: :ref:`int`\ ) Sets the currently focused item as the given ``index``. @@ -1073,7 +1111,7 @@ Passing ``-1`` as the index makes so that no item is focused. .. rst-class:: classref-method -void **set_item_accelerator** **(** :ref:`int` index, :ref:`Key` accel **)** +|void| **set_item_accelerator**\ (\ index\: :ref:`int`, accel\: :ref:`Key`\ ) Sets the accelerator of the item at the given ``index``. An accelerator is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. ``accel`` is generally a combination of :ref:`KeyModifierMask`\ s and :ref:`Key`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`). @@ -1085,7 +1123,7 @@ Sets the accelerator of the item at the given ``index``. An accelerator is a key .. rst-class:: classref-method -void **set_item_as_checkable** **(** :ref:`int` index, :ref:`bool` enable **)** +|void| **set_item_as_checkable**\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) Sets whether the item at the given ``index`` has a checkbox. If ``false``, sets the type of the item to plain text. @@ -1099,7 +1137,7 @@ Sets whether the item at the given ``index`` has a checkbox. If ``false``, sets .. rst-class:: classref-method -void **set_item_as_radio_checkable** **(** :ref:`int` index, :ref:`bool` enable **)** +|void| **set_item_as_radio_checkable**\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) Sets the type of the item at the given ``index`` to radio button. If ``false``, sets the type of the item to plain text. @@ -1111,7 +1149,7 @@ Sets the type of the item at the given ``index`` to radio button. If ``false``, .. rst-class:: classref-method -void **set_item_as_separator** **(** :ref:`int` index, :ref:`bool` enable **)** +|void| **set_item_as_separator**\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) Mark the item at the given ``index`` as a separator, which means that it would be displayed as a line. If ``false``, sets the type of the item to plain text. @@ -1123,7 +1161,7 @@ Mark the item at the given ``index`` as a separator, which means that it would b .. rst-class:: classref-method -void **set_item_checked** **(** :ref:`int` index, :ref:`bool` checked **)** +|void| **set_item_checked**\ (\ index\: :ref:`int`, checked\: :ref:`bool`\ ) Sets the checkstate status of the item at the given ``index``. @@ -1135,7 +1173,7 @@ Sets the checkstate status of the item at the given ``index``. .. rst-class:: classref-method -void **set_item_disabled** **(** :ref:`int` index, :ref:`bool` disabled **)** +|void| **set_item_disabled**\ (\ index\: :ref:`int`, disabled\: :ref:`bool`\ ) Enables/disables the item at the given ``index``. When it is disabled, it can't be selected and its action can't be invoked. @@ -1147,7 +1185,7 @@ Enables/disables the item at the given ``index``. When it is disabled, it can't .. rst-class:: classref-method -void **set_item_icon** **(** :ref:`int` index, :ref:`Texture2D` icon **)** +|void| **set_item_icon**\ (\ index\: :ref:`int`, icon\: :ref:`Texture2D`\ ) Replaces the :ref:`Texture2D` icon of the item at the given ``index``. @@ -1159,7 +1197,7 @@ Replaces the :ref:`Texture2D` icon of the item at the given ``i .. rst-class:: classref-method -void **set_item_icon_max_width** **(** :ref:`int` index, :ref:`int` width **)** +|void| **set_item_icon_max_width**\ (\ index\: :ref:`int`, width\: :ref:`int`\ ) Sets the maximum allowed width of the icon for the item at the given ``index``. This limit is applied on top of the default size of the icon and on top of :ref:`icon_max_width`. The height is adjusted according to the icon's ratio. @@ -1171,7 +1209,7 @@ Sets the maximum allowed width of the icon for the item at the given ``index``. .. rst-class:: classref-method -void **set_item_icon_modulate** **(** :ref:`int` index, :ref:`Color` modulate **)** +|void| **set_item_icon_modulate**\ (\ index\: :ref:`int`, modulate\: :ref:`Color`\ ) Sets a modulating :ref:`Color` of the item's icon at the given ``index``. @@ -1183,7 +1221,7 @@ Sets a modulating :ref:`Color` of the item's icon at the given ``in .. rst-class:: classref-method -void **set_item_id** **(** :ref:`int` index, :ref:`int` id **)** +|void| **set_item_id**\ (\ index\: :ref:`int`, id\: :ref:`int`\ ) Sets the ``id`` of the item at the given ``index``. @@ -1197,7 +1235,7 @@ The ``id`` is used in :ref:`id_pressed` and : .. rst-class:: classref-method -void **set_item_indent** **(** :ref:`int` index, :ref:`int` indent **)** +|void| **set_item_indent**\ (\ index\: :ref:`int`, indent\: :ref:`int`\ ) Sets the horizontal offset of the item at the given ``index``. @@ -1209,7 +1247,7 @@ Sets the horizontal offset of the item at the given ``index``. .. rst-class:: classref-method -void **set_item_language** **(** :ref:`int` index, :ref:`String` language **)** +|void| **set_item_language**\ (\ index\: :ref:`int`, language\: :ref:`String`\ ) Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -1221,7 +1259,7 @@ Sets language code of item's text used for line-breaking and text shaping algori .. rst-class:: classref-method -void **set_item_metadata** **(** :ref:`int` index, :ref:`Variant` metadata **)** +|void| **set_item_metadata**\ (\ index\: :ref:`int`, metadata\: :ref:`Variant`\ ) Sets the metadata of an item, which may be of any type. You can later get it with :ref:`get_item_metadata`, which provides a simple way of assigning context data to items. @@ -1233,7 +1271,7 @@ Sets the metadata of an item, which may be of any type. You can later get it wit .. rst-class:: classref-method -void **set_item_multistate** **(** :ref:`int` index, :ref:`int` state **)** +|void| **set_item_multistate**\ (\ index\: :ref:`int`, state\: :ref:`int`\ ) Sets the state of a multistate item. See :ref:`add_multistate_item` for details. @@ -1245,7 +1283,7 @@ Sets the state of a multistate item. See :ref:`add_multistate_item` index, :ref:`int` max_states **)** +|void| **set_item_multistate_max**\ (\ index\: :ref:`int`, max_states\: :ref:`int`\ ) Sets the max states of a multistate item. See :ref:`add_multistate_item` for details. @@ -1257,7 +1295,7 @@ Sets the max states of a multistate item. See :ref:`add_multistate_item` index, :ref:`Shortcut` shortcut, :ref:`bool` global=false **)** +|void| **set_item_shortcut**\ (\ index\: :ref:`int`, shortcut\: :ref:`Shortcut`, global\: :ref:`bool` = false\ ) Sets a :ref:`Shortcut` for the item at the given ``index``. @@ -1269,7 +1307,7 @@ Sets a :ref:`Shortcut` for the item at the given ``index``. .. rst-class:: classref-method -void **set_item_shortcut_disabled** **(** :ref:`int` index, :ref:`bool` disabled **)** +|void| **set_item_shortcut_disabled**\ (\ index\: :ref:`int`, disabled\: :ref:`bool`\ ) Disables the :ref:`Shortcut` of the item at the given ``index``. @@ -1281,7 +1319,9 @@ Disables the :ref:`Shortcut` of the item at the given ``index``. .. rst-class:: classref-method -void **set_item_submenu** **(** :ref:`int` index, :ref:`String` submenu **)** +|void| **set_item_submenu**\ (\ index\: :ref:`int`, submenu\: :ref:`String`\ ) + +**Deprecated:** Prefer using :ref:`set_item_submenu_node` instead. Sets the submenu of the item at the given ``index``. The submenu is the name of a child **PopupMenu** node that would be shown when the item is clicked. @@ -1289,11 +1329,23 @@ Sets the submenu of the item at the given ``index``. The submenu is the name of ---- +.. _class_PopupMenu_method_set_item_submenu_node: + +.. rst-class:: classref-method + +|void| **set_item_submenu_node**\ (\ index\: :ref:`int`, submenu\: :ref:`PopupMenu`\ ) + +Sets the submenu of the item at the given ``index``. The submenu is a **PopupMenu** node that would be shown when the item is clicked. It must either be a child of this **PopupMenu** or has no parent (in which case it will be automatically added as a child). If the ``submenu`` popup has another parent, this method will fail. + +.. rst-class:: classref-item-separator + +---- + .. _class_PopupMenu_method_set_item_text: .. rst-class:: classref-method -void **set_item_text** **(** :ref:`int` index, :ref:`String` text **)** +|void| **set_item_text**\ (\ index\: :ref:`int`, text\: :ref:`String`\ ) Sets the text of the item at the given ``index``. @@ -1305,7 +1357,7 @@ Sets the text of the item at the given ``index``. .. rst-class:: classref-method -void **set_item_text_direction** **(** :ref:`int` index, :ref:`TextDirection` direction **)** +|void| **set_item_text_direction**\ (\ index\: :ref:`int`, direction\: :ref:`TextDirection`\ ) Sets item's text base writing direction. @@ -1317,7 +1369,7 @@ Sets item's text base writing direction. .. rst-class:: classref-method -void **set_item_tooltip** **(** :ref:`int` index, :ref:`String` tooltip **)** +|void| **set_item_tooltip**\ (\ index\: :ref:`int`, tooltip\: :ref:`String`\ ) Sets the :ref:`String` tooltip of the item at the given ``index``. @@ -1329,7 +1381,7 @@ Sets the :ref:`String` tooltip of the item at the given ``index``. .. rst-class:: classref-method -void **toggle_item_checked** **(** :ref:`int` index **)** +|void| **toggle_item_checked**\ (\ index\: :ref:`int`\ ) Toggles the check state of the item at the given ``index``. @@ -1341,7 +1393,7 @@ Toggles the check state of the item at the given ``index``. .. rst-class:: classref-method -void **toggle_item_multistate** **(** :ref:`int` index **)** +|void| **toggle_item_multistate**\ (\ index\: :ref:`int`\ ) Cycle to the next state of a multistate item. See :ref:`add_multistate_item` for details. @@ -1755,3 +1807,4 @@ Font size of the menu items. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_popuppanel.rst b/classes/class_popuppanel.rst index 3e413c1a912..e1a16b3a10e 100644 --- a/classes/class_popuppanel.rst +++ b/classes/class_popuppanel.rst @@ -28,3 +28,4 @@ A popup with a configurable panel background. Any child controls added to this n .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_portablecompressedtexture2d.rst b/classes/class_portablecompressedtexture2d.rst index 56ebb6837c9..a1f84cd830a 100644 --- a/classes/class_portablecompressedtexture2d.rst +++ b/classes/class_portablecompressedtexture2d.rst @@ -55,17 +55,17 @@ Methods .. table:: :widths: auto - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_from_image` **(** :ref:`Image` image, :ref:`CompressionMode` compression_mode, :ref:`bool` normal_map=false, :ref:`float` lossy_quality=0.8 **)** | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`CompressionMode` | :ref:`get_compression_mode` **(** **)** |const| | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Format` | :ref:`get_format` **(** **)** |const| | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_keeping_all_compressed_buffers` **(** **)** |static| | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_keep_all_compressed_buffers` **(** :ref:`bool` keep **)** |static| | - +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_from_image`\ (\ image\: :ref:`Image`, compression_mode\: :ref:`CompressionMode`, normal_map\: :ref:`bool` = false, lossy_quality\: :ref:`float` = 0.8\ ) | + +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CompressionMode` | :ref:`get_compression_mode`\ (\ ) |const| | + +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Format` | :ref:`get_format`\ (\ ) |const| | + +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_keeping_all_compressed_buffers`\ (\ ) |static| | + +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_keep_all_compressed_buffers`\ (\ keep\: :ref:`bool`\ ) |static| | + +--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -185,8 +185,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_keep_compressed_buffer** **(** :ref:`bool` value **)** -- :ref:`bool` **is_keeping_compressed_buffer** **(** **)** +- |void| **set_keep_compressed_buffer**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_keeping_compressed_buffer**\ (\ ) When running on the editor, this class will keep the source compressed data in memory. Otherwise, the source compressed data is lost after loading and the resource can't be re saved. @@ -204,8 +204,8 @@ This flag allows to keep the compressed data in memory if you intend it to persi .. rst-class:: classref-property-setget -- void **set_size_override** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_size_override** **(** **)** +- |void| **set_size_override**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_size_override**\ (\ ) Allow overriding the texture size (for 2D only). @@ -222,7 +222,7 @@ Method Descriptions .. rst-class:: classref-method -void **create_from_image** **(** :ref:`Image` image, :ref:`CompressionMode` compression_mode, :ref:`bool` normal_map=false, :ref:`float` lossy_quality=0.8 **)** +|void| **create_from_image**\ (\ image\: :ref:`Image`, compression_mode\: :ref:`CompressionMode`, normal_map\: :ref:`bool` = false, lossy_quality\: :ref:`float` = 0.8\ ) Initializes the compressed texture from a base image. The compression mode must be provided. @@ -238,7 +238,7 @@ If lossy compression is requested, the quality setting can optionally be provide .. rst-class:: classref-method -:ref:`CompressionMode` **get_compression_mode** **(** **)** |const| +:ref:`CompressionMode` **get_compression_mode**\ (\ ) |const| Return the compression mode used (valid after initialized). @@ -250,7 +250,7 @@ Return the compression mode used (valid after initialized). .. rst-class:: classref-method -:ref:`Format` **get_format** **(** **)** |const| +:ref:`Format` **get_format**\ (\ ) |const| Return the image format used (valid after initialized). @@ -262,7 +262,7 @@ Return the image format used (valid after initialized). .. rst-class:: classref-method -:ref:`bool` **is_keeping_all_compressed_buffers** **(** **)** |static| +:ref:`bool` **is_keeping_all_compressed_buffers**\ (\ ) |static| Return whether the flag is overridden for all textures of this type. @@ -274,7 +274,7 @@ Return whether the flag is overridden for all textures of this type. .. rst-class:: classref-method -void **set_keep_all_compressed_buffers** **(** :ref:`bool` keep **)** |static| +|void| **set_keep_all_compressed_buffers**\ (\ keep\: :ref:`bool`\ ) |static| Overrides the flag globally for all textures of this type. This is used primarily by the editor. @@ -285,3 +285,4 @@ Overrides the flag globally for all textures of this type. This is used primaril .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index 3dca52cb76b..8e376a1e82e 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -51,11 +51,11 @@ Methods .. table:: :widths: auto - +---------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`_create_mesh_array` **(** **)** |virtual| |const| | - +---------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_mesh_arrays` **(** **)** |const| | - +---------------------------+----------------------------------------------------------------------------------------------------------------+ + +---------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`_create_mesh_array`\ (\ ) |virtual| |const| | + +---------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_mesh_arrays`\ (\ ) |const| | + +---------------------------+----------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -74,8 +74,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_add_uv2** **(** :ref:`bool` value **)** -- :ref:`bool` **get_add_uv2** **(** **)** +- |void| **set_add_uv2**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_add_uv2**\ (\ ) If set, generates UV2 UV coordinates applying a padding using the :ref:`uv2_padding` setting. UV2 is needed for lightmapping. @@ -91,8 +91,8 @@ If set, generates UV2 UV coordinates applying a padding using the :ref:`uv2_padd .. rst-class:: classref-property-setget -- void **set_custom_aabb** **(** :ref:`AABB` value **)** -- :ref:`AABB` **get_custom_aabb** **(** **)** +- |void| **set_custom_aabb**\ (\ value\: :ref:`AABB`\ ) +- :ref:`AABB` **get_custom_aabb**\ (\ ) Overrides the :ref:`AABB` with one defined by user for use with frustum culling. Especially useful to avoid unexpected culling when using a shader to offset vertices. @@ -108,8 +108,8 @@ Overrides the :ref:`AABB` with one defined by user for use with frus .. rst-class:: classref-property-setget -- void **set_flip_faces** **(** :ref:`bool` value **)** -- :ref:`bool` **get_flip_faces** **(** **)** +- |void| **set_flip_faces**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_flip_faces**\ (\ ) If set, the order of the vertices in each triangle are reversed resulting in the backside of the mesh being drawn. @@ -127,8 +127,8 @@ This gives the same result as using :ref:`BaseMaterial3D.CULL_FRONT` value **)** -- :ref:`Material` **get_material** **(** **)** +- |void| **set_material**\ (\ value\: :ref:`Material`\ ) +- :ref:`Material` **get_material**\ (\ ) The current :ref:`Material` of the primitive mesh. @@ -144,8 +144,8 @@ The current :ref:`Material` of the primitive mesh. .. rst-class:: classref-property-setget -- void **set_uv2_padding** **(** :ref:`float` value **)** -- :ref:`float` **get_uv2_padding** **(** **)** +- |void| **set_uv2_padding**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_uv2_padding**\ (\ ) If :ref:`add_uv2` is set, specifies the padding in pixels applied along seams of the mesh. Lower padding values allow making better use of the lightmap texture (resulting in higher texel density), but may introduce visible lightmap bleeding along edges. @@ -164,7 +164,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array` **_create_mesh_array** **(** **)** |virtual| |const| +:ref:`Array` **_create_mesh_array**\ (\ ) |virtual| |const| Override this method to customize how this primitive mesh should be generated. Should return an :ref:`Array` where each element is another Array of values required for the mesh (see the :ref:`ArrayType` constants). @@ -176,7 +176,7 @@ Override this method to customize how this primitive mesh should be generated. S .. rst-class:: classref-method -:ref:`Array` **get_mesh_arrays** **(** **)** |const| +:ref:`Array` **get_mesh_arrays**\ (\ ) |const| Returns mesh arrays used to constitute surface of :ref:`Mesh`. The result can be passed to :ref:`ArrayMesh.add_surface_from_arrays` to create a new surface. For example: @@ -204,3 +204,4 @@ Returns mesh arrays used to constitute surface of :ref:`Mesh`. The r .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst index c1a8f2f276a..b60f1c21613 100644 --- a/classes/class_prismmesh.rst +++ b/classes/class_prismmesh.rst @@ -58,8 +58,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_left_to_right** **(** :ref:`float` value **)** -- :ref:`float` **get_left_to_right** **(** **)** +- |void| **set_left_to_right**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_left_to_right**\ (\ ) Displacement of the upper edge along the X axis. 0.0 positions edge straight above the bottom-left edge. @@ -75,8 +75,8 @@ Displacement of the upper edge along the X axis. 0.0 positions edge straight abo .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_size**\ (\ ) Size of the prism. @@ -92,8 +92,8 @@ Size of the prism. .. rst-class:: classref-property-setget -- void **set_subdivide_depth** **(** :ref:`int` value **)** -- :ref:`int` **get_subdivide_depth** **(** **)** +- |void| **set_subdivide_depth**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_subdivide_depth**\ (\ ) Number of added edge loops along the Z axis. @@ -109,8 +109,8 @@ Number of added edge loops along the Z axis. .. rst-class:: classref-property-setget -- void **set_subdivide_height** **(** :ref:`int` value **)** -- :ref:`int` **get_subdivide_height** **(** **)** +- |void| **set_subdivide_height**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_subdivide_height**\ (\ ) Number of added edge loops along the Y axis. @@ -126,8 +126,8 @@ Number of added edge loops along the Y axis. .. rst-class:: classref-property-setget -- void **set_subdivide_width** **(** :ref:`int` value **)** -- :ref:`int` **get_subdivide_width** **(** **)** +- |void| **set_subdivide_width**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_subdivide_width**\ (\ ) Number of added edge loops along the X axis. @@ -138,3 +138,4 @@ Number of added edge loops along the X axis. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_proceduralskymaterial.rst b/classes/class_proceduralskymaterial.rst index a3f8db4b9d6..1c61e842d84 100644 --- a/classes/class_proceduralskymaterial.rst +++ b/classes/class_proceduralskymaterial.rst @@ -80,8 +80,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_energy_multiplier** **(** :ref:`float` value **)** -- :ref:`float` **get_energy_multiplier** **(** **)** +- |void| **set_energy_multiplier**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_energy_multiplier**\ (\ ) The sky's overall brightness multiplier. Higher values result in a brighter sky. @@ -97,8 +97,8 @@ The sky's overall brightness multiplier. Higher values result in a brighter sky. .. rst-class:: classref-property-setget -- void **set_ground_bottom_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_ground_bottom_color** **(** **)** +- |void| **set_ground_bottom_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_ground_bottom_color**\ (\ ) Color of the ground at the bottom. Blends with :ref:`ground_horizon_color`. @@ -114,8 +114,8 @@ Color of the ground at the bottom. Blends with :ref:`ground_horizon_color` value **)** -- :ref:`float` **get_ground_curve** **(** **)** +- |void| **set_ground_curve**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ground_curve**\ (\ ) How quickly the :ref:`ground_horizon_color` fades into the :ref:`ground_bottom_color`. @@ -131,8 +131,8 @@ How quickly the :ref:`ground_horizon_color` value **)** -- :ref:`float` **get_ground_energy_multiplier** **(** **)** +- |void| **set_ground_energy_multiplier**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ground_energy_multiplier**\ (\ ) Multiplier for ground color. A higher value will make the ground brighter. @@ -148,8 +148,8 @@ Multiplier for ground color. A higher value will make the ground brighter. .. rst-class:: classref-property-setget -- void **set_ground_horizon_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_ground_horizon_color** **(** **)** +- |void| **set_ground_horizon_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_ground_horizon_color**\ (\ ) Color of the ground at the horizon. Blends with :ref:`ground_bottom_color`. @@ -165,8 +165,8 @@ Color of the ground at the horizon. Blends with :ref:`ground_bottom_color` value **)** -- :ref:`Texture2D` **get_sky_cover** **(** **)** +- |void| **set_sky_cover**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_sky_cover**\ (\ ) The sky cover texture to use. This texture must use an equirectangular projection (similar to :ref:`PanoramaSkyMaterial`). The texture's colors will be *added* to the existing sky color, and will be multiplied by :ref:`sky_energy_multiplier` and :ref:`sky_cover_modulate`. This is mainly suited to displaying stars at night, but it can also be used to display clouds at day or night (with a non-physically-accurate look). @@ -182,8 +182,8 @@ The sky cover texture to use. This texture must use an equirectangular projectio .. rst-class:: classref-property-setget -- void **set_sky_cover_modulate** **(** :ref:`Color` value **)** -- :ref:`Color` **get_sky_cover_modulate** **(** **)** +- |void| **set_sky_cover_modulate**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_sky_cover_modulate**\ (\ ) The tint to apply to the :ref:`sky_cover` texture. This can be used to change the sky cover's colors or opacity independently of the sky energy, which is useful for day/night or weather transitions. Only effective if a texture is defined in :ref:`sky_cover`. @@ -199,8 +199,8 @@ The tint to apply to the :ref:`sky_cover` value **)** -- :ref:`float` **get_sky_curve** **(** **)** +- |void| **set_sky_curve**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_sky_curve**\ (\ ) How quickly the :ref:`sky_horizon_color` fades into the :ref:`sky_top_color`. @@ -216,8 +216,8 @@ How quickly the :ref:`sky_horizon_color` value **)** -- :ref:`float` **get_sky_energy_multiplier** **(** **)** +- |void| **set_sky_energy_multiplier**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_sky_energy_multiplier**\ (\ ) Multiplier for sky color. A higher value will make the sky brighter. @@ -233,8 +233,8 @@ Multiplier for sky color. A higher value will make the sky brighter. .. rst-class:: classref-property-setget -- void **set_sky_horizon_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_sky_horizon_color** **(** **)** +- |void| **set_sky_horizon_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_sky_horizon_color**\ (\ ) Color of the sky at the horizon. Blends with :ref:`sky_top_color`. @@ -250,8 +250,8 @@ Color of the sky at the horizon. Blends with :ref:`sky_top_color` value **)** -- :ref:`Color` **get_sky_top_color** **(** **)** +- |void| **set_sky_top_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_sky_top_color**\ (\ ) Color of the sky at the top. Blends with :ref:`sky_horizon_color`. @@ -267,8 +267,8 @@ Color of the sky at the top. Blends with :ref:`sky_horizon_color` value **)** -- :ref:`float` **get_sun_angle_max** **(** **)** +- |void| **set_sun_angle_max**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_sun_angle_max**\ (\ ) Distance from center of sun where it fades out completely. @@ -284,8 +284,8 @@ Distance from center of sun where it fades out completely. .. rst-class:: classref-property-setget -- void **set_sun_curve** **(** :ref:`float` value **)** -- :ref:`float` **get_sun_curve** **(** **)** +- |void| **set_sun_curve**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_sun_curve**\ (\ ) How quickly the sun fades away between the edge of the sun disk and :ref:`sun_angle_max`. @@ -301,8 +301,8 @@ How quickly the sun fades away between the edge of the sun disk and :ref:`sun_an .. rst-class:: classref-property-setget -- void **set_use_debanding** **(** :ref:`bool` value **)** -- :ref:`bool` **get_use_debanding** **(** **)** +- |void| **set_use_debanding**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_debanding**\ (\ ) If ``true``, enables debanding. Debanding adds a small amount of noise which helps reduce banding that appears from the smooth changes in color in the sky. @@ -313,3 +313,4 @@ If ``true``, enables debanding. Debanding adds a small amount of noise which hel .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index 15569a02d6a..3ebfd8ff228 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -127,8 +127,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_editor_preview_indeterminate** **(** :ref:`bool` value **)** -- :ref:`bool` **is_editor_preview_indeterminate_enabled** **(** **)** +- |void| **set_editor_preview_indeterminate**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_editor_preview_indeterminate_enabled**\ (\ ) If ``false``, the :ref:`indeterminate` animation will be paused in the editor. @@ -144,8 +144,8 @@ If ``false``, the :ref:`indeterminate` .. rst-class:: classref-property-setget -- void **set_fill_mode** **(** :ref:`int` value **)** -- :ref:`int` **get_fill_mode** **(** **)** +- |void| **set_fill_mode**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_fill_mode**\ (\ ) The fill direction. See :ref:`FillMode` for possible values. @@ -161,8 +161,8 @@ The fill direction. See :ref:`FillMode` for possible .. rst-class:: classref-property-setget -- void **set_indeterminate** **(** :ref:`bool` value **)** -- :ref:`bool` **is_indeterminate** **(** **)** +- |void| **set_indeterminate**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_indeterminate**\ (\ ) When set to ``true``, the progress bar indicates that something is happening with an animation, but does not show the fill percentage or value. @@ -178,8 +178,8 @@ When set to ``true``, the progress bar indicates that something is happening wit .. rst-class:: classref-property-setget -- void **set_show_percentage** **(** :ref:`bool` value **)** -- :ref:`bool` **is_percentage_shown** **(** **)** +- |void| **set_show_percentage**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_percentage_shown**\ (\ ) If ``true``, the fill percentage is displayed on the bar. @@ -281,3 +281,4 @@ The style of the progress (i.e. the part that fills the bar). .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_projection.rst b/classes/class_projection.rst index 95077427a24..097d4f46631 100644 --- a/classes/class_projection.rst +++ b/classes/class_projection.rst @@ -53,15 +53,15 @@ Constructors .. table:: :widths: auto - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`Projection` **(** **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`Projection` **(** :ref:`Projection` from **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`Projection` **(** :ref:`Transform3D` from **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`Projection` **(** :ref:`Vector4` x_axis, :ref:`Vector4` y_axis, :ref:`Vector4` z_axis, :ref:`Vector4` w_axis **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`Projection`\ (\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`Projection`\ (\ from\: :ref:`Projection`\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`Projection`\ (\ from\: :ref:`Transform3D`\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`Projection`\ (\ x_axis\: :ref:`Vector4`, y_axis\: :ref:`Vector4`, z_axis\: :ref:`Vector4`, w_axis\: :ref:`Vector4`\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -71,59 +71,59 @@ Methods .. table:: :widths: auto - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`create_depth_correction` **(** :ref:`bool` flip_y **)** |static| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`create_fit_aabb` **(** :ref:`AABB` aabb **)** |static| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`create_for_hmd` **(** :ref:`int` eye, :ref:`float` aspect, :ref:`float` intraocular_dist, :ref:`float` display_width, :ref:`float` display_to_lens, :ref:`float` oversample, :ref:`float` z_near, :ref:`float` z_far **)** |static| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`create_frustum` **(** :ref:`float` left, :ref:`float` right, :ref:`float` bottom, :ref:`float` top, :ref:`float` z_near, :ref:`float` z_far **)** |static| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`create_frustum_aspect` **(** :ref:`float` size, :ref:`float` aspect, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far, :ref:`bool` flip_fov=false **)** |static| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`create_light_atlas_rect` **(** :ref:`Rect2` rect **)** |static| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`create_orthogonal` **(** :ref:`float` left, :ref:`float` right, :ref:`float` bottom, :ref:`float` top, :ref:`float` z_near, :ref:`float` z_far **)** |static| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`create_orthogonal_aspect` **(** :ref:`float` size, :ref:`float` aspect, :ref:`float` z_near, :ref:`float` z_far, :ref:`bool` flip_fov=false **)** |static| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`create_perspective` **(** :ref:`float` fovy, :ref:`float` aspect, :ref:`float` z_near, :ref:`float` z_far, :ref:`bool` flip_fov=false **)** |static| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`create_perspective_hmd` **(** :ref:`float` fovy, :ref:`float` aspect, :ref:`float` z_near, :ref:`float` z_far, :ref:`bool` flip_fov, :ref:`int` eye, :ref:`float` intraocular_dist, :ref:`float` convergence_dist **)** |static| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`determinant` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`flipped_y` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_aspect` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_far_plane_half_extents` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_fov` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_fovy` **(** :ref:`float` fovx, :ref:`float` aspect **)** |static| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_lod_multiplier` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_pixels_per_meter` **(** :ref:`int` for_pixel_width **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Plane` | :ref:`get_projection_plane` **(** :ref:`int` plane **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_viewport_half_extents` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_z_far` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_z_near` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`inverse` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_orthogonal` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`jitter_offseted` **(** :ref:`Vector2` offset **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`perspective_znear_adjusted` **(** :ref:`float` new_znear **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`create_depth_correction`\ (\ flip_y\: :ref:`bool`\ ) |static| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`create_fit_aabb`\ (\ aabb\: :ref:`AABB`\ ) |static| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`create_for_hmd`\ (\ eye\: :ref:`int`, aspect\: :ref:`float`, intraocular_dist\: :ref:`float`, display_width\: :ref:`float`, display_to_lens\: :ref:`float`, oversample\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) |static| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`create_frustum`\ (\ left\: :ref:`float`, right\: :ref:`float`, bottom\: :ref:`float`, top\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) |static| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`create_frustum_aspect`\ (\ size\: :ref:`float`, aspect\: :ref:`float`, offset\: :ref:`Vector2`, z_near\: :ref:`float`, z_far\: :ref:`float`, flip_fov\: :ref:`bool` = false\ ) |static| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`create_light_atlas_rect`\ (\ rect\: :ref:`Rect2`\ ) |static| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`create_orthogonal`\ (\ left\: :ref:`float`, right\: :ref:`float`, bottom\: :ref:`float`, top\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) |static| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`create_orthogonal_aspect`\ (\ size\: :ref:`float`, aspect\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`, flip_fov\: :ref:`bool` = false\ ) |static| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`create_perspective`\ (\ fovy\: :ref:`float`, aspect\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`, flip_fov\: :ref:`bool` = false\ ) |static| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`create_perspective_hmd`\ (\ fovy\: :ref:`float`, aspect\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`, flip_fov\: :ref:`bool`, eye\: :ref:`int`, intraocular_dist\: :ref:`float`, convergence_dist\: :ref:`float`\ ) |static| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`determinant`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`flipped_y`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_aspect`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_far_plane_half_extents`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_fov`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_fovy`\ (\ fovx\: :ref:`float`, aspect\: :ref:`float`\ ) |static| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_lod_multiplier`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_pixels_per_meter`\ (\ for_pixel_width\: :ref:`int`\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Plane` | :ref:`get_projection_plane`\ (\ plane\: :ref:`int`\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_viewport_half_extents`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_z_far`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_z_near`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`inverse`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_orthogonal`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`jitter_offseted`\ (\ offset\: :ref:`Vector2`\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`perspective_znear_adjusted`\ (\ new_znear\: :ref:`float`\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -133,17 +133,17 @@ Operators .. table:: :widths: auto - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Projection` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`Projection` | :ref:`operator *` **(** :ref:`Projection` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`operator *` **(** :ref:`Vector4` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Projection` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`operator []` **(** :ref:`int` index **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Projection`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`operator *`\ (\ right\: :ref:`Projection`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator *`\ (\ right\: :ref:`Vector4`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Projection`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -284,7 +284,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Projection` **Projection** **(** **)** +:ref:`Projection` **Projection**\ (\ ) Constructs a default-initialized **Projection** set to :ref:`IDENTITY`. @@ -294,7 +294,7 @@ Constructs a default-initialized **Projection** set to :ref:`IDENTITY` **Projection** **(** :ref:`Projection` from **)** +:ref:`Projection` **Projection**\ (\ from\: :ref:`Projection`\ ) Constructs a **Projection** as a copy of the given **Projection**. @@ -304,7 +304,7 @@ Constructs a **Projection** as a copy of the given **Projection**. .. rst-class:: classref-constructor -:ref:`Projection` **Projection** **(** :ref:`Transform3D` from **)** +:ref:`Projection` **Projection**\ (\ from\: :ref:`Transform3D`\ ) Constructs a Projection as a copy of the given :ref:`Transform3D`. @@ -314,7 +314,7 @@ Constructs a Projection as a copy of the given :ref:`Transform3D` **Projection** **(** :ref:`Vector4` x_axis, :ref:`Vector4` y_axis, :ref:`Vector4` z_axis, :ref:`Vector4` w_axis **)** +:ref:`Projection` **Projection**\ (\ x_axis\: :ref:`Vector4`, y_axis\: :ref:`Vector4`, z_axis\: :ref:`Vector4`, w_axis\: :ref:`Vector4`\ ) Constructs a Projection from four :ref:`Vector4` values (matrix columns). @@ -331,7 +331,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Projection` **create_depth_correction** **(** :ref:`bool` flip_y **)** |static| +:ref:`Projection` **create_depth_correction**\ (\ flip_y\: :ref:`bool`\ ) |static| Creates a new **Projection** that projects positions from a depth range of ``-1`` to ``1`` to one that ranges from ``0`` to ``1``, and flips the projected positions vertically, according to ``flip_y``. @@ -343,7 +343,7 @@ Creates a new **Projection** that projects positions from a depth range of ``-1` .. rst-class:: classref-method -:ref:`Projection` **create_fit_aabb** **(** :ref:`AABB` aabb **)** |static| +:ref:`Projection` **create_fit_aabb**\ (\ aabb\: :ref:`AABB`\ ) |static| Creates a new **Projection** that scales a given projection to fit around a given :ref:`AABB` in projection space. @@ -355,7 +355,7 @@ Creates a new **Projection** that scales a given projection to fit around a give .. rst-class:: classref-method -:ref:`Projection` **create_for_hmd** **(** :ref:`int` eye, :ref:`float` aspect, :ref:`float` intraocular_dist, :ref:`float` display_width, :ref:`float` display_to_lens, :ref:`float` oversample, :ref:`float` z_near, :ref:`float` z_far **)** |static| +:ref:`Projection` **create_for_hmd**\ (\ eye\: :ref:`int`, aspect\: :ref:`float`, intraocular_dist\: :ref:`float`, display_width\: :ref:`float`, display_to_lens\: :ref:`float`, oversample\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) |static| Creates a new **Projection** for projecting positions onto a head-mounted display with the given X:Y aspect ratio, distance between eyes, display width, distance to lens, oversampling factor, and depth clipping planes. @@ -369,7 +369,7 @@ Creates a new **Projection** for projecting positions onto a head-mounted displa .. rst-class:: classref-method -:ref:`Projection` **create_frustum** **(** :ref:`float` left, :ref:`float` right, :ref:`float` bottom, :ref:`float` top, :ref:`float` z_near, :ref:`float` z_far **)** |static| +:ref:`Projection` **create_frustum**\ (\ left\: :ref:`float`, right\: :ref:`float`, bottom\: :ref:`float`, top\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) |static| Creates a new **Projection** that projects positions in a frustum with the given clipping planes. @@ -381,7 +381,7 @@ Creates a new **Projection** that projects positions in a frustum with the given .. rst-class:: classref-method -:ref:`Projection` **create_frustum_aspect** **(** :ref:`float` size, :ref:`float` aspect, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far, :ref:`bool` flip_fov=false **)** |static| +:ref:`Projection` **create_frustum_aspect**\ (\ size\: :ref:`float`, aspect\: :ref:`float`, offset\: :ref:`Vector2`, z_near\: :ref:`float`, z_far\: :ref:`float`, flip_fov\: :ref:`bool` = false\ ) |static| Creates a new **Projection** that projects positions in a frustum with the given size, X:Y aspect ratio, offset, and clipping planes. @@ -395,7 +395,7 @@ Creates a new **Projection** that projects positions in a frustum with the given .. rst-class:: classref-method -:ref:`Projection` **create_light_atlas_rect** **(** :ref:`Rect2` rect **)** |static| +:ref:`Projection` **create_light_atlas_rect**\ (\ rect\: :ref:`Rect2`\ ) |static| Creates a new **Projection** that projects positions into the given :ref:`Rect2`. @@ -407,7 +407,7 @@ Creates a new **Projection** that projects positions into the given :ref:`Rect2< .. rst-class:: classref-method -:ref:`Projection` **create_orthogonal** **(** :ref:`float` left, :ref:`float` right, :ref:`float` bottom, :ref:`float` top, :ref:`float` z_near, :ref:`float` z_far **)** |static| +:ref:`Projection` **create_orthogonal**\ (\ left\: :ref:`float`, right\: :ref:`float`, bottom\: :ref:`float`, top\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) |static| Creates a new **Projection** that projects positions using an orthogonal projection with the given clipping planes. @@ -419,7 +419,7 @@ Creates a new **Projection** that projects positions using an orthogonal project .. rst-class:: classref-method -:ref:`Projection` **create_orthogonal_aspect** **(** :ref:`float` size, :ref:`float` aspect, :ref:`float` z_near, :ref:`float` z_far, :ref:`bool` flip_fov=false **)** |static| +:ref:`Projection` **create_orthogonal_aspect**\ (\ size\: :ref:`float`, aspect\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`, flip_fov\: :ref:`bool` = false\ ) |static| Creates a new **Projection** that projects positions using an orthogonal projection with the given size, X:Y aspect ratio, and clipping planes. @@ -433,7 +433,7 @@ Creates a new **Projection** that projects positions using an orthogonal project .. rst-class:: classref-method -:ref:`Projection` **create_perspective** **(** :ref:`float` fovy, :ref:`float` aspect, :ref:`float` z_near, :ref:`float` z_far, :ref:`bool` flip_fov=false **)** |static| +:ref:`Projection` **create_perspective**\ (\ fovy\: :ref:`float`, aspect\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`, flip_fov\: :ref:`bool` = false\ ) |static| Creates a new **Projection** that projects positions using a perspective projection with the given Y-axis field of view (in degrees), X:Y aspect ratio, and clipping planes. @@ -447,7 +447,7 @@ Creates a new **Projection** that projects positions using a perspective project .. rst-class:: classref-method -:ref:`Projection` **create_perspective_hmd** **(** :ref:`float` fovy, :ref:`float` aspect, :ref:`float` z_near, :ref:`float` z_far, :ref:`bool` flip_fov, :ref:`int` eye, :ref:`float` intraocular_dist, :ref:`float` convergence_dist **)** |static| +:ref:`Projection` **create_perspective_hmd**\ (\ fovy\: :ref:`float`, aspect\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`, flip_fov\: :ref:`bool`, eye\: :ref:`int`, intraocular_dist\: :ref:`float`, convergence_dist\: :ref:`float`\ ) |static| Creates a new **Projection** that projects positions using a perspective projection with the given Y-axis field of view (in degrees), X:Y aspect ratio, and clipping distances. The projection is adjusted for a head-mounted display with the given distance between eyes and distance to a point that can be focused on. @@ -463,7 +463,7 @@ Creates a new **Projection** that projects positions using a perspective project .. rst-class:: classref-method -:ref:`float` **determinant** **(** **)** |const| +:ref:`float` **determinant**\ (\ ) |const| Returns a scalar value that is the signed factor by which areas are scaled by this matrix. If the sign is negative, the matrix flips the orientation of the area. @@ -477,7 +477,7 @@ The determinant can be used to calculate the invertibility of a matrix or solve .. rst-class:: classref-method -:ref:`Projection` **flipped_y** **(** **)** |const| +:ref:`Projection` **flipped_y**\ (\ ) |const| Returns a copy of this **Projection** with the signs of the values of the Y column flipped. @@ -489,7 +489,7 @@ Returns a copy of this **Projection** with the signs of the values of the Y colu .. rst-class:: classref-method -:ref:`float` **get_aspect** **(** **)** |const| +:ref:`float` **get_aspect**\ (\ ) |const| Returns the X:Y aspect ratio of this **Projection**'s viewport. @@ -501,7 +501,7 @@ Returns the X:Y aspect ratio of this **Projection**'s viewport. .. rst-class:: classref-method -:ref:`Vector2` **get_far_plane_half_extents** **(** **)** |const| +:ref:`Vector2` **get_far_plane_half_extents**\ (\ ) |const| Returns the dimensions of the far clipping plane of the projection, divided by two. @@ -513,7 +513,7 @@ Returns the dimensions of the far clipping plane of the projection, divided by t .. rst-class:: classref-method -:ref:`float` **get_fov** **(** **)** |const| +:ref:`float` **get_fov**\ (\ ) |const| Returns the horizontal field of view of the projection (in degrees). @@ -525,7 +525,7 @@ Returns the horizontal field of view of the projection (in degrees). .. rst-class:: classref-method -:ref:`float` **get_fovy** **(** :ref:`float` fovx, :ref:`float` aspect **)** |static| +:ref:`float` **get_fovy**\ (\ fovx\: :ref:`float`, aspect\: :ref:`float`\ ) |static| Returns the vertical field of view of the projection (in degrees) associated with the given horizontal field of view (in degrees) and aspect ratio. @@ -537,7 +537,7 @@ Returns the vertical field of view of the projection (in degrees) associated wit .. rst-class:: classref-method -:ref:`float` **get_lod_multiplier** **(** **)** |const| +:ref:`float` **get_lod_multiplier**\ (\ ) |const| Returns the factor by which the visible level of detail is scaled by this **Projection**. @@ -549,7 +549,7 @@ Returns the factor by which the visible level of detail is scaled by this **Proj .. rst-class:: classref-method -:ref:`int` **get_pixels_per_meter** **(** :ref:`int` for_pixel_width **)** |const| +:ref:`int` **get_pixels_per_meter**\ (\ for_pixel_width\: :ref:`int`\ ) |const| Returns the number of pixels with the given pixel width displayed per meter, after this **Projection** is applied. @@ -561,7 +561,7 @@ Returns the number of pixels with the given pixel width displayed per meter, aft .. rst-class:: classref-method -:ref:`Plane` **get_projection_plane** **(** :ref:`int` plane **)** |const| +:ref:`Plane` **get_projection_plane**\ (\ plane\: :ref:`int`\ ) |const| Returns the clipping plane of this **Projection** whose index is given by ``plane``. @@ -575,7 +575,7 @@ Returns the clipping plane of this **Projection** whose index is given by ``plan .. rst-class:: classref-method -:ref:`Vector2` **get_viewport_half_extents** **(** **)** |const| +:ref:`Vector2` **get_viewport_half_extents**\ (\ ) |const| Returns the dimensions of the viewport plane that this **Projection** projects positions onto, divided by two. @@ -587,7 +587,7 @@ Returns the dimensions of the viewport plane that this **Projection** projects p .. rst-class:: classref-method -:ref:`float` **get_z_far** **(** **)** |const| +:ref:`float` **get_z_far**\ (\ ) |const| Returns the distance for this **Projection** beyond which positions are clipped. @@ -599,7 +599,7 @@ Returns the distance for this **Projection** beyond which positions are clipped. .. rst-class:: classref-method -:ref:`float` **get_z_near** **(** **)** |const| +:ref:`float` **get_z_near**\ (\ ) |const| Returns the distance for this **Projection** before which positions are clipped. @@ -611,7 +611,7 @@ Returns the distance for this **Projection** before which positions are clipped. .. rst-class:: classref-method -:ref:`Projection` **inverse** **(** **)** |const| +:ref:`Projection` **inverse**\ (\ ) |const| Returns a **Projection** that performs the inverse of this **Projection**'s projective transformation. @@ -623,7 +623,7 @@ Returns a **Projection** that performs the inverse of this **Projection**'s proj .. rst-class:: classref-method -:ref:`bool` **is_orthogonal** **(** **)** |const| +:ref:`bool` **is_orthogonal**\ (\ ) |const| Returns ``true`` if this **Projection** performs an orthogonal projection. @@ -635,7 +635,7 @@ Returns ``true`` if this **Projection** performs an orthogonal projection. .. rst-class:: classref-method -:ref:`Projection` **jitter_offseted** **(** :ref:`Vector2` offset **)** |const| +:ref:`Projection` **jitter_offseted**\ (\ offset\: :ref:`Vector2`\ ) |const| Returns a **Projection** with the X and Y values from the given :ref:`Vector2` added to the first and second values of the final column respectively. @@ -647,7 +647,7 @@ Returns a **Projection** with the X and Y values from the given :ref:`Vector2` **perspective_znear_adjusted** **(** :ref:`float` new_znear **)** |const| +:ref:`Projection` **perspective_znear_adjusted**\ (\ new_znear\: :ref:`float`\ ) |const| Returns a **Projection** with the near clipping distance adjusted to be ``new_znear``. @@ -666,7 +666,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Projection` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Projection`\ ) Returns ``true`` if the projections are not equal. @@ -680,7 +680,7 @@ Returns ``true`` if the projections are not equal. .. rst-class:: classref-operator -:ref:`Projection` **operator *** **(** :ref:`Projection` right **)** +:ref:`Projection` **operator ***\ (\ right\: :ref:`Projection`\ ) Returns a **Projection** that applies the combined transformations of this **Projection** and ``right``. @@ -692,7 +692,7 @@ Returns a **Projection** that applies the combined transformations of this **Pro .. rst-class:: classref-operator -:ref:`Vector4` **operator *** **(** :ref:`Vector4` right **)** +:ref:`Vector4` **operator ***\ (\ right\: :ref:`Vector4`\ ) Projects (multiplies) the given :ref:`Vector4` by this **Projection** matrix. @@ -704,7 +704,7 @@ Projects (multiplies) the given :ref:`Vector4` by this **Projecti .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`Projection` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Projection`\ ) Returns ``true`` if the projections are equal. @@ -718,7 +718,7 @@ Returns ``true`` if the projections are equal. .. rst-class:: classref-operator -:ref:`Vector4` **operator []** **(** :ref:`int` index **)** +:ref:`Vector4` **operator []**\ (\ index\: :ref:`int`\ ) Returns the column of the **Projection** with the given index. @@ -731,3 +731,4 @@ Indices are in the following order: x, y, z, w. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index a83b92e9b4e..7e64084db10 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -491,11 +491,11 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`filesystem/import/blender/enabled.web` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`filesystem/import/fbx/enabled` | ``true`` | + | :ref:`bool` | :ref:`filesystem/import/fbx2gltf/enabled` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`filesystem/import/fbx/enabled.android` | ``false`` | + | :ref:`bool` | :ref:`filesystem/import/fbx2gltf/enabled.android` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`filesystem/import/fbx/enabled.web` | ``false`` | + | :ref:`bool` | :ref:`filesystem/import/fbx2gltf/enabled.web` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`gui/common/default_scroll_deadzone` | ``0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -1604,43 +1604,43 @@ Methods .. table:: :widths: auto - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_property_info` **(** :ref:`Dictionary` hint **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** :ref:`String` name **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`get_global_class_list` **(** **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_order` **(** :ref:`String` name **)** |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_setting` **(** :ref:`String` name, :ref:`Variant` default_value=null **)** |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_setting_with_override` **(** :ref:`StringName` name **)** |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`globalize_path` **(** :ref:`String` path **)** |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`load_resource_pack` **(** :ref:`String` pack, :ref:`bool` replace_files=true, :ref:`int` offset=0 **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`localize_path` **(** :ref:`String` path **)** |const| | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save` **(** **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save_custom` **(** :ref:`String` file **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_as_basic` **(** :ref:`String` name, :ref:`bool` basic **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_as_internal` **(** :ref:`String` name, :ref:`bool` internal **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_order` **(** :ref:`String` name, :ref:`int` position **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_restart_if_changed` **(** :ref:`String` name, :ref:`bool` restart **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_setting` **(** :ref:`String` name, :ref:`Variant` value **)** | - +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_property_info`\ (\ hint\: :ref:`Dictionary`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ name\: :ref:`String`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_global_class_list`\ (\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_order`\ (\ name\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_setting`\ (\ name\: :ref:`String`, default_value\: :ref:`Variant` = null\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_setting_with_override`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`globalize_path`\ (\ path\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_setting`\ (\ name\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`load_resource_pack`\ (\ pack\: :ref:`String`, replace_files\: :ref:`bool` = true, offset\: :ref:`int` = 0\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`localize_path`\ (\ path\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save`\ (\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save_custom`\ (\ file\: :ref:`String`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_as_basic`\ (\ name\: :ref:`String`, basic\: :ref:`bool`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_as_internal`\ (\ name\: :ref:`String`, internal\: :ref:`bool`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_initial_value`\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_order`\ (\ name\: :ref:`String`, position\: :ref:`int`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_restart_if_changed`\ (\ name\: :ref:`String`, restart\: :ref:`bool`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_setting`\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -1655,7 +1655,7 @@ Signals .. rst-class:: classref-signal -**settings_changed** **(** **)** +**settings_changed**\ (\ ) Emitted when any setting is changed, up to once per process frame. @@ -4506,39 +4506,39 @@ Override for :ref:`filesystem/import/blender/enabled` **filesystem/import/fbx/enabled** = ``true`` +:ref:`bool` **filesystem/import/fbx2gltf/enabled** = ``true`` If ``true``, Autodesk FBX 3D scene files with the ``.fbx`` extension will be imported by converting them to glTF 2.0. -This requires configuring a path to a FBX2glTF executable in the editor settings at ``filesystem/import/fbx/fbx2gltf_path``. +This requires configuring a path to a FBX2glTF executable in the editor settings at :ref:`EditorSettings.filesystem/import/fbx2gltf/fbx2gltf_path`. .. rst-class:: classref-item-separator ---- -.. _class_ProjectSettings_property_filesystem/import/fbx/enabled.android: +.. _class_ProjectSettings_property_filesystem/import/fbx2gltf/enabled.android: .. rst-class:: classref-property -:ref:`bool` **filesystem/import/fbx/enabled.android** = ``false`` +:ref:`bool` **filesystem/import/fbx2gltf/enabled.android** = ``false`` -Override for :ref:`filesystem/import/fbx/enabled` on Android where FBX2glTF can't easily be accessed from Godot. +Override for :ref:`filesystem/import/fbx2gltf/enabled` on Android where FBX2glTF can't easily be accessed from Godot. .. rst-class:: classref-item-separator ---- -.. _class_ProjectSettings_property_filesystem/import/fbx/enabled.web: +.. _class_ProjectSettings_property_filesystem/import/fbx2gltf/enabled.web: .. rst-class:: classref-property -:ref:`bool` **filesystem/import/fbx/enabled.web** = ``false`` +:ref:`bool` **filesystem/import/fbx2gltf/enabled.web** = ``false`` -Override for :ref:`filesystem/import/fbx/enabled` on the Web where FBX2glTF can't easily be accessed from Godot. +Override for :ref:`filesystem/import/fbx2gltf/enabled` on the Web where FBX2glTF can't easily be accessed from Godot. .. rst-class:: classref-item-separator @@ -9384,7 +9384,7 @@ The size of the 2D shadow atlas in pixels. Higher values result in more precise :ref:`bool` **rendering/2d/snap/snap_2d_transforms_to_pixel** = ``false`` -If ``true``, :ref:`CanvasItem` nodes will internally snap to full pixels. Their position can still be sub-pixel, but the decimals will not have effect. This can lead to a crisper appearance at the cost of less smooth movement, especially when :ref:`Camera2D` smoothing is enabled. +If ``true``, :ref:`CanvasItem` nodes will internally snap to full pixels. Useful for low-resolution pixel art games. Their position can still be sub-pixel, but the decimals will not have effect. This can lead to a crisper appearance at the cost of less smooth movement, especially when :ref:`Camera2D` smoothing is enabled. \ **Note:** This property is only read when the project starts. To toggle 2D transform snapping at runtime, use :ref:`RenderingServer.viewport_set_snap_2d_transforms_to_pixel` on the root :ref:`Viewport` instead. @@ -9400,7 +9400,7 @@ If ``true``, :ref:`CanvasItem` nodes will internally snap to f :ref:`bool` **rendering/2d/snap/snap_2d_vertices_to_pixel** = ``false`` -If ``true``, vertices of :ref:`CanvasItem` nodes will snap to full pixels. Only affects the final vertex positions, not the transforms. This can lead to a crisper appearance at the cost of less smooth movement, especially when :ref:`Camera2D` smoothing is enabled. +If ``true``, vertices of :ref:`CanvasItem` nodes will snap to full pixels. Useful for low-resolution pixel art games. Only affects the final vertex positions, not the transforms. This can lead to a crisper appearance at the cost of less smooth movement, especially when :ref:`Camera2D` smoothing is enabled. \ **Note:** This property is only read when the project starts. To toggle 2D vertex snapping at runtime, use :ref:`RenderingServer.viewport_set_snap_2d_vertices_to_pixel` on the root :ref:`Viewport` instead. @@ -9594,9 +9594,9 @@ If ``true``, performs a previous depth pass before rendering 3D materials. This :ref:`int` **rendering/driver/threads/thread_model** = ``1`` -The thread model to use for rendering. Rendering on a thread may improve performance, but synchronizing to the main thread can cause a bit more jitter. +**Experimental:** This setting has several known bugs which can lead to crashing, especially when using particles or resizing the window. Not recommended for use in production at this stage. -\ **Note:** The **Multi-Threaded** option is experimental, and has several known bugs which can lead to crashing, especially when using particles or resizing the window. Not recommended for use in production at this stage. +The thread model to use for rendering. Rendering on a thread may improve performance, but synchronizing to the main thread can cause a bit more jitter. .. rst-class:: classref-item-separator @@ -11228,6 +11228,8 @@ Lower-end override for :ref:`rendering/shading/overrides/force_vertex_shading`\ s. +\ **Note:** For pixel art aesthetics, see also :ref:`rendering/2d/snap/snap_2d_vertices_to_pixel` and :ref:`rendering/2d/snap/snap_2d_transforms_to_pixel`. + .. rst-class:: classref-item-separator ---- @@ -11640,7 +11642,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_property_info** **(** :ref:`Dictionary` hint **)** +|void| **add_property_info**\ (\ hint\: :ref:`Dictionary`\ ) Adds a custom property info to a property. The dictionary must contain: @@ -11692,7 +11694,7 @@ Adds a custom property info to a property. The dictionary must contain: .. rst-class:: classref-method -void **clear** **(** :ref:`String` name **)** +|void| **clear**\ (\ name\: :ref:`String`\ ) Clears the whole configuration (not recommended, may break things). @@ -11704,7 +11706,7 @@ Clears the whole configuration (not recommended, may break things). .. rst-class:: classref-method -:ref:`Dictionary[]` **get_global_class_list** **(** **)** +:ref:`Array`\[:ref:`Dictionary`\] **get_global_class_list**\ (\ ) Returns an :ref:`Array` of registered global classes. Each global class is represented as a :ref:`Dictionary` that contains the following entries: @@ -11728,7 +11730,7 @@ Returns an :ref:`Array` of registered global classes. Each global c .. rst-class:: classref-method -:ref:`int` **get_order** **(** :ref:`String` name **)** |const| +:ref:`int` **get_order**\ (\ name\: :ref:`String`\ ) |const| Returns the order of a configuration value (influences when saved to the config file). @@ -11740,7 +11742,7 @@ Returns the order of a configuration value (influences when saved to the config .. rst-class:: classref-method -:ref:`Variant` **get_setting** **(** :ref:`String` name, :ref:`Variant` default_value=null **)** |const| +:ref:`Variant` **get_setting**\ (\ name\: :ref:`String`, default_value\: :ref:`Variant` = null\ ) |const| Returns the value of the setting identified by ``name``. If the setting doesn't exist and ``default_value`` is specified, the value of ``default_value`` is returned. Otherwise, ``null`` is returned. @@ -11771,7 +11773,7 @@ Returns the value of the setting identified by ``name``. If the setting doesn't .. rst-class:: classref-method -:ref:`Variant` **get_setting_with_override** **(** :ref:`StringName` name **)** |const| +:ref:`Variant` **get_setting_with_override**\ (\ name\: :ref:`StringName`\ ) |const| Similar to :ref:`get_setting`, but applies feature tag overrides if any exists and is valid. @@ -11802,7 +11804,7 @@ Then the overridden setting will be returned instead if the project is running o .. rst-class:: classref-method -:ref:`String` **globalize_path** **(** :ref:`String` path **)** |const| +:ref:`String` **globalize_path**\ (\ path\: :ref:`String`\ ) |const| Returns the absolute, native OS path corresponding to the localized ``path`` (starting with ``res://`` or ``user://``). The returned path will vary depending on the operating system and user preferences. See :doc:`File paths in Godot projects <../tutorials/io/data_paths>` to see what those paths convert to. See also :ref:`localize_path`. @@ -11830,7 +11832,7 @@ Returns the absolute, native OS path corresponding to the localized ``path`` (st .. rst-class:: classref-method -:ref:`bool` **has_setting** **(** :ref:`String` name **)** |const| +:ref:`bool` **has_setting**\ (\ name\: :ref:`String`\ ) |const| Returns ``true`` if a configuration value is present. @@ -11842,7 +11844,7 @@ Returns ``true`` if a configuration value is present. .. rst-class:: classref-method -:ref:`bool` **load_resource_pack** **(** :ref:`String` pack, :ref:`bool` replace_files=true, :ref:`int` offset=0 **)** +:ref:`bool` **load_resource_pack**\ (\ pack\: :ref:`String`, replace_files\: :ref:`bool` = true, offset\: :ref:`int` = 0\ ) Loads the contents of the .pck or .zip file specified by ``pack`` into the resource filesystem (``res://``). Returns ``true`` on success. @@ -11858,7 +11860,7 @@ Loads the contents of the .pck or .zip file specified by ``pack`` into the resou .. rst-class:: classref-method -:ref:`String` **localize_path** **(** :ref:`String` path **)** |const| +:ref:`String` **localize_path**\ (\ path\: :ref:`String`\ ) |const| Returns the localized path (starting with ``res://``) corresponding to the absolute, native OS ``path``. See also :ref:`globalize_path`. @@ -11870,7 +11872,7 @@ Returns the localized path (starting with ``res://``) corresponding to the absol .. rst-class:: classref-method -:ref:`Error` **save** **(** **)** +:ref:`Error` **save**\ (\ ) Saves the configuration to the ``project.godot`` file. @@ -11884,7 +11886,7 @@ Saves the configuration to the ``project.godot`` file. .. rst-class:: classref-method -:ref:`Error` **save_custom** **(** :ref:`String` file **)** +:ref:`Error` **save_custom**\ (\ file\: :ref:`String`\ ) Saves the configuration to a custom file. The file extension must be ``.godot`` (to save in text-based :ref:`ConfigFile` format) or ``.binary`` (to save in binary format). You can also save ``override.cfg`` file, which is also text, but can be used in exported projects unlike other formats. @@ -11896,7 +11898,7 @@ Saves the configuration to a custom file. The file extension must be ``.godot`` .. rst-class:: classref-method -void **set_as_basic** **(** :ref:`String` name, :ref:`bool` basic **)** +|void| **set_as_basic**\ (\ name\: :ref:`String`, basic\: :ref:`bool`\ ) Defines if the specified setting is considered basic or advanced. Basic settings will always be shown in the project settings. Advanced settings will only be shown if the user enables the "Advanced Settings" option. @@ -11908,7 +11910,7 @@ Defines if the specified setting is considered basic or advanced. Basic settings .. rst-class:: classref-method -void **set_as_internal** **(** :ref:`String` name, :ref:`bool` internal **)** +|void| **set_as_internal**\ (\ name\: :ref:`String`, internal\: :ref:`bool`\ ) Defines if the specified setting is considered internal. An internal setting won't show up in the Project Settings dialog. This is mostly useful for addons that need to store their own internal settings without exposing them directly to the user. @@ -11920,7 +11922,7 @@ Defines if the specified setting is considered internal. An internal setting won .. rst-class:: classref-method -void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value **)** +|void| **set_initial_value**\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) Sets the specified setting's initial value. This is the value the setting reverts to. @@ -11932,7 +11934,7 @@ Sets the specified setting's initial value. This is the value the setting revert .. rst-class:: classref-method -void **set_order** **(** :ref:`String` name, :ref:`int` position **)** +|void| **set_order**\ (\ name\: :ref:`String`, position\: :ref:`int`\ ) Sets the order of a configuration value (influences when saved to the config file). @@ -11944,7 +11946,7 @@ Sets the order of a configuration value (influences when saved to the config fil .. rst-class:: classref-method -void **set_restart_if_changed** **(** :ref:`String` name, :ref:`bool` restart **)** +|void| **set_restart_if_changed**\ (\ name\: :ref:`String`, restart\: :ref:`bool`\ ) Sets whether a setting requires restarting the editor to properly take effect. @@ -11958,7 +11960,7 @@ Sets whether a setting requires restarting the editor to properly take effect. .. rst-class:: classref-method -void **set_setting** **(** :ref:`String` name, :ref:`Variant` value **)** +|void| **set_setting**\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) Sets the value of a setting. @@ -11986,3 +11988,4 @@ This can also be used to erase custom project settings. To do this change the se .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_propertytweener.rst b/classes/class_propertytweener.rst index fc170fa186f..71530dc3fd3 100644 --- a/classes/class_propertytweener.rst +++ b/classes/class_propertytweener.rst @@ -31,21 +31,21 @@ Methods .. table:: :widths: auto - +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PropertyTweener` | :ref:`as_relative` **(** **)** | - +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PropertyTweener` | :ref:`from` **(** :ref:`Variant` value **)** | - +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PropertyTweener` | :ref:`from_current` **(** **)** | - +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PropertyTweener` | :ref:`set_custom_interpolator` **(** :ref:`Callable` interpolator_method **)** | - +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PropertyTweener` | :ref:`set_delay` **(** :ref:`float` delay **)** | - +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PropertyTweener` | :ref:`set_ease` **(** :ref:`EaseType` ease **)** | - +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PropertyTweener` | :ref:`set_trans` **(** :ref:`TransitionType` trans **)** | - +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PropertyTweener` | :ref:`as_relative`\ (\ ) | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PropertyTweener` | :ref:`from`\ (\ value\: :ref:`Variant`\ ) | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PropertyTweener` | :ref:`from_current`\ (\ ) | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PropertyTweener` | :ref:`set_custom_interpolator`\ (\ interpolator_method\: :ref:`Callable`\ ) | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PropertyTweener` | :ref:`set_delay`\ (\ delay\: :ref:`float`\ ) | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PropertyTweener` | :ref:`set_ease`\ (\ ease\: :ref:`EaseType`\ ) | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PropertyTweener` | :ref:`set_trans`\ (\ trans\: :ref:`TransitionType`\ ) | + +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -60,7 +60,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PropertyTweener` **as_relative** **(** **)** +:ref:`PropertyTweener` **as_relative**\ (\ ) When called, the final value will be used as a relative value instead. @@ -79,7 +79,7 @@ When called, the final value will be used as a relative value instead. .. rst-class:: classref-method -:ref:`PropertyTweener` **from** **(** :ref:`Variant` value **)** +:ref:`PropertyTweener` **from**\ (\ value\: :ref:`Variant`\ ) Sets a custom initial value to the **PropertyTweener**. @@ -98,7 +98,7 @@ Sets a custom initial value to the **PropertyTweener**. .. rst-class:: classref-method -:ref:`PropertyTweener` **from_current** **(** **)** +:ref:`PropertyTweener` **from_current**\ (\ ) Makes the **PropertyTweener** use the current property value (i.e. at the time of creating this **PropertyTweener**) as a starting point. This is equivalent of using :ref:`from` with the current value. These two calls will do the same: @@ -115,7 +115,7 @@ Makes the **PropertyTweener** use the current property value (i.e. at the time o .. rst-class:: classref-method -:ref:`PropertyTweener` **set_custom_interpolator** **(** :ref:`Callable` interpolator_method **)** +:ref:`PropertyTweener` **set_custom_interpolator**\ (\ interpolator_method\: :ref:`Callable`\ ) Allows interpolating the value with a custom easing function. The provided ``interpolator_method`` will be called with a value ranging from ``0.0`` to ``1.0`` and is expected to return a value within the same range (values outside the range can be used for overshoot). The return value of the method is then used for interpolation between initial and final value. Note that the parameter passed to the method is still subject to the tweener's own easing. @@ -141,7 +141,7 @@ Allows interpolating the value with a custom easing function. The provided ``int .. rst-class:: classref-method -:ref:`PropertyTweener` **set_delay** **(** :ref:`float` delay **)** +:ref:`PropertyTweener` **set_delay**\ (\ delay\: :ref:`float`\ ) Sets the time in seconds after which the **PropertyTweener** will start interpolating. By default there's no delay. @@ -153,7 +153,7 @@ Sets the time in seconds after which the **PropertyTweener** will start interpol .. rst-class:: classref-method -:ref:`PropertyTweener` **set_ease** **(** :ref:`EaseType` ease **)** +:ref:`PropertyTweener` **set_ease**\ (\ ease\: :ref:`EaseType`\ ) Sets the type of used easing from :ref:`EaseType`. If not set, the default easing is used from the :ref:`Tween` that contains this Tweener. @@ -165,7 +165,7 @@ Sets the type of used easing from :ref:`EaseType`. If not s .. rst-class:: classref-method -:ref:`PropertyTweener` **set_trans** **(** :ref:`TransitionType` trans **)** +:ref:`PropertyTweener` **set_trans**\ (\ trans\: :ref:`TransitionType`\ ) Sets the type of used transition from :ref:`TransitionType`. If not set, the default transition is used from the :ref:`Tween` that contains this Tweener. @@ -176,3 +176,4 @@ Sets the type of used transition from :ref:`TransitionType` value **)** -- :ref:`Vector2` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_size**\ (\ ) The quad's size in 3D units. @@ -71,3 +71,4 @@ The quad's size in 3D units. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_quaternion.rst b/classes/class_quaternion.rst index edbc3c40647..d309291c444 100644 --- a/classes/class_quaternion.rst +++ b/classes/class_quaternion.rst @@ -62,19 +62,19 @@ Constructors .. table:: :widths: auto - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`Quaternion` **(** **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`Quaternion` **(** :ref:`Quaternion` from **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`Quaternion` **(** :ref:`Vector3` arc_from, :ref:`Vector3` arc_to **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`Quaternion` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`Quaternion` **(** :ref:`Basis` from **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`Quaternion` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`Quaternion`\ (\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`Quaternion`\ (\ from\: :ref:`Quaternion`\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`Quaternion`\ (\ arc_from\: :ref:`Vector3`, arc_to\: :ref:`Vector3`\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`Quaternion`\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`Quaternion`\ (\ from\: :ref:`Basis`\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`Quaternion`\ (\ x\: :ref:`float`, y\: :ref:`float`, z\: :ref:`float`, w\: :ref:`float`\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -84,45 +84,45 @@ Methods .. table:: :widths: auto - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`angle_to` **(** :ref:`Quaternion` to **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`dot` **(** :ref:`Quaternion` with **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`exp` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`from_euler` **(** :ref:`Vector3` euler **)** |static| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_angle` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_axis` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_euler` **(** :ref:`int` order=2 **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`inverse` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Quaternion` to **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_finite` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_normalized` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length_squared` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`log` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`normalized` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`slerp` **(** :ref:`Quaternion` to, :ref:`float` weight **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`slerpni` **(** :ref:`Quaternion` to, :ref:`float` weight **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`spherical_cubic_interpolate` **(** :ref:`Quaternion` b, :ref:`Quaternion` pre_a, :ref:`Quaternion` post_b, :ref:`float` weight **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`spherical_cubic_interpolate_in_time` **(** :ref:`Quaternion` b, :ref:`Quaternion` pre_a, :ref:`Quaternion` post_b, :ref:`float` weight, :ref:`float` b_t, :ref:`float` pre_a_t, :ref:`float` post_b_t **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`angle_to`\ (\ to\: :ref:`Quaternion`\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`dot`\ (\ with\: :ref:`Quaternion`\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`exp`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`from_euler`\ (\ euler\: :ref:`Vector3`\ ) |static| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_angle`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_axis`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_euler`\ (\ order\: :ref:`int` = 2\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`inverse`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equal_approx`\ (\ to\: :ref:`Quaternion`\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_normalized`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length_squared`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`log`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`normalized`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`slerp`\ (\ to\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`slerpni`\ (\ to\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`spherical_cubic_interpolate`\ (\ b\: :ref:`Quaternion`, pre_a\: :ref:`Quaternion`, post_b\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`spherical_cubic_interpolate_in_time`\ (\ b\: :ref:`Quaternion`, pre_a\: :ref:`Quaternion`, post_b\: :ref:`Quaternion`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -132,33 +132,33 @@ Operators .. table:: :widths: auto - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Quaternion` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`operator *` **(** :ref:`Quaternion` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator *` **(** :ref:`Vector3` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`operator *` **(** :ref:`float` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`operator *` **(** :ref:`int` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`operator +` **(** :ref:`Quaternion` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`operator -` **(** :ref:`Quaternion` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`operator /` **(** :ref:`float` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`operator /` **(** :ref:`int` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Quaternion` right **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator []` **(** :ref:`int` index **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`operator unary+` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`operator unary-` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Quaternion`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`operator *`\ (\ right\: :ref:`Quaternion`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator *`\ (\ right\: :ref:`Vector3`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`operator *`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`operator *`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`operator +`\ (\ right\: :ref:`Quaternion`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`operator -`\ (\ right\: :ref:`Quaternion`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`operator /`\ (\ right\: :ref:`float`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`operator /`\ (\ right\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Quaternion`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`operator unary+`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`operator unary-`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -251,7 +251,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Quaternion` **Quaternion** **(** **)** +:ref:`Quaternion` **Quaternion**\ (\ ) Constructs a default-initialized quaternion with all components set to ``0``. @@ -261,7 +261,7 @@ Constructs a default-initialized quaternion with all components set to ``0``. .. rst-class:: classref-constructor -:ref:`Quaternion` **Quaternion** **(** :ref:`Quaternion` from **)** +:ref:`Quaternion` **Quaternion**\ (\ from\: :ref:`Quaternion`\ ) Constructs a **Quaternion** as a copy of the given **Quaternion**. @@ -271,7 +271,7 @@ Constructs a **Quaternion** as a copy of the given **Quaternion**. .. rst-class:: classref-constructor -:ref:`Quaternion` **Quaternion** **(** :ref:`Vector3` arc_from, :ref:`Vector3` arc_to **)** +:ref:`Quaternion` **Quaternion**\ (\ arc_from\: :ref:`Vector3`, arc_to\: :ref:`Vector3`\ ) Constructs a quaternion representing the shortest arc between two points on the surface of a sphere with a radius of ``1.0``. @@ -281,7 +281,7 @@ Constructs a quaternion representing the shortest arc between two points on the .. rst-class:: classref-constructor -:ref:`Quaternion` **Quaternion** **(** :ref:`Vector3` axis, :ref:`float` angle **)** +:ref:`Quaternion` **Quaternion**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) Constructs a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. @@ -291,7 +291,7 @@ Constructs a quaternion that will rotate around the given axis by the specified .. rst-class:: classref-constructor -:ref:`Quaternion` **Quaternion** **(** :ref:`Basis` from **)** +:ref:`Quaternion` **Quaternion**\ (\ from\: :ref:`Basis`\ ) Constructs a quaternion from the given :ref:`Basis`. @@ -301,7 +301,7 @@ Constructs a quaternion from the given :ref:`Basis`. .. rst-class:: classref-constructor -:ref:`Quaternion` **Quaternion** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** +:ref:`Quaternion` **Quaternion**\ (\ x\: :ref:`float`, y\: :ref:`float`, z\: :ref:`float`, w\: :ref:`float`\ ) Constructs a quaternion defined by the given values. @@ -318,7 +318,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **angle_to** **(** :ref:`Quaternion` to **)** |const| +:ref:`float` **angle_to**\ (\ to\: :ref:`Quaternion`\ ) |const| Returns the angle between this quaternion and ``to``. This is the magnitude of the angle you would need to rotate by to get from one to the other. @@ -332,7 +332,7 @@ Returns the angle between this quaternion and ``to``. This is the magnitude of t .. rst-class:: classref-method -:ref:`float` **dot** **(** :ref:`Quaternion` with **)** |const| +:ref:`float` **dot**\ (\ with\: :ref:`Quaternion`\ ) |const| Returns the dot product of two quaternions. @@ -344,7 +344,7 @@ Returns the dot product of two quaternions. .. rst-class:: classref-method -:ref:`Quaternion` **exp** **(** **)** |const| +:ref:`Quaternion` **exp**\ (\ ) |const| 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. @@ -356,7 +356,7 @@ Returns the exponential of this quaternion. The rotation axis of the result is t .. rst-class:: classref-method -:ref:`Quaternion` **from_euler** **(** :ref:`Vector3` euler **)** |static| +:ref:`Quaternion` **from_euler**\ (\ euler\: :ref:`Vector3`\ ) |static| Constructs a Quaternion from Euler angles in YXZ rotation order. @@ -368,7 +368,7 @@ Constructs a Quaternion from Euler angles in YXZ rotation order. .. rst-class:: classref-method -:ref:`float` **get_angle** **(** **)** |const| +:ref:`float` **get_angle**\ (\ ) |const| Returns the angle of the rotation represented by this quaternion. @@ -382,7 +382,7 @@ Returns the angle of the rotation represented by this quaternion. .. rst-class:: classref-method -:ref:`Vector3` **get_axis** **(** **)** |const| +:ref:`Vector3` **get_axis**\ (\ ) |const| Returns the rotation axis of the rotation represented by this quaternion. @@ -394,7 +394,7 @@ Returns the rotation axis of the rotation represented by this quaternion. .. rst-class:: classref-method -:ref:`Vector3` **get_euler** **(** :ref:`int` order=2 **)** |const| +:ref:`Vector3` **get_euler**\ (\ order\: :ref:`int` = 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 for possible values. The returned vector contains the rotation angles in the format (X angle, Y angle, Z angle). @@ -406,7 +406,7 @@ Returns the quaternion's rotation in the form of Euler angles. The Euler order d .. rst-class:: classref-method -:ref:`Quaternion` **inverse** **(** **)** |const| +:ref:`Quaternion` **inverse**\ (\ ) |const| Returns the inverse of the quaternion. @@ -418,7 +418,7 @@ Returns the inverse of the quaternion. .. rst-class:: classref-method -:ref:`bool` **is_equal_approx** **(** :ref:`Quaternion` to **)** |const| +:ref:`bool` **is_equal_approx**\ (\ to\: :ref:`Quaternion`\ ) |const| Returns ``true`` if this quaternion and ``to`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. @@ -430,7 +430,7 @@ Returns ``true`` if this quaternion and ``to`` are approximately equal, by runni .. rst-class:: classref-method -:ref:`bool` **is_finite** **(** **)** |const| +:ref:`bool` **is_finite**\ (\ ) |const| Returns ``true`` if this quaternion is finite, by calling :ref:`@GlobalScope.is_finite` on each component. @@ -442,7 +442,7 @@ Returns ``true`` if this quaternion is finite, by calling :ref:`@GlobalScope.is_ .. rst-class:: classref-method -:ref:`bool` **is_normalized** **(** **)** |const| +:ref:`bool` **is_normalized**\ (\ ) |const| Returns whether the quaternion is normalized or not. @@ -454,7 +454,7 @@ Returns whether the quaternion is normalized or not. .. rst-class:: classref-method -:ref:`float` **length** **(** **)** |const| +:ref:`float` **length**\ (\ ) |const| Returns the length of the quaternion. @@ -466,7 +466,7 @@ Returns the length of the quaternion. .. rst-class:: classref-method -:ref:`float` **length_squared** **(** **)** |const| +:ref:`float` **length_squared**\ (\ ) |const| Returns the length of the quaternion, squared. @@ -478,7 +478,7 @@ Returns the length of the quaternion, squared. .. rst-class:: classref-method -:ref:`Quaternion` **log** **(** **)** |const| +:ref:`Quaternion` **log**\ (\ ) |const| Returns the logarithm of this quaternion. The vector part of the result is the rotation axis of this quaternion multiplied by its rotation angle, the real part of the result is zero. @@ -490,7 +490,7 @@ Returns the logarithm of this quaternion. The vector part of the result is the r .. rst-class:: classref-method -:ref:`Quaternion` **normalized** **(** **)** |const| +:ref:`Quaternion` **normalized**\ (\ ) |const| Returns a copy of the quaternion, normalized to unit length. @@ -502,7 +502,7 @@ Returns a copy of the quaternion, normalized to unit length. .. rst-class:: classref-method -:ref:`Quaternion` **slerp** **(** :ref:`Quaternion` to, :ref:`float` weight **)** |const| +:ref:`Quaternion` **slerp**\ (\ to\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| Returns the result of the spherical linear interpolation between this quaternion and ``to`` by amount ``weight``. @@ -516,7 +516,7 @@ Returns the result of the spherical linear interpolation between this quaternion .. rst-class:: classref-method -:ref:`Quaternion` **slerpni** **(** :ref:`Quaternion` to, :ref:`float` weight **)** |const| +:ref:`Quaternion` **slerpni**\ (\ to\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |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. @@ -528,7 +528,7 @@ Returns the result of the spherical linear interpolation between this quaternion .. rst-class:: classref-method -:ref:`Quaternion` **spherical_cubic_interpolate** **(** :ref:`Quaternion` b, :ref:`Quaternion` pre_a, :ref:`Quaternion` post_b, :ref:`float` weight **)** |const| +:ref:`Quaternion` **spherical_cubic_interpolate**\ (\ b\: :ref:`Quaternion`, pre_a\: :ref:`Quaternion`, post_b\: :ref:`Quaternion`, weight\: :ref:`float`\ ) |const| Performs a spherical cubic interpolation between quaternions ``pre_a``, this vector, ``b``, and ``post_b``, by the given amount ``weight``. @@ -540,7 +540,7 @@ Performs a spherical cubic interpolation between quaternions ``pre_a``, this vec .. rst-class:: classref-method -:ref:`Quaternion` **spherical_cubic_interpolate_in_time** **(** :ref:`Quaternion` b, :ref:`Quaternion` pre_a, :ref:`Quaternion` post_b, :ref:`float` weight, :ref:`float` b_t, :ref:`float` pre_a_t, :ref:`float` post_b_t **)** |const| +:ref:`Quaternion` **spherical_cubic_interpolate_in_time**\ (\ b\: :ref:`Quaternion`, pre_a\: :ref:`Quaternion`, post_b\: :ref:`Quaternion`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| Performs a spherical cubic interpolation between quaternions ``pre_a``, this vector, ``b``, and ``post_b``, by the given amount ``weight``. @@ -559,7 +559,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Quaternion` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Quaternion`\ ) Returns ``true`` if the quaternions are not equal. @@ -573,7 +573,7 @@ Returns ``true`` if the quaternions are not equal. .. rst-class:: classref-operator -:ref:`Quaternion` **operator *** **(** :ref:`Quaternion` right **)** +:ref:`Quaternion` **operator ***\ (\ right\: :ref:`Quaternion`\ ) 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). @@ -585,7 +585,7 @@ Composes these two quaternions by multiplying them together. This has the effect .. rst-class:: classref-operator -:ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3`\ ) Rotates (multiplies) the :ref:`Vector3` by the given **Quaternion**. @@ -597,7 +597,7 @@ Rotates (multiplies) the :ref:`Vector3` by the given **Quaternion .. rst-class:: classref-operator -:ref:`Quaternion` **operator *** **(** :ref:`float` right **)** +:ref:`Quaternion` **operator ***\ (\ right\: :ref:`float`\ ) 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. @@ -609,7 +609,7 @@ Multiplies each component of the **Quaternion** by the given value. This operati .. rst-class:: classref-operator -:ref:`Quaternion` **operator *** **(** :ref:`int` right **)** +:ref:`Quaternion` **operator ***\ (\ right\: :ref:`int`\ ) 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. @@ -621,7 +621,7 @@ Multiplies each component of the **Quaternion** by the given value. This operati .. rst-class:: classref-operator -:ref:`Quaternion` **operator +** **(** :ref:`Quaternion` right **)** +:ref:`Quaternion` **operator +**\ (\ right\: :ref:`Quaternion`\ ) 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. @@ -633,7 +633,7 @@ Adds each component of the left **Quaternion** to the right **Quaternion**. This .. rst-class:: classref-operator -:ref:`Quaternion` **operator -** **(** :ref:`Quaternion` right **)** +:ref:`Quaternion` **operator -**\ (\ right\: :ref:`Quaternion`\ ) 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. @@ -645,7 +645,7 @@ Subtracts each component of the left **Quaternion** by the right **Quaternion**. .. rst-class:: classref-operator -:ref:`Quaternion` **operator /** **(** :ref:`float` right **)** +:ref:`Quaternion` **operator /**\ (\ right\: :ref:`float`\ ) 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. @@ -657,7 +657,7 @@ Divides each component of the **Quaternion** by the given value. This operation .. rst-class:: classref-operator -:ref:`Quaternion` **operator /** **(** :ref:`int` right **)** +:ref:`Quaternion` **operator /**\ (\ right\: :ref:`int`\ ) 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. @@ -669,7 +669,7 @@ Divides each component of the **Quaternion** by the given value. This operation .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`Quaternion` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Quaternion`\ ) Returns ``true`` if the quaternions are exactly equal. @@ -683,7 +683,7 @@ Returns ``true`` if the quaternions are exactly equal. .. rst-class:: classref-operator -:ref:`float` **operator []** **(** :ref:`int` index **)** +:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) 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``. @@ -695,7 +695,7 @@ Access quaternion components using their index. ``q[0]`` is equivalent to ``q.x` .. rst-class:: classref-operator -:ref:`Quaternion` **operator unary+** **(** **)** +:ref:`Quaternion` **operator unary+**\ (\ ) Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -707,7 +707,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`Quaternion` **operator unary-** **(** **)** +:ref:`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. @@ -718,3 +718,4 @@ Returns the negative value of the **Quaternion**. This is the same as writing `` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_randomnumbergenerator.rst b/classes/class_randomnumbergenerator.rst index b55418429e5..00005b0d090 100644 --- a/classes/class_randomnumbergenerator.rst +++ b/classes/class_randomnumbergenerator.rst @@ -60,19 +60,19 @@ Methods .. table:: :widths: auto - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`randf` **(** **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`randf_range` **(** :ref:`float` from, :ref:`float` to **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`randfn` **(** :ref:`float` mean=0.0, :ref:`float` deviation=1.0 **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`randi` **(** **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`randi_range` **(** :ref:`int` from, :ref:`int` to **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`randomize` **(** **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`randf`\ (\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`randf_range`\ (\ from\: :ref:`float`, to\: :ref:`float`\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`randfn`\ (\ mean\: :ref:`float` = 0.0, deviation\: :ref:`float` = 1.0\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`randi`\ (\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`randi_range`\ (\ from\: :ref:`int`, to\: :ref:`int`\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`randomize`\ (\ ) | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -91,8 +91,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_seed** **(** :ref:`int` value **)** -- :ref:`int` **get_seed** **(** **)** +- |void| **set_seed**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_seed**\ (\ ) Initializes the random number generator state based on the given seed value. A given seed will give a reproducible sequence of pseudo-random numbers. @@ -120,8 +120,8 @@ Initializes the random number generator state based on the given seed value. A g .. rst-class:: classref-property-setget -- void **set_state** **(** :ref:`int` value **)** -- :ref:`int` **get_state** **(** **)** +- |void| **set_state**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_state**\ (\ ) The current state of the random number generator. Save and restore this property to restore the generator to a previous state: @@ -151,7 +151,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **randf** **(** **)** +:ref:`float` **randf**\ (\ ) Returns a pseudo-random float between ``0.0`` and ``1.0`` (inclusive). @@ -163,7 +163,7 @@ Returns a pseudo-random float between ``0.0`` and ``1.0`` (inclusive). .. rst-class:: classref-method -:ref:`float` **randf_range** **(** :ref:`float` from, :ref:`float` to **)** +:ref:`float` **randf_range**\ (\ from\: :ref:`float`, to\: :ref:`float`\ ) Returns a pseudo-random float between ``from`` and ``to`` (inclusive). @@ -175,7 +175,7 @@ Returns a pseudo-random float between ``from`` and ``to`` (inclusive). .. rst-class:: classref-method -:ref:`float` **randfn** **(** :ref:`float` mean=0.0, :ref:`float` deviation=1.0 **)** +:ref:`float` **randfn**\ (\ mean\: :ref:`float` = 0.0, deviation\: :ref:`float` = 1.0\ ) Returns a `normally-distributed `__ pseudo-random number, using Box-Muller transform with the specified ``mean`` and a standard ``deviation``. This is also called Gaussian distribution. @@ -187,7 +187,7 @@ Returns a `normally-distributed ` **randi** **(** **)** +:ref:`int` **randi**\ (\ ) Returns a pseudo-random 32-bit unsigned integer between ``0`` and ``4294967295`` (inclusive). @@ -199,7 +199,7 @@ Returns a pseudo-random 32-bit unsigned integer between ``0`` and ``4294967295`` .. rst-class:: classref-method -:ref:`int` **randi_range** **(** :ref:`int` from, :ref:`int` to **)** +:ref:`int` **randi_range**\ (\ from\: :ref:`int`, to\: :ref:`int`\ ) Returns a pseudo-random 32-bit signed integer between ``from`` and ``to`` (inclusive). @@ -211,7 +211,7 @@ Returns a pseudo-random 32-bit signed integer between ``from`` and ``to`` (inclu .. rst-class:: classref-method -void **randomize** **(** **)** +|void| **randomize**\ (\ ) Sets up a time-based seed for this **RandomNumberGenerator** instance. Unlike the :ref:`@GlobalScope` random number generation functions, different **RandomNumberGenerator** instances can use different seeds. @@ -222,3 +222,4 @@ Sets up a time-based seed for this **RandomNumberGenerator** instance. Unlike th .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_range.rst b/classes/class_range.rst index 77eedd214ab..e06c1badf74 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -48,7 +48,7 @@ Properties +--------------------------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rounded` | ``false`` | +--------------------------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`SizeFlags`\> | size_flags_vertical | ``0`` (overrides :ref:`Control`) | + | |bitfield|\[:ref:`SizeFlags`\] | size_flags_vertical | ``0`` (overrides :ref:`Control`) | +--------------------------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`float` | :ref:`step` | ``0.01`` | +--------------------------------------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ @@ -63,15 +63,15 @@ Methods .. table:: :widths: auto - +------+----------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_value_changed` **(** :ref:`float` new_value **)** |virtual| | - +------+----------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_value_no_signal` **(** :ref:`float` value **)** | - +------+----------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`share` **(** :ref:`Node` with **)** | - +------+----------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`unshare` **(** **)** | - +------+----------------------------------------------------------------------------------------------------------------------------+ + +--------+-------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_value_changed`\ (\ new_value\: :ref:`float`\ ) |virtual| | + +--------+-------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_value_no_signal`\ (\ value\: :ref:`float`\ ) | + +--------+-------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`share`\ (\ with\: :ref:`Node`\ ) | + +--------+-------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unshare`\ (\ ) | + +--------+-------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -86,7 +86,7 @@ Signals .. rst-class:: classref-signal -**changed** **(** **)** +**changed**\ (\ ) Emitted when :ref:`min_value`, :ref:`max_value`, :ref:`page`, or :ref:`step` change. @@ -98,7 +98,7 @@ Emitted when :ref:`min_value`, :ref:`max_value` value **)** +**value_changed**\ (\ value\: :ref:`float`\ ) Emitted when :ref:`value` changes. When used on a :ref:`Slider`, this is called continuously while dragging (potentially every frame). If you are performing an expensive operation in a function connected to :ref:`value_changed`, consider using a *debouncing* :ref:`Timer` to call the function less often. @@ -121,8 +121,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_allow_greater** **(** :ref:`bool` value **)** -- :ref:`bool` **is_greater_allowed** **(** **)** +- |void| **set_allow_greater**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_greater_allowed**\ (\ ) If ``true``, :ref:`value` may be greater than :ref:`max_value`. @@ -138,8 +138,8 @@ If ``true``, :ref:`value` may be greater than :ref:` .. rst-class:: classref-property-setget -- void **set_allow_lesser** **(** :ref:`bool` value **)** -- :ref:`bool` **is_lesser_allowed** **(** **)** +- |void| **set_allow_lesser**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_lesser_allowed**\ (\ ) If ``true``, :ref:`value` may be less than :ref:`min_value`. @@ -155,8 +155,8 @@ If ``true``, :ref:`value` may be less than :ref:`min .. rst-class:: classref-property-setget -- void **set_exp_ratio** **(** :ref:`bool` value **)** -- :ref:`bool` **is_ratio_exp** **(** **)** +- |void| **set_exp_ratio**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_ratio_exp**\ (\ ) If ``true``, and :ref:`min_value` is greater than 0, :ref:`value` will be represented exponentially rather than linearly. @@ -172,8 +172,8 @@ If ``true``, and :ref:`min_value` is greater tha .. rst-class:: classref-property-setget -- void **set_max** **(** :ref:`float` value **)** -- :ref:`float` **get_max** **(** **)** +- |void| **set_max**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_max**\ (\ ) Maximum value. Range is clamped if :ref:`value` is greater than :ref:`max_value`. @@ -189,8 +189,8 @@ Maximum value. Range is clamped if :ref:`value` is g .. rst-class:: classref-property-setget -- void **set_min** **(** :ref:`float` value **)** -- :ref:`float` **get_min** **(** **)** +- |void| **set_min**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_min**\ (\ ) Minimum value. Range is clamped if :ref:`value` is less than :ref:`min_value`. @@ -206,8 +206,8 @@ Minimum value. Range is clamped if :ref:`value` is l .. rst-class:: classref-property-setget -- void **set_page** **(** :ref:`float` value **)** -- :ref:`float` **get_page** **(** **)** +- |void| **set_page**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_page**\ (\ ) Page size. Used mainly for :ref:`ScrollBar`. ScrollBar's length is its size multiplied by :ref:`page` over the difference between :ref:`min_value` and :ref:`max_value`. @@ -223,8 +223,8 @@ Page size. Used mainly for :ref:`ScrollBar`. ScrollBar's length .. rst-class:: classref-property-setget -- void **set_as_ratio** **(** :ref:`float` value **)** -- :ref:`float` **get_as_ratio** **(** **)** +- |void| **set_as_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_as_ratio**\ (\ ) The value mapped between 0 and 1. @@ -240,8 +240,8 @@ The value mapped between 0 and 1. .. rst-class:: classref-property-setget -- void **set_use_rounded_values** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_rounded_values** **(** **)** +- |void| **set_use_rounded_values**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_rounded_values**\ (\ ) If ``true``, :ref:`value` will always be rounded to the nearest integer. @@ -257,8 +257,8 @@ If ``true``, :ref:`value` will always be rounded to .. rst-class:: classref-property-setget -- void **set_step** **(** :ref:`float` value **)** -- :ref:`float` **get_step** **(** **)** +- |void| **set_step**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_step**\ (\ ) If greater than 0, :ref:`value` will always be rounded to a multiple of this property's value. If :ref:`rounded` is also ``true``, :ref:`value` will first be rounded to a multiple of this property's value, then rounded to the nearest integer. @@ -274,8 +274,8 @@ If greater than 0, :ref:`value` will always be round .. rst-class:: classref-property-setget -- void **set_value** **(** :ref:`float` value **)** -- :ref:`float` **get_value** **(** **)** +- |void| **set_value**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_value**\ (\ ) Range's current value. Changing this property (even via code) will trigger :ref:`value_changed` signal. Use :ref:`set_value_no_signal` if you want to avoid it. @@ -292,7 +292,7 @@ Method Descriptions .. rst-class:: classref-method -void **_value_changed** **(** :ref:`float` new_value **)** |virtual| +|void| **_value_changed**\ (\ new_value\: :ref:`float`\ ) |virtual| Called when the **Range**'s value is changed (following the same conditions as :ref:`value_changed`). @@ -304,7 +304,7 @@ Called when the **Range**'s value is changed (following the same conditions as : .. rst-class:: classref-method -void **set_value_no_signal** **(** :ref:`float` value **)** +|void| **set_value_no_signal**\ (\ value\: :ref:`float`\ ) Sets the **Range**'s current value to the specified ``value``, without emitting the :ref:`value_changed` signal. @@ -316,7 +316,7 @@ Sets the **Range**'s current value to the specified ``value``, without emitting .. rst-class:: classref-method -void **share** **(** :ref:`Node` with **)** +|void| **share**\ (\ with\: :ref:`Node`\ ) Binds two **Range**\ s together along with any ranges previously grouped with either of them. When any of range's member variables change, it will share the new value with all other ranges in its group. @@ -328,7 +328,7 @@ Binds two **Range**\ s together along with any ranges previously grouped with ei .. rst-class:: classref-method -void **unshare** **(** **)** +|void| **unshare**\ (\ ) Stops the **Range** from sharing its member variables with any other. @@ -339,3 +339,4 @@ Stops the **Range** from sharing its member variables with any other. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index 2f63fbcd354..8498461d05a 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -66,35 +66,35 @@ Methods .. table:: :widths: auto - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_exception` **(** :ref:`CollisionObject2D` node **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_exceptions` **(** **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`force_raycast_update` **(** **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_collider` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_collider_rid` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collider_shape` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_collision_mask_value` **(** :ref:`int` layer_number **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_collision_point` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_colliding` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_exception` **(** :ref:`CollisionObject2D` node **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_exception`\ (\ node\: :ref:`CollisionObject2D`\ ) | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_exception_rid`\ (\ rid\: :ref:`RID`\ ) | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_exceptions`\ (\ ) | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_raycast_update`\ (\ ) | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_collider`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_collider_rid`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collider_shape`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_collision_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_collision_normal`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_collision_point`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_colliding`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_exception`\ (\ node\: :ref:`CollisionObject2D`\ ) | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_exception_rid`\ (\ rid\: :ref:`RID`\ ) | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -113,8 +113,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_collide_with_areas** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_areas_enabled** **(** **)** +- |void| **set_collide_with_areas**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_areas_enabled**\ (\ ) If ``true``, collisions with :ref:`Area2D`\ s will be reported. @@ -130,8 +130,8 @@ If ``true``, collisions with :ref:`Area2D`\ s will be reported. .. rst-class:: classref-property-setget -- void **set_collide_with_bodies** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_bodies_enabled** **(** **)** +- |void| **set_collide_with_bodies**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_bodies_enabled**\ (\ ) If ``true``, collisions with :ref:`PhysicsBody2D`\ s will be reported. @@ -147,8 +147,8 @@ If ``true``, collisions with :ref:`PhysicsBody2D`\ s will b .. rst-class:: classref-property-setget -- void **set_collision_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_mask** **(** **)** +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information. @@ -164,8 +164,8 @@ The ray's collision mask. Only objects in at least one collision layer enabled i .. rst-class:: classref-property-setget -- void **set_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_enabled** **(** **)** +- |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_enabled**\ (\ ) If ``true``, collisions will be reported. @@ -181,8 +181,8 @@ If ``true``, collisions will be reported. .. rst-class:: classref-property-setget -- void **set_exclude_parent_body** **(** :ref:`bool` value **)** -- :ref:`bool` **get_exclude_parent_body** **(** **)** +- |void| **set_exclude_parent_body**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_exclude_parent_body**\ (\ ) If ``true``, the parent node will be excluded from collision detection. @@ -198,8 +198,8 @@ If ``true``, the parent node will be excluded from collision detection. .. rst-class:: classref-property-setget -- void **set_hit_from_inside** **(** :ref:`bool` value **)** -- :ref:`bool` **is_hit_from_inside_enabled** **(** **)** +- |void| **set_hit_from_inside**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_hit_from_inside_enabled**\ (\ ) If ``true``, the ray will detect a hit when starting inside shapes. In this case the collision normal will be ``Vector2(0, 0)``. Does not affect concave polygon shapes. @@ -215,8 +215,8 @@ If ``true``, the ray will detect a hit when starting inside shapes. In this case .. rst-class:: classref-property-setget -- void **set_target_position** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_target_position** **(** **)** +- |void| **set_target_position**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_target_position**\ (\ ) The ray's destination point, relative to the RayCast's ``position``. @@ -233,7 +233,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_exception** **(** :ref:`CollisionObject2D` node **)** +|void| **add_exception**\ (\ node\: :ref:`CollisionObject2D`\ ) Adds a collision exception so the ray does not report collisions with the specified :ref:`CollisionObject2D` node. @@ -245,7 +245,7 @@ Adds a collision exception so the ray does not report collisions with the specif .. rst-class:: classref-method -void **add_exception_rid** **(** :ref:`RID` rid **)** +|void| **add_exception_rid**\ (\ rid\: :ref:`RID`\ ) Adds a collision exception so the ray does not report collisions with the specified :ref:`RID`. @@ -257,7 +257,7 @@ Adds a collision exception so the ray does not report collisions with the specif .. rst-class:: classref-method -void **clear_exceptions** **(** **)** +|void| **clear_exceptions**\ (\ ) Removes all collision exceptions for this ray. @@ -269,7 +269,7 @@ Removes all collision exceptions for this ray. .. rst-class:: classref-method -void **force_raycast_update** **(** **)** +|void| **force_raycast_update**\ (\ ) Updates the collision information for the ray immediately, without waiting for the next ``_physics_process`` call. Use this method, for example, when the ray or its parent has changed state. @@ -283,7 +283,7 @@ Updates the collision information for the ray immediately, without waiting for t .. rst-class:: classref-method -:ref:`Object` **get_collider** **(** **)** |const| +:ref:`Object` **get_collider**\ (\ ) |const| Returns the first object that the ray intersects, or ``null`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). @@ -295,7 +295,7 @@ Returns the first object that the ray intersects, or ``null`` if no object is in .. rst-class:: classref-method -:ref:`RID` **get_collider_rid** **(** **)** |const| +:ref:`RID` **get_collider_rid**\ (\ ) |const| Returns the :ref:`RID` of the first object that the ray intersects, or an empty :ref:`RID` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). @@ -307,7 +307,7 @@ Returns the :ref:`RID` of the first object that the ray intersects, o .. rst-class:: classref-method -:ref:`int` **get_collider_shape** **(** **)** |const| +:ref:`int` **get_collider_shape**\ (\ ) |const| Returns the shape ID of the first object that the ray intersects, or ``0`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). @@ -319,7 +319,7 @@ Returns the shape ID of the first object that the ray intersects, or ``0`` if no .. rst-class:: classref-method -:ref:`bool` **get_collision_mask_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -331,7 +331,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_collision_normal** **(** **)** |const| +:ref:`Vector2` **get_collision_normal**\ (\ ) |const| Returns the normal of the intersecting object's shape at the collision point, or ``Vector2(0, 0)`` if the ray starts inside the shape and :ref:`hit_from_inside` is ``true``. @@ -343,7 +343,7 @@ Returns the normal of the intersecting object's shape at the collision point, or .. rst-class:: classref-method -:ref:`Vector2` **get_collision_point** **(** **)** |const| +:ref:`Vector2` **get_collision_point**\ (\ ) |const| Returns the collision point at which the ray intersects the closest object. If :ref:`hit_from_inside` is ``true`` and the ray starts inside of a collision shape, this function will return the origin point of the ray. @@ -357,7 +357,7 @@ Returns the collision point at which the ray intersects the closest object. If : .. rst-class:: classref-method -:ref:`bool` **is_colliding** **(** **)** |const| +:ref:`bool` **is_colliding**\ (\ ) |const| Returns whether any object is intersecting with the ray's vector (considering the vector length). @@ -369,7 +369,7 @@ Returns whether any object is intersecting with the ray's vector (considering th .. rst-class:: classref-method -void **remove_exception** **(** :ref:`CollisionObject2D` node **)** +|void| **remove_exception**\ (\ node\: :ref:`CollisionObject2D`\ ) Removes a collision exception so the ray does report collisions with the specified :ref:`CollisionObject2D` node. @@ -381,7 +381,7 @@ Removes a collision exception so the ray does report collisions with the specifi .. rst-class:: classref-method -void **remove_exception_rid** **(** :ref:`RID` rid **)** +|void| **remove_exception_rid**\ (\ rid\: :ref:`RID`\ ) Removes a collision exception so the ray does report collisions with the specified :ref:`RID`. @@ -393,7 +393,7 @@ Removes a collision exception so the ray does report collisions with the specifi .. rst-class:: classref-method -void **set_collision_mask_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. @@ -404,3 +404,4 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_raycast3d.rst b/classes/class_raycast3d.rst index 9ec0c5ced01..9b67b07195a 100644 --- a/classes/class_raycast3d.rst +++ b/classes/class_raycast3d.rst @@ -74,37 +74,37 @@ Methods .. table:: :widths: auto - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_exception` **(** :ref:`CollisionObject3D` node **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_exceptions` **(** **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`force_raycast_update` **(** **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_collider` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_collider_rid` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collider_shape` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collision_face_index` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_collision_mask_value` **(** :ref:`int` layer_number **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_collision_normal` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_collision_point` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_colliding` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_exception` **(** :ref:`CollisionObject3D` node **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_exception`\ (\ node\: :ref:`CollisionObject3D`\ ) | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_exception_rid`\ (\ rid\: :ref:`RID`\ ) | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_exceptions`\ (\ ) | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_raycast_update`\ (\ ) | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_collider`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_collider_rid`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collider_shape`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collision_face_index`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_collision_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_collision_normal`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_collision_point`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_colliding`\ (\ ) |const| | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_exception`\ (\ node\: :ref:`CollisionObject3D`\ ) | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_exception_rid`\ (\ rid\: :ref:`RID`\ ) | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -123,8 +123,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_collide_with_areas** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_areas_enabled** **(** **)** +- |void| **set_collide_with_areas**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_areas_enabled**\ (\ ) If ``true``, collisions with :ref:`Area3D`\ s will be reported. @@ -140,8 +140,8 @@ If ``true``, collisions with :ref:`Area3D`\ s will be reported. .. rst-class:: classref-property-setget -- void **set_collide_with_bodies** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_bodies_enabled** **(** **)** +- |void| **set_collide_with_bodies**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_bodies_enabled**\ (\ ) If ``true``, collisions with :ref:`PhysicsBody3D`\ s will be reported. @@ -157,8 +157,8 @@ If ``true``, collisions with :ref:`PhysicsBody3D`\ s will b .. rst-class:: classref-property-setget -- void **set_collision_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_mask** **(** **)** +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information. @@ -174,8 +174,8 @@ The ray's collision mask. Only objects in at least one collision layer enabled i .. rst-class:: classref-property-setget -- void **set_debug_shape_custom_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_debug_shape_custom_color** **(** **)** +- |void| **set_debug_shape_custom_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_debug_shape_custom_color**\ (\ ) The custom color to use to draw the shape in the editor and at run-time if **Visible Collision Shapes** is enabled in the **Debug** menu. This color will be highlighted at run-time if the **RayCast3D** is colliding with something. @@ -193,8 +193,8 @@ If set to ``Color(0.0, 0.0, 0.0)`` (by default), the color set in :ref:`ProjectS .. rst-class:: classref-property-setget -- void **set_debug_shape_thickness** **(** :ref:`int` value **)** -- :ref:`int` **get_debug_shape_thickness** **(** **)** +- |void| **set_debug_shape_thickness**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_debug_shape_thickness**\ (\ ) If set to ``1``, a line is used as the debug shape. Otherwise, a truncated pyramid is drawn to represent the **RayCast3D**. Requires **Visible Collision Shapes** to be enabled in the **Debug** menu for the debug shape to be visible at run-time. @@ -210,8 +210,8 @@ If set to ``1``, a line is used as the debug shape. Otherwise, a truncated pyram .. rst-class:: classref-property-setget -- void **set_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_enabled** **(** **)** +- |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_enabled**\ (\ ) If ``true``, collisions will be reported. @@ -227,8 +227,8 @@ If ``true``, collisions will be reported. .. rst-class:: classref-property-setget -- void **set_exclude_parent_body** **(** :ref:`bool` value **)** -- :ref:`bool` **get_exclude_parent_body** **(** **)** +- |void| **set_exclude_parent_body**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_exclude_parent_body**\ (\ ) If ``true``, collisions will be ignored for this RayCast3D's immediate parent. @@ -244,8 +244,8 @@ If ``true``, collisions will be ignored for this RayCast3D's immediate parent. .. rst-class:: classref-property-setget -- void **set_hit_back_faces** **(** :ref:`bool` value **)** -- :ref:`bool` **is_hit_back_faces_enabled** **(** **)** +- |void| **set_hit_back_faces**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_hit_back_faces_enabled**\ (\ ) If ``true``, the ray will hit back faces with concave polygon shapes with back face enabled or heightmap shapes. @@ -261,8 +261,8 @@ If ``true``, the ray will hit back faces with concave polygon shapes with back f .. rst-class:: classref-property-setget -- void **set_hit_from_inside** **(** :ref:`bool` value **)** -- :ref:`bool` **is_hit_from_inside_enabled** **(** **)** +- |void| **set_hit_from_inside**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_hit_from_inside_enabled**\ (\ ) If ``true``, the ray will detect a hit when starting inside shapes. In this case the collision normal will be ``Vector3(0, 0, 0)``. Does not affect shapes with no volume like concave polygon or heightmap. @@ -278,8 +278,8 @@ If ``true``, the ray will detect a hit when starting inside shapes. In this case .. rst-class:: classref-property-setget -- void **set_target_position** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_target_position** **(** **)** +- |void| **set_target_position**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_target_position**\ (\ ) The ray's destination point, relative to the RayCast's ``position``. @@ -296,7 +296,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_exception** **(** :ref:`CollisionObject3D` node **)** +|void| **add_exception**\ (\ node\: :ref:`CollisionObject3D`\ ) Adds a collision exception so the ray does not report collisions with the specified :ref:`CollisionObject3D` node. @@ -308,7 +308,7 @@ Adds a collision exception so the ray does not report collisions with the specif .. rst-class:: classref-method -void **add_exception_rid** **(** :ref:`RID` rid **)** +|void| **add_exception_rid**\ (\ rid\: :ref:`RID`\ ) Adds a collision exception so the ray does not report collisions with the specified :ref:`RID`. @@ -320,7 +320,7 @@ Adds a collision exception so the ray does not report collisions with the specif .. rst-class:: classref-method -void **clear_exceptions** **(** **)** +|void| **clear_exceptions**\ (\ ) Removes all collision exceptions for this ray. @@ -332,7 +332,7 @@ Removes all collision exceptions for this ray. .. rst-class:: classref-method -void **force_raycast_update** **(** **)** +|void| **force_raycast_update**\ (\ ) Updates the collision information for the ray immediately, without waiting for the next ``_physics_process`` call. Use this method, for example, when the ray or its parent has changed state. @@ -346,7 +346,7 @@ Updates the collision information for the ray immediately, without waiting for t .. rst-class:: classref-method -:ref:`Object` **get_collider** **(** **)** |const| +:ref:`Object` **get_collider**\ (\ ) |const| Returns the first object that the ray intersects, or ``null`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). @@ -358,7 +358,7 @@ Returns the first object that the ray intersects, or ``null`` if no object is in .. rst-class:: classref-method -:ref:`RID` **get_collider_rid** **(** **)** |const| +:ref:`RID` **get_collider_rid**\ (\ ) |const| Returns the :ref:`RID` of the first object that the ray intersects, or an empty :ref:`RID` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). @@ -370,7 +370,7 @@ Returns the :ref:`RID` of the first object that the ray intersects, o .. rst-class:: classref-method -:ref:`int` **get_collider_shape** **(** **)** |const| +:ref:`int` **get_collider_shape**\ (\ ) |const| Returns the shape ID of the first object that the ray intersects, or ``0`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). @@ -382,7 +382,7 @@ Returns the shape ID of the first object that the ray intersects, or ``0`` if no .. rst-class:: classref-method -:ref:`int` **get_collision_face_index** **(** **)** |const| +:ref:`int` **get_collision_face_index**\ (\ ) |const| Returns the collision object's face index at the collision point, or ``-1`` if the shape intersecting the ray is not a :ref:`ConcavePolygonShape3D`. @@ -394,7 +394,7 @@ Returns the collision object's face index at the collision point, or ``-1`` if t .. rst-class:: classref-method -:ref:`bool` **get_collision_mask_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -406,7 +406,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_collision_normal** **(** **)** |const| +:ref:`Vector3` **get_collision_normal**\ (\ ) |const| Returns the normal of the intersecting object's shape at the collision point, or ``Vector3(0, 0, 0)`` if the ray starts inside the shape and :ref:`hit_from_inside` is ``true``. @@ -418,7 +418,7 @@ Returns the normal of the intersecting object's shape at the collision point, or .. rst-class:: classref-method -:ref:`Vector3` **get_collision_point** **(** **)** |const| +:ref:`Vector3` **get_collision_point**\ (\ ) |const| Returns the collision point at which the ray intersects the closest object. If :ref:`hit_from_inside` is ``true`` and the ray starts inside of a collision shape, this function will return the origin point of the ray. @@ -432,7 +432,7 @@ Returns the collision point at which the ray intersects the closest object. If : .. rst-class:: classref-method -:ref:`bool` **is_colliding** **(** **)** |const| +:ref:`bool` **is_colliding**\ (\ ) |const| Returns whether any object is intersecting with the ray's vector (considering the vector length). @@ -444,7 +444,7 @@ Returns whether any object is intersecting with the ray's vector (considering th .. rst-class:: classref-method -void **remove_exception** **(** :ref:`CollisionObject3D` node **)** +|void| **remove_exception**\ (\ node\: :ref:`CollisionObject3D`\ ) Removes a collision exception so the ray does report collisions with the specified :ref:`CollisionObject3D` node. @@ -456,7 +456,7 @@ Removes a collision exception so the ray does report collisions with the specifi .. rst-class:: classref-method -void **remove_exception_rid** **(** :ref:`RID` rid **)** +|void| **remove_exception_rid**\ (\ rid\: :ref:`RID`\ ) Removes a collision exception so the ray does report collisions with the specified :ref:`RID`. @@ -468,7 +468,7 @@ Removes a collision exception so the ray does report collisions with the specifi .. rst-class:: classref-method -void **set_collision_mask_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. @@ -479,3 +479,4 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rdattachmentformat.rst b/classes/class_rdattachmentformat.rst index 6b734ce01fc..c0cdc528458 100644 --- a/classes/class_rdattachmentformat.rst +++ b/classes/class_rdattachmentformat.rst @@ -54,8 +54,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_format** **(** :ref:`DataFormat` value **)** -- :ref:`DataFormat` **get_format** **(** **)** +- |void| **set_format**\ (\ value\: :ref:`DataFormat`\ ) +- :ref:`DataFormat` **get_format**\ (\ ) The attachment's data format. @@ -71,8 +71,8 @@ The attachment's data format. .. rst-class:: classref-property-setget -- void **set_samples** **(** :ref:`TextureSamples` value **)** -- :ref:`TextureSamples` **get_samples** **(** **)** +- |void| **set_samples**\ (\ value\: :ref:`TextureSamples`\ ) +- :ref:`TextureSamples` **get_samples**\ (\ ) The number of samples used when sampling the attachment. @@ -88,8 +88,8 @@ The number of samples used when sampling the attachment. .. rst-class:: classref-property-setget -- void **set_usage_flags** **(** :ref:`int` value **)** -- :ref:`int` **get_usage_flags** **(** **)** +- |void| **set_usage_flags**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_usage_flags**\ (\ ) The attachment's usage flags, which determine what can be done with it. @@ -100,3 +100,4 @@ The attachment's usage flags, which determine what can be done with it. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rdframebufferpass.rst b/classes/class_rdframebufferpass.rst index 0ee84fb3747..0d4364ddbbd 100644 --- a/classes/class_rdframebufferpass.rst +++ b/classes/class_rdframebufferpass.rst @@ -79,8 +79,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_color_attachments** **(** :ref:`PackedInt32Array` value **)** -- :ref:`PackedInt32Array` **get_color_attachments** **(** **)** +- |void| **set_color_attachments**\ (\ value\: :ref:`PackedInt32Array`\ ) +- :ref:`PackedInt32Array` **get_color_attachments**\ (\ ) Color attachments in order starting from 0. If this attachment is not used by the shader, pass ATTACHMENT_UNUSED to skip. @@ -96,8 +96,8 @@ Color attachments in order starting from 0. If this attachment is not used by th .. rst-class:: classref-property-setget -- void **set_depth_attachment** **(** :ref:`int` value **)** -- :ref:`int` **get_depth_attachment** **(** **)** +- |void| **set_depth_attachment**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_depth_attachment**\ (\ ) Depth attachment. ATTACHMENT_UNUSED should be used if no depth buffer is required for this pass. @@ -113,8 +113,8 @@ Depth attachment. ATTACHMENT_UNUSED should be used if no depth buffer is require .. rst-class:: classref-property-setget -- void **set_input_attachments** **(** :ref:`PackedInt32Array` value **)** -- :ref:`PackedInt32Array` **get_input_attachments** **(** **)** +- |void| **set_input_attachments**\ (\ value\: :ref:`PackedInt32Array`\ ) +- :ref:`PackedInt32Array` **get_input_attachments**\ (\ ) Used for multipass framebuffers (more than one render pass). Converts an attachment to an input. Make sure to also supply it properly in the :ref:`RDUniform` for the uniform set. @@ -130,8 +130,8 @@ Used for multipass framebuffers (more than one render pass). Converts an attachm .. rst-class:: classref-property-setget -- void **set_preserve_attachments** **(** :ref:`PackedInt32Array` value **)** -- :ref:`PackedInt32Array` **get_preserve_attachments** **(** **)** +- |void| **set_preserve_attachments**\ (\ value\: :ref:`PackedInt32Array`\ ) +- :ref:`PackedInt32Array` **get_preserve_attachments**\ (\ ) Attachments to preserve in this pass (otherwise they are erased). @@ -147,8 +147,8 @@ Attachments to preserve in this pass (otherwise they are erased). .. rst-class:: classref-property-setget -- void **set_resolve_attachments** **(** :ref:`PackedInt32Array` value **)** -- :ref:`PackedInt32Array` **get_resolve_attachments** **(** **)** +- |void| **set_resolve_attachments**\ (\ value\: :ref:`PackedInt32Array`\ ) +- :ref:`PackedInt32Array` **get_resolve_attachments**\ (\ ) If the color attachments are multisampled, non-multisampled resolve attachments can be provided. @@ -159,3 +159,4 @@ If the color attachments are multisampled, non-multisampled resolve attachments .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rdpipelinecolorblendstate.rst b/classes/class_rdpipelinecolorblendstate.rst index eba406bedbc..5892e7cfc81 100644 --- a/classes/class_rdpipelinecolorblendstate.rst +++ b/classes/class_rdpipelinecolorblendstate.rst @@ -29,15 +29,15 @@ Properties .. table:: :widths: auto - +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+-----------------------+ - | :ref:`RDPipelineColorBlendStateAttachment[]` | :ref:`attachments` | ``[]`` | - +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+-----------------------+ - | :ref:`Color` | :ref:`blend_constant` | ``Color(0, 0, 0, 1)`` | - +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+-----------------------+ - | :ref:`bool` | :ref:`enable_logic_op` | ``false`` | - +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+-----------------------+ - | :ref:`LogicOperation` | :ref:`logic_op` | ``0`` | - +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+-----------------------+ + +--------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`Array`\[:ref:`RDPipelineColorBlendStateAttachment`\] | :ref:`attachments` | ``[]`` | + +--------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`blend_constant` | ``Color(0, 0, 0, 1)`` | + +--------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`enable_logic_op` | ``false`` | + +--------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+-----------------------+ + | :ref:`LogicOperation` | :ref:`logic_op` | ``0`` | + +--------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-section-separator @@ -52,12 +52,12 @@ Property Descriptions .. rst-class:: classref-property -:ref:`RDPipelineColorBlendStateAttachment[]` **attachments** = ``[]`` +:ref:`Array`\[:ref:`RDPipelineColorBlendStateAttachment`\] **attachments** = ``[]`` .. rst-class:: classref-property-setget -- void **set_attachments** **(** :ref:`RDPipelineColorBlendStateAttachment[]` value **)** -- :ref:`RDPipelineColorBlendStateAttachment[]` **get_attachments** **(** **)** +- |void| **set_attachments**\ (\ value\: :ref:`Array`\[:ref:`RDPipelineColorBlendStateAttachment`\]\ ) +- :ref:`Array`\[:ref:`RDPipelineColorBlendStateAttachment`\] **get_attachments**\ (\ ) The attachments that are blended together. @@ -73,8 +73,8 @@ The attachments that are blended together. .. rst-class:: classref-property-setget -- void **set_blend_constant** **(** :ref:`Color` value **)** -- :ref:`Color` **get_blend_constant** **(** **)** +- |void| **set_blend_constant**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_blend_constant**\ (\ ) The constant color to blend with. See also :ref:`RenderingDevice.draw_list_set_blend_constants`. @@ -90,8 +90,8 @@ The constant color to blend with. See also :ref:`RenderingDevice.draw_list_set_b .. rst-class:: classref-property-setget -- void **set_enable_logic_op** **(** :ref:`bool` value **)** -- :ref:`bool` **get_enable_logic_op** **(** **)** +- |void| **set_enable_logic_op**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_enable_logic_op**\ (\ ) If ``true``, performs the logic operation defined in :ref:`logic_op`. @@ -107,8 +107,8 @@ If ``true``, performs the logic operation defined in :ref:`logic_op` value **)** -- :ref:`LogicOperation` **get_logic_op** **(** **)** +- |void| **set_logic_op**\ (\ value\: :ref:`LogicOperation`\ ) +- :ref:`LogicOperation` **get_logic_op**\ (\ ) The logic operation to perform for blending. Only effective if :ref:`enable_logic_op` is ``true``. @@ -119,3 +119,4 @@ The logic operation to perform for blending. Only effective if :ref:`enable_logi .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rdpipelinecolorblendstateattachment.rst b/classes/class_rdpipelinecolorblendstateattachment.rst index 7bcda5d0d44..dd7f0829c20 100644 --- a/classes/class_rdpipelinecolorblendstateattachment.rst +++ b/classes/class_rdpipelinecolorblendstateattachment.rst @@ -128,9 +128,9 @@ Methods .. table:: :widths: auto - +------+--------------------------------------------------------------------------------------------+ - | void | :ref:`set_as_mix` **(** **)** | - +------+--------------------------------------------------------------------------------------------+ + +--------+--------------------------------------------------------------------------------------+ + | |void| | :ref:`set_as_mix`\ (\ ) | + +--------+--------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -149,8 +149,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_alpha_blend_op** **(** :ref:`BlendOperation` value **)** -- :ref:`BlendOperation` **get_alpha_blend_op** **(** **)** +- |void| **set_alpha_blend_op**\ (\ value\: :ref:`BlendOperation`\ ) +- :ref:`BlendOperation` **get_alpha_blend_op**\ (\ ) The blend mode to use for the alpha channel. @@ -166,8 +166,8 @@ The blend mode to use for the alpha channel. .. rst-class:: classref-property-setget -- void **set_color_blend_op** **(** :ref:`BlendOperation` value **)** -- :ref:`BlendOperation` **get_color_blend_op** **(** **)** +- |void| **set_color_blend_op**\ (\ value\: :ref:`BlendOperation`\ ) +- :ref:`BlendOperation` **get_color_blend_op**\ (\ ) The blend mode to use for the red/green/blue color channels. @@ -183,8 +183,8 @@ The blend mode to use for the red/green/blue color channels. .. rst-class:: classref-property-setget -- void **set_dst_alpha_blend_factor** **(** :ref:`BlendFactor` value **)** -- :ref:`BlendFactor` **get_dst_alpha_blend_factor** **(** **)** +- |void| **set_dst_alpha_blend_factor**\ (\ value\: :ref:`BlendFactor`\ ) +- :ref:`BlendFactor` **get_dst_alpha_blend_factor**\ (\ ) Controls how the blend factor for the alpha channel is determined based on the destination's fragments. @@ -200,8 +200,8 @@ Controls how the blend factor for the alpha channel is determined based on the d .. rst-class:: classref-property-setget -- void **set_dst_color_blend_factor** **(** :ref:`BlendFactor` value **)** -- :ref:`BlendFactor` **get_dst_color_blend_factor** **(** **)** +- |void| **set_dst_color_blend_factor**\ (\ value\: :ref:`BlendFactor`\ ) +- :ref:`BlendFactor` **get_dst_color_blend_factor**\ (\ ) Controls how the blend factor for the color channels is determined based on the destination's fragments. @@ -217,8 +217,8 @@ Controls how the blend factor for the color channels is determined based on the .. rst-class:: classref-property-setget -- void **set_enable_blend** **(** :ref:`bool` value **)** -- :ref:`bool` **get_enable_blend** **(** **)** +- |void| **set_enable_blend**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_enable_blend**\ (\ ) If ``true``, performs blending between the source and destination according to the factors defined in :ref:`src_color_blend_factor`, :ref:`dst_color_blend_factor`, :ref:`src_alpha_blend_factor` and :ref:`dst_alpha_blend_factor`. The blend modes :ref:`color_blend_op` and :ref:`alpha_blend_op` are also taken into account, with :ref:`write_r`, :ref:`write_g`, :ref:`write_b` and :ref:`write_a` controlling the output. @@ -234,8 +234,8 @@ If ``true``, performs blending between the source and destination according to t .. rst-class:: classref-property-setget -- void **set_src_alpha_blend_factor** **(** :ref:`BlendFactor` value **)** -- :ref:`BlendFactor` **get_src_alpha_blend_factor** **(** **)** +- |void| **set_src_alpha_blend_factor**\ (\ value\: :ref:`BlendFactor`\ ) +- :ref:`BlendFactor` **get_src_alpha_blend_factor**\ (\ ) Controls how the blend factor for the alpha channel is determined based on the source's fragments. @@ -251,8 +251,8 @@ Controls how the blend factor for the alpha channel is determined based on the s .. rst-class:: classref-property-setget -- void **set_src_color_blend_factor** **(** :ref:`BlendFactor` value **)** -- :ref:`BlendFactor` **get_src_color_blend_factor** **(** **)** +- |void| **set_src_color_blend_factor**\ (\ value\: :ref:`BlendFactor`\ ) +- :ref:`BlendFactor` **get_src_color_blend_factor**\ (\ ) Controls how the blend factor for the color channels is determined based on the source's fragments. @@ -268,8 +268,8 @@ Controls how the blend factor for the color channels is determined based on the .. rst-class:: classref-property-setget -- void **set_write_a** **(** :ref:`bool` value **)** -- :ref:`bool` **get_write_a** **(** **)** +- |void| **set_write_a**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_write_a**\ (\ ) If ``true``, writes the new alpha channel to the final result. @@ -285,8 +285,8 @@ If ``true``, writes the new alpha channel to the final result. .. rst-class:: classref-property-setget -- void **set_write_b** **(** :ref:`bool` value **)** -- :ref:`bool` **get_write_b** **(** **)** +- |void| **set_write_b**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_write_b**\ (\ ) If ``true``, writes the new blue color channel to the final result. @@ -302,8 +302,8 @@ If ``true``, writes the new blue color channel to the final result. .. rst-class:: classref-property-setget -- void **set_write_g** **(** :ref:`bool` value **)** -- :ref:`bool` **get_write_g** **(** **)** +- |void| **set_write_g**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_write_g**\ (\ ) If ``true``, writes the new green color channel to the final result. @@ -319,8 +319,8 @@ If ``true``, writes the new green color channel to the final result. .. rst-class:: classref-property-setget -- void **set_write_r** **(** :ref:`bool` value **)** -- :ref:`bool` **get_write_r** **(** **)** +- |void| **set_write_r**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_write_r**\ (\ ) If ``true``, writes the new red color channel to the final result. @@ -337,7 +337,7 @@ Method Descriptions .. rst-class:: classref-method -void **set_as_mix** **(** **)** +|void| **set_as_mix**\ (\ ) Convenience method to perform standard mix blending with straight (non-premultiplied) alpha. This sets :ref:`enable_blend` to ``true``, :ref:`src_color_blend_factor` to :ref:`RenderingDevice.BLEND_FACTOR_SRC_ALPHA`, :ref:`dst_color_blend_factor` to :ref:`RenderingDevice.BLEND_FACTOR_ONE_MINUS_SRC_ALPHA`, :ref:`src_alpha_blend_factor` to :ref:`RenderingDevice.BLEND_FACTOR_SRC_ALPHA` and :ref:`dst_alpha_blend_factor` to :ref:`RenderingDevice.BLEND_FACTOR_ONE_MINUS_SRC_ALPHA`. @@ -348,3 +348,4 @@ Convenience method to perform standard mix blending with straight (non-premultip .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rdpipelinedepthstencilstate.rst b/classes/class_rdpipelinedepthstencilstate.rst index 325ff3d0a64..912cf1e5cda 100644 --- a/classes/class_rdpipelinedepthstencilstate.rst +++ b/classes/class_rdpipelinedepthstencilstate.rst @@ -90,8 +90,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_back_op_compare** **(** :ref:`CompareOperator` value **)** -- :ref:`CompareOperator` **get_back_op_compare** **(** **)** +- |void| **set_back_op_compare**\ (\ value\: :ref:`CompareOperator`\ ) +- :ref:`CompareOperator` **get_back_op_compare**\ (\ ) The method used for comparing the previous back stencil value and :ref:`back_op_reference`. @@ -107,8 +107,8 @@ The method used for comparing the previous back stencil value and :ref:`back_op_ .. rst-class:: classref-property-setget -- void **set_back_op_compare_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_back_op_compare_mask** **(** **)** +- |void| **set_back_op_compare_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_back_op_compare_mask**\ (\ ) Selects which bits from the back stencil value will be compared. @@ -124,8 +124,8 @@ Selects which bits from the back stencil value will be compared. .. rst-class:: classref-property-setget -- void **set_back_op_depth_fail** **(** :ref:`StencilOperation` value **)** -- :ref:`StencilOperation` **get_back_op_depth_fail** **(** **)** +- |void| **set_back_op_depth_fail**\ (\ value\: :ref:`StencilOperation`\ ) +- :ref:`StencilOperation` **get_back_op_depth_fail**\ (\ ) The operation to perform on the stencil buffer for back pixels that pass the stencil test but fail the depth test. @@ -141,8 +141,8 @@ The operation to perform on the stencil buffer for back pixels that pass the ste .. rst-class:: classref-property-setget -- void **set_back_op_fail** **(** :ref:`StencilOperation` value **)** -- :ref:`StencilOperation` **get_back_op_fail** **(** **)** +- |void| **set_back_op_fail**\ (\ value\: :ref:`StencilOperation`\ ) +- :ref:`StencilOperation` **get_back_op_fail**\ (\ ) The operation to perform on the stencil buffer for back pixels that fail the stencil test @@ -158,8 +158,8 @@ The operation to perform on the stencil buffer for back pixels that fail the ste .. rst-class:: classref-property-setget -- void **set_back_op_pass** **(** :ref:`StencilOperation` value **)** -- :ref:`StencilOperation` **get_back_op_pass** **(** **)** +- |void| **set_back_op_pass**\ (\ value\: :ref:`StencilOperation`\ ) +- :ref:`StencilOperation` **get_back_op_pass**\ (\ ) The operation to perform on the stencil buffer for back pixels that pass the stencil test. @@ -175,8 +175,8 @@ The operation to perform on the stencil buffer for back pixels that pass the ste .. rst-class:: classref-property-setget -- void **set_back_op_reference** **(** :ref:`int` value **)** -- :ref:`int` **get_back_op_reference** **(** **)** +- |void| **set_back_op_reference**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_back_op_reference**\ (\ ) The value the previous back stencil value will be compared to. @@ -192,8 +192,8 @@ The value the previous back stencil value will be compared to. .. rst-class:: classref-property-setget -- void **set_back_op_write_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_back_op_write_mask** **(** **)** +- |void| **set_back_op_write_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_back_op_write_mask**\ (\ ) Selects which bits from the back stencil value will be changed. @@ -209,8 +209,8 @@ Selects which bits from the back stencil value will be changed. .. rst-class:: classref-property-setget -- void **set_depth_compare_operator** **(** :ref:`CompareOperator` value **)** -- :ref:`CompareOperator` **get_depth_compare_operator** **(** **)** +- |void| **set_depth_compare_operator**\ (\ value\: :ref:`CompareOperator`\ ) +- :ref:`CompareOperator` **get_depth_compare_operator**\ (\ ) The method used for comparing the previous and current depth values. @@ -226,8 +226,8 @@ The method used for comparing the previous and current depth values. .. rst-class:: classref-property-setget -- void **set_depth_range_max** **(** :ref:`float` value **)** -- :ref:`float` **get_depth_range_max** **(** **)** +- |void| **set_depth_range_max**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_depth_range_max**\ (\ ) The maximum depth that returns true for :ref:`enable_depth_range`. @@ -243,8 +243,8 @@ The maximum depth that returns true for :ref:`enable_depth_range` value **)** -- :ref:`float` **get_depth_range_min** **(** **)** +- |void| **set_depth_range_min**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_depth_range_min**\ (\ ) The minimum depth that returns true for :ref:`enable_depth_range`. @@ -260,8 +260,8 @@ The minimum depth that returns true for :ref:`enable_depth_range` value **)** -- :ref:`bool` **get_enable_depth_range** **(** **)** +- |void| **set_enable_depth_range**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_enable_depth_range**\ (\ ) If ``true``, each depth value will be tested to see if it is between :ref:`depth_range_min` and :ref:`depth_range_max`. If it is outside of these values, it is discarded. @@ -277,8 +277,8 @@ If ``true``, each depth value will be tested to see if it is between :ref:`depth .. rst-class:: classref-property-setget -- void **set_enable_depth_test** **(** :ref:`bool` value **)** -- :ref:`bool` **get_enable_depth_test** **(** **)** +- |void| **set_enable_depth_test**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_enable_depth_test**\ (\ ) If ``true``, enables depth testing which allows objects to be automatically occluded by other objects based on their depth. This also allows objects to be partially occluded by other objects. If ``false``, objects will appear in the order they were drawn (like in Godot's 2D renderer). @@ -294,8 +294,8 @@ If ``true``, enables depth testing which allows objects to be automatically occl .. rst-class:: classref-property-setget -- void **set_enable_depth_write** **(** :ref:`bool` value **)** -- :ref:`bool` **get_enable_depth_write** **(** **)** +- |void| **set_enable_depth_write**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_enable_depth_write**\ (\ ) If ``true``, writes to the depth buffer whenever the depth test returns true. Only works when enable_depth_test is also true. @@ -311,8 +311,8 @@ If ``true``, writes to the depth buffer whenever the depth test returns true. On .. rst-class:: classref-property-setget -- void **set_enable_stencil** **(** :ref:`bool` value **)** -- :ref:`bool` **get_enable_stencil** **(** **)** +- |void| **set_enable_stencil**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_enable_stencil**\ (\ ) 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. @@ -328,8 +328,8 @@ If ``true``, enables stencil testing. There are separate stencil buffers for fro .. rst-class:: classref-property-setget -- void **set_front_op_compare** **(** :ref:`CompareOperator` value **)** -- :ref:`CompareOperator` **get_front_op_compare** **(** **)** +- |void| **set_front_op_compare**\ (\ value\: :ref:`CompareOperator`\ ) +- :ref:`CompareOperator` **get_front_op_compare**\ (\ ) The method used for comparing the previous front stencil value and :ref:`front_op_reference`. @@ -345,8 +345,8 @@ The method used for comparing the previous front stencil value and :ref:`front_o .. rst-class:: classref-property-setget -- void **set_front_op_compare_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_front_op_compare_mask** **(** **)** +- |void| **set_front_op_compare_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_front_op_compare_mask**\ (\ ) Selects which bits from the front stencil value will be compared. @@ -362,8 +362,8 @@ Selects which bits from the front stencil value will be compared. .. rst-class:: classref-property-setget -- void **set_front_op_depth_fail** **(** :ref:`StencilOperation` value **)** -- :ref:`StencilOperation` **get_front_op_depth_fail** **(** **)** +- |void| **set_front_op_depth_fail**\ (\ value\: :ref:`StencilOperation`\ ) +- :ref:`StencilOperation` **get_front_op_depth_fail**\ (\ ) The operation to perform on the stencil buffer for front pixels that pass the stencil test but fail the depth test. @@ -379,8 +379,8 @@ The operation to perform on the stencil buffer for front pixels that pass the st .. rst-class:: classref-property-setget -- void **set_front_op_fail** **(** :ref:`StencilOperation` value **)** -- :ref:`StencilOperation` **get_front_op_fail** **(** **)** +- |void| **set_front_op_fail**\ (\ value\: :ref:`StencilOperation`\ ) +- :ref:`StencilOperation` **get_front_op_fail**\ (\ ) The operation to perform on the stencil buffer for front pixels that fail the stencil test. @@ -396,8 +396,8 @@ The operation to perform on the stencil buffer for front pixels that fail the st .. rst-class:: classref-property-setget -- void **set_front_op_pass** **(** :ref:`StencilOperation` value **)** -- :ref:`StencilOperation` **get_front_op_pass** **(** **)** +- |void| **set_front_op_pass**\ (\ value\: :ref:`StencilOperation`\ ) +- :ref:`StencilOperation` **get_front_op_pass**\ (\ ) The operation to perform on the stencil buffer for front pixels that pass the stencil test. @@ -413,8 +413,8 @@ The operation to perform on the stencil buffer for front pixels that pass the st .. rst-class:: classref-property-setget -- void **set_front_op_reference** **(** :ref:`int` value **)** -- :ref:`int` **get_front_op_reference** **(** **)** +- |void| **set_front_op_reference**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_front_op_reference**\ (\ ) The value the previous front stencil value will be compared to. @@ -430,8 +430,8 @@ The value the previous front stencil value will be compared to. .. rst-class:: classref-property-setget -- void **set_front_op_write_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_front_op_write_mask** **(** **)** +- |void| **set_front_op_write_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_front_op_write_mask**\ (\ ) Selects which bits from the front stencil value will be changed. @@ -442,3 +442,4 @@ Selects which bits from the front stencil value will be changed. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rdpipelinemultisamplestate.rst b/classes/class_rdpipelinemultisamplestate.rst index f0cf83eebaf..26ad77d7091 100644 --- a/classes/class_rdpipelinemultisamplestate.rst +++ b/classes/class_rdpipelinemultisamplestate.rst @@ -40,7 +40,7 @@ Properties +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+-----------+ | :ref:`TextureSamples` | :ref:`sample_count` | ``0`` | +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+-----------+ - | :ref:`int[]` | :ref:`sample_masks` | ``[]`` | + | :ref:`Array`\[:ref:`int`\] | :ref:`sample_masks` | ``[]`` | +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-section-separator @@ -60,8 +60,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_enable_alpha_to_coverage** **(** :ref:`bool` value **)** -- :ref:`bool` **get_enable_alpha_to_coverage** **(** **)** +- |void| **set_enable_alpha_to_coverage**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_enable_alpha_to_coverage**\ (\ ) If ``true``, alpha to coverage is enabled. This generates a temporary coverage value based on the alpha component of the fragment's first color output. This allows alpha transparency to make use of multisample antialiasing. @@ -77,8 +77,8 @@ If ``true``, alpha to coverage is enabled. This generates a temporary coverage v .. rst-class:: classref-property-setget -- void **set_enable_alpha_to_one** **(** :ref:`bool` value **)** -- :ref:`bool` **get_enable_alpha_to_one** **(** **)** +- |void| **set_enable_alpha_to_one**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_enable_alpha_to_one**\ (\ ) If ``true``, alpha is forced to either ``0.0`` or ``1.0``. This allows hardening the edges of antialiased alpha transparencies. Only relevant if :ref:`enable_alpha_to_coverage` is ``true``. @@ -94,8 +94,8 @@ If ``true``, alpha is forced to either ``0.0`` or ``1.0``. This allows hardening .. rst-class:: classref-property-setget -- void **set_enable_sample_shading** **(** :ref:`bool` value **)** -- :ref:`bool` **get_enable_sample_shading** **(** **)** +- |void| **set_enable_sample_shading**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_enable_sample_shading**\ (\ ) If ``true``, enables per-sample shading which replaces MSAA by SSAA. This provides higher quality antialiasing that works with transparent (alpha scissor) edges. This has a very high performance cost. See also :ref:`min_sample_shading`. See the `per-sample shading Vulkan documentation `__ for more details. @@ -111,8 +111,8 @@ If ``true``, enables per-sample shading which replaces MSAA by SSAA. This provid .. rst-class:: classref-property-setget -- void **set_min_sample_shading** **(** :ref:`float` value **)** -- :ref:`float` **get_min_sample_shading** **(** **)** +- |void| **set_min_sample_shading**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_min_sample_shading**\ (\ ) The multiplier of :ref:`sample_count` that determines how many samples are performed for each fragment. Must be between ``0.0`` and ``1.0`` (inclusive). Only effective if :ref:`enable_sample_shading` is ``true``. If :ref:`min_sample_shading` is ``1.0``, fragment invocation must only read from the coverage index sample. Tile image access must not be used if :ref:`enable_sample_shading` is *not* ``1.0``. @@ -128,8 +128,8 @@ The multiplier of :ref:`sample_count` value **)** -- :ref:`TextureSamples` **get_sample_count** **(** **)** +- |void| **set_sample_count**\ (\ value\: :ref:`TextureSamples`\ ) +- :ref:`TextureSamples` **get_sample_count**\ (\ ) The number of MSAA samples (or SSAA samples if :ref:`enable_sample_shading` is ``true``) to perform. Higher values result in better antialiasing, at the cost of performance. @@ -141,12 +141,12 @@ The number of MSAA samples (or SSAA samples if :ref:`enable_sample_shading` **sample_masks** = ``[]`` +:ref:`Array`\[:ref:`int`\] **sample_masks** = ``[]`` .. rst-class:: classref-property-setget -- void **set_sample_masks** **(** :ref:`int[]` value **)** -- :ref:`int[]` **get_sample_masks** **(** **)** +- |void| **set_sample_masks**\ (\ value\: :ref:`Array`\[:ref:`int`\]\ ) +- :ref:`Array`\[:ref:`int`\] **get_sample_masks**\ (\ ) The sample mask array. See the `sample mask Vulkan documentation `__ for more details. @@ -157,3 +157,4 @@ The sample mask array. See the `sample mask Vulkan documentation ` value **)** -- :ref:`PolygonCullMode` **get_cull_mode** **(** **)** +- |void| **set_cull_mode**\ (\ value\: :ref:`PolygonCullMode`\ ) +- :ref:`PolygonCullMode` **get_cull_mode**\ (\ ) The cull mode to use when drawing polygons, which determines whether front faces or backfaces are hidden. @@ -87,8 +87,8 @@ The cull mode to use when drawing polygons, which determines whether front faces .. rst-class:: classref-property-setget -- void **set_depth_bias_clamp** **(** :ref:`float` value **)** -- :ref:`float` **get_depth_bias_clamp** **(** **)** +- |void| **set_depth_bias_clamp**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_depth_bias_clamp**\ (\ ) A limit for how much each depth value can be offset. If negative, it serves as a minimum value, but if positive, it serves as a maximum value. @@ -104,8 +104,8 @@ A limit for how much each depth value can be offset. If negative, it serves as a .. rst-class:: classref-property-setget -- void **set_depth_bias_constant_factor** **(** :ref:`float` value **)** -- :ref:`float` **get_depth_bias_constant_factor** **(** **)** +- |void| **set_depth_bias_constant_factor**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_depth_bias_constant_factor**\ (\ ) A constant offset added to each depth value. Applied after :ref:`depth_bias_slope_factor`. @@ -121,8 +121,8 @@ A constant offset added to each depth value. Applied after :ref:`depth_bias_slop .. rst-class:: classref-property-setget -- void **set_depth_bias_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **get_depth_bias_enabled** **(** **)** +- |void| **set_depth_bias_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_depth_bias_enabled**\ (\ ) If ``true``, each generated depth value will by offset by some amount. The specific amount is generated per polygon based on the values of :ref:`depth_bias_slope_factor` and :ref:`depth_bias_constant_factor`. @@ -138,8 +138,8 @@ If ``true``, each generated depth value will by offset by some amount. The speci .. rst-class:: classref-property-setget -- void **set_depth_bias_slope_factor** **(** :ref:`float` value **)** -- :ref:`float` **get_depth_bias_slope_factor** **(** **)** +- |void| **set_depth_bias_slope_factor**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_depth_bias_slope_factor**\ (\ ) A constant scale applied to the slope of each polygons' depth. Applied before :ref:`depth_bias_constant_factor`. @@ -155,8 +155,8 @@ A constant scale applied to the slope of each polygons' depth. Applied before :r .. rst-class:: classref-property-setget -- void **set_discard_primitives** **(** :ref:`bool` value **)** -- :ref:`bool` **get_discard_primitives** **(** **)** +- |void| **set_discard_primitives**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_discard_primitives**\ (\ ) If ``true``, primitives are discarded immediately before the rasterization stage. @@ -172,8 +172,8 @@ If ``true``, primitives are discarded immediately before the rasterization stage .. rst-class:: classref-property-setget -- void **set_enable_depth_clamp** **(** :ref:`bool` value **)** -- :ref:`bool` **get_enable_depth_clamp** **(** **)** +- |void| **set_enable_depth_clamp**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_enable_depth_clamp**\ (\ ) If ``true``, clamps depth values according to the minimum and maximum depth of the associated viewport. @@ -189,8 +189,8 @@ If ``true``, clamps depth values according to the minimum and maximum depth of t .. rst-class:: classref-property-setget -- void **set_front_face** **(** :ref:`PolygonFrontFace` value **)** -- :ref:`PolygonFrontFace` **get_front_face** **(** **)** +- |void| **set_front_face**\ (\ value\: :ref:`PolygonFrontFace`\ ) +- :ref:`PolygonFrontFace` **get_front_face**\ (\ ) The winding order to use to determine which face of a triangle is considered its front face. @@ -206,8 +206,8 @@ The winding order to use to determine which face of a triangle is considered its .. rst-class:: classref-property-setget -- void **set_line_width** **(** :ref:`float` value **)** -- :ref:`float` **get_line_width** **(** **)** +- |void| **set_line_width**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_line_width**\ (\ ) The line width to use when drawing lines (in pixels). Thick lines may not be supported on all hardware. @@ -223,8 +223,8 @@ The line width to use when drawing lines (in pixels). Thick lines may not be sup .. rst-class:: classref-property-setget -- void **set_patch_control_points** **(** :ref:`int` value **)** -- :ref:`int` **get_patch_control_points** **(** **)** +- |void| **set_patch_control_points**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_patch_control_points**\ (\ ) The number of control points to use when drawing a patch with tessellation enabled. Higher values result in higher quality at the cost of performance. @@ -240,8 +240,8 @@ The number of control points to use when drawing a patch with tessellation enabl .. rst-class:: classref-property-setget -- void **set_wireframe** **(** :ref:`bool` value **)** -- :ref:`bool` **get_wireframe** **(** **)** +- |void| **set_wireframe**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_wireframe**\ (\ ) If ``true``, performs wireframe rendering for triangles instead of flat or textured rendering. @@ -252,3 +252,4 @@ If ``true``, performs wireframe rendering for triangles instead of flat or textu .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rdpipelinespecializationconstant.rst b/classes/class_rdpipelinespecializationconstant.rst index ad23de80888..ec8e7c416db 100644 --- a/classes/class_rdpipelinespecializationconstant.rst +++ b/classes/class_rdpipelinespecializationconstant.rst @@ -54,8 +54,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_constant_id** **(** :ref:`int` value **)** -- :ref:`int` **get_constant_id** **(** **)** +- |void| **set_constant_id**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_constant_id**\ (\ ) The identifier of the specialization constant. This is a value starting from ``0`` and that increments for every different specialization constant for a given shader. @@ -71,8 +71,8 @@ The identifier of the specialization constant. This is a value starting from ``0 .. rst-class:: classref-property-setget -- void **set_value** **(** :ref:`Variant` value **)** -- :ref:`Variant` **get_value** **(** **)** +- |void| **set_value**\ (\ value\: :ref:`Variant`\ ) +- :ref:`Variant` **get_value**\ (\ ) The specialization constant's value. Only :ref:`bool`, :ref:`int` and :ref:`float` types are valid for specialization constants. @@ -83,3 +83,4 @@ The specialization constant's value. Only :ref:`bool`, :ref:`int` value **)** -- :ref:`float` **get_anisotropy_max** **(** **)** +- |void| **set_anisotropy_max**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_anisotropy_max**\ (\ ) Maximum anisotropy that can be used when sampling. Only effective if :ref:`use_anisotropy` is ``true``. Higher values result in a sharper sampler at oblique angles, at the cost of performance (due to memory bandwidth). This value may be limited by the graphics hardware in use. Most graphics hardware only supports values up to ``16.0``. @@ -97,8 +97,8 @@ If :ref:`anisotropy_max` is ``1.0` .. rst-class:: classref-property-setget -- void **set_border_color** **(** :ref:`SamplerBorderColor` value **)** -- :ref:`SamplerBorderColor` **get_border_color** **(** **)** +- |void| **set_border_color**\ (\ value\: :ref:`SamplerBorderColor`\ ) +- :ref:`SamplerBorderColor` **get_border_color**\ (\ ) The border color that will be returned when sampling outside the sampler's bounds and the :ref:`repeat_u`, :ref:`repeat_v` or :ref:`repeat_w` modes have repeating disabled. @@ -114,8 +114,8 @@ The border color that will be returned when sampling outside the sampler's bound .. rst-class:: classref-property-setget -- void **set_compare_op** **(** :ref:`CompareOperator` value **)** -- :ref:`CompareOperator` **get_compare_op** **(** **)** +- |void| **set_compare_op**\ (\ value\: :ref:`CompareOperator`\ ) +- :ref:`CompareOperator` **get_compare_op**\ (\ ) The compare operation to use. Only effective if :ref:`enable_compare` is ``true``. @@ -131,8 +131,8 @@ The compare operation to use. Only effective if :ref:`enable_compare` value **)** -- :ref:`bool` **get_enable_compare** **(** **)** +- |void| **set_enable_compare**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_enable_compare**\ (\ ) If ``true``, returned values will be based on the comparison operation defined in :ref:`compare_op`. This is a hardware-based approach and is therefore faster than performing this manually in a shader. For example, compare operations are used for shadow map rendering by comparing depth values from a shadow sampler. @@ -148,8 +148,8 @@ If ``true``, returned values will be based on the comparison operation defined i .. rst-class:: classref-property-setget -- void **set_lod_bias** **(** :ref:`float` value **)** -- :ref:`float` **get_lod_bias** **(** **)** +- |void| **set_lod_bias**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_lod_bias**\ (\ ) The mipmap LOD bias to use. Positive values will make the sampler blurrier at a given distance, while negative values will make the sampler sharper at a given distance (at the risk of looking grainy). Recommended values are between ``-0.5`` and ``0.0``. Only effective if the sampler has mipmaps available. @@ -165,8 +165,8 @@ The mipmap LOD bias to use. Positive values will make the sampler blurrier at a .. rst-class:: classref-property-setget -- void **set_mag_filter** **(** :ref:`SamplerFilter` value **)** -- :ref:`SamplerFilter` **get_mag_filter** **(** **)** +- |void| **set_mag_filter**\ (\ value\: :ref:`SamplerFilter`\ ) +- :ref:`SamplerFilter` **get_mag_filter**\ (\ ) The sampler's magnification filter. It is the filtering method used when sampling texels that appear bigger than on-screen pixels. @@ -182,8 +182,8 @@ The sampler's magnification filter. It is the filtering method used when samplin .. rst-class:: classref-property-setget -- void **set_max_lod** **(** :ref:`float` value **)** -- :ref:`float` **get_max_lod** **(** **)** +- |void| **set_max_lod**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_max_lod**\ (\ ) The maximum mipmap LOD bias to display (lowest resolution). Only effective if the sampler has mipmaps available. @@ -199,8 +199,8 @@ The maximum mipmap LOD bias to display (lowest resolution). Only effective if th .. rst-class:: classref-property-setget -- void **set_min_filter** **(** :ref:`SamplerFilter` value **)** -- :ref:`SamplerFilter` **get_min_filter** **(** **)** +- |void| **set_min_filter**\ (\ value\: :ref:`SamplerFilter`\ ) +- :ref:`SamplerFilter` **get_min_filter**\ (\ ) The sampler's minification filter. It is the filtering method used when sampling texels that appear smaller than on-screen pixels. @@ -216,8 +216,8 @@ The sampler's minification filter. It is the filtering method used when sampling .. rst-class:: classref-property-setget -- void **set_min_lod** **(** :ref:`float` value **)** -- :ref:`float` **get_min_lod** **(** **)** +- |void| **set_min_lod**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_min_lod**\ (\ ) The minimum mipmap LOD bias to display (highest resolution). Only effective if the sampler has mipmaps available. @@ -233,8 +233,8 @@ The minimum mipmap LOD bias to display (highest resolution). Only effective if t .. rst-class:: classref-property-setget -- void **set_mip_filter** **(** :ref:`SamplerFilter` value **)** -- :ref:`SamplerFilter` **get_mip_filter** **(** **)** +- |void| **set_mip_filter**\ (\ value\: :ref:`SamplerFilter`\ ) +- :ref:`SamplerFilter` **get_mip_filter**\ (\ ) The filtering method to use for mipmaps. @@ -250,8 +250,8 @@ The filtering method to use for mipmaps. .. rst-class:: classref-property-setget -- void **set_repeat_u** **(** :ref:`SamplerRepeatMode` value **)** -- :ref:`SamplerRepeatMode` **get_repeat_u** **(** **)** +- |void| **set_repeat_u**\ (\ value\: :ref:`SamplerRepeatMode`\ ) +- :ref:`SamplerRepeatMode` **get_repeat_u**\ (\ ) The repeat mode to use along the U axis of UV coordinates. This affects the returned values if sampling outside the UV bounds. @@ -267,8 +267,8 @@ The repeat mode to use along the U axis of UV coordinates. This affects the retu .. rst-class:: classref-property-setget -- void **set_repeat_v** **(** :ref:`SamplerRepeatMode` value **)** -- :ref:`SamplerRepeatMode` **get_repeat_v** **(** **)** +- |void| **set_repeat_v**\ (\ value\: :ref:`SamplerRepeatMode`\ ) +- :ref:`SamplerRepeatMode` **get_repeat_v**\ (\ ) The repeat mode to use along the V axis of UV coordinates. This affects the returned values if sampling outside the UV bounds. @@ -284,8 +284,8 @@ The repeat mode to use along the V axis of UV coordinates. This affects the retu .. rst-class:: classref-property-setget -- void **set_repeat_w** **(** :ref:`SamplerRepeatMode` value **)** -- :ref:`SamplerRepeatMode` **get_repeat_w** **(** **)** +- |void| **set_repeat_w**\ (\ value\: :ref:`SamplerRepeatMode`\ ) +- :ref:`SamplerRepeatMode` **get_repeat_w**\ (\ ) The repeat mode to use along the W axis of UV coordinates. This affects the returned values if sampling outside the UV bounds. Only effective for 3D samplers. @@ -301,8 +301,8 @@ The repeat mode to use along the W axis of UV coordinates. This affects the retu .. rst-class:: classref-property-setget -- void **set_unnormalized_uvw** **(** :ref:`bool` value **)** -- :ref:`bool` **get_unnormalized_uvw** **(** **)** +- |void| **set_unnormalized_uvw**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_unnormalized_uvw**\ (\ ) If ``true``, the texture will be sampled with coordinates ranging from 0 to the texture's resolution. Otherwise, the coordinates will be normalized and range from 0 to 1. @@ -318,8 +318,8 @@ If ``true``, the texture will be sampled with coordinates ranging from 0 to the .. rst-class:: classref-property-setget -- void **set_use_anisotropy** **(** :ref:`bool` value **)** -- :ref:`bool` **get_use_anisotropy** **(** **)** +- |void| **set_use_anisotropy**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_anisotropy**\ (\ ) If ``true``, perform anisotropic sampling. See :ref:`anisotropy_max`. @@ -330,3 +330,4 @@ If ``true``, perform anisotropic sampling. See :ref:`anisotropy_max` | :ref:`get_spirv` **(** :ref:`StringName` version=&"" **)** |const| | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName[]` | :ref:`get_version_list` **(** **)** |const| | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bytecode` **(** :ref:`RDShaderSPIRV` bytecode, :ref:`StringName` version=&"" **)** | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RDShaderSPIRV` | :ref:`get_spirv`\ (\ version\: :ref:`StringName` = &""\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`StringName`\] | :ref:`get_version_list`\ (\ ) |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bytecode`\ (\ bytecode\: :ref:`RDShaderSPIRV`, version\: :ref:`StringName` = &""\ ) | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -68,8 +68,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_base_error** **(** :ref:`String` value **)** -- :ref:`String` **get_base_error** **(** **)** +- |void| **set_base_error**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_base_error**\ (\ ) The base compilation error message, which indicates errors not related to a specific shader stage if non-empty. If empty, shader compilation is not necessarily successful (check :ref:`RDShaderSPIRV`'s error message members). @@ -86,7 +86,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RDShaderSPIRV` **get_spirv** **(** :ref:`StringName` version=&"" **)** |const| +:ref:`RDShaderSPIRV` **get_spirv**\ (\ version\: :ref:`StringName` = &""\ ) |const| Returns the SPIR-V intermediate representation for the specified shader ``version``. @@ -98,7 +98,7 @@ Returns the SPIR-V intermediate representation for the specified shader ``versio .. rst-class:: classref-method -:ref:`StringName[]` **get_version_list** **(** **)** |const| +:ref:`Array`\[:ref:`StringName`\] **get_version_list**\ (\ ) |const| Returns the list of compiled versions for this shader. @@ -110,7 +110,7 @@ Returns the list of compiled versions for this shader. .. rst-class:: classref-method -void **set_bytecode** **(** :ref:`RDShaderSPIRV` bytecode, :ref:`StringName` version=&"" **)** +|void| **set_bytecode**\ (\ bytecode\: :ref:`RDShaderSPIRV`, version\: :ref:`StringName` = &""\ ) Sets the SPIR-V ``bytecode`` that will be compiled for the specified ``version``. @@ -121,3 +121,4 @@ Sets the SPIR-V ``bytecode`` that will be compiled for the specified ``version`` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rdshadersource.rst b/classes/class_rdshadersource.rst index 49fb66a881a..9439bce24d9 100644 --- a/classes/class_rdshadersource.rst +++ b/classes/class_rdshadersource.rst @@ -53,11 +53,11 @@ Methods .. table:: :widths: auto - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_stage_source` **(** :ref:`ShaderStage` stage **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_stage_source` **(** :ref:`ShaderStage` stage, :ref:`String` source **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_stage_source`\ (\ stage\: :ref:`ShaderStage`\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stage_source`\ (\ stage\: :ref:`ShaderStage`, source\: :ref:`String`\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -76,8 +76,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_language** **(** :ref:`ShaderLanguage` value **)** -- :ref:`ShaderLanguage` **get_language** **(** **)** +- |void| **set_language**\ (\ value\: :ref:`ShaderLanguage`\ ) +- :ref:`ShaderLanguage` **get_language**\ (\ ) The language the shader is written in. @@ -93,8 +93,8 @@ The language the shader is written in. .. rst-class:: classref-property-setget -- void **set_stage_source** **(** :ref:`ShaderStage` stage, :ref:`String` source **)** -- :ref:`String` **get_stage_source** **(** :ref:`ShaderStage` stage **)** |const| +- |void| **set_stage_source**\ (\ stage\: :ref:`ShaderStage`, source\: :ref:`String`\ ) +- :ref:`String` **get_stage_source**\ (\ stage\: :ref:`ShaderStage`\ ) |const| Source code for the shader's compute stage. @@ -110,8 +110,8 @@ Source code for the shader's compute stage. .. rst-class:: classref-property-setget -- void **set_stage_source** **(** :ref:`ShaderStage` stage, :ref:`String` source **)** -- :ref:`String` **get_stage_source** **(** :ref:`ShaderStage` stage **)** |const| +- |void| **set_stage_source**\ (\ stage\: :ref:`ShaderStage`, source\: :ref:`String`\ ) +- :ref:`String` **get_stage_source**\ (\ stage\: :ref:`ShaderStage`\ ) |const| Source code for the shader's fragment stage. @@ -127,8 +127,8 @@ Source code for the shader's fragment stage. .. rst-class:: classref-property-setget -- void **set_stage_source** **(** :ref:`ShaderStage` stage, :ref:`String` source **)** -- :ref:`String` **get_stage_source** **(** :ref:`ShaderStage` stage **)** |const| +- |void| **set_stage_source**\ (\ stage\: :ref:`ShaderStage`, source\: :ref:`String`\ ) +- :ref:`String` **get_stage_source**\ (\ stage\: :ref:`ShaderStage`\ ) |const| Source code for the shader's tessellation control stage. @@ -144,8 +144,8 @@ Source code for the shader's tessellation control stage. .. rst-class:: classref-property-setget -- void **set_stage_source** **(** :ref:`ShaderStage` stage, :ref:`String` source **)** -- :ref:`String` **get_stage_source** **(** :ref:`ShaderStage` stage **)** |const| +- |void| **set_stage_source**\ (\ stage\: :ref:`ShaderStage`, source\: :ref:`String`\ ) +- :ref:`String` **get_stage_source**\ (\ stage\: :ref:`ShaderStage`\ ) |const| Source code for the shader's tessellation evaluation stage. @@ -161,8 +161,8 @@ Source code for the shader's tessellation evaluation stage. .. rst-class:: classref-property-setget -- void **set_stage_source** **(** :ref:`ShaderStage` stage, :ref:`String` source **)** -- :ref:`String` **get_stage_source** **(** :ref:`ShaderStage` stage **)** |const| +- |void| **set_stage_source**\ (\ stage\: :ref:`ShaderStage`, source\: :ref:`String`\ ) +- :ref:`String` **get_stage_source**\ (\ stage\: :ref:`ShaderStage`\ ) |const| Source code for the shader's vertex stage. @@ -179,7 +179,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **get_stage_source** **(** :ref:`ShaderStage` stage **)** |const| +:ref:`String` **get_stage_source**\ (\ stage\: :ref:`ShaderStage`\ ) |const| Returns source code for the specified shader ``stage``. Equivalent to getting one of :ref:`source_compute`, :ref:`source_fragment`, :ref:`source_tesselation_control`, :ref:`source_tesselation_evaluation` or :ref:`source_vertex`. @@ -191,7 +191,7 @@ Returns source code for the specified shader ``stage``. Equivalent to getting on .. rst-class:: classref-method -void **set_stage_source** **(** :ref:`ShaderStage` stage, :ref:`String` source **)** +|void| **set_stage_source**\ (\ stage\: :ref:`ShaderStage`, source\: :ref:`String`\ ) Sets ``source`` code for the specified shader ``stage``. Equivalent to setting one of :ref:`source_compute`, :ref:`source_fragment`, :ref:`source_tesselation_control`, :ref:`source_tesselation_evaluation` or :ref:`source_vertex`. @@ -202,3 +202,4 @@ Sets ``source`` code for the specified shader ``stage``. Equivalent to setting o .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rdshaderspirv.rst b/classes/class_rdshaderspirv.rst index 0c37fd58e9d..169f1b77c36 100644 --- a/classes/class_rdshaderspirv.rst +++ b/classes/class_rdshaderspirv.rst @@ -61,15 +61,15 @@ Methods .. table:: :widths: auto - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`get_stage_bytecode` **(** :ref:`ShaderStage` stage **)** |const| | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_stage_compile_error` **(** :ref:`ShaderStage` stage **)** |const| | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_stage_bytecode` **(** :ref:`ShaderStage` stage, :ref:`PackedByteArray` bytecode **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_stage_compile_error` **(** :ref:`ShaderStage` stage, :ref:`String` compile_error **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`get_stage_bytecode`\ (\ stage\: :ref:`ShaderStage`\ ) |const| | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_stage_compile_error`\ (\ stage\: :ref:`ShaderStage`\ ) |const| | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stage_bytecode`\ (\ stage\: :ref:`ShaderStage`, bytecode\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stage_compile_error`\ (\ stage\: :ref:`ShaderStage`, compile_error\: :ref:`String`\ ) | + +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -88,8 +88,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_stage_bytecode** **(** :ref:`ShaderStage` stage, :ref:`PackedByteArray` bytecode **)** -- :ref:`PackedByteArray` **get_stage_bytecode** **(** :ref:`ShaderStage` stage **)** |const| +- |void| **set_stage_bytecode**\ (\ stage\: :ref:`ShaderStage`, bytecode\: :ref:`PackedByteArray`\ ) +- :ref:`PackedByteArray` **get_stage_bytecode**\ (\ stage\: :ref:`ShaderStage`\ ) |const| The SPIR-V bytecode for the compute shader stage. @@ -105,8 +105,8 @@ The SPIR-V bytecode for the compute shader stage. .. rst-class:: classref-property-setget -- void **set_stage_bytecode** **(** :ref:`ShaderStage` stage, :ref:`PackedByteArray` bytecode **)** -- :ref:`PackedByteArray` **get_stage_bytecode** **(** :ref:`ShaderStage` stage **)** |const| +- |void| **set_stage_bytecode**\ (\ stage\: :ref:`ShaderStage`, bytecode\: :ref:`PackedByteArray`\ ) +- :ref:`PackedByteArray` **get_stage_bytecode**\ (\ stage\: :ref:`ShaderStage`\ ) |const| The SPIR-V bytecode for the fragment shader stage. @@ -122,8 +122,8 @@ The SPIR-V bytecode for the fragment shader stage. .. rst-class:: classref-property-setget -- void **set_stage_bytecode** **(** :ref:`ShaderStage` stage, :ref:`PackedByteArray` bytecode **)** -- :ref:`PackedByteArray` **get_stage_bytecode** **(** :ref:`ShaderStage` stage **)** |const| +- |void| **set_stage_bytecode**\ (\ stage\: :ref:`ShaderStage`, bytecode\: :ref:`PackedByteArray`\ ) +- :ref:`PackedByteArray` **get_stage_bytecode**\ (\ stage\: :ref:`ShaderStage`\ ) |const| The SPIR-V bytecode for the tessellation control shader stage. @@ -139,8 +139,8 @@ The SPIR-V bytecode for the tessellation control shader stage. .. rst-class:: classref-property-setget -- void **set_stage_bytecode** **(** :ref:`ShaderStage` stage, :ref:`PackedByteArray` bytecode **)** -- :ref:`PackedByteArray` **get_stage_bytecode** **(** :ref:`ShaderStage` stage **)** |const| +- |void| **set_stage_bytecode**\ (\ stage\: :ref:`ShaderStage`, bytecode\: :ref:`PackedByteArray`\ ) +- :ref:`PackedByteArray` **get_stage_bytecode**\ (\ stage\: :ref:`ShaderStage`\ ) |const| The SPIR-V bytecode for the tessellation evaluation shader stage. @@ -156,8 +156,8 @@ The SPIR-V bytecode for the tessellation evaluation shader stage. .. rst-class:: classref-property-setget -- void **set_stage_bytecode** **(** :ref:`ShaderStage` stage, :ref:`PackedByteArray` bytecode **)** -- :ref:`PackedByteArray` **get_stage_bytecode** **(** :ref:`ShaderStage` stage **)** |const| +- |void| **set_stage_bytecode**\ (\ stage\: :ref:`ShaderStage`, bytecode\: :ref:`PackedByteArray`\ ) +- :ref:`PackedByteArray` **get_stage_bytecode**\ (\ stage\: :ref:`ShaderStage`\ ) |const| The SPIR-V bytecode for the vertex shader stage. @@ -173,8 +173,8 @@ The SPIR-V bytecode for the vertex shader stage. .. rst-class:: classref-property-setget -- void **set_stage_compile_error** **(** :ref:`ShaderStage` stage, :ref:`String` compile_error **)** -- :ref:`String` **get_stage_compile_error** **(** :ref:`ShaderStage` stage **)** |const| +- |void| **set_stage_compile_error**\ (\ stage\: :ref:`ShaderStage`, compile_error\: :ref:`String`\ ) +- :ref:`String` **get_stage_compile_error**\ (\ stage\: :ref:`ShaderStage`\ ) |const| The compilation error message for the compute shader stage (set by the SPIR-V compiler and Godot). If empty, shader compilation was successful. @@ -190,8 +190,8 @@ The compilation error message for the compute shader stage (set by the SPIR-V co .. rst-class:: classref-property-setget -- void **set_stage_compile_error** **(** :ref:`ShaderStage` stage, :ref:`String` compile_error **)** -- :ref:`String` **get_stage_compile_error** **(** :ref:`ShaderStage` stage **)** |const| +- |void| **set_stage_compile_error**\ (\ stage\: :ref:`ShaderStage`, compile_error\: :ref:`String`\ ) +- :ref:`String` **get_stage_compile_error**\ (\ stage\: :ref:`ShaderStage`\ ) |const| The compilation error message for the fragment shader stage (set by the SPIR-V compiler and Godot). If empty, shader compilation was successful. @@ -207,8 +207,8 @@ The compilation error message for the fragment shader stage (set by the SPIR-V c .. rst-class:: classref-property-setget -- void **set_stage_compile_error** **(** :ref:`ShaderStage` stage, :ref:`String` compile_error **)** -- :ref:`String` **get_stage_compile_error** **(** :ref:`ShaderStage` stage **)** |const| +- |void| **set_stage_compile_error**\ (\ stage\: :ref:`ShaderStage`, compile_error\: :ref:`String`\ ) +- :ref:`String` **get_stage_compile_error**\ (\ stage\: :ref:`ShaderStage`\ ) |const| The compilation error message for the tessellation control shader stage (set by the SPIR-V compiler and Godot). If empty, shader compilation was successful. @@ -224,8 +224,8 @@ The compilation error message for the tessellation control shader stage (set by .. rst-class:: classref-property-setget -- void **set_stage_compile_error** **(** :ref:`ShaderStage` stage, :ref:`String` compile_error **)** -- :ref:`String` **get_stage_compile_error** **(** :ref:`ShaderStage` stage **)** |const| +- |void| **set_stage_compile_error**\ (\ stage\: :ref:`ShaderStage`, compile_error\: :ref:`String`\ ) +- :ref:`String` **get_stage_compile_error**\ (\ stage\: :ref:`ShaderStage`\ ) |const| The compilation error message for the tessellation evaluation shader stage (set by the SPIR-V compiler and Godot). If empty, shader compilation was successful. @@ -241,8 +241,8 @@ The compilation error message for the tessellation evaluation shader stage (set .. rst-class:: classref-property-setget -- void **set_stage_compile_error** **(** :ref:`ShaderStage` stage, :ref:`String` compile_error **)** -- :ref:`String` **get_stage_compile_error** **(** :ref:`ShaderStage` stage **)** |const| +- |void| **set_stage_compile_error**\ (\ stage\: :ref:`ShaderStage`, compile_error\: :ref:`String`\ ) +- :ref:`String` **get_stage_compile_error**\ (\ stage\: :ref:`ShaderStage`\ ) |const| The compilation error message for the vertex shader stage (set by the SPIR-V compiler and Godot). If empty, shader compilation was successful. @@ -259,7 +259,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedByteArray` **get_stage_bytecode** **(** :ref:`ShaderStage` stage **)** |const| +:ref:`PackedByteArray` **get_stage_bytecode**\ (\ stage\: :ref:`ShaderStage`\ ) |const| Equivalent to getting one of :ref:`bytecode_compute`, :ref:`bytecode_fragment`, :ref:`bytecode_tesselation_control`, :ref:`bytecode_tesselation_evaluation`, :ref:`bytecode_vertex`. @@ -271,7 +271,7 @@ Equivalent to getting one of :ref:`bytecode_compute` **get_stage_compile_error** **(** :ref:`ShaderStage` stage **)** |const| +:ref:`String` **get_stage_compile_error**\ (\ stage\: :ref:`ShaderStage`\ ) |const| Returns the compilation error message for the given shader ``stage``. Equivalent to getting one of :ref:`compile_error_compute`, :ref:`compile_error_fragment`, :ref:`compile_error_tesselation_control`, :ref:`compile_error_tesselation_evaluation`, :ref:`compile_error_vertex`. @@ -283,7 +283,7 @@ Returns the compilation error message for the given shader ``stage``. Equivalent .. rst-class:: classref-method -void **set_stage_bytecode** **(** :ref:`ShaderStage` stage, :ref:`PackedByteArray` bytecode **)** +|void| **set_stage_bytecode**\ (\ stage\: :ref:`ShaderStage`, bytecode\: :ref:`PackedByteArray`\ ) Sets the SPIR-V ``bytecode`` for the given shader ``stage``. Equivalent to setting one of :ref:`bytecode_compute`, :ref:`bytecode_fragment`, :ref:`bytecode_tesselation_control`, :ref:`bytecode_tesselation_evaluation`, :ref:`bytecode_vertex`. @@ -295,7 +295,7 @@ Sets the SPIR-V ``bytecode`` for the given shader ``stage``. Equivalent to setti .. rst-class:: classref-method -void **set_stage_compile_error** **(** :ref:`ShaderStage` stage, :ref:`String` compile_error **)** +|void| **set_stage_compile_error**\ (\ stage\: :ref:`ShaderStage`, compile_error\: :ref:`String`\ ) Sets the compilation error message for the given shader ``stage`` to ``compile_error``. Equivalent to setting one of :ref:`compile_error_compute`, :ref:`compile_error_fragment`, :ref:`compile_error_tesselation_control`, :ref:`compile_error_tesselation_evaluation`, :ref:`compile_error_vertex`. @@ -306,3 +306,4 @@ Sets the compilation error message for the given shader ``stage`` to ``compile_e .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rdtextureformat.rst b/classes/class_rdtextureformat.rst index 7ded5665a4f..0543aaff289 100644 --- a/classes/class_rdtextureformat.rst +++ b/classes/class_rdtextureformat.rst @@ -44,7 +44,7 @@ Properties +------------------------------------------------------------------------------+------------------------------------------------------------------+-------+ | :ref:`TextureType` | :ref:`texture_type` | ``1`` | +------------------------------------------------------------------------------+------------------------------------------------------------------+-------+ - | |bitfield|\<:ref:`TextureUsageBits`\> | :ref:`usage_bits` | ``0`` | + | |bitfield|\[:ref:`TextureUsageBits`\] | :ref:`usage_bits` | ``0`` | +------------------------------------------------------------------------------+------------------------------------------------------------------+-------+ | :ref:`int` | :ref:`width` | ``1`` | +------------------------------------------------------------------------------+------------------------------------------------------------------+-------+ @@ -57,11 +57,11 @@ Methods .. table:: :widths: auto - +------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_shareable_format` **(** :ref:`DataFormat` format **)** | - +------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_shareable_format` **(** :ref:`DataFormat` format **)** | - +------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_shareable_format`\ (\ format\: :ref:`DataFormat`\ ) | + +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_shareable_format`\ (\ format\: :ref:`DataFormat`\ ) | + +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -80,8 +80,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_array_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_array_layers** **(** **)** +- |void| **set_array_layers**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_array_layers**\ (\ ) The number of layers in the texture. Only relevant for 2D texture arrays. @@ -97,8 +97,8 @@ The number of layers in the texture. Only relevant for 2D texture arrays. .. rst-class:: classref-property-setget -- void **set_depth** **(** :ref:`int` value **)** -- :ref:`int` **get_depth** **(** **)** +- |void| **set_depth**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_depth**\ (\ ) The texture's depth (in pixels). This is always ``1`` for 2D textures. @@ -114,8 +114,8 @@ The texture's depth (in pixels). This is always ``1`` for 2D textures. .. rst-class:: classref-property-setget -- void **set_format** **(** :ref:`DataFormat` value **)** -- :ref:`DataFormat` **get_format** **(** **)** +- |void| **set_format**\ (\ value\: :ref:`DataFormat`\ ) +- :ref:`DataFormat` **get_format**\ (\ ) The texture's pixel data format. @@ -131,8 +131,8 @@ The texture's pixel data format. .. rst-class:: classref-property-setget -- void **set_height** **(** :ref:`int` value **)** -- :ref:`int` **get_height** **(** **)** +- |void| **set_height**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_height**\ (\ ) The texture's height (in pixels). @@ -148,8 +148,8 @@ The texture's height (in pixels). .. rst-class:: classref-property-setget -- void **set_mipmaps** **(** :ref:`int` value **)** -- :ref:`int` **get_mipmaps** **(** **)** +- |void| **set_mipmaps**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_mipmaps**\ (\ ) The number of mipmaps available in the texture. @@ -165,8 +165,8 @@ The number of mipmaps available in the texture. .. rst-class:: classref-property-setget -- void **set_samples** **(** :ref:`TextureSamples` value **)** -- :ref:`TextureSamples` **get_samples** **(** **)** +- |void| **set_samples**\ (\ value\: :ref:`TextureSamples`\ ) +- :ref:`TextureSamples` **get_samples**\ (\ ) The number of samples used when sampling the texture. @@ -182,8 +182,8 @@ The number of samples used when sampling the texture. .. rst-class:: classref-property-setget -- void **set_texture_type** **(** :ref:`TextureType` value **)** -- :ref:`TextureType` **get_texture_type** **(** **)** +- |void| **set_texture_type**\ (\ value\: :ref:`TextureType`\ ) +- :ref:`TextureType` **get_texture_type**\ (\ ) The texture type. @@ -195,12 +195,12 @@ The texture type. .. rst-class:: classref-property -|bitfield|\<:ref:`TextureUsageBits`\> **usage_bits** = ``0`` +|bitfield|\[:ref:`TextureUsageBits`\] **usage_bits** = ``0`` .. rst-class:: classref-property-setget -- void **set_usage_bits** **(** |bitfield|\<:ref:`TextureUsageBits`\> value **)** -- |bitfield|\<:ref:`TextureUsageBits`\> **get_usage_bits** **(** **)** +- |void| **set_usage_bits**\ (\ value\: |bitfield|\[:ref:`TextureUsageBits`\]\ ) +- |bitfield|\[:ref:`TextureUsageBits`\] **get_usage_bits**\ (\ ) The texture's usage bits, which determine what can be done using the texture. @@ -216,8 +216,8 @@ The texture's usage bits, which determine what can be done using the texture. .. rst-class:: classref-property-setget -- void **set_width** **(** :ref:`int` value **)** -- :ref:`int` **get_width** **(** **)** +- |void| **set_width**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_width**\ (\ ) The texture's width (in pixels). @@ -234,7 +234,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_shareable_format** **(** :ref:`DataFormat` format **)** +|void| **add_shareable_format**\ (\ format\: :ref:`DataFormat`\ ) .. container:: contribute @@ -248,7 +248,7 @@ void **add_shareable_format** **(** :ref:`DataFormat` format **)** +|void| **remove_shareable_format**\ (\ format\: :ref:`DataFormat`\ ) .. container:: contribute @@ -261,3 +261,4 @@ void **remove_shareable_format** **(** :ref:`DataFormat` value **)** -- :ref:`DataFormat` **get_format_override** **(** **)** +- |void| **set_format_override**\ (\ value\: :ref:`DataFormat`\ ) +- :ref:`DataFormat` **get_format_override**\ (\ ) Optional override for the data format to return sampled values in. The default value of :ref:`RenderingDevice.DATA_FORMAT_MAX` does not override the format. @@ -75,8 +75,8 @@ Optional override for the data format to return sampled values in. The default v .. rst-class:: classref-property-setget -- void **set_swizzle_a** **(** :ref:`TextureSwizzle` value **)** -- :ref:`TextureSwizzle` **get_swizzle_a** **(** **)** +- |void| **set_swizzle_a**\ (\ value\: :ref:`TextureSwizzle`\ ) +- :ref:`TextureSwizzle` **get_swizzle_a**\ (\ ) The channel to sample when sampling the alpha channel. @@ -92,8 +92,8 @@ The channel to sample when sampling the alpha channel. .. rst-class:: classref-property-setget -- void **set_swizzle_b** **(** :ref:`TextureSwizzle` value **)** -- :ref:`TextureSwizzle` **get_swizzle_b** **(** **)** +- |void| **set_swizzle_b**\ (\ value\: :ref:`TextureSwizzle`\ ) +- :ref:`TextureSwizzle` **get_swizzle_b**\ (\ ) The channel to sample when sampling the blue color channel. @@ -109,8 +109,8 @@ The channel to sample when sampling the blue color channel. .. rst-class:: classref-property-setget -- void **set_swizzle_g** **(** :ref:`TextureSwizzle` value **)** -- :ref:`TextureSwizzle` **get_swizzle_g** **(** **)** +- |void| **set_swizzle_g**\ (\ value\: :ref:`TextureSwizzle`\ ) +- :ref:`TextureSwizzle` **get_swizzle_g**\ (\ ) The channel to sample when sampling the green color channel. @@ -126,8 +126,8 @@ The channel to sample when sampling the green color channel. .. rst-class:: classref-property-setget -- void **set_swizzle_r** **(** :ref:`TextureSwizzle` value **)** -- :ref:`TextureSwizzle` **get_swizzle_r** **(** **)** +- |void| **set_swizzle_r**\ (\ value\: :ref:`TextureSwizzle`\ ) +- :ref:`TextureSwizzle` **get_swizzle_r**\ (\ ) The channel to sample when sampling the red color channel. @@ -138,3 +138,4 @@ The channel to sample when sampling the red color channel. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rduniform.rst b/classes/class_rduniform.rst index 5df37ab665a..036c4426858 100644 --- a/classes/class_rduniform.rst +++ b/classes/class_rduniform.rst @@ -43,13 +43,13 @@ Methods .. table:: :widths: auto - +-------------------------+-----------------------------------------------------------------------------------+ - | void | :ref:`add_id` **(** :ref:`RID` id **)** | - +-------------------------+-----------------------------------------------------------------------------------+ - | void | :ref:`clear_ids` **(** **)** | - +-------------------------+-----------------------------------------------------------------------------------+ - | :ref:`RID[]` | :ref:`get_ids` **(** **)** |const| | - +-------------------------+-----------------------------------------------------------------------------------+ + +----------------------------------------------------+--------------------------------------------------------------------------------+ + | |void| | :ref:`add_id`\ (\ id\: :ref:`RID`\ ) | + +----------------------------------------------------+--------------------------------------------------------------------------------+ + | |void| | :ref:`clear_ids`\ (\ ) | + +----------------------------------------------------+--------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`get_ids`\ (\ ) |const| | + +----------------------------------------------------+--------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -68,8 +68,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_binding** **(** :ref:`int` value **)** -- :ref:`int` **get_binding** **(** **)** +- |void| **set_binding**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_binding**\ (\ ) The uniform's binding. @@ -85,8 +85,8 @@ The uniform's binding. .. rst-class:: classref-property-setget -- void **set_uniform_type** **(** :ref:`UniformType` value **)** -- :ref:`UniformType` **get_uniform_type** **(** **)** +- |void| **set_uniform_type**\ (\ value\: :ref:`UniformType`\ ) +- :ref:`UniformType` **get_uniform_type**\ (\ ) The uniform's data type. @@ -103,7 +103,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_id** **(** :ref:`RID` id **)** +|void| **add_id**\ (\ id\: :ref:`RID`\ ) Binds the given id to the uniform. The data associated with the id is then used when the uniform is passed to a shader. @@ -115,7 +115,7 @@ Binds the given id to the uniform. The data associated with the id is then used .. rst-class:: classref-method -void **clear_ids** **(** **)** +|void| **clear_ids**\ (\ ) Unbinds all ids currently bound to the uniform. @@ -127,7 +127,7 @@ Unbinds all ids currently bound to the uniform. .. rst-class:: classref-method -:ref:`RID[]` **get_ids** **(** **)** |const| +:ref:`Array`\[:ref:`RID`\] **get_ids**\ (\ ) |const| Returns an array of all ids currently bound to the uniform. @@ -138,3 +138,4 @@ Returns an array of all ids currently bound to the uniform. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rdvertexattribute.rst b/classes/class_rdvertexattribute.rst index ec5f895ee2a..ce2ec934e57 100644 --- a/classes/class_rdvertexattribute.rst +++ b/classes/class_rdvertexattribute.rst @@ -58,8 +58,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_format** **(** :ref:`DataFormat` value **)** -- :ref:`DataFormat` **get_format** **(** **)** +- |void| **set_format**\ (\ value\: :ref:`DataFormat`\ ) +- :ref:`DataFormat` **get_format**\ (\ ) .. container:: contribute @@ -77,8 +77,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_frequency** **(** :ref:`VertexFrequency` value **)** -- :ref:`VertexFrequency` **get_frequency** **(** **)** +- |void| **set_frequency**\ (\ value\: :ref:`VertexFrequency`\ ) +- :ref:`VertexFrequency` **get_frequency**\ (\ ) .. container:: contribute @@ -96,8 +96,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_location** **(** :ref:`int` value **)** -- :ref:`int` **get_location** **(** **)** +- |void| **set_location**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_location**\ (\ ) .. container:: contribute @@ -115,8 +115,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_offset** **(** :ref:`int` value **)** -- :ref:`int` **get_offset** **(** **)** +- |void| **set_offset**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_offset**\ (\ ) .. container:: contribute @@ -134,8 +134,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_stride** **(** :ref:`int` value **)** -- :ref:`int` **get_stride** **(** **)** +- |void| **set_stride**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_stride**\ (\ ) .. container:: contribute @@ -148,3 +148,4 @@ Property Descriptions .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index 82e576031db..572af49dea6 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -64,17 +64,17 @@ Constructors .. table:: :widths: auto - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`Rect2` **(** **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Rect2` from **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Rect2i` from **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Vector2` position, :ref:`Vector2` size **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`Rect2` **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`Rect2`\ (\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`Rect2`\ (\ from\: :ref:`Rect2`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`Rect2`\ (\ from\: :ref:`Rect2i`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`Rect2`\ (\ position\: :ref:`Vector2`, size\: :ref:`Vector2`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`Rect2`\ (\ x\: :ref:`float`, y\: :ref:`float`, width\: :ref:`float`, height\: :ref:`float`\ ) | + +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -84,37 +84,37 @@ Methods .. table:: :widths: auto - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`abs` **(** **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`encloses` **(** :ref:`Rect2` b **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`expand` **(** :ref:`Vector2` to **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_area` **(** **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_center` **(** **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`grow` **(** :ref:`float` amount **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`grow_individual` **(** :ref:`float` left, :ref:`float` top, :ref:`float` right, :ref:`float` bottom **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`grow_side` **(** :ref:`int` side, :ref:`float` amount **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_area` **(** **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`intersection` **(** :ref:`Rect2` b **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`intersects` **(** :ref:`Rect2` b, :ref:`bool` include_borders=false **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Rect2` rect **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_finite` **(** **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`merge` **(** :ref:`Rect2` b **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`abs`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`encloses`\ (\ b\: :ref:`Rect2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`expand`\ (\ to\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_area`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_center`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`grow`\ (\ amount\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`grow_individual`\ (\ left\: :ref:`float`, top\: :ref:`float`, right\: :ref:`float`, bottom\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`grow_side`\ (\ side\: :ref:`int`, amount\: :ref:`float`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_area`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_point`\ (\ point\: :ref:`Vector2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`intersection`\ (\ b\: :ref:`Rect2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`intersects`\ (\ b\: :ref:`Rect2`, include_borders\: :ref:`bool` = false\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equal_approx`\ (\ rect\: :ref:`Rect2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`merge`\ (\ b\: :ref:`Rect2`\ ) |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -124,13 +124,13 @@ Operators .. table:: :widths: auto - +---------------------------+-----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Rect2` right **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`operator *` **(** :ref:`Transform2D` right **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Rect2` right **)** | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+ + +---------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Rect2`\ ) | + +---------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`operator *`\ (\ right\: :ref:`Transform2D`\ ) | + +---------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Rect2`\ ) | + +---------------------------+--------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -188,7 +188,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Rect2` **Rect2** **(** **)** +:ref:`Rect2` **Rect2**\ (\ ) Constructs a **Rect2** with its :ref:`position` and :ref:`size` set to :ref:`Vector2.ZERO`. @@ -198,7 +198,7 @@ Constructs a **Rect2** with its :ref:`position` a .. rst-class:: classref-constructor -:ref:`Rect2` **Rect2** **(** :ref:`Rect2` from **)** +:ref:`Rect2` **Rect2**\ (\ from\: :ref:`Rect2`\ ) Constructs a **Rect2** as a copy of the given **Rect2**. @@ -208,7 +208,7 @@ Constructs a **Rect2** as a copy of the given **Rect2**. .. rst-class:: classref-constructor -:ref:`Rect2` **Rect2** **(** :ref:`Rect2i` from **)** +:ref:`Rect2` **Rect2**\ (\ from\: :ref:`Rect2i`\ ) Constructs a **Rect2** from a :ref:`Rect2i`. @@ -218,7 +218,7 @@ Constructs a **Rect2** from a :ref:`Rect2i`. .. rst-class:: classref-constructor -:ref:`Rect2` **Rect2** **(** :ref:`Vector2` position, :ref:`Vector2` size **)** +:ref:`Rect2` **Rect2**\ (\ position\: :ref:`Vector2`, size\: :ref:`Vector2`\ ) Constructs a **Rect2** by ``position`` and ``size``. @@ -228,7 +228,7 @@ Constructs a **Rect2** by ``position`` and ``size``. .. rst-class:: classref-constructor -:ref:`Rect2` **Rect2** **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** +:ref:`Rect2` **Rect2**\ (\ x\: :ref:`float`, y\: :ref:`float`, width\: :ref:`float`, height\: :ref:`float`\ ) Constructs a **Rect2** by setting its :ref:`position` to (``x``, ``y``), and its :ref:`size` to (``width``, ``height``). @@ -245,7 +245,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Rect2` **abs** **(** **)** |const| +:ref:`Rect2` **abs**\ (\ ) |const| Returns a **Rect2** equivalent to this rectangle, with its width and height modified to be non-negative values, and with its :ref:`position` being the top-left corner of the rectangle. @@ -274,7 +274,7 @@ Returns a **Rect2** equivalent to this rectangle, with its width and height modi .. rst-class:: classref-method -:ref:`bool` **encloses** **(** :ref:`Rect2` b **)** |const| +:ref:`bool` **encloses**\ (\ b\: :ref:`Rect2`\ ) |const| Returns ``true`` if this rectangle *completely* encloses the ``b`` rectangle. @@ -286,7 +286,7 @@ Returns ``true`` if this rectangle *completely* encloses the ``b`` rectangle. .. rst-class:: classref-method -:ref:`Rect2` **expand** **(** :ref:`Vector2` to **)** |const| +:ref:`Rect2` **expand**\ (\ to\: :ref:`Vector2`\ ) |const| Returns a copy of this rectangle expanded to align the edges with the given ``to`` point, if necessary. @@ -317,7 +317,7 @@ Returns a copy of this rectangle expanded to align the edges with the given ``to .. rst-class:: classref-method -:ref:`float` **get_area** **(** **)** |const| +:ref:`float` **get_area**\ (\ ) |const| Returns the rectangle's area. This is equivalent to ``size.x * size.y``. See also :ref:`has_area`. @@ -329,7 +329,7 @@ Returns the rectangle's area. This is equivalent to ``size.x * size.y``. See als .. rst-class:: classref-method -:ref:`Vector2` **get_center** **(** **)** |const| +:ref:`Vector2` **get_center**\ (\ ) |const| Returns the center point of the rectangle. This is the same as ``position + (size / 2.0)``. @@ -341,7 +341,7 @@ Returns the center point of the rectangle. This is the same as ``position + (siz .. rst-class:: classref-method -:ref:`Rect2` **grow** **(** :ref:`float` amount **)** |const| +:ref:`Rect2` **grow**\ (\ amount\: :ref:`float`\ ) |const| Returns a copy of this rectangle extended on all sides by the given ``amount``. A negative ``amount`` shrinks the rectangle instead. See also :ref:`grow_individual` and :ref:`grow_side`. @@ -368,7 +368,7 @@ Returns a copy of this rectangle extended on all sides by the given ``amount``. .. rst-class:: classref-method -:ref:`Rect2` **grow_individual** **(** :ref:`float` left, :ref:`float` top, :ref:`float` right, :ref:`float` bottom **)** |const| +:ref:`Rect2` **grow_individual**\ (\ left\: :ref:`float`, top\: :ref:`float`, right\: :ref:`float`, bottom\: :ref:`float`\ ) |const| Returns a copy of this rectangle with its ``left``, ``top``, ``right``, and ``bottom`` sides extended by the given amounts. Negative values shrink the sides, instead. See also :ref:`grow` and :ref:`grow_side`. @@ -380,7 +380,7 @@ Returns a copy of this rectangle with its ``left``, ``top``, ``right``, and ``bo .. rst-class:: classref-method -:ref:`Rect2` **grow_side** **(** :ref:`int` side, :ref:`float` amount **)** |const| +:ref:`Rect2` **grow_side**\ (\ side\: :ref:`int`, amount\: :ref:`float`\ ) |const| Returns a copy of this rectangle with its ``side`` extended by the given ``amount`` (see :ref:`Side` constants). A negative ``amount`` shrinks the rectangle, instead. See also :ref:`grow` and :ref:`grow_individual`. @@ -392,7 +392,7 @@ Returns a copy of this rectangle with its ``side`` extended by the given ``amoun .. rst-class:: classref-method -:ref:`bool` **has_area** **(** **)** |const| +:ref:`bool` **has_area**\ (\ ) |const| Returns ``true`` if this rectangle has positive width and height. See also :ref:`get_area`. @@ -404,7 +404,7 @@ Returns ``true`` if this rectangle has positive width and height. See also :ref: .. rst-class:: classref-method -:ref:`bool` **has_point** **(** :ref:`Vector2` point **)** |const| +:ref:`bool` **has_point**\ (\ point\: :ref:`Vector2`\ ) |const| Returns ``true`` if the rectangle contains the given ``point``. By convention, points on the right and bottom edges are **not** included. @@ -418,7 +418,7 @@ Returns ``true`` if the rectangle contains the given ``point``. By convention, p .. rst-class:: classref-method -:ref:`Rect2` **intersection** **(** :ref:`Rect2` b **)** |const| +:ref:`Rect2` **intersection**\ (\ b\: :ref:`Rect2`\ ) |const| Returns the intersection between this rectangle and ``b``. If the rectangles do not intersect, returns an empty **Rect2**. @@ -451,7 +451,7 @@ Returns the intersection between this rectangle and ``b``. If the rectangles do .. rst-class:: classref-method -:ref:`bool` **intersects** **(** :ref:`Rect2` b, :ref:`bool` include_borders=false **)** |const| +:ref:`bool` **intersects**\ (\ b\: :ref:`Rect2`, include_borders\: :ref:`bool` = false\ ) |const| Returns ``true`` if this rectangle overlaps with the ``b`` rectangle. The edges of both rectangles are excluded, unless ``include_borders`` is ``true``. @@ -463,7 +463,7 @@ Returns ``true`` if this rectangle overlaps with the ``b`` rectangle. The edges .. rst-class:: classref-method -:ref:`bool` **is_equal_approx** **(** :ref:`Rect2` rect **)** |const| +:ref:`bool` **is_equal_approx**\ (\ rect\: :ref:`Rect2`\ ) |const| Returns ``true`` if this rectangle and ``rect`` are approximately equal, by calling :ref:`Vector2.is_equal_approx` on the :ref:`position` and the :ref:`size`. @@ -475,7 +475,7 @@ Returns ``true`` if this rectangle and ``rect`` are approximately equal, by call .. rst-class:: classref-method -:ref:`bool` **is_finite** **(** **)** |const| +:ref:`bool` **is_finite**\ (\ ) |const| Returns ``true`` if this rectangle's values are finite, by calling :ref:`Vector2.is_finite` on the :ref:`position` and the :ref:`size`. @@ -487,7 +487,7 @@ Returns ``true`` if this rectangle's values are finite, by calling :ref:`Vector2 .. rst-class:: classref-method -:ref:`Rect2` **merge** **(** :ref:`Rect2` b **)** |const| +:ref:`Rect2` **merge**\ (\ b\: :ref:`Rect2`\ ) |const| Returns a **Rect2** that encloses both this rectangle and ``b`` around the edges. See also :ref:`encloses`. @@ -504,7 +504,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Rect2` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Rect2`\ ) Returns ``true`` if the :ref:`position` or :ref:`size` of both rectangles are not equal. @@ -518,7 +518,7 @@ Returns ``true`` if the :ref:`position` or :ref:` .. rst-class:: classref-operator -:ref:`Rect2` **operator *** **(** :ref:`Transform2D` right **)** +:ref:`Rect2` **operator ***\ (\ right\: :ref:`Transform2D`\ ) Inversely transforms (multiplies) the **Rect2** by the given :ref:`Transform2D` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). @@ -534,7 +534,7 @@ For transforming by inverse of an affine transformation (e.g. with scaling) ``tr .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`Rect2` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Rect2`\ ) Returns ``true`` if both :ref:`position` and :ref:`size` of the rectangles are exactly equal, respectively. @@ -547,3 +547,4 @@ Returns ``true`` if both :ref:`position` and :ref .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rect2i.rst b/classes/class_rect2i.rst index fa0c4558aaf..768fc67bed8 100644 --- a/classes/class_rect2i.rst +++ b/classes/class_rect2i.rst @@ -62,17 +62,17 @@ Constructors .. table:: :widths: auto - +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`Rect2i` **(** **)** | - +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`Rect2i` **(** :ref:`Rect2i` from **)** | - +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`Rect2i` **(** :ref:`Rect2` from **)** | - +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`Rect2i` **(** :ref:`Vector2i` position, :ref:`Vector2i` size **)** | - +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`Rect2i` **(** :ref:`int` x, :ref:`int` y, :ref:`int` width, :ref:`int` height **)** | - +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`Rect2i`\ (\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`Rect2i`\ (\ from\: :ref:`Rect2i`\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`Rect2i`\ (\ from\: :ref:`Rect2`\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`Rect2i`\ (\ position\: :ref:`Vector2i`, size\: :ref:`Vector2i`\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`Rect2i`\ (\ x\: :ref:`int`, y\: :ref:`int`, width\: :ref:`int`, height\: :ref:`int`\ ) | + +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -82,33 +82,33 @@ Methods .. table:: :widths: auto - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`abs` **(** **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`encloses` **(** :ref:`Rect2i` b **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`expand` **(** :ref:`Vector2i` to **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_area` **(** **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_center` **(** **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`grow` **(** :ref:`int` amount **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`grow_individual` **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`grow_side` **(** :ref:`int` side, :ref:`int` amount **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_area` **(** **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2i` point **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`intersection` **(** :ref:`Rect2i` b **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`intersects` **(** :ref:`Rect2i` b **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`merge` **(** :ref:`Rect2i` b **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`abs`\ (\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`encloses`\ (\ b\: :ref:`Rect2i`\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`expand`\ (\ to\: :ref:`Vector2i`\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_area`\ (\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_center`\ (\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`grow`\ (\ amount\: :ref:`int`\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`grow_individual`\ (\ left\: :ref:`int`, top\: :ref:`int`, right\: :ref:`int`, bottom\: :ref:`int`\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`grow_side`\ (\ side\: :ref:`int`, amount\: :ref:`int`\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_area`\ (\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_point`\ (\ point\: :ref:`Vector2i`\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`intersection`\ (\ b\: :ref:`Rect2i`\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`intersects`\ (\ b\: :ref:`Rect2i`\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`merge`\ (\ b\: :ref:`Rect2i`\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -118,11 +118,11 @@ Operators .. table:: :widths: auto - +-------------------------+----------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Rect2i` right **)** | - +-------------------------+----------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Rect2i` right **)** | - +-------------------------+----------------------------------------------------------------------------------------------------+ + +-------------------------+-------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Rect2i`\ ) | + +-------------------------+-------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Rect2i`\ ) | + +-------------------------+-------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -180,7 +180,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Rect2i` **Rect2i** **(** **)** +:ref:`Rect2i` **Rect2i**\ (\ ) Constructs a **Rect2i** with its :ref:`position` and :ref:`size` set to :ref:`Vector2i.ZERO`. @@ -190,7 +190,7 @@ Constructs a **Rect2i** with its :ref:`position` .. rst-class:: classref-constructor -:ref:`Rect2i` **Rect2i** **(** :ref:`Rect2i` from **)** +:ref:`Rect2i` **Rect2i**\ (\ from\: :ref:`Rect2i`\ ) Constructs a **Rect2i** as a copy of the given **Rect2i**. @@ -200,7 +200,7 @@ Constructs a **Rect2i** as a copy of the given **Rect2i**. .. rst-class:: classref-constructor -:ref:`Rect2i` **Rect2i** **(** :ref:`Rect2` from **)** +:ref:`Rect2i` **Rect2i**\ (\ from\: :ref:`Rect2`\ ) Constructs a **Rect2i** from a :ref:`Rect2`. The floating-point coordinates are truncated. @@ -210,7 +210,7 @@ Constructs a **Rect2i** from a :ref:`Rect2`. The floating-point coo .. rst-class:: classref-constructor -:ref:`Rect2i` **Rect2i** **(** :ref:`Vector2i` position, :ref:`Vector2i` size **)** +:ref:`Rect2i` **Rect2i**\ (\ position\: :ref:`Vector2i`, size\: :ref:`Vector2i`\ ) Constructs a **Rect2i** by ``position`` and ``size``. @@ -220,7 +220,7 @@ Constructs a **Rect2i** by ``position`` and ``size``. .. rst-class:: classref-constructor -:ref:`Rect2i` **Rect2i** **(** :ref:`int` x, :ref:`int` y, :ref:`int` width, :ref:`int` height **)** +:ref:`Rect2i` **Rect2i**\ (\ x\: :ref:`int`, y\: :ref:`int`, width\: :ref:`int`, height\: :ref:`int`\ ) Constructs a **Rect2i** by setting its :ref:`position` to (``x``, ``y``), and its :ref:`size` to (``width``, ``height``). @@ -237,7 +237,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Rect2i` **abs** **(** **)** |const| +:ref:`Rect2i` **abs**\ (\ ) |const| Returns a **Rect2i** equivalent to this rectangle, with its width and height modified to be non-negative values, and with its :ref:`position` being the top-left corner of the rectangle. @@ -266,7 +266,7 @@ Returns a **Rect2i** equivalent to this rectangle, with its width and height mod .. rst-class:: classref-method -:ref:`bool` **encloses** **(** :ref:`Rect2i` b **)** |const| +:ref:`bool` **encloses**\ (\ b\: :ref:`Rect2i`\ ) |const| Returns ``true`` if this **Rect2i** completely encloses another one. @@ -278,7 +278,7 @@ Returns ``true`` if this **Rect2i** completely encloses another one. .. rst-class:: classref-method -:ref:`Rect2i` **expand** **(** :ref:`Vector2i` to **)** |const| +:ref:`Rect2i` **expand**\ (\ to\: :ref:`Vector2i`\ ) |const| Returns a copy of this rectangle expanded to align the edges with the given ``to`` point, if necessary. @@ -309,7 +309,7 @@ Returns a copy of this rectangle expanded to align the edges with the given ``to .. rst-class:: classref-method -:ref:`int` **get_area** **(** **)** |const| +:ref:`int` **get_area**\ (\ ) |const| Returns the rectangle's area. This is equivalent to ``size.x * size.y``. See also :ref:`has_area`. @@ -321,7 +321,7 @@ Returns the rectangle's area. This is equivalent to ``size.x * size.y``. See als .. rst-class:: classref-method -:ref:`Vector2i` **get_center** **(** **)** |const| +:ref:`Vector2i` **get_center**\ (\ ) |const| Returns the center point of the rectangle. This is the same as ``position + (size / 2)``. @@ -335,7 +335,7 @@ Returns the center point of the rectangle. This is the same as ``position + (siz .. rst-class:: classref-method -:ref:`Rect2i` **grow** **(** :ref:`int` amount **)** |const| +:ref:`Rect2i` **grow**\ (\ amount\: :ref:`int`\ ) |const| Returns a copy of this rectangle extended on all sides by the given ``amount``. A negative ``amount`` shrinks the rectangle instead. See also :ref:`grow_individual` and :ref:`grow_side`. @@ -362,7 +362,7 @@ Returns a copy of this rectangle extended on all sides by the given ``amount``. .. rst-class:: classref-method -:ref:`Rect2i` **grow_individual** **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** |const| +:ref:`Rect2i` **grow_individual**\ (\ left\: :ref:`int`, top\: :ref:`int`, right\: :ref:`int`, bottom\: :ref:`int`\ ) |const| Returns a copy of this rectangle with its ``left``, ``top``, ``right``, and ``bottom`` sides extended by the given amounts. Negative values shrink the sides, instead. See also :ref:`grow` and :ref:`grow_side`. @@ -374,7 +374,7 @@ Returns a copy of this rectangle with its ``left``, ``top``, ``right``, and ``bo .. rst-class:: classref-method -:ref:`Rect2i` **grow_side** **(** :ref:`int` side, :ref:`int` amount **)** |const| +:ref:`Rect2i` **grow_side**\ (\ side\: :ref:`int`, amount\: :ref:`int`\ ) |const| Returns a copy of this rectangle with its ``side`` extended by the given ``amount`` (see :ref:`Side` constants). A negative ``amount`` shrinks the rectangle, instead. See also :ref:`grow` and :ref:`grow_individual`. @@ -386,7 +386,7 @@ Returns a copy of this rectangle with its ``side`` extended by the given ``amoun .. rst-class:: classref-method -:ref:`bool` **has_area** **(** **)** |const| +:ref:`bool` **has_area**\ (\ ) |const| Returns ``true`` if this rectangle has positive width and height. See also :ref:`get_area`. @@ -398,7 +398,7 @@ Returns ``true`` if this rectangle has positive width and height. See also :ref: .. rst-class:: classref-method -:ref:`bool` **has_point** **(** :ref:`Vector2i` point **)** |const| +:ref:`bool` **has_point**\ (\ point\: :ref:`Vector2i`\ ) |const| Returns ``true`` if the rectangle contains the given ``point``. By convention, points on the right and bottom edges are **not** included. @@ -412,7 +412,7 @@ Returns ``true`` if the rectangle contains the given ``point``. By convention, p .. rst-class:: classref-method -:ref:`Rect2i` **intersection** **(** :ref:`Rect2i` b **)** |const| +:ref:`Rect2i` **intersection**\ (\ b\: :ref:`Rect2i`\ ) |const| Returns the intersection between this rectangle and ``b``. If the rectangles do not intersect, returns an empty **Rect2i**. @@ -445,7 +445,7 @@ Returns the intersection between this rectangle and ``b``. If the rectangles do .. rst-class:: classref-method -:ref:`bool` **intersects** **(** :ref:`Rect2i` b **)** |const| +:ref:`bool` **intersects**\ (\ b\: :ref:`Rect2i`\ ) |const| Returns ``true`` if this rectangle overlaps with the ``b`` rectangle. The edges of both rectangles are excluded. @@ -457,7 +457,7 @@ Returns ``true`` if this rectangle overlaps with the ``b`` rectangle. The edges .. rst-class:: classref-method -:ref:`Rect2i` **merge** **(** :ref:`Rect2i` b **)** |const| +:ref:`Rect2i` **merge**\ (\ b\: :ref:`Rect2i`\ ) |const| Returns a **Rect2i** that encloses both this rectangle and ``b`` around the edges. See also :ref:`encloses`. @@ -474,7 +474,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Rect2i` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Rect2i`\ ) Returns ``true`` if the :ref:`position` or :ref:`size` of both rectangles are not equal. @@ -486,7 +486,7 @@ Returns ``true`` if the :ref:`position` or :ref: .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`Rect2i` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Rect2i`\ ) Returns ``true`` if both :ref:`position` and :ref:`size` of the rectangles are equal, respectively. @@ -497,3 +497,4 @@ Returns ``true`` if both :ref:`position` and :re .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rectangleshape2d.rst b/classes/class_rectangleshape2d.rst index 0cd2a575b5a..4db6354acd9 100644 --- a/classes/class_rectangleshape2d.rst +++ b/classes/class_rectangleshape2d.rst @@ -61,8 +61,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_size**\ (\ ) The rectangle's width and height. @@ -73,3 +73,4 @@ The rectangle's width and height. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_refcounted.rst b/classes/class_refcounted.rst index ff22d1cb039..d09bc3e17f5 100644 --- a/classes/class_refcounted.rst +++ b/classes/class_refcounted.rst @@ -12,7 +12,7 @@ RefCounted **Inherits:** :ref:`Object` -**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorResourceTooltipPlugin`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`JavaClass`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`OpenXRAPIExtension`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`RenderSceneBuffers`, :ref:`RenderSceneBuffersConfiguration`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRPositionalTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` +**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorResourceTooltipPlugin`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`JavaClass`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`OpenXRAPIExtension`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`RenderSceneBuffers`, :ref:`RenderSceneBuffersConfiguration`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRFaceTracker`, :ref:`XRHandTracker`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRPositionalTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` Base class for reference-counted objects. @@ -46,15 +46,15 @@ Methods .. table:: :widths: auto - +-------------------------+---------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_reference_count` **(** **)** |const| | - +-------------------------+---------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`init_ref` **(** **)** | - +-------------------------+---------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`reference` **(** **)** | - +-------------------------+---------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`unreference` **(** **)** | - +-------------------------+---------------------------------------------------------------------------------------------+ + +-------------------------+---------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_reference_count`\ (\ ) |const| | + +-------------------------+---------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`init_ref`\ (\ ) | + +-------------------------+---------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`reference`\ (\ ) | + +-------------------------+---------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`unreference`\ (\ ) | + +-------------------------+---------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -69,7 +69,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_reference_count** **(** **)** |const| +:ref:`int` **get_reference_count**\ (\ ) |const| Returns the current reference count. @@ -81,7 +81,7 @@ Returns the current reference count. .. rst-class:: classref-method -:ref:`bool` **init_ref** **(** **)** +:ref:`bool` **init_ref**\ (\ ) Initializes the internal reference counter. Use this only if you really know what you are doing. @@ -95,7 +95,7 @@ Returns whether the initialization was successful. .. rst-class:: classref-method -:ref:`bool` **reference** **(** **)** +:ref:`bool` **reference**\ (\ ) Increments the internal reference counter. Use this only if you really know what you are doing. @@ -109,7 +109,7 @@ Returns ``true`` if the increment was successful, ``false`` otherwise. .. rst-class:: classref-method -:ref:`bool` **unreference** **(** **)** +:ref:`bool` **unreference**\ (\ ) Decrements the internal reference counter. Use this only if you really know what you are doing. @@ -122,3 +122,4 @@ Returns ``true`` if the object should be freed after the decrement, ``false`` ot .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_referencerect.rst b/classes/class_referencerect.rst index 87391532a05..e6a75188add 100644 --- a/classes/class_referencerect.rst +++ b/classes/class_referencerect.rst @@ -54,8 +54,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_border_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_border_color** **(** **)** +- |void| **set_border_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_border_color**\ (\ ) Sets the border color of the **ReferenceRect**. @@ -71,8 +71,8 @@ Sets the border color of the **ReferenceRect**. .. rst-class:: classref-property-setget -- void **set_border_width** **(** :ref:`float` value **)** -- :ref:`float` **get_border_width** **(** **)** +- |void| **set_border_width**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_border_width**\ (\ ) Sets the border width of the **ReferenceRect**. The border grows both inwards and outwards with respect to the rectangle box. @@ -88,8 +88,8 @@ Sets the border width of the **ReferenceRect**. The border grows both inwards an .. rst-class:: classref-property-setget -- void **set_editor_only** **(** :ref:`bool` value **)** -- :ref:`bool` **get_editor_only** **(** **)** +- |void| **set_editor_only**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_editor_only**\ (\ ) If ``true``, the **ReferenceRect** will only be visible while in editor. Otherwise, **ReferenceRect** will be visible in the running project. @@ -100,3 +100,4 @@ If ``true``, the **ReferenceRect** will only be visible while in editor. Otherwi .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index 84d1fad7cb8..327e60a7a92 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: environment, envmap + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -156,8 +159,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_ambient_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_ambient_color** **(** **)** +- |void| **set_ambient_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_ambient_color**\ (\ ) The custom ambient color to use within the **ReflectionProbe**'s box defined by its :ref:`size`. Only effective if :ref:`ambient_mode` is :ref:`AMBIENT_COLOR`. @@ -173,8 +176,8 @@ The custom ambient color to use within the **ReflectionProbe**'s box defined by .. rst-class:: classref-property-setget -- void **set_ambient_color_energy** **(** :ref:`float` value **)** -- :ref:`float` **get_ambient_color_energy** **(** **)** +- |void| **set_ambient_color_energy**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_ambient_color_energy**\ (\ ) The custom ambient color energy to use within the **ReflectionProbe**'s box defined by its :ref:`size`. Only effective if :ref:`ambient_mode` is :ref:`AMBIENT_COLOR`. @@ -190,8 +193,8 @@ The custom ambient color energy to use within the **ReflectionProbe**'s box defi .. rst-class:: classref-property-setget -- void **set_ambient_mode** **(** :ref:`AmbientMode` value **)** -- :ref:`AmbientMode` **get_ambient_mode** **(** **)** +- |void| **set_ambient_mode**\ (\ value\: :ref:`AmbientMode`\ ) +- :ref:`AmbientMode` **get_ambient_mode**\ (\ ) The ambient color to use within the **ReflectionProbe**'s box defined by its :ref:`size`. The ambient color will smoothly blend with other **ReflectionProbe**\ s and the rest of the scene (outside the **ReflectionProbe**'s box defined by its :ref:`size`). @@ -207,8 +210,8 @@ The ambient color to use within the **ReflectionProbe**'s box defined by its :re .. rst-class:: classref-property-setget -- void **set_enable_box_projection** **(** :ref:`bool` value **)** -- :ref:`bool` **is_box_projection_enabled** **(** **)** +- |void| **set_enable_box_projection**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_box_projection_enabled**\ (\ ) If ``true``, enables box projection. This makes reflections look more correct in rectangle-shaped rooms by offsetting the reflection center depending on the camera's location. @@ -226,8 +229,8 @@ If ``true``, enables box projection. This makes reflections look more correct in .. rst-class:: classref-property-setget -- void **set_cull_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_cull_mask** **(** **)** +- |void| **set_cull_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_cull_mask**\ (\ ) Sets the cull mask which determines what objects are drawn by this probe. Every :ref:`VisualInstance3D` with a layer included in this cull mask will be rendered by the probe. It is best to only include large objects which are likely to take up a lot of space in the reflection in order to save on rendering cost. @@ -245,8 +248,8 @@ This can also be used to prevent an object from reflecting upon itself (for inst .. rst-class:: classref-property-setget -- void **set_enable_shadows** **(** :ref:`bool` value **)** -- :ref:`bool` **are_shadows_enabled** **(** **)** +- |void| **set_enable_shadows**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **are_shadows_enabled**\ (\ ) If ``true``, computes shadows in the reflection probe. This makes the reflection probe slower to render; you may want to disable this if using the :ref:`UPDATE_ALWAYS` :ref:`update_mode`. @@ -262,8 +265,8 @@ If ``true``, computes shadows in the reflection probe. This makes the reflection .. rst-class:: classref-property-setget -- void **set_intensity** **(** :ref:`float` value **)** -- :ref:`float` **get_intensity** **(** **)** +- |void| **set_intensity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_intensity**\ (\ ) Defines the reflection intensity. Intensity modulates the strength of the reflection. @@ -279,8 +282,8 @@ Defines the reflection intensity. Intensity modulates the strength of the reflec .. rst-class:: classref-property-setget -- void **set_as_interior** **(** :ref:`bool` value **)** -- :ref:`bool` **is_set_as_interior** **(** **)** +- |void| **set_as_interior**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_set_as_interior**\ (\ ) If ``true``, reflections will ignore sky contribution. @@ -296,8 +299,8 @@ If ``true``, reflections will ignore sky contribution. .. rst-class:: classref-property-setget -- void **set_max_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_max_distance** **(** **)** +- |void| **set_max_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_max_distance**\ (\ ) The maximum distance away from the **ReflectionProbe** an object can be before it is culled. Decrease this to improve performance, especially when using the :ref:`UPDATE_ALWAYS` :ref:`update_mode`. @@ -315,8 +318,8 @@ The maximum distance away from the **ReflectionProbe** an object can be before i .. rst-class:: classref-property-setget -- void **set_mesh_lod_threshold** **(** :ref:`float` value **)** -- :ref:`float` **get_mesh_lod_threshold** **(** **)** +- |void| **set_mesh_lod_threshold**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_mesh_lod_threshold**\ (\ ) The automatic LOD bias to use for meshes rendered within the **ReflectionProbe** (this is analog to :ref:`Viewport.mesh_lod_threshold`). Higher values will use less detailed versions of meshes that have LOD variations generated. If set to ``0.0``, automatic LOD is disabled. Increase :ref:`mesh_lod_threshold` to improve performance at the cost of geometry detail, especially when using the :ref:`UPDATE_ALWAYS` :ref:`update_mode`. @@ -334,8 +337,8 @@ The automatic LOD bias to use for meshes rendered within the **ReflectionProbe** .. rst-class:: classref-property-setget -- void **set_origin_offset** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_origin_offset** **(** **)** +- |void| **set_origin_offset**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_origin_offset**\ (\ ) Sets the origin offset to be used when this **ReflectionProbe** is in :ref:`box_projection` mode. This can be set to a non-zero value to ensure a reflection fits a rectangle-shaped room, while reducing the number of objects that "get in the way" of the reflection. @@ -351,8 +354,8 @@ Sets the origin offset to be used when this **ReflectionProbe** is in :ref:`box_ .. rst-class:: classref-property-setget -- void **set_reflection_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_reflection_mask** **(** **)** +- |void| **set_reflection_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_reflection_mask**\ (\ ) Sets the reflection mask which determines what objects have reflections applied from this probe. Every :ref:`VisualInstance3D` with a layer included in this reflection mask will have reflections applied from this probe. See also :ref:`cull_mask`, which can be used to exclude objects from appearing in the reflection while still making them affected by the **ReflectionProbe**. @@ -368,8 +371,8 @@ Sets the reflection mask which determines what objects have reflections applied .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_size**\ (\ ) The size of the reflection probe. The larger the size, the more space covered by the probe, which will lower the perceived resolution. It is best to keep the size only as large as you need it. @@ -387,8 +390,8 @@ The size of the reflection probe. The larger the size, the more space covered by .. rst-class:: classref-property-setget -- void **set_update_mode** **(** :ref:`UpdateMode` value **)** -- :ref:`UpdateMode` **get_update_mode** **(** **)** +- |void| **set_update_mode**\ (\ value\: :ref:`UpdateMode`\ ) +- :ref:`UpdateMode` **get_update_mode**\ (\ ) Sets how frequently the **ReflectionProbe** is updated. Can be :ref:`UPDATE_ONCE` or :ref:`UPDATE_ALWAYS`. @@ -399,3 +402,4 @@ Sets how frequently the **ReflectionProbe** is updated. Can be :ref:`UPDATE_ONCE .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_regex.rst b/classes/class_regex.rst index 833ca1976ce..8fee18f0e5c 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -83,27 +83,27 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`compile` **(** :ref:`String` pattern **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RegEx` | :ref:`create_from_string` **(** :ref:`String` pattern **)** |static| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_group_count` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_names` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_pattern` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RegExMatch` | :ref:`search` **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RegExMatch[]` | :ref:`search_all` **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`sub` **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=0, :ref:`int` end=-1 **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`compile`\ (\ pattern\: :ref:`String`\ ) | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RegEx` | :ref:`create_from_string`\ (\ pattern\: :ref:`String`\ ) |static| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_group_count`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_names`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_pattern`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid`\ (\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RegExMatch` | :ref:`search`\ (\ subject\: :ref:`String`, offset\: :ref:`int` = 0, end\: :ref:`int` = -1\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`RegExMatch`\] | :ref:`search_all`\ (\ subject\: :ref:`String`, offset\: :ref:`int` = 0, end\: :ref:`int` = -1\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`sub`\ (\ subject\: :ref:`String`, replacement\: :ref:`String`, all\: :ref:`bool` = false, offset\: :ref:`int` = 0, end\: :ref:`int` = -1\ ) |const| | + +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -118,7 +118,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) This method resets the state of the object, as if it was freshly created. Namely, it unassigns the regular expression of this object. @@ -130,7 +130,7 @@ This method resets the state of the object, as if it was freshly created. Namely .. rst-class:: classref-method -:ref:`Error` **compile** **(** :ref:`String` pattern **)** +:ref:`Error` **compile**\ (\ pattern\: :ref:`String`\ ) Compiles and assign the search pattern to use. Returns :ref:`@GlobalScope.OK` if the compilation is successful. If an error is encountered, details are printed to standard output and an error is returned. @@ -142,7 +142,7 @@ Compiles and assign the search pattern to use. Returns :ref:`@GlobalScope.OK` **create_from_string** **(** :ref:`String` pattern **)** |static| +:ref:`RegEx` **create_from_string**\ (\ pattern\: :ref:`String`\ ) |static| Creates and compiles a new **RegEx** object. @@ -154,7 +154,7 @@ Creates and compiles a new **RegEx** object. .. rst-class:: classref-method -:ref:`int` **get_group_count** **(** **)** |const| +:ref:`int` **get_group_count**\ (\ ) |const| Returns the number of capturing groups in compiled pattern. @@ -166,7 +166,7 @@ Returns the number of capturing groups in compiled pattern. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_names** **(** **)** |const| +:ref:`PackedStringArray` **get_names**\ (\ ) |const| Returns an array of names of named capturing groups in the compiled pattern. They are ordered by appearance. @@ -178,7 +178,7 @@ Returns an array of names of named capturing groups in the compiled pattern. The .. rst-class:: classref-method -:ref:`String` **get_pattern** **(** **)** |const| +:ref:`String` **get_pattern**\ (\ ) |const| Returns the original search pattern that was compiled. @@ -190,7 +190,7 @@ Returns the original search pattern that was compiled. .. rst-class:: classref-method -:ref:`bool` **is_valid** **(** **)** |const| +:ref:`bool` **is_valid**\ (\ ) |const| Returns whether this object has a valid search pattern assigned. @@ -202,7 +202,7 @@ Returns whether this object has a valid search pattern assigned. .. rst-class:: classref-method -:ref:`RegExMatch` **search** **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** |const| +:ref:`RegExMatch` **search**\ (\ subject\: :ref:`String`, offset\: :ref:`int` = 0, end\: :ref:`int` = -1\ ) |const| Searches the text for the compiled pattern. Returns a :ref:`RegExMatch` container of the first matching result if found, otherwise ``null``. @@ -216,7 +216,7 @@ The region to search within can be specified with ``offset`` and ``end``. This i .. rst-class:: classref-method -:ref:`RegExMatch[]` **search_all** **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** |const| +:ref:`Array`\[:ref:`RegExMatch`\] **search_all**\ (\ subject\: :ref:`String`, offset\: :ref:`int` = 0, end\: :ref:`int` = -1\ ) |const| Searches the text for the compiled pattern. Returns an array of :ref:`RegExMatch` containers for each non-overlapping result. If no results were found, an empty array is returned instead. @@ -230,7 +230,7 @@ The region to search within can be specified with ``offset`` and ``end``. This i .. rst-class:: classref-method -:ref:`String` **sub** **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=0, :ref:`int` end=-1 **)** |const| +:ref:`String` **sub**\ (\ subject\: :ref:`String`, replacement\: :ref:`String`, all\: :ref:`bool` = false, offset\: :ref:`int` = 0, end\: :ref:`int` = -1\ ) |const| Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as ``$1`` and ``$name`` are expanded and resolved. By default, only the first instance is replaced, but it can be changed for all instances (global replacement). @@ -243,3 +243,4 @@ The region to search within can be specified with ``offset`` and ``end``. This i .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_regexmatch.rst b/classes/class_regexmatch.rst index 50ac6471aa7..ded48dc51b2 100644 --- a/classes/class_regexmatch.rst +++ b/classes/class_regexmatch.rst @@ -45,15 +45,15 @@ Methods .. table:: :widths: auto - +-----------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_end` **(** :ref:`Variant` name=0 **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_group_count` **(** **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_start` **(** :ref:`Variant` name=0 **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_string` **(** :ref:`Variant` name=0 **)** |const| | - +-----------------------------+----------------------------------------------------------------------------------------------------------------+ + +-----------------------------+---------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_end`\ (\ name\: :ref:`Variant` = 0\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_group_count`\ (\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_start`\ (\ name\: :ref:`Variant` = 0\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_string`\ (\ name\: :ref:`Variant` = 0\ ) |const| | + +-----------------------------+---------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -72,7 +72,7 @@ Property Descriptions .. rst-class:: classref-property-setget -- :ref:`Dictionary` **get_names** **(** **)** +- :ref:`Dictionary` **get_names**\ (\ ) A dictionary of named groups and its corresponding group number. Only groups that were matched are included. If multiple groups have the same name, that name would refer to the first matching one. @@ -88,7 +88,7 @@ A dictionary of named groups and its corresponding group number. Only groups tha .. rst-class:: classref-property-setget -- :ref:`PackedStringArray` **get_strings** **(** **)** +- :ref:`PackedStringArray` **get_strings**\ (\ ) An :ref:`Array` of the match and its capturing groups. @@ -104,7 +104,7 @@ An :ref:`Array` of the match and its capturing groups. .. rst-class:: classref-property-setget -- :ref:`String` **get_subject** **(** **)** +- :ref:`String` **get_subject**\ (\ ) The source string used with the search pattern to find this matching result. @@ -121,7 +121,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_end** **(** :ref:`Variant` name=0 **)** |const| +:ref:`int` **get_end**\ (\ name\: :ref:`Variant` = 0\ ) |const| Returns the end position of the match within the source string. The end position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. @@ -135,7 +135,7 @@ Returns -1 if the group did not match or doesn't exist. .. rst-class:: classref-method -:ref:`int` **get_group_count** **(** **)** |const| +:ref:`int` **get_group_count**\ (\ ) |const| Returns the number of capturing groups. @@ -147,7 +147,7 @@ Returns the number of capturing groups. .. rst-class:: classref-method -:ref:`int` **get_start** **(** :ref:`Variant` name=0 **)** |const| +:ref:`int` **get_start**\ (\ name\: :ref:`Variant` = 0\ ) |const| Returns the starting position of the match within the source string. The starting position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. @@ -161,7 +161,7 @@ Returns -1 if the group did not match or doesn't exist. .. rst-class:: classref-method -:ref:`String` **get_string** **(** :ref:`Variant` name=0 **)** |const| +:ref:`String` **get_string**\ (\ name\: :ref:`Variant` = 0\ ) |const| Returns the substring of the match from the source string. Capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. @@ -174,3 +174,4 @@ Returns an empty string if the group did not match or doesn't exist. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index 447d030177f..3b5af833ea8 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -51,9 +51,9 @@ Methods .. table:: :widths: auto - +------+------------------------------------------------------------------------------------------+ - | void | :ref:`force_update_cache` **(** **)** | - +------+------------------------------------------------------------------------------------------+ + +--------+------------------------------------------------------------------------------------+ + | |void| | :ref:`force_update_cache`\ (\ ) | + +--------+------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -72,8 +72,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_remote_node** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_remote_node** **(** **)** +- |void| **set_remote_node**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_remote_node**\ (\ ) The :ref:`NodePath` to the remote node, relative to the RemoteTransform2D's position in the scene. @@ -89,8 +89,8 @@ The :ref:`NodePath` to the remote node, relative to the RemoteTr .. rst-class:: classref-property-setget -- void **set_update_position** **(** :ref:`bool` value **)** -- :ref:`bool` **get_update_position** **(** **)** +- |void| **set_update_position**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_update_position**\ (\ ) If ``true``, the remote node's position is updated. @@ -106,8 +106,8 @@ If ``true``, the remote node's position is updated. .. rst-class:: classref-property-setget -- void **set_update_rotation** **(** :ref:`bool` value **)** -- :ref:`bool` **get_update_rotation** **(** **)** +- |void| **set_update_rotation**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_update_rotation**\ (\ ) If ``true``, the remote node's rotation is updated. @@ -123,8 +123,8 @@ If ``true``, the remote node's rotation is updated. .. rst-class:: classref-property-setget -- void **set_update_scale** **(** :ref:`bool` value **)** -- :ref:`bool` **get_update_scale** **(** **)** +- |void| **set_update_scale**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_update_scale**\ (\ ) If ``true``, the remote node's scale is updated. @@ -140,8 +140,8 @@ If ``true``, the remote node's scale is updated. .. rst-class:: classref-property-setget -- void **set_use_global_coordinates** **(** :ref:`bool` value **)** -- :ref:`bool` **get_use_global_coordinates** **(** **)** +- |void| **set_use_global_coordinates**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_global_coordinates**\ (\ ) If ``true``, global coordinates are used. If ``false``, local coordinates are used. @@ -158,7 +158,7 @@ Method Descriptions .. rst-class:: classref-method -void **force_update_cache** **(** **)** +|void| **force_update_cache**\ (\ ) **RemoteTransform2D** caches the remote node. It may not notice if the remote node disappears; :ref:`force_update_cache` forces it to update the cache again. @@ -169,3 +169,4 @@ void **force_update_cache** **(** **)** .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_remotetransform3d.rst b/classes/class_remotetransform3d.rst index 99e84d52e17..4e088aaa574 100644 --- a/classes/class_remotetransform3d.rst +++ b/classes/class_remotetransform3d.rst @@ -51,9 +51,9 @@ Methods .. table:: :widths: auto - +------+------------------------------------------------------------------------------------------+ - | void | :ref:`force_update_cache` **(** **)** | - +------+------------------------------------------------------------------------------------------+ + +--------+------------------------------------------------------------------------------------+ + | |void| | :ref:`force_update_cache`\ (\ ) | + +--------+------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -72,8 +72,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_remote_node** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_remote_node** **(** **)** +- |void| **set_remote_node**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_remote_node**\ (\ ) The :ref:`NodePath` to the remote node, relative to the RemoteTransform3D's position in the scene. @@ -89,8 +89,8 @@ The :ref:`NodePath` to the remote node, relative to the RemoteTr .. rst-class:: classref-property-setget -- void **set_update_position** **(** :ref:`bool` value **)** -- :ref:`bool` **get_update_position** **(** **)** +- |void| **set_update_position**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_update_position**\ (\ ) If ``true``, the remote node's position is updated. @@ -106,8 +106,8 @@ If ``true``, the remote node's position is updated. .. rst-class:: classref-property-setget -- void **set_update_rotation** **(** :ref:`bool` value **)** -- :ref:`bool` **get_update_rotation** **(** **)** +- |void| **set_update_rotation**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_update_rotation**\ (\ ) If ``true``, the remote node's rotation is updated. @@ -123,8 +123,8 @@ If ``true``, the remote node's rotation is updated. .. rst-class:: classref-property-setget -- void **set_update_scale** **(** :ref:`bool` value **)** -- :ref:`bool` **get_update_scale** **(** **)** +- |void| **set_update_scale**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_update_scale**\ (\ ) If ``true``, the remote node's scale is updated. @@ -140,8 +140,8 @@ If ``true``, the remote node's scale is updated. .. rst-class:: classref-property-setget -- void **set_use_global_coordinates** **(** :ref:`bool` value **)** -- :ref:`bool` **get_use_global_coordinates** **(** **)** +- |void| **set_use_global_coordinates**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_global_coordinates**\ (\ ) If ``true``, global coordinates are used. If ``false``, local coordinates are used. @@ -158,7 +158,7 @@ Method Descriptions .. rst-class:: classref-method -void **force_update_cache** **(** **)** +|void| **force_update_cache**\ (\ ) **RemoteTransform3D** caches the remote node. It may not notice if the remote node disappears; :ref:`force_update_cache` forces it to update the cache again. @@ -169,3 +169,4 @@ void **force_update_cache** **(** **)** .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_renderdata.rst b/classes/class_renderdata.rst new file mode 100644 index 00000000000..1a212ce20fd --- /dev/null +++ b/classes/class_renderdata.rst @@ -0,0 +1,106 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderData.xml. + +.. _class_RenderData: + +RenderData +========== + +**Inherits:** :ref:`Object` + +**Inherited By:** :ref:`RenderDataExtension`, :ref:`RenderDataRD` + +Abstract render data object, holds frame data related to rendering a single frame of a viewport. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Abstract render data object, exists for the duration of rendering a single viewport. + +\ **Note:** This is an internal rendering server object, do not instantiate this from script. + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_camera_attributes`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_environment`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+ + | :ref:`RenderSceneBuffers` | :ref:`get_render_scene_buffers`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+ + | :ref:`RenderSceneData` | :ref:`get_render_scene_data`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_RenderData_method_get_camera_attributes: + +.. rst-class:: classref-method + +:ref:`RID` **get_camera_attributes**\ (\ ) |const| + +Returns the :ref:`RID` of the camera attributes object in the :ref:`RenderingServer` being used to render this viewport. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderData_method_get_environment: + +.. rst-class:: classref-method + +:ref:`RID` **get_environment**\ (\ ) |const| + +Returns the :ref:`RID` of the environments object in the :ref:`RenderingServer` being used to render this viewport. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderData_method_get_render_scene_buffers: + +.. rst-class:: classref-method + +:ref:`RenderSceneBuffers` **get_render_scene_buffers**\ (\ ) |const| + +Returns the :ref:`RenderSceneBuffers` object managing the scene buffers for rendering this viewport. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderData_method_get_render_scene_data: + +.. rst-class:: classref-method + +:ref:`RenderSceneData` **get_render_scene_data**\ (\ ) |const| + +Returns the :ref:`RenderSceneData` object managing this frames scene data. + +.. |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.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_renderdataextension.rst b/classes/class_renderdataextension.rst new file mode 100644 index 00000000000..a8facc71d95 --- /dev/null +++ b/classes/class_renderdataextension.rst @@ -0,0 +1,104 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderDataExtension.xml. + +.. _class_RenderDataExtension: + +RenderDataExtension +=================== + +**Inherits:** :ref:`RenderData` **<** :ref:`Object` + +This class allows for a RenderData implementation to be made in GDExtension. + +.. rst-class:: classref-introduction-group + +Description +----------- + +This class allows for a RenderData implementation to be made in GDExtension. + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_get_camera_attributes`\ (\ ) |virtual| |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_get_environment`\ (\ ) |virtual| |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RenderSceneBuffers` | :ref:`_get_render_scene_buffers`\ (\ ) |virtual| |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RenderSceneData` | :ref:`_get_render_scene_data`\ (\ ) |virtual| |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_RenderDataExtension_private_method__get_camera_attributes: + +.. rst-class:: classref-method + +:ref:`RID` **_get_camera_attributes**\ (\ ) |virtual| |const| + +Implement this in GDExtension to return the :ref:`RID` for the implementations camera attributes object. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderDataExtension_private_method__get_environment: + +.. rst-class:: classref-method + +:ref:`RID` **_get_environment**\ (\ ) |virtual| |const| + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderDataExtension_private_method__get_render_scene_buffers: + +.. rst-class:: classref-method + +:ref:`RenderSceneBuffers` **_get_render_scene_buffers**\ (\ ) |virtual| |const| + +Implement this in GDExtension to return the :ref:`RID` of the implementations environment object. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderDataExtension_private_method__get_render_scene_data: + +.. rst-class:: classref-method + +:ref:`RenderSceneData` **_get_render_scene_data**\ (\ ) |virtual| |const| + +Implement this in GDExtension to return the implementations :ref:`RenderSceneDataExtension` object. + +.. |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.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_renderdatard.rst b/classes/class_renderdatard.rst new file mode 100644 index 00000000000..02f36a9d959 --- /dev/null +++ b/classes/class_renderdatard.rst @@ -0,0 +1,35 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderDataRD.xml. + +.. _class_RenderDataRD: + +RenderDataRD +============ + +**Inherits:** :ref:`RenderData` **<** :ref:`Object` + +Render data implementation for the RenderingDevice based renderers. + +\ **Note:** This is an internal rendering server object, do not instantiate this from script. + +.. rst-class:: classref-introduction-group + +Description +----------- + +This object manages all render data for the rendering device based renderers. + +\ **Note:** This is an internal rendering server object only exposed for GDExtension plugins. + +.. |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.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_renderingdevice.rst b/classes/class_renderingdevice.rst index 9fd3a8b814b..9d89e189984 100644 --- a/classes/class_renderingdevice.rst +++ b/classes/class_renderingdevice.rst @@ -44,201 +44,201 @@ Methods .. table:: :widths: auto - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`barrier` **(** |bitfield|\<:ref:`BarrierMask`\> from=32767, |bitfield|\<:ref:`BarrierMask`\> to=32767 **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`buffer_clear` **(** :ref:`RID` buffer, :ref:`int` offset, :ref:`int` size_bytes **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`buffer_copy` **(** :ref:`RID` src_buffer, :ref:`RID` dst_buffer, :ref:`int` src_offset, :ref:`int` dst_offset, :ref:`int` size **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`buffer_get_data` **(** :ref:`RID` buffer, :ref:`int` offset_bytes=0, :ref:`int` size_bytes=0 **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`buffer_update` **(** :ref:`RID` buffer, :ref:`int` offset, :ref:`int` size_bytes, :ref:`PackedByteArray` data **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`capture_timestamp` **(** :ref:`String` name **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`compute_list_add_barrier` **(** :ref:`int` compute_list **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`compute_list_begin` **(** **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`compute_list_bind_compute_pipeline` **(** :ref:`int` compute_list, :ref:`RID` compute_pipeline **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`compute_list_bind_uniform_set` **(** :ref:`int` compute_list, :ref:`RID` uniform_set, :ref:`int` set_index **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`compute_list_dispatch` **(** :ref:`int` compute_list, :ref:`int` x_groups, :ref:`int` y_groups, :ref:`int` z_groups **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`compute_list_end` **(** **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`compute_list_set_push_constant` **(** :ref:`int` compute_list, :ref:`PackedByteArray` buffer, :ref:`int` size_bytes **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`compute_pipeline_create` **(** :ref:`RID` shader, :ref:`RDPipelineSpecializationConstant[]` specialization_constants=[] **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`compute_pipeline_is_valid` **(** :ref:`RID` compute_pipeline **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RenderingDevice` | :ref:`create_local_device` **(** **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_command_begin_label` **(** :ref:`String` name, :ref:`Color` color **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_command_end_label` **(** **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_command_insert_label` **(** :ref:`String` name, :ref:`Color` color **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`draw_list_begin` **(** :ref:`RID` framebuffer, :ref:`InitialAction` initial_color_action, :ref:`FinalAction` final_color_action, :ref:`InitialAction` initial_depth_action, :ref:`FinalAction` final_depth_action, :ref:`PackedColorArray` clear_color_values=PackedColorArray(), :ref:`float` clear_depth=1.0, :ref:`int` clear_stencil=0, :ref:`Rect2` region=Rect2(0, 0, 0, 0) **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`draw_list_begin_for_screen` **(** :ref:`int` screen=0, :ref:`Color` clear_color=Color(0, 0, 0, 1) **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`draw_list_begin_split` **(** :ref:`RID` framebuffer, :ref:`int` splits, :ref:`InitialAction` initial_color_action, :ref:`FinalAction` final_color_action, :ref:`InitialAction` initial_depth_action, :ref:`FinalAction` final_depth_action, :ref:`PackedColorArray` clear_color_values=PackedColorArray(), :ref:`float` clear_depth=1.0, :ref:`int` clear_stencil=0, :ref:`Rect2` region=Rect2(0, 0, 0, 0), :ref:`RID[]` storage_textures=[] **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_list_bind_index_array` **(** :ref:`int` draw_list, :ref:`RID` index_array **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_list_bind_render_pipeline` **(** :ref:`int` draw_list, :ref:`RID` render_pipeline **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_list_bind_uniform_set` **(** :ref:`int` draw_list, :ref:`RID` uniform_set, :ref:`int` set_index **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_list_bind_vertex_array` **(** :ref:`int` draw_list, :ref:`RID` vertex_array **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_list_disable_scissor` **(** :ref:`int` draw_list **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_list_draw` **(** :ref:`int` draw_list, :ref:`bool` use_indices, :ref:`int` instances, :ref:`int` procedural_vertex_count=0 **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_list_enable_scissor` **(** :ref:`int` draw_list, :ref:`Rect2` rect=Rect2(0, 0, 0, 0) **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_list_end` **(** **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_list_set_blend_constants` **(** :ref:`int` draw_list, :ref:`Color` color **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_list_set_push_constant` **(** :ref:`int` draw_list, :ref:`PackedByteArray` buffer, :ref:`int` size_bytes **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`draw_list_switch_to_next_pass` **(** **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`draw_list_switch_to_next_pass_split` **(** :ref:`int` splits **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`framebuffer_create` **(** :ref:`RID[]` textures, :ref:`int` validate_with_format=-1, :ref:`int` view_count=1 **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`framebuffer_create_empty` **(** :ref:`Vector2i` size, :ref:`TextureSamples` samples=0, :ref:`int` validate_with_format=-1 **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`framebuffer_create_multipass` **(** :ref:`RID[]` textures, :ref:`RDFramebufferPass[]` passes, :ref:`int` validate_with_format=-1, :ref:`int` view_count=1 **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`framebuffer_format_create` **(** :ref:`RDAttachmentFormat[]` attachments, :ref:`int` view_count=1 **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`framebuffer_format_create_empty` **(** :ref:`TextureSamples` samples=0 **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`framebuffer_format_create_multipass` **(** :ref:`RDAttachmentFormat[]` attachments, :ref:`RDFramebufferPass[]` passes, :ref:`int` view_count=1 **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TextureSamples` | :ref:`framebuffer_format_get_texture_samples` **(** :ref:`int` format, :ref:`int` render_pass=0 **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`framebuffer_get_format` **(** :ref:`RID` framebuffer **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`framebuffer_is_valid` **(** :ref:`RID` framebuffer **)** |const| | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`free_rid` **(** :ref:`RID` rid **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`full_barrier` **(** **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_captured_timestamp_cpu_time` **(** :ref:`int` index **)** |const| | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_captured_timestamp_gpu_time` **(** :ref:`int` index **)** |const| | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_captured_timestamp_name` **(** :ref:`int` index **)** |const| | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_captured_timestamps_count` **(** **)** |const| | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_captured_timestamps_frame` **(** **)** |const| | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_device_name` **(** **)** |const| | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_device_pipeline_cache_uuid` **(** **)** |const| | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_device_vendor_name` **(** **)** |const| | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_driver_resource` **(** :ref:`DriverResource` resource, :ref:`RID` rid, :ref:`int` index **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_frame_delay` **(** **)** |const| | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_memory_usage` **(** :ref:`MemoryType` type **)** |const| | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`index_array_create` **(** :ref:`RID` index_buffer, :ref:`int` index_offset, :ref:`int` index_count **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`index_buffer_create` **(** :ref:`int` size_indices, :ref:`IndexBufferFormat` format, :ref:`PackedByteArray` data=PackedByteArray(), :ref:`bool` use_restart_indices=false **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`limit_get` **(** :ref:`Limit` limit **)** |const| | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`render_pipeline_create` **(** :ref:`RID` shader, :ref:`int` framebuffer_format, :ref:`int` vertex_format, :ref:`RenderPrimitive` primitive, :ref:`RDPipelineRasterizationState` rasterization_state, :ref:`RDPipelineMultisampleState` multisample_state, :ref:`RDPipelineDepthStencilState` stencil_state, :ref:`RDPipelineColorBlendState` color_blend_state, |bitfield|\<:ref:`PipelineDynamicStateFlags`\> dynamic_state_flags=0, :ref:`int` for_render_pass=0, :ref:`RDPipelineSpecializationConstant[]` specialization_constants=[] **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`render_pipeline_is_valid` **(** :ref:`RID` render_pipeline **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`sampler_create` **(** :ref:`RDSamplerState` state **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`sampler_is_format_supported_for_filter` **(** :ref:`DataFormat` format, :ref:`SamplerFilter` sampler_filter **)** |const| | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`screen_get_framebuffer_format` **(** :ref:`int` screen=0 **)** |const| | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`screen_get_height` **(** :ref:`int` screen=0 **)** |const| | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`screen_get_width` **(** :ref:`int` screen=0 **)** |const| | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_resource_name` **(** :ref:`RID` id, :ref:`String` name **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`shader_compile_binary_from_spirv` **(** :ref:`RDShaderSPIRV` spirv_data, :ref:`String` name="" **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RDShaderSPIRV` | :ref:`shader_compile_spirv_from_source` **(** :ref:`RDShaderSource` shader_source, :ref:`bool` allow_cache=true **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`shader_create_from_bytecode` **(** :ref:`PackedByteArray` binary_data, :ref:`RID` placeholder_rid=RID() **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`shader_create_from_spirv` **(** :ref:`RDShaderSPIRV` spirv_data, :ref:`String` name="" **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`shader_create_placeholder` **(** **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shader_get_vertex_input_attribute_mask` **(** :ref:`RID` shader **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`storage_buffer_create` **(** :ref:`int` size_bytes, :ref:`PackedByteArray` data=PackedByteArray(), |bitfield|\<:ref:`StorageBufferUsage`\> usage=0 **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`submit` **(** **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`sync` **(** **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`texture_buffer_create` **(** :ref:`int` size_bytes, :ref:`DataFormat` format, :ref:`PackedByteArray` data=PackedByteArray() **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`texture_clear` **(** :ref:`RID` texture, :ref:`Color` color, :ref:`int` base_mipmap, :ref:`int` mipmap_count, :ref:`int` base_layer, :ref:`int` layer_count **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`texture_copy` **(** :ref:`RID` from_texture, :ref:`RID` to_texture, :ref:`Vector3` from_pos, :ref:`Vector3` to_pos, :ref:`Vector3` size, :ref:`int` src_mipmap, :ref:`int` dst_mipmap, :ref:`int` src_layer, :ref:`int` dst_layer **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`texture_create` **(** :ref:`RDTextureFormat` format, :ref:`RDTextureView` view, :ref:`PackedByteArray[]` data=[] **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`texture_create_from_extension` **(** :ref:`TextureType` type, :ref:`DataFormat` format, :ref:`TextureSamples` samples, |bitfield|\<:ref:`TextureUsageBits`\> usage_flags, :ref:`int` image, :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`int` layers **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`texture_create_shared` **(** :ref:`RDTextureView` view, :ref:`RID` with_texture **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`texture_create_shared_from_slice` **(** :ref:`RDTextureView` view, :ref:`RID` with_texture, :ref:`int` layer, :ref:`int` mipmap, :ref:`int` mipmaps=1, :ref:`TextureSliceType` slice_type=0 **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`texture_get_data` **(** :ref:`RID` texture, :ref:`int` layer **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RDTextureFormat` | :ref:`texture_get_format` **(** :ref:`RID` texture **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`texture_get_native_handle` **(** :ref:`RID` texture **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`texture_is_format_supported_for_usage` **(** :ref:`DataFormat` format, |bitfield|\<:ref:`TextureUsageBits`\> usage_flags **)** |const| | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`texture_is_shared` **(** :ref:`RID` texture **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`texture_is_valid` **(** :ref:`RID` texture **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`texture_resolve_multisample` **(** :ref:`RID` from_texture, :ref:`RID` to_texture **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`texture_update` **(** :ref:`RID` texture, :ref:`int` layer, :ref:`PackedByteArray` data **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`uniform_buffer_create` **(** :ref:`int` size_bytes, :ref:`PackedByteArray` data=PackedByteArray() **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`uniform_set_create` **(** :ref:`RDUniform[]` uniforms, :ref:`RID` shader, :ref:`int` shader_set **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`uniform_set_is_valid` **(** :ref:`RID` uniform_set **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`vertex_array_create` **(** :ref:`int` vertex_count, :ref:`int` vertex_format, :ref:`RID[]` src_buffers, :ref:`PackedInt64Array` offsets=PackedInt64Array() **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`vertex_buffer_create` **(** :ref:`int` size_bytes, :ref:`PackedByteArray` data=PackedByteArray(), :ref:`bool` use_as_storage=false **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`vertex_format_create` **(** :ref:`RDVertexAttribute[]` vertex_descriptions **)** | - +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`barrier`\ (\ from\: |bitfield|\[:ref:`BarrierMask`\] = 32767, to\: |bitfield|\[:ref:`BarrierMask`\] = 32767\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`buffer_clear`\ (\ buffer\: :ref:`RID`, offset\: :ref:`int`, size_bytes\: :ref:`int`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`buffer_copy`\ (\ src_buffer\: :ref:`RID`, dst_buffer\: :ref:`RID`, src_offset\: :ref:`int`, dst_offset\: :ref:`int`, size\: :ref:`int`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`buffer_get_data`\ (\ buffer\: :ref:`RID`, offset_bytes\: :ref:`int` = 0, size_bytes\: :ref:`int` = 0\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`buffer_update`\ (\ buffer\: :ref:`RID`, offset\: :ref:`int`, size_bytes\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`capture_timestamp`\ (\ name\: :ref:`String`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`compute_list_add_barrier`\ (\ compute_list\: :ref:`int`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`compute_list_begin`\ (\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`compute_list_bind_compute_pipeline`\ (\ compute_list\: :ref:`int`, compute_pipeline\: :ref:`RID`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`compute_list_bind_uniform_set`\ (\ compute_list\: :ref:`int`, uniform_set\: :ref:`RID`, set_index\: :ref:`int`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`compute_list_dispatch`\ (\ compute_list\: :ref:`int`, x_groups\: :ref:`int`, y_groups\: :ref:`int`, z_groups\: :ref:`int`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`compute_list_end`\ (\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`compute_list_set_push_constant`\ (\ compute_list\: :ref:`int`, buffer\: :ref:`PackedByteArray`, size_bytes\: :ref:`int`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`compute_pipeline_create`\ (\ shader\: :ref:`RID`, specialization_constants\: :ref:`Array`\[:ref:`RDPipelineSpecializationConstant`\] = []\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`compute_pipeline_is_valid`\ (\ compute_pipeline\: :ref:`RID`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RenderingDevice` | :ref:`create_local_device`\ (\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_command_begin_label`\ (\ name\: :ref:`String`, color\: :ref:`Color`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_command_end_label`\ (\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_command_insert_label`\ (\ name\: :ref:`String`, color\: :ref:`Color`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`draw_list_begin`\ (\ framebuffer\: :ref:`RID`, initial_color_action\: :ref:`InitialAction`, final_color_action\: :ref:`FinalAction`, initial_depth_action\: :ref:`InitialAction`, final_depth_action\: :ref:`FinalAction`, clear_color_values\: :ref:`PackedColorArray` = PackedColorArray(), clear_depth\: :ref:`float` = 1.0, clear_stencil\: :ref:`int` = 0, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0)\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`draw_list_begin_for_screen`\ (\ screen\: :ref:`int` = 0, clear_color\: :ref:`Color` = Color(0, 0, 0, 1)\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`draw_list_begin_split`\ (\ framebuffer\: :ref:`RID`, splits\: :ref:`int`, initial_color_action\: :ref:`InitialAction`, final_color_action\: :ref:`FinalAction`, initial_depth_action\: :ref:`InitialAction`, final_depth_action\: :ref:`FinalAction`, clear_color_values\: :ref:`PackedColorArray` = PackedColorArray(), clear_depth\: :ref:`float` = 1.0, clear_stencil\: :ref:`int` = 0, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), storage_textures\: :ref:`Array`\[:ref:`RID`\] = []\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_list_bind_index_array`\ (\ draw_list\: :ref:`int`, index_array\: :ref:`RID`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_list_bind_render_pipeline`\ (\ draw_list\: :ref:`int`, render_pipeline\: :ref:`RID`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_list_bind_uniform_set`\ (\ draw_list\: :ref:`int`, uniform_set\: :ref:`RID`, set_index\: :ref:`int`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_list_bind_vertex_array`\ (\ draw_list\: :ref:`int`, vertex_array\: :ref:`RID`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_list_disable_scissor`\ (\ draw_list\: :ref:`int`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_list_draw`\ (\ draw_list\: :ref:`int`, use_indices\: :ref:`bool`, instances\: :ref:`int`, procedural_vertex_count\: :ref:`int` = 0\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_list_enable_scissor`\ (\ draw_list\: :ref:`int`, rect\: :ref:`Rect2` = Rect2(0, 0, 0, 0)\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_list_end`\ (\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_list_set_blend_constants`\ (\ draw_list\: :ref:`int`, color\: :ref:`Color`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_list_set_push_constant`\ (\ draw_list\: :ref:`int`, buffer\: :ref:`PackedByteArray`, size_bytes\: :ref:`int`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`draw_list_switch_to_next_pass`\ (\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`draw_list_switch_to_next_pass_split`\ (\ splits\: :ref:`int`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`framebuffer_create`\ (\ textures\: :ref:`Array`\[:ref:`RID`\], validate_with_format\: :ref:`int` = -1, view_count\: :ref:`int` = 1\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`framebuffer_create_empty`\ (\ size\: :ref:`Vector2i`, samples\: :ref:`TextureSamples` = 0, validate_with_format\: :ref:`int` = -1\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`framebuffer_create_multipass`\ (\ textures\: :ref:`Array`\[:ref:`RID`\], passes\: :ref:`Array`\[:ref:`RDFramebufferPass`\], validate_with_format\: :ref:`int` = -1, view_count\: :ref:`int` = 1\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`framebuffer_format_create`\ (\ attachments\: :ref:`Array`\[:ref:`RDAttachmentFormat`\], view_count\: :ref:`int` = 1\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`framebuffer_format_create_empty`\ (\ samples\: :ref:`TextureSamples` = 0\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`framebuffer_format_create_multipass`\ (\ attachments\: :ref:`Array`\[:ref:`RDAttachmentFormat`\], passes\: :ref:`Array`\[:ref:`RDFramebufferPass`\], view_count\: :ref:`int` = 1\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TextureSamples` | :ref:`framebuffer_format_get_texture_samples`\ (\ format\: :ref:`int`, render_pass\: :ref:`int` = 0\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`framebuffer_get_format`\ (\ framebuffer\: :ref:`RID`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`framebuffer_is_valid`\ (\ framebuffer\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`free_rid`\ (\ rid\: :ref:`RID`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`full_barrier`\ (\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_captured_timestamp_cpu_time`\ (\ index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_captured_timestamp_gpu_time`\ (\ index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_captured_timestamp_name`\ (\ index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_captured_timestamps_count`\ (\ ) |const| | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_captured_timestamps_frame`\ (\ ) |const| | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_device_name`\ (\ ) |const| | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_device_pipeline_cache_uuid`\ (\ ) |const| | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_device_vendor_name`\ (\ ) |const| | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_driver_resource`\ (\ resource\: :ref:`DriverResource`, rid\: :ref:`RID`, index\: :ref:`int`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_frame_delay`\ (\ ) |const| | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_memory_usage`\ (\ type\: :ref:`MemoryType`\ ) |const| | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`index_array_create`\ (\ index_buffer\: :ref:`RID`, index_offset\: :ref:`int`, index_count\: :ref:`int`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`index_buffer_create`\ (\ size_indices\: :ref:`int`, format\: :ref:`IndexBufferFormat`, data\: :ref:`PackedByteArray` = PackedByteArray(), use_restart_indices\: :ref:`bool` = false\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`limit_get`\ (\ limit\: :ref:`Limit`\ ) |const| | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`render_pipeline_create`\ (\ shader\: :ref:`RID`, framebuffer_format\: :ref:`int`, vertex_format\: :ref:`int`, primitive\: :ref:`RenderPrimitive`, rasterization_state\: :ref:`RDPipelineRasterizationState`, multisample_state\: :ref:`RDPipelineMultisampleState`, stencil_state\: :ref:`RDPipelineDepthStencilState`, color_blend_state\: :ref:`RDPipelineColorBlendState`, dynamic_state_flags\: |bitfield|\[:ref:`PipelineDynamicStateFlags`\] = 0, for_render_pass\: :ref:`int` = 0, specialization_constants\: :ref:`Array`\[:ref:`RDPipelineSpecializationConstant`\] = []\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`render_pipeline_is_valid`\ (\ render_pipeline\: :ref:`RID`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`sampler_create`\ (\ state\: :ref:`RDSamplerState`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`sampler_is_format_supported_for_filter`\ (\ format\: :ref:`DataFormat`, sampler_filter\: :ref:`SamplerFilter`\ ) |const| | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`screen_get_framebuffer_format`\ (\ screen\: :ref:`int` = 0\ ) |const| | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`screen_get_height`\ (\ screen\: :ref:`int` = 0\ ) |const| | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`screen_get_width`\ (\ screen\: :ref:`int` = 0\ ) |const| | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_resource_name`\ (\ id\: :ref:`RID`, name\: :ref:`String`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`shader_compile_binary_from_spirv`\ (\ spirv_data\: :ref:`RDShaderSPIRV`, name\: :ref:`String` = ""\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RDShaderSPIRV` | :ref:`shader_compile_spirv_from_source`\ (\ shader_source\: :ref:`RDShaderSource`, allow_cache\: :ref:`bool` = true\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`shader_create_from_bytecode`\ (\ binary_data\: :ref:`PackedByteArray`, placeholder_rid\: :ref:`RID` = RID()\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`shader_create_from_spirv`\ (\ spirv_data\: :ref:`RDShaderSPIRV`, name\: :ref:`String` = ""\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`shader_create_placeholder`\ (\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shader_get_vertex_input_attribute_mask`\ (\ shader\: :ref:`RID`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`storage_buffer_create`\ (\ size_bytes\: :ref:`int`, data\: :ref:`PackedByteArray` = PackedByteArray(), usage\: |bitfield|\[:ref:`StorageBufferUsage`\] = 0\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`submit`\ (\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sync`\ (\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`texture_buffer_create`\ (\ size_bytes\: :ref:`int`, format\: :ref:`DataFormat`, data\: :ref:`PackedByteArray` = PackedByteArray()\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`texture_clear`\ (\ texture\: :ref:`RID`, color\: :ref:`Color`, base_mipmap\: :ref:`int`, mipmap_count\: :ref:`int`, base_layer\: :ref:`int`, layer_count\: :ref:`int`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`texture_copy`\ (\ from_texture\: :ref:`RID`, to_texture\: :ref:`RID`, from_pos\: :ref:`Vector3`, to_pos\: :ref:`Vector3`, size\: :ref:`Vector3`, src_mipmap\: :ref:`int`, dst_mipmap\: :ref:`int`, src_layer\: :ref:`int`, dst_layer\: :ref:`int`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`texture_create`\ (\ format\: :ref:`RDTextureFormat`, view\: :ref:`RDTextureView`, data\: :ref:`Array`\[:ref:`PackedByteArray`\] = []\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`texture_create_from_extension`\ (\ type\: :ref:`TextureType`, format\: :ref:`DataFormat`, samples\: :ref:`TextureSamples`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits`\], image\: :ref:`int`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, layers\: :ref:`int`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`texture_create_shared`\ (\ view\: :ref:`RDTextureView`, with_texture\: :ref:`RID`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`texture_create_shared_from_slice`\ (\ view\: :ref:`RDTextureView`, with_texture\: :ref:`RID`, layer\: :ref:`int`, mipmap\: :ref:`int`, mipmaps\: :ref:`int` = 1, slice_type\: :ref:`TextureSliceType` = 0\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`texture_get_data`\ (\ texture\: :ref:`RID`, layer\: :ref:`int`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RDTextureFormat` | :ref:`texture_get_format`\ (\ texture\: :ref:`RID`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`texture_get_native_handle`\ (\ texture\: :ref:`RID`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`texture_is_format_supported_for_usage`\ (\ format\: :ref:`DataFormat`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits`\]\ ) |const| | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`texture_is_shared`\ (\ texture\: :ref:`RID`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`texture_is_valid`\ (\ texture\: :ref:`RID`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`texture_resolve_multisample`\ (\ from_texture\: :ref:`RID`, to_texture\: :ref:`RID`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`texture_update`\ (\ texture\: :ref:`RID`, layer\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`uniform_buffer_create`\ (\ size_bytes\: :ref:`int`, data\: :ref:`PackedByteArray` = PackedByteArray()\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`uniform_set_create`\ (\ uniforms\: :ref:`Array`\[:ref:`RDUniform`\], shader\: :ref:`RID`, shader_set\: :ref:`int`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`uniform_set_is_valid`\ (\ uniform_set\: :ref:`RID`\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`vertex_array_create`\ (\ vertex_count\: :ref:`int`, vertex_format\: :ref:`int`, src_buffers\: :ref:`Array`\[:ref:`RID`\], offsets\: :ref:`PackedInt64Array` = PackedInt64Array()\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`vertex_buffer_create`\ (\ size_bytes\: :ref:`int`, data\: :ref:`PackedByteArray` = PackedByteArray(), use_as_storage\: :ref:`bool` = false\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`vertex_format_create`\ (\ vertex_descriptions\: :ref:`Array`\[:ref:`RDVertexAttribute`\]\ ) | + +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -441,10 +441,6 @@ Buffer of any kind of (storage, vertex, etc.). **Deprecated:** Use :ref:`DRIVER_RESOURCE_LOGICAL_DEVICE` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE: @@ -455,10 +451,6 @@ Buffer of any kind of (storage, vertex, etc.). **Deprecated:** Use :ref:`DRIVER_RESOURCE_PHYSICAL_DEVICE` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_INSTANCE: @@ -469,10 +461,6 @@ Buffer of any kind of (storage, vertex, etc.). **Deprecated:** Use :ref:`DRIVER_RESOURCE_TOPMOST_OBJECT` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_QUEUE: @@ -483,10 +471,6 @@ Buffer of any kind of (storage, vertex, etc.). **Deprecated:** Use :ref:`DRIVER_RESOURCE_COMMAND_QUEUE` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX: @@ -497,10 +481,6 @@ Buffer of any kind of (storage, vertex, etc.). **Deprecated:** Use :ref:`DRIVER_RESOURCE_QUEUE_FAMILY` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_IMAGE: @@ -511,10 +491,6 @@ Buffer of any kind of (storage, vertex, etc.). **Deprecated:** Use :ref:`DRIVER_RESOURCE_TEXTURE` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_IMAGE_VIEW: @@ -525,10 +501,6 @@ Buffer of any kind of (storage, vertex, etc.). **Deprecated:** Use :ref:`DRIVER_RESOURCE_TEXTURE_VIEW` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT: @@ -539,10 +511,6 @@ Buffer of any kind of (storage, vertex, etc.). **Deprecated:** Use :ref:`DRIVER_RESOURCE_TEXTURE_DATA_FORMAT` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_SAMPLER: @@ -553,10 +521,6 @@ Buffer of any kind of (storage, vertex, etc.). **Deprecated:** Use :ref:`DRIVER_RESOURCE_SAMPLER` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET: @@ -567,10 +531,6 @@ Buffer of any kind of (storage, vertex, etc.). **Deprecated:** Use :ref:`DRIVER_RESOURCE_UNIFORM_SET` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_BUFFER: @@ -581,10 +541,6 @@ Buffer of any kind of (storage, vertex, etc.). **Deprecated:** Use :ref:`DRIVER_RESOURCE_BUFFER` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE: @@ -595,10 +551,6 @@ Buffer of any kind of (storage, vertex, etc.). **Deprecated:** Use :ref:`DRIVER_RESOURCE_COMPUTE_PIPELINE` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE: @@ -609,10 +561,6 @@ Buffer of any kind of (storage, vertex, etc.). **Deprecated:** Use :ref:`DRIVER_RESOURCE_RENDER_PIPELINE` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. rst-class:: classref-item-separator @@ -3971,10 +3919,6 @@ Represents the size of the :ref:`InitialAction` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_RenderingDevice_constant_INITIAL_ACTION_CLEAR_REGION_CONTINUE: @@ -3985,10 +3929,6 @@ Represents the size of the :ref:`InitialAction` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_RenderingDevice_constant_INITIAL_ACTION_KEEP: @@ -3999,10 +3939,6 @@ Represents the size of the :ref:`InitialAction` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_RenderingDevice_constant_INITIAL_ACTION_DROP: @@ -4013,10 +3949,6 @@ Represents the size of the :ref:`InitialAction` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_RenderingDevice_constant_INITIAL_ACTION_CONTINUE: @@ -4027,10 +3959,6 @@ Represents the size of the :ref:`InitialAction` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. rst-class:: classref-item-separator @@ -4075,10 +4003,6 @@ Represents the size of the :ref:`FinalAction` **Deprecated:** Use :ref:`FINAL_ACTION_STORE` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_RenderingDevice_constant_FINAL_ACTION_CONTINUE: @@ -4089,10 +4013,6 @@ Represents the size of the :ref:`FinalAction` **Deprecated:** Use :ref:`FINAL_ACTION_STORE` instead. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. rst-class:: classref-item-separator @@ -4631,13 +4551,11 @@ Method Descriptions .. rst-class:: classref-method -void **barrier** **(** |bitfield|\<:ref:`BarrierMask`\> from=32767, |bitfield|\<:ref:`BarrierMask`\> to=32767 **)** +|void| **barrier**\ (\ from\: |bitfield|\[:ref:`BarrierMask`\] = 32767, to\: |bitfield|\[:ref:`BarrierMask`\] = 32767\ ) **Deprecated:** Barriers are automatically inserted by RenderingDevice. -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +This method does nothing. .. rst-class:: classref-item-separator @@ -4647,7 +4565,7 @@ void **barrier** **(** |bitfield|\<:ref:`BarrierMask` **buffer_clear** **(** :ref:`RID` buffer, :ref:`int` offset, :ref:`int` size_bytes **)** +:ref:`Error` **buffer_clear**\ (\ buffer\: :ref:`RID`, offset\: :ref:`int`, size_bytes\: :ref:`int`\ ) Clears the contents of the ``buffer``, clearing ``size_bytes`` bytes, starting at ``offset``. @@ -4669,7 +4587,7 @@ Prints an error if: .. rst-class:: classref-method -:ref:`Error` **buffer_copy** **(** :ref:`RID` src_buffer, :ref:`RID` dst_buffer, :ref:`int` src_offset, :ref:`int` dst_offset, :ref:`int` size **)** +:ref:`Error` **buffer_copy**\ (\ src_buffer\: :ref:`RID`, dst_buffer\: :ref:`RID`, src_offset\: :ref:`int`, dst_offset\: :ref:`int`, size\: :ref:`int`\ ) Copies ``size`` bytes from the ``src_buffer`` at ``src_offset`` into ``dst_buffer`` at ``dst_offset``. @@ -4689,7 +4607,7 @@ Prints an error if: .. rst-class:: classref-method -:ref:`PackedByteArray` **buffer_get_data** **(** :ref:`RID` buffer, :ref:`int` offset_bytes=0, :ref:`int` size_bytes=0 **)** +:ref:`PackedByteArray` **buffer_get_data**\ (\ buffer\: :ref:`RID`, offset_bytes\: :ref:`int` = 0, size_bytes\: :ref:`int` = 0\ ) Returns a copy of the data of the specified ``buffer``, optionally ``offset_bytes`` and ``size_bytes`` can be set to copy only a portion of the buffer. @@ -4701,7 +4619,7 @@ Returns a copy of the data of the specified ``buffer``, optionally ``offset_byte .. rst-class:: classref-method -:ref:`Error` **buffer_update** **(** :ref:`RID` buffer, :ref:`int` offset, :ref:`int` size_bytes, :ref:`PackedByteArray` data **)** +:ref:`Error` **buffer_update**\ (\ buffer\: :ref:`RID`, offset\: :ref:`int`, size_bytes\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) Updates a region of ``size_bytes`` bytes, starting at ``offset``, in the buffer, with the specified ``data``. @@ -4721,7 +4639,7 @@ Prints an error if: .. rst-class:: classref-method -void **capture_timestamp** **(** :ref:`String` name **)** +|void| **capture_timestamp**\ (\ name\: :ref:`String`\ ) Creates a timestamp marker with the specified ``name``. This is used for performance reporting with the :ref:`get_captured_timestamp_cpu_time`, :ref:`get_captured_timestamp_gpu_time` and :ref:`get_captured_timestamp_name` methods. @@ -4733,7 +4651,7 @@ Creates a timestamp marker with the specified ``name``. This is used for perform .. rst-class:: classref-method -void **compute_list_add_barrier** **(** :ref:`int` compute_list **)** +|void| **compute_list_add_barrier**\ (\ compute_list\: :ref:`int`\ ) Raises a Vulkan compute barrier in the specified ``compute_list``. @@ -4745,7 +4663,7 @@ Raises a Vulkan compute barrier in the specified ``compute_list``. .. rst-class:: classref-method -:ref:`int` **compute_list_begin** **(** **)** +:ref:`int` **compute_list_begin**\ (\ ) Starts a list of compute commands created with the ``compute_*`` methods. The returned value should be passed to other ``compute_list_*`` functions. @@ -4777,7 +4695,7 @@ A simple compute operation might look like this (code is not a complete example) .. rst-class:: classref-method -void **compute_list_bind_compute_pipeline** **(** :ref:`int` compute_list, :ref:`RID` compute_pipeline **)** +|void| **compute_list_bind_compute_pipeline**\ (\ compute_list\: :ref:`int`, compute_pipeline\: :ref:`RID`\ ) Tells the GPU what compute pipeline to use when processing the compute list. If the shader has changed since the last time this function was called, Godot will unbind all descriptor sets and will re-bind them inside :ref:`compute_list_dispatch`. @@ -4789,7 +4707,7 @@ Tells the GPU what compute pipeline to use when processing the compute list. If .. rst-class:: classref-method -void **compute_list_bind_uniform_set** **(** :ref:`int` compute_list, :ref:`RID` uniform_set, :ref:`int` set_index **)** +|void| **compute_list_bind_uniform_set**\ (\ compute_list\: :ref:`int`, uniform_set\: :ref:`RID`, set_index\: :ref:`int`\ ) Binds the ``uniform_set`` to this ``compute_list``. Godot ensures that all textures in the uniform set have the correct Vulkan access masks. If Godot had to change access masks of textures, it will raise a Vulkan image memory barrier. @@ -4801,7 +4719,7 @@ Binds the ``uniform_set`` to this ``compute_list``. Godot ensures that all textu .. rst-class:: classref-method -void **compute_list_dispatch** **(** :ref:`int` compute_list, :ref:`int` x_groups, :ref:`int` y_groups, :ref:`int` z_groups **)** +|void| **compute_list_dispatch**\ (\ compute_list\: :ref:`int`, x_groups\: :ref:`int`, y_groups\: :ref:`int`, z_groups\: :ref:`int`\ ) Submits the compute list for processing on the GPU. This is the compute equivalent to :ref:`draw_list_draw`. @@ -4813,7 +4731,7 @@ Submits the compute list for processing on the GPU. This is the compute equivale .. rst-class:: classref-method -void **compute_list_end** **(** **)** +|void| **compute_list_end**\ (\ ) Finishes a list of compute commands created with the ``compute_*`` methods. @@ -4825,7 +4743,7 @@ Finishes a list of compute commands created with the ``compute_*`` methods. .. rst-class:: classref-method -void **compute_list_set_push_constant** **(** :ref:`int` compute_list, :ref:`PackedByteArray` buffer, :ref:`int` size_bytes **)** +|void| **compute_list_set_push_constant**\ (\ compute_list\: :ref:`int`, buffer\: :ref:`PackedByteArray`, size_bytes\: :ref:`int`\ ) Sets the push constant data to ``buffer`` for the specified ``compute_list``. The shader determines how this binary data is used. The buffer's size in bytes must also be specified in ``size_bytes`` (this can be obtained by calling the :ref:`PackedByteArray.size` method on the passed ``buffer``). @@ -4837,7 +4755,7 @@ Sets the push constant data to ``buffer`` for the specified ``compute_list``. Th .. rst-class:: classref-method -:ref:`RID` **compute_pipeline_create** **(** :ref:`RID` shader, :ref:`RDPipelineSpecializationConstant[]` specialization_constants=[] **)** +:ref:`RID` **compute_pipeline_create**\ (\ shader\: :ref:`RID`, specialization_constants\: :ref:`Array`\[:ref:`RDPipelineSpecializationConstant`\] = []\ ) Creates a new compute pipeline. It can be accessed with the RID that is returned. @@ -4851,7 +4769,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`bool` **compute_pipeline_is_valid** **(** :ref:`RID` compute_pipeline **)** +:ref:`bool` **compute_pipeline_is_valid**\ (\ compute_pipeline\: :ref:`RID`\ ) Returns ``true`` if the compute pipeline specified by the ``compute_pipeline`` RID is valid, ``false`` otherwise. @@ -4863,7 +4781,7 @@ Returns ``true`` if the compute pipeline specified by the ``compute_pipeline`` R .. rst-class:: classref-method -:ref:`RenderingDevice` **create_local_device** **(** **)** +:ref:`RenderingDevice` **create_local_device**\ (\ ) Create a new local **RenderingDevice**. This is most useful for performing compute operations on the GPU independently from the rest of the engine. @@ -4875,7 +4793,7 @@ Create a new local **RenderingDevice**. This is most useful for performing compu .. rst-class:: classref-method -void **draw_command_begin_label** **(** :ref:`String` name, :ref:`Color` color **)** +|void| **draw_command_begin_label**\ (\ name\: :ref:`String`, color\: :ref:`Color`\ ) Create a command buffer debug label region that can be displayed in third-party tools such as `RenderDoc `__. All regions must be ended with a :ref:`draw_command_end_label` call. When viewed from the linear series of submissions to a single queue, calls to :ref:`draw_command_begin_label` and :ref:`draw_command_end_label` must be matched and balanced. @@ -4889,7 +4807,7 @@ The ``VK_EXT_DEBUG_UTILS_EXTENSION_NAME`` Vulkan extension must be available and .. rst-class:: classref-method -void **draw_command_end_label** **(** **)** +|void| **draw_command_end_label**\ (\ ) Ends the command buffer debug label region started by a :ref:`draw_command_begin_label` call. @@ -4901,13 +4819,11 @@ Ends the command buffer debug label region started by a :ref:`draw_command_begin .. rst-class:: classref-method -void **draw_command_insert_label** **(** :ref:`String` name, :ref:`Color` color **)** +|void| **draw_command_insert_label**\ (\ name\: :ref:`String`, color\: :ref:`Color`\ ) **Deprecated:** Inserting labels no longer applies due to command reordering. -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +This method does nothing. .. rst-class:: classref-item-separator @@ -4917,7 +4833,7 @@ void **draw_command_insert_label** **(** :ref:`String` name, :ref: .. rst-class:: classref-method -:ref:`int` **draw_list_begin** **(** :ref:`RID` framebuffer, :ref:`InitialAction` initial_color_action, :ref:`FinalAction` final_color_action, :ref:`InitialAction` initial_depth_action, :ref:`FinalAction` final_depth_action, :ref:`PackedColorArray` clear_color_values=PackedColorArray(), :ref:`float` clear_depth=1.0, :ref:`int` clear_stencil=0, :ref:`Rect2` region=Rect2(0, 0, 0, 0) **)** +:ref:`int` **draw_list_begin**\ (\ framebuffer\: :ref:`RID`, initial_color_action\: :ref:`InitialAction`, final_color_action\: :ref:`FinalAction`, initial_depth_action\: :ref:`InitialAction`, final_depth_action\: :ref:`FinalAction`, clear_color_values\: :ref:`PackedColorArray` = PackedColorArray(), clear_depth\: :ref:`float` = 1.0, clear_stencil\: :ref:`int` = 0, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0)\ ) Starts a list of raster drawing commands created with the ``draw_*`` methods. The returned value should be passed to other ``draw_list_*`` functions. @@ -4952,7 +4868,7 @@ A simple drawing operation might look like this (code is not a complete example) .. rst-class:: classref-method -:ref:`int` **draw_list_begin_for_screen** **(** :ref:`int` screen=0, :ref:`Color` clear_color=Color(0, 0, 0, 1) **)** +:ref:`int` **draw_list_begin_for_screen**\ (\ screen\: :ref:`int` = 0, clear_color\: :ref:`Color` = Color(0, 0, 0, 1)\ ) High-level variant of :ref:`draw_list_begin`, with the parameters automatically being adjusted for drawing onto the window specified by the ``screen`` ID. @@ -4966,13 +4882,11 @@ High-level variant of :ref:`draw_list_begin` **draw_list_begin_split** **(** :ref:`RID` framebuffer, :ref:`int` splits, :ref:`InitialAction` initial_color_action, :ref:`FinalAction` final_color_action, :ref:`InitialAction` initial_depth_action, :ref:`FinalAction` final_depth_action, :ref:`PackedColorArray` clear_color_values=PackedColorArray(), :ref:`float` clear_depth=1.0, :ref:`int` clear_stencil=0, :ref:`Rect2` region=Rect2(0, 0, 0, 0), :ref:`RID[]` storage_textures=[] **)** +:ref:`PackedInt64Array` **draw_list_begin_split**\ (\ framebuffer\: :ref:`RID`, splits\: :ref:`int`, initial_color_action\: :ref:`InitialAction`, final_color_action\: :ref:`FinalAction`, initial_depth_action\: :ref:`InitialAction`, final_depth_action\: :ref:`FinalAction`, clear_color_values\: :ref:`PackedColorArray` = PackedColorArray(), clear_depth\: :ref:`float` = 1.0, clear_stencil\: :ref:`int` = 0, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), storage_textures\: :ref:`Array`\[:ref:`RID`\] = []\ ) **Deprecated:** Split draw lists are used automatically by RenderingDevice. -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +This method does nothing and always returns an empty :ref:`PackedInt64Array`. .. rst-class:: classref-item-separator @@ -4982,7 +4896,7 @@ High-level variant of :ref:`draw_list_begin` draw_list, :ref:`RID` index_array **)** +|void| **draw_list_bind_index_array**\ (\ draw_list\: :ref:`int`, index_array\: :ref:`RID`\ ) Binds ``index_array`` to the specified ``draw_list``. @@ -4994,7 +4908,7 @@ Binds ``index_array`` to the specified ``draw_list``. .. rst-class:: classref-method -void **draw_list_bind_render_pipeline** **(** :ref:`int` draw_list, :ref:`RID` render_pipeline **)** +|void| **draw_list_bind_render_pipeline**\ (\ draw_list\: :ref:`int`, render_pipeline\: :ref:`RID`\ ) Binds ``render_pipeline`` to the specified ``draw_list``. @@ -5006,7 +4920,7 @@ Binds ``render_pipeline`` to the specified ``draw_list``. .. rst-class:: classref-method -void **draw_list_bind_uniform_set** **(** :ref:`int` draw_list, :ref:`RID` uniform_set, :ref:`int` set_index **)** +|void| **draw_list_bind_uniform_set**\ (\ draw_list\: :ref:`int`, uniform_set\: :ref:`RID`, set_index\: :ref:`int`\ ) Binds ``uniform_set`` to the specified ``draw_list``. A ``set_index`` must also be specified, which is an identifier starting from ``0`` that must match the one expected by the draw list. @@ -5018,7 +4932,7 @@ Binds ``uniform_set`` to the specified ``draw_list``. A ``set_index`` must also .. rst-class:: classref-method -void **draw_list_bind_vertex_array** **(** :ref:`int` draw_list, :ref:`RID` vertex_array **)** +|void| **draw_list_bind_vertex_array**\ (\ draw_list\: :ref:`int`, vertex_array\: :ref:`RID`\ ) Binds ``vertex_array`` to the specified ``draw_list``. @@ -5030,7 +4944,7 @@ Binds ``vertex_array`` to the specified ``draw_list``. .. rst-class:: classref-method -void **draw_list_disable_scissor** **(** :ref:`int` draw_list **)** +|void| **draw_list_disable_scissor**\ (\ draw_list\: :ref:`int`\ ) Removes and disables the scissor rectangle for the specified ``draw_list``. See also :ref:`draw_list_enable_scissor`. @@ -5042,7 +4956,7 @@ Removes and disables the scissor rectangle for the specified ``draw_list``. See .. rst-class:: classref-method -void **draw_list_draw** **(** :ref:`int` draw_list, :ref:`bool` use_indices, :ref:`int` instances, :ref:`int` procedural_vertex_count=0 **)** +|void| **draw_list_draw**\ (\ draw_list\: :ref:`int`, use_indices\: :ref:`bool`, instances\: :ref:`int`, procedural_vertex_count\: :ref:`int` = 0\ ) Submits ``draw_list`` for rendering on the GPU. This is the raster equivalent to :ref:`compute_list_dispatch`. @@ -5054,7 +4968,7 @@ Submits ``draw_list`` for rendering on the GPU. This is the raster equivalent to .. rst-class:: classref-method -void **draw_list_enable_scissor** **(** :ref:`int` draw_list, :ref:`Rect2` rect=Rect2(0, 0, 0, 0) **)** +|void| **draw_list_enable_scissor**\ (\ draw_list\: :ref:`int`, rect\: :ref:`Rect2` = Rect2(0, 0, 0, 0)\ ) Creates a scissor rectangle and enables it for the specified ``draw_list``. Scissor rectangles are used for clipping by discarding fragments that fall outside a specified rectangular portion of the screen. See also :ref:`draw_list_disable_scissor`. @@ -5068,7 +4982,7 @@ Creates a scissor rectangle and enables it for the specified ``draw_list``. Scis .. rst-class:: classref-method -void **draw_list_end** **(** **)** +|void| **draw_list_end**\ (\ ) Finishes a list of raster drawing commands created with the ``draw_*`` methods. @@ -5080,7 +4994,7 @@ Finishes a list of raster drawing commands created with the ``draw_*`` methods. .. rst-class:: classref-method -void **draw_list_set_blend_constants** **(** :ref:`int` draw_list, :ref:`Color` color **)** +|void| **draw_list_set_blend_constants**\ (\ draw_list\: :ref:`int`, color\: :ref:`Color`\ ) Sets blend constants for the specified ``draw_list`` to ``color``. Blend constants are used only if the graphics pipeline is created with :ref:`DYNAMIC_STATE_BLEND_CONSTANTS` flag set. @@ -5092,7 +5006,7 @@ Sets blend constants for the specified ``draw_list`` to ``color``. Blend constan .. rst-class:: classref-method -void **draw_list_set_push_constant** **(** :ref:`int` draw_list, :ref:`PackedByteArray` buffer, :ref:`int` size_bytes **)** +|void| **draw_list_set_push_constant**\ (\ draw_list\: :ref:`int`, buffer\: :ref:`PackedByteArray`, size_bytes\: :ref:`int`\ ) Sets the push constant data to ``buffer`` for the specified ``draw_list``. The shader determines how this binary data is used. The buffer's size in bytes must also be specified in ``size_bytes`` (this can be obtained by calling the :ref:`PackedByteArray.size` method on the passed ``buffer``). @@ -5104,7 +5018,7 @@ Sets the push constant data to ``buffer`` for the specified ``draw_list``. The s .. rst-class:: classref-method -:ref:`int` **draw_list_switch_to_next_pass** **(** **)** +:ref:`int` **draw_list_switch_to_next_pass**\ (\ ) Switches to the next draw pass. @@ -5116,13 +5030,11 @@ Switches to the next draw pass. .. rst-class:: classref-method -:ref:`PackedInt64Array` **draw_list_switch_to_next_pass_split** **(** :ref:`int` splits **)** +:ref:`PackedInt64Array` **draw_list_switch_to_next_pass_split**\ (\ splits\: :ref:`int`\ ) **Deprecated:** Split draw lists are used automatically by RenderingDevice. -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +This method does nothing and always returns an empty :ref:`PackedInt64Array`. .. rst-class:: classref-item-separator @@ -5132,7 +5044,7 @@ Switches to the next draw pass. .. rst-class:: classref-method -:ref:`RID` **framebuffer_create** **(** :ref:`RID[]` textures, :ref:`int` validate_with_format=-1, :ref:`int` view_count=1 **)** +:ref:`RID` **framebuffer_create**\ (\ textures\: :ref:`Array`\[:ref:`RID`\], validate_with_format\: :ref:`int` = -1, view_count\: :ref:`int` = 1\ ) Creates a new framebuffer. It can be accessed with the RID that is returned. @@ -5146,7 +5058,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`RID` **framebuffer_create_empty** **(** :ref:`Vector2i` size, :ref:`TextureSamples` samples=0, :ref:`int` validate_with_format=-1 **)** +:ref:`RID` **framebuffer_create_empty**\ (\ size\: :ref:`Vector2i`, samples\: :ref:`TextureSamples` = 0, validate_with_format\: :ref:`int` = -1\ ) Creates a new empty framebuffer. It can be accessed with the RID that is returned. @@ -5160,7 +5072,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`RID` **framebuffer_create_multipass** **(** :ref:`RID[]` textures, :ref:`RDFramebufferPass[]` passes, :ref:`int` validate_with_format=-1, :ref:`int` view_count=1 **)** +:ref:`RID` **framebuffer_create_multipass**\ (\ textures\: :ref:`Array`\[:ref:`RID`\], passes\: :ref:`Array`\[:ref:`RDFramebufferPass`\], validate_with_format\: :ref:`int` = -1, view_count\: :ref:`int` = 1\ ) Creates a new multipass framebuffer. It can be accessed with the RID that is returned. @@ -5174,7 +5086,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`int` **framebuffer_format_create** **(** :ref:`RDAttachmentFormat[]` attachments, :ref:`int` view_count=1 **)** +:ref:`int` **framebuffer_format_create**\ (\ attachments\: :ref:`Array`\[:ref:`RDAttachmentFormat`\], view_count\: :ref:`int` = 1\ ) Creates a new framebuffer format with the specified ``attachments`` and ``view_count``. Returns the new framebuffer's unique framebuffer format ID. @@ -5188,7 +5100,7 @@ If ``view_count`` is greater than or equal to ``2``, enables multiview which is .. rst-class:: classref-method -:ref:`int` **framebuffer_format_create_empty** **(** :ref:`TextureSamples` samples=0 **)** +:ref:`int` **framebuffer_format_create_empty**\ (\ samples\: :ref:`TextureSamples` = 0\ ) Creates a new empty framebuffer format with the specified number of ``samples`` and returns its ID. @@ -5200,7 +5112,7 @@ Creates a new empty framebuffer format with the specified number of ``samples`` .. rst-class:: classref-method -:ref:`int` **framebuffer_format_create_multipass** **(** :ref:`RDAttachmentFormat[]` attachments, :ref:`RDFramebufferPass[]` passes, :ref:`int` view_count=1 **)** +:ref:`int` **framebuffer_format_create_multipass**\ (\ attachments\: :ref:`Array`\[:ref:`RDAttachmentFormat`\], passes\: :ref:`Array`\[:ref:`RDFramebufferPass`\], view_count\: :ref:`int` = 1\ ) Creates a multipass framebuffer format with the specified ``attachments``, ``passes`` and ``view_count`` and returns its ID. If ``view_count`` is greater than or equal to ``2``, enables multiview which is used for VR rendering. This requires support for the Vulkan multiview extension. @@ -5212,7 +5124,7 @@ Creates a multipass framebuffer format with the specified ``attachments``, ``pas .. rst-class:: classref-method -:ref:`TextureSamples` **framebuffer_format_get_texture_samples** **(** :ref:`int` format, :ref:`int` render_pass=0 **)** +:ref:`TextureSamples` **framebuffer_format_get_texture_samples**\ (\ format\: :ref:`int`, render_pass\: :ref:`int` = 0\ ) Returns the number of texture samples used for the given framebuffer ``format`` ID (returned by :ref:`framebuffer_get_format`). @@ -5224,7 +5136,7 @@ Returns the number of texture samples used for the given framebuffer ``format`` .. rst-class:: classref-method -:ref:`int` **framebuffer_get_format** **(** :ref:`RID` framebuffer **)** +:ref:`int` **framebuffer_get_format**\ (\ framebuffer\: :ref:`RID`\ ) Returns the format ID of the framebuffer specified by the ``framebuffer`` RID. This ID is guaranteed to be unique for the same formats and does not need to be freed. @@ -5236,7 +5148,7 @@ Returns the format ID of the framebuffer specified by the ``framebuffer`` RID. T .. rst-class:: classref-method -:ref:`bool` **framebuffer_is_valid** **(** :ref:`RID` framebuffer **)** |const| +:ref:`bool` **framebuffer_is_valid**\ (\ framebuffer\: :ref:`RID`\ ) |const| Returns ``true`` if the framebuffer specified by the ``framebuffer`` RID is valid, ``false`` otherwise. @@ -5248,7 +5160,7 @@ Returns ``true`` if the framebuffer specified by the ``framebuffer`` RID is vali .. rst-class:: classref-method -void **free_rid** **(** :ref:`RID` rid **)** +|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) Tries to free an object in the RenderingDevice. To avoid memory leaks, this should be called after using an object as memory management does not occur automatically when using RenderingDevice directly. @@ -5260,13 +5172,11 @@ Tries to free an object in the RenderingDevice. To avoid memory leaks, this shou .. rst-class:: classref-method -void **full_barrier** **(** **)** +|void| **full_barrier**\ (\ ) **Deprecated:** Barriers are automatically inserted by RenderingDevice. -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +This method does nothing. .. rst-class:: classref-item-separator @@ -5276,7 +5186,7 @@ void **full_barrier** **(** **)** .. rst-class:: classref-method -:ref:`int` **get_captured_timestamp_cpu_time** **(** :ref:`int` index **)** |const| +:ref:`int` **get_captured_timestamp_cpu_time**\ (\ index\: :ref:`int`\ ) |const| Returns the timestamp in CPU time for the rendering step specified by ``index`` (in microseconds since the engine started). See also :ref:`get_captured_timestamp_gpu_time` and :ref:`capture_timestamp`. @@ -5288,7 +5198,7 @@ Returns the timestamp in CPU time for the rendering step specified by ``index`` .. rst-class:: classref-method -:ref:`int` **get_captured_timestamp_gpu_time** **(** :ref:`int` index **)** |const| +:ref:`int` **get_captured_timestamp_gpu_time**\ (\ index\: :ref:`int`\ ) |const| Returns the timestamp in GPU time for the rendering step specified by ``index`` (in microseconds since the engine started). See also :ref:`get_captured_timestamp_cpu_time` and :ref:`capture_timestamp`. @@ -5300,7 +5210,7 @@ Returns the timestamp in GPU time for the rendering step specified by ``index`` .. rst-class:: classref-method -:ref:`String` **get_captured_timestamp_name** **(** :ref:`int` index **)** |const| +:ref:`String` **get_captured_timestamp_name**\ (\ index\: :ref:`int`\ ) |const| Returns the timestamp's name for the rendering step specified by ``index``. See also :ref:`capture_timestamp`. @@ -5312,7 +5222,7 @@ Returns the timestamp's name for the rendering step specified by ``index``. See .. rst-class:: classref-method -:ref:`int` **get_captured_timestamps_count** **(** **)** |const| +:ref:`int` **get_captured_timestamps_count**\ (\ ) |const| Returns the total number of timestamps (rendering steps) available for profiling. @@ -5324,7 +5234,7 @@ Returns the total number of timestamps (rendering steps) available for profiling .. rst-class:: classref-method -:ref:`int` **get_captured_timestamps_frame** **(** **)** |const| +:ref:`int` **get_captured_timestamps_frame**\ (\ ) |const| Returns the index of the last frame rendered that has rendering timestamps available for querying. @@ -5336,7 +5246,7 @@ Returns the index of the last frame rendered that has rendering timestamps avail .. rst-class:: classref-method -:ref:`String` **get_device_name** **(** **)** |const| +:ref:`String` **get_device_name**\ (\ ) |const| Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2"). Equivalent to :ref:`RenderingServer.get_video_adapter_name`. See also :ref:`get_device_vendor_name`. @@ -5348,7 +5258,7 @@ Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2"). Equiv .. rst-class:: classref-method -:ref:`String` **get_device_pipeline_cache_uuid** **(** **)** |const| +:ref:`String` **get_device_pipeline_cache_uuid**\ (\ ) |const| Returns the universally unique identifier for the pipeline cache. This is used to cache shader files on disk, which avoids shader recompilations on subsequent engine runs. This UUID varies depending on the graphics card model, but also the driver version. Therefore, updating graphics drivers will invalidate the shader cache. @@ -5360,7 +5270,7 @@ Returns the universally unique identifier for the pipeline cache. This is used t .. rst-class:: classref-method -:ref:`String` **get_device_vendor_name** **(** **)** |const| +:ref:`String` **get_device_vendor_name**\ (\ ) |const| Returns the vendor of the video adapter (e.g. "NVIDIA Corporation"). Equivalent to :ref:`RenderingServer.get_video_adapter_vendor`. See also :ref:`get_device_name`. @@ -5372,7 +5282,7 @@ Returns the vendor of the video adapter (e.g. "NVIDIA Corporation"). Equivalent .. rst-class:: classref-method -:ref:`int` **get_driver_resource** **(** :ref:`DriverResource` resource, :ref:`RID` rid, :ref:`int` index **)** +:ref:`int` **get_driver_resource**\ (\ resource\: :ref:`DriverResource`, rid\: :ref:`RID`, index\: :ref:`int`\ ) Returns the unique identifier of the driver ``resource`` for the specified ``rid``. Some driver resource types ignore the specified ``rid`` (see :ref:`DriverResource` descriptions). ``index`` is always ignored but must be specified anyway. @@ -5384,7 +5294,7 @@ Returns the unique identifier of the driver ``resource`` for the specified ``rid .. rst-class:: classref-method -:ref:`int` **get_frame_delay** **(** **)** |const| +:ref:`int` **get_frame_delay**\ (\ ) |const| Returns the frame count kept by the graphics API. Higher values result in higher input lag, but with more consistent throughput. For the main **RenderingDevice**, frames are cycled (usually 3 with triple-buffered V-Sync enabled). However, local **RenderingDevice**\ s only have 1 frame. @@ -5396,7 +5306,7 @@ Returns the frame count kept by the graphics API. Higher values result in higher .. rst-class:: classref-method -:ref:`int` **get_memory_usage** **(** :ref:`MemoryType` type **)** |const| +:ref:`int` **get_memory_usage**\ (\ type\: :ref:`MemoryType`\ ) |const| Returns the memory usage in bytes corresponding to the given ``type``. When using Vulkan, these statistics are calculated by `Vulkan Memory Allocator `__. @@ -5408,7 +5318,7 @@ Returns the memory usage in bytes corresponding to the given ``type``. When usin .. rst-class:: classref-method -:ref:`RID` **index_array_create** **(** :ref:`RID` index_buffer, :ref:`int` index_offset, :ref:`int` index_count **)** +:ref:`RID` **index_array_create**\ (\ index_buffer\: :ref:`RID`, index_offset\: :ref:`int`, index_count\: :ref:`int`\ ) Creates a new index array. It can be accessed with the RID that is returned. @@ -5422,7 +5332,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`RID` **index_buffer_create** **(** :ref:`int` size_indices, :ref:`IndexBufferFormat` format, :ref:`PackedByteArray` data=PackedByteArray(), :ref:`bool` use_restart_indices=false **)** +:ref:`RID` **index_buffer_create**\ (\ size_indices\: :ref:`int`, format\: :ref:`IndexBufferFormat`, data\: :ref:`PackedByteArray` = PackedByteArray(), use_restart_indices\: :ref:`bool` = false\ ) Creates a new index buffer. It can be accessed with the RID that is returned. @@ -5436,7 +5346,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`int` **limit_get** **(** :ref:`Limit` limit **)** |const| +:ref:`int` **limit_get**\ (\ limit\: :ref:`Limit`\ ) |const| Returns the value of the specified ``limit``. This limit varies depending on the current graphics hardware (and sometimes the driver version). If the given limit is exceeded, rendering errors will occur. @@ -5450,7 +5360,7 @@ Limits for various graphics hardware can be found in the `Vulkan Hardware Databa .. rst-class:: classref-method -:ref:`RID` **render_pipeline_create** **(** :ref:`RID` shader, :ref:`int` framebuffer_format, :ref:`int` vertex_format, :ref:`RenderPrimitive` primitive, :ref:`RDPipelineRasterizationState` rasterization_state, :ref:`RDPipelineMultisampleState` multisample_state, :ref:`RDPipelineDepthStencilState` stencil_state, :ref:`RDPipelineColorBlendState` color_blend_state, |bitfield|\<:ref:`PipelineDynamicStateFlags`\> dynamic_state_flags=0, :ref:`int` for_render_pass=0, :ref:`RDPipelineSpecializationConstant[]` specialization_constants=[] **)** +:ref:`RID` **render_pipeline_create**\ (\ shader\: :ref:`RID`, framebuffer_format\: :ref:`int`, vertex_format\: :ref:`int`, primitive\: :ref:`RenderPrimitive`, rasterization_state\: :ref:`RDPipelineRasterizationState`, multisample_state\: :ref:`RDPipelineMultisampleState`, stencil_state\: :ref:`RDPipelineDepthStencilState`, color_blend_state\: :ref:`RDPipelineColorBlendState`, dynamic_state_flags\: |bitfield|\[:ref:`PipelineDynamicStateFlags`\] = 0, for_render_pass\: :ref:`int` = 0, specialization_constants\: :ref:`Array`\[:ref:`RDPipelineSpecializationConstant`\] = []\ ) Creates a new render pipeline. It can be accessed with the RID that is returned. @@ -5464,7 +5374,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`bool` **render_pipeline_is_valid** **(** :ref:`RID` render_pipeline **)** +:ref:`bool` **render_pipeline_is_valid**\ (\ render_pipeline\: :ref:`RID`\ ) Returns ``true`` if the render pipeline specified by the ``render_pipeline`` RID is valid, ``false`` otherwise. @@ -5476,7 +5386,7 @@ Returns ``true`` if the render pipeline specified by the ``render_pipeline`` RID .. rst-class:: classref-method -:ref:`RID` **sampler_create** **(** :ref:`RDSamplerState` state **)** +:ref:`RID` **sampler_create**\ (\ state\: :ref:`RDSamplerState`\ ) Creates a new sampler. It can be accessed with the RID that is returned. @@ -5490,7 +5400,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`bool` **sampler_is_format_supported_for_filter** **(** :ref:`DataFormat` format, :ref:`SamplerFilter` sampler_filter **)** |const| +:ref:`bool` **sampler_is_format_supported_for_filter**\ (\ format\: :ref:`DataFormat`, sampler_filter\: :ref:`SamplerFilter`\ ) |const| Returns ``true`` if implementation supports using a texture of ``format`` with the given ``sampler_filter``. @@ -5502,7 +5412,7 @@ Returns ``true`` if implementation supports using a texture of ``format`` with t .. rst-class:: classref-method -:ref:`int` **screen_get_framebuffer_format** **(** :ref:`int` screen=0 **)** |const| +:ref:`int` **screen_get_framebuffer_format**\ (\ screen\: :ref:`int` = 0\ ) |const| Returns the framebuffer format of the given screen. @@ -5516,7 +5426,7 @@ Returns the framebuffer format of the given screen. .. rst-class:: classref-method -:ref:`int` **screen_get_height** **(** :ref:`int` screen=0 **)** |const| +:ref:`int` **screen_get_height**\ (\ screen\: :ref:`int` = 0\ ) |const| Returns the window height matching the graphics API context for the given window ID (in pixels). Despite the parameter being named ``screen``, this returns the *window* size. See also :ref:`screen_get_width`. @@ -5530,7 +5440,7 @@ Returns the window height matching the graphics API context for the given window .. rst-class:: classref-method -:ref:`int` **screen_get_width** **(** :ref:`int` screen=0 **)** |const| +:ref:`int` **screen_get_width**\ (\ screen\: :ref:`int` = 0\ ) |const| Returns the window width matching the graphics API context for the given window ID (in pixels). Despite the parameter being named ``screen``, this returns the *window* size. See also :ref:`screen_get_height`. @@ -5544,7 +5454,7 @@ Returns the window width matching the graphics API context for the given window .. rst-class:: classref-method -void **set_resource_name** **(** :ref:`RID` id, :ref:`String` name **)** +|void| **set_resource_name**\ (\ id\: :ref:`RID`, name\: :ref:`String`\ ) Sets the resource name for ``id`` to ``name``. This is used for debugging with third-party tools such as `RenderDoc `__. @@ -5560,7 +5470,7 @@ The following types of resources can be named: texture, sampler, vertex buffer, .. rst-class:: classref-method -:ref:`PackedByteArray` **shader_compile_binary_from_spirv** **(** :ref:`RDShaderSPIRV` spirv_data, :ref:`String` name="" **)** +:ref:`PackedByteArray` **shader_compile_binary_from_spirv**\ (\ spirv_data\: :ref:`RDShaderSPIRV`, name\: :ref:`String` = ""\ ) Compiles a binary shader from ``spirv_data`` and returns the compiled binary data as a :ref:`PackedByteArray`. This compiled shader is specific to the GPU model and driver version used; it will not work on different GPU models or even different driver versions. See also :ref:`shader_compile_spirv_from_source`. @@ -5574,7 +5484,7 @@ Compiles a binary shader from ``spirv_data`` and returns the compiled binary dat .. rst-class:: classref-method -:ref:`RDShaderSPIRV` **shader_compile_spirv_from_source** **(** :ref:`RDShaderSource` shader_source, :ref:`bool` allow_cache=true **)** +:ref:`RDShaderSPIRV` **shader_compile_spirv_from_source**\ (\ shader_source\: :ref:`RDShaderSource`, allow_cache\: :ref:`bool` = true\ ) Compiles a SPIR-V from the shader source code in ``shader_source`` and returns the SPIR-V as a :ref:`RDShaderSPIRV`. This intermediate language shader is portable across different GPU models and driver versions, but cannot be run directly by GPUs until compiled into a binary shader using :ref:`shader_compile_binary_from_spirv`. @@ -5588,7 +5498,7 @@ If ``allow_cache`` is ``true``, make use of the shader cache generated by Godot. .. rst-class:: classref-method -:ref:`RID` **shader_create_from_bytecode** **(** :ref:`PackedByteArray` binary_data, :ref:`RID` placeholder_rid=RID() **)** +:ref:`RID` **shader_create_from_bytecode**\ (\ binary_data\: :ref:`PackedByteArray`, placeholder_rid\: :ref:`RID` = RID()\ ) Creates a new shader instance from a binary compiled shader. It can be accessed with the RID that is returned. @@ -5602,7 +5512,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`RID` **shader_create_from_spirv** **(** :ref:`RDShaderSPIRV` spirv_data, :ref:`String` name="" **)** +:ref:`RID` **shader_create_from_spirv**\ (\ spirv_data\: :ref:`RDShaderSPIRV`, name\: :ref:`String` = ""\ ) Creates a new shader instance from SPIR-V intermediate code. It can be accessed with the RID that is returned. @@ -5616,7 +5526,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`RID` **shader_create_placeholder** **(** **)** +:ref:`RID` **shader_create_placeholder**\ (\ ) Create a placeholder RID by allocating an RID without initializing it for use in :ref:`shader_create_from_bytecode`. This allows you to create an RID for a shader and pass it around, but defer compiling the shader to a later time. @@ -5628,7 +5538,7 @@ Create a placeholder RID by allocating an RID without initializing it for use in .. rst-class:: classref-method -:ref:`int` **shader_get_vertex_input_attribute_mask** **(** :ref:`RID` shader **)** +:ref:`int` **shader_get_vertex_input_attribute_mask**\ (\ shader\: :ref:`RID`\ ) Returns the internal vertex input mask. Internally, the vertex input mask is an unsigned integer consisting of the locations (specified in GLSL via. ``layout(location = ...)``) of the input variables (specified in GLSL by the ``in`` keyword). @@ -5640,7 +5550,7 @@ Returns the internal vertex input mask. Internally, the vertex input mask is an .. rst-class:: classref-method -:ref:`RID` **storage_buffer_create** **(** :ref:`int` size_bytes, :ref:`PackedByteArray` data=PackedByteArray(), |bitfield|\<:ref:`StorageBufferUsage`\> usage=0 **)** +:ref:`RID` **storage_buffer_create**\ (\ size_bytes\: :ref:`int`, data\: :ref:`PackedByteArray` = PackedByteArray(), usage\: |bitfield|\[:ref:`StorageBufferUsage`\] = 0\ ) Creates a `storage buffer `__ with the specified ``data`` and ``usage``. It can be accessed with the RID that is returned. @@ -5654,7 +5564,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -void **submit** **(** **)** +|void| **submit**\ (\ ) Pushes the frame setup and draw command buffers then marks the local device as currently processing (which allows calling :ref:`sync`). @@ -5668,7 +5578,7 @@ Pushes the frame setup and draw command buffers then marks the local device as c .. rst-class:: classref-method -void **sync** **(** **)** +|void| **sync**\ (\ ) Forces a synchronization between the CPU and GPU, which may be required in certain cases. Only call this when needed, as CPU-GPU synchronization has a performance cost. @@ -5684,7 +5594,7 @@ Forces a synchronization between the CPU and GPU, which may be required in certa .. rst-class:: classref-method -:ref:`RID` **texture_buffer_create** **(** :ref:`int` size_bytes, :ref:`DataFormat` format, :ref:`PackedByteArray` data=PackedByteArray() **)** +:ref:`RID` **texture_buffer_create**\ (\ size_bytes\: :ref:`int`, format\: :ref:`DataFormat`, data\: :ref:`PackedByteArray` = PackedByteArray()\ ) Creates a new texture buffer. It can be accessed with the RID that is returned. @@ -5698,7 +5608,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`Error` **texture_clear** **(** :ref:`RID` texture, :ref:`Color` color, :ref:`int` base_mipmap, :ref:`int` mipmap_count, :ref:`int` base_layer, :ref:`int` layer_count **)** +:ref:`Error` **texture_clear**\ (\ texture\: :ref:`RID`, color\: :ref:`Color`, base_mipmap\: :ref:`int`, mipmap_count\: :ref:`int`, base_layer\: :ref:`int`, layer_count\: :ref:`int`\ ) Clears the specified ``texture`` by replacing all of its pixels with the specified ``color``. ``base_mipmap`` and ``mipmap_count`` determine which mipmaps of the texture are affected by this clear operation, while ``base_layer`` and ``layer_count`` determine which layers of a 3D texture (or texture array) are affected by this clear operation. For 2D textures (which only have one layer by design), ``base_layer`` must be ``0`` and ``layer_count`` must be ``1``. @@ -5712,7 +5622,7 @@ Clears the specified ``texture`` by replacing all of its pixels with the specifi .. rst-class:: classref-method -:ref:`Error` **texture_copy** **(** :ref:`RID` from_texture, :ref:`RID` to_texture, :ref:`Vector3` from_pos, :ref:`Vector3` to_pos, :ref:`Vector3` size, :ref:`int` src_mipmap, :ref:`int` dst_mipmap, :ref:`int` src_layer, :ref:`int` dst_layer **)** +:ref:`Error` **texture_copy**\ (\ from_texture\: :ref:`RID`, to_texture\: :ref:`RID`, from_pos\: :ref:`Vector3`, to_pos\: :ref:`Vector3`, size\: :ref:`Vector3`, src_mipmap\: :ref:`int`, dst_mipmap\: :ref:`int`, src_layer\: :ref:`int`, dst_layer\: :ref:`int`\ ) Copies the ``from_texture`` to ``to_texture`` with the specified ``from_pos``, ``to_pos`` and ``size`` coordinates. The Z axis of the ``from_pos``, ``to_pos`` and ``size`` must be ``0`` for 2-dimensional textures. Source and destination mipmaps/layers must also be specified, with these parameters being ``0`` for textures without mipmaps or single-layer textures. Returns :ref:`@GlobalScope.OK` if the texture copy was successful or :ref:`@GlobalScope.ERR_INVALID_PARAMETER` otherwise. @@ -5734,7 +5644,7 @@ Copies the ``from_texture`` to ``to_texture`` with the specified ``from_pos``, ` .. rst-class:: classref-method -:ref:`RID` **texture_create** **(** :ref:`RDTextureFormat` format, :ref:`RDTextureView` view, :ref:`PackedByteArray[]` data=[] **)** +:ref:`RID` **texture_create**\ (\ format\: :ref:`RDTextureFormat`, view\: :ref:`RDTextureView`, data\: :ref:`Array`\[:ref:`PackedByteArray`\] = []\ ) Creates a new texture. It can be accessed with the RID that is returned. @@ -5750,7 +5660,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`RID` **texture_create_from_extension** **(** :ref:`TextureType` type, :ref:`DataFormat` format, :ref:`TextureSamples` samples, |bitfield|\<:ref:`TextureUsageBits`\> usage_flags, :ref:`int` image, :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`int` layers **)** +:ref:`RID` **texture_create_from_extension**\ (\ type\: :ref:`TextureType`, format\: :ref:`DataFormat`, samples\: :ref:`TextureSamples`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits`\], image\: :ref:`int`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, layers\: :ref:`int`\ ) Returns an RID for an existing ``image`` (``VkImage``) with the given ``type``, ``format``, ``samples``, ``usage_flags``, ``width``, ``height``, ``depth``, and ``layers``. This can be used to allow Godot to render onto foreign images. @@ -5762,7 +5672,7 @@ Returns an RID for an existing ``image`` (``VkImage``) with the given ``type``, .. rst-class:: classref-method -:ref:`RID` **texture_create_shared** **(** :ref:`RDTextureView` view, :ref:`RID` with_texture **)** +:ref:`RID` **texture_create_shared**\ (\ view\: :ref:`RDTextureView`, with_texture\: :ref:`RID`\ ) Creates a shared texture using the specified ``view`` and the texture information from ``with_texture``. @@ -5774,7 +5684,7 @@ Creates a shared texture using the specified ``view`` and the texture informatio .. rst-class:: classref-method -:ref:`RID` **texture_create_shared_from_slice** **(** :ref:`RDTextureView` view, :ref:`RID` with_texture, :ref:`int` layer, :ref:`int` mipmap, :ref:`int` mipmaps=1, :ref:`TextureSliceType` slice_type=0 **)** +:ref:`RID` **texture_create_shared_from_slice**\ (\ view\: :ref:`RDTextureView`, with_texture\: :ref:`RID`, layer\: :ref:`int`, mipmap\: :ref:`int`, mipmaps\: :ref:`int` = 1, slice_type\: :ref:`TextureSliceType` = 0\ ) Creates a shared texture using the specified ``view`` and the texture information from ``with_texture``'s ``layer`` and ``mipmap``. The number of included mipmaps from the original texture can be controlled using the ``mipmaps`` parameter. Only relevant for textures with multiple layers, such as 3D textures, texture arrays and cubemaps. For single-layer textures, use :ref:`texture_create_shared`\ @@ -5790,7 +5700,7 @@ For 2D textures (which only have one layer), ``layer`` must be ``0``. .. rst-class:: classref-method -:ref:`PackedByteArray` **texture_get_data** **(** :ref:`RID` texture, :ref:`int` layer **)** +:ref:`PackedByteArray` **texture_get_data**\ (\ texture\: :ref:`RID`, layer\: :ref:`int`\ ) Returns the ``texture`` data for the specified ``layer`` as raw binary data. For 2D textures (which only have one layer), ``layer`` must be ``0``. @@ -5806,7 +5716,7 @@ Returns the ``texture`` data for the specified ``layer`` as raw binary data. For .. rst-class:: classref-method -:ref:`RDTextureFormat` **texture_get_format** **(** :ref:`RID` texture **)** +:ref:`RDTextureFormat` **texture_get_format**\ (\ texture\: :ref:`RID`\ ) Returns the data format used to create this texture. @@ -5818,7 +5728,7 @@ Returns the data format used to create this texture. .. rst-class:: classref-method -:ref:`int` **texture_get_native_handle** **(** :ref:`RID` texture **)** +:ref:`int` **texture_get_native_handle**\ (\ texture\: :ref:`RID`\ ) **Deprecated:** Use :ref:`get_driver_resource` with :ref:`DRIVER_RESOURCE_TEXTURE` instead. @@ -5834,7 +5744,7 @@ Returns the internal graphics handle for this texture object. For use when commu .. rst-class:: classref-method -:ref:`bool` **texture_is_format_supported_for_usage** **(** :ref:`DataFormat` format, |bitfield|\<:ref:`TextureUsageBits`\> usage_flags **)** |const| +:ref:`bool` **texture_is_format_supported_for_usage**\ (\ format\: :ref:`DataFormat`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits`\]\ ) |const| Returns ``true`` if the specified ``format`` is supported for the given ``usage_flags``, ``false`` otherwise. @@ -5846,7 +5756,7 @@ Returns ``true`` if the specified ``format`` is supported for the given ``usage_ .. rst-class:: classref-method -:ref:`bool` **texture_is_shared** **(** :ref:`RID` texture **)** +:ref:`bool` **texture_is_shared**\ (\ texture\: :ref:`RID`\ ) Returns ``true`` if the ``texture`` is shared, ``false`` otherwise. See :ref:`RDTextureView`. @@ -5858,7 +5768,7 @@ Returns ``true`` if the ``texture`` is shared, ``false`` otherwise. See :ref:`RD .. rst-class:: classref-method -:ref:`bool` **texture_is_valid** **(** :ref:`RID` texture **)** +:ref:`bool` **texture_is_valid**\ (\ texture\: :ref:`RID`\ ) Returns ``true`` if the ``texture`` is valid, ``false`` otherwise. @@ -5870,7 +5780,7 @@ Returns ``true`` if the ``texture`` is valid, ``false`` otherwise. .. rst-class:: classref-method -:ref:`Error` **texture_resolve_multisample** **(** :ref:`RID` from_texture, :ref:`RID` to_texture **)** +:ref:`Error` **texture_resolve_multisample**\ (\ from_texture\: :ref:`RID`, to_texture\: :ref:`RID`\ ) Resolves the ``from_texture`` texture onto ``to_texture`` with multisample antialiasing enabled. This must be used when rendering a framebuffer for MSAA to work. Returns :ref:`@GlobalScope.OK` if successful, :ref:`@GlobalScope.ERR_INVALID_PARAMETER` otherwise. @@ -5896,7 +5806,7 @@ Resolves the ``from_texture`` texture onto ``to_texture`` with multisample antia .. rst-class:: classref-method -:ref:`Error` **texture_update** **(** :ref:`RID` texture, :ref:`int` layer, :ref:`PackedByteArray` data **)** +:ref:`Error` **texture_update**\ (\ texture\: :ref:`RID`, layer\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) Updates texture data with new data, replacing the previous data in place. The updated texture data must have the same dimensions and format. For 2D textures (which only have one layer), ``layer`` must be ``0``. Returns :ref:`@GlobalScope.OK` if the update was successful, :ref:`@GlobalScope.ERR_INVALID_PARAMETER` otherwise. @@ -5914,7 +5824,7 @@ Updates texture data with new data, replacing the previous data in place. The up .. rst-class:: classref-method -:ref:`RID` **uniform_buffer_create** **(** :ref:`int` size_bytes, :ref:`PackedByteArray` data=PackedByteArray() **)** +:ref:`RID` **uniform_buffer_create**\ (\ size_bytes\: :ref:`int`, data\: :ref:`PackedByteArray` = PackedByteArray()\ ) Creates a new uniform buffer. It can be accessed with the RID that is returned. @@ -5928,7 +5838,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`RID` **uniform_set_create** **(** :ref:`RDUniform[]` uniforms, :ref:`RID` shader, :ref:`int` shader_set **)** +:ref:`RID` **uniform_set_create**\ (\ uniforms\: :ref:`Array`\[:ref:`RDUniform`\], shader\: :ref:`RID`, shader_set\: :ref:`int`\ ) Creates a new uniform set. It can be accessed with the RID that is returned. @@ -5942,7 +5852,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`bool` **uniform_set_is_valid** **(** :ref:`RID` uniform_set **)** +:ref:`bool` **uniform_set_is_valid**\ (\ uniform_set\: :ref:`RID`\ ) Checks if the ``uniform_set`` is valid, i.e. is owned. @@ -5954,7 +5864,7 @@ Checks if the ``uniform_set`` is valid, i.e. is owned. .. rst-class:: classref-method -:ref:`RID` **vertex_array_create** **(** :ref:`int` vertex_count, :ref:`int` vertex_format, :ref:`RID[]` src_buffers, :ref:`PackedInt64Array` offsets=PackedInt64Array() **)** +:ref:`RID` **vertex_array_create**\ (\ vertex_count\: :ref:`int`, vertex_format\: :ref:`int`, src_buffers\: :ref:`Array`\[:ref:`RID`\], offsets\: :ref:`PackedInt64Array` = PackedInt64Array()\ ) Creates a vertex array based on the specified buffers. Optionally, ``offsets`` (in bytes) may be defined for each buffer. @@ -5966,7 +5876,7 @@ Creates a vertex array based on the specified buffers. Optionally, ``offsets`` ( .. rst-class:: classref-method -:ref:`RID` **vertex_buffer_create** **(** :ref:`int` size_bytes, :ref:`PackedByteArray` data=PackedByteArray(), :ref:`bool` use_as_storage=false **)** +:ref:`RID` **vertex_buffer_create**\ (\ size_bytes\: :ref:`int`, data\: :ref:`PackedByteArray` = PackedByteArray(), use_as_storage\: :ref:`bool` = false\ ) It can be accessed with the RID that is returned. @@ -5980,7 +5890,7 @@ Once finished with your RID, you will want to free the RID using the RenderingDe .. rst-class:: classref-method -:ref:`int` **vertex_format_create** **(** :ref:`RDVertexAttribute[]` vertex_descriptions **)** +:ref:`int` **vertex_format_create**\ (\ vertex_descriptions\: :ref:`Array`\[:ref:`RDVertexAttribute`\]\ ) Creates a new vertex format with the specified ``vertex_descriptions``. Returns a unique vertex format ID corresponding to the newly created vertex format. @@ -5991,3 +5901,4 @@ Creates a new vertex format with the specified ``vertex_descriptions``. Returns .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index 6d9a5483497..8c674065de6 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -64,949 +64,965 @@ Methods .. table:: :widths: auto - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image[]` | :ref:`bake_render_uv2` **(** :ref:`RID` base, :ref:`RID[]` material_overrides, :ref:`Vector2i` image_size **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`call_on_render_thread` **(** :ref:`Callable` callable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`camera_attributes_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`camera_attributes_set_auto_exposure` **(** :ref:`RID` camera_attributes, :ref:`bool` enable, :ref:`float` min_sensitivity, :ref:`float` max_sensitivity, :ref:`float` speed, :ref:`float` scale **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`camera_attributes_set_dof_blur` **(** :ref:`RID` camera_attributes, :ref:`bool` far_enable, :ref:`float` far_distance, :ref:`float` far_transition, :ref:`bool` near_enable, :ref:`float` near_distance, :ref:`float` near_transition, :ref:`float` amount **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`camera_attributes_set_dof_blur_bokeh_shape` **(** :ref:`DOFBokehShape` shape **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`camera_attributes_set_dof_blur_quality` **(** :ref:`DOFBlurQuality` quality, :ref:`bool` use_jitter **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`camera_attributes_set_exposure` **(** :ref:`RID` camera_attributes, :ref:`float` multiplier, :ref:`float` normalization **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`camera_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`camera_set_camera_attributes` **(** :ref:`RID` camera, :ref:`RID` effects **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`camera_set_cull_mask` **(** :ref:`RID` camera, :ref:`int` layers **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`camera_set_environment` **(** :ref:`RID` camera, :ref:`RID` env **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`camera_set_frustum` **(** :ref:`RID` camera, :ref:`float` size, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`camera_set_orthogonal` **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`camera_set_perspective` **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`camera_set_transform` **(** :ref:`RID` camera, :ref:`Transform3D` transform **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`camera_set_use_vertical_aspect` **(** :ref:`RID` camera, :ref:`bool` enable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`canvas_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_animation_slice` **(** :ref:`RID` item, :ref:`float` animation_length, :ref:`float` slice_begin, :ref:`float` slice_end, :ref:`float` offset=0.0 **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_circle` **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_clip_ignore` **(** :ref:`RID` item, :ref:`bool` ignore **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_lcd_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_line` **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=-1.0, :ref:`bool` antialiased=false **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_mesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`Transform2D` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`RID` texture=RID() **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_msdf_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`float` px_range=1.0, :ref:`float` scale=1.0 **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_multiline` **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=-1.0 **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_multimesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture=RID() **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_nine_patch` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_particles` **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_polygon` **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`RID` texture=RID() **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_polyline` **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=-1.0, :ref:`bool` antialiased=false **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_primitive` **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs, :ref:`RID` texture **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_texture_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false, :ref:`bool` clip_uv=true **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_add_triangle_array` **(** :ref:`RID` item, :ref:`PackedInt32Array` indices, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`PackedInt32Array` bones=PackedInt32Array(), :ref:`PackedFloat32Array` weights=PackedFloat32Array(), :ref:`RID` texture=RID(), :ref:`int` count=-1 **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_clear` **(** :ref:`RID` item **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`canvas_item_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_canvas_group_mode` **(** :ref:`RID` item, :ref:`CanvasGroupMode` mode, :ref:`float` clear_margin=5.0, :ref:`bool` fit_empty=false, :ref:`float` fit_margin=0.0, :ref:`bool` blur_mipmaps=false **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_clip` **(** :ref:`RID` item, :ref:`bool` clip **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_copy_to_backbuffer` **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_custom_rect` **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2(0, 0, 0, 0) **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_default_texture_filter` **(** :ref:`RID` item, :ref:`CanvasItemTextureFilter` filter **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_default_texture_repeat` **(** :ref:`RID` item, :ref:`CanvasItemTextureRepeat` repeat **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_distance_field_mode` **(** :ref:`RID` item, :ref:`bool` enabled **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_draw_behind_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_draw_index` **(** :ref:`RID` item, :ref:`int` index **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_light_mask` **(** :ref:`RID` item, :ref:`int` mask **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_material` **(** :ref:`RID` item, :ref:`RID` material **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_parent` **(** :ref:`RID` item, :ref:`RID` parent **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_self_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_sort_children_by_y` **(** :ref:`RID` item, :ref:`bool` enabled **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_use_parent_material` **(** :ref:`RID` item, :ref:`bool` enabled **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_visibility_layer` **(** :ref:`RID` item, :ref:`int` visibility_layer **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_visibility_notifier` **(** :ref:`RID` item, :ref:`bool` enable, :ref:`Rect2` area, :ref:`Callable` enter_callable, :ref:`Callable` exit_callable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_visible` **(** :ref:`RID` item, :ref:`bool` visible **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_z_as_relative_to_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_item_set_z_index` **(** :ref:`RID` item, :ref:`int` z_index **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_attach_to_canvas` **(** :ref:`RID` light, :ref:`RID` canvas **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`canvas_light_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_occluder_attach_to_canvas` **(** :ref:`RID` occluder, :ref:`RID` canvas **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`canvas_light_occluder_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_occluder_set_as_sdf_collision` **(** :ref:`RID` occluder, :ref:`bool` enable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_occluder_set_enabled` **(** :ref:`RID` occluder, :ref:`bool` enabled **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_occluder_set_light_mask` **(** :ref:`RID` occluder, :ref:`int` mask **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_occluder_set_polygon` **(** :ref:`RID` occluder, :ref:`RID` polygon **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_occluder_set_transform` **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_set_blend_mode` **(** :ref:`RID` light, :ref:`CanvasLightBlendMode` mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_set_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_set_energy` **(** :ref:`RID` light, :ref:`float` energy **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_set_height` **(** :ref:`RID` light, :ref:`float` height **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_set_item_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_set_item_shadow_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_set_layer_range` **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_set_mode` **(** :ref:`RID` light, :ref:`CanvasLightMode` mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_set_shadow_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_set_shadow_filter` **(** :ref:`RID` light, :ref:`CanvasLightShadowFilter` filter **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_set_shadow_smooth` **(** :ref:`RID` light, :ref:`float` smooth **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_set_texture` **(** :ref:`RID` light, :ref:`RID` texture **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_set_texture_offset` **(** :ref:`RID` light, :ref:`Vector2` offset **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_set_texture_scale` **(** :ref:`RID` light, :ref:`float` scale **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_set_transform` **(** :ref:`RID` light, :ref:`Transform2D` transform **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_light_set_z_range` **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`canvas_occluder_polygon_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_occluder_polygon_set_cull_mode` **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_occluder_polygon_set_shape` **(** :ref:`RID` occluder_polygon, :ref:`PackedVector2Array` shape, :ref:`bool` closed **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_set_disable_scale` **(** :ref:`bool` disable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_set_item_mirroring` **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_set_modulate` **(** :ref:`RID` canvas, :ref:`Color` color **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_set_shadow_texture_size` **(** :ref:`int` size **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`canvas_texture_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_texture_set_channel` **(** :ref:`RID` canvas_texture, :ref:`CanvasTextureChannel` channel, :ref:`RID` texture **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_texture_set_shading_parameters` **(** :ref:`RID` canvas_texture, :ref:`Color` base_color, :ref:`float` shininess **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_texture_set_texture_filter` **(** :ref:`RID` canvas_texture, :ref:`CanvasItemTextureFilter` filter **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`canvas_texture_set_texture_repeat` **(** :ref:`RID` canvas_texture, :ref:`CanvasItemTextureRepeat` repeat **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RenderingDevice` | :ref:`create_local_rendering_device` **(** **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`debug_canvas_item_get_rect` **(** :ref:`RID` item **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`decal_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`decal_set_albedo_mix` **(** :ref:`RID` decal, :ref:`float` albedo_mix **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`decal_set_cull_mask` **(** :ref:`RID` decal, :ref:`int` mask **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`decal_set_distance_fade` **(** :ref:`RID` decal, :ref:`bool` enabled, :ref:`float` begin, :ref:`float` length **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`decal_set_emission_energy` **(** :ref:`RID` decal, :ref:`float` energy **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`decal_set_fade` **(** :ref:`RID` decal, :ref:`float` above, :ref:`float` below **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`decal_set_modulate` **(** :ref:`RID` decal, :ref:`Color` color **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`decal_set_normal_fade` **(** :ref:`RID` decal, :ref:`float` fade **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`decal_set_size` **(** :ref:`RID` decal, :ref:`Vector3` size **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`decal_set_texture` **(** :ref:`RID` decal, :ref:`DecalTexture` type, :ref:`RID` texture **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`decals_set_filter` **(** :ref:`DecalFilter` filter **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`directional_light_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`directional_shadow_atlas_set_size` **(** :ref:`int` size, :ref:`bool` is_16bits **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`directional_soft_shadow_filter_set_quality` **(** :ref:`ShadowQuality` quality **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`environment_bake_panorama` **(** :ref:`RID` environment, :ref:`bool` bake_irradiance, :ref:`Vector2i` size **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`environment_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_glow_set_use_bicubic_upscale` **(** :ref:`bool` enable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_adjustment` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`bool` use_1d_color_correction, :ref:`RID` color_correction **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_ambient_light` **(** :ref:`RID` env, :ref:`Color` color, :ref:`EnvironmentAmbientSource` ambient=0, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0, :ref:`EnvironmentReflectionSource` reflection_source=0 **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_background` **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_bg_color` **(** :ref:`RID` env, :ref:`Color` color **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_bg_energy` **(** :ref:`RID` env, :ref:`float` multiplier, :ref:`float` exposure_value **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_canvas_max_layer` **(** :ref:`RID` env, :ref:`int` max_layer **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_fog` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` light_color, :ref:`float` light_energy, :ref:`float` sun_scatter, :ref:`float` density, :ref:`float` height, :ref:`float` height_density, :ref:`float` aerial_perspective, :ref:`float` sky_affect **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_glow` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`PackedFloat32Array` levels, :ref:`float` intensity, :ref:`float` strength, :ref:`float` mix, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`float` hdr_luminance_cap, :ref:`float` glow_map_strength, :ref:`RID` glow_map **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_sdfgi` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` cascades, :ref:`float` min_cell_size, :ref:`EnvironmentSDFGIYScale` y_scale, :ref:`bool` use_occlusion, :ref:`float` bounce_feedback, :ref:`bool` read_sky, :ref:`float` energy, :ref:`float` normal_bias, :ref:`float` probe_bias **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_sdfgi_frames_to_converge` **(** :ref:`EnvironmentSDFGIFramesToConverge` frames **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_sdfgi_frames_to_update_light` **(** :ref:`EnvironmentSDFGIFramesToUpdateLight` frames **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_sdfgi_ray_count` **(** :ref:`EnvironmentSDFGIRayCount` ray_count **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_sky` **(** :ref:`RID` env, :ref:`RID` sky **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_sky_custom_fov` **(** :ref:`RID` env, :ref:`float` scale **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_sky_orientation` **(** :ref:`RID` env, :ref:`Basis` orientation **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_ssao` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` power, :ref:`float` detail, :ref:`float` horizon, :ref:`float` sharpness, :ref:`float` light_affect, :ref:`float` ao_channel_affect **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_ssao_quality` **(** :ref:`EnvironmentSSAOQuality` quality, :ref:`bool` half_size, :ref:`float` adaptive_target, :ref:`int` blur_passes, :ref:`float` fadeout_from, :ref:`float` fadeout_to **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_ssil_quality` **(** :ref:`EnvironmentSSILQuality` quality, :ref:`bool` half_size, :ref:`float` adaptive_target, :ref:`int` blur_passes, :ref:`float` fadeout_from, :ref:`float` fadeout_to **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_ssr` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_ssr_roughness_quality` **(** :ref:`EnvironmentSSRRoughnessQuality` quality **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_tonemap` **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_volumetric_fog` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` density, :ref:`Color` albedo, :ref:`Color` emission, :ref:`float` emission_energy, :ref:`float` anisotropy, :ref:`float` length, :ref:`float` p_detail_spread, :ref:`float` gi_inject, :ref:`bool` temporal_reprojection, :ref:`float` temporal_reprojection_amount, :ref:`float` ambient_inject, :ref:`float` sky_affect **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_volumetric_fog_filter_active` **(** :ref:`bool` active **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`environment_set_volumetric_fog_volume_size` **(** :ref:`int` size, :ref:`int` depth **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`fog_volume_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fog_volume_set_material` **(** :ref:`RID` fog_volume, :ref:`RID` material **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fog_volume_set_shape` **(** :ref:`RID` fog_volume, :ref:`FogVolumeShape` shape **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fog_volume_set_size` **(** :ref:`RID` fog_volume, :ref:`Vector3` size **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`force_draw` **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`force_sync` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`free_rid` **(** :ref:`RID` rid **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_default_clear_color` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_frame_setup_time_cpu` **(** **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RenderingDevice` | :ref:`get_rendering_device` **(** **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_rendering_info` **(** :ref:`RenderingInfo` info **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`get_shader_parameter_list` **(** :ref:`RID` shader **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_test_cube` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_test_texture` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_video_adapter_api_version` **(** **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_video_adapter_name` **(** **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`DeviceType` | :ref:`get_video_adapter_type` **(** **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_video_adapter_vendor` **(** **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_white_texture` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`gi_set_use_half_resolution` **(** :ref:`bool` half_resolution **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_shader_parameter_add` **(** :ref:`StringName` name, :ref:`GlobalShaderParameterType` type, :ref:`Variant` default_value **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`global_shader_parameter_get` **(** :ref:`StringName` name **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName[]` | :ref:`global_shader_parameter_get_list` **(** **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GlobalShaderParameterType` | :ref:`global_shader_parameter_get_type` **(** :ref:`StringName` name **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_shader_parameter_remove` **(** :ref:`StringName` name **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_shader_parameter_set` **(** :ref:`StringName` name, :ref:`Variant` value **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`global_shader_parameter_set_override` **(** :ref:`StringName` name, :ref:`Variant` value **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_changed` **(** **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_feature` **(** :ref:`Features` feature **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_os_feature` **(** :ref:`String` feature **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_attach_object_instance_id` **(** :ref:`RID` instance, :ref:`int` id **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_attach_skeleton` **(** :ref:`RID` instance, :ref:`RID` skeleton **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`instance_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`instance_create2` **(** :ref:`RID` base, :ref:`RID` scenario **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`instance_geometry_get_shader_parameter` **(** :ref:`RID` instance, :ref:`StringName` parameter **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`instance_geometry_get_shader_parameter_default_value` **(** :ref:`RID` instance, :ref:`StringName` parameter **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`instance_geometry_get_shader_parameter_list` **(** :ref:`RID` instance **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_geometry_set_cast_shadows_setting` **(** :ref:`RID` instance, :ref:`ShadowCastingSetting` shadow_casting_setting **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_geometry_set_flag` **(** :ref:`RID` instance, :ref:`InstanceFlags` flag, :ref:`bool` enabled **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_geometry_set_lightmap` **(** :ref:`RID` instance, :ref:`RID` lightmap, :ref:`Rect2` lightmap_uv_scale, :ref:`int` lightmap_slice **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_geometry_set_lod_bias` **(** :ref:`RID` instance, :ref:`float` lod_bias **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_geometry_set_material_overlay` **(** :ref:`RID` instance, :ref:`RID` material **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_geometry_set_material_override` **(** :ref:`RID` instance, :ref:`RID` material **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_geometry_set_shader_parameter` **(** :ref:`RID` instance, :ref:`StringName` parameter, :ref:`Variant` value **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_geometry_set_transparency` **(** :ref:`RID` instance, :ref:`float` transparency **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_geometry_set_visibility_range` **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin, :ref:`VisibilityRangeFadeMode` fade_mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_set_base` **(** :ref:`RID` instance, :ref:`RID` base **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_set_blend_shape_weight` **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_set_custom_aabb` **(** :ref:`RID` instance, :ref:`AABB` aabb **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_set_extra_visibility_margin` **(** :ref:`RID` instance, :ref:`float` margin **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_set_ignore_culling` **(** :ref:`RID` instance, :ref:`bool` enabled **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_set_layer_mask` **(** :ref:`RID` instance, :ref:`int` mask **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_set_pivot_data` **(** :ref:`RID` instance, :ref:`float` sorting_offset, :ref:`bool` use_aabb_center **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_set_scenario` **(** :ref:`RID` instance, :ref:`RID` scenario **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_set_surface_override_material` **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_set_transform` **(** :ref:`RID` instance, :ref:`Transform3D` transform **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_set_visibility_parent` **(** :ref:`RID` instance, :ref:`RID` parent **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_set_visible` **(** :ref:`RID` instance, :ref:`bool` visible **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`instances_cull_aabb` **(** :ref:`AABB` aabb, :ref:`RID` scenario=RID() **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`instances_cull_convex` **(** :ref:`Plane[]` convex, :ref:`RID` scenario=RID() **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt64Array` | :ref:`instances_cull_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario=RID() **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`light_directional_set_blend_splits` **(** :ref:`RID` light, :ref:`bool` enable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`light_directional_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`light_directional_set_sky_mode` **(** :ref:`RID` light, :ref:`LightDirectionalSkyMode` mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`light_omni_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`light_projectors_set_filter` **(** :ref:`LightProjectorFilter` filter **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`light_set_bake_mode` **(** :ref:`RID` light, :ref:`LightBakeMode` bake_mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`light_set_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`light_set_distance_fade` **(** :ref:`RID` decal, :ref:`bool` enabled, :ref:`float` begin, :ref:`float` shadow, :ref:`float` length **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`light_set_max_sdfgi_cascade` **(** :ref:`RID` light, :ref:`int` cascade **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`light_set_negative` **(** :ref:`RID` light, :ref:`bool` enable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`light_set_param` **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`light_set_projector` **(** :ref:`RID` light, :ref:`RID` texture **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`light_set_reverse_cull_face_mode` **(** :ref:`RID` light, :ref:`bool` enabled **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`light_set_shadow` **(** :ref:`RID` light, :ref:`bool` enabled **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`lightmap_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`lightmap_get_probe_capture_bsp_tree` **(** :ref:`RID` lightmap **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`lightmap_get_probe_capture_points` **(** :ref:`RID` lightmap **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedColorArray` | :ref:`lightmap_get_probe_capture_sh` **(** :ref:`RID` lightmap **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`lightmap_get_probe_capture_tetrahedra` **(** :ref:`RID` lightmap **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`lightmap_set_baked_exposure_normalization` **(** :ref:`RID` lightmap, :ref:`float` baked_exposure **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`lightmap_set_probe_bounds` **(** :ref:`RID` lightmap, :ref:`AABB` bounds **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`lightmap_set_probe_capture_data` **(** :ref:`RID` lightmap, :ref:`PackedVector3Array` points, :ref:`PackedColorArray` point_sh, :ref:`PackedInt32Array` tetrahedra, :ref:`PackedInt32Array` bsp_tree **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`lightmap_set_probe_capture_update_speed` **(** :ref:`float` speed **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`lightmap_set_probe_interior` **(** :ref:`RID` lightmap, :ref:`bool` interior **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`lightmap_set_textures` **(** :ref:`RID` lightmap, :ref:`RID` light, :ref:`bool` uses_sh **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`make_sphere_mesh` **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`material_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`material_get_param` **(** :ref:`RID` material, :ref:`StringName` parameter **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`material_set_next_pass` **(** :ref:`RID` material, :ref:`RID` next_material **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`material_set_param` **(** :ref:`RID` material, :ref:`StringName` parameter, :ref:`Variant` value **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`material_set_render_priority` **(** :ref:`RID` material, :ref:`int` priority **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`material_set_shader` **(** :ref:`RID` shader_material, :ref:`RID` shader **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`mesh_add_surface` **(** :ref:`RID` mesh, :ref:`Dictionary` surface **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`mesh_add_surface_from_arrays` **(** :ref:`RID` mesh, :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[], :ref:`Dictionary` lods={}, |bitfield|\<:ref:`ArrayFormat`\> compress_format=0 **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`mesh_clear` **(** :ref:`RID` mesh **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`mesh_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`mesh_create_from_surfaces` **(** :ref:`Dictionary[]` surfaces, :ref:`int` blend_shape_count=0 **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`mesh_get_blend_shape_count` **(** :ref:`RID` mesh **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`BlendShapeMode` | :ref:`mesh_get_blend_shape_mode` **(** :ref:`RID` mesh **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`mesh_get_custom_aabb` **(** :ref:`RID` mesh **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`mesh_get_surface` **(** :ref:`RID` mesh, :ref:`int` surface **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`mesh_get_surface_count` **(** :ref:`RID` mesh **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`mesh_set_blend_shape_mode` **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`mesh_set_custom_aabb` **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`mesh_set_shadow_mesh` **(** :ref:`RID` mesh, :ref:`RID` shadow_mesh **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`mesh_surface_get_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array[]` | :ref:`mesh_surface_get_blend_shape_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`mesh_surface_get_format_attribute_stride` **(** |bitfield|\<:ref:`ArrayFormat`\> format, :ref:`int` vertex_count **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`mesh_surface_get_format_normal_tangent_stride` **(** |bitfield|\<:ref:`ArrayFormat`\> format, :ref:`int` vertex_count **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`mesh_surface_get_format_offset` **(** |bitfield|\<:ref:`ArrayFormat`\> format, :ref:`int` vertex_count, :ref:`int` array_index **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`mesh_surface_get_format_skin_stride` **(** |bitfield|\<:ref:`ArrayFormat`\> format, :ref:`int` vertex_count **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`mesh_surface_get_format_vertex_stride` **(** |bitfield|\<:ref:`ArrayFormat`\> format, :ref:`int` vertex_count **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`mesh_surface_get_material` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`mesh_surface_set_material` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`mesh_surface_update_attribute_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`mesh_surface_update_skin_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`mesh_surface_update_vertex_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`multimesh_allocate_data` **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`bool` color_format=false, :ref:`bool` custom_data_format=false **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`multimesh_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`multimesh_get_aabb` **(** :ref:`RID` multimesh **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`multimesh_get_buffer` **(** :ref:`RID` multimesh **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`multimesh_get_custom_aabb` **(** :ref:`RID` multimesh **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`multimesh_get_instance_count` **(** :ref:`RID` multimesh **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`multimesh_get_mesh` **(** :ref:`RID` multimesh **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`multimesh_get_visible_instances` **(** :ref:`RID` multimesh **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`multimesh_instance_get_color` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`multimesh_instance_get_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`multimesh_instance_get_transform` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`multimesh_instance_get_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`multimesh_instance_set_color` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`multimesh_instance_set_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`multimesh_instance_set_transform` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform3D` transform **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`multimesh_instance_set_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`multimesh_set_buffer` **(** :ref:`RID` multimesh, :ref:`PackedFloat32Array` buffer **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`multimesh_set_custom_aabb` **(** :ref:`RID` multimesh, :ref:`AABB` aabb **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`multimesh_set_mesh` **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`multimesh_set_visible_instances` **(** :ref:`RID` multimesh, :ref:`int` visible **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`occluder_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`occluder_set_mesh` **(** :ref:`RID` occluder, :ref:`PackedVector3Array` vertices, :ref:`PackedInt32Array` indices **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`omni_light_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`particles_collision_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_collision_height_field_update` **(** :ref:`RID` particles_collision **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_collision_set_attractor_attenuation` **(** :ref:`RID` particles_collision, :ref:`float` curve **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_collision_set_attractor_directionality` **(** :ref:`RID` particles_collision, :ref:`float` amount **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_collision_set_attractor_strength` **(** :ref:`RID` particles_collision, :ref:`float` strength **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_collision_set_box_extents` **(** :ref:`RID` particles_collision, :ref:`Vector3` extents **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_collision_set_collision_type` **(** :ref:`RID` particles_collision, :ref:`ParticlesCollisionType` type **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_collision_set_cull_mask` **(** :ref:`RID` particles_collision, :ref:`int` mask **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_collision_set_field_texture` **(** :ref:`RID` particles_collision, :ref:`RID` texture **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_collision_set_height_field_resolution` **(** :ref:`RID` particles_collision, :ref:`ParticlesCollisionHeightfieldResolution` resolution **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_collision_set_sphere_radius` **(** :ref:`RID` particles_collision, :ref:`float` radius **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`particles_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_emit` **(** :ref:`RID` particles, :ref:`Transform3D` transform, :ref:`Vector3` velocity, :ref:`Color` color, :ref:`Color` custom, :ref:`int` emit_flags **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`particles_get_current_aabb` **(** :ref:`RID` particles **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`particles_get_emitting` **(** :ref:`RID` particles **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`particles_is_inactive` **(** :ref:`RID` particles **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_request_process` **(** :ref:`RID` particles **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_restart` **(** :ref:`RID` particles **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_amount` **(** :ref:`RID` particles, :ref:`int` amount **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_amount_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_collision_base_size` **(** :ref:`RID` particles, :ref:`float` size **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_custom_aabb` **(** :ref:`RID` particles, :ref:`AABB` aabb **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_draw_order` **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_draw_pass_mesh` **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_draw_passes` **(** :ref:`RID` particles, :ref:`int` count **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_emission_transform` **(** :ref:`RID` particles, :ref:`Transform3D` transform **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_emitter_velocity` **(** :ref:`RID` particles, :ref:`Vector3` velocity **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_emitting` **(** :ref:`RID` particles, :ref:`bool` emitting **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_explosiveness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_fixed_fps` **(** :ref:`RID` particles, :ref:`int` fps **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_fractional_delta` **(** :ref:`RID` particles, :ref:`bool` enable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_interp_to_end` **(** :ref:`RID` particles, :ref:`float` factor **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_interpolate` **(** :ref:`RID` particles, :ref:`bool` enable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_lifetime` **(** :ref:`RID` particles, :ref:`float` lifetime **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_mode` **(** :ref:`RID` particles, :ref:`ParticlesMode` mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_one_shot` **(** :ref:`RID` particles, :ref:`bool` one_shot **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_pre_process_time` **(** :ref:`RID` particles, :ref:`float` time **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_process_material` **(** :ref:`RID` particles, :ref:`RID` material **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_randomness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_speed_scale` **(** :ref:`RID` particles, :ref:`float` scale **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_subemitter` **(** :ref:`RID` particles, :ref:`RID` subemitter_particles **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_trail_bind_poses` **(** :ref:`RID` particles, :ref:`Transform3D[]` bind_poses **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_trails` **(** :ref:`RID` particles, :ref:`bool` enable, :ref:`float` length_sec **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_transform_align` **(** :ref:`RID` particles, :ref:`ParticlesTransformAlign` align **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`particles_set_use_local_coordinates` **(** :ref:`RID` particles, :ref:`bool` enable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`positional_soft_shadow_filter_set_quality` **(** :ref:`ShadowQuality` quality **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`reflection_probe_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reflection_probe_set_ambient_color` **(** :ref:`RID` probe, :ref:`Color` color **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reflection_probe_set_ambient_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reflection_probe_set_ambient_mode` **(** :ref:`RID` probe, :ref:`ReflectionProbeAmbientMode` mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reflection_probe_set_as_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reflection_probe_set_cull_mask` **(** :ref:`RID` probe, :ref:`int` layers **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reflection_probe_set_enable_box_projection` **(** :ref:`RID` probe, :ref:`bool` enable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reflection_probe_set_enable_shadows` **(** :ref:`RID` probe, :ref:`bool` enable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reflection_probe_set_intensity` **(** :ref:`RID` probe, :ref:`float` intensity **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reflection_probe_set_max_distance` **(** :ref:`RID` probe, :ref:`float` distance **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reflection_probe_set_mesh_lod_threshold` **(** :ref:`RID` probe, :ref:`float` pixels **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reflection_probe_set_origin_offset` **(** :ref:`RID` probe, :ref:`Vector3` offset **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reflection_probe_set_reflection_mask` **(** :ref:`RID` probe, :ref:`int` layers **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reflection_probe_set_resolution` **(** :ref:`RID` probe, :ref:`int` resolution **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reflection_probe_set_size` **(** :ref:`RID` probe, :ref:`Vector3` size **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reflection_probe_set_update_mode` **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`request_frame_drawn_callback` **(** :ref:`Callable` callable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`scenario_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`scenario_set_camera_attributes` **(** :ref:`RID` scenario, :ref:`RID` effects **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`scenario_set_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`scenario_set_fallback_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`screen_space_roughness_limiter_set_active` **(** :ref:`bool` enable, :ref:`float` amount, :ref:`float` limit **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_boot_image` **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale, :ref:`bool` use_filter=true **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_debug_generate_wireframes` **(** :ref:`bool` generate **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_default_clear_color` **(** :ref:`Color` color **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`shader_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`shader_get_code` **(** :ref:`RID` shader **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`shader_get_default_texture_parameter` **(** :ref:`RID` shader, :ref:`StringName` name, :ref:`int` index=0 **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`shader_get_parameter_default` **(** :ref:`RID` shader, :ref:`StringName` name **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shader_set_code` **(** :ref:`RID` shader, :ref:`String` code **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shader_set_default_texture_parameter` **(** :ref:`RID` shader, :ref:`StringName` name, :ref:`RID` texture, :ref:`int` index=0 **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shader_set_path_hint` **(** :ref:`RID` shader, :ref:`String` path **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`skeleton_allocate_data` **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`skeleton_bone_get_transform` **(** :ref:`RID` skeleton, :ref:`int` bone **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`skeleton_bone_get_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`skeleton_bone_set_transform` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform3D` transform **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`skeleton_bone_set_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`skeleton_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`skeleton_get_bone_count` **(** :ref:`RID` skeleton **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`skeleton_set_base_transform_2d` **(** :ref:`RID` skeleton, :ref:`Transform2D` base_transform **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`sky_bake_panorama` **(** :ref:`RID` sky, :ref:`float` energy, :ref:`bool` bake_irradiance, :ref:`Vector2i` size **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`sky_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`sky_set_material` **(** :ref:`RID` sky, :ref:`RID` material **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`sky_set_mode` **(** :ref:`RID` sky, :ref:`SkyMode` mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`sky_set_radiance_size` **(** :ref:`RID` sky, :ref:`int` radiance_size **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`spot_light_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`sub_surface_scattering_set_quality` **(** :ref:`SubSurfaceScatteringQuality` quality **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`sub_surface_scattering_set_scale` **(** :ref:`float` scale, :ref:`float` depth_scale **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`texture_2d_create` **(** :ref:`Image` image **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`texture_2d_get` **(** :ref:`RID` texture **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`texture_2d_layer_get` **(** :ref:`RID` texture, :ref:`int` layer **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`texture_2d_layered_create` **(** :ref:`Image[]` layers, :ref:`TextureLayeredType` layered_type **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`texture_2d_layered_placeholder_create` **(** :ref:`TextureLayeredType` layered_type **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`texture_2d_placeholder_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`texture_2d_update` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`texture_3d_create` **(** :ref:`Format` format, :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`bool` mipmaps, :ref:`Image[]` data **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image[]` | :ref:`texture_3d_get` **(** :ref:`RID` texture **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`texture_3d_placeholder_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`texture_3d_update` **(** :ref:`RID` texture, :ref:`Image[]` data **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Format` | :ref:`texture_get_format` **(** :ref:`RID` texture **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`texture_get_native_handle` **(** :ref:`RID` texture, :ref:`bool` srgb=false **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`texture_get_path` **(** :ref:`RID` texture **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`texture_get_rd_texture` **(** :ref:`RID` texture, :ref:`bool` srgb=false **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`texture_proxy_create` **(** :ref:`RID` base **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`texture_proxy_update` **(** :ref:`RID` texture, :ref:`RID` proxy_to **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`texture_rd_create` **(** :ref:`RID` rd_texture, :ref:`TextureLayeredType` layer_type=0 **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`texture_replace` **(** :ref:`RID` texture, :ref:`RID` by_texture **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`texture_set_force_redraw_if_visible` **(** :ref:`RID` texture, :ref:`bool` enable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`texture_set_path` **(** :ref:`RID` texture, :ref:`String` path **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`texture_set_size_override` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_attach_camera` **(** :ref:`RID` viewport, :ref:`RID` camera **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_attach_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_attach_to_screen` **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2(0, 0, 0, 0), :ref:`int` screen=0 **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`viewport_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`viewport_get_measured_render_time_cpu` **(** :ref:`RID` viewport **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`viewport_get_measured_render_time_gpu` **(** :ref:`RID` viewport **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`viewport_get_render_info` **(** :ref:`RID` viewport, :ref:`ViewportRenderInfoType` type, :ref:`ViewportRenderInfo` info **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`viewport_get_render_target` **(** :ref:`RID` viewport **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`viewport_get_texture` **(** :ref:`RID` viewport **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_remove_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_active` **(** :ref:`RID` viewport, :ref:`bool` active **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_canvas_cull_mask` **(** :ref:`RID` viewport, :ref:`int` canvas_cull_mask **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_canvas_stacking` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer, :ref:`int` sublayer **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_canvas_transform` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_clear_mode` **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_debug_draw` **(** :ref:`RID` viewport, :ref:`ViewportDebugDraw` draw **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_default_canvas_item_texture_filter` **(** :ref:`RID` viewport, :ref:`CanvasItemTextureFilter` filter **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_default_canvas_item_texture_repeat` **(** :ref:`RID` viewport, :ref:`CanvasItemTextureRepeat` repeat **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_disable_2d` **(** :ref:`RID` viewport, :ref:`bool` disable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_disable_3d` **(** :ref:`RID` viewport, :ref:`bool` disable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_environment_mode` **(** :ref:`RID` viewport, :ref:`ViewportEnvironmentMode` mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_fsr_sharpness` **(** :ref:`RID` viewport, :ref:`float` sharpness **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_global_canvas_transform` **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_measure_render_time` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_msaa_2d` **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_msaa_3d` **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_occlusion_culling_build_quality` **(** :ref:`ViewportOcclusionCullingBuildQuality` quality **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_occlusion_rays_per_thread` **(** :ref:`int` rays_per_thread **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_parent_viewport` **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_positional_shadow_atlas_quadrant_subdivision` **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_positional_shadow_atlas_size` **(** :ref:`RID` viewport, :ref:`int` size, :ref:`bool` use_16_bits=false **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_render_direct_to_screen` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_scaling_3d_mode` **(** :ref:`RID` viewport, :ref:`ViewportScaling3DMode` scaling_3d_mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_scaling_3d_scale` **(** :ref:`RID` viewport, :ref:`float` scale **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_scenario` **(** :ref:`RID` viewport, :ref:`RID` scenario **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_screen_space_aa` **(** :ref:`RID` viewport, :ref:`ViewportScreenSpaceAA` mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_sdf_oversize_and_scale` **(** :ref:`RID` viewport, :ref:`ViewportSDFOversize` oversize, :ref:`ViewportSDFScale` scale **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_size` **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_snap_2d_transforms_to_pixel` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_snap_2d_vertices_to_pixel` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_texture_mipmap_bias` **(** :ref:`RID` viewport, :ref:`float` mipmap_bias **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_transparent_background` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_update_mode` **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_use_debanding` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_use_hdr_2d` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_use_occlusion_culling` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_use_taa` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_use_xr` **(** :ref:`RID` viewport, :ref:`bool` use_xr **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_vrs_mode` **(** :ref:`RID` viewport, :ref:`ViewportVRSMode` mode **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`viewport_set_vrs_texture` **(** :ref:`RID` viewport, :ref:`RID` texture **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`visibility_notifier_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`visibility_notifier_set_aabb` **(** :ref:`RID` notifier, :ref:`AABB` aabb **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`visibility_notifier_set_callbacks` **(** :ref:`RID` notifier, :ref:`Callable` enter_callable, :ref:`Callable` exit_callable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`voxel_gi_allocate_data` **(** :ref:`RID` voxel_gi, :ref:`Transform3D` to_cell_xform, :ref:`AABB` aabb, :ref:`Vector3i` octree_size, :ref:`PackedByteArray` octree_cells, :ref:`PackedByteArray` data_cells, :ref:`PackedByteArray` distance_field, :ref:`PackedInt32Array` level_counts **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`voxel_gi_create` **(** **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`voxel_gi_get_data_cells` **(** :ref:`RID` voxel_gi **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`voxel_gi_get_distance_field` **(** :ref:`RID` voxel_gi **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`voxel_gi_get_level_counts` **(** :ref:`RID` voxel_gi **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`voxel_gi_get_octree_cells` **(** :ref:`RID` voxel_gi **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`voxel_gi_get_octree_size` **(** :ref:`RID` voxel_gi **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`voxel_gi_get_to_cell_xform` **(** :ref:`RID` voxel_gi **)** |const| | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`voxel_gi_set_baked_exposure_normalization` **(** :ref:`RID` voxel_gi, :ref:`float` baked_exposure **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`voxel_gi_set_bias` **(** :ref:`RID` voxel_gi, :ref:`float` bias **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`voxel_gi_set_dynamic_range` **(** :ref:`RID` voxel_gi, :ref:`float` range **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`voxel_gi_set_energy` **(** :ref:`RID` voxel_gi, :ref:`float` energy **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`voxel_gi_set_interior` **(** :ref:`RID` voxel_gi, :ref:`bool` enable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`voxel_gi_set_normal_bias` **(** :ref:`RID` voxel_gi, :ref:`float` bias **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`voxel_gi_set_propagation` **(** :ref:`RID` voxel_gi, :ref:`float` amount **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`voxel_gi_set_quality` **(** :ref:`VoxelGIQuality` quality **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`voxel_gi_set_use_two_bounces` **(** :ref:`RID` voxel_gi, :ref:`bool` enable **)** | - +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Image`\] | :ref:`bake_render_uv2`\ (\ base\: :ref:`RID`, material_overrides\: :ref:`Array`\[:ref:`RID`\], image_size\: :ref:`Vector2i`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`call_on_render_thread`\ (\ callable\: :ref:`Callable`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`camera_attributes_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`camera_attributes_set_auto_exposure`\ (\ camera_attributes\: :ref:`RID`, enable\: :ref:`bool`, min_sensitivity\: :ref:`float`, max_sensitivity\: :ref:`float`, speed\: :ref:`float`, scale\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`camera_attributes_set_dof_blur`\ (\ camera_attributes\: :ref:`RID`, far_enable\: :ref:`bool`, far_distance\: :ref:`float`, far_transition\: :ref:`float`, near_enable\: :ref:`bool`, near_distance\: :ref:`float`, near_transition\: :ref:`float`, amount\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`camera_attributes_set_dof_blur_bokeh_shape`\ (\ shape\: :ref:`DOFBokehShape`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`camera_attributes_set_dof_blur_quality`\ (\ quality\: :ref:`DOFBlurQuality`, use_jitter\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`camera_attributes_set_exposure`\ (\ camera_attributes\: :ref:`RID`, multiplier\: :ref:`float`, normalization\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`camera_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`camera_set_camera_attributes`\ (\ camera\: :ref:`RID`, effects\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`camera_set_compositor`\ (\ camera\: :ref:`RID`, compositor\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`camera_set_cull_mask`\ (\ camera\: :ref:`RID`, layers\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`camera_set_environment`\ (\ camera\: :ref:`RID`, env\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`camera_set_frustum`\ (\ camera\: :ref:`RID`, size\: :ref:`float`, offset\: :ref:`Vector2`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`camera_set_orthogonal`\ (\ camera\: :ref:`RID`, size\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`camera_set_perspective`\ (\ camera\: :ref:`RID`, fovy_degrees\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`camera_set_transform`\ (\ camera\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`camera_set_use_vertical_aspect`\ (\ camera\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`canvas_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_animation_slice`\ (\ item\: :ref:`RID`, animation_length\: :ref:`float`, slice_begin\: :ref:`float`, slice_end\: :ref:`float`, offset\: :ref:`float` = 0.0\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_circle`\ (\ item\: :ref:`RID`, pos\: :ref:`Vector2`, radius\: :ref:`float`, color\: :ref:`Color`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_clip_ignore`\ (\ item\: :ref:`RID`, ignore\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_lcd_texture_rect_region`\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_line`\ (\ item\: :ref:`RID`, from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_mesh`\ (\ item\: :ref:`RID`, mesh\: :ref:`RID`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color` = Color(1, 1, 1, 1), texture\: :ref:`RID` = RID()\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_msdf_texture_rect_region`\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), outline_size\: :ref:`int` = 0, px_range\: :ref:`float` = 1.0, scale\: :ref:`float` = 1.0\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_multiline`\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_multimesh`\ (\ item\: :ref:`RID`, mesh\: :ref:`RID`, texture\: :ref:`RID` = RID()\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_nine_patch`\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, source\: :ref:`Rect2`, texture\: :ref:`RID`, topleft\: :ref:`Vector2`, bottomright\: :ref:`Vector2`, x_axis_mode\: :ref:`NinePatchAxisMode` = 0, y_axis_mode\: :ref:`NinePatchAxisMode` = 0, draw_center\: :ref:`bool` = true, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_particles`\ (\ item\: :ref:`RID`, particles\: :ref:`RID`, texture\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_polygon`\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`RID` = RID()\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_polyline`\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_primitive`\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array`, texture\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_rect`\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, color\: :ref:`Color`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_set_transform`\ (\ item\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_texture_rect`\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, tile\: :ref:`bool` = false, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_texture_rect_region`\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false, clip_uv\: :ref:`bool` = true\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_add_triangle_array`\ (\ item\: :ref:`RID`, indices\: :ref:`PackedInt32Array`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), bones\: :ref:`PackedInt32Array` = PackedInt32Array(), weights\: :ref:`PackedFloat32Array` = PackedFloat32Array(), texture\: :ref:`RID` = RID(), count\: :ref:`int` = -1\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_clear`\ (\ item\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`canvas_item_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_canvas_group_mode`\ (\ item\: :ref:`RID`, mode\: :ref:`CanvasGroupMode`, clear_margin\: :ref:`float` = 5.0, fit_empty\: :ref:`bool` = false, fit_margin\: :ref:`float` = 0.0, blur_mipmaps\: :ref:`bool` = false\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_clip`\ (\ item\: :ref:`RID`, clip\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_copy_to_backbuffer`\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`, rect\: :ref:`Rect2`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_custom_rect`\ (\ item\: :ref:`RID`, use_custom_rect\: :ref:`bool`, rect\: :ref:`Rect2` = Rect2(0, 0, 0, 0)\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_default_texture_filter`\ (\ item\: :ref:`RID`, filter\: :ref:`CanvasItemTextureFilter`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_default_texture_repeat`\ (\ item\: :ref:`RID`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_distance_field_mode`\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_draw_behind_parent`\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_draw_index`\ (\ item\: :ref:`RID`, index\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_light_mask`\ (\ item\: :ref:`RID`, mask\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_material`\ (\ item\: :ref:`RID`, material\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_modulate`\ (\ item\: :ref:`RID`, color\: :ref:`Color`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_parent`\ (\ item\: :ref:`RID`, parent\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_self_modulate`\ (\ item\: :ref:`RID`, color\: :ref:`Color`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_sort_children_by_y`\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_transform`\ (\ item\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_use_parent_material`\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_visibility_layer`\ (\ item\: :ref:`RID`, visibility_layer\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_visibility_notifier`\ (\ item\: :ref:`RID`, enable\: :ref:`bool`, area\: :ref:`Rect2`, enter_callable\: :ref:`Callable`, exit_callable\: :ref:`Callable`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_visible`\ (\ item\: :ref:`RID`, visible\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_z_as_relative_to_parent`\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_item_set_z_index`\ (\ item\: :ref:`RID`, z_index\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_attach_to_canvas`\ (\ light\: :ref:`RID`, canvas\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`canvas_light_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_occluder_attach_to_canvas`\ (\ occluder\: :ref:`RID`, canvas\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`canvas_light_occluder_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_occluder_set_as_sdf_collision`\ (\ occluder\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_occluder_set_enabled`\ (\ occluder\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_occluder_set_light_mask`\ (\ occluder\: :ref:`RID`, mask\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_occluder_set_polygon`\ (\ occluder\: :ref:`RID`, polygon\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_occluder_set_transform`\ (\ occluder\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_set_blend_mode`\ (\ light\: :ref:`RID`, mode\: :ref:`CanvasLightBlendMode`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_set_color`\ (\ light\: :ref:`RID`, color\: :ref:`Color`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_set_enabled`\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_set_energy`\ (\ light\: :ref:`RID`, energy\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_set_height`\ (\ light\: :ref:`RID`, height\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_set_item_cull_mask`\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_set_item_shadow_cull_mask`\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_set_layer_range`\ (\ light\: :ref:`RID`, min_layer\: :ref:`int`, max_layer\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_set_mode`\ (\ light\: :ref:`RID`, mode\: :ref:`CanvasLightMode`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_set_shadow_color`\ (\ light\: :ref:`RID`, color\: :ref:`Color`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_set_shadow_enabled`\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_set_shadow_filter`\ (\ light\: :ref:`RID`, filter\: :ref:`CanvasLightShadowFilter`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_set_shadow_smooth`\ (\ light\: :ref:`RID`, smooth\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_set_texture`\ (\ light\: :ref:`RID`, texture\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_set_texture_offset`\ (\ light\: :ref:`RID`, offset\: :ref:`Vector2`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_set_texture_scale`\ (\ light\: :ref:`RID`, scale\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_set_transform`\ (\ light\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_light_set_z_range`\ (\ light\: :ref:`RID`, min_z\: :ref:`int`, max_z\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`canvas_occluder_polygon_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_occluder_polygon_set_cull_mode`\ (\ occluder_polygon\: :ref:`RID`, mode\: :ref:`CanvasOccluderPolygonCullMode`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_occluder_polygon_set_shape`\ (\ occluder_polygon\: :ref:`RID`, shape\: :ref:`PackedVector2Array`, closed\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_set_disable_scale`\ (\ disable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_set_item_mirroring`\ (\ canvas\: :ref:`RID`, item\: :ref:`RID`, mirroring\: :ref:`Vector2`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_set_modulate`\ (\ canvas\: :ref:`RID`, color\: :ref:`Color`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_set_shadow_texture_size`\ (\ size\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`canvas_texture_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_texture_set_channel`\ (\ canvas_texture\: :ref:`RID`, channel\: :ref:`CanvasTextureChannel`, texture\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_texture_set_shading_parameters`\ (\ canvas_texture\: :ref:`RID`, base_color\: :ref:`Color`, shininess\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_texture_set_texture_filter`\ (\ canvas_texture\: :ref:`RID`, filter\: :ref:`CanvasItemTextureFilter`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`canvas_texture_set_texture_repeat`\ (\ canvas_texture\: :ref:`RID`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`compositor_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`compositor_effect_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`compositor_effect_set_callback`\ (\ effect\: :ref:`RID`, callback_type\: :ref:`CompositorEffectCallbackType`, callback\: :ref:`Callable`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`compositor_effect_set_enabled`\ (\ effect\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`compositor_effect_set_flag`\ (\ effect\: :ref:`RID`, flag\: :ref:`CompositorEffectFlags`, set\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`compositor_set_compositor_effects`\ (\ compositor\: :ref:`RID`, effects\: :ref:`Array`\[:ref:`RID`\]\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RenderingDevice` | :ref:`create_local_rendering_device`\ (\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`debug_canvas_item_get_rect`\ (\ item\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`decal_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`decal_set_albedo_mix`\ (\ decal\: :ref:`RID`, albedo_mix\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`decal_set_cull_mask`\ (\ decal\: :ref:`RID`, mask\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`decal_set_distance_fade`\ (\ decal\: :ref:`RID`, enabled\: :ref:`bool`, begin\: :ref:`float`, length\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`decal_set_emission_energy`\ (\ decal\: :ref:`RID`, energy\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`decal_set_fade`\ (\ decal\: :ref:`RID`, above\: :ref:`float`, below\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`decal_set_modulate`\ (\ decal\: :ref:`RID`, color\: :ref:`Color`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`decal_set_normal_fade`\ (\ decal\: :ref:`RID`, fade\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`decal_set_size`\ (\ decal\: :ref:`RID`, size\: :ref:`Vector3`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`decal_set_texture`\ (\ decal\: :ref:`RID`, type\: :ref:`DecalTexture`, texture\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`decals_set_filter`\ (\ filter\: :ref:`DecalFilter`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`directional_light_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`directional_shadow_atlas_set_size`\ (\ size\: :ref:`int`, is_16bits\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`directional_soft_shadow_filter_set_quality`\ (\ quality\: :ref:`ShadowQuality`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`environment_bake_panorama`\ (\ environment\: :ref:`RID`, bake_irradiance\: :ref:`bool`, size\: :ref:`Vector2i`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`environment_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_glow_set_use_bicubic_upscale`\ (\ enable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_adjustment`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, brightness\: :ref:`float`, contrast\: :ref:`float`, saturation\: :ref:`float`, use_1d_color_correction\: :ref:`bool`, color_correction\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_ambient_light`\ (\ env\: :ref:`RID`, color\: :ref:`Color`, ambient\: :ref:`EnvironmentAmbientSource` = 0, energy\: :ref:`float` = 1.0, sky_contibution\: :ref:`float` = 0.0, reflection_source\: :ref:`EnvironmentReflectionSource` = 0\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_background`\ (\ env\: :ref:`RID`, bg\: :ref:`EnvironmentBG`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_bg_color`\ (\ env\: :ref:`RID`, color\: :ref:`Color`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_bg_energy`\ (\ env\: :ref:`RID`, multiplier\: :ref:`float`, exposure_value\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_canvas_max_layer`\ (\ env\: :ref:`RID`, max_layer\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_fog`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, light_color\: :ref:`Color`, light_energy\: :ref:`float`, sun_scatter\: :ref:`float`, density\: :ref:`float`, height\: :ref:`float`, height_density\: :ref:`float`, aerial_perspective\: :ref:`float`, sky_affect\: :ref:`float`, fog_mode\: :ref:`EnvironmentFogMode` = 0\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_glow`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, levels\: :ref:`PackedFloat32Array`, intensity\: :ref:`float`, strength\: :ref:`float`, mix\: :ref:`float`, bloom_threshold\: :ref:`float`, blend_mode\: :ref:`EnvironmentGlowBlendMode`, hdr_bleed_threshold\: :ref:`float`, hdr_bleed_scale\: :ref:`float`, hdr_luminance_cap\: :ref:`float`, glow_map_strength\: :ref:`float`, glow_map\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_sdfgi`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, cascades\: :ref:`int`, min_cell_size\: :ref:`float`, y_scale\: :ref:`EnvironmentSDFGIYScale`, use_occlusion\: :ref:`bool`, bounce_feedback\: :ref:`float`, read_sky\: :ref:`bool`, energy\: :ref:`float`, normal_bias\: :ref:`float`, probe_bias\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_sdfgi_frames_to_converge`\ (\ frames\: :ref:`EnvironmentSDFGIFramesToConverge`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_sdfgi_frames_to_update_light`\ (\ frames\: :ref:`EnvironmentSDFGIFramesToUpdateLight`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_sdfgi_ray_count`\ (\ ray_count\: :ref:`EnvironmentSDFGIRayCount`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_sky`\ (\ env\: :ref:`RID`, sky\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_sky_custom_fov`\ (\ env\: :ref:`RID`, scale\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_sky_orientation`\ (\ env\: :ref:`RID`, orientation\: :ref:`Basis`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_ssao`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, radius\: :ref:`float`, intensity\: :ref:`float`, power\: :ref:`float`, detail\: :ref:`float`, horizon\: :ref:`float`, sharpness\: :ref:`float`, light_affect\: :ref:`float`, ao_channel_affect\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_ssao_quality`\ (\ quality\: :ref:`EnvironmentSSAOQuality`, half_size\: :ref:`bool`, adaptive_target\: :ref:`float`, blur_passes\: :ref:`int`, fadeout_from\: :ref:`float`, fadeout_to\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_ssil_quality`\ (\ quality\: :ref:`EnvironmentSSILQuality`, half_size\: :ref:`bool`, adaptive_target\: :ref:`float`, blur_passes\: :ref:`int`, fadeout_from\: :ref:`float`, fadeout_to\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_ssr`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, max_steps\: :ref:`int`, fade_in\: :ref:`float`, fade_out\: :ref:`float`, depth_tolerance\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_ssr_roughness_quality`\ (\ quality\: :ref:`EnvironmentSSRRoughnessQuality`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_tonemap`\ (\ env\: :ref:`RID`, tone_mapper\: :ref:`EnvironmentToneMapper`, exposure\: :ref:`float`, white\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_volumetric_fog`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, density\: :ref:`float`, albedo\: :ref:`Color`, emission\: :ref:`Color`, emission_energy\: :ref:`float`, anisotropy\: :ref:`float`, length\: :ref:`float`, p_detail_spread\: :ref:`float`, gi_inject\: :ref:`float`, temporal_reprojection\: :ref:`bool`, temporal_reprojection_amount\: :ref:`float`, ambient_inject\: :ref:`float`, sky_affect\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_volumetric_fog_filter_active`\ (\ active\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_volumetric_fog_volume_size`\ (\ size\: :ref:`int`, depth\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`fog_volume_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fog_volume_set_material`\ (\ fog_volume\: :ref:`RID`, material\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fog_volume_set_shape`\ (\ fog_volume\: :ref:`RID`, shape\: :ref:`FogVolumeShape`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fog_volume_set_size`\ (\ fog_volume\: :ref:`RID`, size\: :ref:`Vector3`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_draw`\ (\ swap_buffers\: :ref:`bool` = true, frame_step\: :ref:`float` = 0.0\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_sync`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`free_rid`\ (\ rid\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_default_clear_color`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_frame_setup_time_cpu`\ (\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RenderingDevice` | :ref:`get_rendering_device`\ (\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_rendering_info`\ (\ info\: :ref:`RenderingInfo`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_shader_parameter_list`\ (\ shader\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_test_cube`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_test_texture`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_video_adapter_api_version`\ (\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_video_adapter_name`\ (\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`DeviceType` | :ref:`get_video_adapter_type`\ (\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_video_adapter_vendor`\ (\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_white_texture`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`gi_set_use_half_resolution`\ (\ half_resolution\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_shader_parameter_add`\ (\ name\: :ref:`StringName`, type\: :ref:`GlobalShaderParameterType`, default_value\: :ref:`Variant`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`global_shader_parameter_get`\ (\ name\: :ref:`StringName`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`StringName`\] | :ref:`global_shader_parameter_get_list`\ (\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GlobalShaderParameterType` | :ref:`global_shader_parameter_get_type`\ (\ name\: :ref:`StringName`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_shader_parameter_remove`\ (\ name\: :ref:`StringName`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_shader_parameter_set`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_shader_parameter_set_override`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_changed`\ (\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_feature`\ (\ feature\: :ref:`Features`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_os_feature`\ (\ feature\: :ref:`String`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_attach_object_instance_id`\ (\ instance\: :ref:`RID`, id\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_attach_skeleton`\ (\ instance\: :ref:`RID`, skeleton\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`instance_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`instance_create2`\ (\ base\: :ref:`RID`, scenario\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`instance_geometry_get_shader_parameter`\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`instance_geometry_get_shader_parameter_default_value`\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`instance_geometry_get_shader_parameter_list`\ (\ instance\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_geometry_set_cast_shadows_setting`\ (\ instance\: :ref:`RID`, shadow_casting_setting\: :ref:`ShadowCastingSetting`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_geometry_set_flag`\ (\ instance\: :ref:`RID`, flag\: :ref:`InstanceFlags`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_geometry_set_lightmap`\ (\ instance\: :ref:`RID`, lightmap\: :ref:`RID`, lightmap_uv_scale\: :ref:`Rect2`, lightmap_slice\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_geometry_set_lod_bias`\ (\ instance\: :ref:`RID`, lod_bias\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_geometry_set_material_overlay`\ (\ instance\: :ref:`RID`, material\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_geometry_set_material_override`\ (\ instance\: :ref:`RID`, material\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_geometry_set_shader_parameter`\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_geometry_set_transparency`\ (\ instance\: :ref:`RID`, transparency\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_geometry_set_visibility_range`\ (\ instance\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`, min_margin\: :ref:`float`, max_margin\: :ref:`float`, fade_mode\: :ref:`VisibilityRangeFadeMode`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_set_base`\ (\ instance\: :ref:`RID`, base\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_set_blend_shape_weight`\ (\ instance\: :ref:`RID`, shape\: :ref:`int`, weight\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_set_custom_aabb`\ (\ instance\: :ref:`RID`, aabb\: :ref:`AABB`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_set_extra_visibility_margin`\ (\ instance\: :ref:`RID`, margin\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_set_ignore_culling`\ (\ instance\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_set_layer_mask`\ (\ instance\: :ref:`RID`, mask\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_set_pivot_data`\ (\ instance\: :ref:`RID`, sorting_offset\: :ref:`float`, use_aabb_center\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_set_scenario`\ (\ instance\: :ref:`RID`, scenario\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_set_surface_override_material`\ (\ instance\: :ref:`RID`, surface\: :ref:`int`, material\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_set_transform`\ (\ instance\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_set_visibility_parent`\ (\ instance\: :ref:`RID`, parent\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`instance_set_visible`\ (\ instance\: :ref:`RID`, visible\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`instances_cull_aabb`\ (\ aabb\: :ref:`AABB`, scenario\: :ref:`RID` = RID()\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`instances_cull_convex`\ (\ convex\: :ref:`Array`\[:ref:`Plane`\], scenario\: :ref:`RID` = RID()\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt64Array` | :ref:`instances_cull_ray`\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, scenario\: :ref:`RID` = RID()\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`light_directional_set_blend_splits`\ (\ light\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`light_directional_set_shadow_mode`\ (\ light\: :ref:`RID`, mode\: :ref:`LightDirectionalShadowMode`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`light_directional_set_sky_mode`\ (\ light\: :ref:`RID`, mode\: :ref:`LightDirectionalSkyMode`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`light_omni_set_shadow_mode`\ (\ light\: :ref:`RID`, mode\: :ref:`LightOmniShadowMode`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`light_projectors_set_filter`\ (\ filter\: :ref:`LightProjectorFilter`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`light_set_bake_mode`\ (\ light\: :ref:`RID`, bake_mode\: :ref:`LightBakeMode`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`light_set_color`\ (\ light\: :ref:`RID`, color\: :ref:`Color`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`light_set_cull_mask`\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`light_set_distance_fade`\ (\ decal\: :ref:`RID`, enabled\: :ref:`bool`, begin\: :ref:`float`, shadow\: :ref:`float`, length\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`light_set_max_sdfgi_cascade`\ (\ light\: :ref:`RID`, cascade\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`light_set_negative`\ (\ light\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`light_set_param`\ (\ light\: :ref:`RID`, param\: :ref:`LightParam`, value\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`light_set_projector`\ (\ light\: :ref:`RID`, texture\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`light_set_reverse_cull_face_mode`\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`light_set_shadow`\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`lightmap_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`lightmap_get_probe_capture_bsp_tree`\ (\ lightmap\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`lightmap_get_probe_capture_points`\ (\ lightmap\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedColorArray` | :ref:`lightmap_get_probe_capture_sh`\ (\ lightmap\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`lightmap_get_probe_capture_tetrahedra`\ (\ lightmap\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`lightmap_set_baked_exposure_normalization`\ (\ lightmap\: :ref:`RID`, baked_exposure\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`lightmap_set_probe_bounds`\ (\ lightmap\: :ref:`RID`, bounds\: :ref:`AABB`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`lightmap_set_probe_capture_data`\ (\ lightmap\: :ref:`RID`, points\: :ref:`PackedVector3Array`, point_sh\: :ref:`PackedColorArray`, tetrahedra\: :ref:`PackedInt32Array`, bsp_tree\: :ref:`PackedInt32Array`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`lightmap_set_probe_capture_update_speed`\ (\ speed\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`lightmap_set_probe_interior`\ (\ lightmap\: :ref:`RID`, interior\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`lightmap_set_textures`\ (\ lightmap\: :ref:`RID`, light\: :ref:`RID`, uses_sh\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`make_sphere_mesh`\ (\ latitudes\: :ref:`int`, longitudes\: :ref:`int`, radius\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`material_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`material_get_param`\ (\ material\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`material_set_next_pass`\ (\ material\: :ref:`RID`, next_material\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`material_set_param`\ (\ material\: :ref:`RID`, parameter\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`material_set_render_priority`\ (\ material\: :ref:`RID`, priority\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`material_set_shader`\ (\ shader_material\: :ref:`RID`, shader\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`mesh_add_surface`\ (\ mesh\: :ref:`RID`, surface\: :ref:`Dictionary`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`mesh_add_surface_from_arrays`\ (\ mesh\: :ref:`RID`, primitive\: :ref:`PrimitiveType`, arrays\: :ref:`Array`, blend_shapes\: :ref:`Array` = [], lods\: :ref:`Dictionary` = {}, compress_format\: |bitfield|\[:ref:`ArrayFormat`\] = 0\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`mesh_clear`\ (\ mesh\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`mesh_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`mesh_create_from_surfaces`\ (\ surfaces\: :ref:`Array`\[:ref:`Dictionary`\], blend_shape_count\: :ref:`int` = 0\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`mesh_get_blend_shape_count`\ (\ mesh\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`BlendShapeMode` | :ref:`mesh_get_blend_shape_mode`\ (\ mesh\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`mesh_get_custom_aabb`\ (\ mesh\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`mesh_get_surface`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`mesh_get_surface_count`\ (\ mesh\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`mesh_set_blend_shape_mode`\ (\ mesh\: :ref:`RID`, mode\: :ref:`BlendShapeMode`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`mesh_set_custom_aabb`\ (\ mesh\: :ref:`RID`, aabb\: :ref:`AABB`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`mesh_set_shadow_mesh`\ (\ mesh\: :ref:`RID`, shadow_mesh\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`mesh_surface_get_arrays`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Array`\] | :ref:`mesh_surface_get_blend_shape_arrays`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`mesh_surface_get_format_attribute_stride`\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`mesh_surface_get_format_normal_tangent_stride`\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`mesh_surface_get_format_offset`\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`, array_index\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`mesh_surface_get_format_skin_stride`\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`mesh_surface_get_format_vertex_stride`\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`mesh_surface_get_material`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`mesh_surface_set_material`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, material\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`mesh_surface_update_attribute_region`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`mesh_surface_update_skin_region`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`mesh_surface_update_vertex_region`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`multimesh_allocate_data`\ (\ multimesh\: :ref:`RID`, instances\: :ref:`int`, transform_format\: :ref:`MultimeshTransformFormat`, color_format\: :ref:`bool` = false, custom_data_format\: :ref:`bool` = false\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`multimesh_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`multimesh_get_aabb`\ (\ multimesh\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`multimesh_get_buffer`\ (\ multimesh\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`multimesh_get_custom_aabb`\ (\ multimesh\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`multimesh_get_instance_count`\ (\ multimesh\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`multimesh_get_mesh`\ (\ multimesh\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`multimesh_get_visible_instances`\ (\ multimesh\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`multimesh_instance_get_color`\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`multimesh_instance_get_custom_data`\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`multimesh_instance_get_transform`\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`multimesh_instance_get_transform_2d`\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`multimesh_instance_set_color`\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, color\: :ref:`Color`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`multimesh_instance_set_custom_data`\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, custom_data\: :ref:`Color`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`multimesh_instance_set_transform`\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, transform\: :ref:`Transform3D`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`multimesh_instance_set_transform_2d`\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, transform\: :ref:`Transform2D`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`multimesh_set_buffer`\ (\ multimesh\: :ref:`RID`, buffer\: :ref:`PackedFloat32Array`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`multimesh_set_custom_aabb`\ (\ multimesh\: :ref:`RID`, aabb\: :ref:`AABB`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`multimesh_set_mesh`\ (\ multimesh\: :ref:`RID`, mesh\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`multimesh_set_visible_instances`\ (\ multimesh\: :ref:`RID`, visible\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`occluder_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`occluder_set_mesh`\ (\ occluder\: :ref:`RID`, vertices\: :ref:`PackedVector3Array`, indices\: :ref:`PackedInt32Array`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`omni_light_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`particles_collision_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_collision_height_field_update`\ (\ particles_collision\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_collision_set_attractor_attenuation`\ (\ particles_collision\: :ref:`RID`, curve\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_collision_set_attractor_directionality`\ (\ particles_collision\: :ref:`RID`, amount\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_collision_set_attractor_strength`\ (\ particles_collision\: :ref:`RID`, strength\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_collision_set_box_extents`\ (\ particles_collision\: :ref:`RID`, extents\: :ref:`Vector3`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_collision_set_collision_type`\ (\ particles_collision\: :ref:`RID`, type\: :ref:`ParticlesCollisionType`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_collision_set_cull_mask`\ (\ particles_collision\: :ref:`RID`, mask\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_collision_set_field_texture`\ (\ particles_collision\: :ref:`RID`, texture\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_collision_set_height_field_resolution`\ (\ particles_collision\: :ref:`RID`, resolution\: :ref:`ParticlesCollisionHeightfieldResolution`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_collision_set_sphere_radius`\ (\ particles_collision\: :ref:`RID`, radius\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`particles_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_emit`\ (\ particles\: :ref:`RID`, transform\: :ref:`Transform3D`, velocity\: :ref:`Vector3`, color\: :ref:`Color`, custom\: :ref:`Color`, emit_flags\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`particles_get_current_aabb`\ (\ particles\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`particles_get_emitting`\ (\ particles\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`particles_is_inactive`\ (\ particles\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_request_process`\ (\ particles\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_restart`\ (\ particles\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_amount`\ (\ particles\: :ref:`RID`, amount\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_amount_ratio`\ (\ particles\: :ref:`RID`, ratio\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_collision_base_size`\ (\ particles\: :ref:`RID`, size\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_custom_aabb`\ (\ particles\: :ref:`RID`, aabb\: :ref:`AABB`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_draw_order`\ (\ particles\: :ref:`RID`, order\: :ref:`ParticlesDrawOrder`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_draw_pass_mesh`\ (\ particles\: :ref:`RID`, pass\: :ref:`int`, mesh\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_draw_passes`\ (\ particles\: :ref:`RID`, count\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_emission_transform`\ (\ particles\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_emitter_velocity`\ (\ particles\: :ref:`RID`, velocity\: :ref:`Vector3`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_emitting`\ (\ particles\: :ref:`RID`, emitting\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_explosiveness_ratio`\ (\ particles\: :ref:`RID`, ratio\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_fixed_fps`\ (\ particles\: :ref:`RID`, fps\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_fractional_delta`\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_interp_to_end`\ (\ particles\: :ref:`RID`, factor\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_interpolate`\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_lifetime`\ (\ particles\: :ref:`RID`, lifetime\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_mode`\ (\ particles\: :ref:`RID`, mode\: :ref:`ParticlesMode`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_one_shot`\ (\ particles\: :ref:`RID`, one_shot\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_pre_process_time`\ (\ particles\: :ref:`RID`, time\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_process_material`\ (\ particles\: :ref:`RID`, material\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_randomness_ratio`\ (\ particles\: :ref:`RID`, ratio\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_speed_scale`\ (\ particles\: :ref:`RID`, scale\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_subemitter`\ (\ particles\: :ref:`RID`, subemitter_particles\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_trail_bind_poses`\ (\ particles\: :ref:`RID`, bind_poses\: :ref:`Array`\[:ref:`Transform3D`\]\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_trails`\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`, length_sec\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_transform_align`\ (\ particles\: :ref:`RID`, align\: :ref:`ParticlesTransformAlign`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`particles_set_use_local_coordinates`\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`positional_soft_shadow_filter_set_quality`\ (\ quality\: :ref:`ShadowQuality`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`reflection_probe_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reflection_probe_set_ambient_color`\ (\ probe\: :ref:`RID`, color\: :ref:`Color`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reflection_probe_set_ambient_energy`\ (\ probe\: :ref:`RID`, energy\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reflection_probe_set_ambient_mode`\ (\ probe\: :ref:`RID`, mode\: :ref:`ReflectionProbeAmbientMode`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reflection_probe_set_as_interior`\ (\ probe\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reflection_probe_set_cull_mask`\ (\ probe\: :ref:`RID`, layers\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reflection_probe_set_enable_box_projection`\ (\ probe\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reflection_probe_set_enable_shadows`\ (\ probe\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reflection_probe_set_intensity`\ (\ probe\: :ref:`RID`, intensity\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reflection_probe_set_max_distance`\ (\ probe\: :ref:`RID`, distance\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reflection_probe_set_mesh_lod_threshold`\ (\ probe\: :ref:`RID`, pixels\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reflection_probe_set_origin_offset`\ (\ probe\: :ref:`RID`, offset\: :ref:`Vector3`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reflection_probe_set_reflection_mask`\ (\ probe\: :ref:`RID`, layers\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reflection_probe_set_resolution`\ (\ probe\: :ref:`RID`, resolution\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reflection_probe_set_size`\ (\ probe\: :ref:`RID`, size\: :ref:`Vector3`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reflection_probe_set_update_mode`\ (\ probe\: :ref:`RID`, mode\: :ref:`ReflectionProbeUpdateMode`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`request_frame_drawn_callback`\ (\ callable\: :ref:`Callable`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`scenario_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`scenario_set_camera_attributes`\ (\ scenario\: :ref:`RID`, effects\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`scenario_set_compositor`\ (\ scenario\: :ref:`RID`, compositor\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`scenario_set_environment`\ (\ scenario\: :ref:`RID`, environment\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`scenario_set_fallback_environment`\ (\ scenario\: :ref:`RID`, environment\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`screen_space_roughness_limiter_set_active`\ (\ enable\: :ref:`bool`, amount\: :ref:`float`, limit\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_boot_image`\ (\ image\: :ref:`Image`, color\: :ref:`Color`, scale\: :ref:`bool`, use_filter\: :ref:`bool` = true\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_debug_generate_wireframes`\ (\ generate\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_default_clear_color`\ (\ color\: :ref:`Color`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`shader_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`shader_get_code`\ (\ shader\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`shader_get_default_texture_parameter`\ (\ shader\: :ref:`RID`, name\: :ref:`StringName`, index\: :ref:`int` = 0\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`shader_get_parameter_default`\ (\ shader\: :ref:`RID`, name\: :ref:`StringName`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shader_set_code`\ (\ shader\: :ref:`RID`, code\: :ref:`String`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shader_set_default_texture_parameter`\ (\ shader\: :ref:`RID`, name\: :ref:`StringName`, texture\: :ref:`RID`, index\: :ref:`int` = 0\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shader_set_path_hint`\ (\ shader\: :ref:`RID`, path\: :ref:`String`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`skeleton_allocate_data`\ (\ skeleton\: :ref:`RID`, bones\: :ref:`int`, is_2d_skeleton\: :ref:`bool` = false\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`skeleton_bone_get_transform`\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`skeleton_bone_get_transform_2d`\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`skeleton_bone_set_transform`\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`, transform\: :ref:`Transform3D`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`skeleton_bone_set_transform_2d`\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`, transform\: :ref:`Transform2D`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`skeleton_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`skeleton_get_bone_count`\ (\ skeleton\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`skeleton_set_base_transform_2d`\ (\ skeleton\: :ref:`RID`, base_transform\: :ref:`Transform2D`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`sky_bake_panorama`\ (\ sky\: :ref:`RID`, energy\: :ref:`float`, bake_irradiance\: :ref:`bool`, size\: :ref:`Vector2i`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`sky_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sky_set_material`\ (\ sky\: :ref:`RID`, material\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sky_set_mode`\ (\ sky\: :ref:`RID`, mode\: :ref:`SkyMode`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sky_set_radiance_size`\ (\ sky\: :ref:`RID`, radiance_size\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`spot_light_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sub_surface_scattering_set_quality`\ (\ quality\: :ref:`SubSurfaceScatteringQuality`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`sub_surface_scattering_set_scale`\ (\ scale\: :ref:`float`, depth_scale\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`texture_2d_create`\ (\ image\: :ref:`Image`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`texture_2d_get`\ (\ texture\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`texture_2d_layer_get`\ (\ texture\: :ref:`RID`, layer\: :ref:`int`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`texture_2d_layered_create`\ (\ layers\: :ref:`Array`\[:ref:`Image`\], layered_type\: :ref:`TextureLayeredType`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`texture_2d_layered_placeholder_create`\ (\ layered_type\: :ref:`TextureLayeredType`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`texture_2d_placeholder_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`texture_2d_update`\ (\ texture\: :ref:`RID`, image\: :ref:`Image`, layer\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`texture_3d_create`\ (\ format\: :ref:`Format`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, mipmaps\: :ref:`bool`, data\: :ref:`Array`\[:ref:`Image`\]\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Image`\] | :ref:`texture_3d_get`\ (\ texture\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`texture_3d_placeholder_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`texture_3d_update`\ (\ texture\: :ref:`RID`, data\: :ref:`Array`\[:ref:`Image`\]\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Format` | :ref:`texture_get_format`\ (\ texture\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`texture_get_native_handle`\ (\ texture\: :ref:`RID`, srgb\: :ref:`bool` = false\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`texture_get_path`\ (\ texture\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`texture_get_rd_texture`\ (\ texture\: :ref:`RID`, srgb\: :ref:`bool` = false\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`texture_proxy_create`\ (\ base\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`texture_proxy_update`\ (\ texture\: :ref:`RID`, proxy_to\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`texture_rd_create`\ (\ rd_texture\: :ref:`RID`, layer_type\: :ref:`TextureLayeredType` = 0\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`texture_replace`\ (\ texture\: :ref:`RID`, by_texture\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`texture_set_force_redraw_if_visible`\ (\ texture\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`texture_set_path`\ (\ texture\: :ref:`RID`, path\: :ref:`String`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`texture_set_size_override`\ (\ texture\: :ref:`RID`, width\: :ref:`int`, height\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_attach_camera`\ (\ viewport\: :ref:`RID`, camera\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_attach_canvas`\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_attach_to_screen`\ (\ viewport\: :ref:`RID`, rect\: :ref:`Rect2` = Rect2(0, 0, 0, 0), screen\: :ref:`int` = 0\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`viewport_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`viewport_get_measured_render_time_cpu`\ (\ viewport\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`viewport_get_measured_render_time_gpu`\ (\ viewport\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`viewport_get_render_info`\ (\ viewport\: :ref:`RID`, type\: :ref:`ViewportRenderInfoType`, info\: :ref:`ViewportRenderInfo`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`viewport_get_render_target`\ (\ viewport\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`viewport_get_texture`\ (\ viewport\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_remove_canvas`\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_active`\ (\ viewport\: :ref:`RID`, active\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_canvas_cull_mask`\ (\ viewport\: :ref:`RID`, canvas_cull_mask\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_canvas_stacking`\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`, layer\: :ref:`int`, sublayer\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_canvas_transform`\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`, offset\: :ref:`Transform2D`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_clear_mode`\ (\ viewport\: :ref:`RID`, clear_mode\: :ref:`ViewportClearMode`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_debug_draw`\ (\ viewport\: :ref:`RID`, draw\: :ref:`ViewportDebugDraw`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_default_canvas_item_texture_filter`\ (\ viewport\: :ref:`RID`, filter\: :ref:`CanvasItemTextureFilter`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_default_canvas_item_texture_repeat`\ (\ viewport\: :ref:`RID`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_disable_2d`\ (\ viewport\: :ref:`RID`, disable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_disable_3d`\ (\ viewport\: :ref:`RID`, disable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_environment_mode`\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportEnvironmentMode`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_fsr_sharpness`\ (\ viewport\: :ref:`RID`, sharpness\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_global_canvas_transform`\ (\ viewport\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_measure_render_time`\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_msaa_2d`\ (\ viewport\: :ref:`RID`, msaa\: :ref:`ViewportMSAA`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_msaa_3d`\ (\ viewport\: :ref:`RID`, msaa\: :ref:`ViewportMSAA`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_occlusion_culling_build_quality`\ (\ quality\: :ref:`ViewportOcclusionCullingBuildQuality`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_occlusion_rays_per_thread`\ (\ rays_per_thread\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_parent_viewport`\ (\ viewport\: :ref:`RID`, parent_viewport\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_positional_shadow_atlas_quadrant_subdivision`\ (\ viewport\: :ref:`RID`, quadrant\: :ref:`int`, subdivision\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_positional_shadow_atlas_size`\ (\ viewport\: :ref:`RID`, size\: :ref:`int`, use_16_bits\: :ref:`bool` = false\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_render_direct_to_screen`\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_scaling_3d_mode`\ (\ viewport\: :ref:`RID`, scaling_3d_mode\: :ref:`ViewportScaling3DMode`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_scaling_3d_scale`\ (\ viewport\: :ref:`RID`, scale\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_scenario`\ (\ viewport\: :ref:`RID`, scenario\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_screen_space_aa`\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportScreenSpaceAA`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_sdf_oversize_and_scale`\ (\ viewport\: :ref:`RID`, oversize\: :ref:`ViewportSDFOversize`, scale\: :ref:`ViewportSDFScale`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_size`\ (\ viewport\: :ref:`RID`, width\: :ref:`int`, height\: :ref:`int`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_snap_2d_transforms_to_pixel`\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_snap_2d_vertices_to_pixel`\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_texture_mipmap_bias`\ (\ viewport\: :ref:`RID`, mipmap_bias\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_transparent_background`\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_update_mode`\ (\ viewport\: :ref:`RID`, update_mode\: :ref:`ViewportUpdateMode`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_use_debanding`\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_use_hdr_2d`\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_use_occlusion_culling`\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_use_taa`\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_use_xr`\ (\ viewport\: :ref:`RID`, use_xr\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_vrs_mode`\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportVRSMode`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`viewport_set_vrs_texture`\ (\ viewport\: :ref:`RID`, texture\: :ref:`RID`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`visibility_notifier_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`visibility_notifier_set_aabb`\ (\ notifier\: :ref:`RID`, aabb\: :ref:`AABB`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`visibility_notifier_set_callbacks`\ (\ notifier\: :ref:`RID`, enter_callable\: :ref:`Callable`, exit_callable\: :ref:`Callable`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`voxel_gi_allocate_data`\ (\ voxel_gi\: :ref:`RID`, to_cell_xform\: :ref:`Transform3D`, aabb\: :ref:`AABB`, octree_size\: :ref:`Vector3i`, octree_cells\: :ref:`PackedByteArray`, data_cells\: :ref:`PackedByteArray`, distance_field\: :ref:`PackedByteArray`, level_counts\: :ref:`PackedInt32Array`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`voxel_gi_create`\ (\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`voxel_gi_get_data_cells`\ (\ voxel_gi\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`voxel_gi_get_distance_field`\ (\ voxel_gi\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`voxel_gi_get_level_counts`\ (\ voxel_gi\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`voxel_gi_get_octree_cells`\ (\ voxel_gi\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`voxel_gi_get_octree_size`\ (\ voxel_gi\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`voxel_gi_get_to_cell_xform`\ (\ voxel_gi\: :ref:`RID`\ ) |const| | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`voxel_gi_set_baked_exposure_normalization`\ (\ voxel_gi\: :ref:`RID`, baked_exposure\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`voxel_gi_set_bias`\ (\ voxel_gi\: :ref:`RID`, bias\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`voxel_gi_set_dynamic_range`\ (\ voxel_gi\: :ref:`RID`, range\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`voxel_gi_set_energy`\ (\ voxel_gi\: :ref:`RID`, energy\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`voxel_gi_set_interior`\ (\ voxel_gi\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`voxel_gi_set_normal_bias`\ (\ voxel_gi\: :ref:`RID`, bias\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`voxel_gi_set_propagation`\ (\ voxel_gi\: :ref:`RID`, amount\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`voxel_gi_set_quality`\ (\ quality\: :ref:`VoxelGIQuality`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`voxel_gi_set_use_two_bounces`\ (\ voxel_gi\: :ref:`RID`, enable\: :ref:`bool`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -1021,7 +1037,7 @@ Signals .. rst-class:: classref-signal -**frame_post_draw** **(** **)** +**frame_post_draw**\ (\ ) Emitted at the end of the frame, after the RenderingServer has finished updating all the Viewports. @@ -1033,7 +1049,7 @@ Emitted at the end of the frame, after the RenderingServer has finished updating .. rst-class:: classref-signal -**frame_pre_draw** **(** **)** +**frame_pre_draw**\ (\ ) Emitted at the beginning of the frame, before the RenderingServer updates all the Viewports. @@ -3640,6 +3656,118 @@ Uses the fast filtering algorithm to process the radiance map. In general this r \ **Note:** The fast filtering algorithm is limited to 256×256 cubemaps, so :ref:`sky_set_radiance_size` must be set to ``256``. Otherwise, a warning is printed and the overridden radiance size is ignored. +.. rst-class:: classref-item-separator + +---- + +.. _enum_RenderingServer_CompositorEffectFlags: + +.. rst-class:: classref-enumeration + +enum **CompositorEffectFlags**: + +.. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_COLOR: + +.. rst-class:: classref-enumeration-constant + +:ref:`CompositorEffectFlags` **COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_COLOR** = ``1`` + +The rendering effect requires the color buffer to be resolved if MSAA is enabled. + +.. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_DEPTH: + +.. rst-class:: classref-enumeration-constant + +:ref:`CompositorEffectFlags` **COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_DEPTH** = ``2`` + +The rendering effect requires the depth buffer to be resolved if MSAA is enabled. + +.. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_NEEDS_MOTION_VECTORS: + +.. rst-class:: classref-enumeration-constant + +:ref:`CompositorEffectFlags` **COMPOSITOR_EFFECT_FLAG_NEEDS_MOTION_VECTORS** = ``4`` + +The rendering effect requires motion vectors to be produced. + +.. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_NEEDS_ROUGHNESS: + +.. rst-class:: classref-enumeration-constant + +:ref:`CompositorEffectFlags` **COMPOSITOR_EFFECT_FLAG_NEEDS_ROUGHNESS** = ``8`` + +The rendering effect requires normals and roughness g-buffer to be produced (Forward+ only). + +.. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_NEEDS_SEPARATE_SPECULAR: + +.. rst-class:: classref-enumeration-constant + +:ref:`CompositorEffectFlags` **COMPOSITOR_EFFECT_FLAG_NEEDS_SEPARATE_SPECULAR** = ``16`` + +The rendering effect requires specular data to be separated out (Forward+ only). + +.. rst-class:: classref-item-separator + +---- + +.. _enum_RenderingServer_CompositorEffectCallbackType: + +.. rst-class:: classref-enumeration + +enum **CompositorEffectCallbackType**: + +.. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_OPAQUE: + +.. rst-class:: classref-enumeration-constant + +:ref:`CompositorEffectCallbackType` **COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_OPAQUE** = ``0`` + +The callback is called before our opaque rendering pass, but after depth prepass (if applicable). + +.. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_OPAQUE: + +.. rst-class:: classref-enumeration-constant + +:ref:`CompositorEffectCallbackType` **COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_OPAQUE** = ``1`` + +The callback is called after our opaque rendering pass, but before our sky is rendered. + +.. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_SKY: + +.. rst-class:: classref-enumeration-constant + +:ref:`CompositorEffectCallbackType` **COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_SKY** = ``2`` + +The callback is called after our sky is rendered, but before our back buffers are created (and if enabled, before subsurface scattering and/or screen space reflections). + +.. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT: + +.. rst-class:: classref-enumeration-constant + +:ref:`CompositorEffectCallbackType` **COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT** = ``3`` + +The callback is called before our transparent rendering pass, but after our sky is rendered and we've created our back buffers. + +.. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_TRANSPARENT: + +.. rst-class:: classref-enumeration-constant + +:ref:`CompositorEffectCallbackType` **COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_TRANSPARENT** = ``4`` + +The callback is called after our transparent rendering pass, but before any build in post effects and output to our render target. + +.. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_ANY: + +.. rst-class:: classref-enumeration-constant + +:ref:`CompositorEffectCallbackType` **COMPOSITOR_EFFECT_CALLBACK_TYPE_ANY** = ``-1`` + +.. container:: contribute + + There is currently no description for this enum. Please help us by :ref:`contributing one `! + + + .. rst-class:: classref-item-separator ---- @@ -3836,6 +3964,32 @@ Mixes the glow with the underlying color to avoid increasing brightness as much ---- +.. _enum_RenderingServer_EnvironmentFogMode: + +.. rst-class:: classref-enumeration + +enum **EnvironmentFogMode**: + +.. _class_RenderingServer_constant_ENV_FOG_MODE_EXPONENTIAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`EnvironmentFogMode` **ENV_FOG_MODE_EXPONENTIAL** = ``0`` + +Use a physically-based fog model defined primarily by fog density. + +.. _class_RenderingServer_constant_ENV_FOG_MODE_DEPTH: + +.. rst-class:: classref-enumeration-constant + +:ref:`EnvironmentFogMode` **ENV_FOG_MODE_DEPTH** = ``1`` + +Use a simple fog model defined by start and end positions and a custom curve. While not physically accurate, this model can be useful when you need more artistic control. + +.. rst-class:: classref-item-separator + +---- + .. _enum_RenderingServer_EnvironmentToneMapper: .. rst-class:: classref-enumeration @@ -5366,10 +5520,6 @@ enum **Features**: **Deprecated:** This constant has not been used since Godot 3.0. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. _class_RenderingServer_constant_FEATURE_MULTITHREADED: @@ -5380,10 +5530,6 @@ enum **Features**: **Deprecated:** This constant has not been used since Godot 3.0. -.. container:: contribute - - There is currently no description for this enum. Please help us by :ref:`contributing one `! - .. rst-class:: classref-section-separator @@ -5441,9 +5587,9 @@ The maximum number of glow levels that can be used with the glow post-processing **MAX_CURSORS** = ``8`` -**Deprecated:** This constant may be changed or removed in future versions. +**Deprecated:** This constant is not used by the engine. + -This constant is unused internally. .. _class_RenderingServer_constant_MAX_2D_DIRECTIONAL_LIGHTS: @@ -5554,8 +5700,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_render_loop_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_render_loop_enabled** **(** **)** +- |void| **set_render_loop_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_render_loop_enabled**\ (\ ) If ``false``, disables rendering completely, but the engine logic is still being processed. You can call :ref:`force_draw` to draw a frame even with rendering disabled. @@ -5572,7 +5718,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Image[]` **bake_render_uv2** **(** :ref:`RID` base, :ref:`RID[]` material_overrides, :ref:`Vector2i` image_size **)** +:ref:`Array`\[:ref:`Image`\] **bake_render_uv2**\ (\ base\: :ref:`RID`, material_overrides\: :ref:`Array`\[:ref:`RID`\], image_size\: :ref:`Vector2i`\ ) Bakes the material data of the Mesh passed in the ``base`` parameter with optional ``material_overrides`` to a set of :ref:`Image`\ s of size ``image_size``. Returns an array of :ref:`Image`\ s containing material properties as specified in :ref:`BakeChannels`. @@ -5584,7 +5730,7 @@ Bakes the material data of the Mesh passed in the ``base`` parameter with option .. rst-class:: classref-method -void **call_on_render_thread** **(** :ref:`Callable` callable **)** +|void| **call_on_render_thread**\ (\ callable\: :ref:`Callable`\ ) As the RenderingServer actual logic may run on an separate thread, accessing its internals from the main (or any other) thread will result in errors. To make it easier to run code that can safely access the rendering internals (such as :ref:`RenderingDevice` and similar RD classes), push a callable via this function so it will be executed on the render thread. @@ -5596,7 +5742,7 @@ As the RenderingServer actual logic may run on an separate thread, accessing its .. rst-class:: classref-method -:ref:`RID` **camera_attributes_create** **(** **)** +:ref:`RID` **camera_attributes_create**\ (\ ) Creates a camera attributes object and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``camera_attributes_`` RenderingServer functions. @@ -5612,7 +5758,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -void **camera_attributes_set_auto_exposure** **(** :ref:`RID` camera_attributes, :ref:`bool` enable, :ref:`float` min_sensitivity, :ref:`float` max_sensitivity, :ref:`float` speed, :ref:`float` scale **)** +|void| **camera_attributes_set_auto_exposure**\ (\ camera_attributes\: :ref:`RID`, enable\: :ref:`bool`, min_sensitivity\: :ref:`float`, max_sensitivity\: :ref:`float`, speed\: :ref:`float`, scale\: :ref:`float`\ ) Sets the parameters to use with the auto-exposure effect. These parameters take on the same meaning as their counterparts in :ref:`CameraAttributes` and :ref:`CameraAttributesPractical`. @@ -5624,7 +5770,7 @@ Sets the parameters to use with the auto-exposure effect. These parameters take .. rst-class:: classref-method -void **camera_attributes_set_dof_blur** **(** :ref:`RID` camera_attributes, :ref:`bool` far_enable, :ref:`float` far_distance, :ref:`float` far_transition, :ref:`bool` near_enable, :ref:`float` near_distance, :ref:`float` near_transition, :ref:`float` amount **)** +|void| **camera_attributes_set_dof_blur**\ (\ camera_attributes\: :ref:`RID`, far_enable\: :ref:`bool`, far_distance\: :ref:`float`, far_transition\: :ref:`float`, near_enable\: :ref:`bool`, near_distance\: :ref:`float`, near_transition\: :ref:`float`, amount\: :ref:`float`\ ) Sets the parameters to use with the DOF blur effect. These parameters take on the same meaning as their counterparts in :ref:`CameraAttributesPractical`. @@ -5636,7 +5782,7 @@ Sets the parameters to use with the DOF blur effect. These parameters take on th .. rst-class:: classref-method -void **camera_attributes_set_dof_blur_bokeh_shape** **(** :ref:`DOFBokehShape` shape **)** +|void| **camera_attributes_set_dof_blur_bokeh_shape**\ (\ shape\: :ref:`DOFBokehShape`\ ) Sets the shape of the DOF bokeh pattern. Different shapes may be used to achieve artistic effect, or to meet performance targets. For more detail on available options see :ref:`DOFBokehShape`. @@ -5648,7 +5794,7 @@ Sets the shape of the DOF bokeh pattern. Different shapes may be used to achieve .. rst-class:: classref-method -void **camera_attributes_set_dof_blur_quality** **(** :ref:`DOFBlurQuality` quality, :ref:`bool` use_jitter **)** +|void| **camera_attributes_set_dof_blur_quality**\ (\ quality\: :ref:`DOFBlurQuality`, use_jitter\: :ref:`bool`\ ) Sets the quality level of the DOF blur effect to one of the options in :ref:`DOFBlurQuality`. ``use_jitter`` can be used to jitter samples taken during the blur pass to hide artifacts at the cost of looking more fuzzy. @@ -5660,7 +5806,7 @@ Sets the quality level of the DOF blur effect to one of the options in :ref:`DOF .. rst-class:: classref-method -void **camera_attributes_set_exposure** **(** :ref:`RID` camera_attributes, :ref:`float` multiplier, :ref:`float` normalization **)** +|void| **camera_attributes_set_exposure**\ (\ camera_attributes\: :ref:`RID`, multiplier\: :ref:`float`, normalization\: :ref:`float`\ ) Sets the exposure values that will be used by the renderers. The normalization amount is used to bake a given Exposure Value (EV) into rendering calculations to reduce the dynamic range of the scene. @@ -5686,7 +5832,7 @@ The exposure value can be calculated from aperture (in f-stops), shutter speed ( .. rst-class:: classref-method -:ref:`RID` **camera_create** **(** **)** +:ref:`RID` **camera_create**\ (\ ) Creates a 3D camera and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``camera_*`` RenderingServer functions. @@ -5702,7 +5848,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -void **camera_set_camera_attributes** **(** :ref:`RID` camera, :ref:`RID` effects **)** +|void| **camera_set_camera_attributes**\ (\ camera\: :ref:`RID`, effects\: :ref:`RID`\ ) Sets the camera_attributes created with :ref:`camera_attributes_create` to the given camera. @@ -5710,11 +5856,23 @@ Sets the camera_attributes created with :ref:`camera_attributes_create`, compositor\: :ref:`RID`\ ) + +Sets the compositor used by this camera. Equivalent to :ref:`Camera3D.compositor`. + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingServer_method_camera_set_cull_mask: .. rst-class:: classref-method -void **camera_set_cull_mask** **(** :ref:`RID` camera, :ref:`int` layers **)** +|void| **camera_set_cull_mask**\ (\ camera\: :ref:`RID`, layers\: :ref:`int`\ ) Sets the cull mask associated with this camera. The cull mask describes which 3D layers are rendered by this camera. Equivalent to :ref:`Camera3D.cull_mask`. @@ -5726,7 +5884,7 @@ Sets the cull mask associated with this camera. The cull mask describes which 3D .. rst-class:: classref-method -void **camera_set_environment** **(** :ref:`RID` camera, :ref:`RID` env **)** +|void| **camera_set_environment**\ (\ camera\: :ref:`RID`, env\: :ref:`RID`\ ) Sets the environment used by this camera. Equivalent to :ref:`Camera3D.environment`. @@ -5738,7 +5896,7 @@ Sets the environment used by this camera. Equivalent to :ref:`Camera3D.environme .. rst-class:: classref-method -void **camera_set_frustum** **(** :ref:`RID` camera, :ref:`float` size, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far **)** +|void| **camera_set_frustum**\ (\ camera\: :ref:`RID`, size\: :ref:`float`, offset\: :ref:`Vector2`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) Sets camera to use frustum projection. This mode allows adjusting the ``offset`` argument to create "tilted frustum" effects. @@ -5750,7 +5908,7 @@ Sets camera to use frustum projection. This mode allows adjusting the ``offset`` .. rst-class:: classref-method -void **camera_set_orthogonal** **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** +|void| **camera_set_orthogonal**\ (\ camera\: :ref:`RID`, size\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) Sets camera to use orthogonal projection, also known as orthographic projection. Objects remain the same size on the screen no matter how far away they are. @@ -5762,7 +5920,7 @@ Sets camera to use orthogonal projection, also known as orthographic projection. .. rst-class:: classref-method -void **camera_set_perspective** **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** +|void| **camera_set_perspective**\ (\ camera\: :ref:`RID`, fovy_degrees\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away. @@ -5774,7 +5932,7 @@ Sets camera to use perspective projection. Objects on the screen becomes smaller .. rst-class:: classref-method -void **camera_set_transform** **(** :ref:`RID` camera, :ref:`Transform3D` transform **)** +|void| **camera_set_transform**\ (\ camera\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) Sets :ref:`Transform3D` of camera. @@ -5786,7 +5944,7 @@ Sets :ref:`Transform3D` of camera. .. rst-class:: classref-method -void **camera_set_use_vertical_aspect** **(** :ref:`RID` camera, :ref:`bool` enable **)** +|void| **camera_set_use_vertical_aspect**\ (\ camera\: :ref:`RID`, enable\: :ref:`bool`\ ) If ``true``, preserves the horizontal aspect ratio which is equivalent to :ref:`Camera3D.KEEP_WIDTH`. If ``false``, preserves the vertical aspect ratio which is equivalent to :ref:`Camera3D.KEEP_HEIGHT`. @@ -5798,7 +5956,7 @@ If ``true``, preserves the horizontal aspect ratio which is equivalent to :ref:` .. rst-class:: classref-method -:ref:`RID` **canvas_create** **(** **)** +:ref:`RID` **canvas_create**\ (\ ) Creates a canvas and returns the assigned :ref:`RID`. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_*`` RenderingServer functions. @@ -5814,7 +5972,7 @@ Canvas has no :ref:`Resource` or :ref:`Node` equival .. rst-class:: classref-method -void **canvas_item_add_animation_slice** **(** :ref:`RID` item, :ref:`float` animation_length, :ref:`float` slice_begin, :ref:`float` slice_end, :ref:`float` offset=0.0 **)** +|void| **canvas_item_add_animation_slice**\ (\ item\: :ref:`RID`, animation_length\: :ref:`float`, slice_begin\: :ref:`float`, slice_end\: :ref:`float`, offset\: :ref:`float` = 0.0\ ) Subsequent drawing commands will be ignored unless they fall within the specified animation slice. This is a faster way to implement animations that loop on background rather than redrawing constantly. @@ -5826,7 +5984,7 @@ Subsequent drawing commands will be ignored unless they fall within the specifie .. rst-class:: classref-method -void **canvas_item_add_circle** **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** +|void| **canvas_item_add_circle**\ (\ item\: :ref:`RID`, pos\: :ref:`Vector2`, radius\: :ref:`float`, color\: :ref:`Color`\ ) Draws a circle on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_circle`. @@ -5838,7 +5996,7 @@ Draws a circle on the :ref:`CanvasItem` pointed to by the ``it .. rst-class:: classref-method -void **canvas_item_add_clip_ignore** **(** :ref:`RID` item, :ref:`bool` ignore **)** +|void| **canvas_item_add_clip_ignore**\ (\ item\: :ref:`RID`, ignore\: :ref:`bool`\ ) If ``ignore`` is ``true``, ignore clipping on items drawn with this canvas item until this is called again with ``ignore`` set to false. @@ -5850,7 +6008,7 @@ If ``ignore`` is ``true``, ignore clipping on items drawn with this canvas item .. rst-class:: classref-method -void **canvas_item_add_lcd_texture_rect_region** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate **)** +|void| **canvas_item_add_lcd_texture_rect_region**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color`\ ) See also :ref:`CanvasItem.draw_lcd_texture_rect_region`. @@ -5862,7 +6020,7 @@ See also :ref:`CanvasItem.draw_lcd_texture_rect_region` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=-1.0, :ref:`bool` antialiased=false **)** +|void| **canvas_item_add_line**\ (\ item\: :ref:`RID`, from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) Draws a line on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_line`. @@ -5874,7 +6032,7 @@ Draws a line on the :ref:`CanvasItem` pointed to by the ``item .. rst-class:: classref-method -void **canvas_item_add_mesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`Transform2D` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`RID` texture=RID() **)** +|void| **canvas_item_add_mesh**\ (\ item\: :ref:`RID`, mesh\: :ref:`RID`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color` = Color(1, 1, 1, 1), texture\: :ref:`RID` = RID()\ ) Draws a mesh created with :ref:`mesh_create` with given ``transform``, ``modulate`` color, and ``texture``. This is used internally by :ref:`MeshInstance2D`. @@ -5886,7 +6044,7 @@ Draws a mesh created with :ref:`mesh_create` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`float` px_range=1.0, :ref:`float` scale=1.0 **)** +|void| **canvas_item_add_msdf_texture_rect_region**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), outline_size\: :ref:`int` = 0, px_range\: :ref:`float` = 1.0, scale\: :ref:`float` = 1.0\ ) See also :ref:`CanvasItem.draw_msdf_texture_rect_region`. @@ -5898,7 +6056,7 @@ See also :ref:`CanvasItem.draw_msdf_texture_rect_region` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=-1.0 **)** +|void| **canvas_item_add_multiline**\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0\ ) Draws a 2D multiline on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_multiline` and :ref:`CanvasItem.draw_multiline_colors`. @@ -5910,7 +6068,7 @@ Draws a 2D multiline on the :ref:`CanvasItem` pointed to by th .. rst-class:: classref-method -void **canvas_item_add_multimesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture=RID() **)** +|void| **canvas_item_add_multimesh**\ (\ item\: :ref:`RID`, mesh\: :ref:`RID`, texture\: :ref:`RID` = RID()\ ) Draws a 2D :ref:`MultiMesh` on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_multimesh`. @@ -5922,7 +6080,7 @@ Draws a 2D :ref:`MultiMesh` on the :ref:`CanvasItem` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** +|void| **canvas_item_add_nine_patch**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, source\: :ref:`Rect2`, texture\: :ref:`RID`, topleft\: :ref:`Vector2`, bottomright\: :ref:`Vector2`, x_axis_mode\: :ref:`NinePatchAxisMode` = 0, y_axis_mode\: :ref:`NinePatchAxisMode` = 0, draw_center\: :ref:`bool` = true, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) Draws a nine-patch rectangle on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. @@ -5934,7 +6092,7 @@ Draws a nine-patch rectangle on the :ref:`CanvasItem` pointed .. rst-class:: classref-method -void **canvas_item_add_particles** **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture **)** +|void| **canvas_item_add_particles**\ (\ item\: :ref:`RID`, particles\: :ref:`RID`, texture\: :ref:`RID`\ ) Draws particles on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. @@ -5946,7 +6104,7 @@ Draws particles on the :ref:`CanvasItem` pointed to by the ``i .. rst-class:: classref-method -void **canvas_item_add_polygon** **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`RID` texture=RID() **)** +|void| **canvas_item_add_polygon**\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`RID` = RID()\ ) Draws a 2D polygon on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. If you need more flexibility (such as being able to use bones), use :ref:`canvas_item_add_triangle_array` instead. See also :ref:`CanvasItem.draw_polygon`. @@ -5958,7 +6116,7 @@ Draws a 2D polygon on the :ref:`CanvasItem` pointed to by the .. rst-class:: classref-method -void **canvas_item_add_polyline** **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=-1.0, :ref:`bool` antialiased=false **)** +|void| **canvas_item_add_polyline**\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) Draws a 2D polyline on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_polyline` and :ref:`CanvasItem.draw_polyline_colors`. @@ -5970,7 +6128,7 @@ Draws a 2D polyline on the :ref:`CanvasItem` pointed to by the .. rst-class:: classref-method -void **canvas_item_add_primitive** **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs, :ref:`RID` texture **)** +|void| **canvas_item_add_primitive**\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array`, texture\: :ref:`RID`\ ) Draws a 2D primitive on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_primitive`. @@ -5982,7 +6140,7 @@ Draws a 2D primitive on the :ref:`CanvasItem` pointed to by th .. rst-class:: classref-method -void **canvas_item_add_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** +|void| **canvas_item_add_rect**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, color\: :ref:`Color`\ ) Draws a rectangle on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_rect`. @@ -5994,7 +6152,7 @@ Draws a rectangle on the :ref:`CanvasItem` pointed to by the ` .. rst-class:: classref-method -void **canvas_item_add_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** +|void| **canvas_item_add_set_transform**\ (\ item\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) Sets a :ref:`Transform2D` that will be used to transform subsequent canvas item commands. @@ -6006,7 +6164,7 @@ Sets a :ref:`Transform2D` that will be used to transform subs .. rst-class:: classref-method -void **canvas_item_add_texture_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false **)** +|void| **canvas_item_add_texture_rect**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, tile\: :ref:`bool` = false, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) Draws a 2D textured rectangle on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_texture_rect` and :ref:`Texture2D.draw_rect`. @@ -6018,7 +6176,7 @@ Draws a 2D textured rectangle on the :ref:`CanvasItem` pointed .. rst-class:: classref-method -void **canvas_item_add_texture_rect_region** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false, :ref:`bool` clip_uv=true **)** +|void| **canvas_item_add_texture_rect_region**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false, clip_uv\: :ref:`bool` = true\ ) Draws the specified region of a 2D textured rectangle on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_texture_rect_region` and :ref:`Texture2D.draw_rect_region`. @@ -6030,7 +6188,7 @@ Draws the specified region of a 2D textured rectangle on the :ref:`CanvasItem` item, :ref:`PackedInt32Array` indices, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`PackedInt32Array` bones=PackedInt32Array(), :ref:`PackedFloat32Array` weights=PackedFloat32Array(), :ref:`RID` texture=RID(), :ref:`int` count=-1 **)** +|void| **canvas_item_add_triangle_array**\ (\ item\: :ref:`RID`, indices\: :ref:`PackedInt32Array`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), bones\: :ref:`PackedInt32Array` = PackedInt32Array(), weights\: :ref:`PackedFloat32Array` = PackedFloat32Array(), texture\: :ref:`RID` = RID(), count\: :ref:`int` = -1\ ) Draws a triangle array on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. This is internally used by :ref:`Line2D` and :ref:`StyleBoxFlat` for rendering. :ref:`canvas_item_add_triangle_array` is highly flexible, but more complex to use than :ref:`canvas_item_add_polygon`. @@ -6044,7 +6202,7 @@ Draws a triangle array on the :ref:`CanvasItem` pointed to by .. rst-class:: classref-method -void **canvas_item_clear** **(** :ref:`RID` item **)** +|void| **canvas_item_clear**\ (\ item\: :ref:`RID`\ ) Clears the :ref:`CanvasItem` and removes all commands in it. @@ -6056,7 +6214,7 @@ Clears the :ref:`CanvasItem` and removes all commands in it. .. rst-class:: classref-method -:ref:`RID` **canvas_item_create** **(** **)** +:ref:`RID` **canvas_item_create**\ (\ ) Creates a new CanvasItem instance and returns its :ref:`RID`. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_item_*`` RenderingServer functions. @@ -6072,7 +6230,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -void **canvas_item_set_canvas_group_mode** **(** :ref:`RID` item, :ref:`CanvasGroupMode` mode, :ref:`float` clear_margin=5.0, :ref:`bool` fit_empty=false, :ref:`float` fit_margin=0.0, :ref:`bool` blur_mipmaps=false **)** +|void| **canvas_item_set_canvas_group_mode**\ (\ item\: :ref:`RID`, mode\: :ref:`CanvasGroupMode`, clear_margin\: :ref:`float` = 5.0, fit_empty\: :ref:`bool` = false, fit_margin\: :ref:`float` = 0.0, blur_mipmaps\: :ref:`bool` = false\ ) Sets the canvas group mode used during 2D rendering for the canvas item specified by the ``item`` RID. For faster but more limited clipping, use :ref:`canvas_item_set_clip` instead. @@ -6086,7 +6244,7 @@ Sets the canvas group mode used during 2D rendering for the canvas item specifie .. rst-class:: classref-method -void **canvas_item_set_clip** **(** :ref:`RID` item, :ref:`bool` clip **)** +|void| **canvas_item_set_clip**\ (\ item\: :ref:`RID`, clip\: :ref:`bool`\ ) If ``clip`` is ``true``, makes the canvas item specified by the ``item`` RID not draw anything outside of its rect's coordinates. This clipping is fast, but works only with axis-aligned rectangles. This means that rotation is ignored by the clipping rectangle. For more advanced clipping shapes, use :ref:`canvas_item_set_canvas_group_mode` instead. @@ -6100,7 +6258,7 @@ If ``clip`` is ``true``, makes the canvas item specified by the ``item`` RID not .. rst-class:: classref-method -void **canvas_item_set_copy_to_backbuffer** **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** +|void| **canvas_item_set_copy_to_backbuffer**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`, rect\: :ref:`Rect2`\ ) Sets the :ref:`CanvasItem` to copy a rect to the backbuffer. @@ -6112,7 +6270,7 @@ Sets the :ref:`CanvasItem` to copy a rect to the backbuffer. .. rst-class:: classref-method -void **canvas_item_set_custom_rect** **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2(0, 0, 0, 0) **)** +|void| **canvas_item_set_custom_rect**\ (\ item\: :ref:`RID`, use_custom_rect\: :ref:`bool`, rect\: :ref:`Rect2` = Rect2(0, 0, 0, 0)\ ) If ``use_custom_rect`` is ``true``, sets the custom visibility rectangle (used for culling) to ``rect`` for the canvas item specified by ``item``. Setting a custom visibility rect can reduce CPU load when drawing lots of 2D instances. If ``use_custom_rect`` is ``false``, automatically computes a visibility rectangle based on the canvas item's draw commands. @@ -6124,7 +6282,7 @@ If ``use_custom_rect`` is ``true``, sets the custom visibility rectangle (used f .. rst-class:: classref-method -void **canvas_item_set_default_texture_filter** **(** :ref:`RID` item, :ref:`CanvasItemTextureFilter` filter **)** +|void| **canvas_item_set_default_texture_filter**\ (\ item\: :ref:`RID`, filter\: :ref:`CanvasItemTextureFilter`\ ) Sets the default texture filter mode for the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.texture_filter`. @@ -6136,7 +6294,7 @@ Sets the default texture filter mode for the canvas item specified by the ``item .. rst-class:: classref-method -void **canvas_item_set_default_texture_repeat** **(** :ref:`RID` item, :ref:`CanvasItemTextureRepeat` repeat **)** +|void| **canvas_item_set_default_texture_repeat**\ (\ item\: :ref:`RID`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) Sets the default texture repeat mode for the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.texture_repeat`. @@ -6148,7 +6306,7 @@ Sets the default texture repeat mode for the canvas item specified by the ``item .. rst-class:: classref-method -void **canvas_item_set_distance_field_mode** **(** :ref:`RID` item, :ref:`bool` enabled **)** +|void| **canvas_item_set_distance_field_mode**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``enabled`` is ``true``, enables multichannel signed distance field rendering mode for the canvas item specified by the ``item`` RID. This is meant to be used for font rendering, or with specially generated images using `msdfgen `__. @@ -6160,7 +6318,7 @@ If ``enabled`` is ``true``, enables multichannel signed distance field rendering .. rst-class:: classref-method -void **canvas_item_set_draw_behind_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** +|void| **canvas_item_set_draw_behind_parent**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``enabled`` is ``true``, draws the canvas item specified by the ``item`` RID behind its parent. Equivalent to :ref:`CanvasItem.show_behind_parent`. @@ -6172,7 +6330,7 @@ If ``enabled`` is ``true``, draws the canvas item specified by the ``item`` RID .. rst-class:: classref-method -void **canvas_item_set_draw_index** **(** :ref:`RID` item, :ref:`int` index **)** +|void| **canvas_item_set_draw_index**\ (\ item\: :ref:`RID`, index\: :ref:`int`\ ) Sets the index for the :ref:`CanvasItem`. @@ -6184,7 +6342,7 @@ Sets the index for the :ref:`CanvasItem`. .. rst-class:: classref-method -void **canvas_item_set_light_mask** **(** :ref:`RID` item, :ref:`int` mask **)** +|void| **canvas_item_set_light_mask**\ (\ item\: :ref:`RID`, mask\: :ref:`int`\ ) Sets the light ``mask`` for the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.light_mask`. @@ -6196,7 +6354,7 @@ Sets the light ``mask`` for the canvas item specified by the ``item`` RID. Equiv .. rst-class:: classref-method -void **canvas_item_set_material** **(** :ref:`RID` item, :ref:`RID` material **)** +|void| **canvas_item_set_material**\ (\ item\: :ref:`RID`, material\: :ref:`RID`\ ) Sets a new ``material`` to the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.material`. @@ -6208,7 +6366,7 @@ Sets a new ``material`` to the canvas item specified by the ``item`` RID. Equiva .. rst-class:: classref-method -void **canvas_item_set_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** +|void| **canvas_item_set_modulate**\ (\ item\: :ref:`RID`, color\: :ref:`Color`\ ) Multiplies the color of the canvas item specified by the ``item`` RID, while affecting its children. See also :ref:`canvas_item_set_self_modulate`. Equivalent to :ref:`CanvasItem.modulate`. @@ -6220,7 +6378,7 @@ Multiplies the color of the canvas item specified by the ``item`` RID, while aff .. rst-class:: classref-method -void **canvas_item_set_parent** **(** :ref:`RID` item, :ref:`RID` parent **)** +|void| **canvas_item_set_parent**\ (\ item\: :ref:`RID`, parent\: :ref:`RID`\ ) Sets a parent :ref:`CanvasItem` to the :ref:`CanvasItem`. The item will inherit transform, modulation and visibility from its parent, like :ref:`CanvasItem` nodes in the scene tree. @@ -6232,7 +6390,7 @@ Sets a parent :ref:`CanvasItem` to the :ref:`CanvasItem` item, :ref:`Color` color **)** +|void| **canvas_item_set_self_modulate**\ (\ item\: :ref:`RID`, color\: :ref:`Color`\ ) Multiplies the color of the canvas item specified by the ``item`` RID, without affecting its children. See also :ref:`canvas_item_set_modulate`. Equivalent to :ref:`CanvasItem.self_modulate`. @@ -6244,7 +6402,7 @@ Multiplies the color of the canvas item specified by the ``item`` RID, without a .. rst-class:: classref-method -void **canvas_item_set_sort_children_by_y** **(** :ref:`RID` item, :ref:`bool` enabled **)** +|void| **canvas_item_set_sort_children_by_y**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``enabled`` is ``true``, child nodes with the lowest Y position are drawn before those with a higher Y position. Y-sorting only affects children that inherit from the canvas item specified by the ``item`` RID, not the canvas item itself. Equivalent to :ref:`CanvasItem.y_sort_enabled`. @@ -6256,7 +6414,7 @@ If ``enabled`` is ``true``, child nodes with the lowest Y position are drawn bef .. rst-class:: classref-method -void **canvas_item_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** +|void| **canvas_item_set_transform**\ (\ item\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) Sets the ``transform`` of the canvas item specified by the ``item`` RID. This affects where and how the item will be drawn. Child canvas items' transforms are multiplied by their parent's transform. Equivalent to :ref:`Node2D.transform`. @@ -6268,7 +6426,7 @@ Sets the ``transform`` of the canvas item specified by the ``item`` RID. This af .. rst-class:: classref-method -void **canvas_item_set_use_parent_material** **(** :ref:`RID` item, :ref:`bool` enabled **)** +|void| **canvas_item_set_use_parent_material**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) Sets if the :ref:`CanvasItem` uses its parent's material. @@ -6280,7 +6438,7 @@ Sets if the :ref:`CanvasItem` uses its parent's material. .. rst-class:: classref-method -void **canvas_item_set_visibility_layer** **(** :ref:`RID` item, :ref:`int` visibility_layer **)** +|void| **canvas_item_set_visibility_layer**\ (\ item\: :ref:`RID`, visibility_layer\: :ref:`int`\ ) Sets the rendering visibility layer associated with this :ref:`CanvasItem`. Only :ref:`Viewport` nodes with a matching rendering mask will render this :ref:`CanvasItem`. @@ -6292,7 +6450,7 @@ Sets the rendering visibility layer associated with this :ref:`CanvasItem` item, :ref:`bool` enable, :ref:`Rect2` area, :ref:`Callable` enter_callable, :ref:`Callable` exit_callable **)** +|void| **canvas_item_set_visibility_notifier**\ (\ item\: :ref:`RID`, enable\: :ref:`bool`, area\: :ref:`Rect2`, enter_callable\: :ref:`Callable`, exit_callable\: :ref:`Callable`\ ) Sets the given :ref:`CanvasItem` as visibility notifier. ``area`` defines the area of detecting visibility. ``enter_callable`` is called when the :ref:`CanvasItem` enters the screen, ``exit_callable`` is called when the :ref:`CanvasItem` exits the screen. If ``enable`` is ``false``, the item will no longer function as notifier. @@ -6306,7 +6464,7 @@ This method can be used to manually mimic :ref:`VisibleOnScreenNotifier2D` item, :ref:`bool` visible **)** +|void| **canvas_item_set_visible**\ (\ item\: :ref:`RID`, visible\: :ref:`bool`\ ) Sets the visibility of the :ref:`CanvasItem`. @@ -6318,7 +6476,7 @@ Sets the visibility of the :ref:`CanvasItem`. .. rst-class:: classref-method -void **canvas_item_set_z_as_relative_to_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** +|void| **canvas_item_set_z_as_relative_to_parent**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) If this is enabled, the Z index of the parent will be added to the children's Z index. @@ -6330,7 +6488,7 @@ If this is enabled, the Z index of the parent will be added to the children's Z .. rst-class:: classref-method -void **canvas_item_set_z_index** **(** :ref:`RID` item, :ref:`int` z_index **)** +|void| **canvas_item_set_z_index**\ (\ item\: :ref:`RID`, z_index\: :ref:`int`\ ) Sets the :ref:`CanvasItem`'s Z index, i.e. its draw order (lower indexes are drawn first). @@ -6342,7 +6500,7 @@ Sets the :ref:`CanvasItem`'s Z index, i.e. its draw order (low .. rst-class:: classref-method -void **canvas_light_attach_to_canvas** **(** :ref:`RID` light, :ref:`RID` canvas **)** +|void| **canvas_light_attach_to_canvas**\ (\ light\: :ref:`RID`, canvas\: :ref:`RID`\ ) Attaches the canvas light to the canvas. Removes it from its previous canvas. @@ -6354,7 +6512,7 @@ Attaches the canvas light to the canvas. Removes it from its previous canvas. .. rst-class:: classref-method -:ref:`RID` **canvas_light_create** **(** **)** +:ref:`RID` **canvas_light_create**\ (\ ) Creates a canvas light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_light_*`` RenderingServer functions. @@ -6370,7 +6528,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -void **canvas_light_occluder_attach_to_canvas** **(** :ref:`RID` occluder, :ref:`RID` canvas **)** +|void| **canvas_light_occluder_attach_to_canvas**\ (\ occluder\: :ref:`RID`, canvas\: :ref:`RID`\ ) Attaches a light occluder to the canvas. Removes it from its previous canvas. @@ -6382,7 +6540,7 @@ Attaches a light occluder to the canvas. Removes it from its previous canvas. .. rst-class:: classref-method -:ref:`RID` **canvas_light_occluder_create** **(** **)** +:ref:`RID` **canvas_light_occluder_create**\ (\ ) Creates a light occluder and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_light_occluder_*`` RenderingServer functions. @@ -6398,7 +6556,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -void **canvas_light_occluder_set_as_sdf_collision** **(** :ref:`RID` occluder, :ref:`bool` enable **)** +|void| **canvas_light_occluder_set_as_sdf_collision**\ (\ occluder\: :ref:`RID`, enable\: :ref:`bool`\ ) .. container:: contribute @@ -6412,7 +6570,7 @@ void **canvas_light_occluder_set_as_sdf_collision** **(** :ref:`RID` .. rst-class:: classref-method -void **canvas_light_occluder_set_enabled** **(** :ref:`RID` occluder, :ref:`bool` enabled **)** +|void| **canvas_light_occluder_set_enabled**\ (\ occluder\: :ref:`RID`, enabled\: :ref:`bool`\ ) Enables or disables light occluder. @@ -6424,7 +6582,7 @@ Enables or disables light occluder. .. rst-class:: classref-method -void **canvas_light_occluder_set_light_mask** **(** :ref:`RID` occluder, :ref:`int` mask **)** +|void| **canvas_light_occluder_set_light_mask**\ (\ occluder\: :ref:`RID`, mask\: :ref:`int`\ ) The light mask. See :ref:`LightOccluder2D` for more information on light masks. @@ -6436,7 +6594,7 @@ The light mask. See :ref:`LightOccluder2D` for more infor .. rst-class:: classref-method -void **canvas_light_occluder_set_polygon** **(** :ref:`RID` occluder, :ref:`RID` polygon **)** +|void| **canvas_light_occluder_set_polygon**\ (\ occluder\: :ref:`RID`, polygon\: :ref:`RID`\ ) Sets a light occluder's polygon. @@ -6448,7 +6606,7 @@ Sets a light occluder's polygon. .. rst-class:: classref-method -void **canvas_light_occluder_set_transform** **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** +|void| **canvas_light_occluder_set_transform**\ (\ occluder\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) Sets a light occluder's :ref:`Transform2D`. @@ -6460,7 +6618,7 @@ Sets a light occluder's :ref:`Transform2D`. .. rst-class:: classref-method -void **canvas_light_set_blend_mode** **(** :ref:`RID` light, :ref:`CanvasLightBlendMode` mode **)** +|void| **canvas_light_set_blend_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`CanvasLightBlendMode`\ ) Sets the blend mode for the given canvas light. See :ref:`CanvasLightBlendMode` for options. Equivalent to :ref:`Light2D.blend_mode`. @@ -6472,7 +6630,7 @@ Sets the blend mode for the given canvas light. See :ref:`CanvasLightBlendMode` light, :ref:`Color` color **)** +|void| **canvas_light_set_color**\ (\ light\: :ref:`RID`, color\: :ref:`Color`\ ) Sets the color for a light. @@ -6484,7 +6642,7 @@ Sets the color for a light. .. rst-class:: classref-method -void **canvas_light_set_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** +|void| **canvas_light_set_enabled**\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) Enables or disables a canvas light. @@ -6496,7 +6654,7 @@ Enables or disables a canvas light. .. rst-class:: classref-method -void **canvas_light_set_energy** **(** :ref:`RID` light, :ref:`float` energy **)** +|void| **canvas_light_set_energy**\ (\ light\: :ref:`RID`, energy\: :ref:`float`\ ) Sets a canvas light's energy. @@ -6508,7 +6666,7 @@ Sets a canvas light's energy. .. rst-class:: classref-method -void **canvas_light_set_height** **(** :ref:`RID` light, :ref:`float` height **)** +|void| **canvas_light_set_height**\ (\ light\: :ref:`RID`, height\: :ref:`float`\ ) Sets a canvas light's height. @@ -6520,7 +6678,7 @@ Sets a canvas light's height. .. rst-class:: classref-method -void **canvas_light_set_item_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** +|void| **canvas_light_set_item_cull_mask**\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) The light mask. See :ref:`LightOccluder2D` for more information on light masks. @@ -6532,7 +6690,7 @@ The light mask. See :ref:`LightOccluder2D` for more infor .. rst-class:: classref-method -void **canvas_light_set_item_shadow_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** +|void| **canvas_light_set_item_shadow_cull_mask**\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) The binary mask used to determine which layers this canvas light's shadows affects. See :ref:`LightOccluder2D` for more information on light masks. @@ -6544,7 +6702,7 @@ The binary mask used to determine which layers this canvas light's shadows affec .. rst-class:: classref-method -void **canvas_light_set_layer_range** **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** +|void| **canvas_light_set_layer_range**\ (\ light\: :ref:`RID`, min_layer\: :ref:`int`, max_layer\: :ref:`int`\ ) The layer range that gets rendered with this light. @@ -6556,7 +6714,7 @@ The layer range that gets rendered with this light. .. rst-class:: classref-method -void **canvas_light_set_mode** **(** :ref:`RID` light, :ref:`CanvasLightMode` mode **)** +|void| **canvas_light_set_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`CanvasLightMode`\ ) The mode of the light, see :ref:`CanvasLightMode` constants. @@ -6568,7 +6726,7 @@ The mode of the light, see :ref:`CanvasLightMode` light, :ref:`Color` color **)** +|void| **canvas_light_set_shadow_color**\ (\ light\: :ref:`RID`, color\: :ref:`Color`\ ) Sets the color of the canvas light's shadow. @@ -6580,7 +6738,7 @@ Sets the color of the canvas light's shadow. .. rst-class:: classref-method -void **canvas_light_set_shadow_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** +|void| **canvas_light_set_shadow_enabled**\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) Enables or disables the canvas light's shadow. @@ -6592,7 +6750,7 @@ Enables or disables the canvas light's shadow. .. rst-class:: classref-method -void **canvas_light_set_shadow_filter** **(** :ref:`RID` light, :ref:`CanvasLightShadowFilter` filter **)** +|void| **canvas_light_set_shadow_filter**\ (\ light\: :ref:`RID`, filter\: :ref:`CanvasLightShadowFilter`\ ) Sets the canvas light's shadow's filter, see :ref:`CanvasLightShadowFilter` constants. @@ -6604,7 +6762,7 @@ Sets the canvas light's shadow's filter, see :ref:`CanvasLightShadowFilter` light, :ref:`float` smooth **)** +|void| **canvas_light_set_shadow_smooth**\ (\ light\: :ref:`RID`, smooth\: :ref:`float`\ ) Smoothens the shadow. The lower, the smoother. @@ -6616,7 +6774,7 @@ Smoothens the shadow. The lower, the smoother. .. rst-class:: classref-method -void **canvas_light_set_texture** **(** :ref:`RID` light, :ref:`RID` texture **)** +|void| **canvas_light_set_texture**\ (\ light\: :ref:`RID`, texture\: :ref:`RID`\ ) Sets the texture to be used by a :ref:`PointLight2D`. Equivalent to :ref:`PointLight2D.texture`. @@ -6628,7 +6786,7 @@ Sets the texture to be used by a :ref:`PointLight2D`. Equiva .. rst-class:: classref-method -void **canvas_light_set_texture_offset** **(** :ref:`RID` light, :ref:`Vector2` offset **)** +|void| **canvas_light_set_texture_offset**\ (\ light\: :ref:`RID`, offset\: :ref:`Vector2`\ ) Sets the offset of a :ref:`PointLight2D`'s texture. Equivalent to :ref:`PointLight2D.offset`. @@ -6640,7 +6798,7 @@ Sets the offset of a :ref:`PointLight2D`'s texture. Equivale .. rst-class:: classref-method -void **canvas_light_set_texture_scale** **(** :ref:`RID` light, :ref:`float` scale **)** +|void| **canvas_light_set_texture_scale**\ (\ light\: :ref:`RID`, scale\: :ref:`float`\ ) Sets the scale factor of a :ref:`PointLight2D`'s texture. Equivalent to :ref:`PointLight2D.texture_scale`. @@ -6652,7 +6810,7 @@ Sets the scale factor of a :ref:`PointLight2D`'s texture. Eq .. rst-class:: classref-method -void **canvas_light_set_transform** **(** :ref:`RID` light, :ref:`Transform2D` transform **)** +|void| **canvas_light_set_transform**\ (\ light\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) Sets the canvas light's :ref:`Transform2D`. @@ -6664,7 +6822,7 @@ Sets the canvas light's :ref:`Transform2D`. .. rst-class:: classref-method -void **canvas_light_set_z_range** **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** +|void| **canvas_light_set_z_range**\ (\ light\: :ref:`RID`, min_z\: :ref:`int`, max_z\: :ref:`int`\ ) Sets the Z range of objects that will be affected by this light. Equivalent to :ref:`Light2D.range_z_min` and :ref:`Light2D.range_z_max`. @@ -6676,7 +6834,7 @@ Sets the Z range of objects that will be affected by this light. Equivalent to : .. rst-class:: classref-method -:ref:`RID` **canvas_occluder_polygon_create** **(** **)** +:ref:`RID` **canvas_occluder_polygon_create**\ (\ ) Creates a new light occluder polygon and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_occluder_polygon_*`` RenderingServer functions. @@ -6692,7 +6850,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -void **canvas_occluder_polygon_set_cull_mode** **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** +|void| **canvas_occluder_polygon_set_cull_mode**\ (\ occluder_polygon\: :ref:`RID`, mode\: :ref:`CanvasOccluderPolygonCullMode`\ ) Sets an occluder polygons cull mode. See :ref:`CanvasOccluderPolygonCullMode` constants. @@ -6704,7 +6862,7 @@ Sets an occluder polygons cull mode. See :ref:`CanvasOccluderPolygonCullMode` occluder_polygon, :ref:`PackedVector2Array` shape, :ref:`bool` closed **)** +|void| **canvas_occluder_polygon_set_shape**\ (\ occluder_polygon\: :ref:`RID`, shape\: :ref:`PackedVector2Array`, closed\: :ref:`bool`\ ) Sets the shape of the occluder polygon. @@ -6716,7 +6874,7 @@ Sets the shape of the occluder polygon. .. rst-class:: classref-method -void **canvas_set_disable_scale** **(** :ref:`bool` disable **)** +|void| **canvas_set_disable_scale**\ (\ disable\: :ref:`bool`\ ) .. container:: contribute @@ -6730,7 +6888,7 @@ void **canvas_set_disable_scale** **(** :ref:`bool` disable **)** .. rst-class:: classref-method -void **canvas_set_item_mirroring** **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** +|void| **canvas_set_item_mirroring**\ (\ canvas\: :ref:`RID`, item\: :ref:`RID`, mirroring\: :ref:`Vector2`\ ) A copy of the canvas item will be drawn with a local offset of the mirroring :ref:`Vector2`. @@ -6742,7 +6900,7 @@ A copy of the canvas item will be drawn with a local offset of the mirroring :re .. rst-class:: classref-method -void **canvas_set_modulate** **(** :ref:`RID` canvas, :ref:`Color` color **)** +|void| **canvas_set_modulate**\ (\ canvas\: :ref:`RID`, color\: :ref:`Color`\ ) Modulates all colors in the given canvas. @@ -6754,7 +6912,7 @@ Modulates all colors in the given canvas. .. rst-class:: classref-method -void **canvas_set_shadow_texture_size** **(** :ref:`int` size **)** +|void| **canvas_set_shadow_texture_size**\ (\ size\: :ref:`int`\ ) Sets the :ref:`ProjectSettings.rendering/2d/shadow_atlas/size` to use for :ref:`Light2D` shadow rendering (in pixels). The value is rounded up to the nearest power of 2. @@ -6766,7 +6924,7 @@ Sets the :ref:`ProjectSettings.rendering/2d/shadow_atlas/size` **canvas_texture_create** **(** **)** +:ref:`RID` **canvas_texture_create**\ (\ ) Creates a canvas texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_texture_*`` RenderingServer functions. @@ -6782,7 +6940,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -void **canvas_texture_set_channel** **(** :ref:`RID` canvas_texture, :ref:`CanvasTextureChannel` channel, :ref:`RID` texture **)** +|void| **canvas_texture_set_channel**\ (\ canvas_texture\: :ref:`RID`, channel\: :ref:`CanvasTextureChannel`, texture\: :ref:`RID`\ ) Sets the ``channel``'s ``texture`` for the canvas texture specified by the ``canvas_texture`` RID. Equivalent to :ref:`CanvasTexture.diffuse_texture`, :ref:`CanvasTexture.normal_texture` and :ref:`CanvasTexture.specular_texture`. @@ -6794,7 +6952,7 @@ Sets the ``channel``'s ``texture`` for the canvas texture specified by the ``can .. rst-class:: classref-method -void **canvas_texture_set_shading_parameters** **(** :ref:`RID` canvas_texture, :ref:`Color` base_color, :ref:`float` shininess **)** +|void| **canvas_texture_set_shading_parameters**\ (\ canvas_texture\: :ref:`RID`, base_color\: :ref:`Color`, shininess\: :ref:`float`\ ) Sets the ``base_color`` and ``shininess`` to use for the canvas texture specified by the ``canvas_texture`` RID. Equivalent to :ref:`CanvasTexture.specular_color` and :ref:`CanvasTexture.specular_shininess`. @@ -6806,7 +6964,7 @@ Sets the ``base_color`` and ``shininess`` to use for the canvas texture specifie .. rst-class:: classref-method -void **canvas_texture_set_texture_filter** **(** :ref:`RID` canvas_texture, :ref:`CanvasItemTextureFilter` filter **)** +|void| **canvas_texture_set_texture_filter**\ (\ canvas_texture\: :ref:`RID`, filter\: :ref:`CanvasItemTextureFilter`\ ) Sets the texture ``filter`` mode to use for the canvas texture specified by the ``canvas_texture`` RID. @@ -6818,7 +6976,7 @@ Sets the texture ``filter`` mode to use for the canvas texture specified by the .. rst-class:: classref-method -void **canvas_texture_set_texture_repeat** **(** :ref:`RID` canvas_texture, :ref:`CanvasItemTextureRepeat` repeat **)** +|void| **canvas_texture_set_texture_repeat**\ (\ canvas_texture\: :ref:`RID`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) Sets the texture ``repeat`` mode to use for the canvas texture specified by the ``canvas_texture`` RID. @@ -6826,11 +6984,87 @@ Sets the texture ``repeat`` mode to use for the canvas texture specified by the ---- +.. _class_RenderingServer_method_compositor_create: + +.. rst-class:: classref-method + +:ref:`RID` **compositor_create**\ (\ ) + +Creates a new compositor and adds it to the RenderingServer. It can be accessed with the RID that is returned. + +Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid` method. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderingServer_method_compositor_effect_create: + +.. rst-class:: classref-method + +:ref:`RID` **compositor_effect_create**\ (\ ) + +Creates a new rendering effect and adds it to the RenderingServer. It can be accessed with the RID that is returned. + +Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid` method. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderingServer_method_compositor_effect_set_callback: + +.. rst-class:: classref-method + +|void| **compositor_effect_set_callback**\ (\ effect\: :ref:`RID`, callback_type\: :ref:`CompositorEffectCallbackType`, callback\: :ref:`Callable`\ ) + +Sets the callback type (``callback_type``) and callback method(``callback``) for this rendering effect. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderingServer_method_compositor_effect_set_enabled: + +.. rst-class:: classref-method + +|void| **compositor_effect_set_enabled**\ (\ effect\: :ref:`RID`, enabled\: :ref:`bool`\ ) + +Enables/disables this rendering effect. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderingServer_method_compositor_effect_set_flag: + +.. rst-class:: classref-method + +|void| **compositor_effect_set_flag**\ (\ effect\: :ref:`RID`, flag\: :ref:`CompositorEffectFlags`, set\: :ref:`bool`\ ) + +Sets the flag (``flag``) for this rendering effect to ``true`` or ``false`` (``set``). + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderingServer_method_compositor_set_compositor_effects: + +.. rst-class:: classref-method + +|void| **compositor_set_compositor_effects**\ (\ compositor\: :ref:`RID`, effects\: :ref:`Array`\[:ref:`RID`\]\ ) + +Sets the compositor effects for the specified compositor RID. ``effects`` should be an array containing RIDs created with :ref:`compositor_effect_create`. + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingServer_method_create_local_rendering_device: .. rst-class:: classref-method -:ref:`RenderingDevice` **create_local_rendering_device** **(** **)** |const| +:ref:`RenderingDevice` **create_local_rendering_device**\ (\ ) |const| Creates a RenderingDevice that can be used to do draw and compute operations on a separate thread. Cannot draw to the screen nor share data with the global RenderingDevice. @@ -6844,7 +7078,7 @@ Creates a RenderingDevice that can be used to do draw and compute operations on .. rst-class:: classref-method -:ref:`Rect2` **debug_canvas_item_get_rect** **(** :ref:`RID` item **)** +:ref:`Rect2` **debug_canvas_item_get_rect**\ (\ item\: :ref:`RID`\ ) Returns the bounding rectangle for a canvas item in local space, as calculated by the renderer. This bound is used internally for culling. @@ -6858,7 +7092,7 @@ Returns the bounding rectangle for a canvas item in local space, as calculated b .. rst-class:: classref-method -:ref:`RID` **decal_create** **(** **)** +:ref:`RID` **decal_create**\ (\ ) Creates a decal and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``decal_*`` RenderingServer functions. @@ -6876,7 +7110,7 @@ To place in a scene, attach this decal to an instance using :ref:`instance_set_b .. rst-class:: classref-method -void **decal_set_albedo_mix** **(** :ref:`RID` decal, :ref:`float` albedo_mix **)** +|void| **decal_set_albedo_mix**\ (\ decal\: :ref:`RID`, albedo_mix\: :ref:`float`\ ) Sets the ``albedo_mix`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.albedo_mix`. @@ -6888,7 +7122,7 @@ Sets the ``albedo_mix`` in the decal specified by the ``decal`` RID. Equivalent .. rst-class:: classref-method -void **decal_set_cull_mask** **(** :ref:`RID` decal, :ref:`int` mask **)** +|void| **decal_set_cull_mask**\ (\ decal\: :ref:`RID`, mask\: :ref:`int`\ ) Sets the cull ``mask`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.cull_mask`. @@ -6900,7 +7134,7 @@ Sets the cull ``mask`` in the decal specified by the ``decal`` RID. Equivalent t .. rst-class:: classref-method -void **decal_set_distance_fade** **(** :ref:`RID` decal, :ref:`bool` enabled, :ref:`float` begin, :ref:`float` length **)** +|void| **decal_set_distance_fade**\ (\ decal\: :ref:`RID`, enabled\: :ref:`bool`, begin\: :ref:`float`, length\: :ref:`float`\ ) Sets the distance fade parameters in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.distance_fade_enabled`, :ref:`Decal.distance_fade_begin` and :ref:`Decal.distance_fade_length`. @@ -6912,7 +7146,7 @@ Sets the distance fade parameters in the decal specified by the ``decal`` RID. E .. rst-class:: classref-method -void **decal_set_emission_energy** **(** :ref:`RID` decal, :ref:`float` energy **)** +|void| **decal_set_emission_energy**\ (\ decal\: :ref:`RID`, energy\: :ref:`float`\ ) Sets the emission ``energy`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.emission_energy`. @@ -6924,7 +7158,7 @@ Sets the emission ``energy`` in the decal specified by the ``decal`` RID. Equiva .. rst-class:: classref-method -void **decal_set_fade** **(** :ref:`RID` decal, :ref:`float` above, :ref:`float` below **)** +|void| **decal_set_fade**\ (\ decal\: :ref:`RID`, above\: :ref:`float`, below\: :ref:`float`\ ) Sets the upper fade (``above``) and lower fade (``below``) in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.upper_fade` and :ref:`Decal.lower_fade`. @@ -6936,7 +7170,7 @@ Sets the upper fade (``above``) and lower fade (``below``) in the decal specifie .. rst-class:: classref-method -void **decal_set_modulate** **(** :ref:`RID` decal, :ref:`Color` color **)** +|void| **decal_set_modulate**\ (\ decal\: :ref:`RID`, color\: :ref:`Color`\ ) Sets the color multiplier in the decal specified by the ``decal`` RID to ``color``. Equivalent to :ref:`Decal.modulate`. @@ -6948,7 +7182,7 @@ Sets the color multiplier in the decal specified by the ``decal`` RID to ``color .. rst-class:: classref-method -void **decal_set_normal_fade** **(** :ref:`RID` decal, :ref:`float` fade **)** +|void| **decal_set_normal_fade**\ (\ decal\: :ref:`RID`, fade\: :ref:`float`\ ) Sets the normal ``fade`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.normal_fade`. @@ -6960,7 +7194,7 @@ Sets the normal ``fade`` in the decal specified by the ``decal`` RID. Equivalent .. rst-class:: classref-method -void **decal_set_size** **(** :ref:`RID` decal, :ref:`Vector3` size **)** +|void| **decal_set_size**\ (\ decal\: :ref:`RID`, size\: :ref:`Vector3`\ ) Sets the ``size`` of the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.size`. @@ -6972,7 +7206,7 @@ Sets the ``size`` of the decal specified by the ``decal`` RID. Equivalent to :re .. rst-class:: classref-method -void **decal_set_texture** **(** :ref:`RID` decal, :ref:`DecalTexture` type, :ref:`RID` texture **)** +|void| **decal_set_texture**\ (\ decal\: :ref:`RID`, type\: :ref:`DecalTexture`, texture\: :ref:`RID`\ ) Sets the ``texture`` in the given texture ``type`` slot for the specified decal. Equivalent to :ref:`Decal.set_texture`. @@ -6984,7 +7218,7 @@ Sets the ``texture`` in the given texture ``type`` slot for the specified decal. .. rst-class:: classref-method -void **decals_set_filter** **(** :ref:`DecalFilter` filter **)** +|void| **decals_set_filter**\ (\ filter\: :ref:`DecalFilter`\ ) Sets the texture ``filter`` mode to use when rendering decals. This parameter is global and cannot be set on a per-decal basis. @@ -6996,7 +7230,7 @@ Sets the texture ``filter`` mode to use when rendering decals. This parameter is .. rst-class:: classref-method -:ref:`RID` **directional_light_create** **(** **)** +:ref:`RID` **directional_light_create**\ (\ ) Creates a directional light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most ``light_*`` RenderingServer functions. @@ -7014,7 +7248,7 @@ To place in a scene, attach this directional light to an instance using :ref:`in .. rst-class:: classref-method -void **directional_shadow_atlas_set_size** **(** :ref:`int` size, :ref:`bool` is_16bits **)** +|void| **directional_shadow_atlas_set_size**\ (\ size\: :ref:`int`, is_16bits\: :ref:`bool`\ ) Sets the ``size`` of the directional light shadows in 3D. See also :ref:`ProjectSettings.rendering/lights_and_shadows/directional_shadow/size`. This parameter is global and cannot be set on a per-viewport basis. @@ -7026,7 +7260,7 @@ Sets the ``size`` of the directional light shadows in 3D. See also :ref:`Project .. rst-class:: classref-method -void **directional_soft_shadow_filter_set_quality** **(** :ref:`ShadowQuality` quality **)** +|void| **directional_soft_shadow_filter_set_quality**\ (\ quality\: :ref:`ShadowQuality`\ ) Sets the filter ``quality`` for directional light shadows in 3D. See also :ref:`ProjectSettings.rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality`. This parameter is global and cannot be set on a per-viewport basis. @@ -7038,7 +7272,7 @@ Sets the filter ``quality`` for directional light shadows in 3D. See also :ref:` .. rst-class:: classref-method -:ref:`Image` **environment_bake_panorama** **(** :ref:`RID` environment, :ref:`bool` bake_irradiance, :ref:`Vector2i` size **)** +:ref:`Image` **environment_bake_panorama**\ (\ environment\: :ref:`RID`, bake_irradiance\: :ref:`bool`, size\: :ref:`Vector2i`\ ) Generates and returns an :ref:`Image` containing the radiance map for the specified ``environment`` RID's sky. This supports built-in sky material and custom sky shaders. If ``bake_irradiance`` is ``true``, the irradiance map is saved instead of the radiance map. The radiance map is used to render reflected light, while the irradiance map is used to render ambient light. See also :ref:`sky_bake_panorama`. @@ -7054,7 +7288,7 @@ Generates and returns an :ref:`Image` containing the radiance map f .. rst-class:: classref-method -:ref:`RID` **environment_create** **(** **)** +:ref:`RID` **environment_create**\ (\ ) Creates an environment and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``environment_*`` RenderingServer functions. @@ -7070,7 +7304,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -void **environment_glow_set_use_bicubic_upscale** **(** :ref:`bool` enable **)** +|void| **environment_glow_set_use_bicubic_upscale**\ (\ enable\: :ref:`bool`\ ) If ``enable`` is ``true``, enables bicubic upscaling for glow which improves quality at the cost of performance. Equivalent to :ref:`ProjectSettings.rendering/environment/glow/upscale_mode`. @@ -7082,7 +7316,7 @@ If ``enable`` is ``true``, enables bicubic upscaling for glow which improves qua .. rst-class:: classref-method -void **environment_set_adjustment** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`bool` use_1d_color_correction, :ref:`RID` color_correction **)** +|void| **environment_set_adjustment**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, brightness\: :ref:`float`, contrast\: :ref:`float`, saturation\: :ref:`float`, use_1d_color_correction\: :ref:`bool`, color_correction\: :ref:`RID`\ ) Sets the values to be used with the "adjustments" post-process effect. See :ref:`Environment` for more details. @@ -7094,7 +7328,7 @@ Sets the values to be used with the "adjustments" post-process effect. See :ref: .. rst-class:: classref-method -void **environment_set_ambient_light** **(** :ref:`RID` env, :ref:`Color` color, :ref:`EnvironmentAmbientSource` ambient=0, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0, :ref:`EnvironmentReflectionSource` reflection_source=0 **)** +|void| **environment_set_ambient_light**\ (\ env\: :ref:`RID`, color\: :ref:`Color`, ambient\: :ref:`EnvironmentAmbientSource` = 0, energy\: :ref:`float` = 1.0, sky_contibution\: :ref:`float` = 0.0, reflection_source\: :ref:`EnvironmentReflectionSource` = 0\ ) Sets the values to be used for ambient light rendering. See :ref:`Environment` for more details. @@ -7106,7 +7340,7 @@ Sets the values to be used for ambient light rendering. See :ref:`Environment` env, :ref:`EnvironmentBG` bg **)** +|void| **environment_set_background**\ (\ env\: :ref:`RID`, bg\: :ref:`EnvironmentBG`\ ) Sets the environment's background mode. Equivalent to :ref:`Environment.background_mode`. @@ -7118,7 +7352,7 @@ Sets the environment's background mode. Equivalent to :ref:`Environment.backgrou .. rst-class:: classref-method -void **environment_set_bg_color** **(** :ref:`RID` env, :ref:`Color` color **)** +|void| **environment_set_bg_color**\ (\ env\: :ref:`RID`, color\: :ref:`Color`\ ) Color displayed for clear areas of the scene. Only effective if using the :ref:`ENV_BG_COLOR` background mode. @@ -7130,7 +7364,7 @@ Color displayed for clear areas of the scene. Only effective if using the :ref:` .. rst-class:: classref-method -void **environment_set_bg_energy** **(** :ref:`RID` env, :ref:`float` multiplier, :ref:`float` exposure_value **)** +|void| **environment_set_bg_energy**\ (\ env\: :ref:`RID`, multiplier\: :ref:`float`, exposure_value\: :ref:`float`\ ) Sets the intensity of the background color. @@ -7142,7 +7376,7 @@ Sets the intensity of the background color. .. rst-class:: classref-method -void **environment_set_canvas_max_layer** **(** :ref:`RID` env, :ref:`int` max_layer **)** +|void| **environment_set_canvas_max_layer**\ (\ env\: :ref:`RID`, max_layer\: :ref:`int`\ ) Sets the maximum layer to use if using Canvas background mode. @@ -7154,7 +7388,7 @@ Sets the maximum layer to use if using Canvas background mode. .. rst-class:: classref-method -void **environment_set_fog** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` light_color, :ref:`float` light_energy, :ref:`float` sun_scatter, :ref:`float` density, :ref:`float` height, :ref:`float` height_density, :ref:`float` aerial_perspective, :ref:`float` sky_affect **)** +|void| **environment_set_fog**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, light_color\: :ref:`Color`, light_energy\: :ref:`float`, sun_scatter\: :ref:`float`, density\: :ref:`float`, height\: :ref:`float`, height_density\: :ref:`float`, aerial_perspective\: :ref:`float`, sky_affect\: :ref:`float`, fog_mode\: :ref:`EnvironmentFogMode` = 0\ ) Configures fog for the specified environment RID. See ``fog_*`` properties in :ref:`Environment` for more information. @@ -7166,7 +7400,7 @@ Configures fog for the specified environment RID. See ``fog_*`` properties in :r .. rst-class:: classref-method -void **environment_set_glow** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`PackedFloat32Array` levels, :ref:`float` intensity, :ref:`float` strength, :ref:`float` mix, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`float` hdr_luminance_cap, :ref:`float` glow_map_strength, :ref:`RID` glow_map **)** +|void| **environment_set_glow**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, levels\: :ref:`PackedFloat32Array`, intensity\: :ref:`float`, strength\: :ref:`float`, mix\: :ref:`float`, bloom_threshold\: :ref:`float`, blend_mode\: :ref:`EnvironmentGlowBlendMode`, hdr_bleed_threshold\: :ref:`float`, hdr_bleed_scale\: :ref:`float`, hdr_luminance_cap\: :ref:`float`, glow_map_strength\: :ref:`float`, glow_map\: :ref:`RID`\ ) Configures glow for the specified environment RID. See ``glow_*`` properties in :ref:`Environment` for more information. @@ -7178,7 +7412,7 @@ Configures glow for the specified environment RID. See ``glow_*`` properties in .. rst-class:: classref-method -void **environment_set_sdfgi** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` cascades, :ref:`float` min_cell_size, :ref:`EnvironmentSDFGIYScale` y_scale, :ref:`bool` use_occlusion, :ref:`float` bounce_feedback, :ref:`bool` read_sky, :ref:`float` energy, :ref:`float` normal_bias, :ref:`float` probe_bias **)** +|void| **environment_set_sdfgi**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, cascades\: :ref:`int`, min_cell_size\: :ref:`float`, y_scale\: :ref:`EnvironmentSDFGIYScale`, use_occlusion\: :ref:`bool`, bounce_feedback\: :ref:`float`, read_sky\: :ref:`bool`, energy\: :ref:`float`, normal_bias\: :ref:`float`, probe_bias\: :ref:`float`\ ) Configures signed distance field global illumination for the specified environment RID. See ``sdfgi_*`` properties in :ref:`Environment` for more information. @@ -7190,7 +7424,7 @@ Configures signed distance field global illumination for the specified environme .. rst-class:: classref-method -void **environment_set_sdfgi_frames_to_converge** **(** :ref:`EnvironmentSDFGIFramesToConverge` frames **)** +|void| **environment_set_sdfgi_frames_to_converge**\ (\ frames\: :ref:`EnvironmentSDFGIFramesToConverge`\ ) Sets the number of frames to use for converging signed distance field global illumination. Equivalent to :ref:`ProjectSettings.rendering/global_illumination/sdfgi/frames_to_converge`. @@ -7202,7 +7436,7 @@ Sets the number of frames to use for converging signed distance field global ill .. rst-class:: classref-method -void **environment_set_sdfgi_frames_to_update_light** **(** :ref:`EnvironmentSDFGIFramesToUpdateLight` frames **)** +|void| **environment_set_sdfgi_frames_to_update_light**\ (\ frames\: :ref:`EnvironmentSDFGIFramesToUpdateLight`\ ) Sets the update speed for dynamic lights' indirect lighting when computing signed distance field global illumination. Equivalent to :ref:`ProjectSettings.rendering/global_illumination/sdfgi/frames_to_update_lights`. @@ -7214,7 +7448,7 @@ Sets the update speed for dynamic lights' indirect lighting when computing signe .. rst-class:: classref-method -void **environment_set_sdfgi_ray_count** **(** :ref:`EnvironmentSDFGIRayCount` ray_count **)** +|void| **environment_set_sdfgi_ray_count**\ (\ ray_count\: :ref:`EnvironmentSDFGIRayCount`\ ) Sets the number of rays to throw per frame when computing signed distance field global illumination. Equivalent to :ref:`ProjectSettings.rendering/global_illumination/sdfgi/probe_ray_count`. @@ -7226,7 +7460,7 @@ Sets the number of rays to throw per frame when computing signed distance field .. rst-class:: classref-method -void **environment_set_sky** **(** :ref:`RID` env, :ref:`RID` sky **)** +|void| **environment_set_sky**\ (\ env\: :ref:`RID`, sky\: :ref:`RID`\ ) Sets the :ref:`Sky` to be used as the environment's background when using *BGMode* sky. Equivalent to :ref:`Environment.sky`. @@ -7238,7 +7472,7 @@ Sets the :ref:`Sky` to be used as the environment's background when u .. rst-class:: classref-method -void **environment_set_sky_custom_fov** **(** :ref:`RID` env, :ref:`float` scale **)** +|void| **environment_set_sky_custom_fov**\ (\ env\: :ref:`RID`, scale\: :ref:`float`\ ) Sets a custom field of view for the background :ref:`Sky`. Equivalent to :ref:`Environment.sky_custom_fov`. @@ -7250,7 +7484,7 @@ Sets a custom field of view for the background :ref:`Sky`. Equivalent .. rst-class:: classref-method -void **environment_set_sky_orientation** **(** :ref:`RID` env, :ref:`Basis` orientation **)** +|void| **environment_set_sky_orientation**\ (\ env\: :ref:`RID`, orientation\: :ref:`Basis`\ ) Sets the rotation of the background :ref:`Sky` expressed as a :ref:`Basis`. Equivalent to :ref:`Environment.sky_rotation`, where the rotation vector is used to construct the :ref:`Basis`. @@ -7262,7 +7496,7 @@ Sets the rotation of the background :ref:`Sky` expressed as a :ref:`B .. rst-class:: classref-method -void **environment_set_ssao** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` power, :ref:`float` detail, :ref:`float` horizon, :ref:`float` sharpness, :ref:`float` light_affect, :ref:`float` ao_channel_affect **)** +|void| **environment_set_ssao**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, radius\: :ref:`float`, intensity\: :ref:`float`, power\: :ref:`float`, detail\: :ref:`float`, horizon\: :ref:`float`, sharpness\: :ref:`float`, light_affect\: :ref:`float`, ao_channel_affect\: :ref:`float`\ ) Sets the variables to be used with the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment` for more details. @@ -7274,7 +7508,7 @@ Sets the variables to be used with the screen-space ambient occlusion (SSAO) pos .. rst-class:: classref-method -void **environment_set_ssao_quality** **(** :ref:`EnvironmentSSAOQuality` quality, :ref:`bool` half_size, :ref:`float` adaptive_target, :ref:`int` blur_passes, :ref:`float` fadeout_from, :ref:`float` fadeout_to **)** +|void| **environment_set_ssao_quality**\ (\ quality\: :ref:`EnvironmentSSAOQuality`, half_size\: :ref:`bool`, adaptive_target\: :ref:`float`, blur_passes\: :ref:`int`, fadeout_from\: :ref:`float`, fadeout_to\: :ref:`float`\ ) Sets the quality level of the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment` for more details. @@ -7286,7 +7520,7 @@ Sets the quality level of the screen-space ambient occlusion (SSAO) post-process .. rst-class:: classref-method -void **environment_set_ssil_quality** **(** :ref:`EnvironmentSSILQuality` quality, :ref:`bool` half_size, :ref:`float` adaptive_target, :ref:`int` blur_passes, :ref:`float` fadeout_from, :ref:`float` fadeout_to **)** +|void| **environment_set_ssil_quality**\ (\ quality\: :ref:`EnvironmentSSILQuality`, half_size\: :ref:`bool`, adaptive_target\: :ref:`float`, blur_passes\: :ref:`int`, fadeout_from\: :ref:`float`, fadeout_to\: :ref:`float`\ ) Sets the quality level of the screen-space indirect lighting (SSIL) post-process effect. See :ref:`Environment` for more details. @@ -7298,7 +7532,7 @@ Sets the quality level of the screen-space indirect lighting (SSIL) post-process .. rst-class:: classref-method -void **environment_set_ssr** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance **)** +|void| **environment_set_ssr**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, max_steps\: :ref:`int`, fade_in\: :ref:`float`, fade_out\: :ref:`float`, depth_tolerance\: :ref:`float`\ ) Sets the variables to be used with the screen-space reflections (SSR) post-process effect. See :ref:`Environment` for more details. @@ -7310,7 +7544,7 @@ Sets the variables to be used with the screen-space reflections (SSR) post-proce .. rst-class:: classref-method -void **environment_set_ssr_roughness_quality** **(** :ref:`EnvironmentSSRRoughnessQuality` quality **)** +|void| **environment_set_ssr_roughness_quality**\ (\ quality\: :ref:`EnvironmentSSRRoughnessQuality`\ ) .. container:: contribute @@ -7324,7 +7558,7 @@ void **environment_set_ssr_roughness_quality** **(** :ref:`EnvironmentSSRRoughne .. rst-class:: classref-method -void **environment_set_tonemap** **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white **)** +|void| **environment_set_tonemap**\ (\ env\: :ref:`RID`, tone_mapper\: :ref:`EnvironmentToneMapper`, exposure\: :ref:`float`, white\: :ref:`float`\ ) Sets the variables to be used with the "tonemap" post-process effect. See :ref:`Environment` for more details. @@ -7336,7 +7570,7 @@ Sets the variables to be used with the "tonemap" post-process effect. See :ref:` .. rst-class:: classref-method -void **environment_set_volumetric_fog** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` density, :ref:`Color` albedo, :ref:`Color` emission, :ref:`float` emission_energy, :ref:`float` anisotropy, :ref:`float` length, :ref:`float` p_detail_spread, :ref:`float` gi_inject, :ref:`bool` temporal_reprojection, :ref:`float` temporal_reprojection_amount, :ref:`float` ambient_inject, :ref:`float` sky_affect **)** +|void| **environment_set_volumetric_fog**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, density\: :ref:`float`, albedo\: :ref:`Color`, emission\: :ref:`Color`, emission_energy\: :ref:`float`, anisotropy\: :ref:`float`, length\: :ref:`float`, p_detail_spread\: :ref:`float`, gi_inject\: :ref:`float`, temporal_reprojection\: :ref:`bool`, temporal_reprojection_amount\: :ref:`float`, ambient_inject\: :ref:`float`, sky_affect\: :ref:`float`\ ) Sets the variables to be used with the volumetric fog post-process effect. See :ref:`Environment` for more details. @@ -7348,7 +7582,7 @@ Sets the variables to be used with the volumetric fog post-process effect. See : .. rst-class:: classref-method -void **environment_set_volumetric_fog_filter_active** **(** :ref:`bool` active **)** +|void| **environment_set_volumetric_fog_filter_active**\ (\ active\: :ref:`bool`\ ) Enables filtering of the volumetric fog scattering buffer. This results in much smoother volumes with very few under-sampling artifacts. @@ -7360,7 +7594,7 @@ Enables filtering of the volumetric fog scattering buffer. This results in much .. rst-class:: classref-method -void **environment_set_volumetric_fog_volume_size** **(** :ref:`int` size, :ref:`int` depth **)** +|void| **environment_set_volumetric_fog_volume_size**\ (\ size\: :ref:`int`, depth\: :ref:`int`\ ) Sets the resolution of the volumetric fog's froxel buffer. ``size`` is modified by the screen's aspect ratio and then used to set the width and height of the buffer. While ``depth`` is directly used to set the depth of the buffer. @@ -7372,7 +7606,7 @@ Sets the resolution of the volumetric fog's froxel buffer. ``size`` is modified .. rst-class:: classref-method -:ref:`RID` **fog_volume_create** **(** **)** +:ref:`RID` **fog_volume_create**\ (\ ) Creates a new fog volume and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``fog_volume_*`` RenderingServer functions. @@ -7388,7 +7622,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -void **fog_volume_set_material** **(** :ref:`RID` fog_volume, :ref:`RID` material **)** +|void| **fog_volume_set_material**\ (\ fog_volume\: :ref:`RID`, material\: :ref:`RID`\ ) Sets the :ref:`Material` of the fog volume. Can be either a :ref:`FogMaterial` or a custom :ref:`ShaderMaterial`. @@ -7400,7 +7634,7 @@ Sets the :ref:`Material` of the fog volume. Can be either a :ref .. rst-class:: classref-method -void **fog_volume_set_shape** **(** :ref:`RID` fog_volume, :ref:`FogVolumeShape` shape **)** +|void| **fog_volume_set_shape**\ (\ fog_volume\: :ref:`RID`, shape\: :ref:`FogVolumeShape`\ ) Sets the shape of the fog volume to either :ref:`FOG_VOLUME_SHAPE_ELLIPSOID`, :ref:`FOG_VOLUME_SHAPE_CONE`, :ref:`FOG_VOLUME_SHAPE_CYLINDER`, :ref:`FOG_VOLUME_SHAPE_BOX` or :ref:`FOG_VOLUME_SHAPE_WORLD`. @@ -7412,7 +7646,7 @@ Sets the shape of the fog volume to either :ref:`FOG_VOLUME_SHAPE_ELLIPSOID` fog_volume, :ref:`Vector3` size **)** +|void| **fog_volume_set_size**\ (\ fog_volume\: :ref:`RID`, size\: :ref:`Vector3`\ ) Sets the size of the fog volume when shape is :ref:`FOG_VOLUME_SHAPE_ELLIPSOID`, :ref:`FOG_VOLUME_SHAPE_CONE`, :ref:`FOG_VOLUME_SHAPE_CYLINDER` or :ref:`FOG_VOLUME_SHAPE_BOX`. @@ -7424,7 +7658,7 @@ Sets the size of the fog volume when shape is :ref:`FOG_VOLUME_SHAPE_ELLIPSOID` swap_buffers=true, :ref:`float` frame_step=0.0 **)** +|void| **force_draw**\ (\ swap_buffers\: :ref:`bool` = true, frame_step\: :ref:`float` = 0.0\ ) Forces redrawing of all viewports at once. Must be called from the main thread. @@ -7436,7 +7670,7 @@ Forces redrawing of all viewports at once. Must be called from the main thread. .. rst-class:: classref-method -void **force_sync** **(** **)** +|void| **force_sync**\ (\ ) Forces a synchronization between the CPU and GPU, which may be required in certain cases. Only call this when needed, as CPU-GPU synchronization has a performance cost. @@ -7448,7 +7682,7 @@ Forces a synchronization between the CPU and GPU, which may be required in certa .. rst-class:: classref-method -void **free_rid** **(** :ref:`RID` rid **)** +|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) Tries to free an object in the RenderingServer. To avoid memory leaks, this should be called after using an object as memory management does not occur automatically when using RenderingServer directly. @@ -7460,7 +7694,7 @@ Tries to free an object in the RenderingServer. To avoid memory leaks, this shou .. rst-class:: classref-method -:ref:`Color` **get_default_clear_color** **(** **)** +:ref:`Color` **get_default_clear_color**\ (\ ) Returns the default clear color which is used when a specific clear color has not been selected. See also :ref:`set_default_clear_color`. @@ -7472,7 +7706,7 @@ Returns the default clear color which is used when a specific clear color has no .. rst-class:: classref-method -:ref:`float` **get_frame_setup_time_cpu** **(** **)** |const| +:ref:`float` **get_frame_setup_time_cpu**\ (\ ) |const| Returns the time taken to setup rendering on the CPU in milliseconds. This value is shared across all viewports and does *not* require :ref:`viewport_set_measure_render_time` to be enabled on a viewport to be queried. See also :ref:`viewport_get_measured_render_time_cpu`. @@ -7484,7 +7718,7 @@ Returns the time taken to setup rendering on the CPU in milliseconds. This value .. rst-class:: classref-method -:ref:`RenderingDevice` **get_rendering_device** **(** **)** |const| +:ref:`RenderingDevice` **get_rendering_device**\ (\ ) |const| Returns the global RenderingDevice. @@ -7498,7 +7732,7 @@ Returns the global RenderingDevice. .. rst-class:: classref-method -:ref:`int` **get_rendering_info** **(** :ref:`RenderingInfo` info **)** +:ref:`int` **get_rendering_info**\ (\ info\: :ref:`RenderingInfo`\ ) Returns a statistic about the rendering engine which can be used for performance profiling. See :ref:`RenderingInfo` for a list of values that can be queried. See also :ref:`viewport_get_render_info`, which returns information specific to a viewport. @@ -7522,7 +7756,7 @@ Returns a statistic about the rendering engine which can be used for performance .. rst-class:: classref-method -:ref:`Dictionary[]` **get_shader_parameter_list** **(** :ref:`RID` shader **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_shader_parameter_list**\ (\ shader\: :ref:`RID`\ ) |const| Returns the parameters of a shader. @@ -7534,7 +7768,7 @@ Returns the parameters of a shader. .. rst-class:: classref-method -:ref:`RID` **get_test_cube** **(** **)** +:ref:`RID` **get_test_cube**\ (\ ) Returns the RID of the test cube. This mesh will be created and returned on the first call to :ref:`get_test_cube`, then it will be cached for subsequent calls. See also :ref:`make_sphere_mesh`. @@ -7546,7 +7780,7 @@ Returns the RID of the test cube. This mesh will be created and returned on the .. rst-class:: classref-method -:ref:`RID` **get_test_texture** **(** **)** +:ref:`RID` **get_test_texture**\ (\ ) Returns the RID of a 256×256 texture with a testing pattern on it (in :ref:`Image.FORMAT_RGB8` format). This texture will be created and returned on the first call to :ref:`get_test_texture`, then it will be cached for subsequent calls. See also :ref:`get_white_texture`. @@ -7566,7 +7800,7 @@ Example of getting the test texture and applying it to a :ref:`Sprite2D` **get_video_adapter_api_version** **(** **)** |const| +:ref:`String` **get_video_adapter_api_version**\ (\ ) |const| Returns the version of the graphics video adapter *currently in use* (e.g. "1.2.189" for Vulkan, "3.3.0 NVIDIA 510.60.02" for OpenGL). This version may be different from the actual latest version supported by the hardware, as Godot may not always request the latest version. See also :ref:`OS.get_video_adapter_driver_info`. @@ -7580,7 +7814,7 @@ Returns the version of the graphics video adapter *currently in use* (e.g. "1.2. .. rst-class:: classref-method -:ref:`String` **get_video_adapter_name** **(** **)** |const| +:ref:`String` **get_video_adapter_name**\ (\ ) |const| Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2"). @@ -7596,7 +7830,7 @@ Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2"). .. rst-class:: classref-method -:ref:`DeviceType` **get_video_adapter_type** **(** **)** |const| +:ref:`DeviceType` **get_video_adapter_type**\ (\ ) |const| Returns the type of the video adapter. Since dedicated graphics cards from a given generation will *usually* be significantly faster than integrated graphics made in the same generation, the device type can be used as a basis for automatic graphics settings adjustment. However, this is not always true, so make sure to provide users with a way to manually override graphics settings. @@ -7610,7 +7844,7 @@ Returns the type of the video adapter. Since dedicated graphics cards from a giv .. rst-class:: classref-method -:ref:`String` **get_video_adapter_vendor** **(** **)** |const| +:ref:`String` **get_video_adapter_vendor**\ (\ ) |const| Returns the vendor of the video adapter (e.g. "NVIDIA Corporation"). @@ -7624,7 +7858,7 @@ Returns the vendor of the video adapter (e.g. "NVIDIA Corporation"). .. rst-class:: classref-method -:ref:`RID` **get_white_texture** **(** **)** +:ref:`RID` **get_white_texture**\ (\ ) Returns the ID of a 4×4 white texture (in :ref:`Image.FORMAT_RGB8` format). This texture will be created and returned on the first call to :ref:`get_white_texture`, then it will be cached for subsequent calls. See also :ref:`get_test_texture`. @@ -7644,7 +7878,7 @@ Example of getting the white texture and applying it to a :ref:`Sprite2D` half_resolution **)** +|void| **gi_set_use_half_resolution**\ (\ half_resolution\: :ref:`bool`\ ) If ``half_resolution`` is ``true``, renders :ref:`VoxelGI` and SDFGI (:ref:`Environment.sdfgi_enabled`) buffers at halved resolution on each axis (e.g. 960×540 when the viewport size is 1920×1080). This improves performance significantly when VoxelGI or SDFGI is enabled, at the cost of artifacts that may be visible on polygon edges. The loss in quality becomes less noticeable as the viewport resolution increases. :ref:`LightmapGI` rendering is not affected by this setting. Equivalent to :ref:`ProjectSettings.rendering/global_illumination/gi/use_half_resolution`. @@ -7656,7 +7890,7 @@ If ``half_resolution`` is ``true``, renders :ref:`VoxelGI` and SD .. rst-class:: classref-method -void **global_shader_parameter_add** **(** :ref:`StringName` name, :ref:`GlobalShaderParameterType` type, :ref:`Variant` default_value **)** +|void| **global_shader_parameter_add**\ (\ name\: :ref:`StringName`, type\: :ref:`GlobalShaderParameterType`, default_value\: :ref:`Variant`\ ) Creates a new global shader uniform. @@ -7670,7 +7904,7 @@ Creates a new global shader uniform. .. rst-class:: classref-method -:ref:`Variant` **global_shader_parameter_get** **(** :ref:`StringName` name **)** |const| +:ref:`Variant` **global_shader_parameter_get**\ (\ name\: :ref:`StringName`\ ) |const| Returns the value of the global shader uniform specified by ``name``. @@ -7684,7 +7918,7 @@ Returns the value of the global shader uniform specified by ``name``. .. rst-class:: classref-method -:ref:`StringName[]` **global_shader_parameter_get_list** **(** **)** |const| +:ref:`Array`\[:ref:`StringName`\] **global_shader_parameter_get_list**\ (\ ) |const| Returns the list of global shader uniform names. @@ -7698,7 +7932,7 @@ Returns the list of global shader uniform names. .. rst-class:: classref-method -:ref:`GlobalShaderParameterType` **global_shader_parameter_get_type** **(** :ref:`StringName` name **)** |const| +:ref:`GlobalShaderParameterType` **global_shader_parameter_get_type**\ (\ name\: :ref:`StringName`\ ) |const| Returns the type associated to the global shader uniform specified by ``name``. @@ -7712,7 +7946,7 @@ Returns the type associated to the global shader uniform specified by ``name``. .. rst-class:: classref-method -void **global_shader_parameter_remove** **(** :ref:`StringName` name **)** +|void| **global_shader_parameter_remove**\ (\ name\: :ref:`StringName`\ ) Removes the global shader uniform specified by ``name``. @@ -7724,7 +7958,7 @@ Removes the global shader uniform specified by ``name``. .. rst-class:: classref-method -void **global_shader_parameter_set** **(** :ref:`StringName` name, :ref:`Variant` value **)** +|void| **global_shader_parameter_set**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) Sets the global shader uniform ``name`` to ``value``. @@ -7736,7 +7970,7 @@ Sets the global shader uniform ``name`` to ``value``. .. rst-class:: classref-method -void **global_shader_parameter_set_override** **(** :ref:`StringName` name, :ref:`Variant` value **)** +|void| **global_shader_parameter_set_override**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) Overrides the global shader uniform ``name`` with ``value``. Equivalent to the :ref:`ShaderGlobalsOverride` node. @@ -7748,7 +7982,7 @@ Overrides the global shader uniform ``name`` with ``value``. Equivalent to the : .. rst-class:: classref-method -:ref:`bool` **has_changed** **(** **)** |const| +:ref:`bool` **has_changed**\ (\ ) |const| Returns ``true`` if changes have been made to the RenderingServer's data. :ref:`force_draw` is usually called if this happens. @@ -7760,11 +7994,11 @@ Returns ``true`` if changes have been made to the RenderingServer's data. :ref:` .. rst-class:: classref-method -:ref:`bool` **has_feature** **(** :ref:`Features` feature **)** |const| +:ref:`bool` **has_feature**\ (\ feature\: :ref:`Features`\ ) |const| **Deprecated:** This method has not been used since Godot 3.0. -Always returns false. +This method does nothing and always returns ``false``. .. rst-class:: classref-item-separator @@ -7774,7 +8008,7 @@ Always returns false. .. rst-class:: classref-method -:ref:`bool` **has_os_feature** **(** :ref:`String` feature **)** |const| +:ref:`bool` **has_os_feature**\ (\ feature\: :ref:`String`\ ) |const| Returns ``true`` if the OS supports a certain ``feature``. Features might be ``s3tc``, ``etc``, and ``etc2``. @@ -7786,7 +8020,7 @@ Returns ``true`` if the OS supports a certain ``feature``. Features might be ``s .. rst-class:: classref-method -void **instance_attach_object_instance_id** **(** :ref:`RID` instance, :ref:`int` id **)** +|void| **instance_attach_object_instance_id**\ (\ instance\: :ref:`RID`, id\: :ref:`int`\ ) Attaches a unique Object ID to instance. Object ID must be attached to instance for proper culling with :ref:`instances_cull_aabb`, :ref:`instances_cull_convex`, and :ref:`instances_cull_ray`. @@ -7798,7 +8032,7 @@ Attaches a unique Object ID to instance. Object ID must be attached to instance .. rst-class:: classref-method -void **instance_attach_skeleton** **(** :ref:`RID` instance, :ref:`RID` skeleton **)** +|void| **instance_attach_skeleton**\ (\ instance\: :ref:`RID`, skeleton\: :ref:`RID`\ ) Attaches a skeleton to an instance. Removes the previous skeleton from the instance. @@ -7810,7 +8044,7 @@ Attaches a skeleton to an instance. Removes the previous skeleton from the insta .. rst-class:: classref-method -:ref:`RID` **instance_create** **(** **)** +:ref:`RID` **instance_create**\ (\ ) Creates a visual instance and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``instance_*`` RenderingServer functions. @@ -7828,7 +8062,7 @@ An instance is a way of placing a 3D object in the scenario. Objects like partic .. rst-class:: classref-method -:ref:`RID` **instance_create2** **(** :ref:`RID` base, :ref:`RID` scenario **)** +:ref:`RID` **instance_create2**\ (\ base\: :ref:`RID`, scenario\: :ref:`RID`\ ) Creates a visual instance, adds it to the RenderingServer, and sets both base and scenario. It can be accessed with the RID that is returned. This RID will be used in all ``instance_*`` RenderingServer functions. @@ -7842,7 +8076,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`Variant` **instance_geometry_get_shader_parameter** **(** :ref:`RID` instance, :ref:`StringName` parameter **)** |const| +:ref:`Variant` **instance_geometry_get_shader_parameter**\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| Returns the value of the per-instance shader uniform from the specified 3D geometry instance. Equivalent to :ref:`GeometryInstance3D.get_instance_shader_parameter`. @@ -7856,7 +8090,7 @@ Returns the value of the per-instance shader uniform from the specified 3D geome .. rst-class:: classref-method -:ref:`Variant` **instance_geometry_get_shader_parameter_default_value** **(** :ref:`RID` instance, :ref:`StringName` parameter **)** |const| +:ref:`Variant` **instance_geometry_get_shader_parameter_default_value**\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| Returns the default value of the per-instance shader uniform from the specified 3D geometry instance. Equivalent to :ref:`GeometryInstance3D.get_instance_shader_parameter`. @@ -7868,7 +8102,7 @@ Returns the default value of the per-instance shader uniform from the specified .. rst-class:: classref-method -:ref:`Dictionary[]` **instance_geometry_get_shader_parameter_list** **(** :ref:`RID` instance **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **instance_geometry_get_shader_parameter_list**\ (\ instance\: :ref:`RID`\ ) |const| Returns a dictionary of per-instance shader uniform names of the per-instance shader uniform from the specified 3D geometry instance. The returned dictionary is in PropertyInfo format, with the keys ``name``, ``class_name``, ``type``, ``hint``, ``hint_string`` and ``usage``. Equivalent to :ref:`GeometryInstance3D.get_instance_shader_parameter`. @@ -7880,7 +8114,7 @@ Returns a dictionary of per-instance shader uniform names of the per-instance sh .. rst-class:: classref-method -void **instance_geometry_set_cast_shadows_setting** **(** :ref:`RID` instance, :ref:`ShadowCastingSetting` shadow_casting_setting **)** +|void| **instance_geometry_set_cast_shadows_setting**\ (\ instance\: :ref:`RID`, shadow_casting_setting\: :ref:`ShadowCastingSetting`\ ) Sets the shadow casting setting to one of :ref:`ShadowCastingSetting`. Equivalent to :ref:`GeometryInstance3D.cast_shadow`. @@ -7892,7 +8126,7 @@ Sets the shadow casting setting to one of :ref:`ShadowCastingSetting` instance, :ref:`InstanceFlags` flag, :ref:`bool` enabled **)** +|void| **instance_geometry_set_flag**\ (\ instance\: :ref:`RID`, flag\: :ref:`InstanceFlags`, enabled\: :ref:`bool`\ ) Sets the flag for a given :ref:`InstanceFlags`. See :ref:`InstanceFlags` for more details. @@ -7904,7 +8138,7 @@ Sets the flag for a given :ref:`InstanceFlags` instance, :ref:`RID` lightmap, :ref:`Rect2` lightmap_uv_scale, :ref:`int` lightmap_slice **)** +|void| **instance_geometry_set_lightmap**\ (\ instance\: :ref:`RID`, lightmap\: :ref:`RID`, lightmap_uv_scale\: :ref:`Rect2`, lightmap_slice\: :ref:`int`\ ) Sets the lightmap GI instance to use for the specified 3D geometry instance. The lightmap UV scale for the specified instance (equivalent to :ref:`GeometryInstance3D.gi_lightmap_scale`) and lightmap atlas slice must also be specified. @@ -7916,7 +8150,7 @@ Sets the lightmap GI instance to use for the specified 3D geometry instance. The .. rst-class:: classref-method -void **instance_geometry_set_lod_bias** **(** :ref:`RID` instance, :ref:`float` lod_bias **)** +|void| **instance_geometry_set_lod_bias**\ (\ instance\: :ref:`RID`, lod_bias\: :ref:`float`\ ) Sets the level of detail bias to use when rendering the specified 3D geometry instance. Higher values result in higher detail from further away. Equivalent to :ref:`GeometryInstance3D.lod_bias`. @@ -7928,7 +8162,7 @@ Sets the level of detail bias to use when rendering the specified 3D geometry in .. rst-class:: classref-method -void **instance_geometry_set_material_overlay** **(** :ref:`RID` instance, :ref:`RID` material **)** +|void| **instance_geometry_set_material_overlay**\ (\ instance\: :ref:`RID`, material\: :ref:`RID`\ ) Sets a material that will be rendered for all surfaces on top of active materials for the mesh associated with this instance. Equivalent to :ref:`GeometryInstance3D.material_overlay`. @@ -7940,7 +8174,7 @@ Sets a material that will be rendered for all surfaces on top of active material .. rst-class:: classref-method -void **instance_geometry_set_material_override** **(** :ref:`RID` instance, :ref:`RID` material **)** +|void| **instance_geometry_set_material_override**\ (\ instance\: :ref:`RID`, material\: :ref:`RID`\ ) Sets a material that will override the material for all surfaces on the mesh associated with this instance. Equivalent to :ref:`GeometryInstance3D.material_override`. @@ -7952,7 +8186,7 @@ Sets a material that will override the material for all surfaces on the mesh ass .. rst-class:: classref-method -void **instance_geometry_set_shader_parameter** **(** :ref:`RID` instance, :ref:`StringName` parameter, :ref:`Variant` value **)** +|void| **instance_geometry_set_shader_parameter**\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`, value\: :ref:`Variant`\ ) Sets the per-instance shader uniform on the specified 3D geometry instance. Equivalent to :ref:`GeometryInstance3D.set_instance_shader_parameter`. @@ -7964,7 +8198,7 @@ Sets the per-instance shader uniform on the specified 3D geometry instance. Equi .. rst-class:: classref-method -void **instance_geometry_set_transparency** **(** :ref:`RID` instance, :ref:`float` transparency **)** +|void| **instance_geometry_set_transparency**\ (\ instance\: :ref:`RID`, transparency\: :ref:`float`\ ) Sets the transparency for the given geometry instance. Equivalent to :ref:`GeometryInstance3D.transparency`. @@ -7982,7 +8216,7 @@ In spatial shaders, ``1.0 - transparency`` is set as the default value of the `` .. rst-class:: classref-method -void **instance_geometry_set_visibility_range** **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin, :ref:`VisibilityRangeFadeMode` fade_mode **)** +|void| **instance_geometry_set_visibility_range**\ (\ instance\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`, min_margin\: :ref:`float`, max_margin\: :ref:`float`, fade_mode\: :ref:`VisibilityRangeFadeMode`\ ) Sets the visibility range values for the given geometry instance. Equivalent to :ref:`GeometryInstance3D.visibility_range_begin` and related properties. @@ -7994,7 +8228,7 @@ Sets the visibility range values for the given geometry instance. Equivalent to .. rst-class:: classref-method -void **instance_set_base** **(** :ref:`RID` instance, :ref:`RID` base **)** +|void| **instance_set_base**\ (\ instance\: :ref:`RID`, base\: :ref:`RID`\ ) Sets the base of the instance. A base can be any of the 3D objects that are created in the RenderingServer that can be displayed. For example, any of the light types, mesh, multimesh, particle system, reflection probe, decal, lightmap, voxel GI and visibility notifiers are all types that can be set as the base of an instance in order to be displayed in the scenario. @@ -8006,7 +8240,7 @@ Sets the base of the instance. A base can be any of the 3D objects that are crea .. rst-class:: classref-method -void **instance_set_blend_shape_weight** **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** +|void| **instance_set_blend_shape_weight**\ (\ instance\: :ref:`RID`, shape\: :ref:`int`, weight\: :ref:`float`\ ) Sets the weight for a given blend shape associated with this instance. @@ -8018,7 +8252,7 @@ Sets the weight for a given blend shape associated with this instance. .. rst-class:: classref-method -void **instance_set_custom_aabb** **(** :ref:`RID` instance, :ref:`AABB` aabb **)** +|void| **instance_set_custom_aabb**\ (\ instance\: :ref:`RID`, aabb\: :ref:`AABB`\ ) Sets a custom AABB to use when culling objects from the view frustum. Equivalent to setting :ref:`GeometryInstance3D.custom_aabb`. @@ -8030,7 +8264,7 @@ Sets a custom AABB to use when culling objects from the view frustum. Equivalent .. rst-class:: classref-method -void **instance_set_extra_visibility_margin** **(** :ref:`RID` instance, :ref:`float` margin **)** +|void| **instance_set_extra_visibility_margin**\ (\ instance\: :ref:`RID`, margin\: :ref:`float`\ ) Sets a margin to increase the size of the AABB when culling objects from the view frustum. This allows you to avoid culling objects that fall outside the view frustum. Equivalent to :ref:`GeometryInstance3D.extra_cull_margin`. @@ -8042,7 +8276,7 @@ Sets a margin to increase the size of the AABB when culling objects from the vie .. rst-class:: classref-method -void **instance_set_ignore_culling** **(** :ref:`RID` instance, :ref:`bool` enabled **)** +|void| **instance_set_ignore_culling**\ (\ instance\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``true``, ignores both frustum and occlusion culling on the specified 3D geometry instance. This is not the same as :ref:`GeometryInstance3D.ignore_occlusion_culling`, which only ignores occlusion culling and leaves frustum culling intact. @@ -8054,7 +8288,7 @@ If ``true``, ignores both frustum and occlusion culling on the specified 3D geom .. rst-class:: classref-method -void **instance_set_layer_mask** **(** :ref:`RID` instance, :ref:`int` mask **)** +|void| **instance_set_layer_mask**\ (\ instance\: :ref:`RID`, mask\: :ref:`int`\ ) Sets the render layers that this instance will be drawn to. Equivalent to :ref:`VisualInstance3D.layers`. @@ -8066,7 +8300,7 @@ Sets the render layers that this instance will be drawn to. Equivalent to :ref:` .. rst-class:: classref-method -void **instance_set_pivot_data** **(** :ref:`RID` instance, :ref:`float` sorting_offset, :ref:`bool` use_aabb_center **)** +|void| **instance_set_pivot_data**\ (\ instance\: :ref:`RID`, sorting_offset\: :ref:`float`, use_aabb_center\: :ref:`bool`\ ) Sets the sorting offset and switches between using the bounding box or instance origin for depth sorting. @@ -8078,7 +8312,7 @@ Sets the sorting offset and switches between using the bounding box or instance .. rst-class:: classref-method -void **instance_set_scenario** **(** :ref:`RID` instance, :ref:`RID` scenario **)** +|void| **instance_set_scenario**\ (\ instance\: :ref:`RID`, scenario\: :ref:`RID`\ ) Sets the scenario that the instance is in. The scenario is the 3D world that the objects will be displayed in. @@ -8090,7 +8324,7 @@ Sets the scenario that the instance is in. The scenario is the 3D world that the .. rst-class:: classref-method -void **instance_set_surface_override_material** **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** +|void| **instance_set_surface_override_material**\ (\ instance\: :ref:`RID`, surface\: :ref:`int`, material\: :ref:`RID`\ ) Sets the override material of a specific surface. Equivalent to :ref:`MeshInstance3D.set_surface_override_material`. @@ -8102,7 +8336,7 @@ Sets the override material of a specific surface. Equivalent to :ref:`MeshInstan .. rst-class:: classref-method -void **instance_set_transform** **(** :ref:`RID` instance, :ref:`Transform3D` transform **)** +|void| **instance_set_transform**\ (\ instance\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) Sets the world space transform of the instance. Equivalent to :ref:`Node3D.transform`. @@ -8114,7 +8348,7 @@ Sets the world space transform of the instance. Equivalent to :ref:`Node3D.trans .. rst-class:: classref-method -void **instance_set_visibility_parent** **(** :ref:`RID` instance, :ref:`RID` parent **)** +|void| **instance_set_visibility_parent**\ (\ instance\: :ref:`RID`, parent\: :ref:`RID`\ ) Sets the visibility parent for the given instance. Equivalent to :ref:`Node3D.visibility_parent`. @@ -8126,7 +8360,7 @@ Sets the visibility parent for the given instance. Equivalent to :ref:`Node3D.vi .. rst-class:: classref-method -void **instance_set_visible** **(** :ref:`RID` instance, :ref:`bool` visible **)** +|void| **instance_set_visible**\ (\ instance\: :ref:`RID`, visible\: :ref:`bool`\ ) Sets whether an instance is drawn or not. Equivalent to :ref:`Node3D.visible`. @@ -8138,7 +8372,7 @@ Sets whether an instance is drawn or not. Equivalent to :ref:`Node3D.visible` **instances_cull_aabb** **(** :ref:`AABB` aabb, :ref:`RID` scenario=RID() **)** |const| +:ref:`PackedInt64Array` **instances_cull_aabb**\ (\ aabb\: :ref:`AABB`, scenario\: :ref:`RID` = RID()\ ) |const| Returns an array of object IDs intersecting with the provided AABB. Only 3D nodes that inherit from :ref:`VisualInstance3D` are considered, such as :ref:`MeshInstance3D` or :ref:`DirectionalLight3D`. Use :ref:`@GlobalScope.instance_from_id` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World3D` you want to query. This forces an update for all resources queued to update. @@ -8152,7 +8386,7 @@ Returns an array of object IDs intersecting with the provided AABB. Only 3D node .. rst-class:: classref-method -:ref:`PackedInt64Array` **instances_cull_convex** **(** :ref:`Plane[]` convex, :ref:`RID` scenario=RID() **)** |const| +:ref:`PackedInt64Array` **instances_cull_convex**\ (\ convex\: :ref:`Array`\[:ref:`Plane`\], scenario\: :ref:`RID` = RID()\ ) |const| Returns an array of object IDs intersecting with the provided convex shape. Only 3D nodes that inherit from :ref:`VisualInstance3D` are considered, such as :ref:`MeshInstance3D` or :ref:`DirectionalLight3D`. Use :ref:`@GlobalScope.instance_from_id` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World3D` you want to query. This forces an update for all resources queued to update. @@ -8166,7 +8400,7 @@ Returns an array of object IDs intersecting with the provided convex shape. Only .. rst-class:: classref-method -:ref:`PackedInt64Array` **instances_cull_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario=RID() **)** |const| +:ref:`PackedInt64Array` **instances_cull_ray**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, scenario\: :ref:`RID` = RID()\ ) |const| Returns an array of object IDs intersecting with the provided 3D ray. Only 3D nodes that inherit from :ref:`VisualInstance3D` are considered, such as :ref:`MeshInstance3D` or :ref:`DirectionalLight3D`. Use :ref:`@GlobalScope.instance_from_id` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World3D` you want to query. This forces an update for all resources queued to update. @@ -8180,7 +8414,7 @@ Returns an array of object IDs intersecting with the provided 3D ray. Only 3D no .. rst-class:: classref-method -void **light_directional_set_blend_splits** **(** :ref:`RID` light, :ref:`bool` enable **)** +|void| **light_directional_set_blend_splits**\ (\ light\: :ref:`RID`, enable\: :ref:`bool`\ ) If ``true``, this directional light will blend between shadow map splits resulting in a smoother transition between them. Equivalent to :ref:`DirectionalLight3D.directional_shadow_blend_splits`. @@ -8192,7 +8426,7 @@ If ``true``, this directional light will blend between shadow map splits resulti .. rst-class:: classref-method -void **light_directional_set_shadow_mode** **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** +|void| **light_directional_set_shadow_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`LightDirectionalShadowMode`\ ) Sets the shadow mode for this directional light. Equivalent to :ref:`DirectionalLight3D.directional_shadow_mode`. See :ref:`LightDirectionalShadowMode` for options. @@ -8204,7 +8438,7 @@ Sets the shadow mode for this directional light. Equivalent to :ref:`Directional .. rst-class:: classref-method -void **light_directional_set_sky_mode** **(** :ref:`RID` light, :ref:`LightDirectionalSkyMode` mode **)** +|void| **light_directional_set_sky_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`LightDirectionalSkyMode`\ ) If ``true``, this light will not be used for anything except sky shaders. Use this for lights that impact your sky shader that you may want to hide from affecting the rest of the scene. For example, you may want to enable this when the sun in your sky shader falls below the horizon. @@ -8216,7 +8450,7 @@ If ``true``, this light will not be used for anything except sky shaders. Use th .. rst-class:: classref-method -void **light_omni_set_shadow_mode** **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** +|void| **light_omni_set_shadow_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`LightOmniShadowMode`\ ) Sets whether to use a dual paraboloid or a cubemap for the shadow map. Dual paraboloid is faster but may suffer from artifacts. Equivalent to :ref:`OmniLight3D.omni_shadow_mode`. @@ -8228,7 +8462,7 @@ Sets whether to use a dual paraboloid or a cubemap for the shadow map. Dual para .. rst-class:: classref-method -void **light_projectors_set_filter** **(** :ref:`LightProjectorFilter` filter **)** +|void| **light_projectors_set_filter**\ (\ filter\: :ref:`LightProjectorFilter`\ ) Sets the texture filter mode to use when rendering light projectors. This parameter is global and cannot be set on a per-light basis. @@ -8240,7 +8474,7 @@ Sets the texture filter mode to use when rendering light projectors. This parame .. rst-class:: classref-method -void **light_set_bake_mode** **(** :ref:`RID` light, :ref:`LightBakeMode` bake_mode **)** +|void| **light_set_bake_mode**\ (\ light\: :ref:`RID`, bake_mode\: :ref:`LightBakeMode`\ ) Sets the bake mode to use for the specified 3D light. Equivalent to :ref:`Light3D.light_bake_mode`. @@ -8252,7 +8486,7 @@ Sets the bake mode to use for the specified 3D light. Equivalent to :ref:`Light3 .. rst-class:: classref-method -void **light_set_color** **(** :ref:`RID` light, :ref:`Color` color **)** +|void| **light_set_color**\ (\ light\: :ref:`RID`, color\: :ref:`Color`\ ) Sets the color of the light. Equivalent to :ref:`Light3D.light_color`. @@ -8264,7 +8498,7 @@ Sets the color of the light. Equivalent to :ref:`Light3D.light_color` light, :ref:`int` mask **)** +|void| **light_set_cull_mask**\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) Sets the cull mask for this 3D light. Lights only affect objects in the selected layers. Equivalent to :ref:`Light3D.light_cull_mask`. @@ -8276,7 +8510,7 @@ Sets the cull mask for this 3D light. Lights only affect objects in the selected .. rst-class:: classref-method -void **light_set_distance_fade** **(** :ref:`RID` decal, :ref:`bool` enabled, :ref:`float` begin, :ref:`float` shadow, :ref:`float` length **)** +|void| **light_set_distance_fade**\ (\ decal\: :ref:`RID`, enabled\: :ref:`bool`, begin\: :ref:`float`, shadow\: :ref:`float`, length\: :ref:`float`\ ) Sets the distance fade for this 3D light. This acts as a form of level of detail (LOD) and can be used to improve performance. Equivalent to :ref:`Light3D.distance_fade_enabled`, :ref:`Light3D.distance_fade_begin`, :ref:`Light3D.distance_fade_shadow`, and :ref:`Light3D.distance_fade_length`. @@ -8288,7 +8522,7 @@ Sets the distance fade for this 3D light. This acts as a form of level of detail .. rst-class:: classref-method -void **light_set_max_sdfgi_cascade** **(** :ref:`RID` light, :ref:`int` cascade **)** +|void| **light_set_max_sdfgi_cascade**\ (\ light\: :ref:`RID`, cascade\: :ref:`int`\ ) Sets the maximum SDFGI cascade in which the 3D light's indirect lighting is rendered. Higher values allow the light to be rendered in SDFGI further away from the camera. @@ -8300,7 +8534,7 @@ Sets the maximum SDFGI cascade in which the 3D light's indirect lighting is rend .. rst-class:: classref-method -void **light_set_negative** **(** :ref:`RID` light, :ref:`bool` enable **)** +|void| **light_set_negative**\ (\ light\: :ref:`RID`, enable\: :ref:`bool`\ ) If ``true``, the 3D light will subtract light instead of adding light. Equivalent to :ref:`Light3D.light_negative`. @@ -8312,7 +8546,7 @@ If ``true``, the 3D light will subtract light instead of adding light. Equivalen .. rst-class:: classref-method -void **light_set_param** **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** +|void| **light_set_param**\ (\ light\: :ref:`RID`, param\: :ref:`LightParam`, value\: :ref:`float`\ ) Sets the specified 3D light parameter. See :ref:`LightParam` for options. Equivalent to :ref:`Light3D.set_param`. @@ -8324,7 +8558,7 @@ Sets the specified 3D light parameter. See :ref:`LightParam` light, :ref:`RID` texture **)** +|void| **light_set_projector**\ (\ light\: :ref:`RID`, texture\: :ref:`RID`\ ) Sets the projector texture to use for the specified 3D light. Equivalent to :ref:`Light3D.light_projector`. @@ -8336,7 +8570,7 @@ Sets the projector texture to use for the specified 3D light. Equivalent to :ref .. rst-class:: classref-method -void **light_set_reverse_cull_face_mode** **(** :ref:`RID` light, :ref:`bool` enabled **)** +|void| **light_set_reverse_cull_face_mode**\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``true``, reverses the backface culling of the mesh. This can be useful when you have a flat mesh that has a light behind it. If you need to cast a shadow on both sides of the mesh, set the mesh to use double-sided shadows with :ref:`instance_geometry_set_cast_shadows_setting`. Equivalent to :ref:`Light3D.shadow_reverse_cull_face`. @@ -8348,7 +8582,7 @@ If ``true``, reverses the backface culling of the mesh. This can be useful when .. rst-class:: classref-method -void **light_set_shadow** **(** :ref:`RID` light, :ref:`bool` enabled **)** +|void| **light_set_shadow**\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``true``, light will cast shadows. Equivalent to :ref:`Light3D.shadow_enabled`. @@ -8360,7 +8594,7 @@ If ``true``, light will cast shadows. Equivalent to :ref:`Light3D.shadow_enabled .. rst-class:: classref-method -:ref:`RID` **lightmap_create** **(** **)** +:ref:`RID` **lightmap_create**\ (\ ) Creates a new lightmap global illumination instance and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``lightmap_*`` RenderingServer functions. @@ -8376,7 +8610,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`PackedInt32Array` **lightmap_get_probe_capture_bsp_tree** **(** :ref:`RID` lightmap **)** |const| +:ref:`PackedInt32Array` **lightmap_get_probe_capture_bsp_tree**\ (\ lightmap\: :ref:`RID`\ ) |const| .. container:: contribute @@ -8390,7 +8624,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`PackedVector3Array` **lightmap_get_probe_capture_points** **(** :ref:`RID` lightmap **)** |const| +:ref:`PackedVector3Array` **lightmap_get_probe_capture_points**\ (\ lightmap\: :ref:`RID`\ ) |const| .. container:: contribute @@ -8404,7 +8638,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`PackedColorArray` **lightmap_get_probe_capture_sh** **(** :ref:`RID` lightmap **)** |const| +:ref:`PackedColorArray` **lightmap_get_probe_capture_sh**\ (\ lightmap\: :ref:`RID`\ ) |const| .. container:: contribute @@ -8418,7 +8652,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`PackedInt32Array` **lightmap_get_probe_capture_tetrahedra** **(** :ref:`RID` lightmap **)** |const| +:ref:`PackedInt32Array` **lightmap_get_probe_capture_tetrahedra**\ (\ lightmap\: :ref:`RID`\ ) |const| .. container:: contribute @@ -8432,7 +8666,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -void **lightmap_set_baked_exposure_normalization** **(** :ref:`RID` lightmap, :ref:`float` baked_exposure **)** +|void| **lightmap_set_baked_exposure_normalization**\ (\ lightmap\: :ref:`RID`, baked_exposure\: :ref:`float`\ ) Used to inform the renderer what exposure normalization value was used while baking the lightmap. This value will be used and modulated at run time to ensure that the lightmap maintains a consistent level of exposure even if the scene-wide exposure normalization is changed at run time. For more information see :ref:`camera_attributes_set_exposure`. @@ -8444,7 +8678,7 @@ Used to inform the renderer what exposure normalization value was used while bak .. rst-class:: classref-method -void **lightmap_set_probe_bounds** **(** :ref:`RID` lightmap, :ref:`AABB` bounds **)** +|void| **lightmap_set_probe_bounds**\ (\ lightmap\: :ref:`RID`, bounds\: :ref:`AABB`\ ) .. container:: contribute @@ -8458,7 +8692,7 @@ void **lightmap_set_probe_bounds** **(** :ref:`RID` lightmap, :ref:`A .. rst-class:: classref-method -void **lightmap_set_probe_capture_data** **(** :ref:`RID` lightmap, :ref:`PackedVector3Array` points, :ref:`PackedColorArray` point_sh, :ref:`PackedInt32Array` tetrahedra, :ref:`PackedInt32Array` bsp_tree **)** +|void| **lightmap_set_probe_capture_data**\ (\ lightmap\: :ref:`RID`, points\: :ref:`PackedVector3Array`, point_sh\: :ref:`PackedColorArray`, tetrahedra\: :ref:`PackedInt32Array`, bsp_tree\: :ref:`PackedInt32Array`\ ) .. container:: contribute @@ -8472,7 +8706,7 @@ void **lightmap_set_probe_capture_data** **(** :ref:`RID` lightmap, : .. rst-class:: classref-method -void **lightmap_set_probe_capture_update_speed** **(** :ref:`float` speed **)** +|void| **lightmap_set_probe_capture_update_speed**\ (\ speed\: :ref:`float`\ ) .. container:: contribute @@ -8486,7 +8720,7 @@ void **lightmap_set_probe_capture_update_speed** **(** :ref:`float` .. rst-class:: classref-method -void **lightmap_set_probe_interior** **(** :ref:`RID` lightmap, :ref:`bool` interior **)** +|void| **lightmap_set_probe_interior**\ (\ lightmap\: :ref:`RID`, interior\: :ref:`bool`\ ) .. container:: contribute @@ -8500,7 +8734,7 @@ void **lightmap_set_probe_interior** **(** :ref:`RID` lightmap, :ref: .. rst-class:: classref-method -void **lightmap_set_textures** **(** :ref:`RID` lightmap, :ref:`RID` light, :ref:`bool` uses_sh **)** +|void| **lightmap_set_textures**\ (\ lightmap\: :ref:`RID`, light\: :ref:`RID`, uses_sh\: :ref:`bool`\ ) Set the textures on the given ``lightmap`` GI instance to the texture array pointed to by the ``light`` RID. If the lightmap texture was baked with :ref:`LightmapGI.directional` set to ``true``, then ``uses_sh`` must also be ``true``. @@ -8512,7 +8746,7 @@ Set the textures on the given ``lightmap`` GI instance to the texture array poin .. rst-class:: classref-method -:ref:`RID` **make_sphere_mesh** **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** +:ref:`RID` **make_sphere_mesh**\ (\ latitudes\: :ref:`int`, longitudes\: :ref:`int`, radius\: :ref:`float`\ ) Returns a mesh of a sphere with the given number of horizontal subdivisions, vertical subdivisions and radius. See also :ref:`get_test_cube`. @@ -8524,7 +8758,7 @@ Returns a mesh of a sphere with the given number of horizontal subdivisions, ver .. rst-class:: classref-method -:ref:`RID` **material_create** **(** **)** +:ref:`RID` **material_create**\ (\ ) Creates an empty material and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``material_*`` RenderingServer functions. @@ -8540,7 +8774,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`Variant` **material_get_param** **(** :ref:`RID` material, :ref:`StringName` parameter **)** |const| +:ref:`Variant` **material_get_param**\ (\ material\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| Returns the value of a certain material's parameter. @@ -8552,7 +8786,7 @@ Returns the value of a certain material's parameter. .. rst-class:: classref-method -void **material_set_next_pass** **(** :ref:`RID` material, :ref:`RID` next_material **)** +|void| **material_set_next_pass**\ (\ material\: :ref:`RID`, next_material\: :ref:`RID`\ ) Sets an object's next material. @@ -8564,7 +8798,7 @@ Sets an object's next material. .. rst-class:: classref-method -void **material_set_param** **(** :ref:`RID` material, :ref:`StringName` parameter, :ref:`Variant` value **)** +|void| **material_set_param**\ (\ material\: :ref:`RID`, parameter\: :ref:`StringName`, value\: :ref:`Variant`\ ) Sets a material's parameter. @@ -8576,7 +8810,7 @@ Sets a material's parameter. .. rst-class:: classref-method -void **material_set_render_priority** **(** :ref:`RID` material, :ref:`int` priority **)** +|void| **material_set_render_priority**\ (\ material\: :ref:`RID`, priority\: :ref:`int`\ ) Sets a material's render priority. @@ -8588,7 +8822,7 @@ Sets a material's render priority. .. rst-class:: classref-method -void **material_set_shader** **(** :ref:`RID` shader_material, :ref:`RID` shader **)** +|void| **material_set_shader**\ (\ shader_material\: :ref:`RID`, shader\: :ref:`RID`\ ) Sets a shader material's shader. @@ -8600,7 +8834,7 @@ Sets a shader material's shader. .. rst-class:: classref-method -void **mesh_add_surface** **(** :ref:`RID` mesh, :ref:`Dictionary` surface **)** +|void| **mesh_add_surface**\ (\ mesh\: :ref:`RID`, surface\: :ref:`Dictionary`\ ) .. container:: contribute @@ -8614,7 +8848,7 @@ void **mesh_add_surface** **(** :ref:`RID` mesh, :ref:`Dictionary` mesh, :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[], :ref:`Dictionary` lods={}, |bitfield|\<:ref:`ArrayFormat`\> compress_format=0 **)** +|void| **mesh_add_surface_from_arrays**\ (\ mesh\: :ref:`RID`, primitive\: :ref:`PrimitiveType`, arrays\: :ref:`Array`, blend_shapes\: :ref:`Array` = [], lods\: :ref:`Dictionary` = {}, compress_format\: |bitfield|\[:ref:`ArrayFormat`\] = 0\ ) .. container:: contribute @@ -8628,7 +8862,7 @@ void **mesh_add_surface_from_arrays** **(** :ref:`RID` mesh, :ref:`Pr .. rst-class:: classref-method -void **mesh_clear** **(** :ref:`RID` mesh **)** +|void| **mesh_clear**\ (\ mesh\: :ref:`RID`\ ) Removes all surfaces from a mesh. @@ -8640,7 +8874,7 @@ Removes all surfaces from a mesh. .. rst-class:: classref-method -:ref:`RID` **mesh_create** **(** **)** +:ref:`RID` **mesh_create**\ (\ ) Creates a new mesh and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``mesh_*`` RenderingServer functions. @@ -8658,7 +8892,7 @@ To place in a scene, attach this mesh to an instance using :ref:`instance_set_ba .. rst-class:: classref-method -:ref:`RID` **mesh_create_from_surfaces** **(** :ref:`Dictionary[]` surfaces, :ref:`int` blend_shape_count=0 **)** +:ref:`RID` **mesh_create_from_surfaces**\ (\ surfaces\: :ref:`Array`\[:ref:`Dictionary`\], blend_shape_count\: :ref:`int` = 0\ ) .. container:: contribute @@ -8672,7 +8906,7 @@ To place in a scene, attach this mesh to an instance using :ref:`instance_set_ba .. rst-class:: classref-method -:ref:`int` **mesh_get_blend_shape_count** **(** :ref:`RID` mesh **)** |const| +:ref:`int` **mesh_get_blend_shape_count**\ (\ mesh\: :ref:`RID`\ ) |const| Returns a mesh's blend shape count. @@ -8684,7 +8918,7 @@ Returns a mesh's blend shape count. .. rst-class:: classref-method -:ref:`BlendShapeMode` **mesh_get_blend_shape_mode** **(** :ref:`RID` mesh **)** |const| +:ref:`BlendShapeMode` **mesh_get_blend_shape_mode**\ (\ mesh\: :ref:`RID`\ ) |const| Returns a mesh's blend shape mode. @@ -8696,7 +8930,7 @@ Returns a mesh's blend shape mode. .. rst-class:: classref-method -:ref:`AABB` **mesh_get_custom_aabb** **(** :ref:`RID` mesh **)** |const| +:ref:`AABB` **mesh_get_custom_aabb**\ (\ mesh\: :ref:`RID`\ ) |const| Returns a mesh's custom aabb. @@ -8708,7 +8942,7 @@ Returns a mesh's custom aabb. .. rst-class:: classref-method -:ref:`Dictionary` **mesh_get_surface** **(** :ref:`RID` mesh, :ref:`int` surface **)** +:ref:`Dictionary` **mesh_get_surface**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) .. container:: contribute @@ -8722,7 +8956,7 @@ Returns a mesh's custom aabb. .. rst-class:: classref-method -:ref:`int` **mesh_get_surface_count** **(** :ref:`RID` mesh **)** |const| +:ref:`int` **mesh_get_surface_count**\ (\ mesh\: :ref:`RID`\ ) |const| Returns a mesh's number of surfaces. @@ -8734,7 +8968,7 @@ Returns a mesh's number of surfaces. .. rst-class:: classref-method -void **mesh_set_blend_shape_mode** **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** +|void| **mesh_set_blend_shape_mode**\ (\ mesh\: :ref:`RID`, mode\: :ref:`BlendShapeMode`\ ) Sets a mesh's blend shape mode. @@ -8746,7 +8980,7 @@ Sets a mesh's blend shape mode. .. rst-class:: classref-method -void **mesh_set_custom_aabb** **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** +|void| **mesh_set_custom_aabb**\ (\ mesh\: :ref:`RID`, aabb\: :ref:`AABB`\ ) Sets a mesh's custom aabb. @@ -8758,7 +8992,7 @@ Sets a mesh's custom aabb. .. rst-class:: classref-method -void **mesh_set_shadow_mesh** **(** :ref:`RID` mesh, :ref:`RID` shadow_mesh **)** +|void| **mesh_set_shadow_mesh**\ (\ mesh\: :ref:`RID`, shadow_mesh\: :ref:`RID`\ ) .. container:: contribute @@ -8772,7 +9006,7 @@ void **mesh_set_shadow_mesh** **(** :ref:`RID` mesh, :ref:`RID` **mesh_surface_get_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| +:ref:`Array` **mesh_surface_get_arrays**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) |const| Returns a mesh's surface's buffer arrays. @@ -8784,7 +9018,7 @@ Returns a mesh's surface's buffer arrays. .. rst-class:: classref-method -:ref:`Array[]` **mesh_surface_get_blend_shape_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| +:ref:`Array`\[:ref:`Array`\] **mesh_surface_get_blend_shape_arrays**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) |const| Returns a mesh's surface's arrays for blend shapes. @@ -8796,7 +9030,7 @@ Returns a mesh's surface's arrays for blend shapes. .. rst-class:: classref-method -:ref:`int` **mesh_surface_get_format_attribute_stride** **(** |bitfield|\<:ref:`ArrayFormat`\> format, :ref:`int` vertex_count **)** |const| +:ref:`int` **mesh_surface_get_format_attribute_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| Returns the stride of the attribute buffer for a mesh with given ``format``. @@ -8808,7 +9042,7 @@ Returns the stride of the attribute buffer for a mesh with given ``format``. .. rst-class:: classref-method -:ref:`int` **mesh_surface_get_format_normal_tangent_stride** **(** |bitfield|\<:ref:`ArrayFormat`\> format, :ref:`int` vertex_count **)** |const| +:ref:`int` **mesh_surface_get_format_normal_tangent_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| Returns the stride of the combined normals and tangents for a mesh with given ``format``. Note importantly that, while normals and tangents are in the vertex buffer with vertices, they are only interleaved with each other and so have a different stride than vertex positions. @@ -8820,7 +9054,7 @@ Returns the stride of the combined normals and tangents for a mesh with given `` .. rst-class:: classref-method -:ref:`int` **mesh_surface_get_format_offset** **(** |bitfield|\<:ref:`ArrayFormat`\> format, :ref:`int` vertex_count, :ref:`int` array_index **)** |const| +:ref:`int` **mesh_surface_get_format_offset**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`, array_index\: :ref:`int`\ ) |const| Returns the offset of a given attribute by ``array_index`` in the start of its respective buffer. @@ -8832,7 +9066,7 @@ Returns the offset of a given attribute by ``array_index`` in the start of its r .. rst-class:: classref-method -:ref:`int` **mesh_surface_get_format_skin_stride** **(** |bitfield|\<:ref:`ArrayFormat`\> format, :ref:`int` vertex_count **)** |const| +:ref:`int` **mesh_surface_get_format_skin_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| Returns the stride of the skin buffer for a mesh with given ``format``. @@ -8844,7 +9078,7 @@ Returns the stride of the skin buffer for a mesh with given ``format``. .. rst-class:: classref-method -:ref:`int` **mesh_surface_get_format_vertex_stride** **(** |bitfield|\<:ref:`ArrayFormat`\> format, :ref:`int` vertex_count **)** |const| +:ref:`int` **mesh_surface_get_format_vertex_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| Returns the stride of the vertex positions for a mesh with given ``format``. Note importantly that vertex positions are stored consecutively and are not interleaved with the other attributes in the vertex buffer (normals and tangents). @@ -8856,7 +9090,7 @@ Returns the stride of the vertex positions for a mesh with given ``format``. Not .. rst-class:: classref-method -:ref:`RID` **mesh_surface_get_material** **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| +:ref:`RID` **mesh_surface_get_material**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) |const| Returns a mesh's surface's material. @@ -8868,7 +9102,7 @@ Returns a mesh's surface's material. .. rst-class:: classref-method -void **mesh_surface_set_material** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** +|void| **mesh_surface_set_material**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, material\: :ref:`RID`\ ) Sets a mesh's surface's material. @@ -8880,7 +9114,7 @@ Sets a mesh's surface's material. .. rst-class:: classref-method -void **mesh_surface_update_attribute_region** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** +|void| **mesh_surface_update_attribute_region**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) .. container:: contribute @@ -8894,7 +9128,7 @@ void **mesh_surface_update_attribute_region** **(** :ref:`RID` mesh, .. rst-class:: classref-method -void **mesh_surface_update_skin_region** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** +|void| **mesh_surface_update_skin_region**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) .. container:: contribute @@ -8908,7 +9142,7 @@ void **mesh_surface_update_skin_region** **(** :ref:`RID` mesh, :ref: .. rst-class:: classref-method -void **mesh_surface_update_vertex_region** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** +|void| **mesh_surface_update_vertex_region**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) .. container:: contribute @@ -8922,7 +9156,7 @@ void **mesh_surface_update_vertex_region** **(** :ref:`RID` mesh, :re .. rst-class:: classref-method -void **multimesh_allocate_data** **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`bool` color_format=false, :ref:`bool` custom_data_format=false **)** +|void| **multimesh_allocate_data**\ (\ multimesh\: :ref:`RID`, instances\: :ref:`int`, transform_format\: :ref:`MultimeshTransformFormat`, color_format\: :ref:`bool` = false, custom_data_format\: :ref:`bool` = false\ ) .. container:: contribute @@ -8936,7 +9170,7 @@ void **multimesh_allocate_data** **(** :ref:`RID` multimesh, :ref:`in .. rst-class:: classref-method -:ref:`RID` **multimesh_create** **(** **)** +:ref:`RID` **multimesh_create**\ (\ ) Creates a new multimesh on the RenderingServer and returns an :ref:`RID` handle. This RID will be used in all ``multimesh_*`` RenderingServer functions. @@ -8954,7 +9188,7 @@ To place in a scene, attach this multimesh to an instance using :ref:`instance_s .. rst-class:: classref-method -:ref:`AABB` **multimesh_get_aabb** **(** :ref:`RID` multimesh **)** |const| +:ref:`AABB` **multimesh_get_aabb**\ (\ multimesh\: :ref:`RID`\ ) |const| Calculates and returns the axis-aligned bounding box that encloses all instances within the multimesh. @@ -8966,7 +9200,7 @@ Calculates and returns the axis-aligned bounding box that encloses all instances .. rst-class:: classref-method -:ref:`PackedFloat32Array` **multimesh_get_buffer** **(** :ref:`RID` multimesh **)** |const| +:ref:`PackedFloat32Array` **multimesh_get_buffer**\ (\ multimesh\: :ref:`RID`\ ) |const| Returns the MultiMesh data (such as instance transforms, colors, etc). See :ref:`multimesh_set_buffer` for a description of the returned data. @@ -8980,7 +9214,7 @@ Returns the MultiMesh data (such as instance transforms, colors, etc). See :ref: .. rst-class:: classref-method -:ref:`AABB` **multimesh_get_custom_aabb** **(** :ref:`RID` multimesh **)** |const| +:ref:`AABB` **multimesh_get_custom_aabb**\ (\ multimesh\: :ref:`RID`\ ) |const| Returns the custom AABB defined for this MultiMesh resource. @@ -8992,7 +9226,7 @@ Returns the custom AABB defined for this MultiMesh resource. .. rst-class:: classref-method -:ref:`int` **multimesh_get_instance_count** **(** :ref:`RID` multimesh **)** |const| +:ref:`int` **multimesh_get_instance_count**\ (\ multimesh\: :ref:`RID`\ ) |const| Returns the number of instances allocated for this multimesh. @@ -9004,7 +9238,7 @@ Returns the number of instances allocated for this multimesh. .. rst-class:: classref-method -:ref:`RID` **multimesh_get_mesh** **(** :ref:`RID` multimesh **)** |const| +:ref:`RID` **multimesh_get_mesh**\ (\ multimesh\: :ref:`RID`\ ) |const| Returns the RID of the mesh that will be used in drawing this multimesh. @@ -9016,7 +9250,7 @@ Returns the RID of the mesh that will be used in drawing this multimesh. .. rst-class:: classref-method -:ref:`int` **multimesh_get_visible_instances** **(** :ref:`RID` multimesh **)** |const| +:ref:`int` **multimesh_get_visible_instances**\ (\ multimesh\: :ref:`RID`\ ) |const| Returns the number of visible instances for this multimesh. @@ -9028,7 +9262,7 @@ Returns the number of visible instances for this multimesh. .. rst-class:: classref-method -:ref:`Color` **multimesh_instance_get_color** **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| +:ref:`Color` **multimesh_instance_get_color**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| Returns the color by which the specified instance will be modulated. @@ -9040,7 +9274,7 @@ Returns the color by which the specified instance will be modulated. .. rst-class:: classref-method -:ref:`Color` **multimesh_instance_get_custom_data** **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| +:ref:`Color` **multimesh_instance_get_custom_data**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| Returns the custom data associated with the specified instance. @@ -9052,7 +9286,7 @@ Returns the custom data associated with the specified instance. .. rst-class:: classref-method -:ref:`Transform3D` **multimesh_instance_get_transform** **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| +:ref:`Transform3D` **multimesh_instance_get_transform**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| Returns the :ref:`Transform3D` of the specified instance. @@ -9064,7 +9298,7 @@ Returns the :ref:`Transform3D` of the specified instance. .. rst-class:: classref-method -:ref:`Transform2D` **multimesh_instance_get_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| +:ref:`Transform2D` **multimesh_instance_get_transform_2d**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| Returns the :ref:`Transform2D` of the specified instance. For use when the multimesh is set to use 2D transforms. @@ -9076,7 +9310,7 @@ Returns the :ref:`Transform2D` of the specified instance. For .. rst-class:: classref-method -void **multimesh_instance_set_color** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** +|void| **multimesh_instance_set_color**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, color\: :ref:`Color`\ ) Sets the color by which this instance will be modulated. Equivalent to :ref:`MultiMesh.set_instance_color`. @@ -9088,7 +9322,7 @@ Sets the color by which this instance will be modulated. Equivalent to :ref:`Mul .. rst-class:: classref-method -void **multimesh_instance_set_custom_data** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** +|void| **multimesh_instance_set_custom_data**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, custom_data\: :ref:`Color`\ ) Sets the custom data for this instance. Custom data is passed as a :ref:`Color`, but is interpreted as a ``vec4`` in the shader. Equivalent to :ref:`MultiMesh.set_instance_custom_data`. @@ -9100,7 +9334,7 @@ Sets the custom data for this instance. Custom data is passed as a :ref:`Color` multimesh, :ref:`int` index, :ref:`Transform3D` transform **)** +|void| **multimesh_instance_set_transform**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, transform\: :ref:`Transform3D`\ ) Sets the :ref:`Transform3D` for this instance. Equivalent to :ref:`MultiMesh.set_instance_transform`. @@ -9112,7 +9346,7 @@ Sets the :ref:`Transform3D` for this instance. Equivalent to .. rst-class:: classref-method -void **multimesh_instance_set_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** +|void| **multimesh_instance_set_transform_2d**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, transform\: :ref:`Transform2D`\ ) Sets the :ref:`Transform2D` for this instance. For use when multimesh is used in 2D. Equivalent to :ref:`MultiMesh.set_instance_transform_2d`. @@ -9124,7 +9358,7 @@ Sets the :ref:`Transform2D` for this instance. For use when m .. rst-class:: classref-method -void **multimesh_set_buffer** **(** :ref:`RID` multimesh, :ref:`PackedFloat32Array` buffer **)** +|void| **multimesh_set_buffer**\ (\ multimesh\: :ref:`RID`, buffer\: :ref:`PackedFloat32Array`\ ) Set the entire data to use for drawing the ``multimesh`` at once to ``buffer`` (such as instance transforms and colors). ``buffer``'s size must match the number of instances multiplied by the per-instance data size (which depends on the enabled MultiMesh fields). Otherwise, an error message is printed and nothing is rendered. See also :ref:`multimesh_get_buffer`. @@ -9151,7 +9385,7 @@ The per-instance data size and expected data order is: .. rst-class:: classref-method -void **multimesh_set_custom_aabb** **(** :ref:`RID` multimesh, :ref:`AABB` aabb **)** +|void| **multimesh_set_custom_aabb**\ (\ multimesh\: :ref:`RID`, aabb\: :ref:`AABB`\ ) Sets the custom AABB for this MultiMesh resource. @@ -9163,7 +9397,7 @@ Sets the custom AABB for this MultiMesh resource. .. rst-class:: classref-method -void **multimesh_set_mesh** **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** +|void| **multimesh_set_mesh**\ (\ multimesh\: :ref:`RID`, mesh\: :ref:`RID`\ ) Sets the mesh to be drawn by the multimesh. Equivalent to :ref:`MultiMesh.mesh`. @@ -9175,7 +9409,7 @@ Sets the mesh to be drawn by the multimesh. Equivalent to :ref:`MultiMesh.mesh` multimesh, :ref:`int` visible **)** +|void| **multimesh_set_visible_instances**\ (\ multimesh\: :ref:`RID`, visible\: :ref:`int`\ ) Sets the number of instances visible at a given time. If -1, all instances that have been allocated are drawn. Equivalent to :ref:`MultiMesh.visible_instance_count`. @@ -9187,7 +9421,7 @@ Sets the number of instances visible at a given time. If -1, all instances that .. rst-class:: classref-method -:ref:`RID` **occluder_create** **(** **)** +:ref:`RID` **occluder_create**\ (\ ) Creates an occluder instance and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``occluder_*`` RenderingServer functions. @@ -9203,7 +9437,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -void **occluder_set_mesh** **(** :ref:`RID` occluder, :ref:`PackedVector3Array` vertices, :ref:`PackedInt32Array` indices **)** +|void| **occluder_set_mesh**\ (\ occluder\: :ref:`RID`, vertices\: :ref:`PackedVector3Array`, indices\: :ref:`PackedInt32Array`\ ) Sets the mesh data for the given occluder RID, which controls the shape of the occlusion culling that will be performed. @@ -9215,7 +9449,7 @@ Sets the mesh data for the given occluder RID, which controls the shape of the o .. rst-class:: classref-method -:ref:`RID` **omni_light_create** **(** **)** +:ref:`RID` **omni_light_create**\ (\ ) Creates a new omni light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most ``light_*`` RenderingServer functions. @@ -9233,7 +9467,7 @@ To place in a scene, attach this omni light to an instance using :ref:`instance_ .. rst-class:: classref-method -:ref:`RID` **particles_collision_create** **(** **)** +:ref:`RID` **particles_collision_create**\ (\ ) Creates a new 3D GPU particle collision or attractor and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most ``particles_collision_*`` RenderingServer functions. @@ -9247,7 +9481,7 @@ Creates a new 3D GPU particle collision or attractor and adds it to the Renderin .. rst-class:: classref-method -void **particles_collision_height_field_update** **(** :ref:`RID` particles_collision **)** +|void| **particles_collision_height_field_update**\ (\ particles_collision\: :ref:`RID`\ ) Requests an update for the 3D GPU particle collision heightfield. This may be automatically called by the 3D GPU particle collision heightfield depending on its :ref:`GPUParticlesCollisionHeightField3D.update_mode`. @@ -9259,7 +9493,7 @@ Requests an update for the 3D GPU particle collision heightfield. This may be au .. rst-class:: classref-method -void **particles_collision_set_attractor_attenuation** **(** :ref:`RID` particles_collision, :ref:`float` curve **)** +|void| **particles_collision_set_attractor_attenuation**\ (\ particles_collision\: :ref:`RID`, curve\: :ref:`float`\ ) Sets the attenuation ``curve`` for the 3D GPU particles attractor specified by the ``particles_collision`` RID. Only used for attractors, not colliders. Equivalent to :ref:`GPUParticlesAttractor3D.attenuation`. @@ -9271,7 +9505,7 @@ Sets the attenuation ``curve`` for the 3D GPU particles attractor specified by t .. rst-class:: classref-method -void **particles_collision_set_attractor_directionality** **(** :ref:`RID` particles_collision, :ref:`float` amount **)** +|void| **particles_collision_set_attractor_directionality**\ (\ particles_collision\: :ref:`RID`, amount\: :ref:`float`\ ) Sets the directionality ``amount`` for the 3D GPU particles attractor specified by the ``particles_collision`` RID. Only used for attractors, not colliders. Equivalent to :ref:`GPUParticlesAttractor3D.directionality`. @@ -9283,7 +9517,7 @@ Sets the directionality ``amount`` for the 3D GPU particles attractor specified .. rst-class:: classref-method -void **particles_collision_set_attractor_strength** **(** :ref:`RID` particles_collision, :ref:`float` strength **)** +|void| **particles_collision_set_attractor_strength**\ (\ particles_collision\: :ref:`RID`, strength\: :ref:`float`\ ) Sets the ``strength`` for the 3D GPU particles attractor specified by the ``particles_collision`` RID. Only used for attractors, not colliders. Equivalent to :ref:`GPUParticlesAttractor3D.strength`. @@ -9295,7 +9529,7 @@ Sets the ``strength`` for the 3D GPU particles attractor specified by the ``part .. rst-class:: classref-method -void **particles_collision_set_box_extents** **(** :ref:`RID` particles_collision, :ref:`Vector3` extents **)** +|void| **particles_collision_set_box_extents**\ (\ particles_collision\: :ref:`RID`, extents\: :ref:`Vector3`\ ) Sets the ``extents`` for the 3D GPU particles collision by the ``particles_collision`` RID. Equivalent to :ref:`GPUParticlesCollisionBox3D.size`, :ref:`GPUParticlesCollisionSDF3D.size`, :ref:`GPUParticlesCollisionHeightField3D.size`, :ref:`GPUParticlesAttractorBox3D.size` or :ref:`GPUParticlesAttractorVectorField3D.size` depending on the ``particles_collision`` type. @@ -9307,7 +9541,7 @@ Sets the ``extents`` for the 3D GPU particles collision by the ``particles_colli .. rst-class:: classref-method -void **particles_collision_set_collision_type** **(** :ref:`RID` particles_collision, :ref:`ParticlesCollisionType` type **)** +|void| **particles_collision_set_collision_type**\ (\ particles_collision\: :ref:`RID`, type\: :ref:`ParticlesCollisionType`\ ) Sets the collision or attractor shape ``type`` for the 3D GPU particles collision or attractor specified by the ``particles_collision`` RID. @@ -9319,7 +9553,7 @@ Sets the collision or attractor shape ``type`` for the 3D GPU particles collisio .. rst-class:: classref-method -void **particles_collision_set_cull_mask** **(** :ref:`RID` particles_collision, :ref:`int` mask **)** +|void| **particles_collision_set_cull_mask**\ (\ particles_collision\: :ref:`RID`, mask\: :ref:`int`\ ) Sets the cull ``mask`` for the 3D GPU particles collision or attractor specified by the ``particles_collision`` RID. Equivalent to :ref:`GPUParticlesCollision3D.cull_mask` or :ref:`GPUParticlesAttractor3D.cull_mask` depending on the ``particles_collision`` type. @@ -9331,7 +9565,7 @@ Sets the cull ``mask`` for the 3D GPU particles collision or attractor specified .. rst-class:: classref-method -void **particles_collision_set_field_texture** **(** :ref:`RID` particles_collision, :ref:`RID` texture **)** +|void| **particles_collision_set_field_texture**\ (\ particles_collision\: :ref:`RID`, texture\: :ref:`RID`\ ) Sets the signed distance field ``texture`` for the 3D GPU particles collision specified by the ``particles_collision`` RID. Equivalent to :ref:`GPUParticlesCollisionSDF3D.texture` or :ref:`GPUParticlesAttractorVectorField3D.texture` depending on the ``particles_collision`` type. @@ -9343,7 +9577,7 @@ Sets the signed distance field ``texture`` for the 3D GPU particles collision sp .. rst-class:: classref-method -void **particles_collision_set_height_field_resolution** **(** :ref:`RID` particles_collision, :ref:`ParticlesCollisionHeightfieldResolution` resolution **)** +|void| **particles_collision_set_height_field_resolution**\ (\ particles_collision\: :ref:`RID`, resolution\: :ref:`ParticlesCollisionHeightfieldResolution`\ ) Sets the heightmap ``resolution`` for the 3D GPU particles heightfield collision specified by the ``particles_collision`` RID. Equivalent to :ref:`GPUParticlesCollisionHeightField3D.resolution`. @@ -9355,7 +9589,7 @@ Sets the heightmap ``resolution`` for the 3D GPU particles heightfield collision .. rst-class:: classref-method -void **particles_collision_set_sphere_radius** **(** :ref:`RID` particles_collision, :ref:`float` radius **)** +|void| **particles_collision_set_sphere_radius**\ (\ particles_collision\: :ref:`RID`, radius\: :ref:`float`\ ) Sets the ``radius`` for the 3D GPU particles sphere collision or attractor specified by the ``particles_collision`` RID. Equivalent to :ref:`GPUParticlesCollisionSphere3D.radius` or :ref:`GPUParticlesAttractorSphere3D.radius` depending on the ``particles_collision`` type. @@ -9367,7 +9601,7 @@ Sets the ``radius`` for the 3D GPU particles sphere collision or attractor speci .. rst-class:: classref-method -:ref:`RID` **particles_create** **(** **)** +:ref:`RID` **particles_create**\ (\ ) Creates a GPU-based particle system and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``particles_*`` RenderingServer functions. @@ -9387,7 +9621,7 @@ To place in a scene, attach these particles to an instance using :ref:`instance_ .. rst-class:: classref-method -void **particles_emit** **(** :ref:`RID` particles, :ref:`Transform3D` transform, :ref:`Vector3` velocity, :ref:`Color` color, :ref:`Color` custom, :ref:`int` emit_flags **)** +|void| **particles_emit**\ (\ particles\: :ref:`RID`, transform\: :ref:`Transform3D`, velocity\: :ref:`Vector3`, color\: :ref:`Color`, custom\: :ref:`Color`, emit_flags\: :ref:`int`\ ) Manually emits particles from the ``particles`` instance. @@ -9399,7 +9633,7 @@ Manually emits particles from the ``particles`` instance. .. rst-class:: classref-method -:ref:`AABB` **particles_get_current_aabb** **(** :ref:`RID` particles **)** +:ref:`AABB` **particles_get_current_aabb**\ (\ particles\: :ref:`RID`\ ) Calculates and returns the axis-aligned bounding box that contains all the particles. Equivalent to :ref:`GPUParticles3D.capture_aabb`. @@ -9411,7 +9645,7 @@ Calculates and returns the axis-aligned bounding box that contains all the parti .. rst-class:: classref-method -:ref:`bool` **particles_get_emitting** **(** :ref:`RID` particles **)** +:ref:`bool` **particles_get_emitting**\ (\ particles\: :ref:`RID`\ ) Returns ``true`` if particles are currently set to emitting. @@ -9423,7 +9657,7 @@ Returns ``true`` if particles are currently set to emitting. .. rst-class:: classref-method -:ref:`bool` **particles_is_inactive** **(** :ref:`RID` particles **)** +:ref:`bool` **particles_is_inactive**\ (\ particles\: :ref:`RID`\ ) Returns ``true`` if particles are not emitting and particles are set to inactive. @@ -9435,7 +9669,7 @@ Returns ``true`` if particles are not emitting and particles are set to inactive .. rst-class:: classref-method -void **particles_request_process** **(** :ref:`RID` particles **)** +|void| **particles_request_process**\ (\ particles\: :ref:`RID`\ ) Add particle system to list of particle systems that need to be updated. Update will take place on the next frame, or on the next call to :ref:`instances_cull_aabb`, :ref:`instances_cull_convex`, or :ref:`instances_cull_ray`. @@ -9447,7 +9681,7 @@ Add particle system to list of particle systems that need to be updated. Update .. rst-class:: classref-method -void **particles_restart** **(** :ref:`RID` particles **)** +|void| **particles_restart**\ (\ particles\: :ref:`RID`\ ) Reset the particles on the next update. Equivalent to :ref:`GPUParticles3D.restart`. @@ -9459,7 +9693,7 @@ Reset the particles on the next update. Equivalent to :ref:`GPUParticles3D.resta .. rst-class:: classref-method -void **particles_set_amount** **(** :ref:`RID` particles, :ref:`int` amount **)** +|void| **particles_set_amount**\ (\ particles\: :ref:`RID`, amount\: :ref:`int`\ ) Sets the number of particles to be drawn and allocates the memory for them. Equivalent to :ref:`GPUParticles3D.amount`. @@ -9471,7 +9705,7 @@ Sets the number of particles to be drawn and allocates the memory for them. Equi .. rst-class:: classref-method -void **particles_set_amount_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** +|void| **particles_set_amount_ratio**\ (\ particles\: :ref:`RID`, ratio\: :ref:`float`\ ) Sets the amount ratio for particles to be emitted. Equivalent to :ref:`GPUParticles3D.amount_ratio`. @@ -9483,7 +9717,7 @@ Sets the amount ratio for particles to be emitted. Equivalent to :ref:`GPUPartic .. rst-class:: classref-method -void **particles_set_collision_base_size** **(** :ref:`RID` particles, :ref:`float` size **)** +|void| **particles_set_collision_base_size**\ (\ particles\: :ref:`RID`, size\: :ref:`float`\ ) .. container:: contribute @@ -9497,7 +9731,7 @@ void **particles_set_collision_base_size** **(** :ref:`RID` particles .. rst-class:: classref-method -void **particles_set_custom_aabb** **(** :ref:`RID` particles, :ref:`AABB` aabb **)** +|void| **particles_set_custom_aabb**\ (\ particles\: :ref:`RID`, aabb\: :ref:`AABB`\ ) Sets a custom axis-aligned bounding box for the particle system. Equivalent to :ref:`GPUParticles3D.visibility_aabb`. @@ -9509,7 +9743,7 @@ Sets a custom axis-aligned bounding box for the particle system. Equivalent to : .. rst-class:: classref-method -void **particles_set_draw_order** **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** +|void| **particles_set_draw_order**\ (\ particles\: :ref:`RID`, order\: :ref:`ParticlesDrawOrder`\ ) Sets the draw order of the particles to one of the named enums from :ref:`ParticlesDrawOrder`. See :ref:`ParticlesDrawOrder` for options. Equivalent to :ref:`GPUParticles3D.draw_order`. @@ -9521,7 +9755,7 @@ Sets the draw order of the particles to one of the named enums from :ref:`Partic .. rst-class:: classref-method -void **particles_set_draw_pass_mesh** **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** +|void| **particles_set_draw_pass_mesh**\ (\ particles\: :ref:`RID`, pass\: :ref:`int`, mesh\: :ref:`RID`\ ) Sets the mesh to be used for the specified draw pass. Equivalent to :ref:`GPUParticles3D.draw_pass_1`, :ref:`GPUParticles3D.draw_pass_2`, :ref:`GPUParticles3D.draw_pass_3`, and :ref:`GPUParticles3D.draw_pass_4`. @@ -9533,7 +9767,7 @@ Sets the mesh to be used for the specified draw pass. Equivalent to :ref:`GPUPar .. rst-class:: classref-method -void **particles_set_draw_passes** **(** :ref:`RID` particles, :ref:`int` count **)** +|void| **particles_set_draw_passes**\ (\ particles\: :ref:`RID`, count\: :ref:`int`\ ) Sets the number of draw passes to use. Equivalent to :ref:`GPUParticles3D.draw_passes`. @@ -9545,7 +9779,7 @@ Sets the number of draw passes to use. Equivalent to :ref:`GPUParticles3D.draw_p .. rst-class:: classref-method -void **particles_set_emission_transform** **(** :ref:`RID` particles, :ref:`Transform3D` transform **)** +|void| **particles_set_emission_transform**\ (\ particles\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) Sets the :ref:`Transform3D` that will be used by the particles when they first emit. @@ -9557,7 +9791,7 @@ Sets the :ref:`Transform3D` that will be used by the particle .. rst-class:: classref-method -void **particles_set_emitter_velocity** **(** :ref:`RID` particles, :ref:`Vector3` velocity **)** +|void| **particles_set_emitter_velocity**\ (\ particles\: :ref:`RID`, velocity\: :ref:`Vector3`\ ) Sets the velocity of a particle node, that will be used by :ref:`ParticleProcessMaterial.inherit_velocity_ratio`. @@ -9569,7 +9803,7 @@ Sets the velocity of a particle node, that will be used by :ref:`ParticleProcess .. rst-class:: classref-method -void **particles_set_emitting** **(** :ref:`RID` particles, :ref:`bool` emitting **)** +|void| **particles_set_emitting**\ (\ particles\: :ref:`RID`, emitting\: :ref:`bool`\ ) If ``true``, particles will emit over time. Setting to false does not reset the particles, but only stops their emission. Equivalent to :ref:`GPUParticles3D.emitting`. @@ -9581,7 +9815,7 @@ If ``true``, particles will emit over time. Setting to false does not reset the .. rst-class:: classref-method -void **particles_set_explosiveness_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** +|void| **particles_set_explosiveness_ratio**\ (\ particles\: :ref:`RID`, ratio\: :ref:`float`\ ) Sets the explosiveness ratio. Equivalent to :ref:`GPUParticles3D.explosiveness`. @@ -9593,7 +9827,7 @@ Sets the explosiveness ratio. Equivalent to :ref:`GPUParticles3D.explosiveness` particles, :ref:`int` fps **)** +|void| **particles_set_fixed_fps**\ (\ particles\: :ref:`RID`, fps\: :ref:`int`\ ) Sets the frame rate that the particle system rendering will be fixed to. Equivalent to :ref:`GPUParticles3D.fixed_fps`. @@ -9605,7 +9839,7 @@ Sets the frame rate that the particle system rendering will be fixed to. Equival .. rst-class:: classref-method -void **particles_set_fractional_delta** **(** :ref:`RID` particles, :ref:`bool` enable **)** +|void| **particles_set_fractional_delta**\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`\ ) If ``true``, uses fractional delta which smooths the movement of the particles. Equivalent to :ref:`GPUParticles3D.fract_delta`. @@ -9617,7 +9851,7 @@ If ``true``, uses fractional delta which smooths the movement of the particles. .. rst-class:: classref-method -void **particles_set_interp_to_end** **(** :ref:`RID` particles, :ref:`float` factor **)** +|void| **particles_set_interp_to_end**\ (\ particles\: :ref:`RID`, factor\: :ref:`float`\ ) Sets the value that informs a :ref:`ParticleProcessMaterial` to rush all particles towards the end of their lifetime. @@ -9629,7 +9863,7 @@ Sets the value that informs a :ref:`ParticleProcessMaterial` particles, :ref:`bool` enable **)** +|void| **particles_set_interpolate**\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`\ ) .. container:: contribute @@ -9643,7 +9877,7 @@ void **particles_set_interpolate** **(** :ref:`RID` particles, :ref:` .. rst-class:: classref-method -void **particles_set_lifetime** **(** :ref:`RID` particles, :ref:`float` lifetime **)** +|void| **particles_set_lifetime**\ (\ particles\: :ref:`RID`, lifetime\: :ref:`float`\ ) Sets the lifetime of each particle in the system. Equivalent to :ref:`GPUParticles3D.lifetime`. @@ -9655,7 +9889,7 @@ Sets the lifetime of each particle in the system. Equivalent to :ref:`GPUParticl .. rst-class:: classref-method -void **particles_set_mode** **(** :ref:`RID` particles, :ref:`ParticlesMode` mode **)** +|void| **particles_set_mode**\ (\ particles\: :ref:`RID`, mode\: :ref:`ParticlesMode`\ ) Sets whether the GPU particles specified by the ``particles`` RID should be rendered in 2D or 3D according to ``mode``. @@ -9667,7 +9901,7 @@ Sets whether the GPU particles specified by the ``particles`` RID should be rend .. rst-class:: classref-method -void **particles_set_one_shot** **(** :ref:`RID` particles, :ref:`bool` one_shot **)** +|void| **particles_set_one_shot**\ (\ particles\: :ref:`RID`, one_shot\: :ref:`bool`\ ) If ``true``, particles will emit once and then stop. Equivalent to :ref:`GPUParticles3D.one_shot`. @@ -9679,7 +9913,7 @@ If ``true``, particles will emit once and then stop. Equivalent to :ref:`GPUPart .. rst-class:: classref-method -void **particles_set_pre_process_time** **(** :ref:`RID` particles, :ref:`float` time **)** +|void| **particles_set_pre_process_time**\ (\ particles\: :ref:`RID`, time\: :ref:`float`\ ) Sets the preprocess time for the particles' animation. This lets you delay starting an animation until after the particles have begun emitting. Equivalent to :ref:`GPUParticles3D.preprocess`. @@ -9691,7 +9925,7 @@ Sets the preprocess time for the particles' animation. This lets you delay start .. rst-class:: classref-method -void **particles_set_process_material** **(** :ref:`RID` particles, :ref:`RID` material **)** +|void| **particles_set_process_material**\ (\ particles\: :ref:`RID`, material\: :ref:`RID`\ ) Sets the material for processing the particles. @@ -9705,7 +9939,7 @@ Sets the material for processing the particles. .. rst-class:: classref-method -void **particles_set_randomness_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** +|void| **particles_set_randomness_ratio**\ (\ particles\: :ref:`RID`, ratio\: :ref:`float`\ ) Sets the emission randomness ratio. This randomizes the emission of particles within their phase. Equivalent to :ref:`GPUParticles3D.randomness`. @@ -9717,7 +9951,7 @@ Sets the emission randomness ratio. This randomizes the emission of particles wi .. rst-class:: classref-method -void **particles_set_speed_scale** **(** :ref:`RID` particles, :ref:`float` scale **)** +|void| **particles_set_speed_scale**\ (\ particles\: :ref:`RID`, scale\: :ref:`float`\ ) Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D.speed_scale`. @@ -9729,7 +9963,7 @@ Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D. .. rst-class:: classref-method -void **particles_set_subemitter** **(** :ref:`RID` particles, :ref:`RID` subemitter_particles **)** +|void| **particles_set_subemitter**\ (\ particles\: :ref:`RID`, subemitter_particles\: :ref:`RID`\ ) .. container:: contribute @@ -9743,7 +9977,7 @@ void **particles_set_subemitter** **(** :ref:`RID` particles, :ref:`R .. rst-class:: classref-method -void **particles_set_trail_bind_poses** **(** :ref:`RID` particles, :ref:`Transform3D[]` bind_poses **)** +|void| **particles_set_trail_bind_poses**\ (\ particles\: :ref:`RID`, bind_poses\: :ref:`Array`\[:ref:`Transform3D`\]\ ) .. container:: contribute @@ -9757,7 +9991,7 @@ void **particles_set_trail_bind_poses** **(** :ref:`RID` particles, : .. rst-class:: classref-method -void **particles_set_trails** **(** :ref:`RID` particles, :ref:`bool` enable, :ref:`float` length_sec **)** +|void| **particles_set_trails**\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`, length_sec\: :ref:`float`\ ) If ``enable`` is ``true``, enables trails for the ``particles`` with the specified ``length_sec`` in seconds. Equivalent to :ref:`GPUParticles3D.trail_enabled` and :ref:`GPUParticles3D.trail_lifetime`. @@ -9769,7 +10003,7 @@ If ``enable`` is ``true``, enables trails for the ``particles`` with the specifi .. rst-class:: classref-method -void **particles_set_transform_align** **(** :ref:`RID` particles, :ref:`ParticlesTransformAlign` align **)** +|void| **particles_set_transform_align**\ (\ particles\: :ref:`RID`, align\: :ref:`ParticlesTransformAlign`\ ) .. container:: contribute @@ -9783,7 +10017,7 @@ void **particles_set_transform_align** **(** :ref:`RID` particles, :r .. rst-class:: classref-method -void **particles_set_use_local_coordinates** **(** :ref:`RID` particles, :ref:`bool` enable **)** +|void| **particles_set_use_local_coordinates**\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`\ ) If ``true``, particles use local coordinates. If ``false`` they use global coordinates. Equivalent to :ref:`GPUParticles3D.local_coords`. @@ -9795,7 +10029,7 @@ If ``true``, particles use local coordinates. If ``false`` they use global coord .. rst-class:: classref-method -void **positional_soft_shadow_filter_set_quality** **(** :ref:`ShadowQuality` quality **)** +|void| **positional_soft_shadow_filter_set_quality**\ (\ quality\: :ref:`ShadowQuality`\ ) Sets the filter quality for omni and spot light shadows in 3D. See also :ref:`ProjectSettings.rendering/lights_and_shadows/positional_shadow/soft_shadow_filter_quality`. This parameter is global and cannot be set on a per-viewport basis. @@ -9807,7 +10041,7 @@ Sets the filter quality for omni and spot light shadows in 3D. See also :ref:`Pr .. rst-class:: classref-method -:ref:`RID` **reflection_probe_create** **(** **)** +:ref:`RID` **reflection_probe_create**\ (\ ) Creates a reflection probe and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``reflection_probe_*`` RenderingServer functions. @@ -9825,7 +10059,7 @@ To place in a scene, attach this reflection probe to an instance using :ref:`ins .. rst-class:: classref-method -void **reflection_probe_set_ambient_color** **(** :ref:`RID` probe, :ref:`Color` color **)** +|void| **reflection_probe_set_ambient_color**\ (\ probe\: :ref:`RID`, color\: :ref:`Color`\ ) Sets the reflection probe's custom ambient light color. Equivalent to :ref:`ReflectionProbe.ambient_color`. @@ -9837,7 +10071,7 @@ Sets the reflection probe's custom ambient light color. Equivalent to :ref:`Refl .. rst-class:: classref-method -void **reflection_probe_set_ambient_energy** **(** :ref:`RID` probe, :ref:`float` energy **)** +|void| **reflection_probe_set_ambient_energy**\ (\ probe\: :ref:`RID`, energy\: :ref:`float`\ ) Sets the reflection probe's custom ambient light energy. Equivalent to :ref:`ReflectionProbe.ambient_color_energy`. @@ -9849,7 +10083,7 @@ Sets the reflection probe's custom ambient light energy. Equivalent to :ref:`Ref .. rst-class:: classref-method -void **reflection_probe_set_ambient_mode** **(** :ref:`RID` probe, :ref:`ReflectionProbeAmbientMode` mode **)** +|void| **reflection_probe_set_ambient_mode**\ (\ probe\: :ref:`RID`, mode\: :ref:`ReflectionProbeAmbientMode`\ ) Sets the reflection probe's ambient light mode. Equivalent to :ref:`ReflectionProbe.ambient_mode`. @@ -9861,7 +10095,7 @@ Sets the reflection probe's ambient light mode. Equivalent to :ref:`ReflectionPr .. rst-class:: classref-method -void **reflection_probe_set_as_interior** **(** :ref:`RID` probe, :ref:`bool` enable **)** +|void| **reflection_probe_set_as_interior**\ (\ probe\: :ref:`RID`, enable\: :ref:`bool`\ ) If ``true``, reflections will ignore sky contribution. Equivalent to :ref:`ReflectionProbe.interior`. @@ -9873,7 +10107,7 @@ If ``true``, reflections will ignore sky contribution. Equivalent to :ref:`Refle .. rst-class:: classref-method -void **reflection_probe_set_cull_mask** **(** :ref:`RID` probe, :ref:`int` layers **)** +|void| **reflection_probe_set_cull_mask**\ (\ probe\: :ref:`RID`, layers\: :ref:`int`\ ) Sets the render cull mask for this reflection probe. Only instances with a matching layer will be reflected by this probe. Equivalent to :ref:`ReflectionProbe.cull_mask`. @@ -9885,7 +10119,7 @@ Sets the render cull mask for this reflection probe. Only instances with a match .. rst-class:: classref-method -void **reflection_probe_set_enable_box_projection** **(** :ref:`RID` probe, :ref:`bool` enable **)** +|void| **reflection_probe_set_enable_box_projection**\ (\ probe\: :ref:`RID`, enable\: :ref:`bool`\ ) If ``true``, uses box projection. This can make reflections look more correct in certain situations. Equivalent to :ref:`ReflectionProbe.box_projection`. @@ -9897,7 +10131,7 @@ If ``true``, uses box projection. This can make reflections look more correct in .. rst-class:: classref-method -void **reflection_probe_set_enable_shadows** **(** :ref:`RID` probe, :ref:`bool` enable **)** +|void| **reflection_probe_set_enable_shadows**\ (\ probe\: :ref:`RID`, enable\: :ref:`bool`\ ) If ``true``, computes shadows in the reflection probe. This makes the reflection much slower to compute. Equivalent to :ref:`ReflectionProbe.enable_shadows`. @@ -9909,7 +10143,7 @@ If ``true``, computes shadows in the reflection probe. This makes the reflection .. rst-class:: classref-method -void **reflection_probe_set_intensity** **(** :ref:`RID` probe, :ref:`float` intensity **)** +|void| **reflection_probe_set_intensity**\ (\ probe\: :ref:`RID`, intensity\: :ref:`float`\ ) Sets the intensity of the reflection probe. Intensity modulates the strength of the reflection. Equivalent to :ref:`ReflectionProbe.intensity`. @@ -9921,7 +10155,7 @@ Sets the intensity of the reflection probe. Intensity modulates the strength of .. rst-class:: classref-method -void **reflection_probe_set_max_distance** **(** :ref:`RID` probe, :ref:`float` distance **)** +|void| **reflection_probe_set_max_distance**\ (\ probe\: :ref:`RID`, distance\: :ref:`float`\ ) Sets the max distance away from the probe an object can be before it is culled. Equivalent to :ref:`ReflectionProbe.max_distance`. @@ -9933,7 +10167,7 @@ Sets the max distance away from the probe an object can be before it is culled. .. rst-class:: classref-method -void **reflection_probe_set_mesh_lod_threshold** **(** :ref:`RID` probe, :ref:`float` pixels **)** +|void| **reflection_probe_set_mesh_lod_threshold**\ (\ probe\: :ref:`RID`, pixels\: :ref:`float`\ ) Sets the mesh level of detail to use in the reflection probe rendering. Higher values will use less detailed versions of meshes that have LOD variations generated, which can improve performance. Equivalent to :ref:`ReflectionProbe.mesh_lod_threshold`. @@ -9945,7 +10179,7 @@ Sets the mesh level of detail to use in the reflection probe rendering. Higher v .. rst-class:: classref-method -void **reflection_probe_set_origin_offset** **(** :ref:`RID` probe, :ref:`Vector3` offset **)** +|void| **reflection_probe_set_origin_offset**\ (\ probe\: :ref:`RID`, offset\: :ref:`Vector3`\ ) Sets the origin offset to be used when this reflection probe is in box project mode. Equivalent to :ref:`ReflectionProbe.origin_offset`. @@ -9957,7 +10191,7 @@ Sets the origin offset to be used when this reflection probe is in box project m .. rst-class:: classref-method -void **reflection_probe_set_reflection_mask** **(** :ref:`RID` probe, :ref:`int` layers **)** +|void| **reflection_probe_set_reflection_mask**\ (\ probe\: :ref:`RID`, layers\: :ref:`int`\ ) Sets the render reflection mask for this reflection probe. Only instances with a matching layer will have reflections applied from this probe. Equivalent to :ref:`ReflectionProbe.reflection_mask`. @@ -9969,7 +10203,7 @@ Sets the render reflection mask for this reflection probe. Only instances with a .. rst-class:: classref-method -void **reflection_probe_set_resolution** **(** :ref:`RID` probe, :ref:`int` resolution **)** +|void| **reflection_probe_set_resolution**\ (\ probe\: :ref:`RID`, resolution\: :ref:`int`\ ) Sets the resolution to use when rendering the specified reflection probe. The ``resolution`` is specified for each cubemap face: for instance, specifying ``512`` will allocate 6 faces of 512×512 each (plus mipmaps for roughness levels). @@ -9981,7 +10215,7 @@ Sets the resolution to use when rendering the specified reflection probe. The `` .. rst-class:: classref-method -void **reflection_probe_set_size** **(** :ref:`RID` probe, :ref:`Vector3` size **)** +|void| **reflection_probe_set_size**\ (\ probe\: :ref:`RID`, size\: :ref:`Vector3`\ ) Sets the size of the area that the reflection probe will capture. Equivalent to :ref:`ReflectionProbe.size`. @@ -9993,7 +10227,7 @@ Sets the size of the area that the reflection probe will capture. Equivalent to .. rst-class:: classref-method -void **reflection_probe_set_update_mode** **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** +|void| **reflection_probe_set_update_mode**\ (\ probe\: :ref:`RID`, mode\: :ref:`ReflectionProbeUpdateMode`\ ) Sets how often the reflection probe updates. Can either be once or every frame. See :ref:`ReflectionProbeUpdateMode` for options. @@ -10005,7 +10239,7 @@ Sets how often the reflection probe updates. Can either be once or every frame. .. rst-class:: classref-method -void **request_frame_drawn_callback** **(** :ref:`Callable` callable **)** +|void| **request_frame_drawn_callback**\ (\ callable\: :ref:`Callable`\ ) Schedules a callback to the given callable after a frame has been drawn. @@ -10017,7 +10251,7 @@ Schedules a callback to the given callable after a frame has been drawn. .. rst-class:: classref-method -:ref:`RID` **scenario_create** **(** **)** +:ref:`RID` **scenario_create**\ (\ ) Creates a scenario and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``scenario_*`` RenderingServer functions. @@ -10033,7 +10267,7 @@ The scenario is the 3D world that all the visual instances exist in. .. rst-class:: classref-method -void **scenario_set_camera_attributes** **(** :ref:`RID` scenario, :ref:`RID` effects **)** +|void| **scenario_set_camera_attributes**\ (\ scenario\: :ref:`RID`, effects\: :ref:`RID`\ ) Sets the camera attributes (``effects``) that will be used with this scenario. See also :ref:`CameraAttributes`. @@ -10041,11 +10275,23 @@ Sets the camera attributes (``effects``) that will be used with this scenario. S ---- +.. _class_RenderingServer_method_scenario_set_compositor: + +.. rst-class:: classref-method + +|void| **scenario_set_compositor**\ (\ scenario\: :ref:`RID`, compositor\: :ref:`RID`\ ) + +Sets the compositor (``compositor``) that will be used with this scenario. See also :ref:`Compositor`. + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingServer_method_scenario_set_environment: .. rst-class:: classref-method -void **scenario_set_environment** **(** :ref:`RID` scenario, :ref:`RID` environment **)** +|void| **scenario_set_environment**\ (\ scenario\: :ref:`RID`, environment\: :ref:`RID`\ ) Sets the environment that will be used with this scenario. See also :ref:`Environment`. @@ -10057,7 +10303,7 @@ Sets the environment that will be used with this scenario. See also :ref:`Enviro .. rst-class:: classref-method -void **scenario_set_fallback_environment** **(** :ref:`RID` scenario, :ref:`RID` environment **)** +|void| **scenario_set_fallback_environment**\ (\ scenario\: :ref:`RID`, environment\: :ref:`RID`\ ) Sets the fallback environment to be used by this scenario. The fallback environment is used if no environment is set. Internally, this is used by the editor to provide a default environment. @@ -10069,7 +10315,7 @@ Sets the fallback environment to be used by this scenario. The fallback environm .. rst-class:: classref-method -void **screen_space_roughness_limiter_set_active** **(** :ref:`bool` enable, :ref:`float` amount, :ref:`float` limit **)** +|void| **screen_space_roughness_limiter_set_active**\ (\ enable\: :ref:`bool`, amount\: :ref:`float`, limit\: :ref:`float`\ ) Sets the screen-space roughness limiter parameters, such as whether it should be enabled and its thresholds. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/screen_space_roughness_limiter/enabled`, :ref:`ProjectSettings.rendering/anti_aliasing/screen_space_roughness_limiter/amount` and :ref:`ProjectSettings.rendering/anti_aliasing/screen_space_roughness_limiter/limit`. @@ -10081,7 +10327,7 @@ Sets the screen-space roughness limiter parameters, such as whether it should be .. rst-class:: classref-method -void **set_boot_image** **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale, :ref:`bool` use_filter=true **)** +|void| **set_boot_image**\ (\ image\: :ref:`Image`, color\: :ref:`Color`, scale\: :ref:`bool`, use_filter\: :ref:`bool` = true\ ) Sets a boot image. The color defines the background color. If ``scale`` is ``true``, the image will be scaled to fit the screen size. If ``use_filter`` is ``true``, the image will be scaled with linear interpolation. If ``use_filter`` is ``false``, the image will be scaled with nearest-neighbor interpolation. @@ -10093,7 +10339,7 @@ Sets a boot image. The color defines the background color. If ``scale`` is ``tru .. rst-class:: classref-method -void **set_debug_generate_wireframes** **(** :ref:`bool` generate **)** +|void| **set_debug_generate_wireframes**\ (\ generate\: :ref:`bool`\ ) This method is currently unimplemented and does nothing if called with ``generate`` set to ``true``. @@ -10105,7 +10351,7 @@ This method is currently unimplemented and does nothing if called with ``generat .. rst-class:: classref-method -void **set_default_clear_color** **(** :ref:`Color` color **)** +|void| **set_default_clear_color**\ (\ color\: :ref:`Color`\ ) Sets the default clear color which is used when a specific clear color has not been selected. See also :ref:`get_default_clear_color`. @@ -10117,7 +10363,7 @@ Sets the default clear color which is used when a specific clear color has not b .. rst-class:: classref-method -:ref:`RID` **shader_create** **(** **)** +:ref:`RID` **shader_create**\ (\ ) Creates an empty shader and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``shader_*`` RenderingServer functions. @@ -10133,7 +10379,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`String` **shader_get_code** **(** :ref:`RID` shader **)** |const| +:ref:`String` **shader_get_code**\ (\ shader\: :ref:`RID`\ ) |const| Returns a shader's source code as a string. @@ -10145,7 +10391,7 @@ Returns a shader's source code as a string. .. rst-class:: classref-method -:ref:`RID` **shader_get_default_texture_parameter** **(** :ref:`RID` shader, :ref:`StringName` name, :ref:`int` index=0 **)** |const| +:ref:`RID` **shader_get_default_texture_parameter**\ (\ shader\: :ref:`RID`, name\: :ref:`StringName`, index\: :ref:`int` = 0\ ) |const| Returns a default texture from a shader searched by name. @@ -10159,7 +10405,7 @@ Returns a default texture from a shader searched by name. .. rst-class:: classref-method -:ref:`Variant` **shader_get_parameter_default** **(** :ref:`RID` shader, :ref:`StringName` name **)** |const| +:ref:`Variant` **shader_get_parameter_default**\ (\ shader\: :ref:`RID`, name\: :ref:`StringName`\ ) |const| Returns the default value for the specified shader uniform. This is usually the value written in the shader source code. @@ -10171,7 +10417,7 @@ Returns the default value for the specified shader uniform. This is usually the .. rst-class:: classref-method -void **shader_set_code** **(** :ref:`RID` shader, :ref:`String` code **)** +|void| **shader_set_code**\ (\ shader\: :ref:`RID`, code\: :ref:`String`\ ) Sets the shader's source code (which triggers recompilation after being changed). @@ -10183,7 +10429,7 @@ Sets the shader's source code (which triggers recompilation after being changed) .. rst-class:: classref-method -void **shader_set_default_texture_parameter** **(** :ref:`RID` shader, :ref:`StringName` name, :ref:`RID` texture, :ref:`int` index=0 **)** +|void| **shader_set_default_texture_parameter**\ (\ shader\: :ref:`RID`, name\: :ref:`StringName`, texture\: :ref:`RID`, index\: :ref:`int` = 0\ ) Sets a shader's default texture. Overwrites the texture given by name. @@ -10197,7 +10443,7 @@ Sets a shader's default texture. Overwrites the texture given by name. .. rst-class:: classref-method -void **shader_set_path_hint** **(** :ref:`RID` shader, :ref:`String` path **)** +|void| **shader_set_path_hint**\ (\ shader\: :ref:`RID`, path\: :ref:`String`\ ) Sets the path hint for the specified shader. This should generally match the :ref:`Shader` resource's :ref:`Resource.resource_path`. @@ -10209,7 +10455,7 @@ Sets the path hint for the specified shader. This should generally match the :re .. rst-class:: classref-method -void **skeleton_allocate_data** **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** +|void| **skeleton_allocate_data**\ (\ skeleton\: :ref:`RID`, bones\: :ref:`int`, is_2d_skeleton\: :ref:`bool` = false\ ) .. container:: contribute @@ -10223,7 +10469,7 @@ void **skeleton_allocate_data** **(** :ref:`RID` skeleton, :ref:`int< .. rst-class:: classref-method -:ref:`Transform3D` **skeleton_bone_get_transform** **(** :ref:`RID` skeleton, :ref:`int` bone **)** |const| +:ref:`Transform3D` **skeleton_bone_get_transform**\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`\ ) |const| Returns the :ref:`Transform3D` set for a specific bone of this skeleton. @@ -10235,7 +10481,7 @@ Returns the :ref:`Transform3D` set for a specific bone of thi .. rst-class:: classref-method -:ref:`Transform2D` **skeleton_bone_get_transform_2d** **(** :ref:`RID` skeleton, :ref:`int` bone **)** |const| +:ref:`Transform2D` **skeleton_bone_get_transform_2d**\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`\ ) |const| Returns the :ref:`Transform2D` set for a specific bone of this skeleton. @@ -10247,7 +10493,7 @@ Returns the :ref:`Transform2D` set for a specific bone of thi .. rst-class:: classref-method -void **skeleton_bone_set_transform** **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform3D` transform **)** +|void| **skeleton_bone_set_transform**\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`, transform\: :ref:`Transform3D`\ ) Sets the :ref:`Transform3D` for a specific bone of this skeleton. @@ -10259,7 +10505,7 @@ Sets the :ref:`Transform3D` for a specific bone of this skele .. rst-class:: classref-method -void **skeleton_bone_set_transform_2d** **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** +|void| **skeleton_bone_set_transform_2d**\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`, transform\: :ref:`Transform2D`\ ) Sets the :ref:`Transform2D` for a specific bone of this skeleton. @@ -10271,7 +10517,7 @@ Sets the :ref:`Transform2D` for a specific bone of this skele .. rst-class:: classref-method -:ref:`RID` **skeleton_create** **(** **)** +:ref:`RID` **skeleton_create**\ (\ ) Creates a skeleton and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``skeleton_*`` RenderingServer functions. @@ -10285,7 +10531,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`int` **skeleton_get_bone_count** **(** :ref:`RID` skeleton **)** |const| +:ref:`int` **skeleton_get_bone_count**\ (\ skeleton\: :ref:`RID`\ ) |const| Returns the number of bones allocated for this skeleton. @@ -10297,7 +10543,7 @@ Returns the number of bones allocated for this skeleton. .. rst-class:: classref-method -void **skeleton_set_base_transform_2d** **(** :ref:`RID` skeleton, :ref:`Transform2D` base_transform **)** +|void| **skeleton_set_base_transform_2d**\ (\ skeleton\: :ref:`RID`, base_transform\: :ref:`Transform2D`\ ) .. container:: contribute @@ -10311,7 +10557,7 @@ void **skeleton_set_base_transform_2d** **(** :ref:`RID` skeleton, :r .. rst-class:: classref-method -:ref:`Image` **sky_bake_panorama** **(** :ref:`RID` sky, :ref:`float` energy, :ref:`bool` bake_irradiance, :ref:`Vector2i` size **)** +:ref:`Image` **sky_bake_panorama**\ (\ sky\: :ref:`RID`, energy\: :ref:`float`, bake_irradiance\: :ref:`bool`, size\: :ref:`Vector2i`\ ) Generates and returns an :ref:`Image` containing the radiance map for the specified ``sky`` RID. This supports built-in sky material and custom sky shaders. If ``bake_irradiance`` is ``true``, the irradiance map is saved instead of the radiance map. The radiance map is used to render reflected light, while the irradiance map is used to render ambient light. See also :ref:`environment_bake_panorama`. @@ -10327,7 +10573,7 @@ Generates and returns an :ref:`Image` containing the radiance map f .. rst-class:: classref-method -:ref:`RID` **sky_create** **(** **)** +:ref:`RID` **sky_create**\ (\ ) Creates an empty sky and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``sky_*`` RenderingServer functions. @@ -10341,7 +10587,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -void **sky_set_material** **(** :ref:`RID` sky, :ref:`RID` material **)** +|void| **sky_set_material**\ (\ sky\: :ref:`RID`, material\: :ref:`RID`\ ) Sets the material that the sky uses to render the background, ambient and reflection maps. @@ -10353,7 +10599,7 @@ Sets the material that the sky uses to render the background, ambient and reflec .. rst-class:: classref-method -void **sky_set_mode** **(** :ref:`RID` sky, :ref:`SkyMode` mode **)** +|void| **sky_set_mode**\ (\ sky\: :ref:`RID`, mode\: :ref:`SkyMode`\ ) Sets the process ``mode`` of the sky specified by the ``sky`` RID. Equivalent to :ref:`Sky.process_mode`. @@ -10365,7 +10611,7 @@ Sets the process ``mode`` of the sky specified by the ``sky`` RID. Equivalent to .. rst-class:: classref-method -void **sky_set_radiance_size** **(** :ref:`RID` sky, :ref:`int` radiance_size **)** +|void| **sky_set_radiance_size**\ (\ sky\: :ref:`RID`, radiance_size\: :ref:`int`\ ) Sets the ``radiance_size`` of the sky specified by the ``sky`` RID (in pixels). Equivalent to :ref:`Sky.radiance_size`. @@ -10377,7 +10623,7 @@ Sets the ``radiance_size`` of the sky specified by the ``sky`` RID (in pixels). .. rst-class:: classref-method -:ref:`RID` **spot_light_create** **(** **)** +:ref:`RID` **spot_light_create**\ (\ ) Creates a spot light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most ``light_*`` RenderingServer functions. @@ -10393,7 +10639,7 @@ To place in a scene, attach this spot light to an instance using :ref:`instance_ .. rst-class:: classref-method -void **sub_surface_scattering_set_quality** **(** :ref:`SubSurfaceScatteringQuality` quality **)** +|void| **sub_surface_scattering_set_quality**\ (\ quality\: :ref:`SubSurfaceScatteringQuality`\ ) Sets :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_quality` to use when rendering materials that have subsurface scattering enabled. @@ -10405,7 +10651,7 @@ Sets :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurfac .. rst-class:: classref-method -void **sub_surface_scattering_set_scale** **(** :ref:`float` scale, :ref:`float` depth_scale **)** +|void| **sub_surface_scattering_set_scale**\ (\ scale\: :ref:`float`, depth_scale\: :ref:`float`\ ) Sets the :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_scale` and :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_depth_scale` to use when rendering materials that have subsurface scattering enabled. @@ -10417,7 +10663,7 @@ Sets the :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsu .. rst-class:: classref-method -:ref:`RID` **texture_2d_create** **(** :ref:`Image` image **)** +:ref:`RID` **texture_2d_create**\ (\ image\: :ref:`Image`\ ) Creates a 2-dimensional texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``texture_2d_*`` RenderingServer functions. @@ -10435,7 +10681,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`Image` **texture_2d_get** **(** :ref:`RID` texture **)** |const| +:ref:`Image` **texture_2d_get**\ (\ texture\: :ref:`RID`\ ) |const| Returns an :ref:`Image` instance from the given ``texture`` :ref:`RID`. @@ -10455,7 +10701,7 @@ Example of getting the test texture from :ref:`get_test_texture` **texture_2d_layer_get** **(** :ref:`RID` texture, :ref:`int` layer **)** |const| +:ref:`Image` **texture_2d_layer_get**\ (\ texture\: :ref:`RID`, layer\: :ref:`int`\ ) |const| Returns an :ref:`Image` instance from the given ``texture`` :ref:`RID` and ``layer``. @@ -10467,7 +10713,7 @@ Returns an :ref:`Image` instance from the given ``texture`` :ref:`R .. rst-class:: classref-method -:ref:`RID` **texture_2d_layered_create** **(** :ref:`Image[]` layers, :ref:`TextureLayeredType` layered_type **)** +:ref:`RID` **texture_2d_layered_create**\ (\ layers\: :ref:`Array`\[:ref:`Image`\], layered_type\: :ref:`TextureLayeredType`\ ) Creates a 2-dimensional layered texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``texture_2d_layered_*`` RenderingServer functions. @@ -10483,7 +10729,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`RID` **texture_2d_layered_placeholder_create** **(** :ref:`TextureLayeredType` layered_type **)** +:ref:`RID` **texture_2d_layered_placeholder_create**\ (\ layered_type\: :ref:`TextureLayeredType`\ ) Creates a placeholder for a 2-dimensional layered texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``texture_2d_layered_*`` RenderingServer functions, although it does nothing when used. See also :ref:`texture_2d_placeholder_create`. @@ -10497,7 +10743,7 @@ Creates a placeholder for a 2-dimensional layered texture and adds it to the Ren .. rst-class:: classref-method -:ref:`RID` **texture_2d_placeholder_create** **(** **)** +:ref:`RID` **texture_2d_placeholder_create**\ (\ ) Creates a placeholder for a 2-dimensional layered texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``texture_2d_layered_*`` RenderingServer functions, although it does nothing when used. See also :ref:`texture_2d_layered_placeholder_create`\ @@ -10513,7 +10759,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -void **texture_2d_update** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer **)** +|void| **texture_2d_update**\ (\ texture\: :ref:`RID`, image\: :ref:`Image`, layer\: :ref:`int`\ ) Updates the texture specified by the ``texture`` :ref:`RID` with the data in ``image``. A ``layer`` must also be specified, which should be ``0`` when updating a single-layer texture (:ref:`Texture2D`). @@ -10527,7 +10773,7 @@ Updates the texture specified by the ``texture`` :ref:`RID` with the .. rst-class:: classref-method -:ref:`RID` **texture_3d_create** **(** :ref:`Format` format, :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`bool` mipmaps, :ref:`Image[]` data **)** +:ref:`RID` **texture_3d_create**\ (\ format\: :ref:`Format`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, mipmaps\: :ref:`bool`, data\: :ref:`Array`\[:ref:`Image`\]\ ) **Note:** The equivalent resource is :ref:`Texture3D`. @@ -10539,7 +10785,7 @@ Updates the texture specified by the ``texture`` :ref:`RID` with the .. rst-class:: classref-method -:ref:`Image[]` **texture_3d_get** **(** :ref:`RID` texture **)** |const| +:ref:`Array`\[:ref:`Image`\] **texture_3d_get**\ (\ texture\: :ref:`RID`\ ) |const| Returns 3D texture data as an array of :ref:`Image`\ s for the specified texture :ref:`RID`. @@ -10551,7 +10797,7 @@ Returns 3D texture data as an array of :ref:`Image`\ s for the spec .. rst-class:: classref-method -:ref:`RID` **texture_3d_placeholder_create** **(** **)** +:ref:`RID` **texture_3d_placeholder_create**\ (\ ) Creates a placeholder for a 3-dimensional texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``texture_3d_*`` RenderingServer functions, although it does nothing when used. @@ -10567,7 +10813,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -void **texture_3d_update** **(** :ref:`RID` texture, :ref:`Image[]` data **)** +|void| **texture_3d_update**\ (\ texture\: :ref:`RID`, data\: :ref:`Array`\[:ref:`Image`\]\ ) Updates the texture specified by the ``texture`` :ref:`RID`'s data with the data in ``data``. All the texture's layers must be replaced at once. @@ -10581,7 +10827,7 @@ Updates the texture specified by the ``texture`` :ref:`RID`'s data wi .. rst-class:: classref-method -:ref:`Format` **texture_get_format** **(** :ref:`RID` texture **)** |const| +:ref:`Format` **texture_get_format**\ (\ texture\: :ref:`RID`\ ) |const| Returns the format for the texture. @@ -10593,7 +10839,7 @@ Returns the format for the texture. .. rst-class:: classref-method -:ref:`int` **texture_get_native_handle** **(** :ref:`RID` texture, :ref:`bool` srgb=false **)** |const| +:ref:`int` **texture_get_native_handle**\ (\ texture\: :ref:`RID`, srgb\: :ref:`bool` = false\ ) |const| Returns the internal graphics handle for this texture object. For use when communicating with third-party APIs mostly with GDExtension. @@ -10607,7 +10853,7 @@ Returns the internal graphics handle for this texture object. For use when commu .. rst-class:: classref-method -:ref:`String` **texture_get_path** **(** :ref:`RID` texture **)** |const| +:ref:`String` **texture_get_path**\ (\ texture\: :ref:`RID`\ ) |const| .. container:: contribute @@ -10621,7 +10867,7 @@ Returns the internal graphics handle for this texture object. For use when commu .. rst-class:: classref-method -:ref:`RID` **texture_get_rd_texture** **(** :ref:`RID` texture, :ref:`bool` srgb=false **)** |const| +:ref:`RID` **texture_get_rd_texture**\ (\ texture\: :ref:`RID`, srgb\: :ref:`bool` = false\ ) |const| Returns a texture :ref:`RID` that can be used with :ref:`RenderingDevice`. @@ -10633,11 +10879,11 @@ Returns a texture :ref:`RID` that can be used with :ref:`RenderingDev .. rst-class:: classref-method -:ref:`RID` **texture_proxy_create** **(** :ref:`RID` base **)** +:ref:`RID` **texture_proxy_create**\ (\ base\: :ref:`RID`\ ) **Deprecated:** ProxyTexture was removed in Godot 4. -This method does nothing when called and always returns a null :ref:`RID`. +This method does nothing and always returns an invalid :ref:`RID`. .. rst-class:: classref-item-separator @@ -10647,11 +10893,11 @@ This method does nothing when called and always returns a null :ref:`RID` texture, :ref:`RID` proxy_to **)** +|void| **texture_proxy_update**\ (\ texture\: :ref:`RID`, proxy_to\: :ref:`RID`\ ) **Deprecated:** ProxyTexture was removed in Godot 4. -This method should not be used. +This method does nothing. .. rst-class:: classref-item-separator @@ -10661,7 +10907,7 @@ This method should not be used. .. rst-class:: classref-method -:ref:`RID` **texture_rd_create** **(** :ref:`RID` rd_texture, :ref:`TextureLayeredType` layer_type=0 **)** +:ref:`RID` **texture_rd_create**\ (\ rd_texture\: :ref:`RID`, layer_type\: :ref:`TextureLayeredType` = 0\ ) Creates a new texture object based on a texture created directly on the :ref:`RenderingDevice`. If the texture contains layers, ``layer_type`` is used to define the layer type. @@ -10673,7 +10919,7 @@ Creates a new texture object based on a texture created directly on the :ref:`Re .. rst-class:: classref-method -void **texture_replace** **(** :ref:`RID` texture, :ref:`RID` by_texture **)** +|void| **texture_replace**\ (\ texture\: :ref:`RID`, by_texture\: :ref:`RID`\ ) Replaces ``texture``'s texture data by the texture specified by the ``by_texture`` RID, without changing ``texture``'s RID. @@ -10685,7 +10931,7 @@ Replaces ``texture``'s texture data by the texture specified by the ``by_texture .. rst-class:: classref-method -void **texture_set_force_redraw_if_visible** **(** :ref:`RID` texture, :ref:`bool` enable **)** +|void| **texture_set_force_redraw_if_visible**\ (\ texture\: :ref:`RID`, enable\: :ref:`bool`\ ) .. container:: contribute @@ -10699,7 +10945,7 @@ void **texture_set_force_redraw_if_visible** **(** :ref:`RID` texture .. rst-class:: classref-method -void **texture_set_path** **(** :ref:`RID` texture, :ref:`String` path **)** +|void| **texture_set_path**\ (\ texture\: :ref:`RID`, path\: :ref:`String`\ ) .. container:: contribute @@ -10713,7 +10959,7 @@ void **texture_set_path** **(** :ref:`RID` texture, :ref:`String` texture, :ref:`int` width, :ref:`int` height **)** +|void| **texture_set_size_override**\ (\ texture\: :ref:`RID`, width\: :ref:`int`, height\: :ref:`int`\ ) .. container:: contribute @@ -10727,7 +10973,7 @@ void **texture_set_size_override** **(** :ref:`RID` texture, :ref:`in .. rst-class:: classref-method -void **viewport_attach_camera** **(** :ref:`RID` viewport, :ref:`RID` camera **)** +|void| **viewport_attach_camera**\ (\ viewport\: :ref:`RID`, camera\: :ref:`RID`\ ) Sets a viewport's camera. @@ -10739,7 +10985,7 @@ Sets a viewport's camera. .. rst-class:: classref-method -void **viewport_attach_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** +|void| **viewport_attach_canvas**\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`\ ) Sets a viewport's canvas. @@ -10751,7 +10997,7 @@ Sets a viewport's canvas. .. rst-class:: classref-method -void **viewport_attach_to_screen** **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2(0, 0, 0, 0), :ref:`int` screen=0 **)** +|void| **viewport_attach_to_screen**\ (\ viewport\: :ref:`RID`, rect\: :ref:`Rect2` = Rect2(0, 0, 0, 0), screen\: :ref:`int` = 0\ ) Copies the viewport to a region of the screen specified by ``rect``. If :ref:`viewport_set_render_direct_to_screen` is ``true``, then the viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to. @@ -10780,7 +11026,7 @@ Using this can result in significant optimization, especially on lower-end devic .. rst-class:: classref-method -:ref:`RID` **viewport_create** **(** **)** +:ref:`RID` **viewport_create**\ (\ ) Creates an empty viewport and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``viewport_*`` RenderingServer functions. @@ -10796,7 +11042,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`float` **viewport_get_measured_render_time_cpu** **(** :ref:`RID` viewport **)** |const| +:ref:`float` **viewport_get_measured_render_time_cpu**\ (\ viewport\: :ref:`RID`\ ) |const| Returns the CPU time taken to render the last frame in milliseconds. This *only* includes time spent in rendering-related operations; scripts' ``_process`` functions and other engine subsystems are not included in this readout. To get a complete readout of CPU time spent to render the scene, sum the render times of all viewports that are drawn every frame plus :ref:`get_frame_setup_time_cpu`. Unlike :ref:`Engine.get_frames_per_second`, this method will accurately reflect CPU utilization even if framerate is capped via V-Sync or :ref:`Engine.max_fps`. See also :ref:`viewport_get_measured_render_time_gpu`. @@ -10810,7 +11056,7 @@ Returns the CPU time taken to render the last frame in milliseconds. This *only* .. rst-class:: classref-method -:ref:`float` **viewport_get_measured_render_time_gpu** **(** :ref:`RID` viewport **)** |const| +:ref:`float` **viewport_get_measured_render_time_gpu**\ (\ viewport\: :ref:`RID`\ ) |const| Returns the GPU time taken to render the last frame in milliseconds. To get a complete readout of GPU time spent to render the scene, sum the render times of all viewports that are drawn every frame. Unlike :ref:`Engine.get_frames_per_second`, this method accurately reflects GPU utilization even if framerate is capped via V-Sync or :ref:`Engine.max_fps`. See also :ref:`viewport_get_measured_render_time_gpu`. @@ -10826,7 +11072,7 @@ Returns the GPU time taken to render the last frame in milliseconds. To get a co .. rst-class:: classref-method -:ref:`int` **viewport_get_render_info** **(** :ref:`RID` viewport, :ref:`ViewportRenderInfoType` type, :ref:`ViewportRenderInfo` info **)** +:ref:`int` **viewport_get_render_info**\ (\ viewport\: :ref:`RID`, type\: :ref:`ViewportRenderInfoType`, info\: :ref:`ViewportRenderInfo`\ ) Returns a statistic about the rendering engine which can be used for performance profiling. This is separated into render pass ``type``\ s, each of them having the same ``info``\ s you can query (different passes will return different values). See :ref:`ViewportRenderInfoType` for a list of render pass types and :ref:`ViewportRenderInfo` for a list of information that can be queried. @@ -10854,7 +11100,7 @@ See also :ref:`get_rendering_info` **viewport_get_render_target** **(** :ref:`RID` viewport **)** |const| +:ref:`RID` **viewport_get_render_target**\ (\ viewport\: :ref:`RID`\ ) |const| Returns the render target for the viewport. @@ -10866,7 +11112,7 @@ Returns the render target for the viewport. .. rst-class:: classref-method -:ref:`RID` **viewport_get_texture** **(** :ref:`RID` viewport **)** |const| +:ref:`RID` **viewport_get_texture**\ (\ viewport\: :ref:`RID`\ ) |const| Returns the viewport's last rendered frame. @@ -10878,7 +11124,7 @@ Returns the viewport's last rendered frame. .. rst-class:: classref-method -void **viewport_remove_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** +|void| **viewport_remove_canvas**\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`\ ) Detaches a viewport from a canvas and vice versa. @@ -10890,7 +11136,7 @@ Detaches a viewport from a canvas and vice versa. .. rst-class:: classref-method -void **viewport_set_active** **(** :ref:`RID` viewport, :ref:`bool` active **)** +|void| **viewport_set_active**\ (\ viewport\: :ref:`RID`, active\: :ref:`bool`\ ) If ``true``, sets the viewport active, else sets it inactive. @@ -10902,7 +11148,7 @@ If ``true``, sets the viewport active, else sets it inactive. .. rst-class:: classref-method -void **viewport_set_canvas_cull_mask** **(** :ref:`RID` viewport, :ref:`int` canvas_cull_mask **)** +|void| **viewport_set_canvas_cull_mask**\ (\ viewport\: :ref:`RID`, canvas_cull_mask\: :ref:`int`\ ) Sets the rendering mask associated with this :ref:`Viewport`. Only :ref:`CanvasItem` nodes with a matching rendering visibility layer will be rendered by this :ref:`Viewport`. @@ -10914,7 +11160,7 @@ Sets the rendering mask associated with this :ref:`Viewport`. On .. rst-class:: classref-method -void **viewport_set_canvas_stacking** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer, :ref:`int` sublayer **)** +|void| **viewport_set_canvas_stacking**\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`, layer\: :ref:`int`, sublayer\: :ref:`int`\ ) Sets the stacking order for a viewport's canvas. @@ -10928,7 +11174,7 @@ Sets the stacking order for a viewport's canvas. .. rst-class:: classref-method -void **viewport_set_canvas_transform** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** +|void| **viewport_set_canvas_transform**\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`, offset\: :ref:`Transform2D`\ ) Sets the transformation of a viewport's canvas. @@ -10940,7 +11186,7 @@ Sets the transformation of a viewport's canvas. .. rst-class:: classref-method -void **viewport_set_clear_mode** **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** +|void| **viewport_set_clear_mode**\ (\ viewport\: :ref:`RID`, clear_mode\: :ref:`ViewportClearMode`\ ) Sets the clear mode of a viewport. See :ref:`ViewportClearMode` for options. @@ -10952,7 +11198,7 @@ Sets the clear mode of a viewport. See :ref:`ViewportClearMode` viewport, :ref:`ViewportDebugDraw` draw **)** +|void| **viewport_set_debug_draw**\ (\ viewport\: :ref:`RID`, draw\: :ref:`ViewportDebugDraw`\ ) Sets the debug draw mode of a viewport. See :ref:`ViewportDebugDraw` for options. @@ -10964,7 +11210,7 @@ Sets the debug draw mode of a viewport. See :ref:`ViewportDebugDraw` viewport, :ref:`CanvasItemTextureFilter` filter **)** +|void| **viewport_set_default_canvas_item_texture_filter**\ (\ viewport\: :ref:`RID`, filter\: :ref:`CanvasItemTextureFilter`\ ) Sets the default texture filtering mode for the specified ``viewport`` RID. See :ref:`CanvasItemTextureFilter` for options. @@ -10976,7 +11222,7 @@ Sets the default texture filtering mode for the specified ``viewport`` RID. See .. rst-class:: classref-method -void **viewport_set_default_canvas_item_texture_repeat** **(** :ref:`RID` viewport, :ref:`CanvasItemTextureRepeat` repeat **)** +|void| **viewport_set_default_canvas_item_texture_repeat**\ (\ viewport\: :ref:`RID`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) Sets the default texture repeat mode for the specified ``viewport`` RID. See :ref:`CanvasItemTextureRepeat` for options. @@ -10988,7 +11234,7 @@ Sets the default texture repeat mode for the specified ``viewport`` RID. See :re .. rst-class:: classref-method -void **viewport_set_disable_2d** **(** :ref:`RID` viewport, :ref:`bool` disable **)** +|void| **viewport_set_disable_2d**\ (\ viewport\: :ref:`RID`, disable\: :ref:`bool`\ ) If ``true``, the viewport's canvas (i.e. 2D and GUI elements) is not rendered. @@ -11000,7 +11246,7 @@ If ``true``, the viewport's canvas (i.e. 2D and GUI elements) is not rendered. .. rst-class:: classref-method -void **viewport_set_disable_3d** **(** :ref:`RID` viewport, :ref:`bool` disable **)** +|void| **viewport_set_disable_3d**\ (\ viewport\: :ref:`RID`, disable\: :ref:`bool`\ ) If ``true``, the viewport's 3D elements are not rendered. @@ -11012,7 +11258,7 @@ If ``true``, the viewport's 3D elements are not rendered. .. rst-class:: classref-method -void **viewport_set_environment_mode** **(** :ref:`RID` viewport, :ref:`ViewportEnvironmentMode` mode **)** +|void| **viewport_set_environment_mode**\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportEnvironmentMode`\ ) Sets the viewport's environment mode which allows enabling or disabling rendering of 3D environment over 2D canvas. When disabled, 2D will not be affected by the environment. When enabled, 2D will be affected by the environment if the environment background mode is :ref:`ENV_BG_CANVAS`. The default behavior is to inherit the setting from the viewport's parent. If the topmost parent is also set to :ref:`VIEWPORT_ENVIRONMENT_INHERIT`, then the behavior will be the same as if it was set to :ref:`VIEWPORT_ENVIRONMENT_ENABLED`. @@ -11024,7 +11270,7 @@ Sets the viewport's environment mode which allows enabling or disabling renderin .. rst-class:: classref-method -void **viewport_set_fsr_sharpness** **(** :ref:`RID` viewport, :ref:`float` sharpness **)** +|void| **viewport_set_fsr_sharpness**\ (\ viewport\: :ref:`RID`, sharpness\: :ref:`float`\ ) Determines how sharp the upscaled image will be when using the FSR upscaling mode. Sharpness halves with every whole number. Values go from 0.0 (sharpest) to 2.0. Values above 2.0 won't make a visible difference. @@ -11036,7 +11282,7 @@ Determines how sharp the upscaled image will be when using the FSR upscaling mod .. rst-class:: classref-method -void **viewport_set_global_canvas_transform** **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** +|void| **viewport_set_global_canvas_transform**\ (\ viewport\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) Sets the viewport's global transformation matrix. @@ -11048,7 +11294,7 @@ Sets the viewport's global transformation matrix. .. rst-class:: classref-method -void **viewport_set_measure_render_time** **(** :ref:`RID` viewport, :ref:`bool` enable **)** +|void| **viewport_set_measure_render_time**\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) Sets the measurement for the given ``viewport`` RID (obtained using :ref:`Viewport.get_viewport_rid`). Once enabled, :ref:`viewport_get_measured_render_time_cpu` and :ref:`viewport_get_measured_render_time_gpu` will return values greater than ``0.0`` when queried with the given ``viewport``. @@ -11060,7 +11306,7 @@ Sets the measurement for the given ``viewport`` RID (obtained using :ref:`Viewpo .. rst-class:: classref-method -void **viewport_set_msaa_2d** **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** +|void| **viewport_set_msaa_2d**\ (\ viewport\: :ref:`RID`, msaa\: :ref:`ViewportMSAA`\ ) Sets the multisample anti-aliasing mode for 2D/Canvas on the specified ``viewport`` RID. See :ref:`ViewportMSAA` for options. @@ -11072,7 +11318,7 @@ Sets the multisample anti-aliasing mode for 2D/Canvas on the specified ``viewpor .. rst-class:: classref-method -void **viewport_set_msaa_3d** **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** +|void| **viewport_set_msaa_3d**\ (\ viewport\: :ref:`RID`, msaa\: :ref:`ViewportMSAA`\ ) Sets the multisample anti-aliasing mode for 3D on the specified ``viewport`` RID. See :ref:`ViewportMSAA` for options. @@ -11084,7 +11330,7 @@ Sets the multisample anti-aliasing mode for 3D on the specified ``viewport`` RID .. rst-class:: classref-method -void **viewport_set_occlusion_culling_build_quality** **(** :ref:`ViewportOcclusionCullingBuildQuality` quality **)** +|void| **viewport_set_occlusion_culling_build_quality**\ (\ quality\: :ref:`ViewportOcclusionCullingBuildQuality`\ ) Sets the :ref:`ProjectSettings.rendering/occlusion_culling/bvh_build_quality` to use for occlusion culling. This parameter is global and cannot be set on a per-viewport basis. @@ -11096,7 +11342,7 @@ Sets the :ref:`ProjectSettings.rendering/occlusion_culling/bvh_build_quality` rays_per_thread **)** +|void| **viewport_set_occlusion_rays_per_thread**\ (\ rays_per_thread\: :ref:`int`\ ) Sets the :ref:`ProjectSettings.rendering/occlusion_culling/occlusion_rays_per_thread` to use for occlusion culling. This parameter is global and cannot be set on a per-viewport basis. @@ -11108,7 +11354,7 @@ Sets the :ref:`ProjectSettings.rendering/occlusion_culling/occlusion_rays_per_th .. rst-class:: classref-method -void **viewport_set_parent_viewport** **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** +|void| **viewport_set_parent_viewport**\ (\ viewport\: :ref:`RID`, parent_viewport\: :ref:`RID`\ ) Sets the viewport's parent to the viewport specified by the ``parent_viewport`` RID. @@ -11120,7 +11366,7 @@ Sets the viewport's parent to the viewport specified by the ``parent_viewport`` .. rst-class:: classref-method -void **viewport_set_positional_shadow_atlas_quadrant_subdivision** **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** +|void| **viewport_set_positional_shadow_atlas_quadrant_subdivision**\ (\ viewport\: :ref:`RID`, quadrant\: :ref:`int`, subdivision\: :ref:`int`\ ) Sets the number of subdivisions to use in the specified shadow atlas ``quadrant`` for omni and spot shadows. See also :ref:`Viewport.set_positional_shadow_atlas_quadrant_subdiv`. @@ -11132,7 +11378,7 @@ Sets the number of subdivisions to use in the specified shadow atlas ``quadrant` .. rst-class:: classref-method -void **viewport_set_positional_shadow_atlas_size** **(** :ref:`RID` viewport, :ref:`int` size, :ref:`bool` use_16_bits=false **)** +|void| **viewport_set_positional_shadow_atlas_size**\ (\ viewport\: :ref:`RID`, size\: :ref:`int`, use_16_bits\: :ref:`bool` = false\ ) Sets the ``size`` of the shadow atlas's images (used for omni and spot lights) on the viewport specified by the ``viewport`` RID. The value is rounded up to the nearest power of 2. If ``use_16_bits`` is ``true``, use 16 bits for the omni/spot shadow depth map. Enabling this results in shadows having less precision and may result in shadow acne, but can lead to performance improvements on some devices. @@ -11146,7 +11392,7 @@ Sets the ``size`` of the shadow atlas's images (used for omni and spot lights) o .. rst-class:: classref-method -void **viewport_set_render_direct_to_screen** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** +|void| **viewport_set_render_direct_to_screen**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``true``, render the contents of the viewport directly to screen. This allows a low-level optimization where you can skip drawing a viewport to the root viewport. While this optimization can result in a significant increase in speed (especially on older devices), it comes at a cost of usability. When this is enabled, you cannot read from the viewport or from the screen_texture. You also lose the benefit of certain window settings, such as the various stretch modes. Another consequence to be aware of is that in 2D the rendering happens in window coordinates, so if you have a viewport that is double the size of the window, and you set this, then only the portion that fits within the window will be drawn, no automatic scaling is possible, even if your game scene is significantly larger than the window size. @@ -11158,7 +11404,7 @@ If ``true``, render the contents of the viewport directly to screen. This allows .. rst-class:: classref-method -void **viewport_set_scaling_3d_mode** **(** :ref:`RID` viewport, :ref:`ViewportScaling3DMode` scaling_3d_mode **)** +|void| **viewport_set_scaling_3d_mode**\ (\ viewport\: :ref:`RID`, scaling_3d_mode\: :ref:`ViewportScaling3DMode`\ ) Sets the 3D resolution scaling mode. Bilinear scaling renders at different resolution to either undersample or supersample the viewport. FidelityFX Super Resolution 1.0, abbreviated to FSR, is an upscaling technology that produces high quality images at fast framerates by using a spatially aware upscaling algorithm. FSR is slightly more expensive than bilinear, but it produces significantly higher image quality. FSR should be used where possible. @@ -11170,7 +11416,7 @@ Sets the 3D resolution scaling mode. Bilinear scaling renders at different resol .. rst-class:: classref-method -void **viewport_set_scaling_3d_scale** **(** :ref:`RID` viewport, :ref:`float` scale **)** +|void| **viewport_set_scaling_3d_scale**\ (\ viewport\: :ref:`RID`, scale\: :ref:`float`\ ) Scales the 3D render buffer based on the viewport size uses an image filter specified in :ref:`ViewportScaling3DMode` to scale the output image to the full viewport size. Values lower than ``1.0`` can be used to speed up 3D rendering at the cost of quality (undersampling). Values greater than ``1.0`` are only valid for bilinear mode and can be used to improve 3D rendering quality at a high performance cost (supersampling). See also :ref:`ViewportMSAA` for multi-sample antialiasing, which is significantly cheaper but only smoothens the edges of polygons. @@ -11184,7 +11430,7 @@ When using FSR upscaling, AMD recommends exposing the following values as preset .. rst-class:: classref-method -void **viewport_set_scenario** **(** :ref:`RID` viewport, :ref:`RID` scenario **)** +|void| **viewport_set_scenario**\ (\ viewport\: :ref:`RID`, scenario\: :ref:`RID`\ ) Sets a viewport's scenario. The scenario contains information about environment information, reflection atlas, etc. @@ -11196,7 +11442,7 @@ Sets a viewport's scenario. The scenario contains information about environment .. rst-class:: classref-method -void **viewport_set_screen_space_aa** **(** :ref:`RID` viewport, :ref:`ViewportScreenSpaceAA` mode **)** +|void| **viewport_set_screen_space_aa**\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportScreenSpaceAA`\ ) Sets the viewport's screen-space antialiasing mode. @@ -11208,7 +11454,7 @@ Sets the viewport's screen-space antialiasing mode. .. rst-class:: classref-method -void **viewport_set_sdf_oversize_and_scale** **(** :ref:`RID` viewport, :ref:`ViewportSDFOversize` oversize, :ref:`ViewportSDFScale` scale **)** +|void| **viewport_set_sdf_oversize_and_scale**\ (\ viewport\: :ref:`RID`, oversize\: :ref:`ViewportSDFOversize`, scale\: :ref:`ViewportSDFScale`\ ) Sets the viewport's 2D signed distance field :ref:`ProjectSettings.rendering/2d/sdf/oversize` and :ref:`ProjectSettings.rendering/2d/sdf/scale`. This is used when sampling the signed distance field in :ref:`CanvasItem` shaders as well as :ref:`GPUParticles2D` collision. This is *not* used by SDFGI in 3D rendering. @@ -11220,7 +11466,7 @@ Sets the viewport's 2D signed distance field :ref:`ProjectSettings.rendering/2d/ .. rst-class:: classref-method -void **viewport_set_size** **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** +|void| **viewport_set_size**\ (\ viewport\: :ref:`RID`, width\: :ref:`int`, height\: :ref:`int`\ ) Sets the viewport's width and height in pixels. @@ -11232,7 +11478,7 @@ Sets the viewport's width and height in pixels. .. rst-class:: classref-method -void **viewport_set_snap_2d_transforms_to_pixel** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** +|void| **viewport_set_snap_2d_transforms_to_pixel**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``true``, canvas item transforms (i.e. origin position) are snapped to the nearest pixel when rendering. This can lead to a crisper appearance at the cost of less smooth movement, especially when :ref:`Camera2D` smoothing is enabled. Equivalent to :ref:`ProjectSettings.rendering/2d/snap/snap_2d_transforms_to_pixel`. @@ -11244,7 +11490,7 @@ If ``true``, canvas item transforms (i.e. origin position) are snapped to the ne .. rst-class:: classref-method -void **viewport_set_snap_2d_vertices_to_pixel** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** +|void| **viewport_set_snap_2d_vertices_to_pixel**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``true``, canvas item vertices (i.e. polygon points) are snapped to the nearest pixel when rendering. This can lead to a crisper appearance at the cost of less smooth movement, especially when :ref:`Camera2D` smoothing is enabled. Equivalent to :ref:`ProjectSettings.rendering/2d/snap/snap_2d_vertices_to_pixel`. @@ -11256,7 +11502,7 @@ If ``true``, canvas item vertices (i.e. polygon points) are snapped to the neare .. rst-class:: classref-method -void **viewport_set_texture_mipmap_bias** **(** :ref:`RID` viewport, :ref:`float` mipmap_bias **)** +|void| **viewport_set_texture_mipmap_bias**\ (\ viewport\: :ref:`RID`, mipmap_bias\: :ref:`float`\ ) Affects the final texture sharpness by reading from a lower or higher mipmap (also called "texture LOD bias"). Negative values make mipmapped textures sharper but grainier when viewed at a distance, while positive values make mipmapped textures blurrier (even when up close). To get sharper textures at a distance without introducing too much graininess, set this between ``-0.75`` and ``0.0``. Enabling temporal antialiasing (:ref:`ProjectSettings.rendering/anti_aliasing/quality/use_taa`) can help reduce the graininess visible when using negative mipmap bias. @@ -11270,7 +11516,7 @@ Affects the final texture sharpness by reading from a lower or higher mipmap (al .. rst-class:: classref-method -void **viewport_set_transparent_background** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** +|void| **viewport_set_transparent_background**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``true``, the viewport renders its background as transparent. @@ -11282,7 +11528,7 @@ If ``true``, the viewport renders its background as transparent. .. rst-class:: classref-method -void **viewport_set_update_mode** **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** +|void| **viewport_set_update_mode**\ (\ viewport\: :ref:`RID`, update_mode\: :ref:`ViewportUpdateMode`\ ) Sets when the viewport should be updated. See :ref:`ViewportUpdateMode` constants for options. @@ -11294,7 +11540,7 @@ Sets when the viewport should be updated. See :ref:`ViewportUpdateMode` viewport, :ref:`bool` enable **)** +|void| **viewport_set_use_debanding**\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) If ``true``, enables debanding on the specified viewport. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_debanding`. @@ -11306,7 +11552,7 @@ If ``true``, enables debanding on the specified viewport. Equivalent to :ref:`Pr .. rst-class:: classref-method -void **viewport_set_use_hdr_2d** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** +|void| **viewport_set_use_hdr_2d**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) If ``true``, 2D rendering will use a high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ renderer this will be a ``RGBA16`` framebuffer, while when using the Mobile renderer it will be a ``RGB10_A2`` framebuffer. Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen). Practically speaking, this means that the end result of the Viewport will not be clamped into the ``0-1`` range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. This setting has the same effect as :ref:`Viewport.use_hdr_2d`. @@ -11320,7 +11566,7 @@ If ``true``, 2D rendering will use a high dynamic range (HDR) format framebuffer .. rst-class:: classref-method -void **viewport_set_use_occlusion_culling** **(** :ref:`RID` viewport, :ref:`bool` enable **)** +|void| **viewport_set_use_occlusion_culling**\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) If ``true``, enables occlusion culling on the specified viewport. Equivalent to :ref:`ProjectSettings.rendering/occlusion_culling/use_occlusion_culling`. @@ -11332,7 +11578,7 @@ If ``true``, enables occlusion culling on the specified viewport. Equivalent to .. rst-class:: classref-method -void **viewport_set_use_taa** **(** :ref:`RID` viewport, :ref:`bool` enable **)** +|void| **viewport_set_use_taa**\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) If ``true``, use Temporal Anti-Aliasing. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_taa`. @@ -11344,7 +11590,7 @@ If ``true``, use Temporal Anti-Aliasing. Equivalent to :ref:`ProjectSettings.ren .. rst-class:: classref-method -void **viewport_set_use_xr** **(** :ref:`RID` viewport, :ref:`bool` use_xr **)** +|void| **viewport_set_use_xr**\ (\ viewport\: :ref:`RID`, use_xr\: :ref:`bool`\ ) If ``true``, the viewport uses augmented or virtual reality technologies. See :ref:`XRInterface`. @@ -11356,7 +11602,7 @@ If ``true``, the viewport uses augmented or virtual reality technologies. See :r .. rst-class:: classref-method -void **viewport_set_vrs_mode** **(** :ref:`RID` viewport, :ref:`ViewportVRSMode` mode **)** +|void| **viewport_set_vrs_mode**\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportVRSMode`\ ) Sets the Variable Rate Shading (VRS) mode for the viewport. If the GPU does not support VRS, this property is ignored. Equivalent to :ref:`ProjectSettings.rendering/vrs/mode`. @@ -11368,7 +11614,7 @@ Sets the Variable Rate Shading (VRS) mode for the viewport. If the GPU does not .. rst-class:: classref-method -void **viewport_set_vrs_texture** **(** :ref:`RID` viewport, :ref:`RID` texture **)** +|void| **viewport_set_vrs_texture**\ (\ viewport\: :ref:`RID`, texture\: :ref:`RID`\ ) The texture to use when the VRS mode is set to :ref:`VIEWPORT_VRS_TEXTURE`. Equivalent to :ref:`ProjectSettings.rendering/vrs/texture`. @@ -11380,7 +11626,7 @@ The texture to use when the VRS mode is set to :ref:`VIEWPORT_VRS_TEXTURE` **visibility_notifier_create** **(** **)** +:ref:`RID` **visibility_notifier_create**\ (\ ) Creates a new 3D visibility notifier object and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``visibility_notifier_*`` RenderingServer functions. @@ -11398,7 +11644,7 @@ To place in a scene, attach this mesh to an instance using :ref:`instance_set_ba .. rst-class:: classref-method -void **visibility_notifier_set_aabb** **(** :ref:`RID` notifier, :ref:`AABB` aabb **)** +|void| **visibility_notifier_set_aabb**\ (\ notifier\: :ref:`RID`, aabb\: :ref:`AABB`\ ) .. container:: contribute @@ -11412,7 +11658,7 @@ void **visibility_notifier_set_aabb** **(** :ref:`RID` notifier, :ref .. rst-class:: classref-method -void **visibility_notifier_set_callbacks** **(** :ref:`RID` notifier, :ref:`Callable` enter_callable, :ref:`Callable` exit_callable **)** +|void| **visibility_notifier_set_callbacks**\ (\ notifier\: :ref:`RID`, enter_callable\: :ref:`Callable`, exit_callable\: :ref:`Callable`\ ) .. container:: contribute @@ -11426,7 +11672,7 @@ void **visibility_notifier_set_callbacks** **(** :ref:`RID` notifier, .. rst-class:: classref-method -void **voxel_gi_allocate_data** **(** :ref:`RID` voxel_gi, :ref:`Transform3D` to_cell_xform, :ref:`AABB` aabb, :ref:`Vector3i` octree_size, :ref:`PackedByteArray` octree_cells, :ref:`PackedByteArray` data_cells, :ref:`PackedByteArray` distance_field, :ref:`PackedInt32Array` level_counts **)** +|void| **voxel_gi_allocate_data**\ (\ voxel_gi\: :ref:`RID`, to_cell_xform\: :ref:`Transform3D`, aabb\: :ref:`AABB`, octree_size\: :ref:`Vector3i`, octree_cells\: :ref:`PackedByteArray`, data_cells\: :ref:`PackedByteArray`, distance_field\: :ref:`PackedByteArray`, level_counts\: :ref:`PackedInt32Array`\ ) .. container:: contribute @@ -11440,7 +11686,7 @@ void **voxel_gi_allocate_data** **(** :ref:`RID` voxel_gi, :ref:`Tran .. rst-class:: classref-method -:ref:`RID` **voxel_gi_create** **(** **)** +:ref:`RID` **voxel_gi_create**\ (\ ) Creates a new voxel-based global illumination object and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``voxel_gi_*`` RenderingServer functions. @@ -11456,7 +11702,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`PackedByteArray` **voxel_gi_get_data_cells** **(** :ref:`RID` voxel_gi **)** |const| +:ref:`PackedByteArray` **voxel_gi_get_data_cells**\ (\ voxel_gi\: :ref:`RID`\ ) |const| .. container:: contribute @@ -11470,7 +11716,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`PackedByteArray` **voxel_gi_get_distance_field** **(** :ref:`RID` voxel_gi **)** |const| +:ref:`PackedByteArray` **voxel_gi_get_distance_field**\ (\ voxel_gi\: :ref:`RID`\ ) |const| .. container:: contribute @@ -11484,7 +11730,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`PackedInt32Array` **voxel_gi_get_level_counts** **(** :ref:`RID` voxel_gi **)** |const| +:ref:`PackedInt32Array` **voxel_gi_get_level_counts**\ (\ voxel_gi\: :ref:`RID`\ ) |const| .. container:: contribute @@ -11498,7 +11744,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`PackedByteArray` **voxel_gi_get_octree_cells** **(** :ref:`RID` voxel_gi **)** |const| +:ref:`PackedByteArray` **voxel_gi_get_octree_cells**\ (\ voxel_gi\: :ref:`RID`\ ) |const| .. container:: contribute @@ -11512,7 +11758,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`Vector3i` **voxel_gi_get_octree_size** **(** :ref:`RID` voxel_gi **)** |const| +:ref:`Vector3i` **voxel_gi_get_octree_size**\ (\ voxel_gi\: :ref:`RID`\ ) |const| .. container:: contribute @@ -11526,7 +11772,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -:ref:`Transform3D` **voxel_gi_get_to_cell_xform** **(** :ref:`RID` voxel_gi **)** |const| +:ref:`Transform3D` **voxel_gi_get_to_cell_xform**\ (\ voxel_gi\: :ref:`RID`\ ) |const| .. container:: contribute @@ -11540,7 +11786,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. rst-class:: classref-method -void **voxel_gi_set_baked_exposure_normalization** **(** :ref:`RID` voxel_gi, :ref:`float` baked_exposure **)** +|void| **voxel_gi_set_baked_exposure_normalization**\ (\ voxel_gi\: :ref:`RID`, baked_exposure\: :ref:`float`\ ) Used to inform the renderer what exposure normalization value was used while baking the voxel gi. This value will be used and modulated at run time to ensure that the voxel gi maintains a consistent level of exposure even if the scene-wide exposure normalization is changed at run time. For more information see :ref:`camera_attributes_set_exposure`. @@ -11552,7 +11798,7 @@ Used to inform the renderer what exposure normalization value was used while bak .. rst-class:: classref-method -void **voxel_gi_set_bias** **(** :ref:`RID` voxel_gi, :ref:`float` bias **)** +|void| **voxel_gi_set_bias**\ (\ voxel_gi\: :ref:`RID`, bias\: :ref:`float`\ ) Sets the :ref:`VoxelGIData.bias` value to use on the specified ``voxel_gi``'s :ref:`RID`. @@ -11564,7 +11810,7 @@ Sets the :ref:`VoxelGIData.bias` value to use o .. rst-class:: classref-method -void **voxel_gi_set_dynamic_range** **(** :ref:`RID` voxel_gi, :ref:`float` range **)** +|void| **voxel_gi_set_dynamic_range**\ (\ voxel_gi\: :ref:`RID`, range\: :ref:`float`\ ) Sets the :ref:`VoxelGIData.dynamic_range` value to use on the specified ``voxel_gi``'s :ref:`RID`. @@ -11576,7 +11822,7 @@ Sets the :ref:`VoxelGIData.dynamic_range` voxel_gi, :ref:`float` energy **)** +|void| **voxel_gi_set_energy**\ (\ voxel_gi\: :ref:`RID`, energy\: :ref:`float`\ ) Sets the :ref:`VoxelGIData.energy` value to use on the specified ``voxel_gi``'s :ref:`RID`. @@ -11588,7 +11834,7 @@ Sets the :ref:`VoxelGIData.energy` value to u .. rst-class:: classref-method -void **voxel_gi_set_interior** **(** :ref:`RID` voxel_gi, :ref:`bool` enable **)** +|void| **voxel_gi_set_interior**\ (\ voxel_gi\: :ref:`RID`, enable\: :ref:`bool`\ ) Sets the :ref:`VoxelGIData.interior` value to use on the specified ``voxel_gi``'s :ref:`RID`. @@ -11600,7 +11846,7 @@ Sets the :ref:`VoxelGIData.interior` value .. rst-class:: classref-method -void **voxel_gi_set_normal_bias** **(** :ref:`RID` voxel_gi, :ref:`float` bias **)** +|void| **voxel_gi_set_normal_bias**\ (\ voxel_gi\: :ref:`RID`, bias\: :ref:`float`\ ) Sets the :ref:`VoxelGIData.normal_bias` value to use on the specified ``voxel_gi``'s :ref:`RID`. @@ -11612,7 +11858,7 @@ Sets the :ref:`VoxelGIData.normal_bias` .. rst-class:: classref-method -void **voxel_gi_set_propagation** **(** :ref:`RID` voxel_gi, :ref:`float` amount **)** +|void| **voxel_gi_set_propagation**\ (\ voxel_gi\: :ref:`RID`, amount\: :ref:`float`\ ) Sets the :ref:`VoxelGIData.propagation` value to use on the specified ``voxel_gi``'s :ref:`RID`. @@ -11624,7 +11870,7 @@ Sets the :ref:`VoxelGIData.propagation` .. rst-class:: classref-method -void **voxel_gi_set_quality** **(** :ref:`VoxelGIQuality` quality **)** +|void| **voxel_gi_set_quality**\ (\ quality\: :ref:`VoxelGIQuality`\ ) Sets the :ref:`ProjectSettings.rendering/global_illumination/voxel_gi/quality` value to use when rendering. This parameter is global and cannot be set on a per-VoxelGI basis. @@ -11636,7 +11882,7 @@ Sets the :ref:`ProjectSettings.rendering/global_illumination/voxel_gi/quality` voxel_gi, :ref:`bool` enable **)** +|void| **voxel_gi_set_use_two_bounces**\ (\ voxel_gi\: :ref:`RID`, enable\: :ref:`bool`\ ) Sets the :ref:`VoxelGIData.use_two_bounces` value to use on the specified ``voxel_gi``'s :ref:`RID`. @@ -11647,3 +11893,4 @@ Sets the :ref:`VoxelGIData.use_two_bounces` **(** :ref:`RenderSceneBuffersConfiguration` config **)** | - +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`configure`\ (\ config\: :ref:`RenderSceneBuffersConfiguration`\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -50,7 +50,7 @@ Method Descriptions .. rst-class:: classref-method -void **configure** **(** :ref:`RenderSceneBuffersConfiguration` config **)** +|void| **configure**\ (\ config\: :ref:`RenderSceneBuffersConfiguration`\ ) This method is called by the rendering server when the associated viewports configuration is changed. It will discard the old buffers and recreate the internal buffers used. @@ -61,3 +61,4 @@ This method is called by the rendering server when the associated viewports conf .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_renderscenebuffersconfiguration.rst b/classes/class_renderscenebuffersconfiguration.rst index e445a3ddd2c..7d6c636f663 100644 --- a/classes/class_renderscenebuffersconfiguration.rst +++ b/classes/class_renderscenebuffersconfiguration.rst @@ -66,8 +66,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_fsr_sharpness** **(** :ref:`float` value **)** -- :ref:`float` **get_fsr_sharpness** **(** **)** +- |void| **set_fsr_sharpness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fsr_sharpness**\ (\ ) FSR Sharpness applicable if FSR upscaling is used. @@ -83,8 +83,8 @@ FSR Sharpness applicable if FSR upscaling is used. .. rst-class:: classref-property-setget -- void **set_internal_size** **(** :ref:`Vector2i` value **)** -- :ref:`Vector2i` **get_internal_size** **(** **)** +- |void| **set_internal_size**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_internal_size**\ (\ ) The size of the 3D render buffer used for rendering. @@ -100,8 +100,8 @@ The size of the 3D render buffer used for rendering. .. rst-class:: classref-property-setget -- void **set_msaa_3d** **(** :ref:`ViewportMSAA` value **)** -- :ref:`ViewportMSAA` **get_msaa_3d** **(** **)** +- |void| **set_msaa_3d**\ (\ value\: :ref:`ViewportMSAA`\ ) +- :ref:`ViewportMSAA` **get_msaa_3d**\ (\ ) The MSAA mode we're using for 3D rendering. @@ -117,8 +117,8 @@ The MSAA mode we're using for 3D rendering. .. rst-class:: classref-property-setget -- void **set_render_target** **(** :ref:`RID` value **)** -- :ref:`RID` **get_render_target** **(** **)** +- |void| **set_render_target**\ (\ value\: :ref:`RID`\ ) +- :ref:`RID` **get_render_target**\ (\ ) The render target associated with these buffer. @@ -134,8 +134,8 @@ The render target associated with these buffer. .. rst-class:: classref-property-setget -- void **set_scaling_3d_mode** **(** :ref:`ViewportScaling3DMode` value **)** -- :ref:`ViewportScaling3DMode` **get_scaling_3d_mode** **(** **)** +- |void| **set_scaling_3d_mode**\ (\ value\: :ref:`ViewportScaling3DMode`\ ) +- :ref:`ViewportScaling3DMode` **get_scaling_3d_mode**\ (\ ) The requested scaling mode with which we upscale/downscale if :ref:`internal_size` and :ref:`target_size` are not equal. @@ -151,8 +151,8 @@ The requested scaling mode with which we upscale/downscale if :ref:`internal_siz .. rst-class:: classref-property-setget -- void **set_screen_space_aa** **(** :ref:`ViewportScreenSpaceAA` value **)** -- :ref:`ViewportScreenSpaceAA` **get_screen_space_aa** **(** **)** +- |void| **set_screen_space_aa**\ (\ value\: :ref:`ViewportScreenSpaceAA`\ ) +- :ref:`ViewportScreenSpaceAA` **get_screen_space_aa**\ (\ ) The requested screen space AA applied in post processing. @@ -168,8 +168,8 @@ The requested screen space AA applied in post processing. .. rst-class:: classref-property-setget -- void **set_target_size** **(** :ref:`Vector2i` value **)** -- :ref:`Vector2i` **get_target_size** **(** **)** +- |void| **set_target_size**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_target_size**\ (\ ) The target (upscale) size if scaling is used. @@ -185,8 +185,8 @@ The target (upscale) size if scaling is used. .. rst-class:: classref-property-setget -- void **set_texture_mipmap_bias** **(** :ref:`float` value **)** -- :ref:`float` **get_texture_mipmap_bias** **(** **)** +- |void| **set_texture_mipmap_bias**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_texture_mipmap_bias**\ (\ ) Bias applied to mipmaps. @@ -202,8 +202,8 @@ Bias applied to mipmaps. .. rst-class:: classref-property-setget -- void **set_view_count** **(** :ref:`int` value **)** -- :ref:`int` **get_view_count** **(** **)** +- |void| **set_view_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_view_count**\ (\ ) The number of views we're rendering. @@ -214,3 +214,4 @@ The number of views we're rendering. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_renderscenebuffersextension.rst b/classes/class_renderscenebuffersextension.rst index 383b6ae16c7..2c92ebe6deb 100644 --- a/classes/class_renderscenebuffersextension.rst +++ b/classes/class_renderscenebuffersextension.rst @@ -29,15 +29,15 @@ Methods .. table:: :widths: auto - +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_configure` **(** :ref:`RenderSceneBuffersConfiguration` config **)** |virtual| | - +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_fsr_sharpness` **(** :ref:`float` fsr_sharpness **)** |virtual| | - +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_texture_mipmap_bias` **(** :ref:`float` texture_mipmap_bias **)** |virtual| | - +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_use_debanding` **(** :ref:`bool` use_debanding **)** |virtual| | - +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_configure`\ (\ config\: :ref:`RenderSceneBuffersConfiguration`\ ) |virtual| | + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_fsr_sharpness`\ (\ fsr_sharpness\: :ref:`float`\ ) |virtual| | + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_texture_mipmap_bias`\ (\ texture_mipmap_bias\: :ref:`float`\ ) |virtual| | + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_use_debanding`\ (\ use_debanding\: :ref:`bool`\ ) |virtual| | + +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -52,7 +52,7 @@ Method Descriptions .. rst-class:: classref-method -void **_configure** **(** :ref:`RenderSceneBuffersConfiguration` config **)** |virtual| +|void| **_configure**\ (\ config\: :ref:`RenderSceneBuffersConfiguration`\ ) |virtual| Implement this in GDExtension to handle the (re)sizing of a viewport. @@ -64,7 +64,7 @@ Implement this in GDExtension to handle the (re)sizing of a viewport. .. rst-class:: classref-method -void **_set_fsr_sharpness** **(** :ref:`float` fsr_sharpness **)** |virtual| +|void| **_set_fsr_sharpness**\ (\ fsr_sharpness\: :ref:`float`\ ) |virtual| Implement this in GDExtension to record a new FSR sharpness value. @@ -76,7 +76,7 @@ Implement this in GDExtension to record a new FSR sharpness value. .. rst-class:: classref-method -void **_set_texture_mipmap_bias** **(** :ref:`float` texture_mipmap_bias **)** |virtual| +|void| **_set_texture_mipmap_bias**\ (\ texture_mipmap_bias\: :ref:`float`\ ) |virtual| Implement this in GDExtension to change the texture mipmap bias. @@ -88,7 +88,7 @@ Implement this in GDExtension to change the texture mipmap bias. .. rst-class:: classref-method -void **_set_use_debanding** **(** :ref:`bool` use_debanding **)** |virtual| +|void| **_set_use_debanding**\ (\ use_debanding\: :ref:`bool`\ ) |virtual| Implement this in GDExtension to react to the debanding flag changing. @@ -99,3 +99,4 @@ Implement this in GDExtension to react to the debanding flag changing. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_renderscenebuffersrd.rst b/classes/class_renderscenebuffersrd.rst index 6ed9bd560c6..368324f4285 100644 --- a/classes/class_renderscenebuffersrd.rst +++ b/classes/class_renderscenebuffersrd.rst @@ -12,7 +12,7 @@ RenderSceneBuffersRD **Inherits:** :ref:`RenderSceneBuffers` **<** :ref:`RefCounted` **<** :ref:`Object` -Abstract render scene buffer implementation for the RenderingDevice based renderers. +Render scene buffer implementation for the RenderingDevice based renderers. .. rst-class:: classref-introduction-group @@ -25,7 +25,7 @@ All buffers are organized in **contexts**. The default context is called **rende Buffers are only guaranteed to exist during rendering of the viewport. -\ **Note:** this is an internal rendering server object only exposed for GDExtension plugins. +\ **Note:** This is an internal rendering server object, do not instantiate this from script. .. rst-class:: classref-reftable-group @@ -35,47 +35,49 @@ Methods .. table:: :widths: auto - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_context` **(** :ref:`StringName` context **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`create_texture` **(** :ref:`StringName` context, :ref:`StringName` name, :ref:`DataFormat` data_format, :ref:`int` usage_bits, :ref:`TextureSamples` texture_samples, :ref:`Vector2i` size, :ref:`int` layers, :ref:`int` mipmaps, :ref:`bool` unique **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`create_texture_from_format` **(** :ref:`StringName` context, :ref:`StringName` name, :ref:`RDTextureFormat` format, :ref:`RDTextureView` view, :ref:`bool` unique **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`create_texture_view` **(** :ref:`StringName` context, :ref:`StringName` name, :ref:`StringName` view_name, :ref:`RDTextureView` view **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_color_layer` **(** :ref:`int` layer **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_color_texture` **(** **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_depth_layer` **(** :ref:`int` layer **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_depth_texture` **(** **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_internal_size` **(** **)** |const| | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_render_target` **(** **)** |const| | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_texture` **(** :ref:`StringName` context, :ref:`StringName` name **)** |const| | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RDTextureFormat` | :ref:`get_texture_format` **(** :ref:`StringName` context, :ref:`StringName` name **)** |const| | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_texture_slice` **(** :ref:`StringName` context, :ref:`StringName` name, :ref:`int` layer, :ref:`int` mipmap, :ref:`int` layers, :ref:`int` mipmaps **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_texture_slice_size` **(** :ref:`StringName` context, :ref:`StringName` name, :ref:`int` mipmap **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_texture_slice_view` **(** :ref:`StringName` context, :ref:`StringName` name, :ref:`int` layer, :ref:`int` mipmap, :ref:`int` layers, :ref:`int` mipmaps, :ref:`RDTextureView` view **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_use_taa` **(** **)** |const| | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_velocity_layer` **(** :ref:`int` layer **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_velocity_texture` **(** **)** | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_view_count` **(** **)** |const| | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_texture` **(** :ref:`StringName` context, :ref:`StringName` name **)** |const| | - +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_context`\ (\ context\: :ref:`StringName`\ ) | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`create_texture`\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, data_format\: :ref:`DataFormat`, usage_bits\: :ref:`int`, texture_samples\: :ref:`TextureSamples`, size\: :ref:`Vector2i`, layers\: :ref:`int`, mipmaps\: :ref:`int`, unique\: :ref:`bool`\ ) | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`create_texture_from_format`\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, format\: :ref:`RDTextureFormat`, view\: :ref:`RDTextureView`, unique\: :ref:`bool`\ ) | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`create_texture_view`\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, view_name\: :ref:`StringName`, view\: :ref:`RDTextureView`\ ) | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_color_layer`\ (\ layer\: :ref:`int`, msaa\: :ref:`bool` = false\ ) | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_color_texture`\ (\ msaa\: :ref:`bool` = false\ ) | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_depth_layer`\ (\ layer\: :ref:`int`, msaa\: :ref:`bool` = false\ ) | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_depth_texture`\ (\ msaa\: :ref:`bool` = false\ ) | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_internal_size`\ (\ ) |const| | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ViewportMSAA` | :ref:`get_msaa_3d`\ (\ ) |const| | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_render_target`\ (\ ) |const| | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_texture`\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RDTextureFormat` | :ref:`get_texture_format`\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_texture_slice`\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, layer\: :ref:`int`, mipmap\: :ref:`int`, layers\: :ref:`int`, mipmaps\: :ref:`int`\ ) | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_texture_slice_size`\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, mipmap\: :ref:`int`\ ) | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_texture_slice_view`\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, layer\: :ref:`int`, mipmap\: :ref:`int`, layers\: :ref:`int`, mipmaps\: :ref:`int`, view\: :ref:`RDTextureView`\ ) | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_use_taa`\ (\ ) |const| | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_velocity_layer`\ (\ layer\: :ref:`int`, msaa\: :ref:`bool` = false\ ) | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_velocity_texture`\ (\ msaa\: :ref:`bool` = false\ ) | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_view_count`\ (\ ) |const| | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_texture`\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| | + +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -90,7 +92,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear_context** **(** :ref:`StringName` context **)** +|void| **clear_context**\ (\ context\: :ref:`StringName`\ ) Frees all buffers related to this context. @@ -102,7 +104,7 @@ Frees all buffers related to this context. .. rst-class:: classref-method -:ref:`RID` **create_texture** **(** :ref:`StringName` context, :ref:`StringName` name, :ref:`DataFormat` data_format, :ref:`int` usage_bits, :ref:`TextureSamples` texture_samples, :ref:`Vector2i` size, :ref:`int` layers, :ref:`int` mipmaps, :ref:`bool` unique **)** +:ref:`RID` **create_texture**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, data_format\: :ref:`DataFormat`, usage_bits\: :ref:`int`, texture_samples\: :ref:`TextureSamples`, size\: :ref:`Vector2i`, layers\: :ref:`int`, mipmaps\: :ref:`int`, unique\: :ref:`bool`\ ) Create a new texture with the given definition and cache this under the given name. Will return the existing texture if it already exists. @@ -114,7 +116,7 @@ Create a new texture with the given definition and cache this under the given na .. rst-class:: classref-method -:ref:`RID` **create_texture_from_format** **(** :ref:`StringName` context, :ref:`StringName` name, :ref:`RDTextureFormat` format, :ref:`RDTextureView` view, :ref:`bool` unique **)** +:ref:`RID` **create_texture_from_format**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, format\: :ref:`RDTextureFormat`, view\: :ref:`RDTextureView`, unique\: :ref:`bool`\ ) Create a new texture using the given format and view and cache this under the given name. Will return the existing texture if it already exists. @@ -126,7 +128,7 @@ Create a new texture using the given format and view and cache this under the gi .. rst-class:: classref-method -:ref:`RID` **create_texture_view** **(** :ref:`StringName` context, :ref:`StringName` name, :ref:`StringName` view_name, :ref:`RDTextureView` view **)** +:ref:`RID` **create_texture_view**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, view_name\: :ref:`StringName`, view\: :ref:`RDTextureView`\ ) Create a new texture view for an existing texture and cache this under the given view_name. Will return the existing teture view if it already exists. Will error if the source texture doesn't exist. @@ -138,10 +140,12 @@ Create a new texture view for an existing texture and cache this under the given .. rst-class:: classref-method -:ref:`RID` **get_color_layer** **(** :ref:`int` layer **)** +:ref:`RID` **get_color_layer**\ (\ layer\: :ref:`int`, msaa\: :ref:`bool` = false\ ) Returns the specified layer from the color texture we are rendering 3D content to. +If ``msaa`` is **true** and MSAA is enabled, this returns the MSAA variant of the buffer. + .. rst-class:: classref-item-separator ---- @@ -150,10 +154,12 @@ Returns the specified layer from the color texture we are rendering 3D content t .. rst-class:: classref-method -:ref:`RID` **get_color_texture** **(** **)** +:ref:`RID` **get_color_texture**\ (\ msaa\: :ref:`bool` = false\ ) Returns the color texture we are rendering 3D content to. If multiview is used this will be a texture array with all views. +If ``msaa`` is **true** and MSAA is enabled, this returns the MSAA variant of the buffer. + .. rst-class:: classref-item-separator ---- @@ -162,10 +168,12 @@ Returns the color texture we are rendering 3D content to. If multiview is used t .. rst-class:: classref-method -:ref:`RID` **get_depth_layer** **(** :ref:`int` layer **)** +:ref:`RID` **get_depth_layer**\ (\ layer\: :ref:`int`, msaa\: :ref:`bool` = false\ ) Returns the specified layer from the depth texture we are rendering 3D content to. +If ``msaa`` is **true** and MSAA is enabled, this returns the MSAA variant of the buffer. + .. rst-class:: classref-item-separator ---- @@ -174,10 +182,12 @@ Returns the specified layer from the depth texture we are rendering 3D content t .. rst-class:: classref-method -:ref:`RID` **get_depth_texture** **(** **)** +:ref:`RID` **get_depth_texture**\ (\ msaa\: :ref:`bool` = false\ ) Returns the depth texture we are rendering 3D content to. If multiview is used this will be a texture array with all views. +If ``msaa`` is **true** and MSAA is enabled, this returns the MSAA variant of the buffer. + .. rst-class:: classref-item-separator ---- @@ -186,7 +196,7 @@ Returns the depth texture we are rendering 3D content to. If multiview is used t .. rst-class:: classref-method -:ref:`Vector2i` **get_internal_size** **(** **)** |const| +:ref:`Vector2i` **get_internal_size**\ (\ ) |const| Returns the internal size of the render buffer (size before upscaling) with which textures are created by default. @@ -194,11 +204,23 @@ Returns the internal size of the render buffer (size before upscaling) with whic ---- +.. _class_RenderSceneBuffersRD_method_get_msaa_3d: + +.. rst-class:: classref-method + +:ref:`ViewportMSAA` **get_msaa_3d**\ (\ ) |const| + +Returns the applied 3D MSAA mode for this viewport. + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderSceneBuffersRD_method_get_render_target: .. rst-class:: classref-method -:ref:`RID` **get_render_target** **(** **)** |const| +:ref:`RID` **get_render_target**\ (\ ) |const| Returns the render target associated with this buffers object. @@ -210,7 +232,7 @@ Returns the render target associated with this buffers object. .. rst-class:: classref-method -:ref:`RID` **get_texture** **(** :ref:`StringName` context, :ref:`StringName` name **)** |const| +:ref:`RID` **get_texture**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| Returns a cached texture with this name. @@ -222,7 +244,7 @@ Returns a cached texture with this name. .. rst-class:: classref-method -:ref:`RDTextureFormat` **get_texture_format** **(** :ref:`StringName` context, :ref:`StringName` name **)** |const| +:ref:`RDTextureFormat` **get_texture_format**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| Returns the texture format information with which a cached texture was created. @@ -234,7 +256,7 @@ Returns the texture format information with which a cached texture was created. .. rst-class:: classref-method -:ref:`RID` **get_texture_slice** **(** :ref:`StringName` context, :ref:`StringName` name, :ref:`int` layer, :ref:`int` mipmap, :ref:`int` layers, :ref:`int` mipmaps **)** +:ref:`RID` **get_texture_slice**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, layer\: :ref:`int`, mipmap\: :ref:`int`, layers\: :ref:`int`, mipmaps\: :ref:`int`\ ) Returns a specific slice (layer or mipmap) for a cached texture. @@ -246,7 +268,7 @@ Returns a specific slice (layer or mipmap) for a cached texture. .. rst-class:: classref-method -:ref:`Vector2i` **get_texture_slice_size** **(** :ref:`StringName` context, :ref:`StringName` name, :ref:`int` mipmap **)** +:ref:`Vector2i` **get_texture_slice_size**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, mipmap\: :ref:`int`\ ) Returns the texture size of a given slice of a cached texture. @@ -258,7 +280,7 @@ Returns the texture size of a given slice of a cached texture. .. rst-class:: classref-method -:ref:`RID` **get_texture_slice_view** **(** :ref:`StringName` context, :ref:`StringName` name, :ref:`int` layer, :ref:`int` mipmap, :ref:`int` layers, :ref:`int` mipmaps, :ref:`RDTextureView` view **)** +:ref:`RID` **get_texture_slice_view**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`, layer\: :ref:`int`, mipmap\: :ref:`int`, layers\: :ref:`int`, mipmaps\: :ref:`int`, view\: :ref:`RDTextureView`\ ) Returns a specific view of a slice (layer or mipmap) for a cached texture. @@ -270,7 +292,7 @@ Returns a specific view of a slice (layer or mipmap) for a cached texture. .. rst-class:: classref-method -:ref:`bool` **get_use_taa** **(** **)** |const| +:ref:`bool` **get_use_taa**\ (\ ) |const| Returns ``true`` if TAA is enabled. @@ -282,7 +304,7 @@ Returns ``true`` if TAA is enabled. .. rst-class:: classref-method -:ref:`RID` **get_velocity_layer** **(** :ref:`int` layer **)** +:ref:`RID` **get_velocity_layer**\ (\ layer\: :ref:`int`, msaa\: :ref:`bool` = false\ ) Returns the specified layer from the velocity texture we are rendering 3D content to. @@ -294,10 +316,12 @@ Returns the specified layer from the velocity texture we are rendering 3D conten .. rst-class:: classref-method -:ref:`RID` **get_velocity_texture** **(** **)** +:ref:`RID` **get_velocity_texture**\ (\ msaa\: :ref:`bool` = false\ ) Returns the velocity texture we are rendering 3D content to. If multiview is used this will be a texture array with all views. +If ``msaa`` is **true** and MSAA is enabled, this returns the MSAA variant of the buffer. + .. rst-class:: classref-item-separator ---- @@ -306,7 +330,7 @@ Returns the velocity texture we are rendering 3D content to. If multiview is use .. rst-class:: classref-method -:ref:`int` **get_view_count** **(** **)** |const| +:ref:`int` **get_view_count**\ (\ ) |const| Returns the view count for the associated viewport. @@ -318,7 +342,7 @@ Returns the view count for the associated viewport. .. rst-class:: classref-method -:ref:`bool` **has_texture** **(** :ref:`StringName` context, :ref:`StringName` name **)** |const| +:ref:`bool` **has_texture**\ (\ context\: :ref:`StringName`, name\: :ref:`StringName`\ ) |const| Returns ``true`` if a cached texture exists for this name. @@ -329,3 +353,4 @@ Returns ``true`` if a cached texture exists for this name. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_renderscenedata.rst b/classes/class_renderscenedata.rst new file mode 100644 index 00000000000..9116952c1a6 --- /dev/null +++ b/classes/class_renderscenedata.rst @@ -0,0 +1,140 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderSceneData.xml. + +.. _class_RenderSceneData: + +RenderSceneData +=============== + +**Inherits:** :ref:`Object` + +**Inherited By:** :ref:`RenderSceneDataExtension`, :ref:`RenderSceneDataRD` + +Abstract render data object, holds scene data related to rendering a single frame of a viewport. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Abstract scene data object, exists for the duration of rendering a single viewport. + +\ **Note:** This is an internal rendering server object, do not instantiate this from script. + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`get_cam_projection`\ (\ ) |const| | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`get_cam_transform`\ (\ ) |const| | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_uniform_buffer`\ (\ ) |const| | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_view_count`\ (\ ) |const| | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_view_eye_offset`\ (\ view\: :ref:`int`\ ) |const| | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`get_view_projection`\ (\ view\: :ref:`int`\ ) |const| | + +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_RenderSceneData_method_get_cam_projection: + +.. rst-class:: classref-method + +:ref:`Projection` **get_cam_projection**\ (\ ) |const| + +Returns the camera projection used to render this frame. + +\ **Note:** If more than one view is rendered, this will return a combined projection. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderSceneData_method_get_cam_transform: + +.. rst-class:: classref-method + +:ref:`Transform3D` **get_cam_transform**\ (\ ) |const| + +Returns the camera transform used to render this frame. + +\ **Note:** If more than one view is rendered, this will return a centered transform. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderSceneData_method_get_uniform_buffer: + +.. rst-class:: classref-method + +:ref:`RID` **get_uniform_buffer**\ (\ ) |const| + +Return the :ref:`RID` of the uniform buffer containing the scene data as a UBO. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderSceneData_method_get_view_count: + +.. rst-class:: classref-method + +:ref:`int` **get_view_count**\ (\ ) |const| + +Returns the number of views being rendered. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderSceneData_method_get_view_eye_offset: + +.. rst-class:: classref-method + +:ref:`Vector3` **get_view_eye_offset**\ (\ view\: :ref:`int`\ ) |const| + +Returns the eye offset per view used to render this frame. This is the offset between our camera transform and the eye transform. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderSceneData_method_get_view_projection: + +.. rst-class:: classref-method + +:ref:`Projection` **get_view_projection**\ (\ view\: :ref:`int`\ ) |const| + +Returns the view projection per view used to render this frame. + +\ **Note:** If a single view is rendered, this returns the camera projection. If more than one view is rendered, this will return a projection for the given view including the eye offset. + +.. |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.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_renderscenedataextension.rst b/classes/class_renderscenedataextension.rst new file mode 100644 index 00000000000..81c75f175ac --- /dev/null +++ b/classes/class_renderscenedataextension.rst @@ -0,0 +1,130 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderSceneDataExtension.xml. + +.. _class_RenderSceneDataExtension: + +RenderSceneDataExtension +======================== + +**Inherits:** :ref:`RenderSceneData` **<** :ref:`Object` + +This class allows for a RenderSceneData implementation to be made in GDExtension. + +.. rst-class:: classref-introduction-group + +Description +----------- + +This class allows for a RenderSceneData implementation to be made in GDExtension. + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`_get_cam_projection`\ (\ ) |virtual| |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`_get_cam_transform`\ (\ ) |virtual| |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_get_uniform_buffer`\ (\ ) |virtual| |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_view_count`\ (\ ) |virtual| |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`_get_view_eye_offset`\ (\ view\: :ref:`int`\ ) |virtual| |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Projection` | :ref:`_get_view_projection`\ (\ view\: :ref:`int`\ ) |virtual| |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_RenderSceneDataExtension_private_method__get_cam_projection: + +.. rst-class:: classref-method + +:ref:`Projection` **_get_cam_projection**\ (\ ) |virtual| |const| + +Implement this in GDExtension to return the camera :ref:`Projection`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderSceneDataExtension_private_method__get_cam_transform: + +.. rst-class:: classref-method + +:ref:`Transform3D` **_get_cam_transform**\ (\ ) |virtual| |const| + +Implement this in GDExtension to return the camera :ref:`Transform3D`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderSceneDataExtension_private_method__get_uniform_buffer: + +.. rst-class:: classref-method + +:ref:`RID` **_get_uniform_buffer**\ (\ ) |virtual| |const| + +Implement this in GDExtension to return the :ref:`RID` of the uniform buffer containing the scene data as a UBO. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderSceneDataExtension_private_method__get_view_count: + +.. rst-class:: classref-method + +:ref:`int` **_get_view_count**\ (\ ) |virtual| |const| + +Implement this in GDExtension to return the view count. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderSceneDataExtension_private_method__get_view_eye_offset: + +.. rst-class:: classref-method + +:ref:`Vector3` **_get_view_eye_offset**\ (\ view\: :ref:`int`\ ) |virtual| |const| + +Implement this in GDExtension to return the eye offset for the given ``view``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_RenderSceneDataExtension_private_method__get_view_projection: + +.. rst-class:: classref-method + +:ref:`Projection` **_get_view_projection**\ (\ view\: :ref:`int`\ ) |virtual| |const| + +Implement this in GDExtension to return the view :ref:`Projection` for the given ``view``. + +.. |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.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_renderscenedatard.rst b/classes/class_renderscenedatard.rst new file mode 100644 index 00000000000..c95cc7b3023 --- /dev/null +++ b/classes/class_renderscenedatard.rst @@ -0,0 +1,33 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderSceneDataRD.xml. + +.. _class_RenderSceneDataRD: + +RenderSceneDataRD +================= + +**Inherits:** :ref:`RenderSceneData` **<** :ref:`Object` + +Render scene data implementation for the RenderingDevice based renderers. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Object holds scene data related to rendering a single frame of a viewport. + +\ **Note:** This is an internal rendering server object, do not instantiate this from script. + +.. |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.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 908fca43843..54208e0b76f 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -12,7 +12,7 @@ Resource **Inherits:** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`Animation`, :ref:`AnimationLibrary`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BitMap`, :ref:`BoneMap`, :ref:`ButtonGroup`, :ref:`CameraAttributes`, :ref:`CryptoKey`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`EditorNode3DGizmoPlugin`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`Font`, :ref:`GDExtension`, :ref:`GLTFAccessor`, :ref:`GLTFAnimation`, :ref:`GLTFBufferView`, :ref:`GLTFCamera`, :ref:`GLTFDocument`, :ref:`GLTFDocumentExtension`, :ref:`GLTFLight`, :ref:`GLTFMesh`, :ref:`GLTFNode`, :ref:`GLTFPhysicsBody`, :ref:`GLTFPhysicsShape`, :ref:`GLTFSkeleton`, :ref:`GLTFSkin`, :ref:`GLTFSpecGloss`, :ref:`GLTFState`, :ref:`GLTFTexture`, :ref:`GLTFTextureSampler`, :ref:`Gradient`, :ref:`Image`, :ref:`ImporterMesh`, :ref:`InputEvent`, :ref:`JSON`, :ref:`LabelSettings`, :ref:`LightmapGIData`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MissingResource`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationMeshSourceGeometryData2D`, :ref:`NavigationMeshSourceGeometryData3D`, :ref:`NavigationPolygon`, :ref:`Noise`, :ref:`Occluder3D`, :ref:`OccluderPolygon2D`, :ref:`OggPacketSequence`, :ref:`OpenXRAction`, :ref:`OpenXRActionMap`, :ref:`OpenXRActionSet`, :ref:`OpenXRInteractionProfile`, :ref:`OpenXRIPBinding`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RDShaderFile`, :ref:`RDShaderSPIRV`, :ref:`RichTextEffect`, :ref:`SceneReplicationConfig`, :ref:`Script`, :ref:`Shader`, :ref:`ShaderInclude`, :ref:`Shape2D`, :ref:`Shape3D`, :ref:`Shortcut`, :ref:`SkeletonModification2D`, :ref:`SkeletonModificationStack2D`, :ref:`SkeletonProfile`, :ref:`Skin`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`SyntaxHighlighter`, :ref:`Texture`, :ref:`Theme`, :ref:`TileMapPattern`, :ref:`TileSet`, :ref:`TileSetSource`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VideoStreamPlayback`, :ref:`VisualShaderNode`, :ref:`VoxelGIData`, :ref:`World2D`, :ref:`World3D`, :ref:`X509Certificate` +**Inherited By:** :ref:`Animation`, :ref:`AnimationLibrary`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BitMap`, :ref:`BoneMap`, :ref:`ButtonGroup`, :ref:`CameraAttributes`, :ref:`Compositor`, :ref:`CompositorEffect`, :ref:`CryptoKey`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`EditorNode3DGizmoPlugin`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`Font`, :ref:`GDExtension`, :ref:`GLTFAccessor`, :ref:`GLTFAnimation`, :ref:`GLTFBufferView`, :ref:`GLTFCamera`, :ref:`GLTFDocument`, :ref:`GLTFDocumentExtension`, :ref:`GLTFLight`, :ref:`GLTFMesh`, :ref:`GLTFNode`, :ref:`GLTFPhysicsBody`, :ref:`GLTFPhysicsShape`, :ref:`GLTFSkeleton`, :ref:`GLTFSkin`, :ref:`GLTFSpecGloss`, :ref:`GLTFState`, :ref:`GLTFTexture`, :ref:`GLTFTextureSampler`, :ref:`Gradient`, :ref:`Image`, :ref:`ImporterMesh`, :ref:`InputEvent`, :ref:`JSON`, :ref:`LabelSettings`, :ref:`LightmapGIData`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MissingResource`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationMeshSourceGeometryData2D`, :ref:`NavigationMeshSourceGeometryData3D`, :ref:`NavigationPolygon`, :ref:`Noise`, :ref:`Occluder3D`, :ref:`OccluderPolygon2D`, :ref:`OggPacketSequence`, :ref:`OpenXRAction`, :ref:`OpenXRActionMap`, :ref:`OpenXRActionSet`, :ref:`OpenXRInteractionProfile`, :ref:`OpenXRIPBinding`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RDShaderFile`, :ref:`RDShaderSPIRV`, :ref:`RichTextEffect`, :ref:`SceneReplicationConfig`, :ref:`Script`, :ref:`Shader`, :ref:`ShaderInclude`, :ref:`Shape2D`, :ref:`Shape3D`, :ref:`Shortcut`, :ref:`SkeletonModification2D`, :ref:`SkeletonModificationStack2D`, :ref:`SkeletonProfile`, :ref:`Skin`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`SyntaxHighlighter`, :ref:`Texture`, :ref:`Theme`, :ref:`TileMapPattern`, :ref:`TileSet`, :ref:`TileSetSource`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VideoStreamPlayback`, :ref:`VisualShaderNode`, :ref:`VoxelGIData`, :ref:`World2D`, :ref:`World3D`, :ref:`X509Certificate` Base class for serializable objects. @@ -62,23 +62,23 @@ Methods .. table:: :widths: auto - +---------------------------------+------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_get_rid` **(** **)** |virtual| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_setup_local_to_scene` **(** **)** |virtual| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`duplicate` **(** :ref:`bool` subresources=false **)** |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`emit_changed` **(** **)** | - +---------------------------------+------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`get_local_scene` **(** **)** |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`setup_local_to_scene` **(** **)** | - +---------------------------------+------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`take_over_path` **(** :ref:`String` path **)** | - +---------------------------------+------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_get_rid`\ (\ ) |virtual| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_setup_local_to_scene`\ (\ ) |virtual| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`duplicate`\ (\ subresources\: :ref:`bool` = false\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`emit_changed`\ (\ ) | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`get_local_scene`\ (\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`setup_local_to_scene`\ (\ ) | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`take_over_path`\ (\ path\: :ref:`String`\ ) | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -93,7 +93,7 @@ Signals .. rst-class:: classref-signal -**changed** **(** **)** +**changed**\ (\ ) Emitted when the resource changes, usually when one of its properties is modified. See also :ref:`emit_changed`. @@ -107,7 +107,7 @@ Emitted when the resource changes, usually when one of its properties is modifie .. rst-class:: classref-signal -**setup_local_to_scene_requested** **(** **)** +**setup_local_to_scene_requested**\ (\ ) **Deprecated:** This signal is only emitted when the resource is created. Override :ref:`_setup_local_to_scene` instead. @@ -130,8 +130,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_local_to_scene** **(** :ref:`bool` value **)** -- :ref:`bool` **is_local_to_scene** **(** **)** +- |void| **set_local_to_scene**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_local_to_scene**\ (\ ) If ``true``, the resource is duplicated for each instance of all scenes using it. At run-time, the resource can be modified in one scene without affecting other instances (see :ref:`PackedScene.instantiate`). @@ -149,8 +149,8 @@ If ``true``, the resource is duplicated for each instance of all scenes using it .. rst-class:: classref-property-setget -- void **set_name** **(** :ref:`String` value **)** -- :ref:`String` **get_name** **(** **)** +- |void| **set_name**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_name**\ (\ ) An optional name for this resource. When defined, its value is displayed to represent the resource in the Inspector dock. For built-in scripts, the name is displayed as part of the tab name in the script editor. @@ -168,8 +168,8 @@ An optional name for this resource. When defined, its value is displayed to repr .. rst-class:: classref-property-setget -- void **set_path** **(** :ref:`String` value **)** -- :ref:`String` **get_path** **(** **)** +- |void| **set_path**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_path**\ (\ ) The unique path to this resource. If it has been saved to disk, the value will be its filepath. If the resource is exclusively contained within a scene, the value will be the :ref:`PackedScene`'s filepath, followed by a unique identifier. @@ -188,7 +188,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **_get_rid** **(** **)** |virtual| +:ref:`RID` **_get_rid**\ (\ ) |virtual| Override this method to return a custom :ref:`RID` when :ref:`get_rid` is called. @@ -200,7 +200,7 @@ Override this method to return a custom :ref:`RID` when :ref:`get_rid .. rst-class:: classref-method -void **_setup_local_to_scene** **(** **)** |virtual| +|void| **_setup_local_to_scene**\ (\ ) |virtual| Override this method to customize the newly duplicated resource created from :ref:`PackedScene.instantiate`, if the original's :ref:`resource_local_to_scene` is set to ``true``. @@ -223,7 +223,7 @@ Override this method to customize the newly duplicated resource created from :re .. rst-class:: classref-method -:ref:`Resource` **duplicate** **(** :ref:`bool` subresources=false **)** |const| +:ref:`Resource` **duplicate**\ (\ subresources\: :ref:`bool` = false\ ) |const| Duplicates this resource, returning a new resource with its ``export``\ ed or :ref:`@GlobalScope.PROPERTY_USAGE_STORAGE` properties copied from the original. @@ -241,7 +241,7 @@ Subresource properties with the :ref:`@GlobalScope.PROPERTY_USAGE_ALWAYS_DUPLICA .. rst-class:: classref-method -void **emit_changed** **(** **)** +|void| **emit_changed**\ (\ ) Emits the :ref:`changed` signal. This method is called automatically for some built-in resources. @@ -263,7 +263,7 @@ Emits the :ref:`changed` signal. This method is c .. rst-class:: classref-method -:ref:`Node` **get_local_scene** **(** **)** |const| +:ref:`Node` **get_local_scene**\ (\ ) |const| If :ref:`resource_local_to_scene` is set to ``true`` and the resource has been loaded from a :ref:`PackedScene` instantiation, returns the root :ref:`Node` of the scene where this resource is used. Otherwise, returns ``null``. @@ -275,7 +275,7 @@ If :ref:`resource_local_to_scene` **get_rid** **(** **)** |const| +:ref:`RID` **get_rid**\ (\ ) |const| Returns the :ref:`RID` of this resource (or an empty RID). Many resources (such as :ref:`Texture2D`, :ref:`Mesh`, and so on) are high-level abstractions of resources stored in a specialized server (:ref:`DisplayServer`, :ref:`RenderingServer`, etc.), so this function will return the original :ref:`RID`. @@ -287,9 +287,9 @@ Returns the :ref:`RID` of this resource (or an empty RID). Many resou .. rst-class:: classref-method -void **setup_local_to_scene** **(** **)** +|void| **setup_local_to_scene**\ (\ ) -**Deprecated:** This method should only be called internally. Override :ref:`_setup_local_to_scene` instead. +**Deprecated:** This method should only be called internally. Calls :ref:`_setup_local_to_scene`. If :ref:`resource_local_to_scene` is set to ``true``, this method is automatically called from :ref:`PackedScene.instantiate` by the newly duplicated resource within the scene instance. @@ -301,7 +301,7 @@ Calls :ref:`_setup_local_to_scene` path **)** +|void| **take_over_path**\ (\ path\: :ref:`String`\ ) Sets the :ref:`resource_path` to ``path``, potentially overriding an existing cache entry for this path. Further attempts to load an overridden resource by path will instead return this resource. @@ -312,3 +312,4 @@ Sets the :ref:`resource_path` to ``path`` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourceformatloader.rst b/classes/class_resourceformatloader.rst index e72df80e37c..a90f7398948 100644 --- a/classes/class_resourceformatloader.rst +++ b/classes/class_resourceformatloader.rst @@ -33,29 +33,29 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_exists` **(** :ref:`String` path **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_classes_used` **(** :ref:`String` path **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_dependencies` **(** :ref:`String` path, :ref:`bool` add_types **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_recognized_extensions` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_resource_script_class` **(** :ref:`String` path **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_resource_type` **(** :ref:`String` path **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_resource_uid` **(** :ref:`String` path **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_handles_type` **(** :ref:`StringName` type **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_load` **(** :ref:`String` path, :ref:`String` original_path, :ref:`bool` use_sub_threads, :ref:`int` cache_mode **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_recognize_path` **(** :ref:`String` path, :ref:`StringName` type **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_rename_dependencies` **(** :ref:`String` path, :ref:`Dictionary` renames **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_exists`\ (\ path\: :ref:`String`\ ) |virtual| |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_classes_used`\ (\ path\: :ref:`String`\ ) |virtual| |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_dependencies`\ (\ path\: :ref:`String`, add_types\: :ref:`bool`\ ) |virtual| |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_recognized_extensions`\ (\ ) |virtual| |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_resource_script_class`\ (\ path\: :ref:`String`\ ) |virtual| |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_resource_type`\ (\ path\: :ref:`String`\ ) |virtual| |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_resource_uid`\ (\ path\: :ref:`String`\ ) |virtual| |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_handles_type`\ (\ type\: :ref:`StringName`\ ) |virtual| |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_load`\ (\ path\: :ref:`String`, original_path\: :ref:`String`, use_sub_threads\: :ref:`bool`, cache_mode\: :ref:`int`\ ) |virtual| |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_recognize_path`\ (\ path\: :ref:`String`, type\: :ref:`StringName`\ ) |virtual| |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_rename_dependencies`\ (\ path\: :ref:`String`, renames\: :ref:`Dictionary`\ ) |virtual| |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -121,7 +121,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_exists** **(** :ref:`String` path **)** |virtual| |const| +:ref:`bool` **_exists**\ (\ path\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -135,7 +135,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_classes_used** **(** :ref:`String` path **)** |virtual| |const| +:ref:`PackedStringArray` **_get_classes_used**\ (\ path\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -149,7 +149,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_dependencies** **(** :ref:`String` path, :ref:`bool` add_types **)** |virtual| |const| +:ref:`PackedStringArray` **_get_dependencies**\ (\ path\: :ref:`String`, add_types\: :ref:`bool`\ ) |virtual| |const| If implemented, gets the dependencies of a given resource. If ``add_types`` is ``true``, paths should be appended ``::TypeName``, where ``TypeName`` is the class name of the dependency. @@ -163,7 +163,7 @@ If implemented, gets the dependencies of a given resource. If ``add_types`` is ` .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_recognized_extensions** **(** **)** |virtual| |const| +:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ ) |virtual| |const| Gets the list of extensions for files this loader is able to read. @@ -175,7 +175,7 @@ Gets the list of extensions for files this loader is able to read. .. rst-class:: classref-method -:ref:`String` **_get_resource_script_class** **(** :ref:`String` path **)** |virtual| |const| +:ref:`String` **_get_resource_script_class**\ (\ path\: :ref:`String`\ ) |virtual| |const| Returns the script class name associated with the :ref:`Resource` under the given ``path``. If the resource has no script or the script isn't a named class, it should return ``""``. @@ -187,7 +187,7 @@ Returns the script class name associated with the :ref:`Resource .. rst-class:: classref-method -:ref:`String` **_get_resource_type** **(** :ref:`String` path **)** |virtual| |const| +:ref:`String` **_get_resource_type**\ (\ path\: :ref:`String`\ ) |virtual| |const| Gets the class name of the resource associated with the given path. If the loader cannot handle it, it should return ``""``. @@ -201,7 +201,7 @@ Gets the class name of the resource associated with the given path. If the loade .. rst-class:: classref-method -:ref:`int` **_get_resource_uid** **(** :ref:`String` path **)** |virtual| |const| +:ref:`int` **_get_resource_uid**\ (\ path\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -215,7 +215,7 @@ Gets the class name of the resource associated with the given path. If the loade .. rst-class:: classref-method -:ref:`bool` **_handles_type** **(** :ref:`StringName` type **)** |virtual| |const| +:ref:`bool` **_handles_type**\ (\ type\: :ref:`StringName`\ ) |virtual| |const| Tells which resource class this loader can load. @@ -229,7 +229,7 @@ Tells which resource class this loader can load. .. rst-class:: classref-method -:ref:`Variant` **_load** **(** :ref:`String` path, :ref:`String` original_path, :ref:`bool` use_sub_threads, :ref:`int` cache_mode **)** |virtual| |const| +:ref:`Variant` **_load**\ (\ path\: :ref:`String`, original_path\: :ref:`String`, use_sub_threads\: :ref:`bool`, cache_mode\: :ref:`int`\ ) |virtual| |const| Loads a resource when the engine finds this loader to be compatible. If the loaded resource is the result of an import, ``original_path`` will target the source file. Returns a :ref:`Resource` object on success, or an :ref:`Error` constant in case of failure. @@ -243,7 +243,7 @@ The ``cache_mode`` property defines whether and how the cache should be used or .. rst-class:: classref-method -:ref:`bool` **_recognize_path** **(** :ref:`String` path, :ref:`StringName` type **)** |virtual| |const| +:ref:`bool` **_recognize_path**\ (\ path\: :ref:`String`, type\: :ref:`StringName`\ ) |virtual| |const| Tells whether or not this loader should load a resource from its resource path for a given type. @@ -257,7 +257,7 @@ If it is not implemented, the default behavior returns whether the path's extens .. rst-class:: classref-method -:ref:`Error` **_rename_dependencies** **(** :ref:`String` path, :ref:`Dictionary` renames **)** |virtual| |const| +:ref:`Error` **_rename_dependencies**\ (\ path\: :ref:`String`, renames\: :ref:`Dictionary`\ ) |virtual| |const| If implemented, renames dependencies within the given resource and saves it. ``renames`` is a dictionary ``{ String => String }`` mapping old dependency paths to new paths. @@ -270,3 +270,4 @@ Returns :ref:`@GlobalScope.OK` on success, or an .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourceformatsaver.rst b/classes/class_resourceformatsaver.rst index 36bd22dbbd4..e326ee4c501 100644 --- a/classes/class_resourceformatsaver.rst +++ b/classes/class_resourceformatsaver.rst @@ -31,17 +31,17 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_recognized_extensions` **(** :ref:`Resource` resource **)** |virtual| |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_recognize` **(** :ref:`Resource` resource **)** |virtual| |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_recognize_path` **(** :ref:`Resource` resource, :ref:`String` path **)** |virtual| |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_save` **(** :ref:`Resource` resource, :ref:`String` path, :ref:`int` flags **)** |virtual| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_set_uid` **(** :ref:`String` path, :ref:`int` uid **)** |virtual| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_recognized_extensions`\ (\ resource\: :ref:`Resource`\ ) |virtual| |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_recognize`\ (\ resource\: :ref:`Resource`\ ) |virtual| |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_recognize_path`\ (\ resource\: :ref:`Resource`, path\: :ref:`String`\ ) |virtual| |const| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_save`\ (\ resource\: :ref:`Resource`, path\: :ref:`String`, flags\: :ref:`int`\ ) |virtual| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_set_uid`\ (\ path\: :ref:`String`, uid\: :ref:`int`\ ) |virtual| | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -56,7 +56,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_recognized_extensions** **(** :ref:`Resource` resource **)** |virtual| |const| +:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ resource\: :ref:`Resource`\ ) |virtual| |const| Returns the list of extensions available for saving the resource object, provided it is recognized (see :ref:`_recognize`). @@ -68,7 +68,7 @@ Returns the list of extensions available for saving the resource object, provide .. rst-class:: classref-method -:ref:`bool` **_recognize** **(** :ref:`Resource` resource **)** |virtual| |const| +:ref:`bool` **_recognize**\ (\ resource\: :ref:`Resource`\ ) |virtual| |const| Returns whether the given resource object can be saved by this saver. @@ -80,7 +80,7 @@ Returns whether the given resource object can be saved by this saver. .. rst-class:: classref-method -:ref:`bool` **_recognize_path** **(** :ref:`Resource` resource, :ref:`String` path **)** |virtual| |const| +:ref:`bool` **_recognize_path**\ (\ resource\: :ref:`Resource`, path\: :ref:`String`\ ) |virtual| |const| Returns ``true`` if this saver handles a given save path and ``false`` otherwise. @@ -94,7 +94,7 @@ If this method is not implemented, the default behavior returns whether the path .. rst-class:: classref-method -:ref:`Error` **_save** **(** :ref:`Resource` resource, :ref:`String` path, :ref:`int` flags **)** |virtual| +:ref:`Error` **_save**\ (\ resource\: :ref:`Resource`, path\: :ref:`String`, flags\: :ref:`int`\ ) |virtual| Saves the given resource object to a file at the target ``path``. ``flags`` is a bitmask composed with :ref:`SaverFlags` constants. @@ -108,7 +108,7 @@ Returns :ref:`@GlobalScope.OK` on success, or an .. rst-class:: classref-method -:ref:`Error` **_set_uid** **(** :ref:`String` path, :ref:`int` uid **)** |virtual| +:ref:`Error` **_set_uid**\ (\ path\: :ref:`String`, uid\: :ref:`int`\ ) |virtual| Sets a new UID for the resource at the given ``path``. Returns :ref:`@GlobalScope.OK` on success, or an :ref:`Error` constant in case of failure. @@ -119,3 +119,4 @@ Sets a new UID for the resource at the given ``path``. Returns :ref:`@GlobalScop .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourceimporter.rst b/classes/class_resourceimporter.rst index f896ace5797..0e615272466 100644 --- a/classes/class_resourceimporter.rst +++ b/classes/class_resourceimporter.rst @@ -68,3 +68,4 @@ The import order for scenes, which ensures scenes are imported *after* all other .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourceimporterbitmap.rst b/classes/class_resourceimporterbitmap.rst index 6f697bdb82e..e4be9d6a882 100644 --- a/classes/class_resourceimporterbitmap.rst +++ b/classes/class_resourceimporterbitmap.rst @@ -82,3 +82,4 @@ The threshold to use to determine which bits should be considered enabled or dis .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourceimporterbmfont.rst b/classes/class_resourceimporterbmfont.rst index b9d61017320..1f54f413e48 100644 --- a/classes/class_resourceimporterbmfont.rst +++ b/classes/class_resourceimporterbmfont.rst @@ -96,3 +96,4 @@ Font scaling mode. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourceimportercsvtranslation.rst b/classes/class_resourceimportercsvtranslation.rst index bc8964211e3..b4b6510ca84 100644 --- a/classes/class_resourceimportercsvtranslation.rst +++ b/classes/class_resourceimportercsvtranslation.rst @@ -88,3 +88,4 @@ The delimiter to use in the CSV file. The default value matches the common CSV c .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourceimporterdynamicfont.rst b/classes/class_resourceimporterdynamicfont.rst index 9e4cca200d2..1ce20bfc503 100644 --- a/classes/class_resourceimporterdynamicfont.rst +++ b/classes/class_resourceimporterdynamicfont.rst @@ -304,3 +304,4 @@ Subpixel positioning improves font rendering appearance, especially at smaller f .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourceimporterimage.rst b/classes/class_resourceimporterimage.rst index 4b50151677f..c0d25502145 100644 --- a/classes/class_resourceimporterimage.rst +++ b/classes/class_resourceimporterimage.rst @@ -35,3 +35,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourceimporterimagefont.rst b/classes/class_resourceimporterimagefont.rst index 7974284f1b5..11f55124644 100644 --- a/classes/class_resourceimporterimagefont.rst +++ b/classes/class_resourceimporterimagefont.rst @@ -214,3 +214,4 @@ Font scaling mode. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourceimporterlayeredtexture.rst b/classes/class_resourceimporterlayeredtexture.rst index a49516add2b..6f4812e5868 100644 --- a/classes/class_resourceimporterlayeredtexture.rst +++ b/classes/class_resourceimporterlayeredtexture.rst @@ -200,3 +200,4 @@ Controls how the cubemap's texture is internally laid out. When using high-resol .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourceimportermp3.rst b/classes/class_resourceimportermp3.rst index 274bdd6b539..36d7bc9f4cb 100644 --- a/classes/class_resourceimportermp3.rst +++ b/classes/class_resourceimportermp3.rst @@ -136,3 +136,4 @@ A more convenient editor for :ref:`loop_offset` | :ref:`load_from_buffer` **(** :ref:`PackedByteArray` buffer **)** |static| | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStreamOggVorbis` | :ref:`load_from_file` **(** :ref:`String` path **)** |static| | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamOggVorbis` | :ref:`load_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) |static| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamOggVorbis` | :ref:`load_from_file`\ (\ path\: :ref:`String`\ ) |static| | + +---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -156,7 +156,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AudioStreamOggVorbis` **load_from_buffer** **(** :ref:`PackedByteArray` buffer **)** |static| +:ref:`AudioStreamOggVorbis` **load_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) |static| This method loads audio data from a PackedByteArray buffer into an AudioStreamOggVorbis object. @@ -168,7 +168,7 @@ This method loads audio data from a PackedByteArray buffer into an AudioStreamOg .. rst-class:: classref-method -:ref:`AudioStreamOggVorbis` **load_from_file** **(** :ref:`String` path **)** |static| +:ref:`AudioStreamOggVorbis` **load_from_file**\ (\ path\: :ref:`String`\ ) |static| This method loads audio data from a file into an AudioStreamOggVorbis object. The file path is provided as a string. @@ -179,3 +179,4 @@ This method loads audio data from a file into an AudioStreamOggVorbis object. Th .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourceimporterscene.rst b/classes/class_resourceimporterscene.rst index 61bfc50bcad..2bd0a956015 100644 --- a/classes/class_resourceimporterscene.rst +++ b/classes/class_resourceimporterscene.rst @@ -304,3 +304,4 @@ Together, this information is enough to tell Godot how to use the bone poses in .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourceimportershaderfile.rst b/classes/class_resourceimportershaderfile.rst index 23329719d57..c3f6a01a456 100644 --- a/classes/class_resourceimportershaderfile.rst +++ b/classes/class_resourceimportershaderfile.rst @@ -28,3 +28,4 @@ This imports native GLSL shaders as :ref:`RDShaderFile` reso .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourceimportertexture.rst b/classes/class_resourceimportertexture.rst index 4393e3ea029..5cb80aed8e8 100644 --- a/classes/class_resourceimportertexture.rst +++ b/classes/class_resourceimportertexture.rst @@ -394,3 +394,4 @@ The scale the SVG should be rendered at, with ``1.0`` being the original design .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourceimportertextureatlas.rst b/classes/class_resourceimportertextureatlas.rst index 528538f3898..70e7be440fd 100644 --- a/classes/class_resourceimportertextureatlas.rst +++ b/classes/class_resourceimportertextureatlas.rst @@ -107,3 +107,4 @@ If ``true``, trims the region to exclude fully transparent pixels using a clippi .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourceimporterwav.rst b/classes/class_resourceimporterwav.rst index bab6f682e2a..d65a48e04dc 100644 --- a/classes/class_resourceimporterwav.rst +++ b/classes/class_resourceimporterwav.rst @@ -208,3 +208,4 @@ If ``true``, forces the imported audio to be mono if the source file is stereo. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index a5bcb388861..1d7dda6a22e 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -40,31 +40,31 @@ Methods .. table:: :widths: auto - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_resource_format_loader` **(** :ref:`ResourceFormatLoader` format_loader, :ref:`bool` at_front=false **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`exists` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_dependencies` **(** :ref:`String` path **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_recognized_extensions_for_type` **(** :ref:`String` type **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_resource_uid` **(** :ref:`String` path **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_cached` **(** :ref:`String` path **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`load` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`CacheMode` cache_mode=1 **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`load_threaded_get` **(** :ref:`String` path **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ThreadLoadStatus` | :ref:`load_threaded_get_status` **(** :ref:`String` path, :ref:`Array` progress=[] **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`load_threaded_request` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` use_sub_threads=false, :ref:`CacheMode` cache_mode=1 **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_resource_format_loader` **(** :ref:`ResourceFormatLoader` format_loader **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_abort_on_missing_resources` **(** :ref:`bool` abort **)** | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_resource_format_loader`\ (\ format_loader\: :ref:`ResourceFormatLoader`, at_front\: :ref:`bool` = false\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`exists`\ (\ path\: :ref:`String`, type_hint\: :ref:`String` = ""\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_dependencies`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_recognized_extensions_for_type`\ (\ type\: :ref:`String`\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_resource_uid`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_cached`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`load`\ (\ path\: :ref:`String`, type_hint\: :ref:`String` = "", cache_mode\: :ref:`CacheMode` = 1\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`load_threaded_get`\ (\ path\: :ref:`String`\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ThreadLoadStatus` | :ref:`load_threaded_get_status`\ (\ path\: :ref:`String`, progress\: :ref:`Array` = []\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_threaded_request`\ (\ path\: :ref:`String`, type_hint\: :ref:`String` = "", use_sub_threads\: :ref:`bool` = false, cache_mode\: :ref:`CacheMode` = 1\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_resource_format_loader`\ (\ format_loader\: :ref:`ResourceFormatLoader`\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_abort_on_missing_resources`\ (\ abort\: :ref:`bool`\ ) | + +---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -160,7 +160,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_resource_format_loader** **(** :ref:`ResourceFormatLoader` format_loader, :ref:`bool` at_front=false **)** +|void| **add_resource_format_loader**\ (\ format_loader\: :ref:`ResourceFormatLoader`, at_front\: :ref:`bool` = false\ ) Registers a new :ref:`ResourceFormatLoader`. The ResourceLoader will use the ResourceFormatLoader as described in :ref:`load`. @@ -174,7 +174,7 @@ This method is performed implicitly for ResourceFormatLoaders written in GDScrip .. rst-class:: classref-method -:ref:`bool` **exists** **(** :ref:`String` path, :ref:`String` type_hint="" **)** +:ref:`bool` **exists**\ (\ path\: :ref:`String`, type_hint\: :ref:`String` = ""\ ) Returns whether a recognized resource exists for the given ``path``. @@ -190,7 +190,7 @@ An optional ``type_hint`` can be used to further specify the :ref:`Resource` **get_dependencies** **(** :ref:`String` path **)** +:ref:`PackedStringArray` **get_dependencies**\ (\ path\: :ref:`String`\ ) Returns the dependencies for the resource at the given ``path``. @@ -210,7 +210,7 @@ Returns the dependencies for the resource at the given ``path``. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_recognized_extensions_for_type** **(** :ref:`String` type **)** +:ref:`PackedStringArray` **get_recognized_extensions_for_type**\ (\ type\: :ref:`String`\ ) Returns the list of recognized extensions for a resource type. @@ -222,7 +222,7 @@ Returns the list of recognized extensions for a resource type. .. rst-class:: classref-method -:ref:`int` **get_resource_uid** **(** :ref:`String` path **)** +:ref:`int` **get_resource_uid**\ (\ path\: :ref:`String`\ ) Returns the ID associated with a given resource path, or ``-1`` when no such ID exists. @@ -234,7 +234,7 @@ Returns the ID associated with a given resource path, or ``-1`` when no such ID .. rst-class:: classref-method -:ref:`bool` **has_cached** **(** :ref:`String` path **)** +:ref:`bool` **has_cached**\ (\ path\: :ref:`String`\ ) Returns whether a cached resource is available for the given ``path``. @@ -248,7 +248,7 @@ Once a resource has been loaded by the engine, it is cached in memory for faster .. rst-class:: classref-method -:ref:`Resource` **load** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`CacheMode` cache_mode=1 **)** +:ref:`Resource` **load**\ (\ path\: :ref:`String`, type_hint\: :ref:`String` = "", cache_mode\: :ref:`CacheMode` = 1\ ) Loads a resource at the given ``path``, caching the result for further access. @@ -272,7 +272,7 @@ GDScript has a simplified :ref:`@GDScript.load` bui .. rst-class:: classref-method -:ref:`Resource` **load_threaded_get** **(** :ref:`String` path **)** +:ref:`Resource` **load_threaded_get**\ (\ path\: :ref:`String`\ ) Returns the resource loaded by :ref:`load_threaded_request`. @@ -286,7 +286,7 @@ If this is called before the loading thread is done (i.e. :ref:`load_threaded_ge .. rst-class:: classref-method -:ref:`ThreadLoadStatus` **load_threaded_get_status** **(** :ref:`String` path, :ref:`Array` progress=[] **)** +:ref:`ThreadLoadStatus` **load_threaded_get_status**\ (\ path\: :ref:`String`, progress\: :ref:`Array` = []\ ) Returns the status of a threaded loading operation started with :ref:`load_threaded_request` for the resource at ``path``. See :ref:`ThreadLoadStatus` for possible return values. @@ -300,7 +300,7 @@ An array variable can optionally be passed via ``progress``, and will return a o .. rst-class:: classref-method -:ref:`Error` **load_threaded_request** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` use_sub_threads=false, :ref:`CacheMode` cache_mode=1 **)** +:ref:`Error` **load_threaded_request**\ (\ path\: :ref:`String`, type_hint\: :ref:`String` = "", use_sub_threads\: :ref:`bool` = false, cache_mode\: :ref:`CacheMode` = 1\ ) Loads the resource using threads. If ``use_sub_threads`` is ``true``, multiple threads will be used to load the resource, which makes loading faster, but may affect the main thread (and thus cause game slowdowns). @@ -314,7 +314,7 @@ The ``cache_mode`` property defines whether and how the cache should be used or .. rst-class:: classref-method -void **remove_resource_format_loader** **(** :ref:`ResourceFormatLoader` format_loader **)** +|void| **remove_resource_format_loader**\ (\ format_loader\: :ref:`ResourceFormatLoader`\ ) Unregisters the given :ref:`ResourceFormatLoader`. @@ -326,7 +326,7 @@ Unregisters the given :ref:`ResourceFormatLoader`. .. rst-class:: classref-method -void **set_abort_on_missing_resources** **(** :ref:`bool` abort **)** +|void| **set_abort_on_missing_resources**\ (\ abort\: :ref:`bool`\ ) Changes the behavior on missing sub-resources. The default behavior is to abort loading. @@ -337,3 +337,4 @@ Changes the behavior on missing sub-resources. The default behavior is to abort .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index f815155376a..63b64ff769e 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -31,19 +31,19 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_resource` **(** :ref:`StringName` name, :ref:`Resource` resource **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`get_resource` **(** :ref:`StringName` name **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_resource_list` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_resource` **(** :ref:`StringName` name **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_resource` **(** :ref:`StringName` name **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rename_resource` **(** :ref:`StringName` name, :ref:`StringName` newname **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_resource`\ (\ name\: :ref:`StringName`, resource\: :ref:`Resource`\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`get_resource`\ (\ name\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_resource_list`\ (\ ) |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_resource`\ (\ name\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_resource`\ (\ name\: :ref:`StringName`\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rename_resource`\ (\ name\: :ref:`StringName`, newname\: :ref:`StringName`\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -58,7 +58,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_resource** **(** :ref:`StringName` name, :ref:`Resource` resource **)** +|void| **add_resource**\ (\ name\: :ref:`StringName`, resource\: :ref:`Resource`\ ) Adds a resource to the preloader with the given ``name``. If a resource with the given ``name`` already exists, the new resource will be renamed to "``name`` N" where N is an incrementing number starting from 2. @@ -70,7 +70,7 @@ Adds a resource to the preloader with the given ``name``. If a resource with the .. rst-class:: classref-method -:ref:`Resource` **get_resource** **(** :ref:`StringName` name **)** |const| +:ref:`Resource` **get_resource**\ (\ name\: :ref:`StringName`\ ) |const| Returns the resource associated to ``name``. @@ -82,7 +82,7 @@ Returns the resource associated to ``name``. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_resource_list** **(** **)** |const| +:ref:`PackedStringArray` **get_resource_list**\ (\ ) |const| Returns the list of resources inside the preloader. @@ -94,7 +94,7 @@ Returns the list of resources inside the preloader. .. rst-class:: classref-method -:ref:`bool` **has_resource** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_resource**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if the preloader contains a resource associated to ``name``. @@ -106,7 +106,7 @@ Returns ``true`` if the preloader contains a resource associated to ``name``. .. rst-class:: classref-method -void **remove_resource** **(** :ref:`StringName` name **)** +|void| **remove_resource**\ (\ name\: :ref:`StringName`\ ) Removes the resource associated to ``name`` from the preloader. @@ -118,7 +118,7 @@ Removes the resource associated to ``name`` from the preloader. .. rst-class:: classref-method -void **rename_resource** **(** :ref:`StringName` name, :ref:`StringName` newname **)** +|void| **rename_resource**\ (\ name\: :ref:`StringName`, newname\: :ref:`StringName`\ ) Renames a resource inside the preloader from ``name`` to ``newname``. @@ -129,3 +129,4 @@ Renames a resource inside the preloader from ``name`` to ``newname``. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index 66db2e38545..1edce50b7df 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -31,15 +31,15 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_resource_format_saver` **(** :ref:`ResourceFormatSaver` format_saver, :ref:`bool` at_front=false **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` type **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_resource_format_saver` **(** :ref:`ResourceFormatSaver` format_saver **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save` **(** :ref:`Resource` resource, :ref:`String` path="", |bitfield|\<:ref:`SaverFlags`\> flags=0 **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_resource_format_saver`\ (\ format_saver\: :ref:`ResourceFormatSaver`, at_front\: :ref:`bool` = false\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_recognized_extensions`\ (\ type\: :ref:`Resource`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_resource_format_saver`\ (\ format_saver\: :ref:`ResourceFormatSaver`\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save`\ (\ resource\: :ref:`Resource`, path\: :ref:`String` = "", flags\: |bitfield|\[:ref:`SaverFlags`\] = 0\ ) | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -133,7 +133,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_resource_format_saver** **(** :ref:`ResourceFormatSaver` format_saver, :ref:`bool` at_front=false **)** +|void| **add_resource_format_saver**\ (\ format_saver\: :ref:`ResourceFormatSaver`, at_front\: :ref:`bool` = false\ ) Registers a new :ref:`ResourceFormatSaver`. The ResourceSaver will use the ResourceFormatSaver as described in :ref:`save`. @@ -147,7 +147,7 @@ This method is performed implicitly for ResourceFormatSavers written in GDScript .. rst-class:: classref-method -:ref:`PackedStringArray` **get_recognized_extensions** **(** :ref:`Resource` type **)** +:ref:`PackedStringArray` **get_recognized_extensions**\ (\ type\: :ref:`Resource`\ ) Returns the list of extensions available for saving a resource of a given type. @@ -159,7 +159,7 @@ Returns the list of extensions available for saving a resource of a given type. .. rst-class:: classref-method -void **remove_resource_format_saver** **(** :ref:`ResourceFormatSaver` format_saver **)** +|void| **remove_resource_format_saver**\ (\ format_saver\: :ref:`ResourceFormatSaver`\ ) Unregisters the given :ref:`ResourceFormatSaver`. @@ -171,7 +171,7 @@ Unregisters the given :ref:`ResourceFormatSaver`. .. rst-class:: classref-method -:ref:`Error` **save** **(** :ref:`Resource` resource, :ref:`String` path="", |bitfield|\<:ref:`SaverFlags`\> flags=0 **)** +:ref:`Error` **save**\ (\ resource\: :ref:`Resource`, path\: :ref:`String` = "", flags\: |bitfield|\[:ref:`SaverFlags`\] = 0\ ) Saves a resource to disk to the given path, using a :ref:`ResourceFormatSaver` that recognizes the resource object. If ``path`` is empty, **ResourceSaver** will try to use :ref:`Resource.resource_path`. @@ -188,3 +188,4 @@ Returns :ref:`@GlobalScope.OK` on success. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_resourceuid.rst b/classes/class_resourceuid.rst index 992407c106d..d913ebbe06e 100644 --- a/classes/class_resourceuid.rst +++ b/classes/class_resourceuid.rst @@ -31,23 +31,23 @@ Methods .. table:: :widths: auto - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_id` **(** :ref:`int` id, :ref:`String` path **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`create_id` **(** **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_id_path` **(** :ref:`int` id **)** |const| | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_id` **(** :ref:`int` id **)** |const| | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`id_to_text` **(** :ref:`int` id **)** |const| | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_id` **(** :ref:`int` id **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_id` **(** :ref:`int` id, :ref:`String` path **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`text_to_id` **(** :ref:`String` text_id **)** |const| | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+ + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_id`\ (\ id\: :ref:`int`, path\: :ref:`String`\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`create_id`\ (\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_id_path`\ (\ id\: :ref:`int`\ ) |const| | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_id`\ (\ id\: :ref:`int`\ ) |const| | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`id_to_text`\ (\ id\: :ref:`int`\ ) |const| | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_id`\ (\ id\: :ref:`int`\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_id`\ (\ id\: :ref:`int`, path\: :ref:`String`\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`text_to_id`\ (\ text_id\: :ref:`String`\ ) |const| | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -81,7 +81,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_id** **(** :ref:`int` id, :ref:`String` path **)** +|void| **add_id**\ (\ id\: :ref:`int`, path\: :ref:`String`\ ) Adds a new UID value which is mapped to the given resource path. @@ -95,7 +95,7 @@ Fails with an error if the UID already exists, so be sure to check :ref:`has_id< .. rst-class:: classref-method -:ref:`int` **create_id** **(** **)** +:ref:`int` **create_id**\ (\ ) Generates a random resource UID which is guaranteed to be unique within the list of currently loaded UIDs. @@ -109,7 +109,7 @@ In order for this UID to be registered, you must call :ref:`add_id` **get_id_path** **(** :ref:`int` id **)** |const| +:ref:`String` **get_id_path**\ (\ id\: :ref:`int`\ ) |const| Returns the path that the given UID value refers to. @@ -123,7 +123,7 @@ Fails with an error if the UID does not exist, so be sure to check :ref:`has_id< .. rst-class:: classref-method -:ref:`bool` **has_id** **(** :ref:`int` id **)** |const| +:ref:`bool` **has_id**\ (\ id\: :ref:`int`\ ) |const| Returns whether the given UID value is known to the cache. @@ -135,7 +135,7 @@ Returns whether the given UID value is known to the cache. .. rst-class:: classref-method -:ref:`String` **id_to_text** **(** :ref:`int` id **)** |const| +:ref:`String` **id_to_text**\ (\ id\: :ref:`int`\ ) |const| Converts the given UID to a ``uid://`` string value. @@ -147,7 +147,7 @@ Converts the given UID to a ``uid://`` string value. .. rst-class:: classref-method -void **remove_id** **(** :ref:`int` id **)** +|void| **remove_id**\ (\ id\: :ref:`int`\ ) Removes a loaded UID value from the cache. @@ -161,7 +161,7 @@ Fails with an error if the UID does not exist, so be sure to check :ref:`has_id< .. rst-class:: classref-method -void **set_id** **(** :ref:`int` id, :ref:`String` path **)** +|void| **set_id**\ (\ id\: :ref:`int`, path\: :ref:`String`\ ) Updates the resource path of an existing UID. @@ -175,7 +175,7 @@ Fails with an error if the UID does not exist, so be sure to check :ref:`has_id< .. rst-class:: classref-method -:ref:`int` **text_to_id** **(** :ref:`String` text_id **)** |const| +:ref:`int` **text_to_id**\ (\ text_id\: :ref:`String`\ ) |const| Extracts the UID value from the given ``uid://`` string. @@ -186,3 +186,4 @@ Extracts the UID value from the given ``uid://`` string. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_ribbontrailmesh.rst b/classes/class_ribbontrailmesh.rst index f4a37517994..cf4163bcce1 100644 --- a/classes/class_ribbontrailmesh.rst +++ b/classes/class_ribbontrailmesh.rst @@ -102,8 +102,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_curve** **(** :ref:`Curve` value **)** -- :ref:`Curve` **get_curve** **(** **)** +- |void| **set_curve**\ (\ value\: :ref:`Curve`\ ) +- :ref:`Curve` **get_curve**\ (\ ) Determines the size of the ribbon along its length. The size of a particular section segment is obtained by multiplying the baseline :ref:`size` by the value of this curve at the given distance. For values smaller than ``0``, the faces will be inverted. @@ -119,8 +119,8 @@ Determines the size of the ribbon along its length. The size of a particular sec .. rst-class:: classref-property-setget -- void **set_section_length** **(** :ref:`float` value **)** -- :ref:`float` **get_section_length** **(** **)** +- |void| **set_section_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_section_length**\ (\ ) The length of a section of the ribbon. @@ -136,8 +136,8 @@ The length of a section of the ribbon. .. rst-class:: classref-property-setget -- void **set_section_segments** **(** :ref:`int` value **)** -- :ref:`int` **get_section_segments** **(** **)** +- |void| **set_section_segments**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_section_segments**\ (\ ) The number of segments in a section. The :ref:`curve` is sampled on each segment to determine its size. Higher values result in a more detailed ribbon at the cost of performance. @@ -153,8 +153,8 @@ The number of segments in a section. The :ref:`curve` value **)** -- :ref:`int` **get_sections** **(** **)** +- |void| **set_sections**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_sections**\ (\ ) The total number of sections on the ribbon. @@ -170,8 +170,8 @@ The total number of sections on the ribbon. .. rst-class:: classref-property-setget -- void **set_shape** **(** :ref:`Shape` value **)** -- :ref:`Shape` **get_shape** **(** **)** +- |void| **set_shape**\ (\ value\: :ref:`Shape`\ ) +- :ref:`Shape` **get_shape**\ (\ ) Determines the shape of the ribbon. @@ -187,8 +187,8 @@ Determines the shape of the ribbon. .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`float` value **)** -- :ref:`float` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_size**\ (\ ) The baseline size of the ribbon. The size of a particular section segment is obtained by multiplying this size by the value of the :ref:`curve` at the given distance. @@ -199,3 +199,4 @@ The baseline size of the ribbon. The size of a particular section segment is obt .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_richtexteffect.rst b/classes/class_richtexteffect.rst index 0867182c83f..2ade015afcb 100644 --- a/classes/class_richtexteffect.rst +++ b/classes/class_richtexteffect.rst @@ -57,9 +57,9 @@ Methods .. table:: :widths: auto - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_process_custom_fx` **(** :ref:`CharFXTransform` char_fx **)** |virtual| |const| | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_process_custom_fx`\ (\ char_fx\: :ref:`CharFXTransform`\ ) |virtual| |const| | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -74,7 +74,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_process_custom_fx** **(** :ref:`CharFXTransform` char_fx **)** |virtual| |const| +:ref:`bool` **_process_custom_fx**\ (\ char_fx\: :ref:`CharFXTransform`\ ) |virtual| |const| Override this method to modify properties in ``char_fx``. The method must return ``true`` if the character could be transformed successfully. If the method returns ``false``, it will skip transformation to avoid displaying broken text. @@ -85,3 +85,4 @@ Override this method to modify properties in ``char_fx``. The method must return .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index f104ade88ba..ae9d6fee8f5 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -108,143 +108,143 @@ Methods .. table:: :widths: auto - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_image` **(** :ref:`Texture2D` image, :ref:`int` width=0, :ref:`int` height=0, :ref:`Color` color=Color(1, 1, 1, 1), :ref:`InlineAlignment` inline_align=5, :ref:`Rect2` region=Rect2(0, 0, 0, 0), :ref:`Variant` key=null, :ref:`bool` pad=false, :ref:`String` tooltip="", :ref:`bool` size_in_percent=false **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_text` **(** :ref:`String` text **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`append_text` **(** :ref:`String` bbcode **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`deselect` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_character_line` **(** :ref:`int` character **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_character_paragraph` **(** :ref:`int` character **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_content_height` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_content_width` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_count` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_offset` **(** :ref:`int` line **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PopupMenu` | :ref:`get_menu` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_paragraph_count` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_paragraph_offset` **(** :ref:`int` paragraph **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_parsed_text` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_selected_text` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_from` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_to` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_total_character_count` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VScrollBar` | :ref:`get_v_scroll_bar` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_visible_line_count` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_visible_paragraph_count` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`install_effect` **(** :ref:`Variant` effect **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_menu_visible` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_ready` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`menu_option` **(** :ref:`int` option **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`newline` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`parse_bbcode` **(** :ref:`String` bbcode **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`parse_expressions_for_values` **(** :ref:`PackedStringArray` expressions **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`pop` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`pop_all` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`pop_context` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_bgcolor` **(** :ref:`Color` bgcolor **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_bold` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_bold_italics` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_cell` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_color` **(** :ref:`Color` color **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_context` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_customfx` **(** :ref:`RichTextEffect` effect, :ref:`Dictionary` env **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_dropcap` **(** :ref:`String` string, :ref:`Font` font, :ref:`int` size, :ref:`Rect2` dropcap_margins=Rect2(0, 0, 0, 0), :ref:`Color` color=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_color=Color(0, 0, 0, 0) **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_fgcolor` **(** :ref:`Color` fgcolor **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_font` **(** :ref:`Font` font, :ref:`int` font_size=0 **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_font_size` **(** :ref:`int` font_size **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_hint` **(** :ref:`String` description **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_indent` **(** :ref:`int` level **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_italics` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_language` **(** :ref:`String` language **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_list` **(** :ref:`int` level, :ref:`ListType` type, :ref:`bool` capitalize, :ref:`String` bullet="•" **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_meta` **(** :ref:`Variant` data **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_mono` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_normal` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_outline_color` **(** :ref:`Color` color **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_outline_size` **(** :ref:`int` outline_size **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_paragraph` **(** :ref:`HorizontalAlignment` alignment, :ref:`TextDirection` base_direction=0, :ref:`String` language="", :ref:`StructuredTextParser` st_parser=0, |bitfield|\<:ref:`JustificationFlag`\> justification_flags=163, :ref:`PackedFloat32Array` tab_stops=PackedFloat32Array() **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_strikethrough` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_table` **(** :ref:`int` columns, :ref:`InlineAlignment` inline_align=0, :ref:`int` align_to_row=-1 **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_underline` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`remove_paragraph` **(** :ref:`int` paragraph **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`scroll_to_line` **(** :ref:`int` line **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`scroll_to_paragraph` **(** :ref:`int` paragraph **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`scroll_to_selection` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`select_all` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cell_border_color` **(** :ref:`Color` color **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cell_padding` **(** :ref:`Rect2` padding **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cell_row_background_color` **(** :ref:`Color` odd_row_bg, :ref:`Color` even_row_bg **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cell_size_override` **(** :ref:`Vector2` min_size, :ref:`Vector2` max_size **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_table_column_expand` **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio=1 **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`update_image` **(** :ref:`Variant` key, |bitfield|\<:ref:`ImageUpdateMask`\> mask, :ref:`Texture2D` image, :ref:`int` width=0, :ref:`int` height=0, :ref:`Color` color=Color(1, 1, 1, 1), :ref:`InlineAlignment` inline_align=5, :ref:`Rect2` region=Rect2(0, 0, 0, 0), :ref:`bool` pad=false, :ref:`String` tooltip="", :ref:`bool` size_in_percent=false **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_image`\ (\ image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), key\: :ref:`Variant` = null, pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", size_in_percent\: :ref:`bool` = false\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_text`\ (\ text\: :ref:`String`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_text`\ (\ bbcode\: :ref:`String`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`deselect`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_character_line`\ (\ character\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_character_paragraph`\ (\ character\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_content_height`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_content_width`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_count`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_offset`\ (\ line\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PopupMenu` | :ref:`get_menu`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_paragraph_count`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_paragraph_offset`\ (\ paragraph\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_parsed_text`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_selected_text`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_from`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_to`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_total_character_count`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`VScrollBar` | :ref:`get_v_scroll_bar`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_visible_line_count`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_visible_paragraph_count`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`install_effect`\ (\ effect\: :ref:`Variant`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_menu_visible`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_ready`\ (\ ) |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`menu_option`\ (\ option\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`newline`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`parse_bbcode`\ (\ bbcode\: :ref:`String`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`parse_expressions_for_values`\ (\ expressions\: :ref:`PackedStringArray`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`pop`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`pop_all`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`pop_context`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_bgcolor`\ (\ bgcolor\: :ref:`Color`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_bold`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_bold_italics`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_cell`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_color`\ (\ color\: :ref:`Color`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_context`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_customfx`\ (\ effect\: :ref:`RichTextEffect`, env\: :ref:`Dictionary`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_dropcap`\ (\ string\: :ref:`String`, font\: :ref:`Font`, size\: :ref:`int`, dropcap_margins\: :ref:`Rect2` = Rect2(0, 0, 0, 0), color\: :ref:`Color` = Color(1, 1, 1, 1), outline_size\: :ref:`int` = 0, outline_color\: :ref:`Color` = Color(0, 0, 0, 0)\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_fgcolor`\ (\ fgcolor\: :ref:`Color`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_font`\ (\ font\: :ref:`Font`, font_size\: :ref:`int` = 0\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_font_size`\ (\ font_size\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_hint`\ (\ description\: :ref:`String`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_indent`\ (\ level\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_italics`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_language`\ (\ language\: :ref:`String`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_list`\ (\ level\: :ref:`int`, type\: :ref:`ListType`, capitalize\: :ref:`bool`, bullet\: :ref:`String` = "•"\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_meta`\ (\ data\: :ref:`Variant`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_mono`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_normal`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_outline_color`\ (\ color\: :ref:`Color`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_outline_size`\ (\ outline_size\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_paragraph`\ (\ alignment\: :ref:`HorizontalAlignment`, base_direction\: :ref:`TextDirection` = 0, language\: :ref:`String` = "", st_parser\: :ref:`StructuredTextParser` = 0, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 163, tab_stops\: :ref:`PackedFloat32Array` = PackedFloat32Array()\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_strikethrough`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_table`\ (\ columns\: :ref:`int`, inline_align\: :ref:`InlineAlignment` = 0, align_to_row\: :ref:`int` = -1\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_underline`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`remove_paragraph`\ (\ paragraph\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`scroll_to_line`\ (\ line\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`scroll_to_paragraph`\ (\ paragraph\: :ref:`int`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`scroll_to_selection`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select_all`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cell_border_color`\ (\ color\: :ref:`Color`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cell_padding`\ (\ padding\: :ref:`Rect2`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cell_row_background_color`\ (\ odd_row_bg\: :ref:`Color`, even_row_bg\: :ref:`Color`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cell_size_override`\ (\ min_size\: :ref:`Vector2`, max_size\: :ref:`Vector2`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_table_column_expand`\ (\ column\: :ref:`int`, expand\: :ref:`bool`, ratio\: :ref:`int` = 1\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update_image`\ (\ key\: :ref:`Variant`, mask\: |bitfield|\[:ref:`ImageUpdateMask`\], image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", size_in_percent\: :ref:`bool` = false\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -327,7 +327,7 @@ Signals .. rst-class:: classref-signal -**finished** **(** **)** +**finished**\ (\ ) Triggered when the document is fully loaded. @@ -339,7 +339,7 @@ Triggered when the document is fully loaded. .. rst-class:: classref-signal -**meta_clicked** **(** :ref:`Variant` meta **)** +**meta_clicked**\ (\ meta\: :ref:`Variant`\ ) 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` type. If a particular type or an object is desired, the :ref:`push_meta` method must be used to manually insert the data into the tag stack. @@ -351,7 +351,7 @@ Triggered when the user clicks on content between meta tags. If the meta is defi .. rst-class:: classref-signal -**meta_hover_ended** **(** :ref:`Variant` meta **)** +**meta_hover_ended**\ (\ meta\: :ref:`Variant`\ ) Triggers when the mouse exits a meta tag. @@ -363,7 +363,7 @@ Triggers when the mouse exits a meta tag. .. rst-class:: classref-signal -**meta_hover_started** **(** :ref:`Variant` meta **)** +**meta_hover_started**\ (\ meta\: :ref:`Variant`\ ) Triggers when the mouse enters a meta tag. @@ -539,8 +539,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_autowrap_mode** **(** :ref:`AutowrapMode` value **)** -- :ref:`AutowrapMode` **get_autowrap_mode** **(** **)** +- |void| **set_autowrap_mode**\ (\ value\: :ref:`AutowrapMode`\ ) +- :ref:`AutowrapMode` **get_autowrap_mode**\ (\ ) If set to something other than :ref:`TextServer.AUTOWRAP_OFF`, the text gets wrapped inside the node's bounding rectangle. To see how each mode behaves, see :ref:`AutowrapMode`. @@ -556,8 +556,8 @@ If set to something other than :ref:`TextServer.AUTOWRAP_OFF` value **)** -- :ref:`bool` **is_using_bbcode** **(** **)** +- |void| **set_use_bbcode**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_bbcode**\ (\ ) If ``true``, the label uses BBCode formatting. @@ -573,8 +573,8 @@ If ``true``, the label uses BBCode formatting. .. rst-class:: classref-property-setget -- void **set_context_menu_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_context_menu_enabled** **(** **)** +- |void| **set_context_menu_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_context_menu_enabled**\ (\ ) If ``true``, a right-click displays the context menu. @@ -590,8 +590,8 @@ If ``true``, a right-click displays the context menu. .. rst-class:: classref-property-setget -- void **set_effects** **(** :ref:`Array` value **)** -- :ref:`Array` **get_effects** **(** **)** +- |void| **set_effects**\ (\ value\: :ref:`Array`\ ) +- :ref:`Array` **get_effects**\ (\ ) The currently installed custom effects. This is an array of :ref:`RichTextEffect`\ s. @@ -609,8 +609,8 @@ To add a custom effect, it's more convenient to use :ref:`install_effect` value **)** -- :ref:`bool` **is_deselect_on_focus_loss_enabled** **(** **)** +- |void| **set_deselect_on_focus_loss_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_deselect_on_focus_loss_enabled**\ (\ ) If ``true``, the selected text will be deselected when focus is lost. @@ -626,8 +626,8 @@ If ``true``, the selected text will be deselected when focus is lost. .. rst-class:: classref-property-setget -- void **set_drag_and_drop_selection_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_drag_and_drop_selection_enabled** **(** **)** +- |void| **set_drag_and_drop_selection_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_drag_and_drop_selection_enabled**\ (\ ) If ``true``, allow drag and drop of selected text. @@ -643,8 +643,8 @@ If ``true``, allow drag and drop of selected text. .. rst-class:: classref-property-setget -- void **set_fit_content** **(** :ref:`bool` value **)** -- :ref:`bool` **is_fit_content_enabled** **(** **)** +- |void| **set_fit_content**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_fit_content_enabled**\ (\ ) If ``true``, the label's minimum size will be automatically updated to fit its content, matching the behavior of :ref:`Label`. @@ -660,8 +660,8 @@ If ``true``, the label's minimum size will be automatically updated to fit its c .. rst-class:: classref-property-setget -- void **set_hint_underline** **(** :ref:`bool` value **)** -- :ref:`bool` **is_hint_underlined** **(** **)** +- |void| **set_hint_underline**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_hint_underlined**\ (\ ) If ``true``, the label underlines hint tags such as ``[hint=description]{text}[/hint]``. @@ -677,8 +677,8 @@ If ``true``, the label underlines hint tags such as ``[hint=description]{text}[/ .. rst-class:: classref-property-setget -- void **set_language** **(** :ref:`String` value **)** -- :ref:`String` **get_language** **(** **)** +- |void| **set_language**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_language**\ (\ ) Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -694,8 +694,8 @@ Language code used for line-breaking and text shaping algorithms, if left empty .. rst-class:: classref-property-setget -- void **set_meta_underline** **(** :ref:`bool` value **)** -- :ref:`bool` **is_meta_underlined** **(** **)** +- |void| **set_meta_underline**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_meta_underlined**\ (\ ) If ``true``, the label underlines meta tags such as ``[url]{text}[/url]``. @@ -711,8 +711,8 @@ If ``true``, the label underlines meta tags such as ``[url]{text}[/url]``. .. rst-class:: classref-property-setget -- void **set_progress_bar_delay** **(** :ref:`int` value **)** -- :ref:`int` **get_progress_bar_delay** **(** **)** +- |void| **set_progress_bar_delay**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_progress_bar_delay**\ (\ ) The delay after which the loading progress bar is displayed, in milliseconds. Set to ``-1`` to disable progress bar entirely. @@ -730,8 +730,8 @@ The delay after which the loading progress bar is displayed, in milliseconds. Se .. rst-class:: classref-property-setget -- void **set_scroll_active** **(** :ref:`bool` value **)** -- :ref:`bool` **is_scroll_active** **(** **)** +- |void| **set_scroll_active**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_scroll_active**\ (\ ) If ``true``, the scrollbar is visible. Setting this to ``false`` does not block scrolling completely. See :ref:`scroll_to_line`. @@ -747,8 +747,8 @@ If ``true``, the scrollbar is visible. Setting this to ``false`` does not block .. rst-class:: classref-property-setget -- void **set_scroll_follow** **(** :ref:`bool` value **)** -- :ref:`bool` **is_scroll_following** **(** **)** +- |void| **set_scroll_follow**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_scroll_following**\ (\ ) If ``true``, the window scrolls down to display new content automatically. @@ -764,8 +764,8 @@ If ``true``, the window scrolls down to display new content automatically. .. rst-class:: classref-property-setget -- void **set_selection_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_selection_enabled** **(** **)** +- |void| **set_selection_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_selection_enabled**\ (\ ) If ``true``, the label allows text selection. @@ -781,8 +781,8 @@ If ``true``, the label allows text selection. .. rst-class:: classref-property-setget -- void **set_shortcut_keys_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_shortcut_keys_enabled** **(** **)** +- |void| **set_shortcut_keys_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_shortcut_keys_enabled**\ (\ ) If ``true``, shortcut keys for context menu items are enabled, even if the context menu is disabled. @@ -798,8 +798,8 @@ If ``true``, shortcut keys for context menu items are enabled, even if the conte .. rst-class:: classref-property-setget -- void **set_structured_text_bidi_override** **(** :ref:`StructuredTextParser` value **)** -- :ref:`StructuredTextParser` **get_structured_text_bidi_override** **(** **)** +- |void| **set_structured_text_bidi_override**\ (\ value\: :ref:`StructuredTextParser`\ ) +- :ref:`StructuredTextParser` **get_structured_text_bidi_override**\ (\ ) Set BiDi algorithm override for the structured text. @@ -815,8 +815,8 @@ Set BiDi algorithm override for the structured text. .. rst-class:: classref-property-setget -- void **set_structured_text_bidi_override_options** **(** :ref:`Array` value **)** -- :ref:`Array` **get_structured_text_bidi_override_options** **(** **)** +- |void| **set_structured_text_bidi_override_options**\ (\ value\: :ref:`Array`\ ) +- :ref:`Array` **get_structured_text_bidi_override_options**\ (\ ) Set additional options for BiDi override. @@ -832,8 +832,8 @@ Set additional options for BiDi override. .. rst-class:: classref-property-setget -- void **set_tab_size** **(** :ref:`int` value **)** -- :ref:`int` **get_tab_size** **(** **)** +- |void| **set_tab_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_tab_size**\ (\ ) The number of spaces associated with a single tab length. Does not affect ``\t`` in text tags, only indent tags. @@ -849,8 +849,8 @@ The number of spaces associated with a single tab length. Does not affect ``\t`` .. rst-class:: classref-property-setget -- void **set_text** **(** :ref:`String` value **)** -- :ref:`String` **get_text** **(** **)** +- |void| **set_text**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_text**\ (\ ) The label's text in BBCode format. Is not representative of manual modifications to the internal tag stack. Erases changes made by other methods when edited. @@ -868,8 +868,8 @@ The label's text in BBCode format. Is not representative of manual modifications .. rst-class:: classref-property-setget -- void **set_text_direction** **(** :ref:`TextDirection` value **)** -- :ref:`TextDirection` **get_text_direction** **(** **)** +- |void| **set_text_direction**\ (\ value\: :ref:`TextDirection`\ ) +- :ref:`TextDirection` **get_text_direction**\ (\ ) Base text writing direction. @@ -885,8 +885,8 @@ Base text writing direction. .. rst-class:: classref-property-setget -- void **set_threaded** **(** :ref:`bool` value **)** -- :ref:`bool` **is_threaded** **(** **)** +- |void| **set_threaded**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_threaded**\ (\ ) If ``true``, text processing is done in a background thread. @@ -902,8 +902,8 @@ If ``true``, text processing is done in a background thread. .. rst-class:: classref-property-setget -- void **set_visible_characters** **(** :ref:`int` value **)** -- :ref:`int` **get_visible_characters** **(** **)** +- |void| **set_visible_characters**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_visible_characters**\ (\ ) The number of characters to display. If set to ``-1``, all characters are displayed. This can be useful when animating the text appearing in a dialog box. @@ -921,8 +921,8 @@ The number of characters to display. If set to ``-1``, all characters are displa .. rst-class:: classref-property-setget -- void **set_visible_characters_behavior** **(** :ref:`VisibleCharactersBehavior` value **)** -- :ref:`VisibleCharactersBehavior` **get_visible_characters_behavior** **(** **)** +- |void| **set_visible_characters_behavior**\ (\ value\: :ref:`VisibleCharactersBehavior`\ ) +- :ref:`VisibleCharactersBehavior` **get_visible_characters_behavior**\ (\ ) Sets the clipping behavior when :ref:`visible_characters` or :ref:`visible_ratio` is set. See :ref:`VisibleCharactersBehavior` for more info. @@ -938,8 +938,8 @@ Sets the clipping behavior when :ref:`visible_characters` value **)** -- :ref:`float` **get_visible_ratio** **(** **)** +- |void| **set_visible_ratio**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_visible_ratio**\ (\ ) The fraction of characters to display, relative to the total number of characters (see :ref:`get_total_character_count`). If set to ``1.0``, all characters are displayed. If set to ``0.5``, only half of the characters will be displayed. This can be useful when animating the text appearing in a dialog box. @@ -958,7 +958,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_image** **(** :ref:`Texture2D` image, :ref:`int` width=0, :ref:`int` height=0, :ref:`Color` color=Color(1, 1, 1, 1), :ref:`InlineAlignment` inline_align=5, :ref:`Rect2` region=Rect2(0, 0, 0, 0), :ref:`Variant` key=null, :ref:`bool` pad=false, :ref:`String` tooltip="", :ref:`bool` size_in_percent=false **)** +|void| **add_image**\ (\ image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), key\: :ref:`Variant` = null, pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", size_in_percent\: :ref:`bool` = false\ ) Adds an image's opening and closing tags to the tag stack, optionally providing a ``width`` and ``height`` to resize the image, a ``color`` to tint the image and a ``region`` to only use parts of the image. @@ -980,7 +980,7 @@ If ``size_in_percent`` is set, ``width`` and ``height`` values are percentages o .. rst-class:: classref-method -void **add_text** **(** :ref:`String` text **)** +|void| **add_text**\ (\ text\: :ref:`String`\ ) Adds raw non-BBCode-parsed text to the tag stack. @@ -992,7 +992,7 @@ Adds raw non-BBCode-parsed text to the tag stack. .. rst-class:: classref-method -void **append_text** **(** :ref:`String` bbcode **)** +|void| **append_text**\ (\ bbcode\: :ref:`String`\ ) Parses ``bbcode`` and adds tags to the tag stack as needed. @@ -1006,7 +1006,7 @@ Parses ``bbcode`` and adds tags to the tag stack as needed. .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the tag stack. @@ -1020,7 +1020,7 @@ Clears the tag stack. .. rst-class:: classref-method -void **deselect** **(** **)** +|void| **deselect**\ (\ ) Clears the current selection. @@ -1032,7 +1032,7 @@ Clears the current selection. .. rst-class:: classref-method -:ref:`int` **get_character_line** **(** :ref:`int` character **)** +:ref:`int` **get_character_line**\ (\ character\: :ref:`int`\ ) Returns the line number of the character position provided. @@ -1046,7 +1046,7 @@ Returns the line number of the character position provided. .. rst-class:: classref-method -:ref:`int` **get_character_paragraph** **(** :ref:`int` character **)** +:ref:`int` **get_character_paragraph**\ (\ character\: :ref:`int`\ ) Returns the paragraph number of the character position provided. @@ -1060,7 +1060,7 @@ Returns the paragraph number of the character position provided. .. rst-class:: classref-method -:ref:`int` **get_content_height** **(** **)** |const| +:ref:`int` **get_content_height**\ (\ ) |const| Returns the height of the content. @@ -1074,7 +1074,7 @@ Returns the height of the content. .. rst-class:: classref-method -:ref:`int` **get_content_width** **(** **)** |const| +:ref:`int` **get_content_width**\ (\ ) |const| Returns the width of the content. @@ -1088,7 +1088,7 @@ Returns the width of the content. .. rst-class:: classref-method -:ref:`int` **get_line_count** **(** **)** |const| +:ref:`int` **get_line_count**\ (\ ) |const| Returns the total number of lines in the text. Wrapped text is counted as multiple lines. @@ -1102,7 +1102,7 @@ Returns the total number of lines in the text. Wrapped text is counted as multip .. rst-class:: classref-method -:ref:`float` **get_line_offset** **(** :ref:`int` line **)** +:ref:`float` **get_line_offset**\ (\ line\: :ref:`int`\ ) Returns the vertical offset of the line found at the provided index. @@ -1116,7 +1116,7 @@ Returns the vertical offset of the line found at the provided index. .. rst-class:: classref-method -:ref:`PopupMenu` **get_menu** **(** **)** |const| +:ref:`PopupMenu` **get_menu**\ (\ ) |const| Returns the :ref:`PopupMenu` of this **RichTextLabel**. By default, this menu is displayed when right-clicking on the **RichTextLabel**. @@ -1175,7 +1175,7 @@ You can add custom menu items or remove standard ones. Make sure your IDs don't .. rst-class:: classref-method -:ref:`int` **get_paragraph_count** **(** **)** |const| +:ref:`int` **get_paragraph_count**\ (\ ) |const| Returns the total number of paragraphs (newlines or ``p`` tags in the tag stack's text tags). Considers wrapped text as one paragraph. @@ -1187,7 +1187,7 @@ Returns the total number of paragraphs (newlines or ``p`` tags in the tag stack' .. rst-class:: classref-method -:ref:`float` **get_paragraph_offset** **(** :ref:`int` paragraph **)** +:ref:`float` **get_paragraph_offset**\ (\ paragraph\: :ref:`int`\ ) Returns the vertical offset of the paragraph found at the provided index. @@ -1201,7 +1201,7 @@ Returns the vertical offset of the paragraph found at the provided index. .. rst-class:: classref-method -:ref:`String` **get_parsed_text** **(** **)** |const| +:ref:`String` **get_parsed_text**\ (\ ) |const| Returns the text without BBCode mark-up. @@ -1213,7 +1213,7 @@ Returns the text without BBCode mark-up. .. rst-class:: classref-method -:ref:`String` **get_selected_text** **(** **)** |const| +:ref:`String` **get_selected_text**\ (\ ) |const| Returns the current selection text. Does not include BBCodes. @@ -1225,7 +1225,7 @@ Returns the current selection text. Does not include BBCodes. .. rst-class:: classref-method -:ref:`int` **get_selection_from** **(** **)** |const| +:ref:`int` **get_selection_from**\ (\ ) |const| Returns the current selection first character index if a selection is active, ``-1`` otherwise. Does not include BBCodes. @@ -1237,7 +1237,7 @@ Returns the current selection first character index if a selection is active, `` .. rst-class:: classref-method -:ref:`int` **get_selection_to** **(** **)** |const| +:ref:`int` **get_selection_to**\ (\ ) |const| Returns the current selection last character index if a selection is active, ``-1`` otherwise. Does not include BBCodes. @@ -1249,7 +1249,7 @@ Returns the current selection last character index if a selection is active, ``- .. rst-class:: classref-method -:ref:`int` **get_total_character_count** **(** **)** |const| +:ref:`int` **get_total_character_count**\ (\ ) |const| Returns the total number of characters from text tags. Does not include BBCodes. @@ -1261,7 +1261,7 @@ Returns the total number of characters from text tags. Does not include BBCodes. .. rst-class:: classref-method -:ref:`VScrollBar` **get_v_scroll_bar** **(** **)** +:ref:`VScrollBar` **get_v_scroll_bar**\ (\ ) Returns the vertical scrollbar. @@ -1275,7 +1275,7 @@ Returns the vertical scrollbar. .. rst-class:: classref-method -:ref:`int` **get_visible_line_count** **(** **)** |const| +:ref:`int` **get_visible_line_count**\ (\ ) |const| Returns the number of visible lines. @@ -1289,7 +1289,7 @@ Returns the number of visible lines. .. rst-class:: classref-method -:ref:`int` **get_visible_paragraph_count** **(** **)** |const| +:ref:`int` **get_visible_paragraph_count**\ (\ ) |const| Returns the number of visible paragraphs. A paragraph is considered visible if at least one of its lines is visible. @@ -1303,7 +1303,7 @@ Returns the number of visible paragraphs. A paragraph is considered visible if a .. rst-class:: classref-method -void **install_effect** **(** :ref:`Variant` effect **)** +|void| **install_effect**\ (\ effect\: :ref:`Variant`\ ) Installs a custom effect. This can also be done in the RichTextLabel inspector using the :ref:`custom_effects` property. ``effect`` should be a valid :ref:`RichTextEffect`. @@ -1340,7 +1340,7 @@ Registering the above effect in RichTextLabel from script: .. rst-class:: classref-method -:ref:`bool` **is_menu_visible** **(** **)** |const| +:ref:`bool` **is_menu_visible**\ (\ ) |const| Returns whether the menu is visible. Use this instead of ``get_menu().visible`` to improve performance (so the creation of the menu is avoided). @@ -1352,7 +1352,7 @@ Returns whether the menu is visible. Use this instead of ``get_menu().visible`` .. rst-class:: classref-method -:ref:`bool` **is_ready** **(** **)** |const| +:ref:`bool` **is_ready**\ (\ ) |const| If :ref:`threaded` is enabled, returns ``true`` if the background thread has finished text processing, otherwise always return ``true``. @@ -1364,7 +1364,7 @@ If :ref:`threaded` is enabled, returns `` .. rst-class:: classref-method -void **menu_option** **(** :ref:`int` option **)** +|void| **menu_option**\ (\ option\: :ref:`int`\ ) Executes a given action as defined in the :ref:`MenuItems` enum. @@ -1376,7 +1376,7 @@ Executes a given action as defined in the :ref:`MenuItems` bbcode **)** +|void| **parse_bbcode**\ (\ bbcode\: :ref:`String`\ ) The assignment version of :ref:`append_text`. Clears the tag stack and inserts the new content. @@ -1400,7 +1400,7 @@ The assignment version of :ref:`append_text` **parse_expressions_for_values** **(** :ref:`PackedStringArray` expressions **)** +:ref:`Dictionary` **parse_expressions_for_values**\ (\ expressions\: :ref:`PackedStringArray`\ ) Parses BBCode parameter ``expressions`` into a dictionary. @@ -1412,7 +1412,7 @@ Parses BBCode parameter ``expressions`` into a dictionary. .. rst-class:: classref-method -void **pop** **(** **)** +|void| **pop**\ (\ ) Terminates the current tag. Use after ``push_*`` methods to close BBCodes manually. Does not need to follow ``add_*`` methods. @@ -1424,7 +1424,7 @@ Terminates the current tag. Use after ``push_*`` methods to close BBCodes manual .. rst-class:: classref-method -void **pop_all** **(** **)** +|void| **pop_all**\ (\ ) Terminates all tags opened by ``push_*`` methods. @@ -1436,7 +1436,7 @@ Terminates all tags opened by ``push_*`` methods. .. rst-class:: classref-method -void **pop_context** **(** **)** +|void| **pop_context**\ (\ ) Terminates tags opened after the last :ref:`push_context` call (including context marker), or all tags if there's no context marker on the stack. @@ -1448,7 +1448,7 @@ Terminates tags opened after the last :ref:`push_context` bgcolor **)** +|void| **push_bgcolor**\ (\ bgcolor\: :ref:`Color`\ ) Adds a ``[bgcolor]`` tag to the tag stack. @@ -1460,7 +1460,7 @@ Adds a ``[bgcolor]`` tag to the tag stack. .. rst-class:: classref-method -void **push_bold** **(** **)** +|void| **push_bold**\ (\ ) Adds a ``[font]`` tag with a bold font to the tag stack. This is the same as adding a ``[b]`` tag if not currently in a ``[i]`` tag. @@ -1472,7 +1472,7 @@ Adds a ``[font]`` tag with a bold font to the tag stack. This is the same as add .. rst-class:: classref-method -void **push_bold_italics** **(** **)** +|void| **push_bold_italics**\ (\ ) Adds a ``[font]`` tag with a bold italics font to the tag stack. @@ -1484,7 +1484,7 @@ Adds a ``[font]`` tag with a bold italics font to the tag stack. .. rst-class:: classref-method -void **push_cell** **(** **)** +|void| **push_cell**\ (\ ) Adds a ``[cell]`` tag to the tag stack. Must be inside a ``[table]`` tag. See :ref:`push_table` for details. @@ -1496,7 +1496,7 @@ Adds a ``[cell]`` tag to the tag stack. Must be inside a ``[table]`` tag. See :r .. rst-class:: classref-method -void **push_color** **(** :ref:`Color` color **)** +|void| **push_color**\ (\ color\: :ref:`Color`\ ) Adds a ``[color]`` tag to the tag stack. @@ -1508,7 +1508,7 @@ Adds a ``[color]`` tag to the tag stack. .. rst-class:: classref-method -void **push_context** **(** **)** +|void| **push_context**\ (\ ) Adds a context marker to the tag stack. See :ref:`pop_context`. @@ -1520,7 +1520,7 @@ Adds a context marker to the tag stack. See :ref:`pop_context` effect, :ref:`Dictionary` env **)** +|void| **push_customfx**\ (\ effect\: :ref:`RichTextEffect`, env\: :ref:`Dictionary`\ ) Adds a custom effect tag to the tag stack. The effect does not need to be in :ref:`custom_effects`. The environment is directly passed to the effect. @@ -1532,7 +1532,7 @@ Adds a custom effect tag to the tag stack. The effect does not need to be in :re .. rst-class:: classref-method -void **push_dropcap** **(** :ref:`String` string, :ref:`Font` font, :ref:`int` size, :ref:`Rect2` dropcap_margins=Rect2(0, 0, 0, 0), :ref:`Color` color=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`Color` outline_color=Color(0, 0, 0, 0) **)** +|void| **push_dropcap**\ (\ string\: :ref:`String`, font\: :ref:`Font`, size\: :ref:`int`, dropcap_margins\: :ref:`Rect2` = Rect2(0, 0, 0, 0), color\: :ref:`Color` = Color(1, 1, 1, 1), outline_size\: :ref:`int` = 0, outline_color\: :ref:`Color` = Color(0, 0, 0, 0)\ ) Adds a ``[dropcap]`` tag to the tag stack. Drop cap (dropped capital) is a decorative element at the beginning of a paragraph that is larger than the rest of the text. @@ -1544,7 +1544,7 @@ Adds a ``[dropcap]`` tag to the tag stack. Drop cap (dropped capital) is a decor .. rst-class:: classref-method -void **push_fgcolor** **(** :ref:`Color` fgcolor **)** +|void| **push_fgcolor**\ (\ fgcolor\: :ref:`Color`\ ) Adds a ``[fgcolor]`` tag to the tag stack. @@ -1556,7 +1556,7 @@ Adds a ``[fgcolor]`` tag to the tag stack. .. rst-class:: classref-method -void **push_font** **(** :ref:`Font` font, :ref:`int` font_size=0 **)** +|void| **push_font**\ (\ font\: :ref:`Font`, font_size\: :ref:`int` = 0\ ) Adds a ``[font]`` tag to the tag stack. Overrides default fonts for its duration. @@ -1570,7 +1570,7 @@ Passing ``0`` to ``font_size`` will use the existing default font size. .. rst-class:: classref-method -void **push_font_size** **(** :ref:`int` font_size **)** +|void| **push_font_size**\ (\ font_size\: :ref:`int`\ ) Adds a ``[font_size]`` tag to the tag stack. Overrides default font size for its duration. @@ -1582,7 +1582,7 @@ Adds a ``[font_size]`` tag to the tag stack. Overrides default font size for its .. rst-class:: classref-method -void **push_hint** **(** :ref:`String` description **)** +|void| **push_hint**\ (\ description\: :ref:`String`\ ) Adds a ``[hint]`` tag to the tag stack. Same as BBCode ``[hint=something]{text}[/hint]``. @@ -1594,7 +1594,7 @@ Adds a ``[hint]`` tag to the tag stack. Same as BBCode ``[hint=something]{text}[ .. rst-class:: classref-method -void **push_indent** **(** :ref:`int` level **)** +|void| **push_indent**\ (\ level\: :ref:`int`\ ) Adds an ``[indent]`` tag to the tag stack. Multiplies ``level`` by current :ref:`tab_size` to determine new margin length. @@ -1606,7 +1606,7 @@ Adds an ``[indent]`` tag to the tag stack. Multiplies ``level`` by current :ref: .. rst-class:: classref-method -void **push_italics** **(** **)** +|void| **push_italics**\ (\ ) Adds a ``[font]`` tag with an italics font to the tag stack. This is the same as adding an ``[i]`` tag if not currently in a ``[b]`` tag. @@ -1618,7 +1618,7 @@ Adds a ``[font]`` tag with an italics font to the tag stack. This is the same as .. rst-class:: classref-method -void **push_language** **(** :ref:`String` language **)** +|void| **push_language**\ (\ language\: :ref:`String`\ ) Adds language code used for text shaping algorithm and Open-Type font features. @@ -1630,7 +1630,7 @@ Adds language code used for text shaping algorithm and Open-Type font features. .. rst-class:: classref-method -void **push_list** **(** :ref:`int` level, :ref:`ListType` type, :ref:`bool` capitalize, :ref:`String` bullet="•" **)** +|void| **push_list**\ (\ level\: :ref:`int`, type\: :ref:`ListType`, capitalize\: :ref:`bool`, bullet\: :ref:`String` = "•"\ ) Adds ``[ol]`` or ``[ul]`` tag to the tag stack. Multiplies ``level`` by current :ref:`tab_size` to determine new margin length. @@ -1642,7 +1642,7 @@ Adds ``[ol]`` or ``[ul]`` tag to the tag stack. Multiplies ``level`` by current .. rst-class:: classref-method -void **push_meta** **(** :ref:`Variant` data **)** +|void| **push_meta**\ (\ data\: :ref:`Variant`\ ) Adds a meta tag to the tag stack. Similar to the BBCode ``[url=something]{text}[/url]``, but supports non-:ref:`String` metadata types. @@ -1654,7 +1654,7 @@ Adds a meta tag to the tag stack. Similar to the BBCode ``[url=something]{text}[ .. rst-class:: classref-method -void **push_mono** **(** **)** +|void| **push_mono**\ (\ ) Adds a ``[font]`` tag with a monospace font to the tag stack. @@ -1666,7 +1666,7 @@ Adds a ``[font]`` tag with a monospace font to the tag stack. .. rst-class:: classref-method -void **push_normal** **(** **)** +|void| **push_normal**\ (\ ) Adds a ``[font]`` tag with a normal font to the tag stack. @@ -1678,7 +1678,7 @@ Adds a ``[font]`` tag with a normal font to the tag stack. .. rst-class:: classref-method -void **push_outline_color** **(** :ref:`Color` color **)** +|void| **push_outline_color**\ (\ color\: :ref:`Color`\ ) Adds a ``[outline_color]`` tag to the tag stack. Adds text outline for its duration. @@ -1690,7 +1690,7 @@ Adds a ``[outline_color]`` tag to the tag stack. Adds text outline for its durat .. rst-class:: classref-method -void **push_outline_size** **(** :ref:`int` outline_size **)** +|void| **push_outline_size**\ (\ outline_size\: :ref:`int`\ ) Adds a ``[outline_size]`` tag to the tag stack. Overrides default text outline size for its duration. @@ -1702,7 +1702,7 @@ Adds a ``[outline_size]`` tag to the tag stack. Overrides default text outline s .. rst-class:: classref-method -void **push_paragraph** **(** :ref:`HorizontalAlignment` alignment, :ref:`TextDirection` base_direction=0, :ref:`String` language="", :ref:`StructuredTextParser` st_parser=0, |bitfield|\<:ref:`JustificationFlag`\> justification_flags=163, :ref:`PackedFloat32Array` tab_stops=PackedFloat32Array() **)** +|void| **push_paragraph**\ (\ alignment\: :ref:`HorizontalAlignment`, base_direction\: :ref:`TextDirection` = 0, language\: :ref:`String` = "", st_parser\: :ref:`StructuredTextParser` = 0, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 163, tab_stops\: :ref:`PackedFloat32Array` = PackedFloat32Array()\ ) Adds a ``[p]`` tag to the tag stack. @@ -1714,7 +1714,7 @@ Adds a ``[p]`` tag to the tag stack. .. rst-class:: classref-method -void **push_strikethrough** **(** **)** +|void| **push_strikethrough**\ (\ ) Adds a ``[s]`` tag to the tag stack. @@ -1726,7 +1726,7 @@ Adds a ``[s]`` tag to the tag stack. .. rst-class:: classref-method -void **push_table** **(** :ref:`int` columns, :ref:`InlineAlignment` inline_align=0, :ref:`int` align_to_row=-1 **)** +|void| **push_table**\ (\ columns\: :ref:`int`, inline_align\: :ref:`InlineAlignment` = 0, align_to_row\: :ref:`int` = -1\ ) Adds a ``[table=columns,inline_align]`` tag to the tag stack. @@ -1738,7 +1738,7 @@ Adds a ``[table=columns,inline_align]`` tag to the tag stack. .. rst-class:: classref-method -void **push_underline** **(** **)** +|void| **push_underline**\ (\ ) Adds a ``[u]`` tag to the tag stack. @@ -1750,7 +1750,7 @@ Adds a ``[u]`` tag to the tag stack. .. rst-class:: classref-method -:ref:`bool` **remove_paragraph** **(** :ref:`int` paragraph **)** +:ref:`bool` **remove_paragraph**\ (\ paragraph\: :ref:`int`\ ) Removes a paragraph of content from the label. Returns ``true`` if the paragraph exists. @@ -1764,7 +1764,7 @@ The ``paragraph`` argument is the index of the paragraph to remove, it can take .. rst-class:: classref-method -void **scroll_to_line** **(** :ref:`int` line **)** +|void| **scroll_to_line**\ (\ line\: :ref:`int`\ ) Scrolls the window's top line to match ``line``. @@ -1776,7 +1776,7 @@ Scrolls the window's top line to match ``line``. .. rst-class:: classref-method -void **scroll_to_paragraph** **(** :ref:`int` paragraph **)** +|void| **scroll_to_paragraph**\ (\ paragraph\: :ref:`int`\ ) Scrolls the window's top line to match first line of the ``paragraph``. @@ -1788,7 +1788,7 @@ Scrolls the window's top line to match first line of the ``paragraph``. .. rst-class:: classref-method -void **scroll_to_selection** **(** **)** +|void| **scroll_to_selection**\ (\ ) Scrolls to the beginning of the current selection. @@ -1800,7 +1800,7 @@ Scrolls to the beginning of the current selection. .. rst-class:: classref-method -void **select_all** **(** **)** +|void| **select_all**\ (\ ) Select all the text. @@ -1814,7 +1814,7 @@ If :ref:`selection_enabled` is ` .. rst-class:: classref-method -void **set_cell_border_color** **(** :ref:`Color` color **)** +|void| **set_cell_border_color**\ (\ color\: :ref:`Color`\ ) Sets color of a table cell border. @@ -1826,7 +1826,7 @@ Sets color of a table cell border. .. rst-class:: classref-method -void **set_cell_padding** **(** :ref:`Rect2` padding **)** +|void| **set_cell_padding**\ (\ padding\: :ref:`Rect2`\ ) Sets inner padding of a table cell. @@ -1838,7 +1838,7 @@ Sets inner padding of a table cell. .. rst-class:: classref-method -void **set_cell_row_background_color** **(** :ref:`Color` odd_row_bg, :ref:`Color` even_row_bg **)** +|void| **set_cell_row_background_color**\ (\ odd_row_bg\: :ref:`Color`, even_row_bg\: :ref:`Color`\ ) Sets color of a table cell. Separate colors for alternating rows can be specified. @@ -1850,7 +1850,7 @@ Sets color of a table cell. Separate colors for alternating rows can be specifie .. rst-class:: classref-method -void **set_cell_size_override** **(** :ref:`Vector2` min_size, :ref:`Vector2` max_size **)** +|void| **set_cell_size_override**\ (\ min_size\: :ref:`Vector2`, max_size\: :ref:`Vector2`\ ) Sets minimum and maximum size overrides for a table cell. @@ -1862,7 +1862,7 @@ Sets minimum and maximum size overrides for a table cell. .. rst-class:: classref-method -void **set_table_column_expand** **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio=1 **)** +|void| **set_table_column_expand**\ (\ column\: :ref:`int`, expand\: :ref:`bool`, ratio\: :ref:`int` = 1\ ) Edits the selected column's expansion options. If ``expand`` is ``true``, the column expands in proportion to its expansion ratio versus the other columns' ratios. @@ -1878,7 +1878,7 @@ If ``expand`` is ``false``, the column will not contribute to the total ratio. .. rst-class:: classref-method -void **update_image** **(** :ref:`Variant` key, |bitfield|\<:ref:`ImageUpdateMask`\> mask, :ref:`Texture2D` image, :ref:`int` width=0, :ref:`int` height=0, :ref:`Color` color=Color(1, 1, 1, 1), :ref:`InlineAlignment` inline_align=5, :ref:`Rect2` region=Rect2(0, 0, 0, 0), :ref:`bool` pad=false, :ref:`String` tooltip="", :ref:`bool` size_in_percent=false **)** +|void| **update_image**\ (\ key\: :ref:`Variant`, mask\: |bitfield|\[:ref:`ImageUpdateMask`\], image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", size_in_percent\: :ref:`bool` = false\ ) Updates the existing images with the key ``key``. Only properties specified by ``mask`` bits are updated. See :ref:`add_image`. @@ -2244,3 +2244,4 @@ The normal background for the **RichTextLabel**. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rid.rst b/classes/class_rid.rst index 070bc918c97..dd8faf39c2a 100644 --- a/classes/class_rid.rst +++ b/classes/class_rid.rst @@ -33,11 +33,11 @@ Constructors .. table:: :widths: auto - +-----------------------+------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`RID` **(** **)** | - +-----------------------+------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`RID` **(** :ref:`RID` from **)** | - +-----------------------+------------------------------------------------------------------------------+ + +-----------------------+---------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`RID`\ (\ ) | + +-----------------------+---------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`RID`\ (\ from\: :ref:`RID`\ ) | + +-----------------------+---------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -47,11 +47,11 @@ Methods .. table:: :widths: auto - +-------------------------+----------------------------------------------------------------+ - | :ref:`int` | :ref:`get_id` **(** **)** |const| | - +-------------------------+----------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid` **(** **)** |const| | - +-------------------------+----------------------------------------------------------------+ + +-------------------------+----------------------------------------------------------+ + | :ref:`int` | :ref:`get_id`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -61,19 +61,19 @@ Operators .. table:: :widths: auto - +-------------------------+-----------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`RID` right **)** | - +-------------------------+-----------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<` **(** :ref:`RID` right **)** | - +-------------------------+-----------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<=` **(** :ref:`RID` right **)** | - +-------------------------+-----------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`RID` right **)** | - +-------------------------+-----------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >` **(** :ref:`RID` right **)** | - +-------------------------+-----------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >=` **(** :ref:`RID` right **)** | - +-------------------------+-----------------------------------------------------------------------------------------+ + +-------------------------+--------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`RID`\ ) | + +-------------------------+--------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<`\ (\ right\: :ref:`RID`\ ) | + +-------------------------+--------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<=`\ (\ right\: :ref:`RID`\ ) | + +-------------------------+--------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`RID`\ ) | + +-------------------------+--------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >`\ (\ right\: :ref:`RID`\ ) | + +-------------------------+--------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >=`\ (\ right\: :ref:`RID`\ ) | + +-------------------------+--------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -88,7 +88,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`RID` **RID** **(** **)** +:ref:`RID` **RID**\ (\ ) Constructs an empty **RID** with the invalid ID ``0``. @@ -98,7 +98,7 @@ Constructs an empty **RID** with the invalid ID ``0``. .. rst-class:: classref-constructor -:ref:`RID` **RID** **(** :ref:`RID` from **)** +:ref:`RID` **RID**\ (\ from\: :ref:`RID`\ ) Constructs a **RID** as a copy of the given **RID**. @@ -115,7 +115,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_id** **(** **)** |const| +:ref:`int` **get_id**\ (\ ) |const| Returns the ID of the referenced low-level resource. @@ -127,7 +127,7 @@ Returns the ID of the referenced low-level resource. .. rst-class:: classref-method -:ref:`bool` **is_valid** **(** **)** |const| +:ref:`bool` **is_valid**\ (\ ) |const| Returns ``true`` if the **RID** is not ``0``. @@ -144,7 +144,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`RID` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`RID`\ ) Returns ``true`` if the **RID**\ s are not equal. @@ -156,7 +156,7 @@ Returns ``true`` if the **RID**\ s are not equal. .. rst-class:: classref-operator -:ref:`bool` **operator <** **(** :ref:`RID` right **)** +:ref:`bool` **operator <**\ (\ right\: :ref:`RID`\ ) Returns ``true`` if the **RID**'s ID is less than ``right``'s ID. @@ -168,7 +168,7 @@ Returns ``true`` if the **RID**'s ID is less than ``right``'s ID. .. rst-class:: classref-operator -:ref:`bool` **operator <=** **(** :ref:`RID` right **)** +:ref:`bool` **operator <=**\ (\ right\: :ref:`RID`\ ) Returns ``true`` if the **RID**'s ID is less than or equal to ``right``'s ID. @@ -180,7 +180,7 @@ Returns ``true`` if the **RID**'s ID is less than or equal to ``right``'s ID. .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`RID` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`RID`\ ) Returns ``true`` if both **RID**\ s are equal, which means they both refer to the same low-level resource. @@ -192,7 +192,7 @@ Returns ``true`` if both **RID**\ s are equal, which means they both refer to th .. rst-class:: classref-operator -:ref:`bool` **operator >** **(** :ref:`RID` right **)** +:ref:`bool` **operator >**\ (\ right\: :ref:`RID`\ ) Returns ``true`` if the **RID**'s ID is greater than ``right``'s ID. @@ -204,7 +204,7 @@ Returns ``true`` if the **RID**'s ID is greater than ``right``'s ID. .. rst-class:: classref-operator -:ref:`bool` **operator >=** **(** :ref:`RID` right **)** +:ref:`bool` **operator >=**\ (\ right\: :ref:`RID`\ ) Returns ``true`` if the **RID**'s ID is greater than or equal to ``right``'s ID. @@ -215,3 +215,4 @@ Returns ``true`` if the **RID**'s ID is greater than or equal to ``right``'s ID. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 80966cf56d3..e1f752bd40e 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -104,33 +104,33 @@ Methods .. table:: :widths: auto - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_integrate_forces` **(** :ref:`PhysicsDirectBodyState2D` state **)** |virtual| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_constant_central_force` **(** :ref:`Vector2` force **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_constant_force` **(** :ref:`Vector2` force, :ref:`Vector2` position=Vector2(0, 0) **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_constant_torque` **(** :ref:`float` torque **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_central_force` **(** :ref:`Vector2` force **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_central_impulse` **(** :ref:`Vector2` impulse=Vector2(0, 0) **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_force` **(** :ref:`Vector2` force, :ref:`Vector2` position=Vector2(0, 0) **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_impulse` **(** :ref:`Vector2` impulse, :ref:`Vector2` position=Vector2(0, 0) **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_torque` **(** :ref:`float` torque **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_torque_impulse` **(** :ref:`float` torque **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node2D[]` | :ref:`get_colliding_bodies` **(** **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_contact_count` **(** **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_axis_velocity` **(** :ref:`Vector2` axis_velocity **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_integrate_forces`\ (\ state\: :ref:`PhysicsDirectBodyState2D`\ ) |virtual| | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_constant_central_force`\ (\ force\: :ref:`Vector2`\ ) | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_constant_force`\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_constant_torque`\ (\ torque\: :ref:`float`\ ) | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_central_force`\ (\ force\: :ref:`Vector2`\ ) | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_central_impulse`\ (\ impulse\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_force`\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_impulse`\ (\ impulse\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_torque`\ (\ torque\: :ref:`float`\ ) | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_torque_impulse`\ (\ torque\: :ref:`float`\ ) | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Node2D`\] | :ref:`get_colliding_bodies`\ (\ ) |const| | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_contact_count`\ (\ ) |const| | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_axis_velocity`\ (\ axis_velocity\: :ref:`Vector2`\ ) | + +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -145,7 +145,7 @@ Signals .. rst-class:: classref-signal -**body_entered** **(** :ref:`Node` body **)** +**body_entered**\ (\ body\: :ref:`Node`\ ) Emitted when a collision with another :ref:`PhysicsBody2D` or :ref:`TileMap` occurs. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. :ref:`TileMap`\ s are detected if the :ref:`TileSet` has Collision :ref:`Shape2D`\ s. @@ -159,7 +159,7 @@ Emitted when a collision with another :ref:`PhysicsBody2D` .. rst-class:: classref-signal -**body_exited** **(** :ref:`Node` body **)** +**body_exited**\ (\ body\: :ref:`Node`\ ) Emitted when the collision with another :ref:`PhysicsBody2D` or :ref:`TileMap` ends. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. :ref:`TileMap`\ s are detected if the :ref:`TileSet` has Collision :ref:`Shape2D`\ s. @@ -173,7 +173,7 @@ Emitted when the collision with another :ref:`PhysicsBody2D .. rst-class:: classref-signal -**body_shape_entered** **(** :ref:`RID` body_rid, :ref:`Node` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** +**body_shape_entered**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) Emitted when one of this RigidBody2D's :ref:`Shape2D`\ s collides with another :ref:`PhysicsBody2D` or :ref:`TileMap`'s :ref:`Shape2D`\ s. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. :ref:`TileMap`\ s are detected if the :ref:`TileSet` has Collision :ref:`Shape2D`\ s. @@ -193,7 +193,7 @@ Emitted when one of this RigidBody2D's :ref:`Shape2D`\ s collides .. rst-class:: classref-signal -**body_shape_exited** **(** :ref:`RID` body_rid, :ref:`Node` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** +**body_shape_exited**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) Emitted when the collision between one of this RigidBody2D's :ref:`Shape2D`\ s and another :ref:`PhysicsBody2D` or :ref:`TileMap`'s :ref:`Shape2D`\ s ends. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. :ref:`TileMap`\ s are detected if the :ref:`TileSet` has Collision :ref:`Shape2D`\ s. @@ -213,7 +213,7 @@ Emitted when the collision between one of this RigidBody2D's :ref:`Shape2D` value **)** -- :ref:`float` **get_angular_damp** **(** **)** +- |void| **set_angular_damp**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_angular_damp**\ (\ ) Damps the body's rotation. By default, the body will use the **Default Angular Damp** in **Project > Project Settings > Physics > 2d** or any value override set by an :ref:`Area2D` the body is in. Depending on :ref:`angular_damp_mode`, you can set :ref:`angular_damp` to be added to or to replace the body's damping value. @@ -372,8 +372,8 @@ See :ref:`ProjectSettings.physics/2d/default_angular_damp` value **)** -- :ref:`DampMode` **get_angular_damp_mode** **(** **)** +- |void| **set_angular_damp_mode**\ (\ value\: :ref:`DampMode`\ ) +- :ref:`DampMode` **get_angular_damp_mode**\ (\ ) Defines how :ref:`angular_damp` is applied. See :ref:`DampMode` for possible values. @@ -389,8 +389,8 @@ Defines how :ref:`angular_damp` is appl .. rst-class:: classref-property-setget -- void **set_angular_velocity** **(** :ref:`float` value **)** -- :ref:`float` **get_angular_velocity** **(** **)** +- |void| **set_angular_velocity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_angular_velocity**\ (\ ) The body's rotational velocity in *radians* per second. @@ -406,8 +406,8 @@ The body's rotational velocity in *radians* per second. .. rst-class:: classref-property-setget -- void **set_can_sleep** **(** :ref:`bool` value **)** -- :ref:`bool` **is_able_to_sleep** **(** **)** +- |void| **set_can_sleep**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_able_to_sleep**\ (\ ) If ``true``, the body can enter sleep mode when there is no movement. See :ref:`sleeping`. @@ -423,8 +423,8 @@ If ``true``, the body can enter sleep mode when there is no movement. See :ref:` .. rst-class:: classref-property-setget -- void **set_center_of_mass** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_center_of_mass** **(** **)** +- |void| **set_center_of_mass**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_center_of_mass**\ (\ ) The body's custom center of mass, relative to the body's origin position, when :ref:`center_of_mass_mode` is set to :ref:`CENTER_OF_MASS_MODE_CUSTOM`. This is the balanced point of the body, where applied forces only cause linear acceleration. Applying forces outside of the center of mass causes angular acceleration. @@ -442,8 +442,8 @@ When :ref:`center_of_mass_mode` .. rst-class:: classref-property-setget -- void **set_center_of_mass_mode** **(** :ref:`CenterOfMassMode` value **)** -- :ref:`CenterOfMassMode` **get_center_of_mass_mode** **(** **)** +- |void| **set_center_of_mass_mode**\ (\ value\: :ref:`CenterOfMassMode`\ ) +- :ref:`CenterOfMassMode` **get_center_of_mass_mode**\ (\ ) Defines the way the body's center of mass is set. See :ref:`CenterOfMassMode` for possible values. @@ -459,8 +459,8 @@ Defines the way the body's center of mass is set. See :ref:`CenterOfMassMode` value **)** -- :ref:`Vector2` **get_constant_force** **(** **)** +- |void| **set_constant_force**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_constant_force**\ (\ ) The body's total constant positional forces applied during each physics update. @@ -478,8 +478,8 @@ See :ref:`add_constant_force` and : .. rst-class:: classref-property-setget -- void **set_constant_torque** **(** :ref:`float` value **)** -- :ref:`float` **get_constant_torque** **(** **)** +- |void| **set_constant_torque**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_constant_torque**\ (\ ) The body's total constant rotational forces applied during each physics update. @@ -497,8 +497,8 @@ See :ref:`add_constant_torque`. .. rst-class:: classref-property-setget -- void **set_contact_monitor** **(** :ref:`bool` value **)** -- :ref:`bool` **is_contact_monitor_enabled** **(** **)** +- |void| **set_contact_monitor**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_contact_monitor_enabled**\ (\ ) If ``true``, the RigidBody2D will emit signals when it collides with another body. @@ -516,8 +516,8 @@ If ``true``, the RigidBody2D will emit signals when it collides with another bod .. rst-class:: classref-property-setget -- void **set_continuous_collision_detection_mode** **(** :ref:`CCDMode` value **)** -- :ref:`CCDMode` **get_continuous_collision_detection_mode** **(** **)** +- |void| **set_continuous_collision_detection_mode**\ (\ value\: :ref:`CCDMode`\ ) +- :ref:`CCDMode` **get_continuous_collision_detection_mode**\ (\ ) Continuous collision detection mode. @@ -535,8 +535,8 @@ Continuous collision detection tries to predict where a moving body will collide .. rst-class:: classref-property-setget -- void **set_use_custom_integrator** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_custom_integrator** **(** **)** +- |void| **set_use_custom_integrator**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_custom_integrator**\ (\ ) If ``true``, internal force integration is disabled for this body. Aside from collision response, the body will only move as determined by the :ref:`_integrate_forces` function. @@ -552,8 +552,8 @@ If ``true``, internal force integration is disabled for this body. Aside from co .. rst-class:: classref-property-setget -- void **set_freeze_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_freeze_enabled** **(** **)** +- |void| **set_freeze_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_freeze_enabled**\ (\ ) If ``true``, the body is frozen. Gravity and forces are not applied anymore. @@ -573,8 +573,8 @@ For a body that is always frozen, use :ref:`StaticBody2D` or .. rst-class:: classref-property-setget -- void **set_freeze_mode** **(** :ref:`FreezeMode` value **)** -- :ref:`FreezeMode` **get_freeze_mode** **(** **)** +- |void| **set_freeze_mode**\ (\ value\: :ref:`FreezeMode`\ ) +- :ref:`FreezeMode` **get_freeze_mode**\ (\ ) The body's freeze mode. Can be used to set the body's behavior when :ref:`freeze` is enabled. See :ref:`FreezeMode` for possible values. @@ -592,8 +592,8 @@ For a body that is always frozen, use :ref:`StaticBody2D` or .. rst-class:: classref-property-setget -- void **set_gravity_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_gravity_scale** **(** **)** +- |void| **set_gravity_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_gravity_scale**\ (\ ) Multiplies the gravity applied to the body. The body's gravity is calculated from the **Default Gravity** value in **Project > Project Settings > Physics > 2d** and/or any additional gravity vector applied by :ref:`Area2D`\ s. @@ -609,8 +609,8 @@ Multiplies the gravity applied to the body. The body's gravity is calculated fro .. rst-class:: classref-property-setget -- void **set_inertia** **(** :ref:`float` value **)** -- :ref:`float` **get_inertia** **(** **)** +- |void| **set_inertia**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_inertia**\ (\ ) The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this property allows you to set a custom value. @@ -656,8 +656,8 @@ If set to ``0``, inertia is automatically computed (default value). .. rst-class:: classref-property-setget -- void **set_linear_damp** **(** :ref:`float` value **)** -- :ref:`float` **get_linear_damp** **(** **)** +- |void| **set_linear_damp**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_linear_damp**\ (\ ) Damps the body's movement. By default, the body will use the **Default Linear Damp** in **Project > Project Settings > Physics > 2d** or any value override set by an :ref:`Area2D` the body is in. Depending on :ref:`linear_damp_mode`, you can set :ref:`linear_damp` to be added to or to replace the body's damping value. @@ -675,8 +675,8 @@ See :ref:`ProjectSettings.physics/2d/default_linear_damp` value **)** -- :ref:`DampMode` **get_linear_damp_mode** **(** **)** +- |void| **set_linear_damp_mode**\ (\ value\: :ref:`DampMode`\ ) +- :ref:`DampMode` **get_linear_damp_mode**\ (\ ) Defines how :ref:`linear_damp` is applied. See :ref:`DampMode` for possible values. @@ -692,8 +692,8 @@ Defines how :ref:`linear_damp` is applie .. rst-class:: classref-property-setget -- void **set_linear_velocity** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_linear_velocity** **(** **)** +- |void| **set_linear_velocity**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_linear_velocity**\ (\ ) The body's linear velocity in pixels per second. Can be used sporadically, but **don't set this every frame**, because physics may run in another thread and runs at a different granularity. Use :ref:`_integrate_forces` as your process loop for precise control of the body state. @@ -709,8 +709,8 @@ The body's linear velocity in pixels per second. Can be used sporadically, but * .. rst-class:: classref-property-setget -- void **set_lock_rotation_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_lock_rotation_enabled** **(** **)** +- |void| **set_lock_rotation_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_lock_rotation_enabled**\ (\ ) If ``true``, the body cannot rotate. Gravity and forces only apply linear movement. @@ -726,8 +726,8 @@ If ``true``, the body cannot rotate. Gravity and forces only apply linear moveme .. rst-class:: classref-property-setget -- void **set_mass** **(** :ref:`float` value **)** -- :ref:`float` **get_mass** **(** **)** +- |void| **set_mass**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_mass**\ (\ ) The body's mass. @@ -743,8 +743,8 @@ The body's mass. .. rst-class:: classref-property-setget -- void **set_max_contacts_reported** **(** :ref:`int` value **)** -- :ref:`int` **get_max_contacts_reported** **(** **)** +- |void| **set_max_contacts_reported**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_contacts_reported**\ (\ ) The maximum number of contacts that will be recorded. Requires a value greater than 0 and :ref:`contact_monitor` to be set to ``true`` to start to register contacts. Use :ref:`get_contact_count` to retrieve the count or :ref:`get_colliding_bodies` to retrieve bodies that have been collided with. @@ -762,8 +762,8 @@ The maximum number of contacts that will be recorded. Requires a value greater t .. rst-class:: classref-property-setget -- void **set_physics_material_override** **(** :ref:`PhysicsMaterial` value **)** -- :ref:`PhysicsMaterial` **get_physics_material_override** **(** **)** +- |void| **set_physics_material_override**\ (\ value\: :ref:`PhysicsMaterial`\ ) +- :ref:`PhysicsMaterial` **get_physics_material_override**\ (\ ) The physics material override for the body. @@ -781,8 +781,8 @@ If a material is assigned to this property, it will be used instead of any other .. rst-class:: classref-property-setget -- void **set_sleeping** **(** :ref:`bool` value **)** -- :ref:`bool` **is_sleeping** **(** **)** +- |void| **set_sleeping**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_sleeping**\ (\ ) If ``true``, the body will not move and will not calculate forces until woken up by another body through, for example, a collision, or by using the :ref:`apply_impulse` or :ref:`apply_force` methods. @@ -799,7 +799,7 @@ Method Descriptions .. rst-class:: classref-method -void **_integrate_forces** **(** :ref:`PhysicsDirectBodyState2D` state **)** |virtual| +|void| **_integrate_forces**\ (\ state\: :ref:`PhysicsDirectBodyState2D`\ ) |virtual| Allows you to read and safely modify the simulation state for the object. Use this instead of :ref:`Node._physics_process` if you need to directly change the body's ``position`` or other physics properties. By default, it works in addition to the usual physics behavior, but :ref:`custom_integrator` allows you to disable the default behavior and write custom force integration for a body. @@ -811,7 +811,7 @@ Allows you to read and safely modify the simulation state for the object. Use th .. rst-class:: classref-method -void **add_constant_central_force** **(** :ref:`Vector2` force **)** +|void| **add_constant_central_force**\ (\ force\: :ref:`Vector2`\ ) Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with ``constant_force = Vector2(0, 0)``. @@ -825,7 +825,7 @@ This is equivalent to using :ref:`add_constant_force` force, :ref:`Vector2` position=Vector2(0, 0) **)** +|void| **add_constant_force**\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) Adds a constant positioned force to the body that keeps being applied over time until cleared with ``constant_force = Vector2(0, 0)``. @@ -839,7 +839,7 @@ Adds a constant positioned force to the body that keeps being applied over time .. rst-class:: classref-method -void **add_constant_torque** **(** :ref:`float` torque **)** +|void| **add_constant_torque**\ (\ torque\: :ref:`float`\ ) Adds a constant rotational force without affecting position that keeps being applied over time until cleared with ``constant_torque = 0``. @@ -851,7 +851,7 @@ Adds a constant rotational force without affecting position that keeps being app .. rst-class:: classref-method -void **apply_central_force** **(** :ref:`Vector2` force **)** +|void| **apply_central_force**\ (\ force\: :ref:`Vector2`\ ) Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. @@ -865,7 +865,7 @@ This is equivalent to using :ref:`apply_force` impulse=Vector2(0, 0) **)** +|void| **apply_central_impulse**\ (\ impulse\: :ref:`Vector2` = Vector2(0, 0)\ ) Applies a directional impulse without affecting rotation. @@ -881,7 +881,7 @@ This is equivalent to using :ref:`apply_impulse` force, :ref:`Vector2` position=Vector2(0, 0) **)** +|void| **apply_force**\ (\ force\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. @@ -895,7 +895,7 @@ Applies a positioned force to the body. A force is time dependent and meant to b .. rst-class:: classref-method -void **apply_impulse** **(** :ref:`Vector2` impulse, :ref:`Vector2` position=Vector2(0, 0) **)** +|void| **apply_impulse**\ (\ impulse\: :ref:`Vector2`, position\: :ref:`Vector2` = Vector2(0, 0)\ ) Applies a positioned impulse to the body. @@ -911,7 +911,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -void **apply_torque** **(** :ref:`float` torque **)** +|void| **apply_torque**\ (\ torque\: :ref:`float`\ ) Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. @@ -925,7 +925,7 @@ Applies a rotational force without affecting position. A force is time dependent .. rst-class:: classref-method -void **apply_torque_impulse** **(** :ref:`float` torque **)** +|void| **apply_torque_impulse**\ (\ torque\: :ref:`float`\ ) Applies a rotational impulse to the body without affecting the position. @@ -941,7 +941,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -:ref:`Node2D[]` **get_colliding_bodies** **(** **)** |const| +:ref:`Array`\[:ref:`Node2D`\] **get_colliding_bodies**\ (\ ) |const| Returns a list of the bodies colliding with this one. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. @@ -955,7 +955,7 @@ Returns a list of the bodies colliding with this one. Requires :ref:`contact_mon .. rst-class:: classref-method -:ref:`int` **get_contact_count** **(** **)** |const| +:ref:`int` **get_contact_count**\ (\ ) |const| Returns the number of contacts this body has with other bodies. By default, this returns 0 unless bodies are configured to monitor contacts (see :ref:`contact_monitor`). @@ -969,7 +969,7 @@ Returns the number of contacts this body has with other bodies. By default, this .. rst-class:: classref-method -void **set_axis_velocity** **(** :ref:`Vector2` axis_velocity **)** +|void| **set_axis_velocity**\ (\ axis_velocity\: :ref:`Vector2`\ ) Sets the body's velocity on the given axis. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. @@ -980,3 +980,4 @@ Sets the body's velocity on the given axis. The velocity in the given vector axi .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rigidbody3d.rst b/classes/class_rigidbody3d.rst index 15aff1a29a4..a33a69d414f 100644 --- a/classes/class_rigidbody3d.rst +++ b/classes/class_rigidbody3d.rst @@ -106,35 +106,35 @@ Methods .. table:: :widths: auto - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_integrate_forces` **(** :ref:`PhysicsDirectBodyState3D` state **)** |virtual| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_constant_central_force` **(** :ref:`Vector3` force **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_constant_force` **(** :ref:`Vector3` force, :ref:`Vector3` position=Vector3(0, 0, 0) **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_constant_torque` **(** :ref:`Vector3` torque **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_central_force` **(** :ref:`Vector3` force **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_central_impulse` **(** :ref:`Vector3` impulse **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_force` **(** :ref:`Vector3` force, :ref:`Vector3` position=Vector3(0, 0, 0) **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_impulse` **(** :ref:`Vector3` impulse, :ref:`Vector3` position=Vector3(0, 0, 0) **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_torque` **(** :ref:`Vector3` torque **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_torque_impulse` **(** :ref:`Vector3` impulse **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node3D[]` | :ref:`get_colliding_bodies` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_contact_count` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`get_inverse_inertia_tensor` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_axis_velocity` **(** :ref:`Vector3` axis_velocity **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_integrate_forces`\ (\ state\: :ref:`PhysicsDirectBodyState3D`\ ) |virtual| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_constant_central_force`\ (\ force\: :ref:`Vector3`\ ) | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_constant_force`\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_constant_torque`\ (\ torque\: :ref:`Vector3`\ ) | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_central_force`\ (\ force\: :ref:`Vector3`\ ) | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_central_impulse`\ (\ impulse\: :ref:`Vector3`\ ) | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_force`\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_impulse`\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_torque`\ (\ torque\: :ref:`Vector3`\ ) | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_torque_impulse`\ (\ impulse\: :ref:`Vector3`\ ) | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Node3D`\] | :ref:`get_colliding_bodies`\ (\ ) |const| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_contact_count`\ (\ ) |const| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`get_inverse_inertia_tensor`\ (\ ) |const| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_axis_velocity`\ (\ axis_velocity\: :ref:`Vector3`\ ) | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -149,7 +149,7 @@ Signals .. rst-class:: classref-signal -**body_entered** **(** :ref:`Node` body **)** +**body_entered**\ (\ body\: :ref:`Node`\ ) Emitted when a collision with another :ref:`PhysicsBody3D` or :ref:`GridMap` occurs. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. :ref:`GridMap`\ s are detected if the :ref:`MeshLibrary` has Collision :ref:`Shape3D`\ s. @@ -163,7 +163,7 @@ Emitted when a collision with another :ref:`PhysicsBody3D` .. rst-class:: classref-signal -**body_exited** **(** :ref:`Node` body **)** +**body_exited**\ (\ body\: :ref:`Node`\ ) Emitted when the collision with another :ref:`PhysicsBody3D` or :ref:`GridMap` ends. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. :ref:`GridMap`\ s are detected if the :ref:`MeshLibrary` has Collision :ref:`Shape3D`\ s. @@ -177,7 +177,7 @@ Emitted when the collision with another :ref:`PhysicsBody3D .. rst-class:: classref-signal -**body_shape_entered** **(** :ref:`RID` body_rid, :ref:`Node` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** +**body_shape_entered**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) Emitted when one of this RigidBody3D's :ref:`Shape3D`\ s collides with another :ref:`PhysicsBody3D` or :ref:`GridMap`'s :ref:`Shape3D`\ s. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. :ref:`GridMap`\ s are detected if the :ref:`MeshLibrary` has Collision :ref:`Shape3D`\ s. @@ -197,7 +197,7 @@ Emitted when one of this RigidBody3D's :ref:`Shape3D`\ s collides .. rst-class:: classref-signal -**body_shape_exited** **(** :ref:`RID` body_rid, :ref:`Node` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** +**body_shape_exited**\ (\ body_rid\: :ref:`RID`, body\: :ref:`Node`, body_shape_index\: :ref:`int`, local_shape_index\: :ref:`int`\ ) Emitted when the collision between one of this RigidBody3D's :ref:`Shape3D`\ s and another :ref:`PhysicsBody3D` or :ref:`GridMap`'s :ref:`Shape3D`\ s ends. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. :ref:`GridMap`\ s are detected if the :ref:`MeshLibrary` has Collision :ref:`Shape3D`\ s. @@ -217,7 +217,7 @@ Emitted when the collision between one of this RigidBody3D's :ref:`Shape3D` value **)** -- :ref:`float` **get_angular_damp** **(** **)** +- |void| **set_angular_damp**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_angular_damp**\ (\ ) Damps the body's rotation. By default, the body will use the **Default Angular Damp** in **Project > Project Settings > Physics > 3d** or any value override set by an :ref:`Area3D` the body is in. Depending on :ref:`angular_damp_mode`, you can set :ref:`angular_damp` to be added to or to replace the body's damping value. @@ -342,8 +342,8 @@ See :ref:`ProjectSettings.physics/3d/default_angular_damp` value **)** -- :ref:`DampMode` **get_angular_damp_mode** **(** **)** +- |void| **set_angular_damp_mode**\ (\ value\: :ref:`DampMode`\ ) +- :ref:`DampMode` **get_angular_damp_mode**\ (\ ) Defines how :ref:`angular_damp` is applied. See :ref:`DampMode` for possible values. @@ -359,8 +359,8 @@ Defines how :ref:`angular_damp` is appl .. rst-class:: classref-property-setget -- void **set_angular_velocity** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_angular_velocity** **(** **)** +- |void| **set_angular_velocity**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_angular_velocity**\ (\ ) The RigidBody3D's rotational velocity in *radians* per second. @@ -376,8 +376,8 @@ The RigidBody3D's rotational velocity in *radians* per second. .. rst-class:: classref-property-setget -- void **set_can_sleep** **(** :ref:`bool` value **)** -- :ref:`bool` **is_able_to_sleep** **(** **)** +- |void| **set_can_sleep**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_able_to_sleep**\ (\ ) If ``true``, the body can enter sleep mode when there is no movement. See :ref:`sleeping`. @@ -393,8 +393,8 @@ If ``true``, the body can enter sleep mode when there is no movement. See :ref:` .. rst-class:: classref-property-setget -- void **set_center_of_mass** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_center_of_mass** **(** **)** +- |void| **set_center_of_mass**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_center_of_mass**\ (\ ) The body's custom center of mass, relative to the body's origin position, when :ref:`center_of_mass_mode` is set to :ref:`CENTER_OF_MASS_MODE_CUSTOM`. This is the balanced point of the body, where applied forces only cause linear acceleration. Applying forces outside of the center of mass causes angular acceleration. @@ -412,8 +412,8 @@ When :ref:`center_of_mass_mode` .. rst-class:: classref-property-setget -- void **set_center_of_mass_mode** **(** :ref:`CenterOfMassMode` value **)** -- :ref:`CenterOfMassMode` **get_center_of_mass_mode** **(** **)** +- |void| **set_center_of_mass_mode**\ (\ value\: :ref:`CenterOfMassMode`\ ) +- :ref:`CenterOfMassMode` **get_center_of_mass_mode**\ (\ ) Defines the way the body's center of mass is set. See :ref:`CenterOfMassMode` for possible values. @@ -429,8 +429,8 @@ Defines the way the body's center of mass is set. See :ref:`CenterOfMassMode` value **)** -- :ref:`Vector3` **get_constant_force** **(** **)** +- |void| **set_constant_force**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_constant_force**\ (\ ) The body's total constant positional forces applied during each physics update. @@ -448,8 +448,8 @@ See :ref:`add_constant_force` and : .. rst-class:: classref-property-setget -- void **set_constant_torque** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_constant_torque** **(** **)** +- |void| **set_constant_torque**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_constant_torque**\ (\ ) The body's total constant rotational forces applied during each physics update. @@ -467,8 +467,8 @@ See :ref:`add_constant_torque`. .. rst-class:: classref-property-setget -- void **set_contact_monitor** **(** :ref:`bool` value **)** -- :ref:`bool` **is_contact_monitor_enabled** **(** **)** +- |void| **set_contact_monitor**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_contact_monitor_enabled**\ (\ ) If ``true``, the RigidBody3D will emit signals when it collides with another body. @@ -486,8 +486,8 @@ If ``true``, the RigidBody3D will emit signals when it collides with another bod .. rst-class:: classref-property-setget -- void **set_use_continuous_collision_detection** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_continuous_collision_detection** **(** **)** +- |void| **set_use_continuous_collision_detection**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_continuous_collision_detection**\ (\ ) If ``true``, continuous collision detection is used. @@ -505,8 +505,8 @@ Continuous collision detection tries to predict where a moving body will collide .. rst-class:: classref-property-setget -- void **set_use_custom_integrator** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_custom_integrator** **(** **)** +- |void| **set_use_custom_integrator**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_custom_integrator**\ (\ ) If ``true``, internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the :ref:`_integrate_forces` function, if defined. @@ -522,8 +522,8 @@ If ``true``, internal force integration will be disabled (like gravity or air fr .. rst-class:: classref-property-setget -- void **set_freeze_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_freeze_enabled** **(** **)** +- |void| **set_freeze_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_freeze_enabled**\ (\ ) If ``true``, the body is frozen. Gravity and forces are not applied anymore. @@ -543,8 +543,8 @@ For a body that is always frozen, use :ref:`StaticBody3D` or .. rst-class:: classref-property-setget -- void **set_freeze_mode** **(** :ref:`FreezeMode` value **)** -- :ref:`FreezeMode` **get_freeze_mode** **(** **)** +- |void| **set_freeze_mode**\ (\ value\: :ref:`FreezeMode`\ ) +- :ref:`FreezeMode` **get_freeze_mode**\ (\ ) The body's freeze mode. Can be used to set the body's behavior when :ref:`freeze` is enabled. See :ref:`FreezeMode` for possible values. @@ -562,8 +562,8 @@ For a body that is always frozen, use :ref:`StaticBody3D` or .. rst-class:: classref-property-setget -- void **set_gravity_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_gravity_scale** **(** **)** +- |void| **set_gravity_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_gravity_scale**\ (\ ) This is multiplied by the global 3D gravity setting found in **Project > Project Settings > Physics > 3d** to produce RigidBody3D's gravity. For example, a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object. @@ -579,8 +579,8 @@ This is multiplied by the global 3D gravity setting found in **Project > Project .. rst-class:: classref-property-setget -- void **set_inertia** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_inertia** **(** **)** +- |void| **set_inertia**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_inertia**\ (\ ) The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body on each axis. The moment of inertia is usually computed automatically from the mass and the shapes, but this property allows you to set a custom value. @@ -626,8 +626,8 @@ If set to :ref:`Vector3.ZERO`, inertia is automatic .. rst-class:: classref-property-setget -- void **set_linear_damp** **(** :ref:`float` value **)** -- :ref:`float` **get_linear_damp** **(** **)** +- |void| **set_linear_damp**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_linear_damp**\ (\ ) Damps the body's movement. By default, the body will use the **Default Linear Damp** in **Project > Project Settings > Physics > 3d** or any value override set by an :ref:`Area3D` the body is in. Depending on :ref:`linear_damp_mode`, you can set :ref:`linear_damp` to be added to or to replace the body's damping value. @@ -645,8 +645,8 @@ See :ref:`ProjectSettings.physics/3d/default_linear_damp` value **)** -- :ref:`DampMode` **get_linear_damp_mode** **(** **)** +- |void| **set_linear_damp_mode**\ (\ value\: :ref:`DampMode`\ ) +- :ref:`DampMode` **get_linear_damp_mode**\ (\ ) Defines how :ref:`linear_damp` is applied. See :ref:`DampMode` for possible values. @@ -662,8 +662,8 @@ Defines how :ref:`linear_damp` is applie .. rst-class:: classref-property-setget -- void **set_linear_velocity** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_linear_velocity** **(** **)** +- |void| **set_linear_velocity**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_linear_velocity**\ (\ ) The body's linear velocity in units per second. Can be used sporadically, but **don't set this every frame**, because physics may run in another thread and runs at a different granularity. Use :ref:`_integrate_forces` as your process loop for precise control of the body state. @@ -679,8 +679,8 @@ The body's linear velocity in units per second. Can be used sporadically, but ** .. rst-class:: classref-property-setget -- void **set_lock_rotation_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_lock_rotation_enabled** **(** **)** +- |void| **set_lock_rotation_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_lock_rotation_enabled**\ (\ ) If ``true``, the body cannot rotate. Gravity and forces only apply linear movement. @@ -696,8 +696,8 @@ If ``true``, the body cannot rotate. Gravity and forces only apply linear moveme .. rst-class:: classref-property-setget -- void **set_mass** **(** :ref:`float` value **)** -- :ref:`float` **get_mass** **(** **)** +- |void| **set_mass**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_mass**\ (\ ) The body's mass. @@ -713,8 +713,8 @@ The body's mass. .. rst-class:: classref-property-setget -- void **set_max_contacts_reported** **(** :ref:`int` value **)** -- :ref:`int` **get_max_contacts_reported** **(** **)** +- |void| **set_max_contacts_reported**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_contacts_reported**\ (\ ) The maximum number of contacts that will be recorded. Requires a value greater than 0 and :ref:`contact_monitor` to be set to ``true`` to start to register contacts. Use :ref:`get_contact_count` to retrieve the count or :ref:`get_colliding_bodies` to retrieve bodies that have been collided with. @@ -732,8 +732,8 @@ The maximum number of contacts that will be recorded. Requires a value greater t .. rst-class:: classref-property-setget -- void **set_physics_material_override** **(** :ref:`PhysicsMaterial` value **)** -- :ref:`PhysicsMaterial` **get_physics_material_override** **(** **)** +- |void| **set_physics_material_override**\ (\ value\: :ref:`PhysicsMaterial`\ ) +- :ref:`PhysicsMaterial` **get_physics_material_override**\ (\ ) The physics material override for the body. @@ -751,8 +751,8 @@ If a material is assigned to this property, it will be used instead of any other .. rst-class:: classref-property-setget -- void **set_sleeping** **(** :ref:`bool` value **)** -- :ref:`bool` **is_sleeping** **(** **)** +- |void| **set_sleeping**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_sleeping**\ (\ ) If ``true``, the body will not move and will not calculate forces until woken up by another body through, for example, a collision, or by using the :ref:`apply_impulse` or :ref:`apply_force` methods. @@ -769,7 +769,7 @@ Method Descriptions .. rst-class:: classref-method -void **_integrate_forces** **(** :ref:`PhysicsDirectBodyState3D` state **)** |virtual| +|void| **_integrate_forces**\ (\ state\: :ref:`PhysicsDirectBodyState3D`\ ) |virtual| Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default, it works in addition to the usual physics behavior, but the :ref:`custom_integrator` property allows you to disable the default behavior and do fully custom force integration for a body. @@ -781,7 +781,7 @@ Called during physics processing, allowing you to read and safely modify the sim .. rst-class:: classref-method -void **add_constant_central_force** **(** :ref:`Vector3` force **)** +|void| **add_constant_central_force**\ (\ force\: :ref:`Vector3`\ ) Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with ``constant_force = Vector3(0, 0, 0)``. @@ -795,7 +795,7 @@ This is equivalent to using :ref:`add_constant_force` force, :ref:`Vector3` position=Vector3(0, 0, 0) **)** +|void| **add_constant_force**\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) Adds a constant positioned force to the body that keeps being applied over time until cleared with ``constant_force = Vector3(0, 0, 0)``. @@ -809,7 +809,7 @@ Adds a constant positioned force to the body that keeps being applied over time .. rst-class:: classref-method -void **add_constant_torque** **(** :ref:`Vector3` torque **)** +|void| **add_constant_torque**\ (\ torque\: :ref:`Vector3`\ ) Adds a constant rotational force without affecting position that keeps being applied over time until cleared with ``constant_torque = Vector3(0, 0, 0)``. @@ -821,7 +821,7 @@ Adds a constant rotational force without affecting position that keeps being app .. rst-class:: classref-method -void **apply_central_force** **(** :ref:`Vector3` force **)** +|void| **apply_central_force**\ (\ force\: :ref:`Vector3`\ ) Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. @@ -835,7 +835,7 @@ This is equivalent to using :ref:`apply_force` impulse **)** +|void| **apply_central_impulse**\ (\ impulse\: :ref:`Vector3`\ ) Applies a directional impulse without affecting rotation. @@ -851,7 +851,7 @@ This is equivalent to using :ref:`apply_impulse` force, :ref:`Vector3` position=Vector3(0, 0, 0) **)** +|void| **apply_force**\ (\ force\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. @@ -865,7 +865,7 @@ Applies a positioned force to the body. A force is time dependent and meant to b .. rst-class:: classref-method -void **apply_impulse** **(** :ref:`Vector3` impulse, :ref:`Vector3` position=Vector3(0, 0, 0) **)** +|void| **apply_impulse**\ (\ impulse\: :ref:`Vector3`, position\: :ref:`Vector3` = Vector3(0, 0, 0)\ ) Applies a positioned impulse to the body. @@ -881,7 +881,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -void **apply_torque** **(** :ref:`Vector3` torque **)** +|void| **apply_torque**\ (\ torque\: :ref:`Vector3`\ ) Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. @@ -895,7 +895,7 @@ Applies a rotational force without affecting position. A force is time dependent .. rst-class:: classref-method -void **apply_torque_impulse** **(** :ref:`Vector3` impulse **)** +|void| **apply_torque_impulse**\ (\ impulse\: :ref:`Vector3`\ ) Applies a rotational impulse to the body without affecting the position. @@ -911,7 +911,7 @@ An impulse is time-independent! Applying an impulse every frame would result in .. rst-class:: classref-method -:ref:`Node3D[]` **get_colliding_bodies** **(** **)** |const| +:ref:`Array`\[:ref:`Node3D`\] **get_colliding_bodies**\ (\ ) |const| Returns a list of the bodies colliding with this one. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`max_contacts_reported` to be set high enough to detect all the collisions. @@ -925,7 +925,7 @@ Returns a list of the bodies colliding with this one. Requires :ref:`contact_mon .. rst-class:: classref-method -:ref:`int` **get_contact_count** **(** **)** |const| +:ref:`int` **get_contact_count**\ (\ ) |const| Returns the number of contacts this body has with other bodies. By default, this returns 0 unless bodies are configured to monitor contacts (see :ref:`contact_monitor`). @@ -939,7 +939,7 @@ Returns the number of contacts this body has with other bodies. By default, this .. rst-class:: classref-method -:ref:`Basis` **get_inverse_inertia_tensor** **(** **)** |const| +:ref:`Basis` **get_inverse_inertia_tensor**\ (\ ) |const| Returns the inverse inertia tensor basis. This is used to calculate the angular acceleration resulting from a torque applied to the **RigidBody3D**. @@ -951,7 +951,7 @@ Returns the inverse inertia tensor basis. This is used to calculate the angular .. rst-class:: classref-method -void **set_axis_velocity** **(** :ref:`Vector3` axis_velocity **)** +|void| **set_axis_velocity**\ (\ axis_velocity\: :ref:`Vector3`\ ) Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. @@ -962,3 +962,4 @@ Sets an axis velocity. The velocity in the given vector axis will be set as the .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_rootmotionview.rst b/classes/class_rootmotionview.rst index acdb3af1b48..c7fd8514203 100644 --- a/classes/class_rootmotionview.rst +++ b/classes/class_rootmotionview.rst @@ -67,8 +67,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_animation_path** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_animation_path** **(** **)** +- |void| **set_animation_path**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_animation_path**\ (\ ) Path to an :ref:`AnimationMixer` node to use as a basis for root motion. @@ -84,8 +84,8 @@ Path to an :ref:`AnimationMixer` node to use as a basis fo .. rst-class:: classref-property-setget -- void **set_cell_size** **(** :ref:`float` value **)** -- :ref:`float` **get_cell_size** **(** **)** +- |void| **set_cell_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_cell_size**\ (\ ) The grid's cell size in 3D units. @@ -101,8 +101,8 @@ The grid's cell size in 3D units. .. rst-class:: classref-property-setget -- void **set_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_color** **(** **)** +- |void| **set_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_color**\ (\ ) The grid's color. @@ -118,8 +118,8 @@ The grid's color. .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) The grid's radius in 3D units. The grid's opacity will fade gradually as the distance from the origin increases until this :ref:`radius` is reached. @@ -135,8 +135,8 @@ The grid's radius in 3D units. The grid's opacity will fade gradually as the dis .. rst-class:: classref-property-setget -- void **set_zero_y** **(** :ref:`bool` value **)** -- :ref:`bool` **get_zero_y** **(** **)** +- |void| **set_zero_y**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_zero_y**\ (\ ) If ``true``, the grid's points will all be on the same Y coordinate (*local* Y = 0). If ``false``, the points' original Y coordinate is preserved. @@ -147,3 +147,4 @@ If ``true``, the grid's points will all be on the same Y coordinate (*local* Y = .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_scenemultiplayer.rst b/classes/class_scenemultiplayer.rst index 053fa59023c..d4da6438304 100644 --- a/classes/class_scenemultiplayer.rst +++ b/classes/class_scenemultiplayer.rst @@ -63,19 +63,19 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`complete_auth` **(** :ref:`int` id **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`disconnect_peer` **(** :ref:`int` id **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_authenticating_peers` **(** **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`send_auth` **(** :ref:`int` id, :ref:`PackedByteArray` data **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`send_bytes` **(** :ref:`PackedByteArray` bytes, :ref:`int` id=0, :ref:`TransferMode` mode=2, :ref:`int` channel=0 **)** | - +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`complete_auth`\ (\ id\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`disconnect_peer`\ (\ id\: :ref:`int`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_authenticating_peers`\ (\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`send_auth`\ (\ id\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`send_bytes`\ (\ bytes\: :ref:`PackedByteArray`, id\: :ref:`int` = 0, mode\: :ref:`TransferMode` = 2, channel\: :ref:`int` = 0\ ) | + +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -90,7 +90,7 @@ Signals .. rst-class:: classref-signal -**peer_authenticating** **(** :ref:`int` id **)** +**peer_authenticating**\ (\ id\: :ref:`int`\ ) Emitted when this MultiplayerAPI's :ref:`MultiplayerAPI.multiplayer_peer` connects to a new peer and a valid :ref:`auth_callback` is set. In this case, the :ref:`MultiplayerAPI.peer_connected` will not be emitted until :ref:`complete_auth` is called with given peer ``id``. While in this state, the peer will not be included in the list returned by :ref:`MultiplayerAPI.get_peers` (but in the one returned by :ref:`get_authenticating_peers`), and only authentication data will be sent or received. See :ref:`send_auth` for sending authentication data. @@ -102,7 +102,7 @@ Emitted when this MultiplayerAPI's :ref:`MultiplayerAPI.multiplayer_peer` id **)** +**peer_authentication_failed**\ (\ id\: :ref:`int`\ ) Emitted when this MultiplayerAPI's :ref:`MultiplayerAPI.multiplayer_peer` disconnects from a peer for which authentication had not yet completed. See :ref:`peer_authenticating`. @@ -114,7 +114,7 @@ Emitted when this MultiplayerAPI's :ref:`MultiplayerAPI.multiplayer_peer` id, :ref:`PackedByteArray` packet **)** +**peer_packet**\ (\ id\: :ref:`int`, packet\: :ref:`PackedByteArray`\ ) Emitted when this MultiplayerAPI's :ref:`MultiplayerAPI.multiplayer_peer` receives a ``packet`` with custom data (see :ref:`send_bytes`). ID is the peer ID of the peer that sent the packet. @@ -135,8 +135,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_allow_object_decoding** **(** :ref:`bool` value **)** -- :ref:`bool` **is_object_decoding_allowed** **(** **)** +- |void| **set_allow_object_decoding**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_object_decoding_allowed**\ (\ ) If ``true``, the MultiplayerAPI will allow encoding and decoding of object during RPCs. @@ -154,8 +154,8 @@ If ``true``, the MultiplayerAPI will allow encoding and decoding of object durin .. rst-class:: classref-property-setget -- void **set_auth_callback** **(** :ref:`Callable` value **)** -- :ref:`Callable` **get_auth_callback** **(** **)** +- |void| **set_auth_callback**\ (\ value\: :ref:`Callable`\ ) +- :ref:`Callable` **get_auth_callback**\ (\ ) The callback to execute when when receiving authentication data sent via :ref:`send_auth`. If the :ref:`Callable` is empty (default), peers will be automatically accepted as soon as they connect. @@ -171,8 +171,8 @@ The callback to execute when when receiving authentication data sent via :ref:`s .. rst-class:: classref-property-setget -- void **set_auth_timeout** **(** :ref:`float` value **)** -- :ref:`float` **get_auth_timeout** **(** **)** +- |void| **set_auth_timeout**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_auth_timeout**\ (\ ) If set to a value greater than ``0.0``, the maximum amount of time peers can stay in the authenticating state, after which the authentication will automatically fail. See the :ref:`peer_authenticating` and :ref:`peer_authentication_failed` signals. @@ -188,8 +188,8 @@ If set to a value greater than ``0.0``, the maximum amount of time peers can sta .. rst-class:: classref-property-setget -- void **set_max_delta_packet_size** **(** :ref:`int` value **)** -- :ref:`int` **get_max_delta_packet_size** **(** **)** +- |void| **set_max_delta_packet_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_delta_packet_size**\ (\ ) Maximum size of each delta packet. Higher values increase the chance of receiving full updates in a single frame, but also the chance of causing networking congestion (higher latency, disconnections). See :ref:`MultiplayerSynchronizer`. @@ -205,8 +205,8 @@ Maximum size of each delta packet. Higher values increase the chance of receivin .. rst-class:: classref-property-setget -- void **set_max_sync_packet_size** **(** :ref:`int` value **)** -- :ref:`int` **get_max_sync_packet_size** **(** **)** +- |void| **set_max_sync_packet_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_sync_packet_size**\ (\ ) Maximum size of each synchronization packet. Higher values increase the chance of receiving full updates in a single frame, but also the chance of packet loss. See :ref:`MultiplayerSynchronizer`. @@ -222,8 +222,8 @@ Maximum size of each synchronization packet. Higher values increase the chance o .. rst-class:: classref-property-setget -- void **set_refuse_new_connections** **(** :ref:`bool` value **)** -- :ref:`bool` **is_refusing_new_connections** **(** **)** +- |void| **set_refuse_new_connections**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_refusing_new_connections**\ (\ ) If ``true``, the MultiplayerAPI's :ref:`MultiplayerAPI.multiplayer_peer` refuses new incoming connections. @@ -239,8 +239,8 @@ If ``true``, the MultiplayerAPI's :ref:`MultiplayerAPI.multiplayer_peer` value **)** -- :ref:`NodePath` **get_root_path** **(** **)** +- |void| **set_root_path**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_root_path**\ (\ ) The root path to use for RPCs and replication. Instead of an absolute path, a relative path will be used to find the node upon which the RPC should be executed. @@ -258,8 +258,8 @@ This effectively allows to have different branches of the scene tree to be manag .. rst-class:: classref-property-setget -- void **set_server_relay_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_server_relay_enabled** **(** **)** +- |void| **set_server_relay_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_server_relay_enabled**\ (\ ) Enable or disable the server feature that notifies clients of other peers' connection/disconnection, and relays messages between them. When this option is ``false``, clients won't be automatically notified of other peers and won't be able to send them packets through the server. @@ -280,7 +280,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the current SceneMultiplayer network state (you shouldn't call this unless you know what you are doing). @@ -292,7 +292,7 @@ Clears the current SceneMultiplayer network state (you shouldn't call this unles .. rst-class:: classref-method -:ref:`Error` **complete_auth** **(** :ref:`int` id **)** +:ref:`Error` **complete_auth**\ (\ id\: :ref:`int`\ ) Mark the authentication step as completed for the remote peer identified by ``id``. The :ref:`MultiplayerAPI.peer_connected` signal will be emitted for this peer once the remote side also completes the authentication. No further authentication messages are expected to be received from this peer. @@ -306,7 +306,7 @@ If a peer disconnects before completing authentication, either due to a network .. rst-class:: classref-method -void **disconnect_peer** **(** :ref:`int` id **)** +|void| **disconnect_peer**\ (\ id\: :ref:`int`\ ) Disconnects the peer identified by ``id``, removing it from the list of connected peers, and closing the underlying connection with it. @@ -318,7 +318,7 @@ Disconnects the peer identified by ``id``, removing it from the list of connecte .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_authenticating_peers** **(** **)** +:ref:`PackedInt32Array` **get_authenticating_peers**\ (\ ) Returns the IDs of the peers currently trying to authenticate with this :ref:`MultiplayerAPI`. @@ -330,7 +330,7 @@ Returns the IDs of the peers currently trying to authenticate with this :ref:`Mu .. rst-class:: classref-method -:ref:`Error` **send_auth** **(** :ref:`int` id, :ref:`PackedByteArray` data **)** +:ref:`Error` **send_auth**\ (\ id\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) Sends the specified ``data`` to the remote peer identified by ``id`` as part of an authentication message. This can be used to authenticate peers, and control when :ref:`MultiplayerAPI.peer_connected` is emitted (and the remote peer accepted as one of the connected peers). @@ -342,7 +342,7 @@ Sends the specified ``data`` to the remote peer identified by ``id`` as part of .. rst-class:: classref-method -:ref:`Error` **send_bytes** **(** :ref:`PackedByteArray` bytes, :ref:`int` id=0, :ref:`TransferMode` mode=2, :ref:`int` channel=0 **)** +:ref:`Error` **send_bytes**\ (\ bytes\: :ref:`PackedByteArray`, id\: :ref:`int` = 0, mode\: :ref:`TransferMode` = 2, channel\: :ref:`int` = 0\ ) Sends the given raw ``bytes`` to a specific peer identified by ``id`` (see :ref:`MultiplayerPeer.set_target_peer`). Default ID is ``0``, i.e. broadcast to all peers. @@ -353,3 +353,4 @@ Sends the given raw ``bytes`` to a specific peer identified by ``id`` (see :ref: .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_scenereplicationconfig.rst b/classes/class_scenereplicationconfig.rst index 0f1ab3678e8..5fdf6153696 100644 --- a/classes/class_scenereplicationconfig.rst +++ b/classes/class_scenereplicationconfig.rst @@ -22,33 +22,33 @@ Methods .. table:: :widths: auto - +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_property` **(** :ref:`NodePath` path, :ref:`int` index=-1 **)** | - +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath[]` | :ref:`get_properties` **(** **)** |const| | - +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_property` **(** :ref:`NodePath` path **)** |const| | - +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`property_get_index` **(** :ref:`NodePath` path **)** |const| | - +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ReplicationMode` | :ref:`property_get_replication_mode` **(** :ref:`NodePath` path **)** | - +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`property_get_spawn` **(** :ref:`NodePath` path **)** | - +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`property_get_sync` **(** :ref:`NodePath` path **)** | - +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`property_get_watch` **(** :ref:`NodePath` path **)** | - +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`property_set_replication_mode` **(** :ref:`NodePath` path, :ref:`ReplicationMode` mode **)** | - +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`property_set_spawn` **(** :ref:`NodePath` path, :ref:`bool` enabled **)** | - +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`property_set_sync` **(** :ref:`NodePath` path, :ref:`bool` enabled **)** | - +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`property_set_watch` **(** :ref:`NodePath` path, :ref:`bool` enabled **)** | - +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_property` **(** :ref:`NodePath` path **)** | - +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_property`\ (\ path\: :ref:`NodePath`, index\: :ref:`int` = -1\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`NodePath`\] | :ref:`get_properties`\ (\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_property`\ (\ path\: :ref:`NodePath`\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`property_get_index`\ (\ path\: :ref:`NodePath`\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ReplicationMode` | :ref:`property_get_replication_mode`\ (\ path\: :ref:`NodePath`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`property_get_spawn`\ (\ path\: :ref:`NodePath`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`property_get_sync`\ (\ path\: :ref:`NodePath`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`property_get_watch`\ (\ path\: :ref:`NodePath`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`property_set_replication_mode`\ (\ path\: :ref:`NodePath`, mode\: :ref:`ReplicationMode`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`property_set_spawn`\ (\ path\: :ref:`NodePath`, enabled\: :ref:`bool`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`property_set_sync`\ (\ path\: :ref:`NodePath`, enabled\: :ref:`bool`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`property_set_watch`\ (\ path\: :ref:`NodePath`, enabled\: :ref:`bool`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_property`\ (\ path\: :ref:`NodePath`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -102,7 +102,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_property** **(** :ref:`NodePath` path, :ref:`int` index=-1 **)** +|void| **add_property**\ (\ path\: :ref:`NodePath`, index\: :ref:`int` = -1\ ) Adds the property identified by the given ``path`` to the list of the properties being synchronized, optionally passing an ``index``. @@ -116,7 +116,7 @@ Adds the property identified by the given ``path`` to the list of the properties .. rst-class:: classref-method -:ref:`NodePath[]` **get_properties** **(** **)** |const| +:ref:`Array`\[:ref:`NodePath`\] **get_properties**\ (\ ) |const| Returns a list of synchronized property :ref:`NodePath`\ s. @@ -128,9 +128,9 @@ Returns a list of synchronized property :ref:`NodePath`\ s. .. rst-class:: classref-method -:ref:`bool` **has_property** **(** :ref:`NodePath` path **)** |const| +:ref:`bool` **has_property**\ (\ path\: :ref:`NodePath`\ ) |const| -Returns whether the given ``path`` is configured for synchronization. +Returns ``true`` if the given ``path`` is configured for synchronization. .. rst-class:: classref-item-separator @@ -140,7 +140,7 @@ Returns whether the given ``path`` is configured for synchronization. .. rst-class:: classref-method -:ref:`int` **property_get_index** **(** :ref:`NodePath` path **)** |const| +:ref:`int` **property_get_index**\ (\ path\: :ref:`NodePath`\ ) |const| Finds the index of the given ``path``. @@ -152,7 +152,7 @@ Finds the index of the given ``path``. .. rst-class:: classref-method -:ref:`ReplicationMode` **property_get_replication_mode** **(** :ref:`NodePath` path **)** +:ref:`ReplicationMode` **property_get_replication_mode**\ (\ path\: :ref:`NodePath`\ ) Returns the replication mode for the property identified by the given ``path``. See :ref:`ReplicationMode`. @@ -164,9 +164,9 @@ Returns the replication mode for the property identified by the given ``path``. .. rst-class:: classref-method -:ref:`bool` **property_get_spawn** **(** :ref:`NodePath` path **)** +:ref:`bool` **property_get_spawn**\ (\ path\: :ref:`NodePath`\ ) -Returns whether the property identified by the given ``path`` is configured to be synchronized on spawn. +Returns ``true`` if the property identified by the given ``path`` is configured to be synchronized on spawn. .. rst-class:: classref-item-separator @@ -176,11 +176,11 @@ Returns whether the property identified by the given ``path`` is configured to b .. rst-class:: classref-method -:ref:`bool` **property_get_sync** **(** :ref:`NodePath` path **)** +:ref:`bool` **property_get_sync**\ (\ path\: :ref:`NodePath`\ ) **Deprecated:** Use :ref:`property_get_replication_mode` instead. -Returns whether the property identified by the given ``path`` is configured to be synchronized on process. +Returns ``true`` if the property identified by the given ``path`` is configured to be synchronized on process. .. rst-class:: classref-item-separator @@ -190,11 +190,11 @@ Returns whether the property identified by the given ``path`` is configured to b .. rst-class:: classref-method -:ref:`bool` **property_get_watch** **(** :ref:`NodePath` path **)** +:ref:`bool` **property_get_watch**\ (\ path\: :ref:`NodePath`\ ) **Deprecated:** Use :ref:`property_get_replication_mode` instead. -Returns whether the property identified by the given ``path`` is configured to be reliably synchronized when changes are detected on process. +Returns ``true`` if the property identified by the given ``path`` is configured to be reliably synchronized when changes are detected on process. .. rst-class:: classref-item-separator @@ -204,7 +204,7 @@ Returns whether the property identified by the given ``path`` is configured to b .. rst-class:: classref-method -void **property_set_replication_mode** **(** :ref:`NodePath` path, :ref:`ReplicationMode` mode **)** +|void| **property_set_replication_mode**\ (\ path\: :ref:`NodePath`, mode\: :ref:`ReplicationMode`\ ) Sets the synchronization mode for the property identified by the given ``path``. See :ref:`ReplicationMode`. @@ -216,7 +216,7 @@ Sets the synchronization mode for the property identified by the given ``path``. .. rst-class:: classref-method -void **property_set_spawn** **(** :ref:`NodePath` path, :ref:`bool` enabled **)** +|void| **property_set_spawn**\ (\ path\: :ref:`NodePath`, enabled\: :ref:`bool`\ ) Sets whether the property identified by the given ``path`` is configured to be synchronized on spawn. @@ -228,7 +228,7 @@ Sets whether the property identified by the given ``path`` is configured to be s .. rst-class:: classref-method -void **property_set_sync** **(** :ref:`NodePath` path, :ref:`bool` enabled **)** +|void| **property_set_sync**\ (\ path\: :ref:`NodePath`, enabled\: :ref:`bool`\ ) **Deprecated:** Use :ref:`property_set_replication_mode` with :ref:`REPLICATION_MODE_ALWAYS` instead. @@ -242,7 +242,7 @@ Sets whether the property identified by the given ``path`` is configured to be s .. rst-class:: classref-method -void **property_set_watch** **(** :ref:`NodePath` path, :ref:`bool` enabled **)** +|void| **property_set_watch**\ (\ path\: :ref:`NodePath`, enabled\: :ref:`bool`\ ) **Deprecated:** Use :ref:`property_set_replication_mode` with :ref:`REPLICATION_MODE_ON_CHANGE` instead. @@ -256,7 +256,7 @@ Sets whether the property identified by the given ``path`` is configured to be r .. rst-class:: classref-method -void **remove_property** **(** :ref:`NodePath` path **)** +|void| **remove_property**\ (\ path\: :ref:`NodePath`\ ) Removes the property identified by the given ``path`` from the configuration. @@ -267,3 +267,4 @@ Removes the property identified by the given ``path`` from the configuration. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index ca2aa962285..2129af69218 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -31,49 +31,49 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_connection_binds` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_connection_count` **(** **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_connection_flags` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_connection_method` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_connection_signal` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_connection_source` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_connection_target` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_connection_unbinds` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_node_count` **(** **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_node_groups` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_node_index` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedScene` | :ref:`get_node_instance` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_node_instance_placeholder` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_node_name` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_node_owner_path` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_node_path` **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_node_property_count` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_node_property_name` **(** :ref:`int` idx, :ref:`int` prop_idx **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_node_property_value` **(** :ref:`int` idx, :ref:`int` prop_idx **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_node_type` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_node_instance_placeholder` **(** :ref:`int` idx **)** |const| | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_connection_binds`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_connection_count`\ (\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_connection_flags`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_connection_method`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_connection_signal`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_connection_source`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_connection_target`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_connection_unbinds`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_node_count`\ (\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_node_groups`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_node_index`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedScene` | :ref:`get_node_instance`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_node_instance_placeholder`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_node_name`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_node_owner_path`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_node_path`\ (\ idx\: :ref:`int`, for_parent\: :ref:`bool` = false\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_node_property_count`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_node_property_name`\ (\ idx\: :ref:`int`, prop_idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_node_property_value`\ (\ idx\: :ref:`int`, prop_idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_node_type`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_node_instance_placeholder`\ (\ idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -141,7 +141,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array` **get_connection_binds** **(** :ref:`int` idx **)** |const| +:ref:`Array` **get_connection_binds**\ (\ idx\: :ref:`int`\ ) |const| Returns the list of bound parameters for the signal at ``idx``. @@ -153,7 +153,7 @@ Returns the list of bound parameters for the signal at ``idx``. .. rst-class:: classref-method -:ref:`int` **get_connection_count** **(** **)** |const| +:ref:`int` **get_connection_count**\ (\ ) |const| Returns the number of signal connections in the scene. @@ -167,7 +167,7 @@ The ``idx`` argument used to query connection metadata in other ``get_connection .. rst-class:: classref-method -:ref:`int` **get_connection_flags** **(** :ref:`int` idx **)** |const| +:ref:`int` **get_connection_flags**\ (\ idx\: :ref:`int`\ ) |const| Returns the connection flags for the signal at ``idx``. See :ref:`ConnectFlags` constants. @@ -179,7 +179,7 @@ Returns the connection flags for the signal at ``idx``. See :ref:`ConnectFlags` **get_connection_method** **(** :ref:`int` idx **)** |const| +:ref:`StringName` **get_connection_method**\ (\ idx\: :ref:`int`\ ) |const| Returns the method connected to the signal at ``idx``. @@ -191,7 +191,7 @@ Returns the method connected to the signal at ``idx``. .. rst-class:: classref-method -:ref:`StringName` **get_connection_signal** **(** :ref:`int` idx **)** |const| +:ref:`StringName` **get_connection_signal**\ (\ idx\: :ref:`int`\ ) |const| Returns the name of the signal at ``idx``. @@ -203,7 +203,7 @@ Returns the name of the signal at ``idx``. .. rst-class:: classref-method -:ref:`NodePath` **get_connection_source** **(** :ref:`int` idx **)** |const| +:ref:`NodePath` **get_connection_source**\ (\ idx\: :ref:`int`\ ) |const| Returns the path to the node that owns the signal at ``idx``, relative to the root node. @@ -215,7 +215,7 @@ Returns the path to the node that owns the signal at ``idx``, relative to the ro .. rst-class:: classref-method -:ref:`NodePath` **get_connection_target** **(** :ref:`int` idx **)** |const| +:ref:`NodePath` **get_connection_target**\ (\ idx\: :ref:`int`\ ) |const| Returns the path to the node that owns the method connected to the signal at ``idx``, relative to the root node. @@ -227,7 +227,7 @@ Returns the path to the node that owns the method connected to the signal at ``i .. rst-class:: classref-method -:ref:`int` **get_connection_unbinds** **(** :ref:`int` idx **)** |const| +:ref:`int` **get_connection_unbinds**\ (\ idx\: :ref:`int`\ ) |const| Returns the number of unbound parameters for the signal at ``idx``. @@ -239,7 +239,7 @@ Returns the number of unbound parameters for the signal at ``idx``. .. rst-class:: classref-method -:ref:`int` **get_node_count** **(** **)** |const| +:ref:`int` **get_node_count**\ (\ ) |const| Returns the number of nodes in the scene. @@ -253,7 +253,7 @@ The ``idx`` argument used to query node data in other ``get_node_*`` methods in .. rst-class:: classref-method -:ref:`PackedStringArray` **get_node_groups** **(** :ref:`int` idx **)** |const| +:ref:`PackedStringArray` **get_node_groups**\ (\ idx\: :ref:`int`\ ) |const| Returns the list of group names associated with the node at ``idx``. @@ -265,7 +265,7 @@ Returns the list of group names associated with the node at ``idx``. .. rst-class:: classref-method -:ref:`int` **get_node_index** **(** :ref:`int` idx **)** |const| +:ref:`int` **get_node_index**\ (\ idx\: :ref:`int`\ ) |const| Returns the node's index, which is its position relative to its siblings. This is only relevant and saved in scenes for cases where new nodes are added to an instantiated or inherited scene among siblings from the base scene. Despite the name, this index is not related to the ``idx`` argument used here and in other methods. @@ -277,7 +277,7 @@ Returns the node's index, which is its position relative to its siblings. This i .. rst-class:: classref-method -:ref:`PackedScene` **get_node_instance** **(** :ref:`int` idx **)** |const| +:ref:`PackedScene` **get_node_instance**\ (\ idx\: :ref:`int`\ ) |const| Returns a :ref:`PackedScene` for the node at ``idx`` (i.e. the whole branch starting at this node, with its child nodes and resources), or ``null`` if the node is not an instance. @@ -289,7 +289,7 @@ Returns a :ref:`PackedScene` for the node at ``idx`` (i.e. th .. rst-class:: classref-method -:ref:`String` **get_node_instance_placeholder** **(** :ref:`int` idx **)** |const| +:ref:`String` **get_node_instance_placeholder**\ (\ idx\: :ref:`int`\ ) |const| Returns the path to the represented scene file if the node at ``idx`` is an :ref:`InstancePlaceholder`. @@ -301,7 +301,7 @@ Returns the path to the represented scene file if the node at ``idx`` is an :ref .. rst-class:: classref-method -:ref:`StringName` **get_node_name** **(** :ref:`int` idx **)** |const| +:ref:`StringName` **get_node_name**\ (\ idx\: :ref:`int`\ ) |const| Returns the name of the node at ``idx``. @@ -313,7 +313,7 @@ Returns the name of the node at ``idx``. .. rst-class:: classref-method -:ref:`NodePath` **get_node_owner_path** **(** :ref:`int` idx **)** |const| +:ref:`NodePath` **get_node_owner_path**\ (\ idx\: :ref:`int`\ ) |const| Returns the path to the owner of the node at ``idx``, relative to the root node. @@ -325,7 +325,7 @@ Returns the path to the owner of the node at ``idx``, relative to the root node. .. rst-class:: classref-method -:ref:`NodePath` **get_node_path** **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** |const| +:ref:`NodePath` **get_node_path**\ (\ idx\: :ref:`int`, for_parent\: :ref:`bool` = false\ ) |const| Returns the path to the node at ``idx``. @@ -339,7 +339,7 @@ If ``for_parent`` is ``true``, returns the path of the ``idx`` node's parent ins .. rst-class:: classref-method -:ref:`int` **get_node_property_count** **(** :ref:`int` idx **)** |const| +:ref:`int` **get_node_property_count**\ (\ idx\: :ref:`int`\ ) |const| Returns the number of exported or overridden properties for the node at ``idx``. @@ -353,7 +353,7 @@ The ``prop_idx`` argument used to query node property data in other ``get_node_p .. rst-class:: classref-method -:ref:`StringName` **get_node_property_name** **(** :ref:`int` idx, :ref:`int` prop_idx **)** |const| +:ref:`StringName` **get_node_property_name**\ (\ idx\: :ref:`int`, prop_idx\: :ref:`int`\ ) |const| Returns the name of the property at ``prop_idx`` for the node at ``idx``. @@ -365,7 +365,7 @@ Returns the name of the property at ``prop_idx`` for the node at ``idx``. .. rst-class:: classref-method -:ref:`Variant` **get_node_property_value** **(** :ref:`int` idx, :ref:`int` prop_idx **)** |const| +:ref:`Variant` **get_node_property_value**\ (\ idx\: :ref:`int`, prop_idx\: :ref:`int`\ ) |const| Returns the value of the property at ``prop_idx`` for the node at ``idx``. @@ -377,7 +377,7 @@ Returns the value of the property at ``prop_idx`` for the node at ``idx``. .. rst-class:: classref-method -:ref:`StringName` **get_node_type** **(** :ref:`int` idx **)** |const| +:ref:`StringName` **get_node_type**\ (\ idx\: :ref:`int`\ ) |const| Returns the type of the node at ``idx``. @@ -389,7 +389,7 @@ Returns the type of the node at ``idx``. .. rst-class:: classref-method -:ref:`bool` **is_node_instance_placeholder** **(** :ref:`int` idx **)** |const| +:ref:`bool` **is_node_instance_placeholder**\ (\ idx\: :ref:`int`\ ) |const| Returns ``true`` if the node at ``idx`` is an :ref:`InstancePlaceholder`. @@ -400,3 +400,4 @@ Returns ``true`` if the node at ``idx`` is an :ref:`InstancePlaceholder` **(** :ref:`StringName` group, :ref:`StringName` method, ... **)** |vararg| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`call_group_flags` **(** :ref:`int` flags, :ref:`StringName` group, :ref:`StringName` method, ... **)** |vararg| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`change_scene_to_file` **(** :ref:`String` path **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`change_scene_to_packed` **(** :ref:`PackedScene` packed_scene **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec, :ref:`bool` process_always=true, :ref:`bool` process_in_physics=false, :ref:`bool` ignore_time_scale=false **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Tween` | :ref:`create_tween` **(** **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`get_first_node_in_group` **(** :ref:`StringName` group **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_frame` **(** **)** |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`MultiplayerAPI` | :ref:`get_multiplayer` **(** :ref:`NodePath` for_path=NodePath("") **)** |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_node_count` **(** **)** |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_node_count_in_group` **(** :ref:`StringName` group **)** |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node[]` | :ref:`get_nodes_in_group` **(** :ref:`StringName` group **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Tween[]` | :ref:`get_processed_tweens` **(** **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_group` **(** :ref:`StringName` name **)** |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`notify_group` **(** :ref:`StringName` group, :ref:`int` notification **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`notify_group_flags` **(** :ref:`int` call_flags, :ref:`StringName` group, :ref:`int` notification **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`queue_delete` **(** :ref:`Object` obj **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`quit` **(** :ref:`int` exit_code=0 **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`reload_current_scene` **(** **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_group` **(** :ref:`StringName` group, :ref:`String` property, :ref:`Variant` value **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_group_flags` **(** :ref:`int` call_flags, :ref:`StringName` group, :ref:`String` property, :ref:`Variant` value **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_multiplayer` **(** :ref:`MultiplayerAPI` multiplayer, :ref:`NodePath` root_path=NodePath("") **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`unload_current_scene` **(** **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`call_group`\ (\ group\: :ref:`StringName`, method\: :ref:`StringName`, ...\ ) |vararg| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`call_group_flags`\ (\ flags\: :ref:`int`, group\: :ref:`StringName`, method\: :ref:`StringName`, ...\ ) |vararg| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`change_scene_to_file`\ (\ path\: :ref:`String`\ ) | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`change_scene_to_packed`\ (\ packed_scene\: :ref:`PackedScene`\ ) | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SceneTreeTimer` | :ref:`create_timer`\ (\ time_sec\: :ref:`float`, process_always\: :ref:`bool` = true, process_in_physics\: :ref:`bool` = false, ignore_time_scale\: :ref:`bool` = false\ ) | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Tween` | :ref:`create_tween`\ (\ ) | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`get_first_node_in_group`\ (\ group\: :ref:`StringName`\ ) | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_frame`\ (\ ) |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`MultiplayerAPI` | :ref:`get_multiplayer`\ (\ for_path\: :ref:`NodePath` = NodePath("")\ ) |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_node_count`\ (\ ) |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_node_count_in_group`\ (\ group\: :ref:`StringName`\ ) |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Node`\] | :ref:`get_nodes_in_group`\ (\ group\: :ref:`StringName`\ ) | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Tween`\] | :ref:`get_processed_tweens`\ (\ ) | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_group`\ (\ name\: :ref:`StringName`\ ) |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`notify_group`\ (\ group\: :ref:`StringName`, notification\: :ref:`int`\ ) | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`notify_group_flags`\ (\ call_flags\: :ref:`int`, group\: :ref:`StringName`, notification\: :ref:`int`\ ) | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`queue_delete`\ (\ obj\: :ref:`Object`\ ) | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`quit`\ (\ exit_code\: :ref:`int` = 0\ ) | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`reload_current_scene`\ (\ ) | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_group`\ (\ group\: :ref:`StringName`, property\: :ref:`String`, value\: :ref:`Variant`\ ) | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_group_flags`\ (\ call_flags\: :ref:`int`, group\: :ref:`StringName`, property\: :ref:`String`, value\: :ref:`Variant`\ ) | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_multiplayer`\ (\ multiplayer\: :ref:`MultiplayerAPI`, root_path\: :ref:`NodePath` = NodePath("")\ ) | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unload_current_scene`\ (\ ) | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -133,7 +133,7 @@ Signals .. rst-class:: classref-signal -**node_added** **(** :ref:`Node` node **)** +**node_added**\ (\ node\: :ref:`Node`\ ) Emitted whenever a node is added to the **SceneTree**. @@ -145,7 +145,7 @@ Emitted whenever a node is added to the **SceneTree**. .. rst-class:: classref-signal -**node_configuration_warning_changed** **(** :ref:`Node` node **)** +**node_configuration_warning_changed**\ (\ node\: :ref:`Node`\ ) Emitted when a node's configuration changed. Only emitted in ``tool`` mode. @@ -157,7 +157,7 @@ Emitted when a node's configuration changed. Only emitted in ``tool`` mode. .. rst-class:: classref-signal -**node_removed** **(** :ref:`Node` node **)** +**node_removed**\ (\ node\: :ref:`Node`\ ) Emitted whenever a node is removed from the **SceneTree**. @@ -169,7 +169,7 @@ Emitted whenever a node is removed from the **SceneTree**. .. rst-class:: classref-signal -**node_renamed** **(** :ref:`Node` node **)** +**node_renamed**\ (\ node\: :ref:`Node`\ ) Emitted whenever a node is renamed. @@ -181,7 +181,7 @@ Emitted whenever a node is renamed. .. rst-class:: classref-signal -**physics_frame** **(** **)** +**physics_frame**\ (\ ) Emitted immediately before :ref:`Node._physics_process` is called on every node in the **SceneTree**. @@ -193,7 +193,7 @@ Emitted immediately before :ref:`Node._physics_process` is called on every node in the **SceneTree**. @@ -205,7 +205,7 @@ Emitted immediately before :ref:`Node._process` is changed. @@ -287,8 +287,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_auto_accept_quit** **(** :ref:`bool` value **)** -- :ref:`bool` **is_auto_accept_quit** **(** **)** +- |void| **set_auto_accept_quit**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_auto_accept_quit**\ (\ ) If ``true``, the application automatically accepts quitting requests. @@ -306,8 +306,8 @@ For mobile platforms, see :ref:`quit_on_go_back` value **)** -- :ref:`Node` **get_current_scene** **(** **)** +- |void| **set_current_scene**\ (\ value\: :ref:`Node`\ ) +- :ref:`Node` **get_current_scene**\ (\ ) Returns the root node of the currently running scene, regardless of its structure. @@ -325,8 +325,8 @@ Returns the root node of the currently running scene, regardless of its structur .. rst-class:: classref-property-setget -- void **set_debug_collisions_hint** **(** :ref:`bool` value **)** -- :ref:`bool` **is_debugging_collisions_hint** **(** **)** +- |void| **set_debug_collisions_hint**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_debugging_collisions_hint**\ (\ ) If ``true``, collision shapes will be visible when running the game from the editor for debugging purposes. @@ -344,8 +344,8 @@ If ``true``, collision shapes will be visible when running the game from the edi .. rst-class:: classref-property-setget -- void **set_debug_navigation_hint** **(** :ref:`bool` value **)** -- :ref:`bool` **is_debugging_navigation_hint** **(** **)** +- |void| **set_debug_navigation_hint**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_debugging_navigation_hint**\ (\ ) If ``true``, navigation polygons will be visible when running the game from the editor for debugging purposes. @@ -363,8 +363,8 @@ If ``true``, navigation polygons will be visible when running the game from the .. rst-class:: classref-property-setget -- void **set_debug_paths_hint** **(** :ref:`bool` value **)** -- :ref:`bool` **is_debugging_paths_hint** **(** **)** +- |void| **set_debug_paths_hint**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_debugging_paths_hint**\ (\ ) If ``true``, curves from :ref:`Path2D` and :ref:`Path3D` nodes will be visible when running the game from the editor for debugging purposes. @@ -382,8 +382,8 @@ If ``true``, curves from :ref:`Path2D` and :ref:`Path3D` value **)** -- :ref:`Node` **get_edited_scene_root** **(** **)** +- |void| **set_edited_scene_root**\ (\ value\: :ref:`Node`\ ) +- :ref:`Node` **get_edited_scene_root**\ (\ ) The root of the edited scene. @@ -399,8 +399,8 @@ The root of the edited scene. .. rst-class:: classref-property-setget -- void **set_multiplayer_poll_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_multiplayer_poll_enabled** **(** **)** +- |void| **set_multiplayer_poll_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_multiplayer_poll_enabled**\ (\ ) If ``true`` (default value), enables automatic polling of the :ref:`MultiplayerAPI` for this SceneTree during :ref:`process_frame`. @@ -418,8 +418,8 @@ If ``false``, you need to manually call :ref:`MultiplayerAPI.poll` value **)** -- :ref:`bool` **is_paused** **(** **)** +- |void| **set_pause**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_paused**\ (\ ) If ``true``, the **SceneTree** is paused. Doing so will have the following behavior: @@ -439,8 +439,8 @@ If ``true``, the **SceneTree** is paused. Doing so will have the following behav .. rst-class:: classref-property-setget -- void **set_quit_on_go_back** **(** :ref:`bool` value **)** -- :ref:`bool` **is_quit_on_go_back** **(** **)** +- |void| **set_quit_on_go_back**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_quit_on_go_back**\ (\ ) If ``true``, the application quits automatically when navigating back (e.g. using the system "Back" button on Android). @@ -458,7 +458,7 @@ To handle 'Go Back' button when this option is disabled, use :ref:`DisplayServer .. rst-class:: classref-property-setget -- :ref:`Window` **get_root** **(** **)** +- :ref:`Window` **get_root**\ (\ ) The **SceneTree**'s root :ref:`Window`. @@ -475,7 +475,7 @@ Method Descriptions .. rst-class:: classref-method -void **call_group** **(** :ref:`StringName` group, :ref:`StringName` method, ... **)** |vararg| +|void| **call_group**\ (\ group\: :ref:`StringName`, method\: :ref:`StringName`, ...\ ) |vararg| Calls ``method`` on each member of the given group. You can pass arguments to ``method`` by specifying them at the end of the method call. If a node doesn't have the given method or the argument list does not match (either in count or in types), it will be skipped. @@ -489,7 +489,7 @@ Calls ``method`` on each member of the given group. You can pass arguments to `` .. rst-class:: classref-method -void **call_group_flags** **(** :ref:`int` flags, :ref:`StringName` group, :ref:`StringName` method, ... **)** |vararg| +|void| **call_group_flags**\ (\ flags\: :ref:`int`, group\: :ref:`StringName`, method\: :ref:`StringName`, ...\ ) |vararg| Calls ``method`` on each member of the given group, respecting the given :ref:`GroupCallFlags`. You can pass arguments to ``method`` by specifying them at the end of the method call. If a node doesn't have the given method or the argument list does not match (either in count or in types), it will be skipped. @@ -508,7 +508,7 @@ Calls ``method`` on each member of the given group, respecting the given :ref:`G .. rst-class:: classref-method -:ref:`Error` **change_scene_to_file** **(** :ref:`String` path **)** +:ref:`Error` **change_scene_to_file**\ (\ path\: :ref:`String`\ ) Changes the running scene to the one at the given ``path``, after loading it into a :ref:`PackedScene` and creating a new instance. @@ -524,7 +524,7 @@ Returns :ref:`@GlobalScope.OK` on success, :ref: .. rst-class:: classref-method -:ref:`Error` **change_scene_to_packed** **(** :ref:`PackedScene` packed_scene **)** +:ref:`Error` **change_scene_to_packed**\ (\ packed_scene\: :ref:`PackedScene`\ ) Changes the running scene to a new instance of the given :ref:`PackedScene` (which must be valid). @@ -546,7 +546,7 @@ This ensures that both scenes aren't running at the same time, while still freei .. rst-class:: classref-method -:ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec, :ref:`bool` process_always=true, :ref:`bool` process_in_physics=false, :ref:`bool` ignore_time_scale=false **)** +:ref:`SceneTreeTimer` **create_timer**\ (\ time_sec\: :ref:`float`, process_always\: :ref:`bool` = true, process_in_physics\: :ref:`bool` = false, ignore_time_scale\: :ref:`bool` = false\ ) Returns a :ref:`SceneTreeTimer` which will emit :ref:`SceneTreeTimer.timeout` after the given time in seconds elapsed in this **SceneTree**. @@ -591,7 +591,7 @@ The timer will be automatically freed after its time elapses. .. rst-class:: classref-method -:ref:`Tween` **create_tween** **(** **)** +:ref:`Tween` **create_tween**\ (\ ) Creates and returns a new :ref:`Tween`. The Tween will start automatically on the next process frame or physics frame (depending on :ref:`TweenProcessMode`). @@ -605,7 +605,7 @@ Creates and returns a new :ref:`Tween`. The Tween will start automa .. rst-class:: classref-method -:ref:`Node` **get_first_node_in_group** **(** :ref:`StringName` group **)** +:ref:`Node` **get_first_node_in_group**\ (\ group\: :ref:`StringName`\ ) Returns the first node in the specified group, or ``null`` if the group is empty or does not exist. @@ -617,7 +617,7 @@ Returns the first node in the specified group, or ``null`` if the group is empty .. rst-class:: classref-method -:ref:`int` **get_frame** **(** **)** |const| +:ref:`int` **get_frame**\ (\ ) |const| Returns the current frame number, i.e. the total frame count since the application started. @@ -629,7 +629,7 @@ Returns the current frame number, i.e. the total frame count since the applicati .. rst-class:: classref-method -:ref:`MultiplayerAPI` **get_multiplayer** **(** :ref:`NodePath` for_path=NodePath("") **)** |const| +:ref:`MultiplayerAPI` **get_multiplayer**\ (\ for_path\: :ref:`NodePath` = NodePath("")\ ) |const| Searches for the :ref:`MultiplayerAPI` configured for the given path, if one does not exist it searches the parent paths until one is found. If the path is empty, or none is found, the default one is returned. See :ref:`set_multiplayer`. @@ -641,7 +641,7 @@ Searches for the :ref:`MultiplayerAPI` configured for the .. rst-class:: classref-method -:ref:`int` **get_node_count** **(** **)** |const| +:ref:`int` **get_node_count**\ (\ ) |const| Returns the number of nodes in this **SceneTree**. @@ -653,7 +653,7 @@ Returns the number of nodes in this **SceneTree**. .. rst-class:: classref-method -:ref:`int` **get_node_count_in_group** **(** :ref:`StringName` group **)** |const| +:ref:`int` **get_node_count_in_group**\ (\ group\: :ref:`StringName`\ ) |const| Returns the number of nodes assigned to the given group. @@ -665,7 +665,7 @@ Returns the number of nodes assigned to the given group. .. rst-class:: classref-method -:ref:`Node[]` **get_nodes_in_group** **(** :ref:`StringName` group **)** +:ref:`Array`\[:ref:`Node`\] **get_nodes_in_group**\ (\ group\: :ref:`StringName`\ ) Returns a list of all nodes assigned to the given group. @@ -677,7 +677,7 @@ Returns a list of all nodes assigned to the given group. .. rst-class:: classref-method -:ref:`Tween[]` **get_processed_tweens** **(** **)** +:ref:`Array`\[:ref:`Tween`\] **get_processed_tweens**\ (\ ) Returns an array of currently existing :ref:`Tween`\ s in the **SceneTree** (both running and paused). @@ -689,7 +689,7 @@ Returns an array of currently existing :ref:`Tween`\ s in the **Sce .. rst-class:: classref-method -:ref:`bool` **has_group** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_group**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if the given group exists. @@ -703,7 +703,7 @@ A group exists if any :ref:`Node` in the tree belongs to it (see :re .. rst-class:: classref-method -void **notify_group** **(** :ref:`StringName` group, :ref:`int` notification **)** +|void| **notify_group**\ (\ group\: :ref:`StringName`, notification\: :ref:`int`\ ) Sends the given notification to all members of the ``group``. @@ -717,7 +717,7 @@ Sends the given notification to all members of the ``group``. .. rst-class:: classref-method -void **notify_group_flags** **(** :ref:`int` call_flags, :ref:`StringName` group, :ref:`int` notification **)** +|void| **notify_group_flags**\ (\ call_flags\: :ref:`int`, group\: :ref:`StringName`, notification\: :ref:`int`\ ) Sends the given notification to all members of the ``group``, respecting the given :ref:`GroupCallFlags`. @@ -731,7 +731,7 @@ Sends the given notification to all members of the ``group``, respecting the giv .. rst-class:: classref-method -void **queue_delete** **(** :ref:`Object` obj **)** +|void| **queue_delete**\ (\ obj\: :ref:`Object`\ ) Queues the given object for deletion, delaying the call to :ref:`Object.free` to the end of the current frame. @@ -743,7 +743,7 @@ Queues the given object for deletion, delaying the call to :ref:`Object.free` exit_code=0 **)** +|void| **quit**\ (\ exit_code\: :ref:`int` = 0\ ) Quits the application at the end of the current iteration. Argument ``exit_code`` can optionally be given (defaulting to 0) to customize the exit status code. @@ -761,7 +761,7 @@ For portability reasons, the exit code should be set between 0 and 125 (inclusiv .. rst-class:: classref-method -:ref:`Error` **reload_current_scene** **(** **)** +:ref:`Error` **reload_current_scene**\ (\ ) Reloads the currently active scene. @@ -775,7 +775,7 @@ Returns :ref:`@GlobalScope.OK` on success, :ref: .. rst-class:: classref-method -void **set_group** **(** :ref:`StringName` group, :ref:`String` property, :ref:`Variant` value **)** +|void| **set_group**\ (\ group\: :ref:`StringName`, property\: :ref:`String`, value\: :ref:`Variant`\ ) Sets the given ``property`` to ``value`` on all members of the given group. @@ -789,7 +789,7 @@ Sets the given ``property`` to ``value`` on all members of the given group. .. rst-class:: classref-method -void **set_group_flags** **(** :ref:`int` call_flags, :ref:`StringName` group, :ref:`String` property, :ref:`Variant` value **)** +|void| **set_group_flags**\ (\ call_flags\: :ref:`int`, group\: :ref:`StringName`, property\: :ref:`String`, value\: :ref:`Variant`\ ) Sets the given ``property`` to ``value`` on all members of the given group, respecting the given :ref:`GroupCallFlags`. @@ -803,7 +803,7 @@ Sets the given ``property`` to ``value`` on all members of the given group, resp .. rst-class:: classref-method -void **set_multiplayer** **(** :ref:`MultiplayerAPI` multiplayer, :ref:`NodePath` root_path=NodePath("") **)** +|void| **set_multiplayer**\ (\ multiplayer\: :ref:`MultiplayerAPI`, root_path\: :ref:`NodePath` = NodePath("")\ ) Sets a custom :ref:`MultiplayerAPI` with the given ``root_path`` (controlling also the relative subpaths), or override the default one if ``root_path`` is empty. @@ -817,7 +817,7 @@ Sets a custom :ref:`MultiplayerAPI` with the given ``root_ .. rst-class:: classref-method -void **unload_current_scene** **(** **)** +|void| **unload_current_scene**\ (\ ) If a current scene is loaded, calling this method will unload it. @@ -828,3 +828,4 @@ If a current scene is loaded, calling this method will unload it. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_scenetreetimer.rst b/classes/class_scenetreetimer.rst index 714386c5e6e..66bb1366387 100644 --- a/classes/class_scenetreetimer.rst +++ b/classes/class_scenetreetimer.rst @@ -73,7 +73,7 @@ Signals .. rst-class:: classref-signal -**timeout** **(** **)** +**timeout**\ (\ ) Emitted when the timer reaches 0. @@ -94,8 +94,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_time_left** **(** :ref:`float` value **)** -- :ref:`float` **get_time_left** **(** **)** +- |void| **set_time_left**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_time_left**\ (\ ) The time remaining (in seconds). @@ -106,3 +106,4 @@ The time remaining (in seconds). .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_script.rst b/classes/class_script.rst index 06b399e7515..e6ce12aa4ca 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -54,37 +54,37 @@ Methods .. table:: :widths: auto - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`can_instantiate` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Script` | :ref:`get_base_script` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_global_name` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_instance_base_type` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_property_default_value` **(** :ref:`StringName` property **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_script_constant_map` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`get_script_method_list` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`get_script_property_list` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`get_script_signal_list` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_script_signal` **(** :ref:`StringName` signal_name **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_source_code` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`instance_has` **(** :ref:`Object` base_object **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_abstract` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_tool` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`reload` **(** :ref:`bool` keep_state=false **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`can_instantiate`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Script` | :ref:`get_base_script`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_global_name`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_instance_base_type`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_property_default_value`\ (\ property\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_script_constant_map`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_script_method_list`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_script_property_list`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_script_signal_list`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_script_signal`\ (\ signal_name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_source_code`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`instance_has`\ (\ base_object\: :ref:`Object`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_abstract`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_tool`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`reload`\ (\ keep_state\: :ref:`bool` = false\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -103,8 +103,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_source_code** **(** :ref:`String` value **)** -- :ref:`String` **get_source_code** **(** **)** +- |void| **set_source_code**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_source_code**\ (\ ) The script source code or an empty string if source code is not available. When set, does not reload the class implementation automatically. @@ -121,7 +121,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **can_instantiate** **(** **)** |const| +:ref:`bool` **can_instantiate**\ (\ ) |const| Returns ``true`` if the script can be instantiated. @@ -133,7 +133,7 @@ Returns ``true`` if the script can be instantiated. .. rst-class:: classref-method -:ref:`Script` **get_base_script** **(** **)** |const| +:ref:`Script` **get_base_script**\ (\ ) |const| Returns the script directly inherited by this script. @@ -145,7 +145,7 @@ Returns the script directly inherited by this script. .. rst-class:: classref-method -:ref:`StringName` **get_global_name** **(** **)** |const| +:ref:`StringName` **get_global_name**\ (\ ) |const| Returns the class name associated with the script, if there is one. Returns an empty string otherwise. @@ -178,7 +178,7 @@ To give the script a global name, you can use the ``class_name`` keyword in GDSc .. rst-class:: classref-method -:ref:`StringName` **get_instance_base_type** **(** **)** |const| +:ref:`StringName` **get_instance_base_type**\ (\ ) |const| Returns the script's base type. @@ -190,7 +190,7 @@ Returns the script's base type. .. rst-class:: classref-method -:ref:`Variant` **get_property_default_value** **(** :ref:`StringName` property **)** +:ref:`Variant` **get_property_default_value**\ (\ property\: :ref:`StringName`\ ) Returns the default value of the specified property. @@ -202,7 +202,7 @@ Returns the default value of the specified property. .. rst-class:: classref-method -:ref:`Dictionary` **get_script_constant_map** **(** **)** +:ref:`Dictionary` **get_script_constant_map**\ (\ ) Returns a dictionary containing constant names and their values. @@ -214,7 +214,7 @@ Returns a dictionary containing constant names and their values. .. rst-class:: classref-method -:ref:`Dictionary[]` **get_script_method_list** **(** **)** +:ref:`Array`\[:ref:`Dictionary`\] **get_script_method_list**\ (\ ) Returns the list of methods in this **Script**. @@ -226,7 +226,7 @@ Returns the list of methods in this **Script**. .. rst-class:: classref-method -:ref:`Dictionary[]` **get_script_property_list** **(** **)** +:ref:`Array`\[:ref:`Dictionary`\] **get_script_property_list**\ (\ ) Returns the list of properties in this **Script**. @@ -238,7 +238,7 @@ Returns the list of properties in this **Script**. .. rst-class:: classref-method -:ref:`Dictionary[]` **get_script_signal_list** **(** **)** +:ref:`Array`\[:ref:`Dictionary`\] **get_script_signal_list**\ (\ ) Returns the list of user signals defined in this **Script**. @@ -250,7 +250,7 @@ Returns the list of user signals defined in this **Script**. .. rst-class:: classref-method -:ref:`bool` **has_script_signal** **(** :ref:`StringName` signal_name **)** |const| +:ref:`bool` **has_script_signal**\ (\ signal_name\: :ref:`StringName`\ ) |const| Returns ``true`` if the script, or a base class, defines a signal with the given name. @@ -262,7 +262,7 @@ Returns ``true`` if the script, or a base class, defines a signal with the given .. rst-class:: classref-method -:ref:`bool` **has_source_code** **(** **)** |const| +:ref:`bool` **has_source_code**\ (\ ) |const| Returns ``true`` if the script contains non-empty source code. @@ -274,7 +274,7 @@ Returns ``true`` if the script contains non-empty source code. .. rst-class:: classref-method -:ref:`bool` **instance_has** **(** :ref:`Object` base_object **)** |const| +:ref:`bool` **instance_has**\ (\ base_object\: :ref:`Object`\ ) |const| Returns ``true`` if ``base_object`` is an instance of this script. @@ -286,7 +286,7 @@ Returns ``true`` if ``base_object`` is an instance of this script. .. rst-class:: classref-method -:ref:`bool` **is_abstract** **(** **)** |const| +:ref:`bool` **is_abstract**\ (\ ) |const| Returns ``true`` if the script is an abstract script. An abstract script does not have a constructor and cannot be instantiated. @@ -298,7 +298,7 @@ Returns ``true`` if the script is an abstract script. An abstract script does no .. rst-class:: classref-method -:ref:`bool` **is_tool** **(** **)** |const| +:ref:`bool` **is_tool**\ (\ ) |const| Returns ``true`` if the script is a tool script. A tool script can run in the editor. @@ -310,7 +310,7 @@ Returns ``true`` if the script is a tool script. A tool script can run in the ed .. rst-class:: classref-method -:ref:`Error` **reload** **(** :ref:`bool` keep_state=false **)** +:ref:`Error` **reload**\ (\ keep_state\: :ref:`bool` = false\ ) Reloads the script's class implementation. Returns an error code. @@ -321,3 +321,4 @@ Reloads the script's class implementation. Returns an error code. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_scriptcreatedialog.rst b/classes/class_scriptcreatedialog.rst index 68880c39dae..8fe7f9ae84a 100644 --- a/classes/class_scriptcreatedialog.rst +++ b/classes/class_scriptcreatedialog.rst @@ -68,9 +68,9 @@ Methods .. table:: :widths: auto - +------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`config` **(** :ref:`String` inherits, :ref:`String` path, :ref:`bool` built_in_enabled=true, :ref:`bool` load_enabled=true **)** | - +------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`config`\ (\ inherits\: :ref:`String`, path\: :ref:`String`, built_in_enabled\: :ref:`bool` = true, load_enabled\: :ref:`bool` = true\ ) | + +--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -85,7 +85,7 @@ Signals .. rst-class:: classref-signal -**script_created** **(** :ref:`Script` script **)** +**script_created**\ (\ script\: :ref:`Script`\ ) Emitted when the user clicks the OK button. @@ -102,7 +102,7 @@ Method Descriptions .. rst-class:: classref-method -void **config** **(** :ref:`String` inherits, :ref:`String` path, :ref:`bool` built_in_enabled=true, :ref:`bool` load_enabled=true **)** +|void| **config**\ (\ inherits\: :ref:`String`, path\: :ref:`String`, built_in_enabled\: :ref:`bool` = true, load_enabled\: :ref:`bool` = true\ ) Prefills required fields to configure the ScriptCreateDialog for use. @@ -113,3 +113,4 @@ Prefills required fields to configure the ScriptCreateDialog for use. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst index 164f44009fa..4b3850eeb97 100644 --- a/classes/class_scripteditor.rst +++ b/classes/class_scripteditor.rst @@ -31,23 +31,23 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ScriptEditorBase` | :ref:`get_current_editor` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Script` | :ref:`get_current_script` **(** **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ScriptEditorBase[]` | :ref:`get_open_script_editors` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Script[]` | :ref:`get_open_scripts` **(** **)** |const| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`goto_line` **(** :ref:`int` line_number **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`open_script_create_dialog` **(** :ref:`String` base_name, :ref:`String` base_path **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`register_syntax_highlighter` **(** :ref:`EditorSyntaxHighlighter` syntax_highlighter **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`unregister_syntax_highlighter` **(** :ref:`EditorSyntaxHighlighter` syntax_highlighter **)** | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ScriptEditorBase` | :ref:`get_current_editor`\ (\ ) |const| | + +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Script` | :ref:`get_current_script`\ (\ ) | + +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`ScriptEditorBase`\] | :ref:`get_open_script_editors`\ (\ ) |const| | + +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Script`\] | :ref:`get_open_scripts`\ (\ ) |const| | + +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`goto_line`\ (\ line_number\: :ref:`int`\ ) | + +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`open_script_create_dialog`\ (\ base_name\: :ref:`String`, base_path\: :ref:`String`\ ) | + +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_syntax_highlighter`\ (\ syntax_highlighter\: :ref:`EditorSyntaxHighlighter`\ ) | + +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unregister_syntax_highlighter`\ (\ syntax_highlighter\: :ref:`EditorSyntaxHighlighter`\ ) | + +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -62,7 +62,7 @@ Signals .. rst-class:: classref-signal -**editor_script_changed** **(** :ref:`Script` script **)** +**editor_script_changed**\ (\ script\: :ref:`Script`\ ) Emitted when user changed active script. Argument is a freshly activated :ref:`Script`. @@ -74,7 +74,7 @@ Emitted when user changed active script. Argument is a freshly activated :ref:`S .. rst-class:: classref-signal -**script_close** **(** :ref:`Script` script **)** +**script_close**\ (\ script\: :ref:`Script`\ ) Emitted when editor is about to close the active script. Argument is a :ref:`Script` that is going to be closed. @@ -91,7 +91,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`ScriptEditorBase` **get_current_editor** **(** **)** |const| +:ref:`ScriptEditorBase` **get_current_editor**\ (\ ) |const| Returns the :ref:`ScriptEditorBase` object that the user is currently editing. @@ -103,7 +103,7 @@ Returns the :ref:`ScriptEditorBase` object that the user .. rst-class:: classref-method -:ref:`Script` **get_current_script** **(** **)** +:ref:`Script` **get_current_script**\ (\ ) Returns a :ref:`Script` that is currently active in editor. @@ -115,7 +115,7 @@ Returns a :ref:`Script` that is currently active in editor. .. rst-class:: classref-method -:ref:`ScriptEditorBase[]` **get_open_script_editors** **(** **)** |const| +:ref:`Array`\[:ref:`ScriptEditorBase`\] **get_open_script_editors**\ (\ ) |const| Returns an array with all :ref:`ScriptEditorBase` objects which are currently open in editor. @@ -127,7 +127,7 @@ Returns an array with all :ref:`ScriptEditorBase` object .. rst-class:: classref-method -:ref:`Script[]` **get_open_scripts** **(** **)** |const| +:ref:`Array`\[:ref:`Script`\] **get_open_scripts**\ (\ ) |const| Returns an array with all :ref:`Script` objects which are currently open in editor. @@ -139,7 +139,7 @@ Returns an array with all :ref:`Script` objects which are currentl .. rst-class:: classref-method -void **goto_line** **(** :ref:`int` line_number **)** +|void| **goto_line**\ (\ line_number\: :ref:`int`\ ) Goes to the specified line in the current script. @@ -151,7 +151,7 @@ Goes to the specified line in the current script. .. rst-class:: classref-method -void **open_script_create_dialog** **(** :ref:`String` base_name, :ref:`String` base_path **)** +|void| **open_script_create_dialog**\ (\ base_name\: :ref:`String`, base_path\: :ref:`String`\ ) Opens the script create dialog. The script will extend ``base_name``. The file extension can be omitted from ``base_path``. It will be added based on the selected scripting language. @@ -163,7 +163,7 @@ Opens the script create dialog. The script will extend ``base_name``. The file e .. rst-class:: classref-method -void **register_syntax_highlighter** **(** :ref:`EditorSyntaxHighlighter` syntax_highlighter **)** +|void| **register_syntax_highlighter**\ (\ syntax_highlighter\: :ref:`EditorSyntaxHighlighter`\ ) Registers the :ref:`EditorSyntaxHighlighter` to the editor, the :ref:`EditorSyntaxHighlighter` will be available on all open scripts. @@ -177,7 +177,7 @@ Registers the :ref:`EditorSyntaxHighlighter` to t .. rst-class:: classref-method -void **unregister_syntax_highlighter** **(** :ref:`EditorSyntaxHighlighter` syntax_highlighter **)** +|void| **unregister_syntax_highlighter**\ (\ syntax_highlighter\: :ref:`EditorSyntaxHighlighter`\ ) Unregisters the :ref:`EditorSyntaxHighlighter` from the editor. @@ -190,3 +190,4 @@ Unregisters the :ref:`EditorSyntaxHighlighter` fr .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_scripteditorbase.rst b/classes/class_scripteditorbase.rst index e9d2508ddd4..892c7c70d67 100644 --- a/classes/class_scripteditorbase.rst +++ b/classes/class_scripteditorbase.rst @@ -29,11 +29,11 @@ Methods .. table:: :widths: auto - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_syntax_highlighter` **(** :ref:`EditorSyntaxHighlighter` highlighter **)** | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Control` | :ref:`get_base_editor` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_syntax_highlighter`\ (\ highlighter\: :ref:`EditorSyntaxHighlighter`\ ) | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Control` | :ref:`get_base_editor`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -48,7 +48,7 @@ Signals .. rst-class:: classref-signal -**edited_script_changed** **(** **)** +**edited_script_changed**\ (\ ) Emitted after script validation. @@ -60,7 +60,7 @@ Emitted after script validation. .. rst-class:: classref-signal -**go_to_help** **(** :ref:`String` what **)** +**go_to_help**\ (\ what\: :ref:`String`\ ) Emitted when the user requests a specific documentation page. @@ -72,7 +72,7 @@ Emitted when the user requests a specific documentation page. .. rst-class:: classref-signal -**go_to_method** **(** :ref:`Object` script, :ref:`String` method **)** +**go_to_method**\ (\ script\: :ref:`Object`, method\: :ref:`String`\ ) Emitted when the user requests to view a specific method of a script, similar to :ref:`request_open_script_at_line`. @@ -84,7 +84,7 @@ Emitted when the user requests to view a specific method of a script, similar to .. rst-class:: classref-signal -**name_changed** **(** **)** +**name_changed**\ (\ ) Emitted after script validation or when the edited resource has changed. @@ -96,7 +96,7 @@ Emitted after script validation or when the edited resource has changed. .. rst-class:: classref-signal -**replace_in_files_requested** **(** :ref:`String` text **)** +**replace_in_files_requested**\ (\ text\: :ref:`String`\ ) Emitted when the user request to find and replace text in the file system. @@ -108,7 +108,7 @@ Emitted when the user request to find and replace text in the file system. .. rst-class:: classref-signal -**request_help** **(** :ref:`String` topic **)** +**request_help**\ (\ topic\: :ref:`String`\ ) Emitted when the user requests contextual help. @@ -120,7 +120,7 @@ Emitted when the user requests contextual help. .. rst-class:: classref-signal -**request_open_script_at_line** **(** :ref:`Object` script, :ref:`int` line **)** +**request_open_script_at_line**\ (\ script\: :ref:`Object`, line\: :ref:`int`\ ) Emitted when the user requests to view a specific line of a script, similar to :ref:`go_to_method`. @@ -132,7 +132,7 @@ Emitted when the user requests to view a specific line of a script, similar to : .. rst-class:: classref-signal -**request_save_history** **(** **)** +**request_save_history**\ (\ ) Emitted when the user contextual goto and the item is in the same script. @@ -144,7 +144,7 @@ Emitted when the user contextual goto and the item is in the same script. .. rst-class:: classref-signal -**search_in_files_requested** **(** :ref:`String` text **)** +**search_in_files_requested**\ (\ text\: :ref:`String`\ ) Emitted when the user request to search text in the file system. @@ -161,7 +161,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_syntax_highlighter** **(** :ref:`EditorSyntaxHighlighter` highlighter **)** +|void| **add_syntax_highlighter**\ (\ highlighter\: :ref:`EditorSyntaxHighlighter`\ ) Adds a :ref:`EditorSyntaxHighlighter` to the open script. @@ -173,7 +173,7 @@ Adds a :ref:`EditorSyntaxHighlighter` to the open .. rst-class:: classref-method -:ref:`Control` **get_base_editor** **(** **)** |const| +:ref:`Control` **get_base_editor**\ (\ ) |const| Returns the underlying :ref:`Control` used for editing scripts. For text scripts, this is a :ref:`CodeEdit`. @@ -184,3 +184,4 @@ Returns the underlying :ref:`Control` used for editing scripts. F .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_scriptextension.rst b/classes/class_scriptextension.rst index fdfbc2cabc1..07c2d80efae 100644 --- a/classes/class_scriptextension.rst +++ b/classes/class_scriptextension.rst @@ -24,77 +24,77 @@ Methods .. table:: :widths: auto - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_can_instantiate` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_editor_can_reload_from_file` **(** **)** |virtual| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Script` | :ref:`_get_base_script` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_class_icon_path` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_constants` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`_get_documentation` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`_get_global_name` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`_get_instance_base_type` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ScriptLanguage` | :ref:`_get_language` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_member_line` **(** :ref:`StringName` member **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName[]` | :ref:`_get_members` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_method_info` **(** :ref:`StringName` method **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_property_default_value` **(** :ref:`StringName` property **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_rpc_config` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`_get_script_method_list` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`_get_script_property_list` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`_get_script_signal_list` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_source_code` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_method` **(** :ref:`StringName` method **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_property_default_value` **(** :ref:`StringName` property **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_script_signal` **(** :ref:`StringName` signal **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_source_code` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_static_method` **(** :ref:`StringName` method **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_inherits_script` **(** :ref:`Script` script **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void* | :ref:`_instance_create` **(** :ref:`Object` for_object **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_instance_has` **(** :ref:`Object` object **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_abstract` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_placeholder_fallback_enabled` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_tool` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_valid` **(** **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_placeholder_erased` **(** void* placeholder **)** |virtual| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void* | :ref:`_placeholder_instance_create` **(** :ref:`Object` for_object **)** |virtual| |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_reload` **(** :ref:`bool` keep_state **)** |virtual| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_source_code` **(** :ref:`String` code **)** |virtual| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_update_exports` **(** **)** |virtual| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_can_instantiate`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_editor_can_reload_from_file`\ (\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Script` | :ref:`_get_base_script`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_class_icon_path`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_constants`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_documentation`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`_get_global_name`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`_get_instance_base_type`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ScriptLanguage` | :ref:`_get_language`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_member_line`\ (\ member\: :ref:`StringName`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`StringName`\] | :ref:`_get_members`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_method_info`\ (\ method\: :ref:`StringName`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_property_default_value`\ (\ property\: :ref:`StringName`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_rpc_config`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_script_method_list`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_script_property_list`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_script_signal_list`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_source_code`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_method`\ (\ method\: :ref:`StringName`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_property_default_value`\ (\ property\: :ref:`StringName`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_script_signal`\ (\ signal\: :ref:`StringName`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_source_code`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_static_method`\ (\ method\: :ref:`StringName`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_inherits_script`\ (\ script\: :ref:`Script`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ``void*`` | :ref:`_instance_create`\ (\ for_object\: :ref:`Object`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_instance_has`\ (\ object\: :ref:`Object`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_abstract`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_placeholder_fallback_enabled`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_tool`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_valid`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_placeholder_erased`\ (\ placeholder\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ``void*`` | :ref:`_placeholder_instance_create`\ (\ for_object\: :ref:`Object`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_reload`\ (\ keep_state\: :ref:`bool`\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_source_code`\ (\ code\: :ref:`String`\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_update_exports`\ (\ ) |virtual| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -109,7 +109,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_can_instantiate** **(** **)** |virtual| |const| +:ref:`bool` **_can_instantiate**\ (\ ) |virtual| |const| .. container:: contribute @@ -123,7 +123,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_editor_can_reload_from_file** **(** **)** |virtual| +:ref:`bool` **_editor_can_reload_from_file**\ (\ ) |virtual| .. container:: contribute @@ -137,7 +137,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Script` **_get_base_script** **(** **)** |virtual| |const| +:ref:`Script` **_get_base_script**\ (\ ) |virtual| |const| .. container:: contribute @@ -151,7 +151,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **_get_class_icon_path** **(** **)** |virtual| |const| +:ref:`String` **_get_class_icon_path**\ (\ ) |virtual| |const| .. container:: contribute @@ -165,7 +165,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary` **_get_constants** **(** **)** |virtual| |const| +:ref:`Dictionary` **_get_constants**\ (\ ) |virtual| |const| .. container:: contribute @@ -179,7 +179,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary[]` **_get_documentation** **(** **)** |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_documentation**\ (\ ) |virtual| |const| .. container:: contribute @@ -193,7 +193,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`StringName` **_get_global_name** **(** **)** |virtual| |const| +:ref:`StringName` **_get_global_name**\ (\ ) |virtual| |const| .. container:: contribute @@ -207,7 +207,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`StringName` **_get_instance_base_type** **(** **)** |virtual| |const| +:ref:`StringName` **_get_instance_base_type**\ (\ ) |virtual| |const| .. container:: contribute @@ -221,7 +221,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`ScriptLanguage` **_get_language** **(** **)** |virtual| |const| +:ref:`ScriptLanguage` **_get_language**\ (\ ) |virtual| |const| .. container:: contribute @@ -235,7 +235,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_member_line** **(** :ref:`StringName` member **)** |virtual| |const| +:ref:`int` **_get_member_line**\ (\ member\: :ref:`StringName`\ ) |virtual| |const| .. container:: contribute @@ -249,7 +249,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`StringName[]` **_get_members** **(** **)** |virtual| |const| +:ref:`Array`\[:ref:`StringName`\] **_get_members**\ (\ ) |virtual| |const| .. container:: contribute @@ -263,7 +263,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary` **_get_method_info** **(** :ref:`StringName` method **)** |virtual| |const| +:ref:`Dictionary` **_get_method_info**\ (\ method\: :ref:`StringName`\ ) |virtual| |const| .. container:: contribute @@ -277,7 +277,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **_get_property_default_value** **(** :ref:`StringName` property **)** |virtual| |const| +:ref:`Variant` **_get_property_default_value**\ (\ property\: :ref:`StringName`\ ) |virtual| |const| .. container:: contribute @@ -291,7 +291,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **_get_rpc_config** **(** **)** |virtual| |const| +:ref:`Variant` **_get_rpc_config**\ (\ ) |virtual| |const| .. container:: contribute @@ -305,7 +305,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary[]` **_get_script_method_list** **(** **)** |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_script_method_list**\ (\ ) |virtual| |const| .. container:: contribute @@ -319,7 +319,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary[]` **_get_script_property_list** **(** **)** |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_script_property_list**\ (\ ) |virtual| |const| .. container:: contribute @@ -333,7 +333,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary[]` **_get_script_signal_list** **(** **)** |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_script_signal_list**\ (\ ) |virtual| |const| .. container:: contribute @@ -347,7 +347,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **_get_source_code** **(** **)** |virtual| |const| +:ref:`String` **_get_source_code**\ (\ ) |virtual| |const| .. container:: contribute @@ -361,7 +361,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_has_method** **(** :ref:`StringName` method **)** |virtual| |const| +:ref:`bool` **_has_method**\ (\ method\: :ref:`StringName`\ ) |virtual| |const| .. container:: contribute @@ -375,7 +375,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_has_property_default_value** **(** :ref:`StringName` property **)** |virtual| |const| +:ref:`bool` **_has_property_default_value**\ (\ property\: :ref:`StringName`\ ) |virtual| |const| .. container:: contribute @@ -389,7 +389,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_has_script_signal** **(** :ref:`StringName` signal **)** |virtual| |const| +:ref:`bool` **_has_script_signal**\ (\ signal\: :ref:`StringName`\ ) |virtual| |const| .. container:: contribute @@ -403,7 +403,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_has_source_code** **(** **)** |virtual| |const| +:ref:`bool` **_has_source_code**\ (\ ) |virtual| |const| .. container:: contribute @@ -417,7 +417,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_has_static_method** **(** :ref:`StringName` method **)** |virtual| |const| +:ref:`bool` **_has_static_method**\ (\ method\: :ref:`StringName`\ ) |virtual| |const| .. container:: contribute @@ -431,7 +431,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_inherits_script** **(** :ref:`Script` script **)** |virtual| |const| +:ref:`bool` **_inherits_script**\ (\ script\: :ref:`Script`\ ) |virtual| |const| .. container:: contribute @@ -445,7 +445,7 @@ Method Descriptions .. rst-class:: classref-method -void* **_instance_create** **(** :ref:`Object` for_object **)** |virtual| |const| +``void*`` **_instance_create**\ (\ for_object\: :ref:`Object`\ ) |virtual| |const| .. container:: contribute @@ -459,7 +459,7 @@ void* **_instance_create** **(** :ref:`Object` for_object **)** |v .. rst-class:: classref-method -:ref:`bool` **_instance_has** **(** :ref:`Object` object **)** |virtual| |const| +:ref:`bool` **_instance_has**\ (\ object\: :ref:`Object`\ ) |virtual| |const| .. container:: contribute @@ -473,7 +473,7 @@ void* **_instance_create** **(** :ref:`Object` for_object **)** |v .. rst-class:: classref-method -:ref:`bool` **_is_abstract** **(** **)** |virtual| |const| +:ref:`bool` **_is_abstract**\ (\ ) |virtual| |const| Returns ``true`` if the script is an abstract script. An abstract script does not have a constructor and cannot be instantiated. @@ -485,7 +485,7 @@ Returns ``true`` if the script is an abstract script. An abstract script does no .. rst-class:: classref-method -:ref:`bool` **_is_placeholder_fallback_enabled** **(** **)** |virtual| |const| +:ref:`bool` **_is_placeholder_fallback_enabled**\ (\ ) |virtual| |const| .. container:: contribute @@ -499,7 +499,7 @@ Returns ``true`` if the script is an abstract script. An abstract script does no .. rst-class:: classref-method -:ref:`bool` **_is_tool** **(** **)** |virtual| |const| +:ref:`bool` **_is_tool**\ (\ ) |virtual| |const| .. container:: contribute @@ -513,7 +513,7 @@ Returns ``true`` if the script is an abstract script. An abstract script does no .. rst-class:: classref-method -:ref:`bool` **_is_valid** **(** **)** |virtual| |const| +:ref:`bool` **_is_valid**\ (\ ) |virtual| |const| .. container:: contribute @@ -527,7 +527,7 @@ Returns ``true`` if the script is an abstract script. An abstract script does no .. rst-class:: classref-method -void **_placeholder_erased** **(** void* placeholder **)** |virtual| +|void| **_placeholder_erased**\ (\ placeholder\: ``void*``\ ) |virtual| .. container:: contribute @@ -541,7 +541,7 @@ void **_placeholder_erased** **(** void* placeholder **)** |virtual| .. rst-class:: classref-method -void* **_placeholder_instance_create** **(** :ref:`Object` for_object **)** |virtual| |const| +``void*`` **_placeholder_instance_create**\ (\ for_object\: :ref:`Object`\ ) |virtual| |const| .. container:: contribute @@ -555,7 +555,7 @@ void* **_placeholder_instance_create** **(** :ref:`Object` for_obj .. rst-class:: classref-method -:ref:`Error` **_reload** **(** :ref:`bool` keep_state **)** |virtual| +:ref:`Error` **_reload**\ (\ keep_state\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -569,7 +569,7 @@ void* **_placeholder_instance_create** **(** :ref:`Object` for_obj .. rst-class:: classref-method -void **_set_source_code** **(** :ref:`String` code **)** |virtual| +|void| **_set_source_code**\ (\ code\: :ref:`String`\ ) |virtual| .. container:: contribute @@ -583,7 +583,7 @@ void **_set_source_code** **(** :ref:`String` code **)** |virtual| .. rst-class:: classref-method -void **_update_exports** **(** **)** |virtual| +|void| **_update_exports**\ (\ ) |virtual| .. container:: contribute @@ -596,3 +596,4 @@ void **_update_exports** **(** **)** |virtual| .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_scriptlanguage.rst b/classes/class_scriptlanguage.rst index ba55ef0bf34..daeaf77b2d7 100644 --- a/classes/class_scriptlanguage.rst +++ b/classes/class_scriptlanguage.rst @@ -25,3 +25,4 @@ ScriptLanguage .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_scriptlanguageextension.rst b/classes/class_scriptlanguageextension.rst index 128afb07f89..5436a188f31 100644 --- a/classes/class_scriptlanguageextension.rst +++ b/classes/class_scriptlanguageextension.rst @@ -24,121 +24,121 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_add_global_constant` **(** :ref:`StringName` name, :ref:`Variant` value **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_add_named_global_constant` **(** :ref:`StringName` name, :ref:`Variant` value **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_auto_indent_code` **(** :ref:`String` code, :ref:`int` from_line, :ref:`int` to_line **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_can_inherit_from_file` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_can_make_function` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_complete_code` **(** :ref:`String` code, :ref:`String` path, :ref:`Object` owner **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`_create_script` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`_debug_get_current_stack_info` **(** **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_debug_get_error` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_debug_get_globals` **(** :ref:`int` max_subitems, :ref:`int` max_depth **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_debug_get_stack_level_count` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_debug_get_stack_level_function` **(** :ref:`int` level **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void* | :ref:`_debug_get_stack_level_instance` **(** :ref:`int` level **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_debug_get_stack_level_line` **(** :ref:`int` level **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_debug_get_stack_level_locals` **(** :ref:`int` level, :ref:`int` max_subitems, :ref:`int` max_depth **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_debug_get_stack_level_members` **(** :ref:`int` level, :ref:`int` max_subitems, :ref:`int` max_depth **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_debug_parse_stack_level_expression` **(** :ref:`int` level, :ref:`String` expression, :ref:`int` max_subitems, :ref:`int` max_depth **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_find_function` **(** :ref:`String` function, :ref:`String` code **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_finish` **(** **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_frame` **(** **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`_get_built_in_templates` **(** :ref:`StringName` object **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_comment_delimiters` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_doc_comment_delimiters` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_extension` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_global_class_name` **(** :ref:`String` path **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_name` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`_get_public_annotations` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_public_constants` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`_get_public_functions` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_recognized_extensions` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_reserved_words` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_string_delimiters` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_type` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_handles_global_class_type` **(** :ref:`String` type **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_named_classes` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_init` **(** **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_control_flow_keyword` **(** :ref:`String` keyword **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_using_templates` **(** **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_lookup_code` **(** :ref:`String` code, :ref:`String` symbol, :ref:`String` path, :ref:`Object` owner **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_make_function` **(** :ref:`String` class_name, :ref:`String` function_name, :ref:`PackedStringArray` function_args **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Script` | :ref:`_make_template` **(** :ref:`String` template, :ref:`String` class_name, :ref:`String` base_class_name **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_open_in_external_editor` **(** :ref:`Script` script, :ref:`int` line, :ref:`int` column **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_overrides_external_editor` **(** **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_profiling_get_accumulated_data` **(** ScriptLanguageExtensionProfilingInfo* info_array, :ref:`int` info_max **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_profiling_get_frame_data` **(** ScriptLanguageExtensionProfilingInfo* info_array, :ref:`int` info_max **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_profiling_set_save_native_calls` **(** :ref:`bool` enable **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_profiling_start` **(** **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_profiling_stop` **(** **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_reload_all_scripts` **(** **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_reload_tool_script` **(** :ref:`Script` script, :ref:`bool` soft_reload **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_remove_named_global_constant` **(** :ref:`StringName` name **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_supports_builtin_mode` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_supports_documentation` **(** **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_thread_enter` **(** **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_thread_exit` **(** **)** |virtual| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_validate` **(** :ref:`String` script, :ref:`String` path, :ref:`bool` validate_functions, :ref:`bool` validate_errors, :ref:`bool` validate_warnings, :ref:`bool` validate_safe_lines **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_validate_path` **(** :ref:`String` path **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_add_global_constant`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_add_named_global_constant`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_auto_indent_code`\ (\ code\: :ref:`String`, from_line\: :ref:`int`, to_line\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_can_inherit_from_file`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_can_make_function`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_complete_code`\ (\ code\: :ref:`String`, path\: :ref:`String`, owner\: :ref:`Object`\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`_create_script`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_debug_get_current_stack_info`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_debug_get_error`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_debug_get_globals`\ (\ max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_debug_get_stack_level_count`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_debug_get_stack_level_function`\ (\ level\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ``void*`` | :ref:`_debug_get_stack_level_instance`\ (\ level\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_debug_get_stack_level_line`\ (\ level\: :ref:`int`\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_debug_get_stack_level_locals`\ (\ level\: :ref:`int`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_debug_get_stack_level_members`\ (\ level\: :ref:`int`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_debug_parse_stack_level_expression`\ (\ level\: :ref:`int`, expression\: :ref:`String`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_find_function`\ (\ function\: :ref:`String`, code\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_finish`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_frame`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_built_in_templates`\ (\ object\: :ref:`StringName`\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_comment_delimiters`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_doc_comment_delimiters`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_extension`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_global_class_name`\ (\ path\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_name`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_public_annotations`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_public_constants`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_public_functions`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_recognized_extensions`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_reserved_words`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_string_delimiters`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_type`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_handles_global_class_type`\ (\ type\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_named_classes`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_init`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_control_flow_keyword`\ (\ keyword\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_using_templates`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_lookup_code`\ (\ code\: :ref:`String`, symbol\: :ref:`String`, path\: :ref:`String`, owner\: :ref:`Object`\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_make_function`\ (\ class_name\: :ref:`String`, function_name\: :ref:`String`, function_args\: :ref:`PackedStringArray`\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Script` | :ref:`_make_template`\ (\ template\: :ref:`String`, class_name\: :ref:`String`, base_class_name\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_open_in_external_editor`\ (\ script\: :ref:`Script`, line\: :ref:`int`, column\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_overrides_external_editor`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_profiling_get_accumulated_data`\ (\ info_array\: ``ScriptLanguageExtensionProfilingInfo*``, info_max\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_profiling_get_frame_data`\ (\ info_array\: ``ScriptLanguageExtensionProfilingInfo*``, info_max\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_profiling_set_save_native_calls`\ (\ enable\: :ref:`bool`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_profiling_start`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_profiling_stop`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_reload_all_scripts`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_reload_tool_script`\ (\ script\: :ref:`Script`, soft_reload\: :ref:`bool`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_remove_named_global_constant`\ (\ name\: :ref:`StringName`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_supports_builtin_mode`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_supports_documentation`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_thread_enter`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_thread_exit`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_validate`\ (\ script\: :ref:`String`, path\: :ref:`String`, validate_functions\: :ref:`bool`, validate_errors\: :ref:`bool`, validate_warnings\: :ref:`bool`, validate_safe_lines\: :ref:`bool`\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_validate_path`\ (\ path\: :ref:`String`\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -472,7 +472,7 @@ Method Descriptions .. rst-class:: classref-method -void **_add_global_constant** **(** :ref:`StringName` name, :ref:`Variant` value **)** |virtual| +|void| **_add_global_constant**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| .. container:: contribute @@ -486,7 +486,7 @@ void **_add_global_constant** **(** :ref:`StringName` name, :r .. rst-class:: classref-method -void **_add_named_global_constant** **(** :ref:`StringName` name, :ref:`Variant` value **)** |virtual| +|void| **_add_named_global_constant**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| .. container:: contribute @@ -500,7 +500,7 @@ void **_add_named_global_constant** **(** :ref:`StringName` na .. rst-class:: classref-method -:ref:`String` **_auto_indent_code** **(** :ref:`String` code, :ref:`int` from_line, :ref:`int` to_line **)** |virtual| |const| +:ref:`String` **_auto_indent_code**\ (\ code\: :ref:`String`, from_line\: :ref:`int`, to_line\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -514,7 +514,7 @@ void **_add_named_global_constant** **(** :ref:`StringName` na .. rst-class:: classref-method -:ref:`bool` **_can_inherit_from_file** **(** **)** |virtual| |const| +:ref:`bool` **_can_inherit_from_file**\ (\ ) |virtual| |const| .. container:: contribute @@ -528,7 +528,7 @@ void **_add_named_global_constant** **(** :ref:`StringName` na .. rst-class:: classref-method -:ref:`bool` **_can_make_function** **(** **)** |virtual| |const| +:ref:`bool` **_can_make_function**\ (\ ) |virtual| |const| .. container:: contribute @@ -542,7 +542,7 @@ void **_add_named_global_constant** **(** :ref:`StringName` na .. rst-class:: classref-method -:ref:`Dictionary` **_complete_code** **(** :ref:`String` code, :ref:`String` path, :ref:`Object` owner **)** |virtual| |const| +:ref:`Dictionary` **_complete_code**\ (\ code\: :ref:`String`, path\: :ref:`String`, owner\: :ref:`Object`\ ) |virtual| |const| .. container:: contribute @@ -556,7 +556,7 @@ void **_add_named_global_constant** **(** :ref:`StringName` na .. rst-class:: classref-method -:ref:`Object` **_create_script** **(** **)** |virtual| |const| +:ref:`Object` **_create_script**\ (\ ) |virtual| |const| .. container:: contribute @@ -570,7 +570,7 @@ void **_add_named_global_constant** **(** :ref:`StringName` na .. rst-class:: classref-method -:ref:`Dictionary[]` **_debug_get_current_stack_info** **(** **)** |virtual| +:ref:`Array`\[:ref:`Dictionary`\] **_debug_get_current_stack_info**\ (\ ) |virtual| .. container:: contribute @@ -584,7 +584,7 @@ void **_add_named_global_constant** **(** :ref:`StringName` na .. rst-class:: classref-method -:ref:`String` **_debug_get_error** **(** **)** |virtual| |const| +:ref:`String` **_debug_get_error**\ (\ ) |virtual| |const| .. container:: contribute @@ -598,7 +598,7 @@ void **_add_named_global_constant** **(** :ref:`StringName` na .. rst-class:: classref-method -:ref:`Dictionary` **_debug_get_globals** **(** :ref:`int` max_subitems, :ref:`int` max_depth **)** |virtual| +:ref:`Dictionary` **_debug_get_globals**\ (\ max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -612,7 +612,7 @@ void **_add_named_global_constant** **(** :ref:`StringName` na .. rst-class:: classref-method -:ref:`int` **_debug_get_stack_level_count** **(** **)** |virtual| |const| +:ref:`int` **_debug_get_stack_level_count**\ (\ ) |virtual| |const| .. container:: contribute @@ -626,7 +626,7 @@ void **_add_named_global_constant** **(** :ref:`StringName` na .. rst-class:: classref-method -:ref:`String` **_debug_get_stack_level_function** **(** :ref:`int` level **)** |virtual| |const| +:ref:`String` **_debug_get_stack_level_function**\ (\ level\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -640,7 +640,7 @@ void **_add_named_global_constant** **(** :ref:`StringName` na .. rst-class:: classref-method -void* **_debug_get_stack_level_instance** **(** :ref:`int` level **)** |virtual| +``void*`` **_debug_get_stack_level_instance**\ (\ level\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -654,7 +654,7 @@ void* **_debug_get_stack_level_instance** **(** :ref:`int` level **)* .. rst-class:: classref-method -:ref:`int` **_debug_get_stack_level_line** **(** :ref:`int` level **)** |virtual| |const| +:ref:`int` **_debug_get_stack_level_line**\ (\ level\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -668,7 +668,7 @@ void* **_debug_get_stack_level_instance** **(** :ref:`int` level **)* .. rst-class:: classref-method -:ref:`Dictionary` **_debug_get_stack_level_locals** **(** :ref:`int` level, :ref:`int` max_subitems, :ref:`int` max_depth **)** |virtual| +:ref:`Dictionary` **_debug_get_stack_level_locals**\ (\ level\: :ref:`int`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -682,7 +682,7 @@ void* **_debug_get_stack_level_instance** **(** :ref:`int` level **)* .. rst-class:: classref-method -:ref:`Dictionary` **_debug_get_stack_level_members** **(** :ref:`int` level, :ref:`int` max_subitems, :ref:`int` max_depth **)** |virtual| +:ref:`Dictionary` **_debug_get_stack_level_members**\ (\ level\: :ref:`int`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -696,7 +696,7 @@ void* **_debug_get_stack_level_instance** **(** :ref:`int` level **)* .. rst-class:: classref-method -:ref:`String` **_debug_parse_stack_level_expression** **(** :ref:`int` level, :ref:`String` expression, :ref:`int` max_subitems, :ref:`int` max_depth **)** |virtual| +:ref:`String` **_debug_parse_stack_level_expression**\ (\ level\: :ref:`int`, expression\: :ref:`String`, max_subitems\: :ref:`int`, max_depth\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -710,7 +710,7 @@ void* **_debug_get_stack_level_instance** **(** :ref:`int` level **)* .. rst-class:: classref-method -:ref:`int` **_find_function** **(** :ref:`String` function, :ref:`String` code **)** |virtual| |const| +:ref:`int` **_find_function**\ (\ function\: :ref:`String`, code\: :ref:`String`\ ) |virtual| |const| Returns the line where the function is defined in the code, or ``-1`` if the function is not present. @@ -722,7 +722,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. rst-class:: classref-method -void **_finish** **(** **)** |virtual| +|void| **_finish**\ (\ ) |virtual| .. container:: contribute @@ -736,7 +736,7 @@ void **_finish** **(** **)** |virtual| .. rst-class:: classref-method -void **_frame** **(** **)** |virtual| +|void| **_frame**\ (\ ) |virtual| .. container:: contribute @@ -750,7 +750,7 @@ void **_frame** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`Dictionary[]` **_get_built_in_templates** **(** :ref:`StringName` object **)** |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_built_in_templates**\ (\ object\: :ref:`StringName`\ ) |virtual| |const| .. container:: contribute @@ -764,7 +764,7 @@ void **_frame** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_comment_delimiters** **(** **)** |virtual| |const| +:ref:`PackedStringArray` **_get_comment_delimiters**\ (\ ) |virtual| |const| .. container:: contribute @@ -778,7 +778,7 @@ void **_frame** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_doc_comment_delimiters** **(** **)** |virtual| |const| +:ref:`PackedStringArray` **_get_doc_comment_delimiters**\ (\ ) |virtual| |const| .. container:: contribute @@ -792,7 +792,7 @@ void **_frame** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`String` **_get_extension** **(** **)** |virtual| |const| +:ref:`String` **_get_extension**\ (\ ) |virtual| |const| .. container:: contribute @@ -806,7 +806,7 @@ void **_frame** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`Dictionary` **_get_global_class_name** **(** :ref:`String` path **)** |virtual| |const| +:ref:`Dictionary` **_get_global_class_name**\ (\ path\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -820,7 +820,7 @@ void **_frame** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`String` **_get_name** **(** **)** |virtual| |const| +:ref:`String` **_get_name**\ (\ ) |virtual| |const| .. container:: contribute @@ -834,7 +834,7 @@ void **_frame** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`Dictionary[]` **_get_public_annotations** **(** **)** |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_public_annotations**\ (\ ) |virtual| |const| .. container:: contribute @@ -848,7 +848,7 @@ void **_frame** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`Dictionary` **_get_public_constants** **(** **)** |virtual| |const| +:ref:`Dictionary` **_get_public_constants**\ (\ ) |virtual| |const| .. container:: contribute @@ -862,7 +862,7 @@ void **_frame** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`Dictionary[]` **_get_public_functions** **(** **)** |virtual| |const| +:ref:`Array`\[:ref:`Dictionary`\] **_get_public_functions**\ (\ ) |virtual| |const| .. container:: contribute @@ -876,7 +876,7 @@ void **_frame** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_recognized_extensions** **(** **)** |virtual| |const| +:ref:`PackedStringArray` **_get_recognized_extensions**\ (\ ) |virtual| |const| .. container:: contribute @@ -890,7 +890,7 @@ void **_frame** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_reserved_words** **(** **)** |virtual| |const| +:ref:`PackedStringArray` **_get_reserved_words**\ (\ ) |virtual| |const| .. container:: contribute @@ -904,7 +904,7 @@ void **_frame** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_string_delimiters** **(** **)** |virtual| |const| +:ref:`PackedStringArray` **_get_string_delimiters**\ (\ ) |virtual| |const| .. container:: contribute @@ -918,7 +918,7 @@ void **_frame** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`String` **_get_type** **(** **)** |virtual| |const| +:ref:`String` **_get_type**\ (\ ) |virtual| |const| .. container:: contribute @@ -932,7 +932,7 @@ void **_frame** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_handles_global_class_type** **(** :ref:`String` type **)** |virtual| |const| +:ref:`bool` **_handles_global_class_type**\ (\ type\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -946,14 +946,10 @@ void **_frame** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_has_named_classes** **(** **)** |virtual| |const| +:ref:`bool` **_has_named_classes**\ (\ ) |virtual| |const| **Deprecated:** This method is not called by the engine. -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! - .. rst-class:: classref-item-separator ---- @@ -962,7 +958,7 @@ void **_frame** **(** **)** |virtual| .. rst-class:: classref-method -void **_init** **(** **)** |virtual| +|void| **_init**\ (\ ) |virtual| .. container:: contribute @@ -976,7 +972,7 @@ void **_init** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_is_control_flow_keyword** **(** :ref:`String` keyword **)** |virtual| |const| +:ref:`bool` **_is_control_flow_keyword**\ (\ keyword\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -990,7 +986,7 @@ void **_init** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_is_using_templates** **(** **)** |virtual| +:ref:`bool` **_is_using_templates**\ (\ ) |virtual| .. container:: contribute @@ -1004,7 +1000,7 @@ void **_init** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`Dictionary` **_lookup_code** **(** :ref:`String` code, :ref:`String` symbol, :ref:`String` path, :ref:`Object` owner **)** |virtual| |const| +:ref:`Dictionary` **_lookup_code**\ (\ code\: :ref:`String`, symbol\: :ref:`String`, path\: :ref:`String`, owner\: :ref:`Object`\ ) |virtual| |const| .. container:: contribute @@ -1018,7 +1014,7 @@ void **_init** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`String` **_make_function** **(** :ref:`String` class_name, :ref:`String` function_name, :ref:`PackedStringArray` function_args **)** |virtual| |const| +:ref:`String` **_make_function**\ (\ class_name\: :ref:`String`, function_name\: :ref:`String`, function_args\: :ref:`PackedStringArray`\ ) |virtual| |const| .. container:: contribute @@ -1032,7 +1028,7 @@ void **_init** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`Script` **_make_template** **(** :ref:`String` template, :ref:`String` class_name, :ref:`String` base_class_name **)** |virtual| |const| +:ref:`Script` **_make_template**\ (\ template\: :ref:`String`, class_name\: :ref:`String`, base_class_name\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -1046,7 +1042,7 @@ void **_init** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`Error` **_open_in_external_editor** **(** :ref:`Script` script, :ref:`int` line, :ref:`int` column **)** |virtual| +:ref:`Error` **_open_in_external_editor**\ (\ script\: :ref:`Script`, line\: :ref:`int`, column\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1060,7 +1056,7 @@ void **_init** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_overrides_external_editor** **(** **)** |virtual| +:ref:`bool` **_overrides_external_editor**\ (\ ) |virtual| .. container:: contribute @@ -1074,7 +1070,7 @@ void **_init** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_profiling_get_accumulated_data** **(** ScriptLanguageExtensionProfilingInfo* info_array, :ref:`int` info_max **)** |virtual| +:ref:`int` **_profiling_get_accumulated_data**\ (\ info_array\: ``ScriptLanguageExtensionProfilingInfo*``, info_max\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1088,7 +1084,7 @@ void **_init** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_profiling_get_frame_data** **(** ScriptLanguageExtensionProfilingInfo* info_array, :ref:`int` info_max **)** |virtual| +:ref:`int` **_profiling_get_frame_data**\ (\ info_array\: ``ScriptLanguageExtensionProfilingInfo*``, info_max\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1102,7 +1098,7 @@ void **_init** **(** **)** |virtual| .. rst-class:: classref-method -void **_profiling_set_save_native_calls** **(** :ref:`bool` enable **)** |virtual| +|void| **_profiling_set_save_native_calls**\ (\ enable\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1116,7 +1112,7 @@ void **_profiling_set_save_native_calls** **(** :ref:`bool` enable * .. rst-class:: classref-method -void **_profiling_start** **(** **)** |virtual| +|void| **_profiling_start**\ (\ ) |virtual| .. container:: contribute @@ -1130,7 +1126,7 @@ void **_profiling_start** **(** **)** |virtual| .. rst-class:: classref-method -void **_profiling_stop** **(** **)** |virtual| +|void| **_profiling_stop**\ (\ ) |virtual| .. container:: contribute @@ -1144,7 +1140,7 @@ void **_profiling_stop** **(** **)** |virtual| .. rst-class:: classref-method -void **_reload_all_scripts** **(** **)** |virtual| +|void| **_reload_all_scripts**\ (\ ) |virtual| .. container:: contribute @@ -1158,7 +1154,7 @@ void **_reload_all_scripts** **(** **)** |virtual| .. rst-class:: classref-method -void **_reload_tool_script** **(** :ref:`Script` script, :ref:`bool` soft_reload **)** |virtual| +|void| **_reload_tool_script**\ (\ script\: :ref:`Script`, soft_reload\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1172,7 +1168,7 @@ void **_reload_tool_script** **(** :ref:`Script` script, :ref:`boo .. rst-class:: classref-method -void **_remove_named_global_constant** **(** :ref:`StringName` name **)** |virtual| +|void| **_remove_named_global_constant**\ (\ name\: :ref:`StringName`\ ) |virtual| .. container:: contribute @@ -1186,7 +1182,7 @@ void **_remove_named_global_constant** **(** :ref:`StringName` .. rst-class:: classref-method -:ref:`bool` **_supports_builtin_mode** **(** **)** |virtual| |const| +:ref:`bool` **_supports_builtin_mode**\ (\ ) |virtual| |const| .. container:: contribute @@ -1200,7 +1196,7 @@ void **_remove_named_global_constant** **(** :ref:`StringName` .. rst-class:: classref-method -:ref:`bool` **_supports_documentation** **(** **)** |virtual| |const| +:ref:`bool` **_supports_documentation**\ (\ ) |virtual| |const| .. container:: contribute @@ -1214,7 +1210,7 @@ void **_remove_named_global_constant** **(** :ref:`StringName` .. rst-class:: classref-method -void **_thread_enter** **(** **)** |virtual| +|void| **_thread_enter**\ (\ ) |virtual| .. container:: contribute @@ -1228,7 +1224,7 @@ void **_thread_enter** **(** **)** |virtual| .. rst-class:: classref-method -void **_thread_exit** **(** **)** |virtual| +|void| **_thread_exit**\ (\ ) |virtual| .. container:: contribute @@ -1242,7 +1238,7 @@ void **_thread_exit** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`Dictionary` **_validate** **(** :ref:`String` script, :ref:`String` path, :ref:`bool` validate_functions, :ref:`bool` validate_errors, :ref:`bool` validate_warnings, :ref:`bool` validate_safe_lines **)** |virtual| |const| +:ref:`Dictionary` **_validate**\ (\ script\: :ref:`String`, path\: :ref:`String`, validate_functions\: :ref:`bool`, validate_errors\: :ref:`bool`, validate_warnings\: :ref:`bool`, validate_safe_lines\: :ref:`bool`\ ) |virtual| |const| .. container:: contribute @@ -1256,7 +1252,7 @@ void **_thread_exit** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`String` **_validate_path** **(** :ref:`String` path **)** |virtual| |const| +:ref:`String` **_validate_path**\ (\ path\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -1269,3 +1265,4 @@ void **_thread_exit** **(** **)** |virtual| .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index 30acc393f6c..fabf3760582 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -82,7 +82,7 @@ Signals .. rst-class:: classref-signal -**scrolling** **(** **)** +**scrolling**\ (\ ) Emitted when the scrollbar is being scrolled. @@ -103,8 +103,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_custom_step** **(** :ref:`float` value **)** -- :ref:`float` **get_custom_step** **(** **)** +- |void| **set_custom_step**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_custom_step**\ (\ ) Overrides the step used when clicking increment and decrement buttons or when using arrow keys when the **ScrollBar** is focused. @@ -252,3 +252,4 @@ Used as background when the **ScrollBar** has the GUI focus. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index c84ee6e6a78..ae8b3f62051 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -66,13 +66,13 @@ Methods .. table:: :widths: auto - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`ensure_control_visible` **(** :ref:`Control` control **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`HScrollBar` | :ref:`get_h_scroll_bar` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VScrollBar` | :ref:`get_v_scroll_bar` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`ensure_control_visible`\ (\ control\: :ref:`Control`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`HScrollBar` | :ref:`get_h_scroll_bar`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`VScrollBar` | :ref:`get_v_scroll_bar`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -99,7 +99,7 @@ Signals .. rst-class:: classref-signal -**scroll_ended** **(** **)** +**scroll_ended**\ (\ ) Emitted when scrolling stops when dragging the scrollable area *with a touch event*. This signal is *not* emitted when scrolling by dragging the scrollbar, scrolling with the mouse wheel or scrolling with keyboard/gamepad events. @@ -113,7 +113,7 @@ Emitted when scrolling stops when dragging the scrollable area *with a touch eve .. rst-class:: classref-signal -**scroll_started** **(** **)** +**scroll_started**\ (\ ) Emitted when scrolling starts when dragging the scrollable area w\ *ith a touch event*. This signal is *not* emitted when scrolling by dragging the scrollbar, scrolling with the mouse wheel or scrolling with keyboard/gamepad events. @@ -183,8 +183,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_follow_focus** **(** :ref:`bool` value **)** -- :ref:`bool` **is_following_focus** **(** **)** +- |void| **set_follow_focus**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_following_focus**\ (\ ) If ``true``, the ScrollContainer will automatically scroll to focused children (including indirect children) to make sure they are fully visible. @@ -200,8 +200,8 @@ If ``true``, the ScrollContainer will automatically scroll to focused children ( .. rst-class:: classref-property-setget -- void **set_horizontal_scroll_mode** **(** :ref:`ScrollMode` value **)** -- :ref:`ScrollMode` **get_horizontal_scroll_mode** **(** **)** +- |void| **set_horizontal_scroll_mode**\ (\ value\: :ref:`ScrollMode`\ ) +- :ref:`ScrollMode` **get_horizontal_scroll_mode**\ (\ ) Controls whether horizontal scrollbar can be used and when it should be visible. See :ref:`ScrollMode` for options. @@ -217,8 +217,8 @@ Controls whether horizontal scrollbar can be used and when it should be visible. .. rst-class:: classref-property-setget -- void **set_deadzone** **(** :ref:`int` value **)** -- :ref:`int` **get_deadzone** **(** **)** +- |void| **set_deadzone**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_deadzone**\ (\ ) Deadzone for touch scrolling. Lower deadzone makes the scrolling more sensitive. @@ -234,8 +234,8 @@ Deadzone for touch scrolling. Lower deadzone makes the scrolling more sensitive. .. rst-class:: classref-property-setget -- void **set_h_scroll** **(** :ref:`int` value **)** -- :ref:`int` **get_h_scroll** **(** **)** +- |void| **set_h_scroll**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_h_scroll**\ (\ ) The current horizontal scroll value. @@ -258,8 +258,8 @@ The current horizontal scroll value. .. rst-class:: classref-property-setget -- void **set_horizontal_custom_step** **(** :ref:`float` value **)** -- :ref:`float` **get_horizontal_custom_step** **(** **)** +- |void| **set_horizontal_custom_step**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_horizontal_custom_step**\ (\ ) Overrides the :ref:`ScrollBar.custom_step` used when clicking the internal scroll bar's horizontal increment and decrement buttons or when using arrow keys when the :ref:`ScrollBar` is focused. @@ -275,8 +275,8 @@ Overrides the :ref:`ScrollBar.custom_step` .. rst-class:: classref-property-setget -- void **set_v_scroll** **(** :ref:`int` value **)** -- :ref:`int` **get_v_scroll** **(** **)** +- |void| **set_v_scroll**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_v_scroll**\ (\ ) The current vertical scroll value. @@ -299,8 +299,8 @@ The current vertical scroll value. .. rst-class:: classref-property-setget -- void **set_vertical_custom_step** **(** :ref:`float` value **)** -- :ref:`float` **get_vertical_custom_step** **(** **)** +- |void| **set_vertical_custom_step**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_vertical_custom_step**\ (\ ) Overrides the :ref:`ScrollBar.custom_step` used when clicking the internal scroll bar's vertical increment and decrement buttons or when using arrow keys when the :ref:`ScrollBar` is focused. @@ -316,8 +316,8 @@ Overrides the :ref:`ScrollBar.custom_step` .. rst-class:: classref-property-setget -- void **set_vertical_scroll_mode** **(** :ref:`ScrollMode` value **)** -- :ref:`ScrollMode` **get_vertical_scroll_mode** **(** **)** +- |void| **set_vertical_scroll_mode**\ (\ value\: :ref:`ScrollMode`\ ) +- :ref:`ScrollMode` **get_vertical_scroll_mode**\ (\ ) Controls whether vertical scrollbar can be used and when it should be visible. See :ref:`ScrollMode` for options. @@ -334,7 +334,7 @@ Method Descriptions .. rst-class:: classref-method -void **ensure_control_visible** **(** :ref:`Control` control **)** +|void| **ensure_control_visible**\ (\ control\: :ref:`Control`\ ) Ensures the given ``control`` is visible (must be a direct or indirect child of the ScrollContainer). Used by :ref:`follow_focus`. @@ -354,7 +354,7 @@ Ensures the given ``control`` is visible (must be a direct or indirect child of .. rst-class:: classref-method -:ref:`HScrollBar` **get_h_scroll_bar** **(** **)** +:ref:`HScrollBar` **get_h_scroll_bar**\ (\ ) Returns the horizontal scrollbar :ref:`HScrollBar` of this **ScrollContainer**. @@ -368,7 +368,7 @@ Returns the horizontal scrollbar :ref:`HScrollBar` of this **S .. rst-class:: classref-method -:ref:`VScrollBar` **get_v_scroll_bar** **(** **)** +:ref:`VScrollBar` **get_v_scroll_bar**\ (\ ) Returns the vertical scrollbar :ref:`VScrollBar` of this **ScrollContainer**. @@ -398,3 +398,4 @@ The background :ref:`StyleBox` of the **ScrollContainer**. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index 43f4f76a080..e2af7dd66a9 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_a** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_a** **(** **)** +- |void| **set_a**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_a**\ (\ ) The segment's first point position. @@ -69,8 +69,8 @@ The segment's first point position. .. rst-class:: classref-property-setget -- void **set_b** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_b** **(** **)** +- |void| **set_b**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_b**\ (\ ) The segment's second point position. @@ -81,3 +81,4 @@ The segment's second point position. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index 58a7cd0f58a..baf9ef65423 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -46,13 +46,13 @@ Methods .. table:: :widths: auto - +-------------------------+--------------------------------------------------------------+ - | void | :ref:`post` **(** **)** | - +-------------------------+--------------------------------------------------------------+ - | :ref:`bool` | :ref:`try_wait` **(** **)** | - +-------------------------+--------------------------------------------------------------+ - | void | :ref:`wait` **(** **)** | - +-------------------------+--------------------------------------------------------------+ + +-------------------------+--------------------------------------------------------+ + | |void| | :ref:`post`\ (\ ) | + +-------------------------+--------------------------------------------------------+ + | :ref:`bool` | :ref:`try_wait`\ (\ ) | + +-------------------------+--------------------------------------------------------+ + | |void| | :ref:`wait`\ (\ ) | + +-------------------------+--------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -67,7 +67,7 @@ Method Descriptions .. rst-class:: classref-method -void **post** **(** **)** +|void| **post**\ (\ ) Lowers the **Semaphore**, allowing one more thread in. @@ -79,7 +79,7 @@ Lowers the **Semaphore**, allowing one more thread in. .. rst-class:: classref-method -:ref:`bool` **try_wait** **(** **)** +:ref:`bool` **try_wait**\ (\ ) Like :ref:`wait`, but won't block, so if the value is zero, fails immediately and returns ``false``. If non-zero, it returns ``true`` to report success. @@ -91,7 +91,7 @@ Like :ref:`wait`, but won't block, so if the value .. rst-class:: classref-method -void **wait** **(** **)** +|void| **wait**\ (\ ) Waits for the **Semaphore**, if its value is zero, blocks until non-zero. @@ -102,3 +102,4 @@ Waits for the **Semaphore**, if its value is zero, blocks until non-zero. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_separationrayshape2d.rst b/classes/class_separationrayshape2d.rst index 195e63fe886..c198df3b6ee 100644 --- a/classes/class_separationrayshape2d.rst +++ b/classes/class_separationrayshape2d.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_length** **(** :ref:`float` value **)** -- :ref:`float` **get_length** **(** **)** +- |void| **set_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_length**\ (\ ) The ray's length. @@ -69,8 +69,8 @@ The ray's length. .. rst-class:: classref-property-setget -- void **set_slide_on_slope** **(** :ref:`bool` value **)** -- :ref:`bool` **get_slide_on_slope** **(** **)** +- |void| **set_slide_on_slope**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_slide_on_slope**\ (\ ) If ``false`` (default), the shape always separates and returns a normal along its own direction. @@ -83,3 +83,4 @@ If ``true``, the shape can return the correct normal and separate in any directi .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_separationrayshape3d.rst b/classes/class_separationrayshape3d.rst index a951f748fee..3090cd92669 100644 --- a/classes/class_separationrayshape3d.rst +++ b/classes/class_separationrayshape3d.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_length** **(** :ref:`float` value **)** -- :ref:`float` **get_length** **(** **)** +- |void| **set_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_length**\ (\ ) The ray's length. @@ -69,8 +69,8 @@ The ray's length. .. rst-class:: classref-property-setget -- void **set_slide_on_slope** **(** :ref:`bool` value **)** -- :ref:`bool` **get_slide_on_slope** **(** **)** +- |void| **set_slide_on_slope**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_slide_on_slope**\ (\ ) If ``false`` (default), the shape always separates and returns a normal along its own direction. @@ -83,3 +83,4 @@ If ``true``, the shape can return the correct normal and separate in any directi .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_separator.rst b/classes/class_separator.rst index ae73f68e7f0..52775b8852d 100644 --- a/classes/class_separator.rst +++ b/classes/class_separator.rst @@ -73,3 +73,4 @@ The style for the separator line. Works best with :ref:`StyleBoxLine` | :ref:`get_default_texture_parameter` **(** :ref:`StringName` name, :ref:`int` index=0 **)** |const| | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Mode` | :ref:`get_mode` **(** **)** |const| | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_shader_uniform_list` **(** :ref:`bool` get_groups=false **)** | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_default_texture_parameter` **(** :ref:`StringName` name, :ref:`Texture2D` texture, :ref:`int` index=0 **)** | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_default_texture_parameter`\ (\ name\: :ref:`StringName`, index\: :ref:`int` = 0\ ) |const| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Mode` | :ref:`get_mode`\ (\ ) |const| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_shader_uniform_list`\ (\ get_groups\: :ref:`bool` = false\ ) | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_default_texture_parameter`\ (\ name\: :ref:`StringName`, texture\: :ref:`Texture2D`, index\: :ref:`int` = 0\ ) | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -134,8 +134,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_code** **(** :ref:`String` value **)** -- :ref:`String` **get_code** **(** **)** +- |void| **set_code**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_code**\ (\ ) Returns the shader's code as the user has written it, not the full generated code used internally. @@ -152,7 +152,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Texture2D` **get_default_texture_parameter** **(** :ref:`StringName` name, :ref:`int` index=0 **)** |const| +:ref:`Texture2D` **get_default_texture_parameter**\ (\ name\: :ref:`StringName`, index\: :ref:`int` = 0\ ) |const| Returns the texture that is set as default for the specified parameter. @@ -168,7 +168,7 @@ Returns the texture that is set as default for the specified parameter. .. rst-class:: classref-method -:ref:`Mode` **get_mode** **(** **)** |const| +:ref:`Mode` **get_mode**\ (\ ) |const| Returns the shader mode for the shader. @@ -180,7 +180,7 @@ Returns the shader mode for the shader. .. rst-class:: classref-method -:ref:`Array` **get_shader_uniform_list** **(** :ref:`bool` get_groups=false **)** +:ref:`Array` **get_shader_uniform_list**\ (\ get_groups\: :ref:`bool` = false\ ) Get the list of shader uniforms that can be assigned to a :ref:`ShaderMaterial`, for use with :ref:`ShaderMaterial.set_shader_parameter` and :ref:`ShaderMaterial.get_shader_parameter`. The parameters returned are contained in dictionaries in a similar format to the ones returned by :ref:`Object.get_property_list`. @@ -194,7 +194,7 @@ If argument ``get_groups`` is true, parameter grouping hints will be provided. .. rst-class:: classref-method -void **set_default_texture_parameter** **(** :ref:`StringName` name, :ref:`Texture2D` texture, :ref:`int` index=0 **)** +|void| **set_default_texture_parameter**\ (\ name\: :ref:`StringName`, texture\: :ref:`Texture2D`, index\: :ref:`int` = 0\ ) Sets the default texture to be used with a texture uniform. The default is used if a texture is not set in the :ref:`ShaderMaterial`. @@ -209,3 +209,4 @@ Sets the default texture to be used with a texture uniform. The default is used .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_shaderglobalsoverride.rst b/classes/class_shaderglobalsoverride.rst index bdb325568b4..055dad2b6ce 100644 --- a/classes/class_shaderglobalsoverride.rst +++ b/classes/class_shaderglobalsoverride.rst @@ -39,3 +39,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_shaderinclude.rst b/classes/class_shaderinclude.rst index 476aa7fbac9..00828fda3d5 100644 --- a/classes/class_shaderinclude.rst +++ b/classes/class_shaderinclude.rst @@ -57,8 +57,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_code** **(** :ref:`String` value **)** -- :ref:`String` **get_code** **(** **)** +- |void| **set_code**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_code**\ (\ ) Returns the code of the shader include file. The returned text is what the user has written, not the full generated code used internally. @@ -69,3 +69,4 @@ Returns the code of the shader include file. The returned text is what the user .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index f8486d315b7..5bb12d5d721 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -52,11 +52,11 @@ Methods .. table:: :widths: auto - +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_shader_parameter` **(** :ref:`StringName` param **)** |const| | - +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_shader_parameter` **(** :ref:`StringName` param, :ref:`Variant` value **)** | - +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_shader_parameter`\ (\ param\: :ref:`StringName`\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_shader_parameter`\ (\ param\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -75,8 +75,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_shader** **(** :ref:`Shader` value **)** -- :ref:`Shader` **get_shader** **(** **)** +- |void| **set_shader**\ (\ value\: :ref:`Shader`\ ) +- :ref:`Shader` **get_shader**\ (\ ) The :ref:`Shader` program used to render this material. @@ -93,7 +93,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **get_shader_parameter** **(** :ref:`StringName` param **)** |const| +:ref:`Variant` **get_shader_parameter**\ (\ param\: :ref:`StringName`\ ) |const| Returns the current value set for this material of a uniform in the shader. @@ -105,7 +105,7 @@ Returns the current value set for this material of a uniform in the shader. .. rst-class:: classref-method -void **set_shader_parameter** **(** :ref:`StringName` param, :ref:`Variant` value **)** +|void| **set_shader_parameter**\ (\ param\: :ref:`StringName`, value\: :ref:`Variant`\ ) Changes the value set for this material of a uniform in the shader. @@ -120,3 +120,4 @@ Changes the value set for this material of a uniform in the shader. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index c0c9c2c379a..bbfbd3527d9 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -52,19 +52,19 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`collide` **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`collide_and_get_contacts` **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`collide_with_motion` **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`collide_with_motion_and_get_contacts` **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Color` color **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_rect` **(** **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`collide`\ (\ local_xform\: :ref:`Transform2D`, with_shape\: :ref:`Shape2D`, shape_xform\: :ref:`Transform2D`\ ) | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`collide_and_get_contacts`\ (\ local_xform\: :ref:`Transform2D`, with_shape\: :ref:`Shape2D`, shape_xform\: :ref:`Transform2D`\ ) | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`collide_with_motion`\ (\ local_xform\: :ref:`Transform2D`, local_motion\: :ref:`Vector2`, with_shape\: :ref:`Shape2D`, shape_xform\: :ref:`Transform2D`, shape_motion\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`collide_with_motion_and_get_contacts`\ (\ local_xform\: :ref:`Transform2D`, local_motion\: :ref:`Vector2`, with_shape\: :ref:`Shape2D`, shape_xform\: :ref:`Transform2D`, shape_motion\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw`\ (\ canvas_item\: :ref:`RID`, color\: :ref:`Color`\ ) | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_rect`\ (\ ) |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -83,8 +83,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_custom_solver_bias** **(** :ref:`float` value **)** -- :ref:`float` **get_custom_solver_bias** **(** **)** +- |void| **set_custom_solver_bias**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_custom_solver_bias**\ (\ ) The shape's custom solver bias. Defines how much bodies react to enforce contact separation when this shape is involved. @@ -103,7 +103,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **collide** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** +:ref:`bool` **collide**\ (\ local_xform\: :ref:`Transform2D`, with_shape\: :ref:`Shape2D`, shape_xform\: :ref:`Transform2D`\ ) Returns ``true`` if this shape is colliding with another. @@ -117,7 +117,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th .. rst-class:: classref-method -:ref:`PackedVector2Array` **collide_and_get_contacts** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** +:ref:`PackedVector2Array` **collide_and_get_contacts**\ (\ local_xform\: :ref:`Transform2D`, with_shape\: :ref:`Shape2D`, shape_xform\: :ref:`Transform2D`\ ) Returns a list of contact point pairs where this shape touches another. @@ -135,7 +135,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th .. rst-class:: classref-method -:ref:`bool` **collide_with_motion** **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** +:ref:`bool` **collide_with_motion**\ (\ local_xform\: :ref:`Transform2D`, local_motion\: :ref:`Vector2`, with_shape\: :ref:`Shape2D`, shape_xform\: :ref:`Transform2D`, shape_motion\: :ref:`Vector2`\ ) Returns whether this shape would collide with another, if a given movement was applied. @@ -149,7 +149,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th .. rst-class:: classref-method -:ref:`PackedVector2Array` **collide_with_motion_and_get_contacts** **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** +:ref:`PackedVector2Array` **collide_with_motion_and_get_contacts**\ (\ local_xform\: :ref:`Transform2D`, local_motion\: :ref:`Vector2`, with_shape\: :ref:`Shape2D`, shape_xform\: :ref:`Transform2D`, shape_motion\: :ref:`Vector2`\ ) Returns a list of contact point pairs where this shape would touch another, if a given movement was applied. @@ -167,7 +167,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th .. rst-class:: classref-method -void **draw** **(** :ref:`RID` canvas_item, :ref:`Color` color **)** +|void| **draw**\ (\ canvas_item\: :ref:`RID`, color\: :ref:`Color`\ ) Draws a solid shape onto a :ref:`CanvasItem` with the :ref:`RenderingServer` API filled with the specified ``color``. The exact drawing method is specific for each shape and cannot be configured. @@ -179,7 +179,7 @@ Draws a solid shape onto a :ref:`CanvasItem` with the :ref:`Re .. rst-class:: classref-method -:ref:`Rect2` **get_rect** **(** **)** |const| +:ref:`Rect2` **get_rect**\ (\ ) |const| Returns a :ref:`Rect2` representing the shapes boundary. @@ -190,3 +190,4 @@ Returns a :ref:`Rect2` representing the shapes boundary. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_shape3d.rst b/classes/class_shape3d.rst index eaad3974c95..f1df6c19616 100644 --- a/classes/class_shape3d.rst +++ b/classes/class_shape3d.rst @@ -54,9 +54,9 @@ Methods .. table:: :widths: auto - +-----------------------------------+------------------------------------------------------------------------+ - | :ref:`ArrayMesh` | :ref:`get_debug_mesh` **(** **)** | - +-----------------------------------+------------------------------------------------------------------------+ + +-----------------------------------+------------------------------------------------------------------+ + | :ref:`ArrayMesh` | :ref:`get_debug_mesh`\ (\ ) | + +-----------------------------------+------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -75,8 +75,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_custom_solver_bias** **(** :ref:`float` value **)** -- :ref:`float` **get_custom_solver_bias** **(** **)** +- |void| **set_custom_solver_bias**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_custom_solver_bias**\ (\ ) The shape's custom solver bias. Defines how much bodies react to enforce contact separation when this shape is involved. @@ -94,8 +94,8 @@ When set to ``0``, the default value from :ref:`ProjectSettings.physics/3d/solve .. rst-class:: classref-property-setget -- void **set_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_margin** **(** **)** +- |void| **set_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_margin**\ (\ ) The collision margin for the shape. This is not used in Godot Physics. @@ -114,7 +114,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`ArrayMesh` **get_debug_mesh** **(** **)** +:ref:`ArrayMesh` **get_debug_mesh**\ (\ ) Returns the :ref:`ArrayMesh` used to draw the debug collision for this **Shape3D**. @@ -125,3 +125,4 @@ Returns the :ref:`ArrayMesh` used to draw the debug collision f .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_shapecast2d.rst b/classes/class_shapecast2d.rst index 5e25c1871dd..ee7ed2c9a50 100644 --- a/classes/class_shapecast2d.rst +++ b/classes/class_shapecast2d.rst @@ -63,41 +63,41 @@ Methods .. table:: :widths: auto - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_exception` **(** :ref:`CollisionObject2D` node **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_exceptions` **(** **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`force_shapecast_update` **(** **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_closest_collision_safe_fraction` **(** **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_closest_collision_unsafe_fraction` **(** **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_collider` **(** :ref:`int` index **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_collider_rid` **(** :ref:`int` index **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collider_shape` **(** :ref:`int` index **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collision_count` **(** **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_collision_mask_value` **(** :ref:`int` layer_number **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_collision_normal` **(** :ref:`int` index **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_collision_point` **(** :ref:`int` index **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_colliding` **(** **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_exception` **(** :ref:`CollisionObject2D` node **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_exception`\ (\ node\: :ref:`CollisionObject2D`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_exception_rid`\ (\ rid\: :ref:`RID`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_exceptions`\ (\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_shapecast_update`\ (\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_closest_collision_safe_fraction`\ (\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_closest_collision_unsafe_fraction`\ (\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_collider`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_collider_rid`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collider_shape`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collision_count`\ (\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_collision_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_collision_normal`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_collision_point`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_colliding`\ (\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_exception`\ (\ node\: :ref:`CollisionObject2D`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_exception_rid`\ (\ rid\: :ref:`RID`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -116,8 +116,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_collide_with_areas** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_areas_enabled** **(** **)** +- |void| **set_collide_with_areas**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_areas_enabled**\ (\ ) If ``true``, collisions with :ref:`Area2D`\ s will be reported. @@ -133,8 +133,8 @@ If ``true``, collisions with :ref:`Area2D`\ s will be reported. .. rst-class:: classref-property-setget -- void **set_collide_with_bodies** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_bodies_enabled** **(** **)** +- |void| **set_collide_with_bodies**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_bodies_enabled**\ (\ ) If ``true``, collisions with :ref:`PhysicsBody2D`\ s will be reported. @@ -150,8 +150,8 @@ If ``true``, collisions with :ref:`PhysicsBody2D`\ s will b .. rst-class:: classref-property-setget -- void **set_collision_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_mask** **(** **)** +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) The shape's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. @@ -179,8 +179,8 @@ Returns the complete collision information from the collision sweep. The data re .. rst-class:: classref-property-setget -- void **set_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_enabled** **(** **)** +- |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_enabled**\ (\ ) If ``true``, collisions will be reported. @@ -196,8 +196,8 @@ If ``true``, collisions will be reported. .. rst-class:: classref-property-setget -- void **set_exclude_parent_body** **(** :ref:`bool` value **)** -- :ref:`bool` **get_exclude_parent_body** **(** **)** +- |void| **set_exclude_parent_body**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_exclude_parent_body**\ (\ ) If ``true``, the parent node will be excluded from collision detection. @@ -213,8 +213,8 @@ If ``true``, the parent node will be excluded from collision detection. .. rst-class:: classref-property-setget -- void **set_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_margin** **(** **)** +- |void| **set_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_margin**\ (\ ) The collision margin for the shape. A larger margin helps detecting collisions more consistently, at the cost of precision. @@ -230,8 +230,8 @@ The collision margin for the shape. A larger margin helps detecting collisions m .. rst-class:: classref-property-setget -- void **set_max_results** **(** :ref:`int` value **)** -- :ref:`int` **get_max_results** **(** **)** +- |void| **set_max_results**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_results**\ (\ ) The number of intersections can be limited with this parameter, to reduce the processing time. @@ -247,8 +247,8 @@ The number of intersections can be limited with this parameter, to reduce the pr .. rst-class:: classref-property-setget -- void **set_shape** **(** :ref:`Shape2D` value **)** -- :ref:`Shape2D` **get_shape** **(** **)** +- |void| **set_shape**\ (\ value\: :ref:`Shape2D`\ ) +- :ref:`Shape2D` **get_shape**\ (\ ) The :ref:`Shape2D`-derived shape to be used for collision queries. @@ -264,8 +264,8 @@ The :ref:`Shape2D`-derived shape to be used for collision queries .. rst-class:: classref-property-setget -- void **set_target_position** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_target_position** **(** **)** +- |void| **set_target_position**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_target_position**\ (\ ) The shape's destination point, relative to this node's ``position``. @@ -282,7 +282,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_exception** **(** :ref:`CollisionObject2D` node **)** +|void| **add_exception**\ (\ node\: :ref:`CollisionObject2D`\ ) Adds a collision exception so the shape does not report collisions with the specified :ref:`CollisionObject2D` node. @@ -294,7 +294,7 @@ Adds a collision exception so the shape does not report collisions with the spec .. rst-class:: classref-method -void **add_exception_rid** **(** :ref:`RID` rid **)** +|void| **add_exception_rid**\ (\ rid\: :ref:`RID`\ ) Adds a collision exception so the shape does not report collisions with the specified :ref:`RID`. @@ -306,7 +306,7 @@ Adds a collision exception so the shape does not report collisions with the spec .. rst-class:: classref-method -void **clear_exceptions** **(** **)** +|void| **clear_exceptions**\ (\ ) Removes all collision exceptions for this shape. @@ -318,7 +318,7 @@ Removes all collision exceptions for this shape. .. rst-class:: classref-method -void **force_shapecast_update** **(** **)** +|void| **force_shapecast_update**\ (\ ) Updates the collision information for the shape immediately, without waiting for the next ``_physics_process`` call. Use this method, for example, when the shape or its parent has changed state. @@ -332,7 +332,7 @@ Updates the collision information for the shape immediately, without waiting for .. rst-class:: classref-method -:ref:`float` **get_closest_collision_safe_fraction** **(** **)** |const| +:ref:`float` **get_closest_collision_safe_fraction**\ (\ ) |const| The fraction from the **ShapeCast2D**'s origin to its :ref:`target_position` (between 0 and 1) of how far the shape can move without triggering a collision. @@ -344,7 +344,7 @@ The fraction from the **ShapeCast2D**'s origin to its :ref:`target_position` **get_closest_collision_unsafe_fraction** **(** **)** |const| +:ref:`float` **get_closest_collision_unsafe_fraction**\ (\ ) |const| The fraction from the **ShapeCast2D**'s origin to its :ref:`target_position` (between 0 and 1) of how far the shape must move to trigger a collision. @@ -356,7 +356,7 @@ The fraction from the **ShapeCast2D**'s origin to its :ref:`target_position` **get_collider** **(** :ref:`int` index **)** |const| +:ref:`Object` **get_collider**\ (\ index\: :ref:`int`\ ) |const| Returns the collided :ref:`Object` of one of the multiple collisions at ``index``, or ``null`` if no object is intersecting the shape (i.e. :ref:`is_colliding` returns ``false``). @@ -368,7 +368,7 @@ Returns the collided :ref:`Object` of one of the multiple collisio .. rst-class:: classref-method -:ref:`RID` **get_collider_rid** **(** :ref:`int` index **)** |const| +:ref:`RID` **get_collider_rid**\ (\ index\: :ref:`int`\ ) |const| Returns the :ref:`RID` of the collided object of one of the multiple collisions at ``index``. @@ -380,7 +380,7 @@ Returns the :ref:`RID` of the collided object of one of the multiple .. rst-class:: classref-method -:ref:`int` **get_collider_shape** **(** :ref:`int` index **)** |const| +:ref:`int` **get_collider_shape**\ (\ index\: :ref:`int`\ ) |const| Returns the shape ID of the colliding shape of one of the multiple collisions at ``index``, or ``0`` if no object is intersecting the shape (i.e. :ref:`is_colliding` returns ``false``). @@ -392,7 +392,7 @@ Returns the shape ID of the colliding shape of one of the multiple collisions at .. rst-class:: classref-method -:ref:`int` **get_collision_count** **(** **)** |const| +:ref:`int` **get_collision_count**\ (\ ) |const| The number of collisions detected at the point of impact. Use this to iterate over multiple collisions as provided by :ref:`get_collider`, :ref:`get_collider_shape`, :ref:`get_collision_point`, and :ref:`get_collision_normal` methods. @@ -404,7 +404,7 @@ The number of collisions detected at the point of impact. Use this to iterate ov .. rst-class:: classref-method -:ref:`bool` **get_collision_mask_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -416,7 +416,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_collision_normal** **(** :ref:`int` index **)** |const| +:ref:`Vector2` **get_collision_normal**\ (\ index\: :ref:`int`\ ) |const| Returns the normal of one of the multiple collisions at ``index`` of the intersecting object. @@ -428,7 +428,7 @@ Returns the normal of one of the multiple collisions at ``index`` of the interse .. rst-class:: classref-method -:ref:`Vector2` **get_collision_point** **(** :ref:`int` index **)** |const| +:ref:`Vector2` **get_collision_point**\ (\ index\: :ref:`int`\ ) |const| Returns the collision point of one of the multiple collisions at ``index`` where the shape intersects the colliding object. @@ -442,7 +442,7 @@ Returns the collision point of one of the multiple collisions at ``index`` where .. rst-class:: classref-method -:ref:`bool` **is_colliding** **(** **)** |const| +:ref:`bool` **is_colliding**\ (\ ) |const| Returns whether any object is intersecting with the shape's vector (considering the vector length). @@ -454,7 +454,7 @@ Returns whether any object is intersecting with the shape's vector (considering .. rst-class:: classref-method -void **remove_exception** **(** :ref:`CollisionObject2D` node **)** +|void| **remove_exception**\ (\ node\: :ref:`CollisionObject2D`\ ) Removes a collision exception so the shape does report collisions with the specified :ref:`CollisionObject2D` node. @@ -466,7 +466,7 @@ Removes a collision exception so the shape does report collisions with the speci .. rst-class:: classref-method -void **remove_exception_rid** **(** :ref:`RID` rid **)** +|void| **remove_exception_rid**\ (\ rid\: :ref:`RID`\ ) Removes a collision exception so the shape does report collisions with the specified :ref:`RID`. @@ -478,7 +478,7 @@ Removes a collision exception so the shape does report collisions with the speci .. rst-class:: classref-method -void **set_collision_mask_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. @@ -489,3 +489,4 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_shapecast3d.rst b/classes/class_shapecast3d.rst index 9ad787cfb36..9854997bad6 100644 --- a/classes/class_shapecast3d.rst +++ b/classes/class_shapecast3d.rst @@ -65,43 +65,43 @@ Methods .. table:: :widths: auto - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_exception` **(** :ref:`CollisionObject3D` node **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_exceptions` **(** **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`force_shapecast_update` **(** **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_closest_collision_safe_fraction` **(** **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_closest_collision_unsafe_fraction` **(** **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_collider` **(** :ref:`int` index **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_collider_rid` **(** :ref:`int` index **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collider_shape` **(** :ref:`int` index **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collision_count` **(** **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_collision_mask_value` **(** :ref:`int` layer_number **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_collision_normal` **(** :ref:`int` index **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_collision_point` **(** :ref:`int` index **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_colliding` **(** **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_exception` **(** :ref:`CollisionObject3D` node **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_exception`\ (\ node\: :ref:`CollisionObject3D`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_exception_rid`\ (\ rid\: :ref:`RID`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_exceptions`\ (\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_shapecast_update`\ (\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_closest_collision_safe_fraction`\ (\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_closest_collision_unsafe_fraction`\ (\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_collider`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_collider_rid`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collider_shape`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collision_count`\ (\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_collision_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_collision_normal`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_collision_point`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_colliding`\ (\ ) |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_exception`\ (\ node\: :ref:`CollisionObject3D`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_exception_rid`\ (\ rid\: :ref:`RID`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`resource_changed`\ (\ resource\: :ref:`Resource`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -120,8 +120,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_collide_with_areas** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_areas_enabled** **(** **)** +- |void| **set_collide_with_areas**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_areas_enabled**\ (\ ) If ``true``, collisions with :ref:`Area3D`\ s will be reported. @@ -137,8 +137,8 @@ If ``true``, collisions with :ref:`Area3D`\ s will be reported. .. rst-class:: classref-property-setget -- void **set_collide_with_bodies** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collide_with_bodies_enabled** **(** **)** +- |void| **set_collide_with_bodies**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collide_with_bodies_enabled**\ (\ ) If ``true``, collisions with :ref:`PhysicsBody3D`\ s will be reported. @@ -154,8 +154,8 @@ If ``true``, collisions with :ref:`PhysicsBody3D`\ s will b .. rst-class:: classref-property-setget -- void **set_collision_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_mask** **(** **)** +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) The shape's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information. @@ -183,8 +183,8 @@ Returns the complete collision information from the collision sweep. The data re .. rst-class:: classref-property-setget -- void **set_debug_shape_custom_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_debug_shape_custom_color** **(** **)** +- |void| **set_debug_shape_custom_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_debug_shape_custom_color**\ (\ ) The custom color to use to draw the shape in the editor and at run-time if **Visible Collision Shapes** is enabled in the **Debug** menu. This color will be highlighted at run-time if the **ShapeCast3D** is colliding with something. @@ -202,8 +202,8 @@ If set to ``Color(0.0, 0.0, 0.0)`` (by default), the color set in :ref:`ProjectS .. rst-class:: classref-property-setget -- void **set_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_enabled** **(** **)** +- |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_enabled**\ (\ ) If ``true``, collisions will be reported. @@ -219,8 +219,8 @@ If ``true``, collisions will be reported. .. rst-class:: classref-property-setget -- void **set_exclude_parent_body** **(** :ref:`bool` value **)** -- :ref:`bool` **get_exclude_parent_body** **(** **)** +- |void| **set_exclude_parent_body**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_exclude_parent_body**\ (\ ) If ``true``, the parent node will be excluded from collision detection. @@ -236,8 +236,8 @@ If ``true``, the parent node will be excluded from collision detection. .. rst-class:: classref-property-setget -- void **set_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_margin** **(** **)** +- |void| **set_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_margin**\ (\ ) The collision margin for the shape. A larger margin helps detecting collisions more consistently, at the cost of precision. @@ -253,8 +253,8 @@ The collision margin for the shape. A larger margin helps detecting collisions m .. rst-class:: classref-property-setget -- void **set_max_results** **(** :ref:`int` value **)** -- :ref:`int` **get_max_results** **(** **)** +- |void| **set_max_results**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_results**\ (\ ) The number of intersections can be limited with this parameter, to reduce the processing time. @@ -270,8 +270,8 @@ The number of intersections can be limited with this parameter, to reduce the pr .. rst-class:: classref-property-setget -- void **set_shape** **(** :ref:`Shape3D` value **)** -- :ref:`Shape3D` **get_shape** **(** **)** +- |void| **set_shape**\ (\ value\: :ref:`Shape3D`\ ) +- :ref:`Shape3D` **get_shape**\ (\ ) The :ref:`Shape3D`-derived shape to be used for collision queries. @@ -287,8 +287,8 @@ The :ref:`Shape3D`-derived shape to be used for collision queries .. rst-class:: classref-property-setget -- void **set_target_position** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_target_position** **(** **)** +- |void| **set_target_position**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_target_position**\ (\ ) The shape's destination point, relative to this node's ``position``. @@ -305,7 +305,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_exception** **(** :ref:`CollisionObject3D` node **)** +|void| **add_exception**\ (\ node\: :ref:`CollisionObject3D`\ ) Adds a collision exception so the shape does not report collisions with the specified :ref:`CollisionObject3D` node. @@ -317,7 +317,7 @@ Adds a collision exception so the shape does not report collisions with the spec .. rst-class:: classref-method -void **add_exception_rid** **(** :ref:`RID` rid **)** +|void| **add_exception_rid**\ (\ rid\: :ref:`RID`\ ) Adds a collision exception so the shape does not report collisions with the specified :ref:`RID`. @@ -329,7 +329,7 @@ Adds a collision exception so the shape does not report collisions with the spec .. rst-class:: classref-method -void **clear_exceptions** **(** **)** +|void| **clear_exceptions**\ (\ ) Removes all collision exceptions for this **ShapeCast3D**. @@ -341,7 +341,7 @@ Removes all collision exceptions for this **ShapeCast3D**. .. rst-class:: classref-method -void **force_shapecast_update** **(** **)** +|void| **force_shapecast_update**\ (\ ) Updates the collision information for the shape immediately, without waiting for the next ``_physics_process`` call. Use this method, for example, when the shape or its parent has changed state. @@ -355,7 +355,7 @@ Updates the collision information for the shape immediately, without waiting for .. rst-class:: classref-method -:ref:`float` **get_closest_collision_safe_fraction** **(** **)** |const| +:ref:`float` **get_closest_collision_safe_fraction**\ (\ ) |const| The fraction from the **ShapeCast3D**'s origin to its :ref:`target_position` (between 0 and 1) of how far the shape can move without triggering a collision. @@ -367,7 +367,7 @@ The fraction from the **ShapeCast3D**'s origin to its :ref:`target_position` **get_closest_collision_unsafe_fraction** **(** **)** |const| +:ref:`float` **get_closest_collision_unsafe_fraction**\ (\ ) |const| The fraction from the **ShapeCast3D**'s origin to its :ref:`target_position` (between 0 and 1) of how far the shape must move to trigger a collision. @@ -379,7 +379,7 @@ The fraction from the **ShapeCast3D**'s origin to its :ref:`target_position` **get_collider** **(** :ref:`int` index **)** |const| +:ref:`Object` **get_collider**\ (\ index\: :ref:`int`\ ) |const| Returns the collided :ref:`Object` of one of the multiple collisions at ``index``, or ``null`` if no object is intersecting the shape (i.e. :ref:`is_colliding` returns ``false``). @@ -391,7 +391,7 @@ Returns the collided :ref:`Object` of one of the multiple collisio .. rst-class:: classref-method -:ref:`RID` **get_collider_rid** **(** :ref:`int` index **)** |const| +:ref:`RID` **get_collider_rid**\ (\ index\: :ref:`int`\ ) |const| Returns the :ref:`RID` of the collided object of one of the multiple collisions at ``index``. @@ -403,7 +403,7 @@ Returns the :ref:`RID` of the collided object of one of the multiple .. rst-class:: classref-method -:ref:`int` **get_collider_shape** **(** :ref:`int` index **)** |const| +:ref:`int` **get_collider_shape**\ (\ index\: :ref:`int`\ ) |const| Returns the shape ID of the colliding shape of one of the multiple collisions at ``index``, or ``0`` if no object is intersecting the shape (i.e. :ref:`is_colliding` returns ``false``). @@ -415,7 +415,7 @@ Returns the shape ID of the colliding shape of one of the multiple collisions at .. rst-class:: classref-method -:ref:`int` **get_collision_count** **(** **)** |const| +:ref:`int` **get_collision_count**\ (\ ) |const| The number of collisions detected at the point of impact. Use this to iterate over multiple collisions as provided by :ref:`get_collider`, :ref:`get_collider_shape`, :ref:`get_collision_point`, and :ref:`get_collision_normal` methods. @@ -427,7 +427,7 @@ The number of collisions detected at the point of impact. Use this to iterate ov .. rst-class:: classref-method -:ref:`bool` **get_collision_mask_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -439,7 +439,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_collision_normal** **(** :ref:`int` index **)** |const| +:ref:`Vector3` **get_collision_normal**\ (\ index\: :ref:`int`\ ) |const| Returns the normal of one of the multiple collisions at ``index`` of the intersecting object. @@ -451,7 +451,7 @@ Returns the normal of one of the multiple collisions at ``index`` of the interse .. rst-class:: classref-method -:ref:`Vector3` **get_collision_point** **(** :ref:`int` index **)** |const| +:ref:`Vector3` **get_collision_point**\ (\ index\: :ref:`int`\ ) |const| Returns the collision point of one of the multiple collisions at ``index`` where the shape intersects the colliding object. @@ -465,7 +465,7 @@ Returns the collision point of one of the multiple collisions at ``index`` where .. rst-class:: classref-method -:ref:`bool` **is_colliding** **(** **)** |const| +:ref:`bool` **is_colliding**\ (\ ) |const| Returns whether any object is intersecting with the shape's vector (considering the vector length). @@ -477,7 +477,7 @@ Returns whether any object is intersecting with the shape's vector (considering .. rst-class:: classref-method -void **remove_exception** **(** :ref:`CollisionObject3D` node **)** +|void| **remove_exception**\ (\ node\: :ref:`CollisionObject3D`\ ) Removes a collision exception so the shape does report collisions with the specified :ref:`CollisionObject3D` node. @@ -489,7 +489,7 @@ Removes a collision exception so the shape does report collisions with the speci .. rst-class:: classref-method -void **remove_exception_rid** **(** :ref:`RID` rid **)** +|void| **remove_exception_rid**\ (\ rid\: :ref:`RID`\ ) Removes a collision exception so the shape does report collisions with the specified :ref:`RID`. @@ -501,7 +501,7 @@ Removes a collision exception so the shape does report collisions with the speci .. rst-class:: classref-method -void **resource_changed** **(** :ref:`Resource` resource **)** +|void| **resource_changed**\ (\ resource\: :ref:`Resource`\ ) **Deprecated:** Use :ref:`Resource.changed` instead. @@ -515,7 +515,7 @@ This method does nothing. .. rst-class:: classref-method -void **set_collision_mask_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. @@ -526,3 +526,4 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_shortcut.rst b/classes/class_shortcut.rst index 2b6275b6b7b..ab9e8e7f945 100644 --- a/classes/class_shortcut.rst +++ b/classes/class_shortcut.rst @@ -43,13 +43,13 @@ Methods .. table:: :widths: auto - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_as_text` **(** **)** |const| | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_valid_event` **(** **)** |const| | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`matches_event` **(** :ref:`InputEvent` event **)** |const| | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_as_text`\ (\ ) |const| | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_valid_event`\ (\ ) |const| | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`matches_event`\ (\ event\: :ref:`InputEvent`\ ) |const| | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -68,8 +68,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_events** **(** :ref:`Array` value **)** -- :ref:`Array` **get_events** **(** **)** +- |void| **set_events**\ (\ value\: :ref:`Array`\ ) +- :ref:`Array` **get_events**\ (\ ) The shortcut's :ref:`InputEvent` array. @@ -88,7 +88,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **get_as_text** **(** **)** |const| +:ref:`String` **get_as_text**\ (\ ) |const| Returns the shortcut's first valid :ref:`InputEvent` as a :ref:`String`. @@ -100,7 +100,7 @@ Returns the shortcut's first valid :ref:`InputEvent` as a :ref .. rst-class:: classref-method -:ref:`bool` **has_valid_event** **(** **)** |const| +:ref:`bool` **has_valid_event**\ (\ ) |const| Returns whether :ref:`events` contains an :ref:`InputEvent` which is valid. @@ -112,7 +112,7 @@ Returns whether :ref:`events` contains an :ref:` .. rst-class:: classref-method -:ref:`bool` **matches_event** **(** :ref:`InputEvent` event **)** |const| +:ref:`bool` **matches_event**\ (\ event\: :ref:`InputEvent`\ ) |const| Returns whether any :ref:`InputEvent` in :ref:`events` equals ``event``. @@ -123,3 +123,4 @@ Returns whether any :ref:`InputEvent` in :ref:`events` | :ref:`Signal` **(** **)** | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Signal` | :ref:`Signal` **(** :ref:`Signal` from **)** | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Signal` | :ref:`Signal` **(** :ref:`Object` object, :ref:`StringName` signal **)** | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Signal` | :ref:`Signal`\ (\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Signal` | :ref:`Signal`\ (\ from\: :ref:`Signal`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Signal` | :ref:`Signal`\ (\ object\: :ref:`Object`, signal\: :ref:`StringName`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -81,25 +81,25 @@ Methods .. table:: :widths: auto - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`connect` **(** :ref:`Callable` callable, :ref:`int` flags=0 **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`disconnect` **(** :ref:`Callable` callable **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`emit` **(** ... **)** |vararg| |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_connections` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_name` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`get_object` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_object_id` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_connected` **(** :ref:`Callable` callable **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_null` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`connect`\ (\ callable\: :ref:`Callable`, flags\: :ref:`int` = 0\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`disconnect`\ (\ callable\: :ref:`Callable`\ ) | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`emit`\ (\ ...\ ) |vararg| |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_connections`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_name`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_object`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_object_id`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_connected`\ (\ callable\: :ref:`Callable`\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_null`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -109,11 +109,11 @@ Operators .. table:: :widths: auto - +-------------------------+----------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Signal` right **)** | - +-------------------------+----------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Signal` right **)** | - +-------------------------+----------------------------------------------------------------------------------------------------+ + +-------------------------+-------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Signal`\ ) | + +-------------------------+-------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Signal`\ ) | + +-------------------------+-------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -128,7 +128,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Signal` **Signal** **(** **)** +:ref:`Signal` **Signal**\ (\ ) Constructs an empty **Signal** with no object nor signal name bound. @@ -138,7 +138,7 @@ Constructs an empty **Signal** with no object nor signal name bound. .. rst-class:: classref-constructor -:ref:`Signal` **Signal** **(** :ref:`Signal` from **)** +:ref:`Signal` **Signal**\ (\ from\: :ref:`Signal`\ ) Constructs a **Signal** as a copy of the given **Signal**. @@ -148,7 +148,7 @@ Constructs a **Signal** as a copy of the given **Signal**. .. rst-class:: classref-constructor -:ref:`Signal` **Signal** **(** :ref:`Object` object, :ref:`StringName` signal **)** +:ref:`Signal` **Signal**\ (\ object\: :ref:`Object`, signal\: :ref:`StringName`\ ) Creates a new **Signal** named ``signal`` in the specified ``object``. @@ -165,7 +165,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **connect** **(** :ref:`Callable` callable, :ref:`int` flags=0 **)** +:ref:`int` **connect**\ (\ callable\: :ref:`Callable`, flags\: :ref:`int` = 0\ ) Connects this signal to the specified ``callable``. Optional ``flags`` can be also added to configure the connection's behavior (see :ref:`ConnectFlags` constants). You can provide additional arguments to the connected ``callable`` by using :ref:`Callable.bind`. @@ -187,7 +187,7 @@ A signal can only be connected once to the same :ref:`Callable`. .. rst-class:: classref-method -void **disconnect** **(** :ref:`Callable` callable **)** +|void| **disconnect**\ (\ callable\: :ref:`Callable`\ ) Disconnects this signal from the specified :ref:`Callable`. If the connection does not exist, generates an error. Use :ref:`is_connected` to make sure that the connection exists. @@ -199,7 +199,7 @@ Disconnects this signal from the specified :ref:`Callable`. If t .. rst-class:: classref-method -void **emit** **(** ... **)** |vararg| |const| +|void| **emit**\ (\ ...\ ) |vararg| |const| Emits this signal. All :ref:`Callable`\ s connected to this signal will be triggered. This method supports a variable number of arguments, so parameters can be passed as a comma separated list. @@ -211,7 +211,7 @@ Emits this signal. All :ref:`Callable`\ s connected to this sign .. rst-class:: classref-method -:ref:`Array` **get_connections** **(** **)** |const| +:ref:`Array` **get_connections**\ (\ ) |const| Returns an :ref:`Array` of connections for this signal. Each connection is represented as a :ref:`Dictionary` that contains three entries: @@ -229,7 +229,7 @@ Returns an :ref:`Array` of connections for this signal. Each connec .. rst-class:: classref-method -:ref:`StringName` **get_name** **(** **)** |const| +:ref:`StringName` **get_name**\ (\ ) |const| Returns the name of this signal. @@ -241,7 +241,7 @@ Returns the name of this signal. .. rst-class:: classref-method -:ref:`Object` **get_object** **(** **)** |const| +:ref:`Object` **get_object**\ (\ ) |const| Returns the object emitting this signal. @@ -253,7 +253,7 @@ Returns the object emitting this signal. .. rst-class:: classref-method -:ref:`int` **get_object_id** **(** **)** |const| +:ref:`int` **get_object_id**\ (\ ) |const| Returns the ID of the object emitting this signal (see :ref:`Object.get_instance_id`). @@ -265,7 +265,7 @@ Returns the ID of the object emitting this signal (see :ref:`Object.get_instance .. rst-class:: classref-method -:ref:`bool` **is_connected** **(** :ref:`Callable` callable **)** |const| +:ref:`bool` **is_connected**\ (\ callable\: :ref:`Callable`\ ) |const| Returns ``true`` if the specified :ref:`Callable` is connected to this signal. @@ -277,7 +277,7 @@ Returns ``true`` if the specified :ref:`Callable` is connected t .. rst-class:: classref-method -:ref:`bool` **is_null** **(** **)** |const| +:ref:`bool` **is_null**\ (\ ) |const| Returns ``true`` if the signal's name does not exist in its object, or the object is not valid. @@ -294,7 +294,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Signal` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Signal`\ ) Returns ``true`` if the signals do not share the same object and name. @@ -306,7 +306,7 @@ Returns ``true`` if the signals do not share the same object and name. .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`Signal` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Signal`\ ) Returns ``true`` if both signals share the same object and name. @@ -317,3 +317,4 @@ Returns ``true`` if both signals share the same object and name. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_skeleton2d.rst b/classes/class_skeleton2d.rst index 10ba21be770..334dc2ad873 100644 --- a/classes/class_skeleton2d.rst +++ b/classes/class_skeleton2d.rst @@ -38,23 +38,23 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`execute_modifications` **(** :ref:`float` delta, :ref:`int` execution_mode **)** | - +-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Bone2D` | :ref:`get_bone` **(** :ref:`int` idx **)** | - +-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_bone_count` **(** **)** |const| | - +-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_bone_local_pose_override` **(** :ref:`int` bone_idx **)** | - +-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SkeletonModificationStack2D` | :ref:`get_modification_stack` **(** **)** |const| | - +-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_skeleton` **(** **)** |const| | - +-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bone_local_pose_override` **(** :ref:`int` bone_idx, :ref:`Transform2D` override_pose, :ref:`float` strength, :ref:`bool` persistent **)** | - +-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_modification_stack` **(** :ref:`SkeletonModificationStack2D` modification_stack **)** | - +-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`execute_modifications`\ (\ delta\: :ref:`float`, execution_mode\: :ref:`int`\ ) | + +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Bone2D` | :ref:`get_bone`\ (\ idx\: :ref:`int`\ ) | + +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_bone_count`\ (\ ) |const| | + +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_bone_local_pose_override`\ (\ bone_idx\: :ref:`int`\ ) | + +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SkeletonModificationStack2D` | :ref:`get_modification_stack`\ (\ ) |const| | + +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_skeleton`\ (\ ) |const| | + +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bone_local_pose_override`\ (\ bone_idx\: :ref:`int`, override_pose\: :ref:`Transform2D`, strength\: :ref:`float`, persistent\: :ref:`bool`\ ) | + +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_modification_stack`\ (\ modification_stack\: :ref:`SkeletonModificationStack2D`\ ) | + +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -69,7 +69,7 @@ Signals .. rst-class:: classref-signal -**bone_setup_changed** **(** **)** +**bone_setup_changed**\ (\ ) Emitted when the :ref:`Bone2D` setup attached to this skeletons changes. This is primarily used internally within the skeleton. @@ -86,7 +86,7 @@ Method Descriptions .. rst-class:: classref-method -void **execute_modifications** **(** :ref:`float` delta, :ref:`int` execution_mode **)** +|void| **execute_modifications**\ (\ delta\: :ref:`float`, execution_mode\: :ref:`int`\ ) Executes all the modifications on the :ref:`SkeletonModificationStack2D`, if the Skeleton2D has one assigned. @@ -98,7 +98,7 @@ Executes all the modifications on the :ref:`SkeletonModificationStack2D` **get_bone** **(** :ref:`int` idx **)** +:ref:`Bone2D` **get_bone**\ (\ idx\: :ref:`int`\ ) Returns a :ref:`Bone2D` from the node hierarchy parented by Skeleton2D. The object to return is identified by the parameter ``idx``. Bones are indexed by descending the node hierarchy from top to bottom, adding the children of each branch before moving to the next sibling. @@ -110,7 +110,7 @@ Returns a :ref:`Bone2D` from the node hierarchy parented by Skelet .. rst-class:: classref-method -:ref:`int` **get_bone_count** **(** **)** |const| +:ref:`int` **get_bone_count**\ (\ ) |const| Returns the number of :ref:`Bone2D` nodes in the node hierarchy parented by Skeleton2D. @@ -122,7 +122,7 @@ Returns the number of :ref:`Bone2D` nodes in the node hierarchy pa .. rst-class:: classref-method -:ref:`Transform2D` **get_bone_local_pose_override** **(** :ref:`int` bone_idx **)** +:ref:`Transform2D` **get_bone_local_pose_override**\ (\ bone_idx\: :ref:`int`\ ) Returns the local pose override transform for ``bone_idx``. @@ -134,7 +134,7 @@ Returns the local pose override transform for ``bone_idx``. .. rst-class:: classref-method -:ref:`SkeletonModificationStack2D` **get_modification_stack** **(** **)** |const| +:ref:`SkeletonModificationStack2D` **get_modification_stack**\ (\ ) |const| Returns the :ref:`SkeletonModificationStack2D` attached to this skeleton, if one exists. @@ -146,7 +146,7 @@ Returns the :ref:`SkeletonModificationStack2D .. rst-class:: classref-method -:ref:`RID` **get_skeleton** **(** **)** |const| +:ref:`RID` **get_skeleton**\ (\ ) |const| Returns the :ref:`RID` of a Skeleton2D instance. @@ -158,7 +158,7 @@ Returns the :ref:`RID` of a Skeleton2D instance. .. rst-class:: classref-method -void **set_bone_local_pose_override** **(** :ref:`int` bone_idx, :ref:`Transform2D` override_pose, :ref:`float` strength, :ref:`bool` persistent **)** +|void| **set_bone_local_pose_override**\ (\ bone_idx\: :ref:`int`, override_pose\: :ref:`Transform2D`, strength\: :ref:`float`, persistent\: :ref:`bool`\ ) Sets the local pose transform, ``override_pose``, for the bone at ``bone_idx``. @@ -174,7 +174,7 @@ Sets the local pose transform, ``override_pose``, for the bone at ``bone_idx``. .. rst-class:: classref-method -void **set_modification_stack** **(** :ref:`SkeletonModificationStack2D` modification_stack **)** +|void| **set_modification_stack**\ (\ modification_stack\: :ref:`SkeletonModificationStack2D`\ ) Sets the :ref:`SkeletonModificationStack2D` attached to this skeleton. @@ -185,3 +185,4 @@ Sets the :ref:`SkeletonModificationStack2D` a .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_skeleton3d.rst b/classes/class_skeleton3d.rst index d9c35cd3ba1..9c9924c1bfc 100644 --- a/classes/class_skeleton3d.rst +++ b/classes/class_skeleton3d.rst @@ -58,87 +58,87 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_bone` **(** :ref:`String` name **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_bones` **(** **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_bones_global_pose_override` **(** **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Skin` | :ref:`create_skin_from_rest_transforms` **(** **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find_bone` **(** :ref:`String` name **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`force_update_all_bone_transforms` **(** **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`force_update_bone_child_transform` **(** :ref:`int` bone_idx **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_bone_children` **(** :ref:`int` bone_idx **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_bone_count` **(** **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`get_bone_global_pose` **(** :ref:`int` bone_idx **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`get_bone_global_pose_no_override` **(** :ref:`int` bone_idx **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`get_bone_global_pose_override` **(** :ref:`int` bone_idx **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`get_bone_global_rest` **(** :ref:`int` bone_idx **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_bone_name` **(** :ref:`int` bone_idx **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_bone_parent` **(** :ref:`int` bone_idx **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`get_bone_pose` **(** :ref:`int` bone_idx **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_bone_pose_position` **(** :ref:`int` bone_idx **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Quaternion` | :ref:`get_bone_pose_rotation` **(** :ref:`int` bone_idx **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_bone_pose_scale` **(** :ref:`int` bone_idx **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`get_bone_rest` **(** :ref:`int` bone_idx **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_parentless_bones` **(** **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_version` **(** **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_bone_enabled` **(** :ref:`int` bone_idx **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`localize_rests` **(** **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`physical_bones_add_collision_exception` **(** :ref:`RID` exception **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`physical_bones_remove_collision_exception` **(** :ref:`RID` exception **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`physical_bones_start_simulation` **(** :ref:`StringName[]` bones=[] **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`physical_bones_stop_simulation` **(** **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SkinReference` | :ref:`register_skin` **(** :ref:`Skin` skin **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reset_bone_pose` **(** :ref:`int` bone_idx **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reset_bone_poses` **(** **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bone_enabled` **(** :ref:`int` bone_idx, :ref:`bool` enabled=true **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bone_global_pose_override` **(** :ref:`int` bone_idx, :ref:`Transform3D` pose, :ref:`float` amount, :ref:`bool` persistent=false **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bone_name` **(** :ref:`int` bone_idx, :ref:`String` name **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bone_parent` **(** :ref:`int` bone_idx, :ref:`int` parent_idx **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bone_pose_position` **(** :ref:`int` bone_idx, :ref:`Vector3` position **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bone_pose_rotation` **(** :ref:`int` bone_idx, :ref:`Quaternion` rotation **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bone_pose_scale` **(** :ref:`int` bone_idx, :ref:`Vector3` scale **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bone_rest` **(** :ref:`int` bone_idx, :ref:`Transform3D` rest **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`unparent_bone_and_rest` **(** :ref:`int` bone_idx **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_bone`\ (\ name\: :ref:`String`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_bones`\ (\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_bones_global_pose_override`\ (\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Skin` | :ref:`create_skin_from_rest_transforms`\ (\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find_bone`\ (\ name\: :ref:`String`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_update_all_bone_transforms`\ (\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_update_bone_child_transform`\ (\ bone_idx\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_bone_children`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_bone_count`\ (\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`get_bone_global_pose`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`get_bone_global_pose_no_override`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`get_bone_global_pose_override`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`get_bone_global_rest`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_bone_name`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_bone_parent`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`get_bone_pose`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_bone_pose_position`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Quaternion` | :ref:`get_bone_pose_rotation`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_bone_pose_scale`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`get_bone_rest`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_parentless_bones`\ (\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_version`\ (\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_bone_enabled`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`localize_rests`\ (\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`physical_bones_add_collision_exception`\ (\ exception\: :ref:`RID`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`physical_bones_remove_collision_exception`\ (\ exception\: :ref:`RID`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`physical_bones_start_simulation`\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`physical_bones_stop_simulation`\ (\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SkinReference` | :ref:`register_skin`\ (\ skin\: :ref:`Skin`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reset_bone_pose`\ (\ bone_idx\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reset_bone_poses`\ (\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bone_enabled`\ (\ bone_idx\: :ref:`int`, enabled\: :ref:`bool` = true\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bone_global_pose_override`\ (\ bone_idx\: :ref:`int`, pose\: :ref:`Transform3D`, amount\: :ref:`float`, persistent\: :ref:`bool` = false\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bone_name`\ (\ bone_idx\: :ref:`int`, name\: :ref:`String`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bone_parent`\ (\ bone_idx\: :ref:`int`, parent_idx\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bone_pose_position`\ (\ bone_idx\: :ref:`int`, position\: :ref:`Vector3`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bone_pose_rotation`\ (\ bone_idx\: :ref:`int`, rotation\: :ref:`Quaternion`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bone_pose_scale`\ (\ bone_idx\: :ref:`int`, scale\: :ref:`Vector3`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bone_rest`\ (\ bone_idx\: :ref:`int`, rest\: :ref:`Transform3D`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unparent_bone_and_rest`\ (\ bone_idx\: :ref:`int`\ ) | + +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -153,7 +153,7 @@ Signals .. rst-class:: classref-signal -**bone_enabled_changed** **(** :ref:`int` bone_idx **)** +**bone_enabled_changed**\ (\ bone_idx\: :ref:`int`\ ) Emitted when the bone at ``bone_idx`` is toggled with :ref:`set_bone_enabled`. Use :ref:`is_bone_enabled` to check the new value. @@ -165,7 +165,7 @@ Emitted when the bone at ``bone_idx`` is toggled with :ref:`set_bone_enabled` bone_idx **)** +**bone_pose_changed**\ (\ bone_idx\: :ref:`int`\ ) This signal is emitted when one of the bones in the Skeleton3D node have changed their pose. This is used to inform nodes that rely on bone positions that one of the bones in the Skeleton3D have changed their transform/pose. @@ -177,7 +177,7 @@ This signal is emitted when one of the bones in the Skeleton3D node have changed .. rst-class:: classref-signal -**pose_updated** **(** **)** +**pose_updated**\ (\ ) Emitted when the pose is updated, after :ref:`NOTIFICATION_UPDATE_SKELETON` is received. @@ -189,7 +189,7 @@ Emitted when the pose is updated, after :ref:`NOTIFICATION_UPDATE_SKELETON` changes. @@ -229,8 +229,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_animate_physical_bones** **(** :ref:`bool` value **)** -- :ref:`bool` **get_animate_physical_bones** **(** **)** +- |void| **set_animate_physical_bones**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_animate_physical_bones**\ (\ ) .. container:: contribute @@ -248,8 +248,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_motion_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_motion_scale** **(** **)** +- |void| **set_motion_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_motion_scale**\ (\ ) Multiplies the 3D position track animation. @@ -267,8 +267,8 @@ Multiplies the 3D position track animation. .. rst-class:: classref-property-setget -- void **set_show_rest_only** **(** :ref:`bool` value **)** -- :ref:`bool` **is_show_rest_only** **(** **)** +- |void| **set_show_rest_only**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_show_rest_only**\ (\ ) 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. @@ -285,7 +285,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_bone** **(** :ref:`String` name **)** +|void| **add_bone**\ (\ name\: :ref:`String`\ ) Adds a bone, with name ``name``. :ref:`get_bone_count` will become the bone index. @@ -297,7 +297,7 @@ Adds a bone, with name ``name``. :ref:`get_bone_count` **create_skin_from_rest_transforms** **(** **)** +:ref:`Skin` **create_skin_from_rest_transforms**\ (\ ) .. container:: contribute @@ -335,7 +335,7 @@ Removes the global pose override on all bones in the skeleton. .. rst-class:: classref-method -:ref:`int` **find_bone** **(** :ref:`String` name **)** |const| +:ref:`int` **find_bone**\ (\ name\: :ref:`String`\ ) |const| Returns the bone index that matches ``name`` as its name. @@ -347,9 +347,9 @@ Returns the bone index that matches ``name`` as its name. .. rst-class:: classref-method -void **force_update_all_bone_transforms** **(** **)** +|void| **force_update_all_bone_transforms**\ (\ ) -**Deprecated:** Do not use this method. +**Deprecated:** This method should only be called internally. Force updates the bone transforms/poses for all bones in the skeleton. @@ -361,7 +361,7 @@ Force updates the bone transforms/poses for all bones in the skeleton. .. rst-class:: classref-method -void **force_update_bone_child_transform** **(** :ref:`int` bone_idx **)** +|void| **force_update_bone_child_transform**\ (\ bone_idx\: :ref:`int`\ ) Force updates the bone transform for the bone at ``bone_idx`` and all of its children. @@ -373,7 +373,7 @@ Force updates the bone transform for the bone at ``bone_idx`` and all of its chi .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_bone_children** **(** :ref:`int` bone_idx **)** |const| +:ref:`PackedInt32Array` **get_bone_children**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns an array containing the bone indexes of all the children node of the passed in bone, ``bone_idx``. @@ -385,7 +385,7 @@ Returns an array containing the bone indexes of all the children node of the pas .. rst-class:: classref-method -:ref:`int` **get_bone_count** **(** **)** |const| +:ref:`int` **get_bone_count**\ (\ ) |const| Returns the number of bones in the skeleton. @@ -397,7 +397,7 @@ Returns the number of bones in the skeleton. .. rst-class:: classref-method -:ref:`Transform3D` **get_bone_global_pose** **(** :ref:`int` bone_idx **)** |const| +:ref:`Transform3D` **get_bone_global_pose**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. @@ -409,7 +409,7 @@ Returns the overall transform of the specified bone, with respect to the skeleto .. rst-class:: classref-method -:ref:`Transform3D` **get_bone_global_pose_no_override** **(** :ref:`int` bone_idx **)** |const| +:ref:`Transform3D` **get_bone_global_pose_no_override**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns the overall transform of the specified bone, with respect to the skeleton, but without any global pose overrides. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. @@ -421,7 +421,7 @@ Returns the overall transform of the specified bone, with respect to the skeleto .. rst-class:: classref-method -:ref:`Transform3D` **get_bone_global_pose_override** **(** :ref:`int` bone_idx **)** |const| +:ref:`Transform3D` **get_bone_global_pose_override**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns the global pose override transform for ``bone_idx``. @@ -433,7 +433,7 @@ Returns the global pose override transform for ``bone_idx``. .. rst-class:: classref-method -:ref:`Transform3D` **get_bone_global_rest** **(** :ref:`int` bone_idx **)** |const| +:ref:`Transform3D` **get_bone_global_rest**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns the global rest transform for ``bone_idx``. @@ -445,7 +445,7 @@ Returns the global rest transform for ``bone_idx``. .. rst-class:: classref-method -:ref:`String` **get_bone_name** **(** :ref:`int` bone_idx **)** |const| +:ref:`String` **get_bone_name**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns the name of the bone at index ``bone_idx``. @@ -457,7 +457,7 @@ Returns the name of the bone at index ``bone_idx``. .. rst-class:: classref-method -:ref:`int` **get_bone_parent** **(** :ref:`int` bone_idx **)** |const| +:ref:`int` **get_bone_parent**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns the bone index which is the parent of the bone at ``bone_idx``. If -1, then bone has no parent. @@ -471,7 +471,7 @@ Returns the bone index which is the parent of the bone at ``bone_idx``. If -1, t .. rst-class:: classref-method -:ref:`Transform3D` **get_bone_pose** **(** :ref:`int` bone_idx **)** |const| +:ref:`Transform3D` **get_bone_pose**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns the pose transform of the specified bone. @@ -483,7 +483,7 @@ Returns the pose transform of the specified bone. .. rst-class:: classref-method -:ref:`Vector3` **get_bone_pose_position** **(** :ref:`int` bone_idx **)** |const| +:ref:`Vector3` **get_bone_pose_position**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns the pose position of the bone at ``bone_idx``. The returned :ref:`Vector3` is in the local coordinate space of the **Skeleton3D** node. @@ -495,7 +495,7 @@ Returns the pose position of the bone at ``bone_idx``. The returned :ref:`Vector .. rst-class:: classref-method -:ref:`Quaternion` **get_bone_pose_rotation** **(** :ref:`int` bone_idx **)** |const| +:ref:`Quaternion` **get_bone_pose_rotation**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns the pose rotation of the bone at ``bone_idx``. The returned :ref:`Quaternion` is local to the bone with respect to the rotation of any parent bones. @@ -507,7 +507,7 @@ Returns the pose rotation of the bone at ``bone_idx``. The returned :ref:`Quater .. rst-class:: classref-method -:ref:`Vector3` **get_bone_pose_scale** **(** :ref:`int` bone_idx **)** |const| +:ref:`Vector3` **get_bone_pose_scale**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns the pose scale of the bone at ``bone_idx``. @@ -519,7 +519,7 @@ Returns the pose scale of the bone at ``bone_idx``. .. rst-class:: classref-method -:ref:`Transform3D` **get_bone_rest** **(** :ref:`int` bone_idx **)** |const| +:ref:`Transform3D` **get_bone_rest**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns the rest transform for a bone ``bone_idx``. @@ -531,7 +531,7 @@ Returns the rest transform for a bone ``bone_idx``. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_parentless_bones** **(** **)** |const| +:ref:`PackedInt32Array` **get_parentless_bones**\ (\ ) |const| Returns an array with all of the bones that are parentless. Another way to look at this is that it returns the indexes of all the bones that are not dependent or modified by other bones in the Skeleton. @@ -543,7 +543,7 @@ Returns an array with all of the bones that are parentless. Another way to look .. rst-class:: classref-method -:ref:`int` **get_version** **(** **)** |const| +:ref:`int` **get_version**\ (\ ) |const| Returns the number of times the bone hierarchy has changed within this skeleton, including renames. @@ -559,7 +559,7 @@ Use for invalidating caches in IK solvers and other nodes which process bones. .. rst-class:: classref-method -:ref:`bool` **is_bone_enabled** **(** :ref:`int` bone_idx **)** |const| +:ref:`bool` **is_bone_enabled**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns whether the bone pose for the bone at ``bone_idx`` is enabled. @@ -571,7 +571,7 @@ Returns whether the bone pose for the bone at ``bone_idx`` is enabled. .. rst-class:: classref-method -void **localize_rests** **(** **)** +|void| **localize_rests**\ (\ ) Returns all bones in the skeleton to their rest poses. @@ -583,7 +583,7 @@ Returns all bones in the skeleton to their rest poses. .. rst-class:: classref-method -void **physical_bones_add_collision_exception** **(** :ref:`RID` exception **)** +|void| **physical_bones_add_collision_exception**\ (\ exception\: :ref:`RID`\ ) Adds a collision exception to the physical bone. @@ -597,7 +597,7 @@ Works just like the :ref:`RigidBody3D` node. .. rst-class:: classref-method -void **physical_bones_remove_collision_exception** **(** :ref:`RID` exception **)** +|void| **physical_bones_remove_collision_exception**\ (\ exception\: :ref:`RID`\ ) Removes a collision exception to the physical bone. @@ -611,7 +611,7 @@ Works just like the :ref:`RigidBody3D` node. .. rst-class:: classref-method -void **physical_bones_start_simulation** **(** :ref:`StringName[]` bones=[] **)** +|void| **physical_bones_start_simulation**\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) Tells the :ref:`PhysicalBone3D` nodes in the Skeleton to start simulating and reacting to the physics world. @@ -625,7 +625,7 @@ Optionally, a list of bone names can be passed-in, allowing only the passed-in b .. rst-class:: classref-method -void **physical_bones_stop_simulation** **(** **)** +|void| **physical_bones_stop_simulation**\ (\ ) Tells the :ref:`PhysicalBone3D` nodes in the Skeleton to stop simulating. @@ -637,7 +637,7 @@ Tells the :ref:`PhysicalBone3D` nodes in the Skeleton to s .. rst-class:: classref-method -:ref:`SkinReference` **register_skin** **(** :ref:`Skin` skin **)** +:ref:`SkinReference` **register_skin**\ (\ skin\: :ref:`Skin`\ ) Binds the given Skin to the Skeleton. @@ -649,7 +649,7 @@ Binds the given Skin to the Skeleton. .. rst-class:: classref-method -void **reset_bone_pose** **(** :ref:`int` bone_idx **)** +|void| **reset_bone_pose**\ (\ bone_idx\: :ref:`int`\ ) Sets the bone pose to rest for ``bone_idx``. @@ -661,7 +661,7 @@ Sets the bone pose to rest for ``bone_idx``. .. rst-class:: classref-method -void **reset_bone_poses** **(** **)** +|void| **reset_bone_poses**\ (\ ) Sets all bone poses to rests. @@ -673,7 +673,7 @@ Sets all bone poses to rests. .. rst-class:: classref-method -void **set_bone_enabled** **(** :ref:`int` bone_idx, :ref:`bool` enabled=true **)** +|void| **set_bone_enabled**\ (\ bone_idx\: :ref:`int`, enabled\: :ref:`bool` = true\ ) Disables the pose for the bone at ``bone_idx`` if ``false``, enables the bone pose if ``true``. @@ -685,7 +685,7 @@ Disables the pose for the bone at ``bone_idx`` if ``false``, enables the bone po .. rst-class:: classref-method -void **set_bone_global_pose_override** **(** :ref:`int` bone_idx, :ref:`Transform3D` pose, :ref:`float` amount, :ref:`bool` persistent=false **)** +|void| **set_bone_global_pose_override**\ (\ bone_idx\: :ref:`int`, pose\: :ref:`Transform3D`, amount\: :ref:`float`, persistent\: :ref:`bool` = false\ ) Sets the global pose transform, ``pose``, for the bone at ``bone_idx``. @@ -701,7 +701,7 @@ Sets the global pose transform, ``pose``, for the bone at ``bone_idx``. .. rst-class:: classref-method -void **set_bone_name** **(** :ref:`int` bone_idx, :ref:`String` name **)** +|void| **set_bone_name**\ (\ bone_idx\: :ref:`int`, name\: :ref:`String`\ ) .. container:: contribute @@ -715,7 +715,7 @@ void **set_bone_name** **(** :ref:`int` bone_idx, :ref:`String` bone_idx, :ref:`int` parent_idx **)** +|void| **set_bone_parent**\ (\ bone_idx\: :ref:`int`, parent_idx\: :ref:`int`\ ) Sets the bone index ``parent_idx`` as the parent of the bone at ``bone_idx``. If -1, then bone has no parent. @@ -729,7 +729,7 @@ Sets the bone index ``parent_idx`` as the parent of the bone at ``bone_idx``. If .. rst-class:: classref-method -void **set_bone_pose_position** **(** :ref:`int` bone_idx, :ref:`Vector3` position **)** +|void| **set_bone_pose_position**\ (\ bone_idx\: :ref:`int`, position\: :ref:`Vector3`\ ) Sets the pose position of the bone at ``bone_idx`` to ``position``. ``position`` is a :ref:`Vector3` describing a position local to the **Skeleton3D** node. @@ -741,7 +741,7 @@ Sets the pose position of the bone at ``bone_idx`` to ``position``. ``position`` .. rst-class:: classref-method -void **set_bone_pose_rotation** **(** :ref:`int` bone_idx, :ref:`Quaternion` rotation **)** +|void| **set_bone_pose_rotation**\ (\ bone_idx\: :ref:`int`, rotation\: :ref:`Quaternion`\ ) Sets the pose rotation of the bone at ``bone_idx`` to ``rotation``. ``rotation`` is a :ref:`Quaternion` describing a rotation in the bone's local coordinate space with respect to the rotation of any parent bones. @@ -753,7 +753,7 @@ Sets the pose rotation of the bone at ``bone_idx`` to ``rotation``. ``rotation`` .. rst-class:: classref-method -void **set_bone_pose_scale** **(** :ref:`int` bone_idx, :ref:`Vector3` scale **)** +|void| **set_bone_pose_scale**\ (\ bone_idx\: :ref:`int`, scale\: :ref:`Vector3`\ ) Sets the pose scale of the bone at ``bone_idx`` to ``scale``. @@ -765,7 +765,7 @@ Sets the pose scale of the bone at ``bone_idx`` to ``scale``. .. rst-class:: classref-method -void **set_bone_rest** **(** :ref:`int` bone_idx, :ref:`Transform3D` rest **)** +|void| **set_bone_rest**\ (\ bone_idx\: :ref:`int`, rest\: :ref:`Transform3D`\ ) Sets the rest transform for bone ``bone_idx``. @@ -777,7 +777,7 @@ Sets the rest transform for bone ``bone_idx``. .. rst-class:: classref-method -void **unparent_bone_and_rest** **(** :ref:`int` bone_idx **)** +|void| **unparent_bone_and_rest**\ (\ bone_idx\: :ref:`int`\ ) Unparents the bone at ``bone_idx`` and sets its rest position to that of its parent prior to being reset. @@ -788,3 +788,4 @@ Unparents the bone at ``bone_idx`` and sets its rest position to that of its par .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_skeletonik3d.rst b/classes/class_skeletonik3d.rst index 8f64910ab72..e110695ac88 100644 --- a/classes/class_skeletonik3d.rst +++ b/classes/class_skeletonik3d.rst @@ -88,15 +88,15 @@ Methods .. table:: :widths: auto - +-------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Skeleton3D` | :ref:`get_parent_skeleton` **(** **)** |const| | - +-------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_running` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------+ - | void | :ref:`start` **(** :ref:`bool` one_time=false **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------+ - | void | :ref:`stop` **(** **)** | - +-------------------------------------+--------------------------------------------------------------------------------------------------+ + +-------------------------------------+-------------------------------------------------------------------------------------------------+ + | :ref:`Skeleton3D` | :ref:`get_parent_skeleton`\ (\ ) |const| | + +-------------------------------------+-------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_running`\ (\ ) | + +-------------------------------------+-------------------------------------------------------------------------------------------------+ + | |void| | :ref:`start`\ (\ one_time\: :ref:`bool` = false\ ) | + +-------------------------------------+-------------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop`\ (\ ) | + +-------------------------------------+-------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -115,8 +115,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_interpolation** **(** :ref:`float` value **)** -- :ref:`float` **get_interpolation** **(** **)** +- |void| **set_interpolation**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_interpolation**\ (\ ) Interpolation value for how much the IK results are applied to the current skeleton bone chain. A value of ``1.0`` will overwrite all skeleton bone transforms completely while a value of ``0.0`` will visually disable the SkeletonIK. A value at or below ``0.01`` also calls :ref:`Skeleton3D.clear_bones_global_pose_override`. @@ -132,8 +132,8 @@ Interpolation value for how much the IK results are applied to the current skele .. rst-class:: classref-property-setget -- void **set_magnet_position** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_magnet_position** **(** **)** +- |void| **set_magnet_position**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_magnet_position**\ (\ ) Secondary target position (first is :ref:`target` property or :ref:`target_node`) for the IK chain. Use magnet position (pole target) to control the bending of the IK chain. Only works if the bone chain has more than 2 bones. The middle chain bone position will be linearly interpolated with the magnet position. @@ -149,8 +149,8 @@ Secondary target position (first is :ref:`target` value **)** -- :ref:`int` **get_max_iterations** **(** **)** +- |void| **set_max_iterations**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_iterations**\ (\ ) Number of iteration loops used by the IK solver to produce more accurate (and elegant) bone chain results. @@ -166,8 +166,8 @@ Number of iteration loops used by the IK solver to produce more accurate (and el .. rst-class:: classref-property-setget -- void **set_min_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_min_distance** **(** **)** +- |void| **set_min_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_min_distance**\ (\ ) The minimum distance between bone and goal target. If the distance is below this value, the IK solver stops further iterations. @@ -183,8 +183,8 @@ The minimum distance between bone and goal target. If the distance is below this .. rst-class:: classref-property-setget -- void **set_override_tip_basis** **(** :ref:`bool` value **)** -- :ref:`bool` **is_override_tip_basis** **(** **)** +- |void| **set_override_tip_basis**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_override_tip_basis**\ (\ ) If ``true`` overwrites the rotation of the tip bone with the rotation of the :ref:`target` (or :ref:`target_node` if defined). @@ -200,8 +200,8 @@ If ``true`` overwrites the rotation of the tip bone with the rotation of the :re .. rst-class:: classref-property-setget -- void **set_root_bone** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_root_bone** **(** **)** +- |void| **set_root_bone**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_root_bone**\ (\ ) The name of the current root bone, the first bone in the IK chain. @@ -217,8 +217,8 @@ The name of the current root bone, the first bone in the IK chain. .. rst-class:: classref-property-setget -- void **set_target_transform** **(** :ref:`Transform3D` value **)** -- :ref:`Transform3D` **get_target_transform** **(** **)** +- |void| **set_target_transform**\ (\ value\: :ref:`Transform3D`\ ) +- :ref:`Transform3D` **get_target_transform**\ (\ ) First target of the IK chain where the tip bone is placed and, if :ref:`override_tip_basis` is ``true``, how the tip bone is rotated. If a :ref:`target_node` path is available the nodes transform is used instead and this property is ignored. @@ -234,8 +234,8 @@ First target of the IK chain where the tip bone is placed and, if :ref:`override .. rst-class:: classref-property-setget -- void **set_target_node** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_target_node** **(** **)** +- |void| **set_target_node**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_target_node**\ (\ ) Target node :ref:`NodePath` for the IK chain. If available, the node's current :ref:`Transform3D` is used instead of the :ref:`target` property. @@ -251,8 +251,8 @@ Target node :ref:`NodePath` for the IK chain. If available, the .. rst-class:: classref-property-setget -- void **set_tip_bone** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_tip_bone** **(** **)** +- |void| **set_tip_bone**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_tip_bone**\ (\ ) The name of the current tip bone, the last bone in the IK chain placed at the :ref:`target` transform (or :ref:`target_node` if defined). @@ -268,8 +268,8 @@ The name of the current tip bone, the last bone in the IK chain placed at the :r .. rst-class:: classref-property-setget -- void **set_use_magnet** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_magnet** **(** **)** +- |void| **set_use_magnet**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_magnet**\ (\ ) If ``true``, instructs the IK solver to consider the secondary magnet target (pole target) when calculating the bone chain. Use the magnet position (pole target) to control the bending of the IK chain. @@ -286,7 +286,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Skeleton3D` **get_parent_skeleton** **(** **)** |const| +:ref:`Skeleton3D` **get_parent_skeleton**\ (\ ) |const| Returns the parent :ref:`Skeleton3D` Node that was present when SkeletonIK entered the :ref:`SceneTree`. Returns null if the parent node was not a :ref:`Skeleton3D` Node when SkeletonIK3D entered the :ref:`SceneTree`. @@ -298,7 +298,7 @@ Returns the parent :ref:`Skeleton3D` Node that was present whe .. rst-class:: classref-method -:ref:`bool` **is_running** **(** **)** +:ref:`bool` **is_running**\ (\ ) Returns ``true`` if SkeletonIK is applying IK effects on continues frames to the :ref:`Skeleton3D` bones. Returns ``false`` if SkeletonIK is stopped or :ref:`start` was used with the ``one_time`` parameter set to ``true``. @@ -310,7 +310,7 @@ Returns ``true`` if SkeletonIK is applying IK effects on continues frames to the .. rst-class:: classref-method -void **start** **(** :ref:`bool` one_time=false **)** +|void| **start**\ (\ one_time\: :ref:`bool` = false\ ) Starts applying IK effects on each frame to the :ref:`Skeleton3D` bones but will only take effect starting on the next frame. If ``one_time`` is ``true``, this will take effect immediately but also reset on the next frame. @@ -322,7 +322,7 @@ Starts applying IK effects on each frame to the :ref:`Skeleton3D` bones and also calls :ref:`Skeleton3D.clear_bones_global_pose_override` to remove existing overrides on all bones. @@ -333,3 +333,4 @@ Stops applying IK effects on each frame to the :ref:`Skeleton3D` **(** **)** |virtual| | - +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_execute` **(** :ref:`float` delta **)** |virtual| | - +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_setup_modification` **(** :ref:`SkeletonModificationStack2D` modification_stack **)** |virtual| | - +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`clamp_angle` **(** :ref:`float` angle, :ref:`float` min, :ref:`float` max, :ref:`bool` invert **)** | - +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_editor_draw_gizmo` **(** **)** |const| | - +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_is_setup` **(** **)** |const| | - +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SkeletonModificationStack2D` | :ref:`get_modification_stack` **(** **)** | - +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_editor_draw_gizmo` **(** :ref:`bool` draw_gizmo **)** | - +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_is_setup` **(** :ref:`bool` is_setup **)** | - +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_draw_editor_gizmo`\ (\ ) |virtual| | + +-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_execute`\ (\ delta\: :ref:`float`\ ) |virtual| | + +-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_setup_modification`\ (\ modification_stack\: :ref:`SkeletonModificationStack2D`\ ) |virtual| | + +-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`clamp_angle`\ (\ angle\: :ref:`float`, min\: :ref:`float`, max\: :ref:`float`, invert\: :ref:`bool`\ ) | + +-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_editor_draw_gizmo`\ (\ ) |const| | + +-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_is_setup`\ (\ ) |const| | + +-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SkeletonModificationStack2D` | :ref:`get_modification_stack`\ (\ ) | + +-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_editor_draw_gizmo`\ (\ draw_gizmo\: :ref:`bool`\ ) | + +-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_is_setup`\ (\ is_setup\: :ref:`bool`\ ) | + +-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -86,8 +86,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **get_enabled** **(** **)** +- |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_enabled**\ (\ ) If ``true``, the modification's :ref:`_execute` function will be called by the :ref:`SkeletonModificationStack2D`. @@ -103,8 +103,8 @@ If ``true``, the modification's :ref:`_execute` value **)** -- :ref:`int` **get_execution_mode** **(** **)** +- |void| **set_execution_mode**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_execution_mode**\ (\ ) The execution mode for the modification. This tells the modification stack when to execute the modification. Some modifications have settings that are only available in certain execution modes. @@ -121,7 +121,7 @@ Method Descriptions .. rst-class:: classref-method -void **_draw_editor_gizmo** **(** **)** |virtual| +|void| **_draw_editor_gizmo**\ (\ ) |virtual| Used for drawing **editor-only** modification gizmos. This function will only be called in the Godot editor and can be overridden to draw custom gizmos. @@ -135,7 +135,7 @@ Used for drawing **editor-only** modification gizmos. This function will only be .. rst-class:: classref-method -void **_execute** **(** :ref:`float` delta **)** |virtual| +|void| **_execute**\ (\ delta\: :ref:`float`\ ) |virtual| Executes the given modification. This is where the modification performs whatever function it is designed to do. @@ -147,7 +147,7 @@ Executes the given modification. This is where the modification performs whateve .. rst-class:: classref-method -void **_setup_modification** **(** :ref:`SkeletonModificationStack2D` modification_stack **)** |virtual| +|void| **_setup_modification**\ (\ modification_stack\: :ref:`SkeletonModificationStack2D`\ ) |virtual| Called when the modification is setup. This is where the modification performs initialization. @@ -159,7 +159,7 @@ Called when the modification is setup. This is where the modification performs i .. rst-class:: classref-method -:ref:`float` **clamp_angle** **(** :ref:`float` angle, :ref:`float` min, :ref:`float` max, :ref:`bool` invert **)** +:ref:`float` **clamp_angle**\ (\ angle\: :ref:`float`, min\: :ref:`float`, max\: :ref:`float`, invert\: :ref:`bool`\ ) Takes an angle and clamps it so it is within the passed-in ``min`` and ``max`` range. ``invert`` will inversely clamp the angle, clamping it to the range outside of the given bounds. @@ -171,7 +171,7 @@ Takes an angle and clamps it so it is within the passed-in ``min`` and ``max`` r .. rst-class:: classref-method -:ref:`bool` **get_editor_draw_gizmo** **(** **)** |const| +:ref:`bool` **get_editor_draw_gizmo**\ (\ ) |const| Returns whether this modification will call :ref:`_draw_editor_gizmo` in the Godot editor to draw modification-specific gizmos. @@ -183,7 +183,7 @@ Returns whether this modification will call :ref:`_draw_editor_gizmo` **get_is_setup** **(** **)** |const| +:ref:`bool` **get_is_setup**\ (\ ) |const| Returns whether this modification has been successfully setup or not. @@ -195,7 +195,7 @@ Returns whether this modification has been successfully setup or not. .. rst-class:: classref-method -:ref:`SkeletonModificationStack2D` **get_modification_stack** **(** **)** +:ref:`SkeletonModificationStack2D` **get_modification_stack**\ (\ ) Returns the :ref:`SkeletonModificationStack2D` that this modification is bound to. Through the modification stack, you can access the Skeleton2D the modification is operating on. @@ -207,7 +207,7 @@ Returns the :ref:`SkeletonModificationStack2D .. rst-class:: classref-method -void **set_editor_draw_gizmo** **(** :ref:`bool` draw_gizmo **)** +|void| **set_editor_draw_gizmo**\ (\ draw_gizmo\: :ref:`bool`\ ) Sets whether this modification will call :ref:`_draw_editor_gizmo` in the Godot editor to draw modification-specific gizmos. @@ -219,7 +219,7 @@ Sets whether this modification will call :ref:`_draw_editor_gizmo` is_setup **)** +|void| **set_is_setup**\ (\ is_setup\: :ref:`bool`\ ) Manually allows you to set the setup state of the modification. This function should only rarely be used, as the :ref:`SkeletonModificationStack2D` the modification is bound to should handle setting the modification up. @@ -230,3 +230,4 @@ Manually allows you to set the setup state of the modification. This function sh .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_skeletonmodification2dccdik.rst b/classes/class_skeletonmodification2dccdik.rst index bf1e47835ad..9c060fd0e04 100644 --- a/classes/class_skeletonmodification2dccdik.rst +++ b/classes/class_skeletonmodification2dccdik.rst @@ -53,35 +53,35 @@ Methods .. table:: :widths: auto - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_ccdik_joint_bone2d_node` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_ccdik_joint_bone_index` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_ccdik_joint_constraint_angle_invert` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_ccdik_joint_constraint_angle_max` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_ccdik_joint_constraint_angle_min` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_ccdik_joint_enable_constraint` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_ccdik_joint_rotate_from_joint` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_ccdik_joint_bone2d_node` **(** :ref:`int` joint_idx, :ref:`NodePath` bone2d_nodepath **)** | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_ccdik_joint_bone_index` **(** :ref:`int` joint_idx, :ref:`int` bone_idx **)** | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_ccdik_joint_constraint_angle_invert` **(** :ref:`int` joint_idx, :ref:`bool` invert **)** | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_ccdik_joint_constraint_angle_max` **(** :ref:`int` joint_idx, :ref:`float` angle_max **)** | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_ccdik_joint_constraint_angle_min` **(** :ref:`int` joint_idx, :ref:`float` angle_min **)** | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_ccdik_joint_enable_constraint` **(** :ref:`int` joint_idx, :ref:`bool` enable_constraint **)** | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_ccdik_joint_rotate_from_joint` **(** :ref:`int` joint_idx, :ref:`bool` rotate_from_joint **)** | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_ccdik_joint_bone2d_node`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_ccdik_joint_bone_index`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_ccdik_joint_constraint_angle_invert`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_ccdik_joint_constraint_angle_max`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_ccdik_joint_constraint_angle_min`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_ccdik_joint_enable_constraint`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_ccdik_joint_rotate_from_joint`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_ccdik_joint_bone2d_node`\ (\ joint_idx\: :ref:`int`, bone2d_nodepath\: :ref:`NodePath`\ ) | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_ccdik_joint_bone_index`\ (\ joint_idx\: :ref:`int`, bone_idx\: :ref:`int`\ ) | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_ccdik_joint_constraint_angle_invert`\ (\ joint_idx\: :ref:`int`, invert\: :ref:`bool`\ ) | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_ccdik_joint_constraint_angle_max`\ (\ joint_idx\: :ref:`int`, angle_max\: :ref:`float`\ ) | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_ccdik_joint_constraint_angle_min`\ (\ joint_idx\: :ref:`int`, angle_min\: :ref:`float`\ ) | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_ccdik_joint_enable_constraint`\ (\ joint_idx\: :ref:`int`, enable_constraint\: :ref:`bool`\ ) | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_ccdik_joint_rotate_from_joint`\ (\ joint_idx\: :ref:`int`, rotate_from_joint\: :ref:`bool`\ ) | + +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -100,8 +100,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_ccdik_data_chain_length** **(** :ref:`int` value **)** -- :ref:`int` **get_ccdik_data_chain_length** **(** **)** +- |void| **set_ccdik_data_chain_length**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_ccdik_data_chain_length**\ (\ ) The number of CCDIK joints in the CCDIK modification. @@ -117,8 +117,8 @@ The number of CCDIK joints in the CCDIK modification. .. rst-class:: classref-property-setget -- void **set_target_node** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_target_node** **(** **)** +- |void| **set_target_node**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_target_node**\ (\ ) The NodePath to the node that is the target for the CCDIK modification. This node is what the CCDIK chain will attempt to rotate the bone chain to. @@ -134,8 +134,8 @@ The NodePath to the node that is the target for the CCDIK modification. This nod .. rst-class:: classref-property-setget -- void **set_tip_node** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_tip_node** **(** **)** +- |void| **set_tip_node**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_tip_node**\ (\ ) The end position of the CCDIK chain. Typically, this should be a child of a :ref:`Bone2D` node attached to the final :ref:`Bone2D` in the CCDIK chain. @@ -152,7 +152,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`NodePath` **get_ccdik_joint_bone2d_node** **(** :ref:`int` joint_idx **)** |const| +:ref:`NodePath` **get_ccdik_joint_bone2d_node**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns the :ref:`Bone2D` node assigned to the CCDIK joint at ``joint_idx``. @@ -164,7 +164,7 @@ Returns the :ref:`Bone2D` node assigned to the CCDIK joint at ``jo .. rst-class:: classref-method -:ref:`int` **get_ccdik_joint_bone_index** **(** :ref:`int` joint_idx **)** |const| +:ref:`int` **get_ccdik_joint_bone_index**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns the index of the :ref:`Bone2D` node assigned to the CCDIK joint at ``joint_idx``. @@ -176,7 +176,7 @@ Returns the index of the :ref:`Bone2D` node assigned to the CCDIK .. rst-class:: classref-method -:ref:`bool` **get_ccdik_joint_constraint_angle_invert** **(** :ref:`int` joint_idx **)** |const| +:ref:`bool` **get_ccdik_joint_constraint_angle_invert**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns whether the CCDIK joint at ``joint_idx`` uses an inverted joint constraint. See :ref:`set_ccdik_joint_constraint_angle_invert` for details. @@ -188,7 +188,7 @@ Returns whether the CCDIK joint at ``joint_idx`` uses an inverted joint constrai .. rst-class:: classref-method -:ref:`float` **get_ccdik_joint_constraint_angle_max** **(** :ref:`int` joint_idx **)** |const| +:ref:`float` **get_ccdik_joint_constraint_angle_max**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns the maximum angle constraint for the joint at ``joint_idx``. @@ -200,7 +200,7 @@ Returns the maximum angle constraint for the joint at ``joint_idx``. .. rst-class:: classref-method -:ref:`float` **get_ccdik_joint_constraint_angle_min** **(** :ref:`int` joint_idx **)** |const| +:ref:`float` **get_ccdik_joint_constraint_angle_min**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns the minimum angle constraint for the joint at ``joint_idx``. @@ -212,7 +212,7 @@ Returns the minimum angle constraint for the joint at ``joint_idx``. .. rst-class:: classref-method -:ref:`bool` **get_ccdik_joint_enable_constraint** **(** :ref:`int` joint_idx **)** |const| +:ref:`bool` **get_ccdik_joint_enable_constraint**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns whether angle constraints on the CCDIK joint at ``joint_idx`` are enabled. @@ -224,7 +224,7 @@ Returns whether angle constraints on the CCDIK joint at ``joint_idx`` are enable .. rst-class:: classref-method -:ref:`bool` **get_ccdik_joint_rotate_from_joint** **(** :ref:`int` joint_idx **)** |const| +:ref:`bool` **get_ccdik_joint_rotate_from_joint**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns whether the joint at ``joint_idx`` is set to rotate from the joint, ``true``, or to rotate from the tip, ``false``. The default is to rotate from the tip. @@ -236,7 +236,7 @@ Returns whether the joint at ``joint_idx`` is set to rotate from the joint, ``tr .. rst-class:: classref-method -void **set_ccdik_joint_bone2d_node** **(** :ref:`int` joint_idx, :ref:`NodePath` bone2d_nodepath **)** +|void| **set_ccdik_joint_bone2d_node**\ (\ joint_idx\: :ref:`int`, bone2d_nodepath\: :ref:`NodePath`\ ) Sets the :ref:`Bone2D` node assigned to the CCDIK joint at ``joint_idx``. @@ -248,7 +248,7 @@ Sets the :ref:`Bone2D` node assigned to the CCDIK joint at ``joint .. rst-class:: classref-method -void **set_ccdik_joint_bone_index** **(** :ref:`int` joint_idx, :ref:`int` bone_idx **)** +|void| **set_ccdik_joint_bone_index**\ (\ joint_idx\: :ref:`int`, bone_idx\: :ref:`int`\ ) Sets the bone index, ``bone_idx``, of the CCDIK joint at ``joint_idx``. When possible, this will also update the ``bone2d_node`` of the CCDIK joint based on data provided by the linked skeleton. @@ -260,7 +260,7 @@ Sets the bone index, ``bone_idx``, of the CCDIK joint at ``joint_idx``. When pos .. rst-class:: classref-method -void **set_ccdik_joint_constraint_angle_invert** **(** :ref:`int` joint_idx, :ref:`bool` invert **)** +|void| **set_ccdik_joint_constraint_angle_invert**\ (\ joint_idx\: :ref:`int`, invert\: :ref:`bool`\ ) Sets whether the CCDIK joint at ``joint_idx`` uses an inverted joint constraint. @@ -274,7 +274,7 @@ An inverted joint constraint only constraints the CCDIK joint to the angles *out .. rst-class:: classref-method -void **set_ccdik_joint_constraint_angle_max** **(** :ref:`int` joint_idx, :ref:`float` angle_max **)** +|void| **set_ccdik_joint_constraint_angle_max**\ (\ joint_idx\: :ref:`int`, angle_max\: :ref:`float`\ ) Sets the maximum angle constraint for the joint at ``joint_idx``. @@ -286,7 +286,7 @@ Sets the maximum angle constraint for the joint at ``joint_idx``. .. rst-class:: classref-method -void **set_ccdik_joint_constraint_angle_min** **(** :ref:`int` joint_idx, :ref:`float` angle_min **)** +|void| **set_ccdik_joint_constraint_angle_min**\ (\ joint_idx\: :ref:`int`, angle_min\: :ref:`float`\ ) Sets the minimum angle constraint for the joint at ``joint_idx``. @@ -298,7 +298,7 @@ Sets the minimum angle constraint for the joint at ``joint_idx``. .. rst-class:: classref-method -void **set_ccdik_joint_enable_constraint** **(** :ref:`int` joint_idx, :ref:`bool` enable_constraint **)** +|void| **set_ccdik_joint_enable_constraint**\ (\ joint_idx\: :ref:`int`, enable_constraint\: :ref:`bool`\ ) Determines whether angle constraints on the CCDIK joint at ``joint_idx`` are enabled. When ``true``, constraints will be enabled and taken into account when solving. @@ -310,7 +310,7 @@ Determines whether angle constraints on the CCDIK joint at ``joint_idx`` are ena .. rst-class:: classref-method -void **set_ccdik_joint_rotate_from_joint** **(** :ref:`int` joint_idx, :ref:`bool` rotate_from_joint **)** +|void| **set_ccdik_joint_rotate_from_joint**\ (\ joint_idx\: :ref:`int`, rotate_from_joint\: :ref:`bool`\ ) Sets whether the joint at ``joint_idx`` is set to rotate from the joint, ``true``, or to rotate from the tip, ``false``. @@ -321,3 +321,4 @@ Sets whether the joint at ``joint_idx`` is set to rotate from the joint, ``true` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_skeletonmodification2dfabrik.rst b/classes/class_skeletonmodification2dfabrik.rst index 703ed2624f0..b95ccdf1702 100644 --- a/classes/class_skeletonmodification2dfabrik.rst +++ b/classes/class_skeletonmodification2dfabrik.rst @@ -53,23 +53,23 @@ Methods .. table:: :widths: auto - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_fabrik_joint_bone2d_node` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_fabrik_joint_bone_index` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_fabrik_joint_magnet_position` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_fabrik_joint_use_target_rotation` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_fabrik_joint_bone2d_node` **(** :ref:`int` joint_idx, :ref:`NodePath` bone2d_nodepath **)** | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_fabrik_joint_bone_index` **(** :ref:`int` joint_idx, :ref:`int` bone_idx **)** | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_fabrik_joint_magnet_position` **(** :ref:`int` joint_idx, :ref:`Vector2` magnet_position **)** | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_fabrik_joint_use_target_rotation` **(** :ref:`int` joint_idx, :ref:`bool` use_target_rotation **)** | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_fabrik_joint_bone2d_node`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_fabrik_joint_bone_index`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_fabrik_joint_magnet_position`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_fabrik_joint_use_target_rotation`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_fabrik_joint_bone2d_node`\ (\ joint_idx\: :ref:`int`, bone2d_nodepath\: :ref:`NodePath`\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_fabrik_joint_bone_index`\ (\ joint_idx\: :ref:`int`, bone_idx\: :ref:`int`\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_fabrik_joint_magnet_position`\ (\ joint_idx\: :ref:`int`, magnet_position\: :ref:`Vector2`\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_fabrik_joint_use_target_rotation`\ (\ joint_idx\: :ref:`int`, use_target_rotation\: :ref:`bool`\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -88,8 +88,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_fabrik_data_chain_length** **(** :ref:`int` value **)** -- :ref:`int` **get_fabrik_data_chain_length** **(** **)** +- |void| **set_fabrik_data_chain_length**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_fabrik_data_chain_length**\ (\ ) The number of FABRIK joints in the FABRIK modification. @@ -105,8 +105,8 @@ The number of FABRIK joints in the FABRIK modification. .. rst-class:: classref-property-setget -- void **set_target_node** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_target_node** **(** **)** +- |void| **set_target_node**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_target_node**\ (\ ) The NodePath to the node that is the target for the FABRIK modification. This node is what the FABRIK chain will attempt to rotate the bone chain to. @@ -123,7 +123,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`NodePath` **get_fabrik_joint_bone2d_node** **(** :ref:`int` joint_idx **)** |const| +:ref:`NodePath` **get_fabrik_joint_bone2d_node**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns the :ref:`Bone2D` node assigned to the FABRIK joint at ``joint_idx``. @@ -135,7 +135,7 @@ Returns the :ref:`Bone2D` node assigned to the FABRIK joint at ``j .. rst-class:: classref-method -:ref:`int` **get_fabrik_joint_bone_index** **(** :ref:`int` joint_idx **)** |const| +:ref:`int` **get_fabrik_joint_bone_index**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns the index of the :ref:`Bone2D` node assigned to the FABRIK joint at ``joint_idx``. @@ -147,7 +147,7 @@ Returns the index of the :ref:`Bone2D` node assigned to the FABRIK .. rst-class:: classref-method -:ref:`Vector2` **get_fabrik_joint_magnet_position** **(** :ref:`int` joint_idx **)** |const| +:ref:`Vector2` **get_fabrik_joint_magnet_position**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns the magnet position vector for the joint at ``joint_idx``. @@ -159,7 +159,7 @@ Returns the magnet position vector for the joint at ``joint_idx``. .. rst-class:: classref-method -:ref:`bool` **get_fabrik_joint_use_target_rotation** **(** :ref:`int` joint_idx **)** |const| +:ref:`bool` **get_fabrik_joint_use_target_rotation**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns whether the joint is using the target's rotation rather than allowing FABRIK to rotate the joint. This option only applies to the tip/final joint in the chain. @@ -171,7 +171,7 @@ Returns whether the joint is using the target's rotation rather than allowing FA .. rst-class:: classref-method -void **set_fabrik_joint_bone2d_node** **(** :ref:`int` joint_idx, :ref:`NodePath` bone2d_nodepath **)** +|void| **set_fabrik_joint_bone2d_node**\ (\ joint_idx\: :ref:`int`, bone2d_nodepath\: :ref:`NodePath`\ ) Sets the :ref:`Bone2D` node assigned to the FABRIK joint at ``joint_idx``. @@ -183,7 +183,7 @@ Sets the :ref:`Bone2D` node assigned to the FABRIK joint at ``join .. rst-class:: classref-method -void **set_fabrik_joint_bone_index** **(** :ref:`int` joint_idx, :ref:`int` bone_idx **)** +|void| **set_fabrik_joint_bone_index**\ (\ joint_idx\: :ref:`int`, bone_idx\: :ref:`int`\ ) Sets the bone index, ``bone_idx``, of the FABRIK joint at ``joint_idx``. When possible, this will also update the ``bone2d_node`` of the FABRIK joint based on data provided by the linked skeleton. @@ -195,7 +195,7 @@ Sets the bone index, ``bone_idx``, of the FABRIK joint at ``joint_idx``. When po .. rst-class:: classref-method -void **set_fabrik_joint_magnet_position** **(** :ref:`int` joint_idx, :ref:`Vector2` magnet_position **)** +|void| **set_fabrik_joint_magnet_position**\ (\ joint_idx\: :ref:`int`, magnet_position\: :ref:`Vector2`\ ) Sets the magnet position vector for the joint at ``joint_idx``. @@ -207,7 +207,7 @@ Sets the magnet position vector for the joint at ``joint_idx``. .. rst-class:: classref-method -void **set_fabrik_joint_use_target_rotation** **(** :ref:`int` joint_idx, :ref:`bool` use_target_rotation **)** +|void| **set_fabrik_joint_use_target_rotation**\ (\ joint_idx\: :ref:`int`, use_target_rotation\: :ref:`bool`\ ) Sets whether the joint at ``joint_idx`` will use the target node's rotation rather than letting FABRIK rotate the node. @@ -220,3 +220,4 @@ Sets whether the joint at ``joint_idx`` will use the target node's rotation rath .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_skeletonmodification2djiggle.rst b/classes/class_skeletonmodification2djiggle.rst index 3446f9b81fd..5c877d6859a 100644 --- a/classes/class_skeletonmodification2djiggle.rst +++ b/classes/class_skeletonmodification2djiggle.rst @@ -59,47 +59,47 @@ Methods .. table:: :widths: auto - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collision_mask` **(** **)** |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_jiggle_joint_bone2d_node` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_jiggle_joint_bone_index` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_jiggle_joint_damping` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_jiggle_joint_gravity` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_jiggle_joint_mass` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_jiggle_joint_override` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_jiggle_joint_stiffness` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_jiggle_joint_use_gravity` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_use_colliders` **(** **)** |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_mask` **(** :ref:`int` collision_mask **)** | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_jiggle_joint_bone2d_node` **(** :ref:`int` joint_idx, :ref:`NodePath` bone2d_node **)** | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_jiggle_joint_bone_index` **(** :ref:`int` joint_idx, :ref:`int` bone_idx **)** | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_jiggle_joint_damping` **(** :ref:`int` joint_idx, :ref:`float` damping **)** | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_jiggle_joint_gravity` **(** :ref:`int` joint_idx, :ref:`Vector2` gravity **)** | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_jiggle_joint_mass` **(** :ref:`int` joint_idx, :ref:`float` mass **)** | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_jiggle_joint_override` **(** :ref:`int` joint_idx, :ref:`bool` override **)** | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_jiggle_joint_stiffness` **(** :ref:`int` joint_idx, :ref:`float` stiffness **)** | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_jiggle_joint_use_gravity` **(** :ref:`int` joint_idx, :ref:`bool` use_gravity **)** | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_use_colliders` **(** :ref:`bool` use_colliders **)** | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collision_mask`\ (\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_jiggle_joint_bone2d_node`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_jiggle_joint_bone_index`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_jiggle_joint_damping`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_jiggle_joint_gravity`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_jiggle_joint_mass`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_jiggle_joint_override`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_jiggle_joint_stiffness`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_jiggle_joint_use_gravity`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_use_colliders`\ (\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_mask`\ (\ collision_mask\: :ref:`int`\ ) | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_jiggle_joint_bone2d_node`\ (\ joint_idx\: :ref:`int`, bone2d_node\: :ref:`NodePath`\ ) | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_jiggle_joint_bone_index`\ (\ joint_idx\: :ref:`int`, bone_idx\: :ref:`int`\ ) | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_jiggle_joint_damping`\ (\ joint_idx\: :ref:`int`, damping\: :ref:`float`\ ) | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_jiggle_joint_gravity`\ (\ joint_idx\: :ref:`int`, gravity\: :ref:`Vector2`\ ) | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_jiggle_joint_mass`\ (\ joint_idx\: :ref:`int`, mass\: :ref:`float`\ ) | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_jiggle_joint_override`\ (\ joint_idx\: :ref:`int`, override\: :ref:`bool`\ ) | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_jiggle_joint_stiffness`\ (\ joint_idx\: :ref:`int`, stiffness\: :ref:`float`\ ) | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_jiggle_joint_use_gravity`\ (\ joint_idx\: :ref:`int`, use_gravity\: :ref:`bool`\ ) | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_use_colliders`\ (\ use_colliders\: :ref:`bool`\ ) | + +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -118,8 +118,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_damping** **(** :ref:`float` value **)** -- :ref:`float` **get_damping** **(** **)** +- |void| **set_damping**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_damping**\ (\ ) The default amount of damping applied to the Jiggle joints, if they are not overridden. Higher values lead to more of the calculated velocity being applied. @@ -135,8 +135,8 @@ The default amount of damping applied to the Jiggle joints, if they are not over .. rst-class:: classref-property-setget -- void **set_gravity** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_gravity** **(** **)** +- |void| **set_gravity**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_gravity**\ (\ ) The default amount of gravity applied to the Jiggle joints, if they are not overridden. @@ -152,8 +152,8 @@ The default amount of gravity applied to the Jiggle joints, if they are not over .. rst-class:: classref-property-setget -- void **set_jiggle_data_chain_length** **(** :ref:`int` value **)** -- :ref:`int` **get_jiggle_data_chain_length** **(** **)** +- |void| **set_jiggle_data_chain_length**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_jiggle_data_chain_length**\ (\ ) The amount of Jiggle joints in the Jiggle modification. @@ -169,8 +169,8 @@ The amount of Jiggle joints in the Jiggle modification. .. rst-class:: classref-property-setget -- void **set_mass** **(** :ref:`float` value **)** -- :ref:`float` **get_mass** **(** **)** +- |void| **set_mass**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_mass**\ (\ ) The default amount of mass assigned to the Jiggle joints, if they are not overridden. Higher values lead to faster movements and more overshooting. @@ -186,8 +186,8 @@ The default amount of mass assigned to the Jiggle joints, if they are not overri .. rst-class:: classref-property-setget -- void **set_stiffness** **(** :ref:`float` value **)** -- :ref:`float` **get_stiffness** **(** **)** +- |void| **set_stiffness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_stiffness**\ (\ ) The default amount of stiffness assigned to the Jiggle joints, if they are not overridden. Higher values act more like springs, quickly moving into the correct position. @@ -203,8 +203,8 @@ The default amount of stiffness assigned to the Jiggle joints, if they are not o .. rst-class:: classref-property-setget -- void **set_target_node** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_target_node** **(** **)** +- |void| **set_target_node**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_target_node**\ (\ ) The NodePath to the node that is the target for the Jiggle modification. This node is what the Jiggle chain will attempt to rotate the bone chain to. @@ -220,8 +220,8 @@ The NodePath to the node that is the target for the Jiggle modification. This no .. rst-class:: classref-property-setget -- void **set_use_gravity** **(** :ref:`bool` value **)** -- :ref:`bool` **get_use_gravity** **(** **)** +- |void| **set_use_gravity**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_gravity**\ (\ ) Whether the gravity vector, :ref:`gravity`, should be applied to the Jiggle joints, assuming they are not overriding the default settings. @@ -238,7 +238,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_collision_mask** **(** **)** |const| +:ref:`int` **get_collision_mask**\ (\ ) |const| Returns the collision mask used by the Jiggle modifier when collisions are enabled. @@ -250,7 +250,7 @@ Returns the collision mask used by the Jiggle modifier when collisions are enabl .. rst-class:: classref-method -:ref:`NodePath` **get_jiggle_joint_bone2d_node** **(** :ref:`int` joint_idx **)** |const| +:ref:`NodePath` **get_jiggle_joint_bone2d_node**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns the :ref:`Bone2D` node assigned to the Jiggle joint at ``joint_idx``. @@ -262,7 +262,7 @@ Returns the :ref:`Bone2D` node assigned to the Jiggle joint at ``j .. rst-class:: classref-method -:ref:`int` **get_jiggle_joint_bone_index** **(** :ref:`int` joint_idx **)** |const| +:ref:`int` **get_jiggle_joint_bone_index**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns the index of the :ref:`Bone2D` node assigned to the Jiggle joint at ``joint_idx``. @@ -274,7 +274,7 @@ Returns the index of the :ref:`Bone2D` node assigned to the Jiggle .. rst-class:: classref-method -:ref:`float` **get_jiggle_joint_damping** **(** :ref:`int` joint_idx **)** |const| +:ref:`float` **get_jiggle_joint_damping**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns the amount of damping of the Jiggle joint at ``joint_idx``. @@ -286,7 +286,7 @@ Returns the amount of damping of the Jiggle joint at ``joint_idx``. .. rst-class:: classref-method -:ref:`Vector2` **get_jiggle_joint_gravity** **(** :ref:`int` joint_idx **)** |const| +:ref:`Vector2` **get_jiggle_joint_gravity**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns a :ref:`Vector2` representing the amount of gravity the Jiggle joint at ``joint_idx`` is influenced by. @@ -298,7 +298,7 @@ Returns a :ref:`Vector2` representing the amount of gravity the J .. rst-class:: classref-method -:ref:`float` **get_jiggle_joint_mass** **(** :ref:`int` joint_idx **)** |const| +:ref:`float` **get_jiggle_joint_mass**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns the amount of mass of the jiggle joint at ``joint_idx``. @@ -310,7 +310,7 @@ Returns the amount of mass of the jiggle joint at ``joint_idx``. .. rst-class:: classref-method -:ref:`bool` **get_jiggle_joint_override** **(** :ref:`int` joint_idx **)** |const| +:ref:`bool` **get_jiggle_joint_override**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns a boolean that indicates whether the joint at ``joint_idx`` is overriding the default Jiggle joint data defined in the modification. @@ -322,7 +322,7 @@ Returns a boolean that indicates whether the joint at ``joint_idx`` is overridin .. rst-class:: classref-method -:ref:`float` **get_jiggle_joint_stiffness** **(** :ref:`int` joint_idx **)** |const| +:ref:`float` **get_jiggle_joint_stiffness**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns the stiffness of the Jiggle joint at ``joint_idx``. @@ -334,7 +334,7 @@ Returns the stiffness of the Jiggle joint at ``joint_idx``. .. rst-class:: classref-method -:ref:`bool` **get_jiggle_joint_use_gravity** **(** :ref:`int` joint_idx **)** |const| +:ref:`bool` **get_jiggle_joint_use_gravity**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns a boolean that indicates whether the joint at ``joint_idx`` is using gravity or not. @@ -346,7 +346,7 @@ Returns a boolean that indicates whether the joint at ``joint_idx`` is using gra .. rst-class:: classref-method -:ref:`bool` **get_use_colliders** **(** **)** |const| +:ref:`bool` **get_use_colliders**\ (\ ) |const| Returns whether the jiggle modifier is taking physics colliders into account when solving. @@ -358,7 +358,7 @@ Returns whether the jiggle modifier is taking physics colliders into account whe .. rst-class:: classref-method -void **set_collision_mask** **(** :ref:`int` collision_mask **)** +|void| **set_collision_mask**\ (\ collision_mask\: :ref:`int`\ ) Sets the collision mask that the Jiggle modifier will use when reacting to colliders, if the Jiggle modifier is set to take colliders into account. @@ -370,7 +370,7 @@ Sets the collision mask that the Jiggle modifier will use when reacting to colli .. rst-class:: classref-method -void **set_jiggle_joint_bone2d_node** **(** :ref:`int` joint_idx, :ref:`NodePath` bone2d_node **)** +|void| **set_jiggle_joint_bone2d_node**\ (\ joint_idx\: :ref:`int`, bone2d_node\: :ref:`NodePath`\ ) Sets the :ref:`Bone2D` node assigned to the Jiggle joint at ``joint_idx``. @@ -382,7 +382,7 @@ Sets the :ref:`Bone2D` node assigned to the Jiggle joint at ``join .. rst-class:: classref-method -void **set_jiggle_joint_bone_index** **(** :ref:`int` joint_idx, :ref:`int` bone_idx **)** +|void| **set_jiggle_joint_bone_index**\ (\ joint_idx\: :ref:`int`, bone_idx\: :ref:`int`\ ) Sets the bone index, ``bone_idx``, of the Jiggle joint at ``joint_idx``. When possible, this will also update the ``bone2d_node`` of the Jiggle joint based on data provided by the linked skeleton. @@ -394,7 +394,7 @@ Sets the bone index, ``bone_idx``, of the Jiggle joint at ``joint_idx``. When po .. rst-class:: classref-method -void **set_jiggle_joint_damping** **(** :ref:`int` joint_idx, :ref:`float` damping **)** +|void| **set_jiggle_joint_damping**\ (\ joint_idx\: :ref:`int`, damping\: :ref:`float`\ ) Sets the amount of damping of the Jiggle joint at ``joint_idx``. @@ -406,7 +406,7 @@ Sets the amount of damping of the Jiggle joint at ``joint_idx``. .. rst-class:: classref-method -void **set_jiggle_joint_gravity** **(** :ref:`int` joint_idx, :ref:`Vector2` gravity **)** +|void| **set_jiggle_joint_gravity**\ (\ joint_idx\: :ref:`int`, gravity\: :ref:`Vector2`\ ) Sets the gravity vector of the Jiggle joint at ``joint_idx``. @@ -418,7 +418,7 @@ Sets the gravity vector of the Jiggle joint at ``joint_idx``. .. rst-class:: classref-method -void **set_jiggle_joint_mass** **(** :ref:`int` joint_idx, :ref:`float` mass **)** +|void| **set_jiggle_joint_mass**\ (\ joint_idx\: :ref:`int`, mass\: :ref:`float`\ ) Sets the of mass of the Jiggle joint at ``joint_idx``. @@ -430,7 +430,7 @@ Sets the of mass of the Jiggle joint at ``joint_idx``. .. rst-class:: classref-method -void **set_jiggle_joint_override** **(** :ref:`int` joint_idx, :ref:`bool` override **)** +|void| **set_jiggle_joint_override**\ (\ joint_idx\: :ref:`int`, override\: :ref:`bool`\ ) Sets whether the Jiggle joint at ``joint_idx`` should override the default Jiggle joint settings. Setting this to ``true`` will make the joint use its own settings rather than the default ones attached to the modification. @@ -442,7 +442,7 @@ Sets whether the Jiggle joint at ``joint_idx`` should override the default Jiggl .. rst-class:: classref-method -void **set_jiggle_joint_stiffness** **(** :ref:`int` joint_idx, :ref:`float` stiffness **)** +|void| **set_jiggle_joint_stiffness**\ (\ joint_idx\: :ref:`int`, stiffness\: :ref:`float`\ ) Sets the of stiffness of the Jiggle joint at ``joint_idx``. @@ -454,7 +454,7 @@ Sets the of stiffness of the Jiggle joint at ``joint_idx``. .. rst-class:: classref-method -void **set_jiggle_joint_use_gravity** **(** :ref:`int` joint_idx, :ref:`bool` use_gravity **)** +|void| **set_jiggle_joint_use_gravity**\ (\ joint_idx\: :ref:`int`, use_gravity\: :ref:`bool`\ ) Sets whether the Jiggle joint at ``joint_idx`` should use gravity. @@ -466,7 +466,7 @@ Sets whether the Jiggle joint at ``joint_idx`` should use gravity. .. rst-class:: classref-method -void **set_use_colliders** **(** :ref:`bool` use_colliders **)** +|void| **set_use_colliders**\ (\ use_colliders\: :ref:`bool`\ ) If ``true``, the Jiggle modifier will take colliders into account, keeping them from entering into these collision objects. @@ -477,3 +477,4 @@ If ``true``, the Jiggle modifier will take colliders into account, keeping them .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_skeletonmodification2dlookat.rst b/classes/class_skeletonmodification2dlookat.rst index 2fd41e0e1c1..a4cf3f595a4 100644 --- a/classes/class_skeletonmodification2dlookat.rst +++ b/classes/class_skeletonmodification2dlookat.rst @@ -47,27 +47,27 @@ Methods .. table:: :widths: auto - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_additional_rotation` **(** **)** |const| | - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_constraint_angle_invert` **(** **)** |const| | - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_constraint_angle_max` **(** **)** |const| | - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_constraint_angle_min` **(** **)** |const| | - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_enable_constraint` **(** **)** |const| | - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_additional_rotation` **(** :ref:`float` rotation **)** | - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_constraint_angle_invert` **(** :ref:`bool` invert **)** | - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_constraint_angle_max` **(** :ref:`float` angle_max **)** | - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_constraint_angle_min` **(** :ref:`float` angle_min **)** | - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_enable_constraint` **(** :ref:`bool` enable_constraint **)** | - +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_additional_rotation`\ (\ ) |const| | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_constraint_angle_invert`\ (\ ) |const| | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_constraint_angle_max`\ (\ ) |const| | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_constraint_angle_min`\ (\ ) |const| | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_enable_constraint`\ (\ ) |const| | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_additional_rotation`\ (\ rotation\: :ref:`float`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_constraint_angle_invert`\ (\ invert\: :ref:`bool`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_constraint_angle_max`\ (\ angle_max\: :ref:`float`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_constraint_angle_min`\ (\ angle_min\: :ref:`float`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_enable_constraint`\ (\ enable_constraint\: :ref:`bool`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -86,8 +86,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bone2d_node** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_bone2d_node** **(** **)** +- |void| **set_bone2d_node**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_bone2d_node**\ (\ ) The :ref:`Bone2D` node that the modification will operate on. @@ -103,8 +103,8 @@ The :ref:`Bone2D` node that the modification will operate on. .. rst-class:: classref-property-setget -- void **set_bone_index** **(** :ref:`int` value **)** -- :ref:`int` **get_bone_index** **(** **)** +- |void| **set_bone_index**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_bone_index**\ (\ ) The index of the :ref:`Bone2D` node that the modification will operate on. @@ -120,8 +120,8 @@ The index of the :ref:`Bone2D` node that the modification will ope .. rst-class:: classref-property-setget -- void **set_target_node** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_target_node** **(** **)** +- |void| **set_target_node**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_target_node**\ (\ ) The NodePath to the node that is the target for the LookAt modification. This node is what the modification will rotate the :ref:`Bone2D` to. @@ -138,7 +138,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_additional_rotation** **(** **)** |const| +:ref:`float` **get_additional_rotation**\ (\ ) |const| Returns the amount of additional rotation that is applied after the LookAt modification executes. @@ -150,7 +150,7 @@ Returns the amount of additional rotation that is applied after the LookAt modif .. rst-class:: classref-method -:ref:`bool` **get_constraint_angle_invert** **(** **)** |const| +:ref:`bool` **get_constraint_angle_invert**\ (\ ) |const| Returns whether the constraints to this modification are inverted or not. @@ -162,7 +162,7 @@ Returns whether the constraints to this modification are inverted or not. .. rst-class:: classref-method -:ref:`float` **get_constraint_angle_max** **(** **)** |const| +:ref:`float` **get_constraint_angle_max**\ (\ ) |const| Returns the constraint's maximum allowed angle. @@ -174,7 +174,7 @@ Returns the constraint's maximum allowed angle. .. rst-class:: classref-method -:ref:`float` **get_constraint_angle_min** **(** **)** |const| +:ref:`float` **get_constraint_angle_min**\ (\ ) |const| Returns the constraint's minimum allowed angle. @@ -186,7 +186,7 @@ Returns the constraint's minimum allowed angle. .. rst-class:: classref-method -:ref:`bool` **get_enable_constraint** **(** **)** |const| +:ref:`bool` **get_enable_constraint**\ (\ ) |const| Returns ``true`` if the LookAt modification is using constraints. @@ -198,7 +198,7 @@ Returns ``true`` if the LookAt modification is using constraints. .. rst-class:: classref-method -void **set_additional_rotation** **(** :ref:`float` rotation **)** +|void| **set_additional_rotation**\ (\ rotation\: :ref:`float`\ ) Sets the amount of additional rotation that is to be applied after executing the modification. This allows for offsetting the results by the inputted rotation amount. @@ -210,7 +210,7 @@ Sets the amount of additional rotation that is to be applied after executing the .. rst-class:: classref-method -void **set_constraint_angle_invert** **(** :ref:`bool` invert **)** +|void| **set_constraint_angle_invert**\ (\ invert\: :ref:`bool`\ ) When ``true``, the modification will use an inverted joint constraint. @@ -224,7 +224,7 @@ An inverted joint constraint only constraints the :ref:`Bone2D` to .. rst-class:: classref-method -void **set_constraint_angle_max** **(** :ref:`float` angle_max **)** +|void| **set_constraint_angle_max**\ (\ angle_max\: :ref:`float`\ ) Sets the constraint's maximum allowed angle. @@ -236,7 +236,7 @@ Sets the constraint's maximum allowed angle. .. rst-class:: classref-method -void **set_constraint_angle_min** **(** :ref:`float` angle_min **)** +|void| **set_constraint_angle_min**\ (\ angle_min\: :ref:`float`\ ) Sets the constraint's minimum allowed angle. @@ -248,7 +248,7 @@ Sets the constraint's minimum allowed angle. .. rst-class:: classref-method -void **set_enable_constraint** **(** :ref:`bool` enable_constraint **)** +|void| **set_enable_constraint**\ (\ enable_constraint\: :ref:`bool`\ ) Sets whether this modification will use constraints or not. When ``true``, constraints will be applied when solving the LookAt modification. @@ -259,3 +259,4 @@ Sets whether this modification will use constraints or not. When ``true``, const .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_skeletonmodification2dphysicalbones.rst b/classes/class_skeletonmodification2dphysicalbones.rst index 2fc54ae2ba9..1a8d6a948d8 100644 --- a/classes/class_skeletonmodification2dphysicalbones.rst +++ b/classes/class_skeletonmodification2dphysicalbones.rst @@ -10,7 +10,7 @@ SkeletonModification2DPhysicalBones =================================== -**Experimental:** This class may be changed or removed in future versions. +**Experimental:** Physical bones may be changed in the future to perform the position update of :ref:`Bone2D` on their own, without needing this resource. **Inherits:** :ref:`SkeletonModification2D` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` @@ -23,8 +23,6 @@ Description This modification takes the transforms of :ref:`PhysicalBone2D` nodes and applies them to :ref:`Bone2D` nodes. This allows the :ref:`Bone2D` nodes to react to physics thanks to the linked :ref:`PhysicalBone2D` nodes. -Experimental. Physical bones may be changed in the future to perform the position update of :ref:`Bone2D` on their own. - .. rst-class:: classref-reftable-group Properties @@ -45,17 +43,17 @@ Methods .. table:: :widths: auto - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fetch_physical_bones` **(** **)** | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_physical_bone_node` **(** :ref:`int` joint_idx **)** |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_physical_bone_node` **(** :ref:`int` joint_idx, :ref:`NodePath` physicalbone2d_node **)** | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`start_simulation` **(** :ref:`StringName[]` bones=[] **)** | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`stop_simulation` **(** :ref:`StringName[]` bones=[] **)** | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fetch_physical_bones`\ (\ ) | + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_physical_bone_node`\ (\ joint_idx\: :ref:`int`\ ) |const| | + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_physical_bone_node`\ (\ joint_idx\: :ref:`int`, physicalbone2d_node\: :ref:`NodePath`\ ) | + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`start_simulation`\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) | + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop_simulation`\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) | + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -74,8 +72,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_physical_bone_chain_length** **(** :ref:`int` value **)** -- :ref:`int` **get_physical_bone_chain_length** **(** **)** +- |void| **set_physical_bone_chain_length**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_physical_bone_chain_length**\ (\ ) The number of :ref:`PhysicalBone2D` nodes linked in this modification. @@ -92,7 +90,7 @@ Method Descriptions .. rst-class:: classref-method -void **fetch_physical_bones** **(** **)** +|void| **fetch_physical_bones**\ (\ ) Empties the list of :ref:`PhysicalBone2D` nodes and populates it with all :ref:`PhysicalBone2D` nodes that are children of the :ref:`Skeleton2D`. @@ -104,7 +102,7 @@ Empties the list of :ref:`PhysicalBone2D` nodes and popula .. rst-class:: classref-method -:ref:`NodePath` **get_physical_bone_node** **(** :ref:`int` joint_idx **)** |const| +:ref:`NodePath` **get_physical_bone_node**\ (\ joint_idx\: :ref:`int`\ ) |const| Returns the :ref:`PhysicalBone2D` node at ``joint_idx``. @@ -116,7 +114,7 @@ Returns the :ref:`PhysicalBone2D` node at ``joint_idx``. .. rst-class:: classref-method -void **set_physical_bone_node** **(** :ref:`int` joint_idx, :ref:`NodePath` physicalbone2d_node **)** +|void| **set_physical_bone_node**\ (\ joint_idx\: :ref:`int`, physicalbone2d_node\: :ref:`NodePath`\ ) Sets the :ref:`PhysicalBone2D` node at ``joint_idx``. @@ -130,7 +128,7 @@ Sets the :ref:`PhysicalBone2D` node at ``joint_idx``. .. rst-class:: classref-method -void **start_simulation** **(** :ref:`StringName[]` bones=[] **)** +|void| **start_simulation**\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) Tell the :ref:`PhysicalBone2D` nodes to start simulating and interacting with the physics world. @@ -144,7 +142,7 @@ Optionally, an array of bone names can be passed to this function, and that will .. rst-class:: classref-method -void **stop_simulation** **(** :ref:`StringName[]` bones=[] **)** +|void| **stop_simulation**\ (\ bones\: :ref:`Array`\[:ref:`StringName`\] = []\ ) Tell the :ref:`PhysicalBone2D` nodes to stop simulating and interacting with the physics world. @@ -157,3 +155,4 @@ Optionally, an array of bone names can be passed to this function, and that will .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_skeletonmodification2dstackholder.rst b/classes/class_skeletonmodification2dstackholder.rst index 3088e6fc5f2..a17d97310f6 100644 --- a/classes/class_skeletonmodification2dstackholder.rst +++ b/classes/class_skeletonmodification2dstackholder.rst @@ -33,11 +33,11 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SkeletonModificationStack2D` | :ref:`get_held_modification_stack` **(** **)** |const| | - +-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_held_modification_stack` **(** :ref:`SkeletonModificationStack2D` held_modification_stack **)** | - +-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SkeletonModificationStack2D` | :ref:`get_held_modification_stack`\ (\ ) |const| | + +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_held_modification_stack`\ (\ held_modification_stack\: :ref:`SkeletonModificationStack2D`\ ) | + +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -52,7 +52,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`SkeletonModificationStack2D` **get_held_modification_stack** **(** **)** |const| +:ref:`SkeletonModificationStack2D` **get_held_modification_stack**\ (\ ) |const| Returns the :ref:`SkeletonModificationStack2D` that this modification is holding. @@ -64,7 +64,7 @@ Returns the :ref:`SkeletonModificationStack2D .. rst-class:: classref-method -void **set_held_modification_stack** **(** :ref:`SkeletonModificationStack2D` held_modification_stack **)** +|void| **set_held_modification_stack**\ (\ held_modification_stack\: :ref:`SkeletonModificationStack2D`\ ) Sets the :ref:`SkeletonModificationStack2D` that this modification is holding. This modification stack will then be executed when this modification is executed. @@ -75,3 +75,4 @@ Sets the :ref:`SkeletonModificationStack2D` t .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_skeletonmodification2dtwoboneik.rst b/classes/class_skeletonmodification2dtwoboneik.rst index 87698674ed7..de58e168922 100644 --- a/classes/class_skeletonmodification2dtwoboneik.rst +++ b/classes/class_skeletonmodification2dtwoboneik.rst @@ -51,23 +51,23 @@ Methods .. table:: :widths: auto - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_joint_one_bone2d_node` **(** **)** |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_joint_one_bone_idx` **(** **)** |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NodePath` | :ref:`get_joint_two_bone2d_node` **(** **)** |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_joint_two_bone_idx` **(** **)** |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_joint_one_bone2d_node` **(** :ref:`NodePath` bone2d_node **)** | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_joint_one_bone_idx` **(** :ref:`int` bone_idx **)** | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_joint_two_bone2d_node` **(** :ref:`NodePath` bone2d_node **)** | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_joint_two_bone_idx` **(** :ref:`int` bone_idx **)** | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_joint_one_bone2d_node`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_joint_one_bone_idx`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`get_joint_two_bone2d_node`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_joint_two_bone_idx`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_one_bone2d_node`\ (\ bone2d_node\: :ref:`NodePath`\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_one_bone_idx`\ (\ bone_idx\: :ref:`int`\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_two_bone2d_node`\ (\ bone2d_node\: :ref:`NodePath`\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_joint_two_bone_idx`\ (\ bone_idx\: :ref:`int`\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -86,8 +86,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_flip_bend_direction** **(** :ref:`bool` value **)** -- :ref:`bool` **get_flip_bend_direction** **(** **)** +- |void| **set_flip_bend_direction**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_flip_bend_direction**\ (\ ) If ``true``, the bones in the modification will blend outward as opposed to inwards when contracting. If ``false``, the bones will bend inwards when contracting. @@ -103,8 +103,8 @@ If ``true``, the bones in the modification will blend outward as opposed to inwa .. rst-class:: classref-property-setget -- void **set_target_maximum_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_target_maximum_distance** **(** **)** +- |void| **set_target_maximum_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_target_maximum_distance**\ (\ ) The maximum distance the target can be at. If the target is farther than this distance, the modification will solve as if it's at this maximum distance. When set to ``0``, the modification will solve without distance constraints. @@ -120,8 +120,8 @@ The maximum distance the target can be at. If the target is farther than this di .. rst-class:: classref-property-setget -- void **set_target_minimum_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_target_minimum_distance** **(** **)** +- |void| **set_target_minimum_distance**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_target_minimum_distance**\ (\ ) The minimum distance the target can be at. If the target is closer than this distance, the modification will solve as if it's at this minimum distance. When set to ``0``, the modification will solve without distance constraints. @@ -137,8 +137,8 @@ The minimum distance the target can be at. If the target is closer than this dis .. rst-class:: classref-property-setget -- void **set_target_node** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_target_node** **(** **)** +- |void| **set_target_node**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_target_node**\ (\ ) The NodePath to the node that is the target for the TwoBoneIK modification. This node is what the modification will use when bending the :ref:`Bone2D` nodes. @@ -155,7 +155,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`NodePath` **get_joint_one_bone2d_node** **(** **)** |const| +:ref:`NodePath` **get_joint_one_bone2d_node**\ (\ ) |const| Returns the :ref:`Bone2D` node that is being used as the first bone in the TwoBoneIK modification. @@ -167,7 +167,7 @@ Returns the :ref:`Bone2D` node that is being used as the first bon .. rst-class:: classref-method -:ref:`int` **get_joint_one_bone_idx** **(** **)** |const| +:ref:`int` **get_joint_one_bone_idx**\ (\ ) |const| Returns the index of the :ref:`Bone2D` node that is being used as the first bone in the TwoBoneIK modification. @@ -179,7 +179,7 @@ Returns the index of the :ref:`Bone2D` node that is being used as .. rst-class:: classref-method -:ref:`NodePath` **get_joint_two_bone2d_node** **(** **)** |const| +:ref:`NodePath` **get_joint_two_bone2d_node**\ (\ ) |const| Returns the :ref:`Bone2D` node that is being used as the second bone in the TwoBoneIK modification. @@ -191,7 +191,7 @@ Returns the :ref:`Bone2D` node that is being used as the second bo .. rst-class:: classref-method -:ref:`int` **get_joint_two_bone_idx** **(** **)** |const| +:ref:`int` **get_joint_two_bone_idx**\ (\ ) |const| Returns the index of the :ref:`Bone2D` node that is being used as the second bone in the TwoBoneIK modification. @@ -203,7 +203,7 @@ Returns the index of the :ref:`Bone2D` node that is being used as .. rst-class:: classref-method -void **set_joint_one_bone2d_node** **(** :ref:`NodePath` bone2d_node **)** +|void| **set_joint_one_bone2d_node**\ (\ bone2d_node\: :ref:`NodePath`\ ) Sets the :ref:`Bone2D` node that is being used as the first bone in the TwoBoneIK modification. @@ -215,7 +215,7 @@ Sets the :ref:`Bone2D` node that is being used as the first bone i .. rst-class:: classref-method -void **set_joint_one_bone_idx** **(** :ref:`int` bone_idx **)** +|void| **set_joint_one_bone_idx**\ (\ bone_idx\: :ref:`int`\ ) Sets the index of the :ref:`Bone2D` node that is being used as the first bone in the TwoBoneIK modification. @@ -227,7 +227,7 @@ Sets the index of the :ref:`Bone2D` node that is being used as the .. rst-class:: classref-method -void **set_joint_two_bone2d_node** **(** :ref:`NodePath` bone2d_node **)** +|void| **set_joint_two_bone2d_node**\ (\ bone2d_node\: :ref:`NodePath`\ ) Sets the :ref:`Bone2D` node that is being used as the second bone in the TwoBoneIK modification. @@ -239,7 +239,7 @@ Sets the :ref:`Bone2D` node that is being used as the second bone .. rst-class:: classref-method -void **set_joint_two_bone_idx** **(** :ref:`int` bone_idx **)** +|void| **set_joint_two_bone_idx**\ (\ bone_idx\: :ref:`int`\ ) Sets the index of the :ref:`Bone2D` node that is being used as the second bone in the TwoBoneIK modification. @@ -250,3 +250,4 @@ Sets the index of the :ref:`Bone2D` node that is being used as the .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_skeletonmodificationstack2d.rst b/classes/class_skeletonmodificationstack2d.rst index b65ca427eef..4f80b5abf6d 100644 --- a/classes/class_skeletonmodificationstack2d.rst +++ b/classes/class_skeletonmodificationstack2d.rst @@ -51,25 +51,25 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_modification` **(** :ref:`SkeletonModification2D` modification **)** | - +-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`delete_modification` **(** :ref:`int` mod_idx **)** | - +-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`enable_all_modifications` **(** :ref:`bool` enabled **)** | - +-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`execute` **(** :ref:`float` delta, :ref:`int` execution_mode **)** | - +-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_is_setup` **(** **)** |const| | - +-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SkeletonModification2D` | :ref:`get_modification` **(** :ref:`int` mod_idx **)** |const| | - +-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Skeleton2D` | :ref:`get_skeleton` **(** **)** |const| | - +-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_modification` **(** :ref:`int` mod_idx, :ref:`SkeletonModification2D` modification **)** | - +-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`setup` **(** **)** | - +-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_modification`\ (\ modification\: :ref:`SkeletonModification2D`\ ) | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`delete_modification`\ (\ mod_idx\: :ref:`int`\ ) | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`enable_all_modifications`\ (\ enabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`execute`\ (\ delta\: :ref:`float`, execution_mode\: :ref:`int`\ ) | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_is_setup`\ (\ ) |const| | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SkeletonModification2D` | :ref:`get_modification`\ (\ mod_idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Skeleton2D` | :ref:`get_skeleton`\ (\ ) |const| | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_modification`\ (\ mod_idx\: :ref:`int`, modification\: :ref:`SkeletonModification2D`\ ) | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`setup`\ (\ ) | + +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -88,8 +88,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **get_enabled** **(** **)** +- |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_enabled**\ (\ ) If ``true``, the modification's in the stack will be called. This is handled automatically through the :ref:`Skeleton2D` node. @@ -105,8 +105,8 @@ If ``true``, the modification's in the stack will be called. This is handled aut .. rst-class:: classref-property-setget -- void **set_modification_count** **(** :ref:`int` value **)** -- :ref:`int` **get_modification_count** **(** **)** +- |void| **set_modification_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_modification_count**\ (\ ) The number of modifications in the stack. @@ -122,8 +122,8 @@ The number of modifications in the stack. .. rst-class:: classref-property-setget -- void **set_strength** **(** :ref:`float` value **)** -- :ref:`float` **get_strength** **(** **)** +- |void| **set_strength**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_strength**\ (\ ) The interpolation strength of the modifications in stack. A value of ``0`` will make it where the modifications are not applied, a strength of ``0.5`` will be half applied, and a strength of ``1`` will allow the modifications to be fully applied and override the :ref:`Skeleton2D` :ref:`Bone2D` poses. @@ -140,7 +140,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_modification** **(** :ref:`SkeletonModification2D` modification **)** +|void| **add_modification**\ (\ modification\: :ref:`SkeletonModification2D`\ ) Adds the passed-in :ref:`SkeletonModification2D` to the stack. @@ -152,7 +152,7 @@ Adds the passed-in :ref:`SkeletonModification2D` t .. rst-class:: classref-method -void **delete_modification** **(** :ref:`int` mod_idx **)** +|void| **delete_modification**\ (\ mod_idx\: :ref:`int`\ ) Deletes the :ref:`SkeletonModification2D` at the index position ``mod_idx``, if it exists. @@ -164,7 +164,7 @@ Deletes the :ref:`SkeletonModification2D` at the i .. rst-class:: classref-method -void **enable_all_modifications** **(** :ref:`bool` enabled **)** +|void| **enable_all_modifications**\ (\ enabled\: :ref:`bool`\ ) Enables all :ref:`SkeletonModification2D`\ s in the stack. @@ -176,7 +176,7 @@ Enables all :ref:`SkeletonModification2D`\ s in th .. rst-class:: classref-method -void **execute** **(** :ref:`float` delta, :ref:`int` execution_mode **)** +|void| **execute**\ (\ delta\: :ref:`float`, execution_mode\: :ref:`int`\ ) Executes all of the :ref:`SkeletonModification2D`\ s in the stack that use the same execution mode as the passed-in ``execution_mode``, starting from index ``0`` to :ref:`modification_count`. @@ -190,7 +190,7 @@ Executes all of the :ref:`SkeletonModification2D`\ .. rst-class:: classref-method -:ref:`bool` **get_is_setup** **(** **)** |const| +:ref:`bool` **get_is_setup**\ (\ ) |const| Returns a boolean that indicates whether the modification stack is setup and can execute. @@ -202,7 +202,7 @@ Returns a boolean that indicates whether the modification stack is setup and can .. rst-class:: classref-method -:ref:`SkeletonModification2D` **get_modification** **(** :ref:`int` mod_idx **)** |const| +:ref:`SkeletonModification2D` **get_modification**\ (\ mod_idx\: :ref:`int`\ ) |const| Returns the :ref:`SkeletonModification2D` at the passed-in index, ``mod_idx``. @@ -214,7 +214,7 @@ Returns the :ref:`SkeletonModification2D` at the p .. rst-class:: classref-method -:ref:`Skeleton2D` **get_skeleton** **(** **)** |const| +:ref:`Skeleton2D` **get_skeleton**\ (\ ) |const| Returns the :ref:`Skeleton2D` node that the SkeletonModificationStack2D is bound to. @@ -226,7 +226,7 @@ Returns the :ref:`Skeleton2D` node that the SkeletonModificati .. rst-class:: classref-method -void **set_modification** **(** :ref:`int` mod_idx, :ref:`SkeletonModification2D` modification **)** +|void| **set_modification**\ (\ mod_idx\: :ref:`int`, modification\: :ref:`SkeletonModification2D`\ ) Sets the modification at ``mod_idx`` to the passed-in modification, ``modification``. @@ -238,7 +238,7 @@ Sets the modification at ``mod_idx`` to the passed-in modification, ``modificati .. rst-class:: classref-method -void **setup** **(** **)** +|void| **setup**\ (\ ) Sets up the modification stack so it can execute. This function should be called by :ref:`Skeleton2D` and shouldn't be manually called unless you know what you are doing. @@ -249,3 +249,4 @@ Sets up the modification stack so it can execute. This function should be called .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_skeletonprofile.rst b/classes/class_skeletonprofile.rst index 0080d0a1525..a999793306e 100644 --- a/classes/class_skeletonprofile.rst +++ b/classes/class_skeletonprofile.rst @@ -58,45 +58,45 @@ Methods .. table:: :widths: auto - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find_bone` **(** :ref:`StringName` bone_name **)** |const| | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_bone_name` **(** :ref:`int` bone_idx **)** |const| | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_bone_parent` **(** :ref:`int` bone_idx **)** |const| | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_bone_tail` **(** :ref:`int` bone_idx **)** |const| | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_group` **(** :ref:`int` bone_idx **)** |const| | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_group_name` **(** :ref:`int` group_idx **)** |const| | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_handle_offset` **(** :ref:`int` bone_idx **)** |const| | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`get_reference_pose` **(** :ref:`int` bone_idx **)** |const| | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TailDirection` | :ref:`get_tail_direction` **(** :ref:`int` bone_idx **)** |const| | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_texture` **(** :ref:`int` group_idx **)** |const| | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bone_name` **(** :ref:`int` bone_idx, :ref:`StringName` bone_name **)** | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bone_parent` **(** :ref:`int` bone_idx, :ref:`StringName` bone_parent **)** | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bone_tail` **(** :ref:`int` bone_idx, :ref:`StringName` bone_tail **)** | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_group` **(** :ref:`int` bone_idx, :ref:`StringName` group **)** | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_group_name` **(** :ref:`int` group_idx, :ref:`StringName` group_name **)** | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_handle_offset` **(** :ref:`int` bone_idx, :ref:`Vector2` handle_offset **)** | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_reference_pose` **(** :ref:`int` bone_idx, :ref:`Transform3D` bone_name **)** | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tail_direction` **(** :ref:`int` bone_idx, :ref:`TailDirection` tail_direction **)** | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_texture` **(** :ref:`int` group_idx, :ref:`Texture2D` texture **)** | - +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find_bone`\ (\ bone_name\: :ref:`StringName`\ ) |const| | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_bone_name`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_bone_parent`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_bone_tail`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_group`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_group_name`\ (\ group_idx\: :ref:`int`\ ) |const| | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_handle_offset`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`get_reference_pose`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TailDirection` | :ref:`get_tail_direction`\ (\ bone_idx\: :ref:`int`\ ) |const| | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_texture`\ (\ group_idx\: :ref:`int`\ ) |const| | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bone_name`\ (\ bone_idx\: :ref:`int`, bone_name\: :ref:`StringName`\ ) | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bone_parent`\ (\ bone_idx\: :ref:`int`, bone_parent\: :ref:`StringName`\ ) | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bone_tail`\ (\ bone_idx\: :ref:`int`, bone_tail\: :ref:`StringName`\ ) | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_group`\ (\ bone_idx\: :ref:`int`, group\: :ref:`StringName`\ ) | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_group_name`\ (\ group_idx\: :ref:`int`, group_name\: :ref:`StringName`\ ) | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_handle_offset`\ (\ bone_idx\: :ref:`int`, handle_offset\: :ref:`Vector2`\ ) | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_reference_pose`\ (\ bone_idx\: :ref:`int`, bone_name\: :ref:`Transform3D`\ ) | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tail_direction`\ (\ bone_idx\: :ref:`int`, tail_direction\: :ref:`TailDirection`\ ) | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_texture`\ (\ group_idx\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | + +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -111,7 +111,7 @@ Signals .. rst-class:: classref-signal -**profile_updated** **(** **)** +**profile_updated**\ (\ ) This signal is emitted when change the value in profile. This is used to update key name in the :ref:`BoneMap` and to redraw the :ref:`BoneMap` editor. @@ -173,8 +173,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bone_size** **(** :ref:`int` value **)** -- :ref:`int` **get_bone_size** **(** **)** +- |void| **set_bone_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_bone_size**\ (\ ) The amount of bones in retargeting section's :ref:`BoneMap` editor. For example, :ref:`SkeletonProfileHumanoid` has 56 bones. @@ -192,8 +192,8 @@ The size of elements in :ref:`BoneMap` updates when changing this .. rst-class:: classref-property-setget -- void **set_group_size** **(** :ref:`int` value **)** -- :ref:`int` **get_group_size** **(** **)** +- |void| **set_group_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_group_size**\ (\ ) The amount of groups of bones in retargeting section's :ref:`BoneMap` editor. For example, :ref:`SkeletonProfileHumanoid` has 4 groups. @@ -211,8 +211,8 @@ This property exists to separate the bone list into several sections in the edit .. rst-class:: classref-property-setget -- void **set_root_bone** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_root_bone** **(** **)** +- |void| **set_root_bone**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_root_bone**\ (\ ) A bone name that will be used as the root bone in :ref:`AnimationTree`. This should be the bone of the parent of hips that exists at the world origin. @@ -228,8 +228,8 @@ A bone name that will be used as the root bone in :ref:`AnimationTree` value **)** -- :ref:`StringName` **get_scale_base_bone** **(** **)** +- |void| **set_scale_base_bone**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_scale_base_bone**\ (\ ) A bone name which will use model's height as the coefficient for normalization. For example, :ref:`SkeletonProfileHumanoid` defines it as ``Hips``. @@ -246,7 +246,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **find_bone** **(** :ref:`StringName` bone_name **)** |const| +:ref:`int` **find_bone**\ (\ bone_name\: :ref:`StringName`\ ) |const| Returns the bone index that matches ``bone_name`` as its name. @@ -258,7 +258,7 @@ Returns the bone index that matches ``bone_name`` as its name. .. rst-class:: classref-method -:ref:`StringName` **get_bone_name** **(** :ref:`int` bone_idx **)** |const| +:ref:`StringName` **get_bone_name**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns the name of the bone at ``bone_idx`` that will be the key name in the :ref:`BoneMap`. @@ -272,7 +272,7 @@ In the retargeting process, the returned bone name is the bone name of the targe .. rst-class:: classref-method -:ref:`StringName` **get_bone_parent** **(** :ref:`int` bone_idx **)** |const| +:ref:`StringName` **get_bone_parent**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns the name of the bone which is the parent to the bone at ``bone_idx``. The result is empty if the bone has no parent. @@ -284,7 +284,7 @@ Returns the name of the bone which is the parent to the bone at ``bone_idx``. Th .. rst-class:: classref-method -:ref:`StringName` **get_bone_tail** **(** :ref:`int` bone_idx **)** |const| +:ref:`StringName` **get_bone_tail**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns the name of the bone which is the tail of the bone at ``bone_idx``. @@ -296,7 +296,7 @@ Returns the name of the bone which is the tail of the bone at ``bone_idx``. .. rst-class:: classref-method -:ref:`StringName` **get_group** **(** :ref:`int` bone_idx **)** |const| +:ref:`StringName` **get_group**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns the group of the bone at ``bone_idx``. @@ -308,7 +308,7 @@ Returns the group of the bone at ``bone_idx``. .. rst-class:: classref-method -:ref:`StringName` **get_group_name** **(** :ref:`int` group_idx **)** |const| +:ref:`StringName` **get_group_name**\ (\ group_idx\: :ref:`int`\ ) |const| Returns the name of the group at ``group_idx`` that will be the drawing group in the :ref:`BoneMap` editor. @@ -320,7 +320,7 @@ Returns the name of the group at ``group_idx`` that will be the drawing group in .. rst-class:: classref-method -:ref:`Vector2` **get_handle_offset** **(** :ref:`int` bone_idx **)** |const| +:ref:`Vector2` **get_handle_offset**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns the offset of the bone at ``bone_idx`` that will be the button position in the :ref:`BoneMap` editor. @@ -334,7 +334,7 @@ This is the offset with origin at the top left corner of the square. .. rst-class:: classref-method -:ref:`Transform3D` **get_reference_pose** **(** :ref:`int` bone_idx **)** |const| +:ref:`Transform3D` **get_reference_pose**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns the reference pose transform for bone ``bone_idx``. @@ -346,7 +346,7 @@ Returns the reference pose transform for bone ``bone_idx``. .. rst-class:: classref-method -:ref:`TailDirection` **get_tail_direction** **(** :ref:`int` bone_idx **)** |const| +:ref:`TailDirection` **get_tail_direction**\ (\ bone_idx\: :ref:`int`\ ) |const| Returns the tail direction of the bone at ``bone_idx``. @@ -358,7 +358,7 @@ Returns the tail direction of the bone at ``bone_idx``. .. rst-class:: classref-method -:ref:`Texture2D` **get_texture** **(** :ref:`int` group_idx **)** |const| +:ref:`Texture2D` **get_texture**\ (\ group_idx\: :ref:`int`\ ) |const| Returns the texture of the group at ``group_idx`` that will be the drawing group background image in the :ref:`BoneMap` editor. @@ -370,7 +370,7 @@ Returns the texture of the group at ``group_idx`` that will be the drawing group .. rst-class:: classref-method -void **set_bone_name** **(** :ref:`int` bone_idx, :ref:`StringName` bone_name **)** +|void| **set_bone_name**\ (\ bone_idx\: :ref:`int`, bone_name\: :ref:`StringName`\ ) Sets the name of the bone at ``bone_idx`` that will be the key name in the :ref:`BoneMap`. @@ -384,7 +384,7 @@ In the retargeting process, the setting bone name is the bone name of the target .. rst-class:: classref-method -void **set_bone_parent** **(** :ref:`int` bone_idx, :ref:`StringName` bone_parent **)** +|void| **set_bone_parent**\ (\ bone_idx\: :ref:`int`, bone_parent\: :ref:`StringName`\ ) Sets the bone with name ``bone_parent`` as the parent of the bone at ``bone_idx``. If an empty string is passed, then the bone has no parent. @@ -396,7 +396,7 @@ Sets the bone with name ``bone_parent`` as the parent of the bone at ``bone_idx` .. rst-class:: classref-method -void **set_bone_tail** **(** :ref:`int` bone_idx, :ref:`StringName` bone_tail **)** +|void| **set_bone_tail**\ (\ bone_idx\: :ref:`int`, bone_tail\: :ref:`StringName`\ ) Sets the bone with name ``bone_tail`` as the tail of the bone at ``bone_idx``. @@ -408,7 +408,7 @@ Sets the bone with name ``bone_tail`` as the tail of the bone at ``bone_idx``. .. rst-class:: classref-method -void **set_group** **(** :ref:`int` bone_idx, :ref:`StringName` group **)** +|void| **set_group**\ (\ bone_idx\: :ref:`int`, group\: :ref:`StringName`\ ) Sets the group of the bone at ``bone_idx``. @@ -420,7 +420,7 @@ Sets the group of the bone at ``bone_idx``. .. rst-class:: classref-method -void **set_group_name** **(** :ref:`int` group_idx, :ref:`StringName` group_name **)** +|void| **set_group_name**\ (\ group_idx\: :ref:`int`, group_name\: :ref:`StringName`\ ) Sets the name of the group at ``group_idx`` that will be the drawing group in the :ref:`BoneMap` editor. @@ -432,7 +432,7 @@ Sets the name of the group at ``group_idx`` that will be the drawing group in th .. rst-class:: classref-method -void **set_handle_offset** **(** :ref:`int` bone_idx, :ref:`Vector2` handle_offset **)** +|void| **set_handle_offset**\ (\ bone_idx\: :ref:`int`, handle_offset\: :ref:`Vector2`\ ) Sets the offset of the bone at ``bone_idx`` that will be the button position in the :ref:`BoneMap` editor. @@ -446,7 +446,7 @@ This is the offset with origin at the top left corner of the square. .. rst-class:: classref-method -void **set_reference_pose** **(** :ref:`int` bone_idx, :ref:`Transform3D` bone_name **)** +|void| **set_reference_pose**\ (\ bone_idx\: :ref:`int`, bone_name\: :ref:`Transform3D`\ ) Sets the reference pose transform for bone ``bone_idx``. @@ -458,7 +458,7 @@ Sets the reference pose transform for bone ``bone_idx``. .. rst-class:: classref-method -void **set_tail_direction** **(** :ref:`int` bone_idx, :ref:`TailDirection` tail_direction **)** +|void| **set_tail_direction**\ (\ bone_idx\: :ref:`int`, tail_direction\: :ref:`TailDirection`\ ) Sets the tail direction of the bone at ``bone_idx``. @@ -472,7 +472,7 @@ Sets the tail direction of the bone at ``bone_idx``. .. rst-class:: classref-method -void **set_texture** **(** :ref:`int` group_idx, :ref:`Texture2D` texture **)** +|void| **set_texture**\ (\ group_idx\: :ref:`int`, texture\: :ref:`Texture2D`\ ) Sets the texture of the group at ``group_idx`` that will be the drawing group background image in the :ref:`BoneMap` editor. @@ -483,3 +483,4 @@ Sets the texture of the group at ``group_idx`` that will be the drawing group ba .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_skeletonprofilehumanoid.rst b/classes/class_skeletonprofilehumanoid.rst index efb6b834796..2f89d331d36 100644 --- a/classes/class_skeletonprofilehumanoid.rst +++ b/classes/class_skeletonprofilehumanoid.rst @@ -112,3 +112,4 @@ Properties .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_skin.rst b/classes/class_skin.rst index 298fa7e6b07..b6b247932c6 100644 --- a/classes/class_skin.rst +++ b/classes/class_skin.rst @@ -24,29 +24,29 @@ Methods .. table:: :widths: auto - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_bind` **(** :ref:`int` bone, :ref:`Transform3D` pose **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_named_bind` **(** :ref:`String` name, :ref:`Transform3D` pose **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_binds` **(** **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_bind_bone` **(** :ref:`int` bind_index **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_bind_count` **(** **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_bind_name` **(** :ref:`int` bind_index **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`get_bind_pose` **(** :ref:`int` bind_index **)** |const| | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bind_bone` **(** :ref:`int` bind_index, :ref:`int` bone **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bind_count` **(** :ref:`int` bind_count **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bind_name` **(** :ref:`int` bind_index, :ref:`StringName` name **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bind_pose` **(** :ref:`int` bind_index, :ref:`Transform3D` pose **)** | - +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_bind`\ (\ bone\: :ref:`int`, pose\: :ref:`Transform3D`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_named_bind`\ (\ name\: :ref:`String`, pose\: :ref:`Transform3D`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_binds`\ (\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_bind_bone`\ (\ bind_index\: :ref:`int`\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_bind_count`\ (\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_bind_name`\ (\ bind_index\: :ref:`int`\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`get_bind_pose`\ (\ bind_index\: :ref:`int`\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bind_bone`\ (\ bind_index\: :ref:`int`, bone\: :ref:`int`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bind_count`\ (\ bind_count\: :ref:`int`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bind_name`\ (\ bind_index\: :ref:`int`, name\: :ref:`StringName`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bind_pose`\ (\ bind_index\: :ref:`int`, pose\: :ref:`Transform3D`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -61,7 +61,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_bind** **(** :ref:`int` bone, :ref:`Transform3D` pose **)** +|void| **add_bind**\ (\ bone\: :ref:`int`, pose\: :ref:`Transform3D`\ ) .. container:: contribute @@ -75,7 +75,7 @@ void **add_bind** **(** :ref:`int` bone, :ref:`Transform3D` name, :ref:`Transform3D` pose **)** +|void| **add_named_bind**\ (\ name\: :ref:`String`, pose\: :ref:`Transform3D`\ ) .. container:: contribute @@ -89,7 +89,7 @@ void **add_named_bind** **(** :ref:`String` name, :ref:`Transform3 .. rst-class:: classref-method -void **clear_binds** **(** **)** +|void| **clear_binds**\ (\ ) .. container:: contribute @@ -103,7 +103,7 @@ void **clear_binds** **(** **)** .. rst-class:: classref-method -:ref:`int` **get_bind_bone** **(** :ref:`int` bind_index **)** |const| +:ref:`int` **get_bind_bone**\ (\ bind_index\: :ref:`int`\ ) |const| .. container:: contribute @@ -117,7 +117,7 @@ void **clear_binds** **(** **)** .. rst-class:: classref-method -:ref:`int` **get_bind_count** **(** **)** |const| +:ref:`int` **get_bind_count**\ (\ ) |const| .. container:: contribute @@ -131,7 +131,7 @@ void **clear_binds** **(** **)** .. rst-class:: classref-method -:ref:`StringName` **get_bind_name** **(** :ref:`int` bind_index **)** |const| +:ref:`StringName` **get_bind_name**\ (\ bind_index\: :ref:`int`\ ) |const| .. container:: contribute @@ -145,7 +145,7 @@ void **clear_binds** **(** **)** .. rst-class:: classref-method -:ref:`Transform3D` **get_bind_pose** **(** :ref:`int` bind_index **)** |const| +:ref:`Transform3D` **get_bind_pose**\ (\ bind_index\: :ref:`int`\ ) |const| .. container:: contribute @@ -159,7 +159,7 @@ void **clear_binds** **(** **)** .. rst-class:: classref-method -void **set_bind_bone** **(** :ref:`int` bind_index, :ref:`int` bone **)** +|void| **set_bind_bone**\ (\ bind_index\: :ref:`int`, bone\: :ref:`int`\ ) .. container:: contribute @@ -173,7 +173,7 @@ void **set_bind_bone** **(** :ref:`int` bind_index, :ref:`int` bind_count **)** +|void| **set_bind_count**\ (\ bind_count\: :ref:`int`\ ) .. container:: contribute @@ -187,7 +187,7 @@ void **set_bind_count** **(** :ref:`int` bind_count **)** .. rst-class:: classref-method -void **set_bind_name** **(** :ref:`int` bind_index, :ref:`StringName` name **)** +|void| **set_bind_name**\ (\ bind_index\: :ref:`int`, name\: :ref:`StringName`\ ) .. container:: contribute @@ -201,7 +201,7 @@ void **set_bind_name** **(** :ref:`int` bind_index, :ref:`StringName< .. rst-class:: classref-method -void **set_bind_pose** **(** :ref:`int` bind_index, :ref:`Transform3D` pose **)** +|void| **set_bind_pose**\ (\ bind_index\: :ref:`int`, pose\: :ref:`Transform3D`\ ) .. container:: contribute @@ -214,3 +214,4 @@ void **set_bind_pose** **(** :ref:`int` bind_index, :ref:`Transform3D .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_skinreference.rst b/classes/class_skinreference.rst index d6b8440abef..b44bd1c069a 100644 --- a/classes/class_skinreference.rst +++ b/classes/class_skinreference.rst @@ -24,11 +24,11 @@ Methods .. table:: :widths: auto - +-------------------------+----------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_skeleton` **(** **)** |const| | - +-------------------------+----------------------------------------------------------------------------------+ - | :ref:`Skin` | :ref:`get_skin` **(** **)** |const| | - +-------------------------+----------------------------------------------------------------------------------+ + +-------------------------+----------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_skeleton`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------+ + | :ref:`Skin` | :ref:`get_skin`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -43,7 +43,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **get_skeleton** **(** **)** |const| +:ref:`RID` **get_skeleton**\ (\ ) |const| .. container:: contribute @@ -57,7 +57,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Skin` **get_skin** **(** **)** |const| +:ref:`Skin` **get_skin**\ (\ ) |const| .. container:: contribute @@ -70,3 +70,4 @@ Method Descriptions .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_sky.rst b/classes/class_sky.rst index 07ed0d2198b..f5a9c55204e 100644 --- a/classes/class_sky.rst +++ b/classes/class_sky.rst @@ -177,8 +177,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_process_mode** **(** :ref:`ProcessMode` value **)** -- :ref:`ProcessMode` **get_process_mode** **(** **)** +- |void| **set_process_mode**\ (\ value\: :ref:`ProcessMode`\ ) +- :ref:`ProcessMode` **get_process_mode**\ (\ ) Sets the method for generating the radiance map from the sky. The radiance map is a cubemap with increasingly blurry versions of the sky corresponding to different levels of roughness. Radiance maps can be expensive to calculate. See :ref:`ProcessMode` for options. @@ -194,8 +194,8 @@ Sets the method for generating the radiance map from the sky. The radiance map i .. rst-class:: classref-property-setget -- void **set_radiance_size** **(** :ref:`RadianceSize` value **)** -- :ref:`RadianceSize` **get_radiance_size** **(** **)** +- |void| **set_radiance_size**\ (\ value\: :ref:`RadianceSize`\ ) +- :ref:`RadianceSize` **get_radiance_size**\ (\ ) The **Sky**'s radiance map size. The higher the radiance map size, the more detailed the lighting from the **Sky** will be. @@ -215,8 +215,8 @@ See :ref:`RadianceSize` constants for values. .. rst-class:: classref-property-setget -- void **set_material** **(** :ref:`Material` value **)** -- :ref:`Material` **get_material** **(** **)** +- |void| **set_material**\ (\ value\: :ref:`Material`\ ) +- :ref:`Material` **get_material**\ (\ ) :ref:`Material` used to draw the background. Can be :ref:`PanoramaSkyMaterial`, :ref:`ProceduralSkyMaterial`, :ref:`PhysicalSkyMaterial`, or even a :ref:`ShaderMaterial` if you want to use your own custom shader. @@ -227,3 +227,4 @@ See :ref:`RadianceSize` constants for values. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_slider.rst b/classes/class_slider.rst index efc975a233c..0abfba2ec03 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -86,7 +86,7 @@ Signals .. rst-class:: classref-signal -**drag_ended** **(** :ref:`bool` value_changed **)** +**drag_ended**\ (\ value_changed\: :ref:`bool`\ ) Emitted when dragging stops. If ``value_changed`` is true, :ref:`Range.value` is different from the value when you started the dragging. @@ -98,7 +98,7 @@ Emitted when dragging stops. If ``value_changed`` is true, :ref:`Range.value` signal. @@ -119,8 +119,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_editable** **(** :ref:`bool` value **)** -- :ref:`bool` **is_editable** **(** **)** +- |void| **set_editable**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_editable**\ (\ ) If ``true``, the slider can be interacted with. If ``false``, the value can be changed only by code. @@ -136,8 +136,8 @@ If ``true``, the slider can be interacted with. If ``false``, the value can be c .. rst-class:: classref-property-setget -- void **set_scrollable** **(** :ref:`bool` value **)** -- :ref:`bool` **is_scrollable** **(** **)** +- |void| **set_scrollable**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_scrollable**\ (\ ) If ``true``, the value can be changed using the mouse wheel. @@ -153,8 +153,8 @@ If ``true``, the value can be changed using the mouse wheel. .. rst-class:: classref-property-setget -- void **set_ticks** **(** :ref:`int` value **)** -- :ref:`int` **get_ticks** **(** **)** +- |void| **set_ticks**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_ticks**\ (\ ) Number of ticks displayed on the slider, including border ticks. Ticks are uniformly-distributed value markers. @@ -170,8 +170,8 @@ Number of ticks displayed on the slider, including border ticks. Ticks are unifo .. rst-class:: classref-property-setget -- void **set_ticks_on_borders** **(** :ref:`bool` value **)** -- :ref:`bool` **get_ticks_on_borders** **(** **)** +- |void| **set_ticks_on_borders**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_ticks_on_borders**\ (\ ) If ``true``, the slider will display ticks for minimum and maximum values. @@ -295,3 +295,4 @@ The background for the whole slider. Affects the height or width of the :ref:`gr .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_sliderjoint3d.rst b/classes/class_sliderjoint3d.rst index 942cd6fc112..9666bba2833 100644 --- a/classes/class_sliderjoint3d.rst +++ b/classes/class_sliderjoint3d.rst @@ -83,11 +83,11 @@ Methods .. table:: :widths: auto - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_param` **(** :ref:`Param` param **)** |const| | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_param` **(** :ref:`Param` param, :ref:`float` value **)** | - +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_param`\ (\ param\: :ref:`Param`\ ) |const| | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_param`\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -305,8 +305,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The amount of damping of the rotation when the limit is surpassed. @@ -324,8 +324,8 @@ A lower damping value allows a rotation initiated by body A to travel to body B .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The lower limit of rotation in the slider. @@ -341,8 +341,8 @@ The lower limit of rotation in the slider. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The amount of restitution of the rotation when the limit is surpassed. @@ -360,8 +360,8 @@ Does not affect damping. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| A factor applied to the all rotation once the limit is surpassed. @@ -379,8 +379,8 @@ Makes all rotation slower when between 0 and 1. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The upper limit of rotation in the slider. @@ -396,8 +396,8 @@ The upper limit of rotation in the slider. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The amount of damping of the rotation in the limits. @@ -413,8 +413,8 @@ The amount of damping of the rotation in the limits. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The amount of restitution of the rotation in the limits. @@ -430,8 +430,8 @@ The amount of restitution of the rotation in the limits. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| A factor applied to the all rotation in the limits. @@ -447,8 +447,8 @@ A factor applied to the all rotation in the limits. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The amount of damping of the rotation across axes orthogonal to the slider. @@ -464,8 +464,8 @@ The amount of damping of the rotation across axes orthogonal to the slider. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The amount of restitution of the rotation across axes orthogonal to the slider. @@ -481,8 +481,8 @@ The amount of restitution of the rotation across axes orthogonal to the slider. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| A factor applied to the all rotation across axes orthogonal to the slider. @@ -498,8 +498,8 @@ A factor applied to the all rotation across axes orthogonal to the slider. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The amount of damping that happens once the limit defined by :ref:`linear_limit/lower_distance` and :ref:`linear_limit/upper_distance` is surpassed. @@ -515,8 +515,8 @@ The amount of damping that happens once the limit defined by :ref:`linear_limit/ .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The minimum difference between the pivot points on their X axis before damping happens. @@ -532,8 +532,8 @@ The minimum difference between the pivot points on their X axis before damping h .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost. @@ -549,8 +549,8 @@ The amount of restitution once the limits are surpassed. The lower, the more vel .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. @@ -566,8 +566,8 @@ A factor applied to the movement across the slider axis once the limits get surp .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The maximum difference between the pivot points on their X axis before damping happens. @@ -583,8 +583,8 @@ The maximum difference between the pivot points on their X axis before damping h .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The amount of damping inside the slider limits. @@ -600,8 +600,8 @@ The amount of damping inside the slider limits. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The amount of restitution inside the slider limits. @@ -617,8 +617,8 @@ The amount of restitution inside the slider limits. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| A factor applied to the movement across the slider axis as long as the slider is in the limits. The lower, the slower the movement. @@ -634,8 +634,8 @@ A factor applied to the movement across the slider axis as long as the slider is .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The amount of damping when movement is across axes orthogonal to the slider. @@ -651,8 +651,8 @@ The amount of damping when movement is across axes orthogonal to the slider. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The amount of restitution when movement is across axes orthogonal to the slider. @@ -668,8 +668,8 @@ The amount of restitution when movement is across axes orthogonal to the slider. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** -- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +- |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| A factor applied to the movement across axes orthogonal to the slider. @@ -686,7 +686,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +:ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| .. container:: contribute @@ -700,7 +700,7 @@ Method Descriptions .. rst-class:: classref-method -void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** +|void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) .. container:: contribute @@ -713,3 +713,4 @@ void **set_param** **(** :ref:`Param` param, :ref:`flo .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_softbody3d.rst b/classes/class_softbody3d.rst index 91bd8302eb1..2f26ce9ea82 100644 --- a/classes/class_softbody3d.rst +++ b/classes/class_softbody3d.rst @@ -70,29 +70,29 @@ Methods .. table:: :widths: auto - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsBody3D[]` | :ref:`get_collision_exceptions` **(** **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_collision_layer_value` **(** :ref:`int` layer_number **)** |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_collision_mask_value` **(** :ref:`int` layer_number **)** |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_physics_rid` **(** **)** |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_point_transform` **(** :ref:`int` point_index **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_point_pinned` **(** :ref:`int` point_index **)** |const| | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_point_pinned` **(** :ref:`int` point_index, :ref:`bool` pinned, :ref:`NodePath` attachment_path=NodePath("") **)** | - +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_collision_exception_with`\ (\ body\: :ref:`Node`\ ) | + +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`PhysicsBody3D`\] | :ref:`get_collision_exceptions`\ (\ ) | + +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_collision_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_collision_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_physics_rid`\ (\ ) |const| | + +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_point_transform`\ (\ point_index\: :ref:`int`\ ) | + +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_point_pinned`\ (\ point_index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_collision_exception_with`\ (\ body\: :ref:`Node`\ ) | + +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_point_pinned`\ (\ point_index\: :ref:`int`, pinned\: :ref:`bool`, attachment_path\: :ref:`NodePath` = NodePath("")\ ) | + +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -144,8 +144,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_collision_layer** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_layer** **(** **)** +- |void| **set_collision_layer**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_layer**\ (\ ) The physics layers this SoftBody3D **is in**. Collision objects can exist in one or more of 32 different layers. See also :ref:`collision_mask`. @@ -163,8 +163,8 @@ The physics layers this SoftBody3D **is in**. Collision objects can exist in one .. rst-class:: classref-property-setget -- void **set_collision_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_mask** **(** **)** +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) The physics layers this SoftBody3D **scans**. Collision objects can scan one or more of 32 different layers. See also :ref:`collision_layer`. @@ -182,8 +182,8 @@ The physics layers this SoftBody3D **scans**. Collision objects can scan one or .. rst-class:: classref-property-setget -- void **set_damping_coefficient** **(** :ref:`float` value **)** -- :ref:`float` **get_damping_coefficient** **(** **)** +- |void| **set_damping_coefficient**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_damping_coefficient**\ (\ ) The body's damping coefficient. Higher values will slow down the body more noticeably when forces are applied. @@ -199,8 +199,8 @@ The body's damping coefficient. Higher values will slow down the body more notic .. rst-class:: classref-property-setget -- void **set_disable_mode** **(** :ref:`DisableMode` value **)** -- :ref:`DisableMode` **get_disable_mode** **(** **)** +- |void| **set_disable_mode**\ (\ value\: :ref:`DisableMode`\ ) +- :ref:`DisableMode` **get_disable_mode**\ (\ ) Defines the behavior in physics when :ref:`Node.process_mode` is set to :ref:`Node.PROCESS_MODE_DISABLED`. See :ref:`DisableMode` for more details about the different modes. @@ -216,8 +216,8 @@ Defines the behavior in physics when :ref:`Node.process_mode` value **)** -- :ref:`float` **get_drag_coefficient** **(** **)** +- |void| **set_drag_coefficient**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_drag_coefficient**\ (\ ) The body's drag coefficient. Higher values increase this body's air resistance. @@ -235,8 +235,8 @@ The body's drag coefficient. Higher values increase this body's air resistance. .. rst-class:: classref-property-setget -- void **set_linear_stiffness** **(** :ref:`float` value **)** -- :ref:`float` **get_linear_stiffness** **(** **)** +- |void| **set_linear_stiffness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_linear_stiffness**\ (\ ) Higher values will result in a stiffer body, while lower values will increase the body's ability to bend. The value can be between ``0.0`` and ``1.0`` (inclusive). @@ -252,8 +252,8 @@ Higher values will result in a stiffer body, while lower values will increase th .. rst-class:: classref-property-setget -- void **set_parent_collision_ignore** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_parent_collision_ignore** **(** **)** +- |void| **set_parent_collision_ignore**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_parent_collision_ignore**\ (\ ) :ref:`NodePath` to a :ref:`CollisionObject3D` this SoftBody3D should avoid clipping. @@ -269,8 +269,8 @@ Higher values will result in a stiffer body, while lower values will increase th .. rst-class:: classref-property-setget -- void **set_pressure_coefficient** **(** :ref:`float` value **)** -- :ref:`float` **get_pressure_coefficient** **(** **)** +- |void| **set_pressure_coefficient**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pressure_coefficient**\ (\ ) The pressure coefficient of this soft body. Simulate pressure build-up from inside this body. Higher values increase the strength of this effect. @@ -286,8 +286,8 @@ The pressure coefficient of this soft body. Simulate pressure build-up from insi .. rst-class:: classref-property-setget -- void **set_ray_pickable** **(** :ref:`bool` value **)** -- :ref:`bool` **is_ray_pickable** **(** **)** +- |void| **set_ray_pickable**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_ray_pickable**\ (\ ) If ``true``, the **SoftBody3D** will respond to :ref:`RayCast3D`\ s. @@ -303,8 +303,8 @@ If ``true``, the **SoftBody3D** will respond to :ref:`RayCast3D .. rst-class:: classref-property-setget -- void **set_simulation_precision** **(** :ref:`int` value **)** -- :ref:`int` **get_simulation_precision** **(** **)** +- |void| **set_simulation_precision**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_simulation_precision**\ (\ ) Increasing this value will improve the resulting simulation, but can affect performance. Use with care. @@ -320,8 +320,8 @@ Increasing this value will improve the resulting simulation, but can affect perf .. rst-class:: classref-property-setget -- void **set_total_mass** **(** :ref:`float` value **)** -- :ref:`float` **get_total_mass** **(** **)** +- |void| **set_total_mass**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_total_mass**\ (\ ) The SoftBody3D's mass. @@ -338,7 +338,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_collision_exception_with** **(** :ref:`Node` body **)** +|void| **add_collision_exception_with**\ (\ body\: :ref:`Node`\ ) Adds a body to the list of bodies that this body can't collide with. @@ -350,7 +350,7 @@ Adds a body to the list of bodies that this body can't collide with. .. rst-class:: classref-method -:ref:`PhysicsBody3D[]` **get_collision_exceptions** **(** **)** +:ref:`Array`\[:ref:`PhysicsBody3D`\] **get_collision_exceptions**\ (\ ) Returns an array of nodes that were added as collision exceptions for this body. @@ -362,7 +362,7 @@ Returns an array of nodes that were added as collision exceptions for this body. .. rst-class:: classref-method -:ref:`bool` **get_collision_layer_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_collision_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`collision_layer` is enabled, given a ``layer_number`` between 1 and 32. @@ -374,7 +374,7 @@ Returns whether or not the specified layer of the :ref:`collision_layer` **get_collision_mask_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`collision_mask` is enabled, given a ``layer_number`` between 1 and 32. @@ -386,7 +386,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_physics_rid** **(** **)** |const| +:ref:`RID` **get_physics_rid**\ (\ ) |const| Returns the internal :ref:`RID` used by the :ref:`PhysicsServer3D` for this body. @@ -398,7 +398,7 @@ Returns the internal :ref:`RID` used by the :ref:`PhysicsServer3D` **get_point_transform** **(** :ref:`int` point_index **)** +:ref:`Vector3` **get_point_transform**\ (\ point_index\: :ref:`int`\ ) Returns local translation of a vertex in the surface array. @@ -410,7 +410,7 @@ Returns local translation of a vertex in the surface array. .. rst-class:: classref-method -:ref:`bool` **is_point_pinned** **(** :ref:`int` point_index **)** |const| +:ref:`bool` **is_point_pinned**\ (\ point_index\: :ref:`int`\ ) |const| Returns ``true`` if vertex is set to pinned. @@ -422,7 +422,7 @@ Returns ``true`` if vertex is set to pinned. .. rst-class:: classref-method -void **remove_collision_exception_with** **(** :ref:`Node` body **)** +|void| **remove_collision_exception_with**\ (\ body\: :ref:`Node`\ ) Removes a body from the list of bodies that this body can't collide with. @@ -434,7 +434,7 @@ Removes a body from the list of bodies that this body can't collide with. .. rst-class:: classref-method -void **set_collision_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_collision_layer_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`collision_layer`, given a ``layer_number`` between 1 and 32. @@ -446,7 +446,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. rst-class:: classref-method -void **set_collision_mask_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask`, given a ``layer_number`` between 1 and 32. @@ -458,7 +458,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi .. rst-class:: classref-method -void **set_point_pinned** **(** :ref:`int` point_index, :ref:`bool` pinned, :ref:`NodePath` attachment_path=NodePath("") **)** +|void| **set_point_pinned**\ (\ point_index\: :ref:`int`, pinned\: :ref:`bool`, attachment_path\: :ref:`NodePath` = NodePath("")\ ) Sets the pinned state of a surface vertex. When set to ``true``, the optional ``attachment_path`` can define a :ref:`Node3D` the pinned vertex will be attached to. @@ -469,3 +469,4 @@ Sets the pinned state of a surface vertex. When set to ``true``, the optional `` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_spheremesh.rst b/classes/class_spheremesh.rst index c64636372d4..bf1735dfd83 100644 --- a/classes/class_spheremesh.rst +++ b/classes/class_spheremesh.rst @@ -58,8 +58,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_height** **(** :ref:`float` value **)** -- :ref:`float` **get_height** **(** **)** +- |void| **set_height**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_height**\ (\ ) Full height of the sphere. @@ -75,8 +75,8 @@ Full height of the sphere. .. rst-class:: classref-property-setget -- void **set_is_hemisphere** **(** :ref:`bool` value **)** -- :ref:`bool` **get_is_hemisphere** **(** **)** +- |void| **set_is_hemisphere**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_is_hemisphere**\ (\ ) If ``true``, a hemisphere is created rather than a full sphere. @@ -94,8 +94,8 @@ If ``true``, a hemisphere is created rather than a full sphere. .. rst-class:: classref-property-setget -- void **set_radial_segments** **(** :ref:`int` value **)** -- :ref:`int` **get_radial_segments** **(** **)** +- |void| **set_radial_segments**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_radial_segments**\ (\ ) Number of radial segments on the sphere. @@ -111,8 +111,8 @@ Number of radial segments on the sphere. .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) Radius of sphere. @@ -128,8 +128,8 @@ Radius of sphere. .. rst-class:: classref-property-setget -- void **set_rings** **(** :ref:`int` value **)** -- :ref:`int` **get_rings** **(** **)** +- |void| **set_rings**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_rings**\ (\ ) Number of segments along the height of the sphere. @@ -140,3 +140,4 @@ Number of segments along the height of the sphere. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_sphereoccluder3d.rst b/classes/class_sphereoccluder3d.rst index a387d2f59ad..2843f9e4ea6 100644 --- a/classes/class_sphereoccluder3d.rst +++ b/classes/class_sphereoccluder3d.rst @@ -59,8 +59,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) The sphere's radius in 3D units. @@ -71,3 +71,4 @@ The sphere's radius in 3D units. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_sphereshape3d.rst b/classes/class_sphereshape3d.rst index 4a1b4c87434..fb3fe35645b 100644 --- a/classes/class_sphereshape3d.rst +++ b/classes/class_sphereshape3d.rst @@ -59,8 +59,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) The sphere's radius. The shape's diameter is double the radius. @@ -71,3 +71,4 @@ The sphere's radius. The shape's diameter is double the radius. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index 889e47da01c..2afc3351670 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: number, numeric, input + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -73,7 +76,7 @@ Properties +-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`select_all_on_focus` | ``false`` | +-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`SizeFlags`\> | size_flags_vertical | ``1`` (overrides :ref:`Control`) | + | |bitfield|\[:ref:`SizeFlags`\] | size_flags_vertical | ``1`` (overrides :ref:`Control`) | +-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`float` | step | ``1.0`` (overrides :ref:`Range`) | +-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ @@ -90,11 +93,11 @@ Methods .. table:: :widths: auto - +---------------------------------+----------------------------------------------------------------------+ - | void | :ref:`apply` **(** **)** | - +---------------------------------+----------------------------------------------------------------------+ - | :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | - +---------------------------------+----------------------------------------------------------------------+ + +---------------------------------+----------------------------------------------------------------+ + | |void| | :ref:`apply`\ (\ ) | + +---------------------------------+----------------------------------------------------------------+ + | :ref:`LineEdit` | :ref:`get_line_edit`\ (\ ) | + +---------------------------------+----------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -125,8 +128,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_horizontal_alignment** **(** :ref:`HorizontalAlignment` value **)** -- :ref:`HorizontalAlignment` **get_horizontal_alignment** **(** **)** +- |void| **set_horizontal_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) +- :ref:`HorizontalAlignment` **get_horizontal_alignment**\ (\ ) Changes the alignment of the underlying :ref:`LineEdit`. @@ -142,8 +145,8 @@ Changes the alignment of the underlying :ref:`LineEdit`. .. rst-class:: classref-property-setget -- void **set_custom_arrow_step** **(** :ref:`float` value **)** -- :ref:`float` **get_custom_arrow_step** **(** **)** +- |void| **set_custom_arrow_step**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_custom_arrow_step**\ (\ ) If not ``0``, :ref:`Range.value` will always be rounded to a multiple of :ref:`custom_arrow_step` when interacting with the arrow buttons of the **SpinBox**. @@ -159,8 +162,8 @@ If not ``0``, :ref:`Range.value` will always be roun .. rst-class:: classref-property-setget -- void **set_editable** **(** :ref:`bool` value **)** -- :ref:`bool` **is_editable** **(** **)** +- |void| **set_editable**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_editable**\ (\ ) If ``true``, the **SpinBox** will be editable. Otherwise, it will be read only. @@ -176,8 +179,8 @@ If ``true``, the **SpinBox** will be editable. Otherwise, it will be read only. .. rst-class:: classref-property-setget -- void **set_prefix** **(** :ref:`String` value **)** -- :ref:`String` **get_prefix** **(** **)** +- |void| **set_prefix**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_prefix**\ (\ ) Adds the specified prefix string before the numerical value of the **SpinBox**. @@ -193,8 +196,8 @@ Adds the specified prefix string before the numerical value of the **SpinBox**. .. rst-class:: classref-property-setget -- void **set_select_all_on_focus** **(** :ref:`bool` value **)** -- :ref:`bool` **is_select_all_on_focus** **(** **)** +- |void| **set_select_all_on_focus**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_select_all_on_focus**\ (\ ) If ``true``, the **SpinBox** will select the whole text when the :ref:`LineEdit` gains focus. Clicking the up and down arrows won't trigger this behavior. @@ -210,8 +213,8 @@ If ``true``, the **SpinBox** will select the whole text when the :ref:`LineEdit< .. rst-class:: classref-property-setget -- void **set_suffix** **(** :ref:`String` value **)** -- :ref:`String` **get_suffix** **(** **)** +- |void| **set_suffix**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_suffix**\ (\ ) Adds the specified suffix string after the numerical value of the **SpinBox**. @@ -227,8 +230,8 @@ Adds the specified suffix string after the numerical value of the **SpinBox**. .. rst-class:: classref-property-setget -- void **set_update_on_text_changed** **(** :ref:`bool` value **)** -- :ref:`bool` **get_update_on_text_changed** **(** **)** +- |void| **set_update_on_text_changed**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_update_on_text_changed**\ (\ ) Sets the value of the :ref:`Range` for this **SpinBox** when the :ref:`LineEdit` text is *changed* instead of *submitted*. See :ref:`LineEdit.text_changed` and :ref:`LineEdit.text_submitted`. @@ -245,7 +248,7 @@ Method Descriptions .. rst-class:: classref-method -void **apply** **(** **)** +|void| **apply**\ (\ ) Applies the current value of this **SpinBox**. @@ -257,7 +260,7 @@ Applies the current value of this **SpinBox**. .. rst-class:: classref-method -:ref:`LineEdit` **get_line_edit** **(** **)** +:ref:`LineEdit` **get_line_edit**\ (\ ) Returns the :ref:`LineEdit` instance from this **SpinBox**. You can use it to access properties and methods of :ref:`LineEdit`. @@ -287,3 +290,4 @@ Sets a custom :ref:`Texture2D` for up and down arrows of the ** .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index 0c518983247..8166de4e852 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -56,9 +56,9 @@ Methods .. table:: :widths: auto - +------+---------------------------------------------------------------------------------------+ - | void | :ref:`clamp_split_offset` **(** **)** | - +------+---------------------------------------------------------------------------------------+ + +--------+---------------------------------------------------------------------------------+ + | |void| | :ref:`clamp_split_offset`\ (\ ) | + +--------+---------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -95,7 +95,7 @@ Signals .. rst-class:: classref-signal -**dragged** **(** :ref:`int` offset **)** +**dragged**\ (\ offset\: :ref:`int`\ ) Emitted when the dragger is dragged by user. @@ -155,8 +155,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_collapsed** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collapsed** **(** **)** +- |void| **set_collapsed**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collapsed**\ (\ ) If ``true``, the area of the first :ref:`Control` will be collapsed and the dragger will be disabled. @@ -172,8 +172,8 @@ If ``true``, the area of the first :ref:`Control` will be collaps .. rst-class:: classref-property-setget -- void **set_dragger_visibility** **(** :ref:`DraggerVisibility` value **)** -- :ref:`DraggerVisibility` **get_dragger_visibility** **(** **)** +- |void| **set_dragger_visibility**\ (\ value\: :ref:`DraggerVisibility`\ ) +- :ref:`DraggerVisibility` **get_dragger_visibility**\ (\ ) Determines the dragger's visibility. See :ref:`DraggerVisibility` for details. @@ -189,8 +189,8 @@ Determines the dragger's visibility. See :ref:`DraggerVisibility` value **)** -- :ref:`int` **get_split_offset** **(** **)** +- |void| **set_split_offset**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_split_offset**\ (\ ) The initial offset of the splitting between the two :ref:`Control`\ s, with ``0`` being at the end of the first :ref:`Control`. @@ -206,8 +206,8 @@ The initial offset of the splitting between the two :ref:`Control .. rst-class:: classref-property-setget -- void **set_vertical** **(** :ref:`bool` value **)** -- :ref:`bool` **is_vertical** **(** **)** +- |void| **set_vertical**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_vertical**\ (\ ) If ``true``, the **SplitContainer** will arrange its children vertically, rather than horizontally. @@ -226,7 +226,7 @@ Method Descriptions .. rst-class:: classref-method -void **clamp_split_offset** **(** **)** +|void| **clamp_split_offset**\ (\ ) Clamps the :ref:`split_offset` value to not go outside the currently possible minimal and maximum values. @@ -314,3 +314,4 @@ The icon used for the grabber drawn in the middle area when :ref:`vertical` value **)** -- :ref:`float` **get_param** **(** **)** +- |void| **set_param**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ ) The spotlight's angle in degrees. @@ -94,8 +94,8 @@ The spotlight's angle in degrees. .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`float` value **)** -- :ref:`float` **get_param** **(** **)** +- |void| **set_param**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ ) The spotlight's *angular* attenuation curve. See also :ref:`spot_attenuation`. @@ -111,8 +111,8 @@ The spotlight's *angular* attenuation curve. See also :ref:`spot_attenuation` value **)** -- :ref:`float` **get_param** **(** **)** +- |void| **set_param**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ ) Controls the distance attenuation function for spotlights. @@ -134,8 +134,8 @@ A value of ``0.0`` smoothly attenuates light at the edge of the range. A value o .. rst-class:: classref-property-setget -- void **set_param** **(** :ref:`float` value **)** -- :ref:`float` **get_param** **(** **)** +- |void| **set_param**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_param**\ (\ ) The maximal range that can be reached by the spotlight. Note that the effectively lit area may appear to be smaller depending on the :ref:`spot_attenuation` in use. No matter the :ref:`spot_attenuation` in use, the light will never reach anything outside this range. @@ -148,3 +148,4 @@ The maximal range that can be reached by the spotlight. Note that the effectivel .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_springarm3d.rst b/classes/class_springarm3d.rst index 221147efd1a..7a8e1b823b9 100644 --- a/classes/class_springarm3d.rst +++ b/classes/class_springarm3d.rst @@ -47,15 +47,15 @@ Methods .. table:: :widths: auto - +---------------------------+----------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_excluded_object` **(** :ref:`RID` RID **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_excluded_objects` **(** **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_hit_length` **(** **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`remove_excluded_object` **(** :ref:`RID` RID **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------+ + +---------------------------+-------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_excluded_object`\ (\ RID\: :ref:`RID`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_excluded_objects`\ (\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_hit_length`\ (\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`remove_excluded_object`\ (\ RID\: :ref:`RID`\ ) | + +---------------------------+-------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -74,8 +74,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_collision_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_collision_mask** **(** **)** +- |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_collision_mask**\ (\ ) The layers against which the collision check shall be done. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information. @@ -91,8 +91,8 @@ The layers against which the collision check shall be done. See `Collision layer .. rst-class:: classref-property-setget -- void **set_margin** **(** :ref:`float` value **)** -- :ref:`float` **get_margin** **(** **)** +- |void| **set_margin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_margin**\ (\ ) When the collision check is made, a candidate length for the SpringArm3D is given. @@ -112,8 +112,8 @@ This margin is useful for when the SpringArm3D has a :ref:`Camera3D` value **)** -- :ref:`Shape3D` **get_shape** **(** **)** +- |void| **set_shape**\ (\ value\: :ref:`Shape3D`\ ) +- :ref:`Shape3D` **get_shape**\ (\ ) The :ref:`Shape3D` to use for the SpringArm3D. @@ -131,8 +131,8 @@ When the shape is set, the SpringArm3D will cast the :ref:`Shape3D` value **)** -- :ref:`float` **get_length** **(** **)** +- |void| **set_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_length**\ (\ ) The maximum extent of the SpringArm3D. This is used as a length for both the ray and the shape cast used internally to calculate the desired position of the SpringArm3D's child nodes. @@ -151,7 +151,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_excluded_object** **(** :ref:`RID` RID **)** +|void| **add_excluded_object**\ (\ RID\: :ref:`RID`\ ) Adds the :ref:`PhysicsBody3D` object with the given :ref:`RID` to the list of :ref:`PhysicsBody3D` objects excluded from the collision check. @@ -163,7 +163,7 @@ Adds the :ref:`PhysicsBody3D` object with the given :ref:`R .. rst-class:: classref-method -void **clear_excluded_objects** **(** **)** +|void| **clear_excluded_objects**\ (\ ) Clears the list of :ref:`PhysicsBody3D` objects excluded from the collision check. @@ -175,7 +175,7 @@ Clears the list of :ref:`PhysicsBody3D` objects excluded fr .. rst-class:: classref-method -:ref:`float` **get_hit_length** **(** **)** +:ref:`float` **get_hit_length**\ (\ ) Returns the spring arm's current length. @@ -187,7 +187,7 @@ Returns the spring arm's current length. .. rst-class:: classref-method -:ref:`bool` **remove_excluded_object** **(** :ref:`RID` RID **)** +:ref:`bool` **remove_excluded_object**\ (\ RID\: :ref:`RID`\ ) Removes the given :ref:`RID` from the list of :ref:`PhysicsBody3D` objects excluded from the collision check. @@ -198,3 +198,4 @@ Removes the given :ref:`RID` from the list of :ref:`PhysicsBody3D` | :ref:`get_rect` **(** **)** |const| | - +---------------------------+---------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_pixel_opaque` **(** :ref:`Vector2` pos **)** |const| | - +---------------------------+---------------------------------------------------------------------------------------------------------------------+ + +---------------------------+------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_rect`\ (\ ) |const| | + +---------------------------+------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_pixel_opaque`\ (\ pos\: :ref:`Vector2`\ ) |const| | + +---------------------------+------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -89,7 +89,7 @@ Signals .. rst-class:: classref-signal -**frame_changed** **(** **)** +**frame_changed**\ (\ ) Emitted when the :ref:`frame` changes. @@ -101,7 +101,7 @@ Emitted when the :ref:`frame` changes. .. rst-class:: classref-signal -**texture_changed** **(** **)** +**texture_changed**\ (\ ) Emitted when the :ref:`texture` changes. @@ -122,11 +122,13 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_centered** **(** :ref:`bool` value **)** -- :ref:`bool` **is_centered** **(** **)** +- |void| **set_centered**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_centered**\ (\ ) If ``true``, texture is centered. +\ **Note:** For games with a pixel art aesthetic, textures may appear deformed when centered. This is caused by their position being between pixels. To prevent this, set this property to ``false``, or consider enabling :ref:`ProjectSettings.rendering/2d/snap/snap_2d_vertices_to_pixel` and :ref:`ProjectSettings.rendering/2d/snap/snap_2d_transforms_to_pixel`. + .. rst-class:: classref-item-separator ---- @@ -139,8 +141,8 @@ If ``true``, texture is centered. .. rst-class:: classref-property-setget -- void **set_flip_h** **(** :ref:`bool` value **)** -- :ref:`bool` **is_flipped_h** **(** **)** +- |void| **set_flip_h**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_flipped_h**\ (\ ) If ``true``, texture is flipped horizontally. @@ -156,8 +158,8 @@ If ``true``, texture is flipped horizontally. .. rst-class:: classref-property-setget -- void **set_flip_v** **(** :ref:`bool` value **)** -- :ref:`bool` **is_flipped_v** **(** **)** +- |void| **set_flip_v**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_flipped_v**\ (\ ) If ``true``, texture is flipped vertically. @@ -173,8 +175,8 @@ If ``true``, texture is flipped vertically. .. rst-class:: classref-property-setget -- void **set_frame** **(** :ref:`int` value **)** -- :ref:`int` **get_frame** **(** **)** +- |void| **set_frame**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_frame**\ (\ ) Current frame to display from sprite sheet. :ref:`hframes` or :ref:`vframes` must be greater than 1. This property is automatically adjusted when :ref:`hframes` or :ref:`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``. @@ -190,8 +192,8 @@ Current frame to display from sprite sheet. :ref:`hframes` value **)** -- :ref:`Vector2i` **get_frame_coords** **(** **)** +- |void| **set_frame_coords**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_frame_coords**\ (\ ) Coordinates of the frame to display from sprite sheet. This is as an alias for the :ref:`frame` property. :ref:`hframes` or :ref:`vframes` must be greater than 1. @@ -207,8 +209,8 @@ Coordinates of the frame to display from sprite sheet. This is as an alias for t .. rst-class:: classref-property-setget -- void **set_hframes** **(** :ref:`int` value **)** -- :ref:`int` **get_hframes** **(** **)** +- |void| **set_hframes**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_hframes**\ (\ ) The number of columns in the sprite sheet. When this property is changed, :ref:`frame` is adjusted so that the same visual frame is maintained (same row and column). If that's impossible, :ref:`frame` is reset to ``0``. @@ -224,8 +226,8 @@ The number of columns in the sprite sheet. When this property is changed, :ref:` .. rst-class:: classref-property-setget -- void **set_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_offset** **(** **)** +- |void| **set_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_offset**\ (\ ) The texture's drawing offset. @@ -241,8 +243,8 @@ The texture's drawing offset. .. rst-class:: classref-property-setget -- void **set_region_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_region_enabled** **(** **)** +- |void| **set_region_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_region_enabled**\ (\ ) If ``true``, texture is cut from a larger atlas texture. See :ref:`region_rect`. @@ -258,8 +260,8 @@ If ``true``, texture is cut from a larger atlas texture. See :ref:`region_rect` value **)** -- :ref:`bool` **is_region_filter_clip_enabled** **(** **)** +- |void| **set_region_filter_clip_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_region_filter_clip_enabled**\ (\ ) If ``true``, the outermost pixels get blurred out. :ref:`region_enabled` must be ``true``. @@ -275,8 +277,8 @@ If ``true``, the outermost pixels get blurred out. :ref:`region_enabled` value **)** -- :ref:`Rect2` **get_region_rect** **(** **)** +- |void| **set_region_rect**\ (\ value\: :ref:`Rect2`\ ) +- :ref:`Rect2` **get_region_rect**\ (\ ) The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. @@ -292,8 +294,8 @@ The region of the atlas texture to display. :ref:`region_enabled` value **)** -- :ref:`Texture2D` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ ) :ref:`Texture2D` object to draw. @@ -309,8 +311,8 @@ The region of the atlas texture to display. :ref:`region_enabled` value **)** -- :ref:`int` **get_vframes** **(** **)** +- |void| **set_vframes**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_vframes**\ (\ ) The number of rows in the sprite sheet. When this property is changed, :ref:`frame` is adjusted so that the same visual frame is maintained (same row and column). If that's impossible, :ref:`frame` is reset to ``0``. @@ -327,7 +329,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Rect2` **get_rect** **(** **)** |const| +:ref:`Rect2` **get_rect**\ (\ ) |const| Returns a :ref:`Rect2` representing the Sprite2D's boundary in local coordinates. Can be used to detect if the Sprite2D was clicked. @@ -369,9 +371,9 @@ Returns a :ref:`Rect2` representing the Sprite2D's boundary in loca .. rst-class:: classref-method -:ref:`bool` **is_pixel_opaque** **(** :ref:`Vector2` pos **)** |const| +:ref:`bool` **is_pixel_opaque**\ (\ pos\: :ref:`Vector2`\ ) |const| -Returns ``true``, if the pixel at the given position is opaque and ``false`` in other case. +Returns ``true``, if the pixel at the given position is opaque and ``false`` in other case. The position is in local coordinates. \ **Note:** It also returns ``false``, if the sprite's texture is ``null`` or if the given position is invalid. @@ -382,3 +384,4 @@ Returns ``true``, if the pixel at the given position is opaque and ``false`` in .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index 1acb2f0cff0..437f6ad1d05 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -58,7 +58,7 @@ Signals .. rst-class:: classref-signal -**frame_changed** **(** **)** +**frame_changed**\ (\ ) Emitted when the :ref:`frame` changes. @@ -70,7 +70,7 @@ Emitted when the :ref:`frame` changes. .. rst-class:: classref-signal -**texture_changed** **(** **)** +**texture_changed**\ (\ ) Emitted when the :ref:`texture` changes. @@ -91,8 +91,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_frame** **(** :ref:`int` value **)** -- :ref:`int` **get_frame** **(** **)** +- |void| **set_frame**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_frame**\ (\ ) Current frame to display from sprite sheet. :ref:`hframes` or :ref:`vframes` must be greater than 1. This property is automatically adjusted when :ref:`hframes` or :ref:`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``. @@ -108,8 +108,8 @@ Current frame to display from sprite sheet. :ref:`hframes` value **)** -- :ref:`Vector2i` **get_frame_coords** **(** **)** +- |void| **set_frame_coords**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_frame_coords**\ (\ ) Coordinates of the frame to display from sprite sheet. This is as an alias for the :ref:`frame` property. :ref:`hframes` or :ref:`vframes` must be greater than 1. @@ -125,8 +125,8 @@ Coordinates of the frame to display from sprite sheet. This is as an alias for t .. rst-class:: classref-property-setget -- void **set_hframes** **(** :ref:`int` value **)** -- :ref:`int` **get_hframes** **(** **)** +- |void| **set_hframes**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_hframes**\ (\ ) The number of columns in the sprite sheet. When this property is changed, :ref:`frame` is adjusted so that the same visual frame is maintained (same row and column). If that's impossible, :ref:`frame` is reset to ``0``. @@ -142,8 +142,8 @@ The number of columns in the sprite sheet. When this property is changed, :ref:` .. rst-class:: classref-property-setget -- void **set_region_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_region_enabled** **(** **)** +- |void| **set_region_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_region_enabled**\ (\ ) If ``true``, the sprite will use :ref:`region_rect` and display only the specified part of its texture. @@ -159,8 +159,8 @@ If ``true``, the sprite will use :ref:`region_rect` value **)** -- :ref:`Rect2` **get_region_rect** **(** **)** +- |void| **set_region_rect**\ (\ value\: :ref:`Rect2`\ ) +- :ref:`Rect2` **get_region_rect**\ (\ ) The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. @@ -176,8 +176,8 @@ The region of the atlas texture to display. :ref:`region_enabled` value **)** -- :ref:`Texture2D` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ ) :ref:`Texture2D` object to draw. If :ref:`GeometryInstance3D.material_override` is used, this will be overridden. The size information is still used. @@ -193,8 +193,8 @@ The region of the atlas texture to display. :ref:`region_enabled` value **)** -- :ref:`int` **get_vframes** **(** **)** +- |void| **set_vframes**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_vframes**\ (\ ) The number of rows in the sprite sheet. When this property is changed, :ref:`frame` is adjusted so that the same visual frame is maintained (same row and column). If that's impossible, :ref:`frame` is reset to ``0``. @@ -205,3 +205,4 @@ The number of rows in the sprite sheet. When this property is changed, :ref:`fra .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index 1f14e688052..e60f73576c3 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -81,15 +81,15 @@ Methods .. table:: :widths: auto - +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** |const| | - +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_draw_flag` **(** :ref:`DrawFlags` flag **)** |const| | - +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_item_rect` **(** **)** |const| | - +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_draw_flag` **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** | - +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TriangleMesh` | :ref:`generate_triangle_mesh`\ (\ ) |const| | + +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_draw_flag`\ (\ flag\: :ref:`DrawFlags`\ ) |const| | + +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_item_rect`\ (\ ) |const| | + +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_draw_flag`\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -213,8 +213,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_alpha_antialiasing_edge** **(** :ref:`float` value **)** -- :ref:`float` **get_alpha_antialiasing_edge** **(** **)** +- |void| **set_alpha_antialiasing_edge**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_alpha_antialiasing_edge**\ (\ ) Threshold at which antialiasing will be applied on the alpha channel. @@ -230,8 +230,8 @@ Threshold at which antialiasing will be applied on the alpha channel. .. rst-class:: classref-property-setget -- void **set_alpha_antialiasing** **(** :ref:`AlphaAntiAliasing` value **)** -- :ref:`AlphaAntiAliasing` **get_alpha_antialiasing** **(** **)** +- |void| **set_alpha_antialiasing**\ (\ value\: :ref:`AlphaAntiAliasing`\ ) +- :ref:`AlphaAntiAliasing` **get_alpha_antialiasing**\ (\ ) The type of alpha antialiasing to apply. See :ref:`AlphaAntiAliasing`. @@ -247,8 +247,8 @@ The type of alpha antialiasing to apply. See :ref:`AlphaAntiAliasing` value **)** -- :ref:`AlphaCutMode` **get_alpha_cut_mode** **(** **)** +- |void| **set_alpha_cut_mode**\ (\ value\: :ref:`AlphaCutMode`\ ) +- :ref:`AlphaCutMode` **get_alpha_cut_mode**\ (\ ) The alpha cutting mode to use for the sprite. See :ref:`AlphaCutMode` for possible values. @@ -264,8 +264,8 @@ The alpha cutting mode to use for the sprite. See :ref:`AlphaCutMode` value **)** -- :ref:`float` **get_alpha_hash_scale** **(** **)** +- |void| **set_alpha_hash_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_alpha_hash_scale**\ (\ ) The hashing scale for Alpha Hash. Recommended values between ``0`` and ``2``. @@ -281,8 +281,8 @@ The hashing scale for Alpha Hash. Recommended values between ``0`` and ``2``. .. rst-class:: classref-property-setget -- void **set_alpha_scissor_threshold** **(** :ref:`float` value **)** -- :ref:`float` **get_alpha_scissor_threshold** **(** **)** +- |void| **set_alpha_scissor_threshold**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_alpha_scissor_threshold**\ (\ ) Threshold at which the alpha scissor will discard values. @@ -298,8 +298,8 @@ Vector3.Axis **axis** = ``2`` .. rst-class:: classref-property-setget -- void **set_axis** **(** Vector3.Axis value **)** -- Vector3.Axis **get_axis** **(** **)** +- |void| **set_axis**\ (\ value\: Vector3.Axis\ ) +- Vector3.Axis **get_axis**\ (\ ) The direction in which the front of the texture faces. @@ -315,8 +315,8 @@ The direction in which the front of the texture faces. .. rst-class:: classref-property-setget -- void **set_billboard_mode** **(** :ref:`BillboardMode` value **)** -- :ref:`BillboardMode` **get_billboard_mode** **(** **)** +- |void| **set_billboard_mode**\ (\ value\: :ref:`BillboardMode`\ ) +- :ref:`BillboardMode` **get_billboard_mode**\ (\ ) The billboard mode to use for the sprite. See :ref:`BillboardMode` for possible values. @@ -334,8 +334,8 @@ The billboard mode to use for the sprite. See :ref:`BillboardMode` value **)** -- :ref:`bool` **is_centered** **(** **)** +- |void| **set_centered**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_centered**\ (\ ) If ``true``, texture will be centered. @@ -351,8 +351,8 @@ If ``true``, texture will be centered. .. rst-class:: classref-property-setget -- void **set_draw_flag** **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** |const| +- |void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| If ``true``, texture can be seen from the back as well, if ``false``, it is invisible when looking at it from behind. @@ -368,8 +368,8 @@ If ``true``, texture can be seen from the back as well, if ``false``, it is invi .. rst-class:: classref-property-setget -- void **set_draw_flag** **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** |const| +- |void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| If ``true``, the label is rendered at the same size regardless of distance. @@ -385,8 +385,8 @@ If ``true``, the label is rendered at the same size regardless of distance. .. rst-class:: classref-property-setget -- void **set_flip_h** **(** :ref:`bool` value **)** -- :ref:`bool` **is_flipped_h** **(** **)** +- |void| **set_flip_h**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_flipped_h**\ (\ ) If ``true``, texture is flipped horizontally. @@ -402,8 +402,8 @@ If ``true``, texture is flipped horizontally. .. rst-class:: classref-property-setget -- void **set_flip_v** **(** :ref:`bool` value **)** -- :ref:`bool` **is_flipped_v** **(** **)** +- |void| **set_flip_v**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_flipped_v**\ (\ ) If ``true``, texture is flipped vertically. @@ -419,8 +419,8 @@ If ``true``, texture is flipped vertically. .. rst-class:: classref-property-setget -- void **set_modulate** **(** :ref:`Color` value **)** -- :ref:`Color` **get_modulate** **(** **)** +- |void| **set_modulate**\ (\ value\: :ref:`Color`\ ) +- :ref:`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 ambient light. @@ -440,8 +440,8 @@ A color value used to *multiply* the texture's colors. Can be used for mood-colo .. rst-class:: classref-property-setget -- void **set_draw_flag** **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** |const| +- |void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| If ``true``, depth testing is disabled and the object will be drawn in render order. @@ -457,8 +457,8 @@ If ``true``, depth testing is disabled and the object will be drawn in render or .. rst-class:: classref-property-setget -- void **set_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_offset** **(** **)** +- |void| **set_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_offset**\ (\ ) The texture's drawing offset. @@ -474,8 +474,8 @@ The texture's drawing offset. .. rst-class:: classref-property-setget -- void **set_pixel_size** **(** :ref:`float` value **)** -- :ref:`float` **get_pixel_size** **(** **)** +- |void| **set_pixel_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pixel_size**\ (\ ) The size of one pixel's width on the sprite to scale it in 3D. @@ -491,8 +491,8 @@ The size of one pixel's width on the sprite to scale it in 3D. .. rst-class:: classref-property-setget -- void **set_render_priority** **(** :ref:`int` value **)** -- :ref:`int` **get_render_priority** **(** **)** +- |void| **set_render_priority**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_render_priority**\ (\ ) Sets the render priority for the sprite. Higher priority objects will be sorted in front of lower priority objects. @@ -512,8 +512,8 @@ Sets the render priority for the sprite. Higher priority objects will be sorted .. rst-class:: classref-property-setget -- void **set_draw_flag** **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** |const| +- |void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| If ``true``, the :ref:`Light3D` in the :ref:`Environment` has effects on the sprite. @@ -529,8 +529,8 @@ If ``true``, the :ref:`Light3D` in the :ref:`Environment` value **)** -- :ref:`TextureFilter` **get_texture_filter** **(** **)** +- |void| **set_texture_filter**\ (\ value\: :ref:`TextureFilter`\ ) +- :ref:`TextureFilter` **get_texture_filter**\ (\ ) Filter flags for the texture. See :ref:`TextureFilter` for options. @@ -548,8 +548,8 @@ Filter flags for the texture. See :ref:`TextureFilter` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** |const| +- |void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| If ``true``, the texture's transparency and the opacity are used to make those parts of the sprite invisible. @@ -566,7 +566,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** |const| +:ref:`TriangleMesh` **generate_triangle_mesh**\ (\ ) |const| Returns a :ref:`TriangleMesh` with the sprite's vertices following its current configuration (such as its :ref:`axis` and :ref:`pixel_size`). @@ -578,7 +578,7 @@ Returns a :ref:`TriangleMesh` with the sprite's vertices fol .. rst-class:: classref-method -:ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** |const| +:ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| Returns the value of the specified flag. @@ -590,7 +590,7 @@ Returns the value of the specified flag. .. rst-class:: classref-method -:ref:`Rect2` **get_item_rect** **(** **)** |const| +:ref:`Rect2` **get_item_rect**\ (\ ) |const| Returns the rectangle representing this sprite. @@ -602,7 +602,7 @@ Returns the rectangle representing this sprite. .. rst-class:: classref-method -void **set_draw_flag** **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** +|void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) If ``true``, the specified flag will be enabled. See :ref:`DrawFlags` for a list of flags. @@ -613,3 +613,4 @@ If ``true``, the specified flag will be enabled. See :ref:`DrawFlags` **(** :ref:`StringName` anim **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_frame` **(** :ref:`StringName` anim, :ref:`Texture2D` texture, :ref:`float` duration=1.0, :ref:`int` at_position=-1 **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** :ref:`StringName` anim **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_all` **(** **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`StringName` anim **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_animation_names` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_animation_speed` **(** :ref:`StringName` anim **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_frame_count` **(** :ref:`StringName` anim **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_frame_duration` **(** :ref:`StringName` anim, :ref:`int` idx **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_frame_texture` **(** :ref:`StringName` anim, :ref:`int` idx **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_animation` **(** :ref:`StringName` anim **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_animation` **(** :ref:`StringName` anim **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_frame` **(** :ref:`StringName` anim, :ref:`int` idx **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rename_animation` **(** :ref:`StringName` anim, :ref:`StringName` newname **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_animation_loop` **(** :ref:`StringName` anim, :ref:`bool` loop **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_animation_speed` **(** :ref:`StringName` anim, :ref:`float` fps **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_frame` **(** :ref:`StringName` anim, :ref:`int` idx, :ref:`Texture2D` texture, :ref:`float` duration=1.0 **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_animation`\ (\ anim\: :ref:`StringName`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_frame`\ (\ anim\: :ref:`StringName`, texture\: :ref:`Texture2D`, duration\: :ref:`float` = 1.0, at_position\: :ref:`int` = -1\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ anim\: :ref:`StringName`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_all`\ (\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_animation_loop`\ (\ anim\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_animation_names`\ (\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_animation_speed`\ (\ anim\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_frame_count`\ (\ anim\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_frame_duration`\ (\ anim\: :ref:`StringName`, idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_frame_texture`\ (\ anim\: :ref:`StringName`, idx\: :ref:`int`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_animation`\ (\ anim\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_animation`\ (\ anim\: :ref:`StringName`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_frame`\ (\ anim\: :ref:`StringName`, idx\: :ref:`int`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rename_animation`\ (\ anim\: :ref:`StringName`, newname\: :ref:`StringName`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_animation_loop`\ (\ anim\: :ref:`StringName`, loop\: :ref:`bool`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_animation_speed`\ (\ anim\: :ref:`StringName`, fps\: :ref:`float`\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_frame`\ (\ anim\: :ref:`StringName`, idx\: :ref:`int`, texture\: :ref:`Texture2D`, duration\: :ref:`float` = 1.0\ ) | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -78,7 +78,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_animation** **(** :ref:`StringName` anim **)** +|void| **add_animation**\ (\ anim\: :ref:`StringName`\ ) Adds a new ``anim`` animation to the library. @@ -90,7 +90,7 @@ Adds a new ``anim`` animation to the library. .. rst-class:: classref-method -void **add_frame** **(** :ref:`StringName` anim, :ref:`Texture2D` texture, :ref:`float` duration=1.0, :ref:`int` at_position=-1 **)** +|void| **add_frame**\ (\ anim\: :ref:`StringName`, texture\: :ref:`Texture2D`, duration\: :ref:`float` = 1.0, at_position\: :ref:`int` = -1\ ) Adds a frame to the ``anim`` animation. If ``at_position`` is ``-1``, the frame will be added to the end of the animation. @@ -102,7 +102,7 @@ Adds a frame to the ``anim`` animation. If ``at_position`` is ``-1``, the frame .. rst-class:: classref-method -void **clear** **(** :ref:`StringName` anim **)** +|void| **clear**\ (\ anim\: :ref:`StringName`\ ) Removes all frames from the ``anim`` animation. @@ -114,7 +114,7 @@ Removes all frames from the ``anim`` animation. .. rst-class:: classref-method -void **clear_all** **(** **)** +|void| **clear_all**\ (\ ) Removes all animations. An empty ``default`` animation will be created. @@ -126,7 +126,7 @@ Removes all animations. An empty ``default`` animation will be created. .. rst-class:: classref-method -:ref:`bool` **get_animation_loop** **(** :ref:`StringName` anim **)** |const| +:ref:`bool` **get_animation_loop**\ (\ anim\: :ref:`StringName`\ ) |const| Returns ``true`` if the given animation is configured to loop when it finishes playing. Otherwise, returns ``false``. @@ -138,7 +138,7 @@ Returns ``true`` if the given animation is configured to loop when it finishes p .. rst-class:: classref-method -:ref:`PackedStringArray` **get_animation_names** **(** **)** |const| +:ref:`PackedStringArray` **get_animation_names**\ (\ ) |const| Returns an array containing the names associated to each animation. Values are placed in alphabetical order. @@ -150,7 +150,7 @@ Returns an array containing the names associated to each animation. Values are p .. rst-class:: classref-method -:ref:`float` **get_animation_speed** **(** :ref:`StringName` anim **)** |const| +:ref:`float` **get_animation_speed**\ (\ anim\: :ref:`StringName`\ ) |const| Returns the speed in frames per second for the ``anim`` animation. @@ -162,7 +162,7 @@ Returns the speed in frames per second for the ``anim`` animation. .. rst-class:: classref-method -:ref:`int` **get_frame_count** **(** :ref:`StringName` anim **)** |const| +:ref:`int` **get_frame_count**\ (\ anim\: :ref:`StringName`\ ) |const| Returns the number of frames for the ``anim`` animation. @@ -174,7 +174,7 @@ Returns the number of frames for the ``anim`` animation. .. rst-class:: classref-method -:ref:`float` **get_frame_duration** **(** :ref:`StringName` anim, :ref:`int` idx **)** |const| +:ref:`float` **get_frame_duration**\ (\ anim\: :ref:`StringName`, idx\: :ref:`int`\ ) |const| Returns a relative duration of the frame ``idx`` in the ``anim`` animation (defaults to ``1.0``). For example, a frame with a duration of ``2.0`` is displayed twice as long as a frame with a duration of ``1.0``. You can calculate the absolute duration (in seconds) of a frame using the following formula: @@ -192,7 +192,7 @@ In this example, ``playing_speed`` refers to either :ref:`AnimatedSprite2D.get_p .. rst-class:: classref-method -:ref:`Texture2D` **get_frame_texture** **(** :ref:`StringName` anim, :ref:`int` idx **)** |const| +:ref:`Texture2D` **get_frame_texture**\ (\ anim\: :ref:`StringName`, idx\: :ref:`int`\ ) |const| Returns the texture of the frame ``idx`` in the ``anim`` animation. @@ -204,7 +204,7 @@ Returns the texture of the frame ``idx`` in the ``anim`` animation. .. rst-class:: classref-method -:ref:`bool` **has_animation** **(** :ref:`StringName` anim **)** |const| +:ref:`bool` **has_animation**\ (\ anim\: :ref:`StringName`\ ) |const| Returns ``true`` if the ``anim`` animation exists. @@ -216,7 +216,7 @@ Returns ``true`` if the ``anim`` animation exists. .. rst-class:: classref-method -void **remove_animation** **(** :ref:`StringName` anim **)** +|void| **remove_animation**\ (\ anim\: :ref:`StringName`\ ) Removes the ``anim`` animation. @@ -228,7 +228,7 @@ Removes the ``anim`` animation. .. rst-class:: classref-method -void **remove_frame** **(** :ref:`StringName` anim, :ref:`int` idx **)** +|void| **remove_frame**\ (\ anim\: :ref:`StringName`, idx\: :ref:`int`\ ) Removes the ``anim`` animation's frame ``idx``. @@ -240,7 +240,7 @@ Removes the ``anim`` animation's frame ``idx``. .. rst-class:: classref-method -void **rename_animation** **(** :ref:`StringName` anim, :ref:`StringName` newname **)** +|void| **rename_animation**\ (\ anim\: :ref:`StringName`, newname\: :ref:`StringName`\ ) Changes the ``anim`` animation's name to ``newname``. @@ -252,7 +252,7 @@ Changes the ``anim`` animation's name to ``newname``. .. rst-class:: classref-method -void **set_animation_loop** **(** :ref:`StringName` anim, :ref:`bool` loop **)** +|void| **set_animation_loop**\ (\ anim\: :ref:`StringName`, loop\: :ref:`bool`\ ) If ``loop`` is ``true``, the ``anim`` animation will loop when it reaches the end, or the start if it is played in reverse. @@ -264,7 +264,7 @@ If ``loop`` is ``true``, the ``anim`` animation will loop when it reaches the en .. rst-class:: classref-method -void **set_animation_speed** **(** :ref:`StringName` anim, :ref:`float` fps **)** +|void| **set_animation_speed**\ (\ anim\: :ref:`StringName`, fps\: :ref:`float`\ ) Sets the speed for the ``anim`` animation in frames per second. @@ -276,7 +276,7 @@ Sets the speed for the ``anim`` animation in frames per second. .. rst-class:: classref-method -void **set_frame** **(** :ref:`StringName` anim, :ref:`int` idx, :ref:`Texture2D` texture, :ref:`float` duration=1.0 **)** +|void| **set_frame**\ (\ anim\: :ref:`StringName`, idx\: :ref:`int`, texture\: :ref:`Texture2D`, duration\: :ref:`float` = 1.0\ ) Sets the ``texture`` and the ``duration`` of the frame ``idx`` in the ``anim`` animation. @@ -287,3 +287,4 @@ Sets the ``texture`` and the ``duration`` of the frame ``idx`` in the ``anim`` a .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_standardmaterial3d.rst b/classes/class_standardmaterial3d.rst index cc3309399c5..e38a139b457 100644 --- a/classes/class_standardmaterial3d.rst +++ b/classes/class_standardmaterial3d.rst @@ -35,3 +35,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index 812f352990a..30a3a5245e3 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -60,8 +60,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_constant_angular_velocity** **(** :ref:`float` value **)** -- :ref:`float` **get_constant_angular_velocity** **(** **)** +- |void| **set_constant_angular_velocity**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_constant_angular_velocity**\ (\ ) The body's constant angular velocity. This does not rotate the body, but affects touching bodies, as if it were rotating. @@ -77,8 +77,8 @@ The body's constant angular velocity. This does not rotate the body, but affects .. rst-class:: classref-property-setget -- void **set_constant_linear_velocity** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_constant_linear_velocity** **(** **)** +- |void| **set_constant_linear_velocity**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_constant_linear_velocity**\ (\ ) The body's constant linear velocity. This does not move the body, but affects touching bodies, as if it were moving. @@ -94,8 +94,8 @@ The body's constant linear velocity. This does not move the body, but affects to .. rst-class:: classref-property-setget -- void **set_physics_material_override** **(** :ref:`PhysicsMaterial` value **)** -- :ref:`PhysicsMaterial` **get_physics_material_override** **(** **)** +- |void| **set_physics_material_override**\ (\ value\: :ref:`PhysicsMaterial`\ ) +- :ref:`PhysicsMaterial` **get_physics_material_override**\ (\ ) The physics material override for the body. @@ -108,3 +108,4 @@ If a material is assigned to this property, it will be used instead of any other .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_staticbody3d.rst b/classes/class_staticbody3d.rst index 827a608e257..2bfc213e7fd 100644 --- a/classes/class_staticbody3d.rst +++ b/classes/class_staticbody3d.rst @@ -71,8 +71,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_constant_angular_velocity** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_constant_angular_velocity** **(** **)** +- |void| **set_constant_angular_velocity**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_constant_angular_velocity**\ (\ ) The body's constant angular velocity. This does not rotate the body, but affects touching bodies, as if it were rotating. @@ -88,8 +88,8 @@ The body's constant angular velocity. This does not rotate the body, but affects .. rst-class:: classref-property-setget -- void **set_constant_linear_velocity** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_constant_linear_velocity** **(** **)** +- |void| **set_constant_linear_velocity**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_constant_linear_velocity**\ (\ ) The body's constant linear velocity. This does not move the body, but affects touching bodies, as if it were moving. @@ -105,8 +105,8 @@ The body's constant linear velocity. This does not move the body, but affects to .. rst-class:: classref-property-setget -- void **set_physics_material_override** **(** :ref:`PhysicsMaterial` value **)** -- :ref:`PhysicsMaterial` **get_physics_material_override** **(** **)** +- |void| **set_physics_material_override**\ (\ value\: :ref:`PhysicsMaterial`\ ) +- :ref:`PhysicsMaterial` **get_physics_material_override**\ (\ ) The physics material override for the body. @@ -119,3 +119,4 @@ If a material is assigned to this property, it will be used instead of any other .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_statusindicator.rst b/classes/class_statusindicator.rst index c663c209c45..44a13273b7b 100644 --- a/classes/class_statusindicator.rst +++ b/classes/class_statusindicator.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: tray + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -45,7 +48,7 @@ Signals .. rst-class:: classref-signal -**pressed** **(** :ref:`int` mouse_button, :ref:`Vector2i` position **)** +**pressed**\ (\ mouse_button\: :ref:`int`, position\: :ref:`Vector2i`\ ) Emitted when the status indicator is pressed. @@ -66,8 +69,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_icon** **(** :ref:`Image` value **)** -- :ref:`Image` **get_icon** **(** **)** +- |void| **set_icon**\ (\ value\: :ref:`Image`\ ) +- :ref:`Image` **get_icon**\ (\ ) Status indicator icon. @@ -83,8 +86,8 @@ Status indicator icon. .. rst-class:: classref-property-setget -- void **set_tooltip** **(** :ref:`String` value **)** -- :ref:`String` **get_tooltip** **(** **)** +- |void| **set_tooltip**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_tooltip**\ (\ ) Status indicator tooltip. @@ -100,8 +103,8 @@ Status indicator tooltip. .. rst-class:: classref-property-setget -- void **set_visible** **(** :ref:`bool` value **)** -- :ref:`bool` **is_visible** **(** **)** +- |void| **set_visible**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_visible**\ (\ ) If ``true``, the status indicator is visible. @@ -112,3 +115,4 @@ If ``true``, the status indicator is visible. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 5f490f03107..ed5055fca14 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -45,69 +45,69 @@ Methods .. table:: :widths: auto - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_8` **(** **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_16` **(** **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_32` **(** **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_64` **(** **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_available_bytes` **(** **)** |const| | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_data` **(** :ref:`int` bytes **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_double` **(** **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_float` **(** **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_partial_data` **(** :ref:`int` bytes **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_string` **(** :ref:`int` bytes=-1 **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_u8` **(** **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_u16` **(** **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_u32` **(** **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_u64` **(** **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_utf8_string` **(** :ref:`int` bytes=-1 **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_var` **(** :ref:`bool` allow_objects=false **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`put_8` **(** :ref:`int` value **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`put_16` **(** :ref:`int` value **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`put_32` **(** :ref:`int` value **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`put_64` **(** :ref:`int` value **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`put_data` **(** :ref:`PackedByteArray` data **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`put_double` **(** :ref:`float` value **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`put_float` **(** :ref:`float` value **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`put_partial_data` **(** :ref:`PackedByteArray` data **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`put_string` **(** :ref:`String` value **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`put_u8` **(** :ref:`int` value **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`put_u16` **(** :ref:`int` value **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`put_u32` **(** :ref:`int` value **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`put_u64` **(** :ref:`int` value **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`put_utf8_string` **(** :ref:`String` value **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`put_var` **(** :ref:`Variant` value, :ref:`bool` full_objects=false **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_8`\ (\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_16`\ (\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_32`\ (\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_64`\ (\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_available_bytes`\ (\ ) |const| | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_data`\ (\ bytes\: :ref:`int`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_double`\ (\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_float`\ (\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_partial_data`\ (\ bytes\: :ref:`int`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_string`\ (\ bytes\: :ref:`int` = -1\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_u8`\ (\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_u16`\ (\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_u32`\ (\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_u64`\ (\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_utf8_string`\ (\ bytes\: :ref:`int` = -1\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_var`\ (\ allow_objects\: :ref:`bool` = false\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`put_8`\ (\ value\: :ref:`int`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`put_16`\ (\ value\: :ref:`int`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`put_32`\ (\ value\: :ref:`int`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`put_64`\ (\ value\: :ref:`int`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`put_data`\ (\ data\: :ref:`PackedByteArray`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`put_double`\ (\ value\: :ref:`float`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`put_float`\ (\ value\: :ref:`float`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`put_partial_data`\ (\ data\: :ref:`PackedByteArray`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`put_string`\ (\ value\: :ref:`String`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`put_u8`\ (\ value\: :ref:`int`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`put_u16`\ (\ value\: :ref:`int`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`put_u32`\ (\ value\: :ref:`int`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`put_u64`\ (\ value\: :ref:`int`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`put_utf8_string`\ (\ value\: :ref:`String`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`put_var`\ (\ value\: :ref:`Variant`, full_objects\: :ref:`bool` = false\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -126,8 +126,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_big_endian** **(** :ref:`bool` value **)** -- :ref:`bool` **is_big_endian_enabled** **(** **)** +- |void| **set_big_endian**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_big_endian_enabled**\ (\ ) If ``true``, this **StreamPeer** will using big-endian format for encoding and decoding. @@ -144,7 +144,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_8** **(** **)** +:ref:`int` **get_8**\ (\ ) Gets a signed byte from the stream. @@ -156,7 +156,7 @@ Gets a signed byte from the stream. .. rst-class:: classref-method -:ref:`int` **get_16** **(** **)** +:ref:`int` **get_16**\ (\ ) Gets a signed 16-bit value from the stream. @@ -168,7 +168,7 @@ Gets a signed 16-bit value from the stream. .. rst-class:: classref-method -:ref:`int` **get_32** **(** **)** +:ref:`int` **get_32**\ (\ ) Gets a signed 32-bit value from the stream. @@ -180,7 +180,7 @@ Gets a signed 32-bit value from the stream. .. rst-class:: classref-method -:ref:`int` **get_64** **(** **)** +:ref:`int` **get_64**\ (\ ) Gets a signed 64-bit value from the stream. @@ -192,7 +192,7 @@ Gets a signed 64-bit value from the stream. .. rst-class:: classref-method -:ref:`int` **get_available_bytes** **(** **)** |const| +:ref:`int` **get_available_bytes**\ (\ ) |const| Returns the number of bytes this **StreamPeer** has available. @@ -204,7 +204,7 @@ Returns the number of bytes this **StreamPeer** has available. .. rst-class:: classref-method -:ref:`Array` **get_data** **(** :ref:`int` bytes **)** +:ref:`Array` **get_data**\ (\ bytes\: :ref:`int`\ ) Returns a chunk data with the received bytes. The number of bytes to be received can be requested in the ``bytes`` argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an :ref:`Error` code and a data array. @@ -216,7 +216,7 @@ Returns a chunk data with the received bytes. The number of bytes to be received .. rst-class:: classref-method -:ref:`float` **get_double** **(** **)** +:ref:`float` **get_double**\ (\ ) Gets a double-precision float from the stream. @@ -228,7 +228,7 @@ Gets a double-precision float from the stream. .. rst-class:: classref-method -:ref:`float` **get_float** **(** **)** +:ref:`float` **get_float**\ (\ ) Gets a single-precision float from the stream. @@ -240,7 +240,7 @@ Gets a single-precision float from the stream. .. rst-class:: classref-method -:ref:`Array` **get_partial_data** **(** :ref:`int` bytes **)** +:ref:`Array` **get_partial_data**\ (\ bytes\: :ref:`int`\ ) Returns a chunk data with the received bytes. The number of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an :ref:`Error` code, and a data array. @@ -252,7 +252,7 @@ Returns a chunk data with the received bytes. The number of bytes to be received .. rst-class:: classref-method -:ref:`String` **get_string** **(** :ref:`int` bytes=-1 **)** +:ref:`String` **get_string**\ (\ bytes\: :ref:`int` = -1\ ) Gets an ASCII string with byte-length ``bytes`` from the stream. If ``bytes`` is negative (default) the length will be read from the stream using the reverse process of :ref:`put_string`. @@ -264,7 +264,7 @@ Gets an ASCII string with byte-length ``bytes`` from the stream. If ``bytes`` is .. rst-class:: classref-method -:ref:`int` **get_u8** **(** **)** +:ref:`int` **get_u8**\ (\ ) Gets an unsigned byte from the stream. @@ -276,7 +276,7 @@ Gets an unsigned byte from the stream. .. rst-class:: classref-method -:ref:`int` **get_u16** **(** **)** +:ref:`int` **get_u16**\ (\ ) Gets an unsigned 16-bit value from the stream. @@ -288,7 +288,7 @@ Gets an unsigned 16-bit value from the stream. .. rst-class:: classref-method -:ref:`int` **get_u32** **(** **)** +:ref:`int` **get_u32**\ (\ ) Gets an unsigned 32-bit value from the stream. @@ -300,7 +300,7 @@ Gets an unsigned 32-bit value from the stream. .. rst-class:: classref-method -:ref:`int` **get_u64** **(** **)** +:ref:`int` **get_u64**\ (\ ) Gets an unsigned 64-bit value from the stream. @@ -312,7 +312,7 @@ Gets an unsigned 64-bit value from the stream. .. rst-class:: classref-method -:ref:`String` **get_utf8_string** **(** :ref:`int` bytes=-1 **)** +:ref:`String` **get_utf8_string**\ (\ bytes\: :ref:`int` = -1\ ) Gets a UTF-8 string with byte-length ``bytes`` from the stream (this decodes the string sent as UTF-8). If ``bytes`` is negative (default) the length will be read from the stream using the reverse process of :ref:`put_utf8_string`. @@ -324,7 +324,7 @@ Gets a UTF-8 string with byte-length ``bytes`` from the stream (this decodes the .. rst-class:: classref-method -:ref:`Variant` **get_var** **(** :ref:`bool` allow_objects=false **)** +:ref:`Variant` **get_var**\ (\ allow_objects\: :ref:`bool` = false\ ) Gets a Variant from the stream. If ``allow_objects`` is ``true``, decoding objects is allowed. @@ -340,7 +340,7 @@ Internally, this uses the same decoding mechanism as the :ref:`@GlobalScope.byte .. rst-class:: classref-method -void **put_8** **(** :ref:`int` value **)** +|void| **put_8**\ (\ value\: :ref:`int`\ ) Puts a signed byte into the stream. @@ -352,7 +352,7 @@ Puts a signed byte into the stream. .. rst-class:: classref-method -void **put_16** **(** :ref:`int` value **)** +|void| **put_16**\ (\ value\: :ref:`int`\ ) Puts a signed 16-bit value into the stream. @@ -364,7 +364,7 @@ Puts a signed 16-bit value into the stream. .. rst-class:: classref-method -void **put_32** **(** :ref:`int` value **)** +|void| **put_32**\ (\ value\: :ref:`int`\ ) Puts a signed 32-bit value into the stream. @@ -376,7 +376,7 @@ Puts a signed 32-bit value into the stream. .. rst-class:: classref-method -void **put_64** **(** :ref:`int` value **)** +|void| **put_64**\ (\ value\: :ref:`int`\ ) Puts a signed 64-bit value into the stream. @@ -388,7 +388,7 @@ Puts a signed 64-bit value into the stream. .. rst-class:: classref-method -:ref:`Error` **put_data** **(** :ref:`PackedByteArray` data **)** +:ref:`Error` **put_data**\ (\ data\: :ref:`PackedByteArray`\ ) Sends a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an :ref:`Error` code. @@ -400,7 +400,7 @@ Sends a chunk of data through the connection, blocking if necessary until the da .. rst-class:: classref-method -void **put_double** **(** :ref:`float` value **)** +|void| **put_double**\ (\ value\: :ref:`float`\ ) Puts a double-precision float into the stream. @@ -412,7 +412,7 @@ Puts a double-precision float into the stream. .. rst-class:: classref-method -void **put_float** **(** :ref:`float` value **)** +|void| **put_float**\ (\ value\: :ref:`float`\ ) Puts a single-precision float into the stream. @@ -424,7 +424,7 @@ Puts a single-precision float into the stream. .. rst-class:: classref-method -:ref:`Array` **put_partial_data** **(** :ref:`PackedByteArray` data **)** +:ref:`Array` **put_partial_data**\ (\ data\: :ref:`PackedByteArray`\ ) Sends a chunk of data through the connection. If all the data could not be sent at once, only part of it will. This function returns two values, an :ref:`Error` code and an integer, describing how much data was actually sent. @@ -436,7 +436,7 @@ Sends a chunk of data through the connection. If all the data could not be sent .. rst-class:: classref-method -void **put_string** **(** :ref:`String` value **)** +|void| **put_string**\ (\ value\: :ref:`String`\ ) Puts a zero-terminated ASCII string into the stream prepended by a 32-bit unsigned integer representing its size. @@ -463,7 +463,7 @@ Puts a zero-terminated ASCII string into the stream prepended by a 32-bit unsign .. rst-class:: classref-method -void **put_u8** **(** :ref:`int` value **)** +|void| **put_u8**\ (\ value\: :ref:`int`\ ) Puts an unsigned byte into the stream. @@ -475,7 +475,7 @@ Puts an unsigned byte into the stream. .. rst-class:: classref-method -void **put_u16** **(** :ref:`int` value **)** +|void| **put_u16**\ (\ value\: :ref:`int`\ ) Puts an unsigned 16-bit value into the stream. @@ -487,7 +487,7 @@ Puts an unsigned 16-bit value into the stream. .. rst-class:: classref-method -void **put_u32** **(** :ref:`int` value **)** +|void| **put_u32**\ (\ value\: :ref:`int`\ ) Puts an unsigned 32-bit value into the stream. @@ -499,7 +499,7 @@ Puts an unsigned 32-bit value into the stream. .. rst-class:: classref-method -void **put_u64** **(** :ref:`int` value **)** +|void| **put_u64**\ (\ value\: :ref:`int`\ ) Puts an unsigned 64-bit value into the stream. @@ -511,7 +511,7 @@ Puts an unsigned 64-bit value into the stream. .. rst-class:: classref-method -void **put_utf8_string** **(** :ref:`String` value **)** +|void| **put_utf8_string**\ (\ value\: :ref:`String`\ ) Puts a zero-terminated UTF-8 string into the stream prepended by a 32 bits unsigned integer representing its size. @@ -538,7 +538,7 @@ Puts a zero-terminated UTF-8 string into the stream prepended by a 32 bits unsig .. rst-class:: classref-method -void **put_var** **(** :ref:`Variant` value, :ref:`bool` full_objects=false **)** +|void| **put_var**\ (\ value\: :ref:`Variant`, full_objects\: :ref:`bool` = false\ ) Puts a Variant into the stream. If ``full_objects`` is ``true`` encoding objects is allowed (and can potentially include code). @@ -551,3 +551,4 @@ Internally, this uses the same encoding mechanism as the :ref:`@GlobalScope.var_ .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_streampeerbuffer.rst b/classes/class_streampeerbuffer.rst index 8390241dcaf..eeb93a88266 100644 --- a/classes/class_streampeerbuffer.rst +++ b/classes/class_streampeerbuffer.rst @@ -43,19 +43,19 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+--------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------+ - | :ref:`StreamPeerBuffer` | :ref:`duplicate` **(** **)** |const| | - +-------------------------------------------------+--------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_position` **(** **)** |const| | - +-------------------------------------------------+--------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_size` **(** **)** |const| | - +-------------------------------------------------+--------------------------------------------------------------------------------------------+ - | void | :ref:`resize` **(** :ref:`int` size **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------+ - | void | :ref:`seek` **(** :ref:`int` position **)** | - +-------------------------------------------------+--------------------------------------------------------------------------------------------+ + +-------------------------------------------------+-----------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------+ + | :ref:`StreamPeerBuffer` | :ref:`duplicate`\ (\ ) |const| | + +-------------------------------------------------+-----------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_position`\ (\ ) |const| | + +-------------------------------------------------+-----------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_size`\ (\ ) |const| | + +-------------------------------------------------+-----------------------------------------------------------------------------------------+ + | |void| | :ref:`resize`\ (\ size\: :ref:`int`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------+ + | |void| | :ref:`seek`\ (\ position\: :ref:`int`\ ) | + +-------------------------------------------------+-----------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -74,8 +74,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_data_array** **(** :ref:`PackedByteArray` value **)** -- :ref:`PackedByteArray` **get_data_array** **(** **)** +- |void| **set_data_array**\ (\ value\: :ref:`PackedByteArray`\ ) +- :ref:`PackedByteArray` **get_data_array**\ (\ ) The underlying data buffer. Setting this value resets the cursor. @@ -92,7 +92,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the :ref:`data_array` and resets the cursor. @@ -104,7 +104,7 @@ Clears the :ref:`data_array` and res .. rst-class:: classref-method -:ref:`StreamPeerBuffer` **duplicate** **(** **)** |const| +:ref:`StreamPeerBuffer` **duplicate**\ (\ ) |const| Returns a new **StreamPeerBuffer** with the same :ref:`data_array` content. @@ -116,7 +116,7 @@ Returns a new **StreamPeerBuffer** with the same :ref:`data_array` **get_position** **(** **)** |const| +:ref:`int` **get_position**\ (\ ) |const| Returns the current cursor position. @@ -128,7 +128,7 @@ Returns the current cursor position. .. rst-class:: classref-method -:ref:`int` **get_size** **(** **)** |const| +:ref:`int` **get_size**\ (\ ) |const| Returns the size of :ref:`data_array`. @@ -140,7 +140,7 @@ Returns the size of :ref:`data_array .. rst-class:: classref-method -void **resize** **(** :ref:`int` size **)** +|void| **resize**\ (\ size\: :ref:`int`\ ) Resizes the :ref:`data_array`. This *doesn't* update the cursor. @@ -152,7 +152,7 @@ Resizes the :ref:`data_array`. This .. rst-class:: classref-method -void **seek** **(** :ref:`int` position **)** +|void| **seek**\ (\ position\: :ref:`int`\ ) Moves the cursor to the specified position. ``position`` must be a valid index of :ref:`data_array`. @@ -163,3 +163,4 @@ Moves the cursor to the specified position. ``position`` must be a valid index o .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_streampeerextension.rst b/classes/class_streampeerextension.rst index 7969add9498..2233bf51cc9 100644 --- a/classes/class_streampeerextension.rst +++ b/classes/class_streampeerextension.rst @@ -24,17 +24,17 @@ Methods .. table:: :widths: auto - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_available_bytes` **(** **)** |virtual| |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_get_data` **(** uint8_t* r_buffer, :ref:`int` r_bytes, int32_t* r_received **)** |virtual| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_get_partial_data` **(** uint8_t* r_buffer, :ref:`int` r_bytes, int32_t* r_received **)** |virtual| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_put_data` **(** const uint8_t* p_data, :ref:`int` p_bytes, int32_t* r_sent **)** |virtual| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_put_partial_data` **(** const uint8_t* p_data, :ref:`int` p_bytes, int32_t* r_sent **)** |virtual| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_available_bytes`\ (\ ) |virtual| |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_get_data`\ (\ r_buffer\: ``uint8_t*``, r_bytes\: :ref:`int`, r_received\: ``int32_t*``\ ) |virtual| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_get_partial_data`\ (\ r_buffer\: ``uint8_t*``, r_bytes\: :ref:`int`, r_received\: ``int32_t*``\ ) |virtual| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_put_data`\ (\ p_data\: ``const uint8_t*``, p_bytes\: :ref:`int`, r_sent\: ``int32_t*``\ ) |virtual| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_put_partial_data`\ (\ p_data\: ``const uint8_t*``, p_bytes\: :ref:`int`, r_sent\: ``int32_t*``\ ) |virtual| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -49,7 +49,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_available_bytes** **(** **)** |virtual| |const| +:ref:`int` **_get_available_bytes**\ (\ ) |virtual| |const| .. container:: contribute @@ -63,7 +63,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_get_data** **(** uint8_t* r_buffer, :ref:`int` r_bytes, int32_t* r_received **)** |virtual| +:ref:`Error` **_get_data**\ (\ r_buffer\: ``uint8_t*``, r_bytes\: :ref:`int`, r_received\: ``int32_t*``\ ) |virtual| .. container:: contribute @@ -77,7 +77,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_get_partial_data** **(** uint8_t* r_buffer, :ref:`int` r_bytes, int32_t* r_received **)** |virtual| +:ref:`Error` **_get_partial_data**\ (\ r_buffer\: ``uint8_t*``, r_bytes\: :ref:`int`, r_received\: ``int32_t*``\ ) |virtual| .. container:: contribute @@ -91,7 +91,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_put_data** **(** const uint8_t* p_data, :ref:`int` p_bytes, int32_t* r_sent **)** |virtual| +:ref:`Error` **_put_data**\ (\ p_data\: ``const uint8_t*``, p_bytes\: :ref:`int`, r_sent\: ``int32_t*``\ ) |virtual| .. container:: contribute @@ -105,7 +105,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_put_partial_data** **(** const uint8_t* p_data, :ref:`int` p_bytes, int32_t* r_sent **)** |virtual| +:ref:`Error` **_put_partial_data**\ (\ p_data\: ``const uint8_t*``, p_bytes\: :ref:`int`, r_sent\: ``int32_t*``\ ) |virtual| .. container:: contribute @@ -118,3 +118,4 @@ Method Descriptions .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_streampeergzip.rst b/classes/class_streampeergzip.rst index 5095278efea..880f22d7f69 100644 --- a/classes/class_streampeergzip.rst +++ b/classes/class_streampeergzip.rst @@ -33,15 +33,15 @@ Methods .. table:: :widths: auto - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`finish` **(** **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`start_compression` **(** :ref:`bool` use_deflate=false, :ref:`int` buffer_size=65535 **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`start_decompression` **(** :ref:`bool` use_deflate=false, :ref:`int` buffer_size=65535 **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`finish`\ (\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`start_compression`\ (\ use_deflate\: :ref:`bool` = false, buffer_size\: :ref:`int` = 65535\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`start_decompression`\ (\ use_deflate\: :ref:`bool` = false, buffer_size\: :ref:`int` = 65535\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -56,7 +56,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears this stream, resetting the internal state. @@ -68,7 +68,7 @@ Clears this stream, resetting the internal state. .. rst-class:: classref-method -:ref:`Error` **finish** **(** **)** +:ref:`Error` **finish**\ (\ ) Finalizes the stream, compressing or decompressing any buffered chunk left. @@ -80,7 +80,7 @@ Finalizes the stream, compressing or decompressing any buffered chunk left. .. rst-class:: classref-method -:ref:`Error` **start_compression** **(** :ref:`bool` use_deflate=false, :ref:`int` buffer_size=65535 **)** +:ref:`Error` **start_compression**\ (\ use_deflate\: :ref:`bool` = false, buffer_size\: :ref:`int` = 65535\ ) Start the stream in compression mode with the given ``buffer_size``, if ``use_deflate`` is ``true`` uses deflate instead of GZIP. @@ -92,7 +92,7 @@ Start the stream in compression mode with the given ``buffer_size``, if ``use_de .. rst-class:: classref-method -:ref:`Error` **start_decompression** **(** :ref:`bool` use_deflate=false, :ref:`int` buffer_size=65535 **)** +:ref:`Error` **start_decompression**\ (\ use_deflate\: :ref:`bool` = false, buffer_size\: :ref:`int` = 65535\ ) Start the stream in decompression mode with the given ``buffer_size``, if ``use_deflate`` is ``true`` uses deflate instead of GZIP. @@ -103,3 +103,4 @@ Start the stream in decompression mode with the given ``buffer_size``, if ``use_ .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index 4f7d6e3c006..5b68b692be0 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -31,25 +31,25 @@ Methods .. table:: :widths: auto - +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`bind` **(** :ref:`int` port, :ref:`String` host="*" **)** | - +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port **)** | - +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`disconnect_from_host` **(** **)** | - +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_connected_host` **(** **)** |const| | - +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_connected_port` **(** **)** |const| | - +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_local_port` **(** **)** |const| | - +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Status` | :ref:`get_status` **(** **)** |const| | - +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`poll` **(** **)** | - +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_no_delay` **(** :ref:`bool` enabled **)** | - +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`bind`\ (\ port\: :ref:`int`, host\: :ref:`String` = "*"\ ) | + +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`connect_to_host`\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) | + +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`disconnect_from_host`\ (\ ) | + +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_connected_host`\ (\ ) |const| | + +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_connected_port`\ (\ ) |const| | + +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_local_port`\ (\ ) |const| | + +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Status` | :ref:`get_status`\ (\ ) |const| | + +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`poll`\ (\ ) | + +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_no_delay`\ (\ enabled\: :ref:`bool`\ ) | + +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -111,7 +111,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **bind** **(** :ref:`int` port, :ref:`String` host="*" **)** +:ref:`Error` **bind**\ (\ port\: :ref:`int`, host\: :ref:`String` = "*"\ ) Opens the TCP socket, and binds it to the specified local address. @@ -125,7 +125,7 @@ This method is generally not needed, and only used to force the subsequent call .. rst-class:: classref-method -:ref:`Error` **connect_to_host** **(** :ref:`String` host, :ref:`int` port **)** +:ref:`Error` **connect_to_host**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) Connects to the specified ``host:port`` pair. A hostname will be resolved if valid. Returns :ref:`@GlobalScope.OK` on success. @@ -137,7 +137,7 @@ Connects to the specified ``host:port`` pair. A hostname will be resolved if val .. rst-class:: classref-method -void **disconnect_from_host** **(** **)** +|void| **disconnect_from_host**\ (\ ) Disconnects from host. @@ -149,7 +149,7 @@ Disconnects from host. .. rst-class:: classref-method -:ref:`String` **get_connected_host** **(** **)** |const| +:ref:`String` **get_connected_host**\ (\ ) |const| Returns the IP of this peer. @@ -161,7 +161,7 @@ Returns the IP of this peer. .. rst-class:: classref-method -:ref:`int` **get_connected_port** **(** **)** |const| +:ref:`int` **get_connected_port**\ (\ ) |const| Returns the port of this peer. @@ -173,7 +173,7 @@ Returns the port of this peer. .. rst-class:: classref-method -:ref:`int` **get_local_port** **(** **)** |const| +:ref:`int` **get_local_port**\ (\ ) |const| Returns the local port to which this peer is bound. @@ -185,7 +185,7 @@ Returns the local port to which this peer is bound. .. rst-class:: classref-method -:ref:`Status` **get_status** **(** **)** |const| +:ref:`Status` **get_status**\ (\ ) |const| Returns the status of the connection, see :ref:`Status`. @@ -197,7 +197,7 @@ Returns the status of the connection, see :ref:`Status` **poll** **(** **)** +:ref:`Error` **poll**\ (\ ) Poll the socket, updating its state. See :ref:`get_status`. @@ -209,7 +209,7 @@ Poll the socket, updating its state. See :ref:`get_status` enabled **)** +|void| **set_no_delay**\ (\ enabled\: :ref:`bool`\ ) If ``enabled`` is ``true``, packets will be sent immediately. If ``enabled`` is ``false`` (the default), packet transfers will be delayed and combined using `Nagle's algorithm `__. @@ -222,3 +222,4 @@ If ``enabled`` is ``true``, packets will be sent immediately. If ``enabled`` is .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_streampeertls.rst b/classes/class_streampeertls.rst index 9678facfceb..eb578c3cd46 100644 --- a/classes/class_streampeertls.rst +++ b/classes/class_streampeertls.rst @@ -38,19 +38,19 @@ Methods .. table:: :widths: auto - +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`accept_stream` **(** :ref:`StreamPeer` stream, :ref:`TLSOptions` server_options **)** | - +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`connect_to_stream` **(** :ref:`StreamPeer` stream, :ref:`String` common_name, :ref:`TLSOptions` client_options=null **)** | - +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`disconnect_from_stream` **(** **)** | - +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Status` | :ref:`get_status` **(** **)** |const| | - +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StreamPeer` | :ref:`get_stream` **(** **)** |const| | - +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`poll` **(** **)** | - +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`accept_stream`\ (\ stream\: :ref:`StreamPeer`, server_options\: :ref:`TLSOptions`\ ) | + +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`connect_to_stream`\ (\ stream\: :ref:`StreamPeer`, common_name\: :ref:`String`, client_options\: :ref:`TLSOptions` = null\ ) | + +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`disconnect_from_stream`\ (\ ) | + +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Status` | :ref:`get_status`\ (\ ) |const| | + +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StreamPeer` | :ref:`get_stream`\ (\ ) |const| | + +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`poll`\ (\ ) | + +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -120,7 +120,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **accept_stream** **(** :ref:`StreamPeer` stream, :ref:`TLSOptions` server_options **)** +:ref:`Error` **accept_stream**\ (\ stream\: :ref:`StreamPeer`, server_options\: :ref:`TLSOptions`\ ) Accepts a peer connection as a server using the given ``server_options``. See :ref:`TLSOptions.server`. @@ -132,7 +132,7 @@ Accepts a peer connection as a server using the given ``server_options``. See :r .. rst-class:: classref-method -:ref:`Error` **connect_to_stream** **(** :ref:`StreamPeer` stream, :ref:`String` common_name, :ref:`TLSOptions` client_options=null **)** +:ref:`Error` **connect_to_stream**\ (\ stream\: :ref:`StreamPeer`, common_name\: :ref:`String`, client_options\: :ref:`TLSOptions` = null\ ) Connects to a peer using an underlying :ref:`StreamPeer` ``stream`` and verifying the remote certificate is correctly signed for the given ``common_name``. You can pass the optional ``client_options`` parameter to customize the trusted certification authorities, or disable the common name verification. See :ref:`TLSOptions.client` and :ref:`TLSOptions.client_unsafe`. @@ -144,7 +144,7 @@ Connects to a peer using an underlying :ref:`StreamPeer` ``str .. rst-class:: classref-method -void **disconnect_from_stream** **(** **)** +|void| **disconnect_from_stream**\ (\ ) Disconnects from host. @@ -156,7 +156,7 @@ Disconnects from host. .. rst-class:: classref-method -:ref:`Status` **get_status** **(** **)** |const| +:ref:`Status` **get_status**\ (\ ) |const| Returns the status of the connection. See :ref:`Status` for values. @@ -168,7 +168,7 @@ Returns the status of the connection. See :ref:`Status` **get_stream** **(** **)** |const| +:ref:`StreamPeer` **get_stream**\ (\ ) |const| Returns the underlying :ref:`StreamPeer` connection, used in :ref:`accept_stream` or :ref:`connect_to_stream`. @@ -180,7 +180,7 @@ Returns the underlying :ref:`StreamPeer` connection, used in : .. rst-class:: classref-method -void **poll** **(** **)** +|void| **poll**\ (\ ) Poll the connection to check for incoming bytes. Call this right before :ref:`StreamPeer.get_available_bytes` for it to work properly. @@ -191,3 +191,4 @@ Poll the connection to check for incoming bytes. Call this right before :ref:`St .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_string.rst b/classes/class_string.rst index 7d91b325238..4503f50f00b 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -42,15 +42,15 @@ Constructors .. table:: :widths: auto - +-----------------------------+-----------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`String` **(** **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`String` **(** :ref:`String` from **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`String` **(** :ref:`NodePath` from **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`String` **(** :ref:`StringName` from **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------+ + +-----------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`String`\ (\ ) | + +-----------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`String`\ (\ from\: :ref:`String`\ ) | + +-----------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`String`\ (\ from\: :ref:`NodePath`\ ) | + +-----------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`String`\ (\ from\: :ref:`StringName`\ ) | + +-----------------------------+--------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -60,215 +60,215 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`begins_with` **(** :ref:`String` text **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`bigrams` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bin_to_int` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`c_escape` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`c_unescape` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`capitalize` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`casecmp_to` **(** :ref:`String` to **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`chr` **(** :ref:`int` char **)** |static| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`contains` **(** :ref:`String` what **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count` **(** :ref:`String` what, :ref:`int` from=0, :ref:`int` to=0 **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`countn` **(** :ref:`String` what, :ref:`int` from=0, :ref:`int` to=0 **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`dedent` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`ends_with` **(** :ref:`String` text **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`erase` **(** :ref:`int` position, :ref:`int` chars=1 **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find` **(** :ref:`String` what, :ref:`int` from=0 **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`findn` **(** :ref:`String` what, :ref:`int` from=0 **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`format` **(** :ref:`Variant` values, :ref:`String` placeholder="{_}" **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_base_dir` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_basename` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_extension` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_file` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_slice` **(** :ref:`String` delimiter, :ref:`int` slice **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_slice_count` **(** :ref:`String` delimiter **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_slicec` **(** :ref:`int` delimiter, :ref:`int` slice **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`hash` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`hex_decode` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`hex_to_int` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`humanize_size` **(** :ref:`int` size **)** |static| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`indent` **(** :ref:`String` prefix **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`insert` **(** :ref:`int` position, :ref:`String` what **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_absolute_path` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_relative_path` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_subsequence_of` **(** :ref:`String` text **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_subsequence_ofn` **(** :ref:`String` text **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_filename` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_float` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_hex_number` **(** :ref:`bool` with_prefix=false **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_html_color` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_identifier` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_int` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_ip_address` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`join` **(** :ref:`PackedStringArray` parts **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`json_escape` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`left` **(** :ref:`int` length **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`length` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`lpad` **(** :ref:`int` min_length, :ref:`String` character=" " **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`lstrip` **(** :ref:`String` chars **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`match` **(** :ref:`String` expr **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`matchn` **(** :ref:`String` expr **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`md5_buffer` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`md5_text` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`naturalcasecmp_to` **(** :ref:`String` to **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`naturalnocasecmp_to` **(** :ref:`String` to **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`nocasecmp_to` **(** :ref:`String` to **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`num` **(** :ref:`float` number, :ref:`int` decimals=-1 **)** |static| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`num_int64` **(** :ref:`int` number, :ref:`int` base=10, :ref:`bool` capitalize_hex=false **)** |static| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`num_scientific` **(** :ref:`float` number **)** |static| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`num_uint64` **(** :ref:`int` number, :ref:`int` base=10, :ref:`bool` capitalize_hex=false **)** |static| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`pad_decimals` **(** :ref:`int` digits **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`pad_zeros` **(** :ref:`int` digits **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`path_join` **(** :ref:`String` file **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`repeat` **(** :ref:`int` count **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`replace` **(** :ref:`String` what, :ref:`String` forwhat **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`replacen` **(** :ref:`String` what, :ref:`String` forwhat **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`reverse` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind` **(** :ref:`String` what, :ref:`int` from=-1 **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfindn` **(** :ref:`String` what, :ref:`int` from=-1 **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`right` **(** :ref:`int` length **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rpad` **(** :ref:`int` min_length, :ref:`String` character=" " **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`rsplit` **(** :ref:`String` delimiter="", :ref:`bool` allow_empty=true, :ref:`int` maxsplit=0 **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rstrip` **(** :ref:`String` chars **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`sha1_buffer` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`sha1_text` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`sha256_buffer` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`sha256_text` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`similarity` **(** :ref:`String` text **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`simplify_path` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`split` **(** :ref:`String` delimiter="", :ref:`bool` allow_empty=true, :ref:`int` maxsplit=0 **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat64Array` | :ref:`split_floats` **(** :ref:`String` delimiter, :ref:`bool` allow_empty=true **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`strip_edges` **(** :ref:`bool` left=true, :ref:`bool` right=true **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`strip_escapes` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`substr` **(** :ref:`int` from, :ref:`int` len=-1 **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_ascii_buffer` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`to_camel_case` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`to_float` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`to_int` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`to_lower` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`to_pascal_case` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`to_snake_case` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`to_upper` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_utf8_buffer` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_utf16_buffer` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_utf32_buffer` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_wchar_buffer` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`trim_prefix` **(** :ref:`String` prefix **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`trim_suffix` **(** :ref:`String` suffix **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`unicode_at` **(** :ref:`int` at **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`uri_decode` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`uri_encode` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`validate_filename` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`validate_node_name` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`xml_escape` **(** :ref:`bool` escape_quotes=false **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`xml_unescape` **(** **)** |const| | - +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`begins_with`\ (\ text\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`bigrams`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bin_to_int`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`c_escape`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`c_unescape`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`capitalize`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`casecmp_to`\ (\ to\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`chr`\ (\ char\: :ref:`int`\ ) |static| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`contains`\ (\ what\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ what\: :ref:`String`, from\: :ref:`int` = 0, to\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`countn`\ (\ what\: :ref:`String`, from\: :ref:`int` = 0, to\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`dedent`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`ends_with`\ (\ text\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`erase`\ (\ position\: :ref:`int`, chars\: :ref:`int` = 1\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ what\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`findn`\ (\ what\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`format`\ (\ values\: :ref:`Variant`, placeholder\: :ref:`String` = "{_}"\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_base_dir`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_basename`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_extension`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_file`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_slice`\ (\ delimiter\: :ref:`String`, slice\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_slice_count`\ (\ delimiter\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_slicec`\ (\ delimiter\: :ref:`int`, slice\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`hash`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`hex_decode`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`hex_to_int`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`humanize_size`\ (\ size\: :ref:`int`\ ) |static| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`indent`\ (\ prefix\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`insert`\ (\ position\: :ref:`int`, what\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_absolute_path`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_relative_path`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_subsequence_of`\ (\ text\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_subsequence_ofn`\ (\ text\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_filename`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_float`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_hex_number`\ (\ with_prefix\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_html_color`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_identifier`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_int`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_ip_address`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`join`\ (\ parts\: :ref:`PackedStringArray`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`json_escape`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`left`\ (\ length\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`length`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`lpad`\ (\ min_length\: :ref:`int`, character\: :ref:`String` = " "\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`lstrip`\ (\ chars\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`match`\ (\ expr\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`matchn`\ (\ expr\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`md5_buffer`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`md5_text`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`naturalcasecmp_to`\ (\ to\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`naturalnocasecmp_to`\ (\ to\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`nocasecmp_to`\ (\ to\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`num`\ (\ number\: :ref:`float`, decimals\: :ref:`int` = -1\ ) |static| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`num_int64`\ (\ number\: :ref:`int`, base\: :ref:`int` = 10, capitalize_hex\: :ref:`bool` = false\ ) |static| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`num_scientific`\ (\ number\: :ref:`float`\ ) |static| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`num_uint64`\ (\ number\: :ref:`int`, base\: :ref:`int` = 10, capitalize_hex\: :ref:`bool` = false\ ) |static| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`pad_decimals`\ (\ digits\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`pad_zeros`\ (\ digits\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`path_join`\ (\ file\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`repeat`\ (\ count\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`replace`\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`replacen`\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`reverse`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ what\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfindn`\ (\ what\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`right`\ (\ length\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`rpad`\ (\ min_length\: :ref:`int`, character\: :ref:`String` = " "\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`rsplit`\ (\ delimiter\: :ref:`String` = "", allow_empty\: :ref:`bool` = true, maxsplit\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`rstrip`\ (\ chars\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`sha1_buffer`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`sha1_text`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`sha256_buffer`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`sha256_text`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`similarity`\ (\ text\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`simplify_path`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`split`\ (\ delimiter\: :ref:`String` = "", allow_empty\: :ref:`bool` = true, maxsplit\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat64Array` | :ref:`split_floats`\ (\ delimiter\: :ref:`String`, allow_empty\: :ref:`bool` = true\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`strip_edges`\ (\ left\: :ref:`bool` = true, right\: :ref:`bool` = true\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`strip_escapes`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`substr`\ (\ from\: :ref:`int`, len\: :ref:`int` = -1\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_ascii_buffer`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`to_camel_case`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`to_float`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`to_int`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`to_lower`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`to_pascal_case`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`to_snake_case`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`to_upper`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_utf8_buffer`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_utf16_buffer`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_utf32_buffer`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_wchar_buffer`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`trim_prefix`\ (\ prefix\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`trim_suffix`\ (\ suffix\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`unicode_at`\ (\ at\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`uri_decode`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`uri_encode`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`validate_filename`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`validate_node_name`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`xml_escape`\ (\ escape_quotes\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`xml_unescape`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -278,31 +278,31 @@ Operators .. table:: :widths: auto - +-----------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`String` right **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`StringName` right **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`operator %` **(** :ref:`Variant` right **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`operator +` **(** :ref:`String` right **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`operator +` **(** :ref:`StringName` right **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<` **(** :ref:`String` right **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<=` **(** :ref:`String` right **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`String` right **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`StringName` right **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >` **(** :ref:`String` right **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >=` **(** :ref:`String` right **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`operator []` **(** :ref:`int` index **)** | - +-----------------------------+----------------------------------------------------------------------------------------------------------------+ + +-----------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`String`\ ) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`StringName`\ ) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`operator %`\ (\ right\: :ref:`Variant`\ ) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`operator +`\ (\ right\: :ref:`String`\ ) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`operator +`\ (\ right\: :ref:`StringName`\ ) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<`\ (\ right\: :ref:`String`\ ) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<=`\ (\ right\: :ref:`String`\ ) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`String`\ ) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`StringName`\ ) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >`\ (\ right\: :ref:`String`\ ) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >=`\ (\ right\: :ref:`String`\ ) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +-----------------------------+-------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -317,7 +317,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`String` **String** **(** **)** +:ref:`String` **String**\ (\ ) Constructs an empty **String** (``""``). @@ -327,7 +327,7 @@ Constructs an empty **String** (``""``). .. rst-class:: classref-constructor -:ref:`String` **String** **(** :ref:`String` from **)** +:ref:`String` **String**\ (\ from\: :ref:`String`\ ) Constructs a **String** as a copy of the given **String**. @@ -337,7 +337,7 @@ Constructs a **String** as a copy of the given **String**. .. rst-class:: classref-constructor -:ref:`String` **String** **(** :ref:`NodePath` from **)** +:ref:`String` **String**\ (\ from\: :ref:`NodePath`\ ) Constructs a new **String** from the given :ref:`NodePath`. @@ -347,7 +347,7 @@ Constructs a new **String** from the given :ref:`NodePath`. .. rst-class:: classref-constructor -:ref:`String` **String** **(** :ref:`StringName` from **)** +:ref:`String` **String**\ (\ from\: :ref:`StringName`\ ) Constructs a new **String** from the given :ref:`StringName`. @@ -364,7 +364,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **begins_with** **(** :ref:`String` text **)** |const| +:ref:`bool` **begins_with**\ (\ text\: :ref:`String`\ ) |const| Returns ``true`` if the string begins with the given ``text``. See also :ref:`ends_with`. @@ -376,7 +376,7 @@ Returns ``true`` if the string begins with the given ``text``. See also :ref:`en .. rst-class:: classref-method -:ref:`PackedStringArray` **bigrams** **(** **)** |const| +:ref:`PackedStringArray` **bigrams**\ (\ ) |const| Returns an array containing the bigrams (pairs of consecutive characters) of this string. @@ -392,7 +392,7 @@ Returns an array containing the bigrams (pairs of consecutive characters) of thi .. rst-class:: classref-method -:ref:`int` **bin_to_int** **(** **)** |const| +:ref:`int` **bin_to_int**\ (\ ) |const| Converts the string representing a binary number into an :ref:`int`. The string may optionally be prefixed with ``"0b"``, and an additional ``-`` prefix for negative numbers. @@ -421,7 +421,7 @@ Converts the string representing a binary number into an :ref:`int`. .. rst-class:: classref-method -:ref:`String` **c_escape** **(** **)** |const| +:ref:`String` **c_escape**\ (\ ) |const| Returns a copy of the string with special characters escaped using the C language standard. @@ -433,7 +433,7 @@ Returns a copy of the string with special characters escaped using the C languag .. rst-class:: classref-method -:ref:`String` **c_unescape** **(** **)** |const| +:ref:`String` **c_unescape**\ (\ ) |const| Returns a copy of the string with escaped characters replaced by their meanings. Supported escape sequences are ``\'``, ``\"``, ``\\``, ``\a``, ``\b``, ``\f``, ``\n``, ``\r``, ``\t``, ``\v``. @@ -447,7 +447,7 @@ Returns a copy of the string with escaped characters replaced by their meanings. .. rst-class:: classref-method -:ref:`String` **capitalize** **(** **)** |const| +:ref:`String` **capitalize**\ (\ ) |const| Changes the appearance of the string: replaces underscores (``_``) with spaces, adds spaces before uppercase letters in the middle of a word, converts all letters to lowercase, then converts the first one and each one following a space to uppercase. @@ -476,7 +476,7 @@ Changes the appearance of the string: replaces underscores (``_``) with spaces, .. rst-class:: classref-method -:ref:`int` **casecmp_to** **(** :ref:`String` to **)** |const| +:ref:`int` **casecmp_to**\ (\ to\: :ref:`String`\ ) |const| Performs a case-sensitive comparison to another string. Returns ``-1`` if less than, ``1`` if greater than, or ``0`` if equal. "Less than" and "greater than" are determined by the `Unicode code points `__ of each string, which roughly matches the alphabetical order. @@ -492,7 +492,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`String` **chr** **(** :ref:`int` char **)** |static| +:ref:`String` **chr**\ (\ char\: :ref:`int`\ ) |static| Returns a single Unicode character from the decimal ``char``. You may use `unicodelookup.com `__ or `unicode.org `__ as points of reference. @@ -509,7 +509,7 @@ Returns a single Unicode character from the decimal ``char``. You may use `unico .. rst-class:: classref-method -:ref:`bool` **contains** **(** :ref:`String` what **)** |const| +:ref:`bool` **contains**\ (\ what\: :ref:`String`\ ) |const| Returns ``true`` if the string contains ``what``. In GDScript, this corresponds to the ``in`` operator. @@ -539,7 +539,7 @@ If you need to know where ``what`` is within the string, use :ref:`find` **count** **(** :ref:`String` what, :ref:`int` from=0, :ref:`int` to=0 **)** |const| +:ref:`int` **count**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0, to\: :ref:`int` = 0\ ) |const| Returns the number of occurrences of the substring ``what`` between ``from`` and ``to`` positions. If ``to`` is 0, the search continues until the end of the string. @@ -551,7 +551,7 @@ Returns the number of occurrences of the substring ``what`` between ``from`` and .. rst-class:: classref-method -:ref:`int` **countn** **(** :ref:`String` what, :ref:`int` from=0, :ref:`int` to=0 **)** |const| +:ref:`int` **countn**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0, to\: :ref:`int` = 0\ ) |const| Returns the number of occurrences of the substring ``what`` between ``from`` and ``to`` positions, **ignoring case**. If ``to`` is 0, the search continues until the end of the string. @@ -563,7 +563,7 @@ Returns the number of occurrences of the substring ``what`` between ``from`` and .. rst-class:: classref-method -:ref:`String` **dedent** **(** **)** |const| +:ref:`String` **dedent**\ (\ ) |const| Returns a copy of the string with indentation (leading tabs and spaces) removed. See also :ref:`indent` to add indentation. @@ -575,7 +575,7 @@ Returns a copy of the string with indentation (leading tabs and spaces) removed. .. rst-class:: classref-method -:ref:`bool` **ends_with** **(** :ref:`String` text **)** |const| +:ref:`bool` **ends_with**\ (\ text\: :ref:`String`\ ) |const| Returns ``true`` if the string ends with the given ``text``. See also :ref:`begins_with`. @@ -587,7 +587,7 @@ Returns ``true`` if the string ends with the given ``text``. See also :ref:`begi .. rst-class:: classref-method -:ref:`String` **erase** **(** :ref:`int` position, :ref:`int` chars=1 **)** |const| +:ref:`String` **erase**\ (\ position\: :ref:`int`, chars\: :ref:`int` = 1\ ) |const| Returns a string with ``chars`` characters erased starting from ``position``. If ``chars`` goes beyond the string's length given the specified ``position``, fewer characters will be erased from the returned string. Returns an empty string if either ``position`` or ``chars`` is negative. Returns the original string unmodified if ``chars`` is ``0``. @@ -599,7 +599,7 @@ Returns a string with ``chars`` characters erased starting from ``position``. If .. rst-class:: classref-method -:ref:`int` **find** **(** :ref:`String` what, :ref:`int` from=0 **)** |const| +:ref:`int` **find**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| Returns the index of the **first** occurrence of ``what`` in this string, or ``-1`` if there are none. The search's start can be specified with ``from``, continuing to the end of the string. @@ -634,7 +634,7 @@ Returns the index of the **first** occurrence of ``what`` in this string, or ``- .. rst-class:: classref-method -:ref:`int` **findn** **(** :ref:`String` what, :ref:`int` from=0 **)** |const| +:ref:`int` **findn**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| Returns the index of the **first** **case-insensitive** occurrence of ``what`` in this string, or ``-1`` if there are none. The starting search index can be specified with ``from``, continuing to the end of the string. @@ -646,7 +646,7 @@ Returns the index of the **first** **case-insensitive** occurrence of ``what`` i .. rst-class:: classref-method -:ref:`String` **format** **(** :ref:`Variant` values, :ref:`String` placeholder="{_}" **)** |const| +:ref:`String` **format**\ (\ values\: :ref:`Variant`, placeholder\: :ref:`String` = "{_}"\ ) |const| Formats the string by replacing all occurrences of ``placeholder`` with the elements of ``values``. @@ -681,7 +681,7 @@ See also the :doc:`GDScript format string <../tutorials/scripting/gdscript/gdscr .. rst-class:: classref-method -:ref:`String` **get_base_dir** **(** **)** |const| +:ref:`String` **get_base_dir**\ (\ ) |const| If the string is a valid file path, returns the base directory name. @@ -697,7 +697,7 @@ If the string is a valid file path, returns the base directory name. .. rst-class:: classref-method -:ref:`String` **get_basename** **(** **)** |const| +:ref:`String` **get_basename**\ (\ ) |const| If the string is a valid file path, returns the full file path, without the extension. @@ -713,7 +713,7 @@ If the string is a valid file path, returns the full file path, without the exte .. rst-class:: classref-method -:ref:`String` **get_extension** **(** **)** |const| +:ref:`String` **get_extension**\ (\ ) |const| If the string is a valid file name or path, returns the file extension without the leading period (``.``). Otherwise, returns an empty string. @@ -737,7 +737,7 @@ If the string is a valid file name or path, returns the file extension without t .. rst-class:: classref-method -:ref:`String` **get_file** **(** **)** |const| +:ref:`String` **get_file**\ (\ ) |const| If the string is a valid file path, returns the file name, including the extension. @@ -753,7 +753,7 @@ If the string is a valid file path, returns the file name, including the extensi .. rst-class:: classref-method -:ref:`String` **get_slice** **(** :ref:`String` delimiter, :ref:`int` slice **)** |const| +:ref:`String` **get_slice**\ (\ delimiter\: :ref:`String`, slice\: :ref:`int`\ ) |const| Splits the string using a ``delimiter`` and returns the substring at index ``slice``. Returns the original string if ``delimiter`` does not occur in the string. Returns an empty string if the ``slice`` does not exist. @@ -773,7 +773,7 @@ This is faster than :ref:`split`, if you only need on .. rst-class:: classref-method -:ref:`int` **get_slice_count** **(** :ref:`String` delimiter **)** |const| +:ref:`int` **get_slice_count**\ (\ delimiter\: :ref:`String`\ ) |const| Returns the total number of slices when the string is split with the given ``delimiter`` (see :ref:`split`). @@ -785,7 +785,7 @@ Returns the total number of slices when the string is split with the given ``del .. rst-class:: classref-method -:ref:`String` **get_slicec** **(** :ref:`int` delimiter, :ref:`int` slice **)** |const| +:ref:`String` **get_slicec**\ (\ delimiter\: :ref:`int`, slice\: :ref:`int`\ ) |const| Splits the string using a Unicode character with code ``delimiter`` and returns the substring at index ``slice``. Returns an empty string if the ``slice`` does not exist. @@ -799,7 +799,7 @@ This is faster than :ref:`split`, if you only need on .. rst-class:: classref-method -:ref:`int` **hash** **(** **)** |const| +:ref:`int` **hash**\ (\ ) |const| Returns the 32-bit hash value representing the string's contents. @@ -813,7 +813,7 @@ Returns the 32-bit hash value representing the string's contents. .. rst-class:: classref-method -:ref:`PackedByteArray` **hex_decode** **(** **)** |const| +:ref:`PackedByteArray` **hex_decode**\ (\ ) |const| Decodes a hexadecimal string as a :ref:`PackedByteArray`. @@ -842,7 +842,7 @@ Decodes a hexadecimal string as a :ref:`PackedByteArray`. .. rst-class:: classref-method -:ref:`int` **hex_to_int** **(** **)** |const| +:ref:`int` **hex_to_int**\ (\ ) |const| Converts the string representing a hexadecimal number into an :ref:`int`. The string may be optionally prefixed with ``"0x"``, and an additional ``-`` prefix for negative numbers. @@ -869,7 +869,7 @@ Converts the string representing a hexadecimal number into an :ref:`int` **humanize_size** **(** :ref:`int` size **)** |static| +:ref:`String` **humanize_size**\ (\ size\: :ref:`int`\ ) |static| Converts ``size`` which represents a number of bytes into a human-readable form. @@ -883,7 +883,7 @@ The result is in `IEC prefix format ` **indent** **(** :ref:`String` prefix **)** |const| +:ref:`String` **indent**\ (\ prefix\: :ref:`String`\ ) |const| Indents every line of the string with the given ``prefix``. Empty lines are not indented. See also :ref:`dedent` to remove indentation. @@ -897,7 +897,7 @@ For example, the string can be indented with two tabulations using ``"\t\t"``, o .. rst-class:: classref-method -:ref:`String` **insert** **(** :ref:`int` position, :ref:`String` what **)** |const| +:ref:`String` **insert**\ (\ position\: :ref:`int`, what\: :ref:`String`\ ) |const| Inserts ``what`` at the given ``position`` in the string. @@ -909,7 +909,7 @@ Inserts ``what`` at the given ``position`` in the string. .. rst-class:: classref-method -:ref:`bool` **is_absolute_path** **(** **)** |const| +:ref:`bool` **is_absolute_path**\ (\ ) |const| Returns ``true`` if the string is a path to a file or directory, and its starting point is explicitly defined. This method is the opposite of :ref:`is_relative_path`. @@ -923,7 +923,7 @@ This includes all paths starting with ``"res://"``, ``"user://"``, ``"C:\"``, `` .. rst-class:: classref-method -:ref:`bool` **is_empty** **(** **)** |const| +:ref:`bool` **is_empty**\ (\ ) |const| Returns ``true`` if the string's length is ``0`` (``""``). See also :ref:`length`. @@ -935,7 +935,7 @@ Returns ``true`` if the string's length is ``0`` (``""``). See also :ref:`length .. rst-class:: classref-method -:ref:`bool` **is_relative_path** **(** **)** |const| +:ref:`bool` **is_relative_path**\ (\ ) |const| Returns ``true`` if the string is a path, and its starting point is dependent on context. The path could begin from the current directory, or the current :ref:`Node` (if the string is derived from a :ref:`NodePath`), and may sometimes be prefixed with ``"./"``. This method is the opposite of :ref:`is_absolute_path`. @@ -947,7 +947,7 @@ Returns ``true`` if the string is a path, and its starting point is dependent on .. rst-class:: classref-method -:ref:`bool` **is_subsequence_of** **(** :ref:`String` text **)** |const| +:ref:`bool` **is_subsequence_of**\ (\ text\: :ref:`String`\ ) |const| Returns ``true`` if all characters of this string can be found in ``text`` in their original order. @@ -968,7 +968,7 @@ Returns ``true`` if all characters of this string can be found in ``text`` in th .. rst-class:: classref-method -:ref:`bool` **is_subsequence_ofn** **(** :ref:`String` text **)** |const| +:ref:`bool` **is_subsequence_ofn**\ (\ text\: :ref:`String`\ ) |const| Returns ``true`` if all characters of this string can be found in ``text`` in their original order, **ignoring case**. @@ -980,7 +980,7 @@ Returns ``true`` if all characters of this string can be found in ``text`` in th .. rst-class:: classref-method -:ref:`bool` **is_valid_filename** **(** **)** |const| +:ref:`bool` **is_valid_filename**\ (\ ) |const| Returns ``true`` if this string does not contain characters that are not allowed in file names (``:`` ``/`` ``\`` ``?`` ``*`` ``"`` ``|`` ``%`` ``<`` ``>``). @@ -992,7 +992,7 @@ Returns ``true`` if this string does not contain characters that are not allowed .. rst-class:: classref-method -:ref:`bool` **is_valid_float** **(** **)** |const| +:ref:`bool` **is_valid_float**\ (\ ) |const| Returns ``true`` if this string represents a valid floating-point number. A valid float may contain only digits, one decimal point (``.``), and the exponent letter (``e``). It may also be prefixed with a positive (``+``) or negative (``-``) sign. Any valid integer is also a valid float (see :ref:`is_valid_int`). See also :ref:`to_float`. @@ -1011,7 +1011,7 @@ Returns ``true`` if this string represents a valid floating-point number. A vali .. rst-class:: classref-method -:ref:`bool` **is_valid_hex_number** **(** :ref:`bool` with_prefix=false **)** |const| +:ref:`bool` **is_valid_hex_number**\ (\ with_prefix\: :ref:`bool` = false\ ) |const| Returns ``true`` if this string is a valid hexadecimal number. A valid hexadecimal number only contains digits or letters ``A`` to ``F`` (either uppercase or lowercase), and may be prefixed with a positive (``+``) or negative (``-``) sign. @@ -1033,7 +1033,7 @@ If ``with_prefix`` is ``true``, the hexadecimal number needs to prefixed by ``"0 .. rst-class:: classref-method -:ref:`bool` **is_valid_html_color** **(** **)** |const| +:ref:`bool` **is_valid_html_color**\ (\ ) |const| Returns ``true`` if this string is a valid color in hexadecimal HTML notation. The string must be a hexadecimal value (see :ref:`is_valid_hex_number`) of either 3, 4, 6 or 8 digits, and may be prefixed by a hash sign (``#``). Other HTML notations for colors, such as names or ``hsl()``, are not considered valid. See also :ref:`Color.html`. @@ -1045,7 +1045,7 @@ Returns ``true`` if this string is a valid color in hexadecimal HTML notation. T .. rst-class:: classref-method -:ref:`bool` **is_valid_identifier** **(** **)** |const| +:ref:`bool` **is_valid_identifier**\ (\ ) |const| Returns ``true`` if this string is a valid identifier. A valid identifier may contain only letters, digits and underscores (``_``), and the first character may not be a digit. @@ -1064,7 +1064,7 @@ Returns ``true`` if this string is a valid identifier. A valid identifier may co .. rst-class:: classref-method -:ref:`bool` **is_valid_int** **(** **)** |const| +:ref:`bool` **is_valid_int**\ (\ ) |const| Returns ``true`` if this string represents a valid integer. A valid integer only contains digits, and may be prefixed with a positive (``+``) or negative (``-``) sign. See also :ref:`to_int`. @@ -1084,7 +1084,7 @@ Returns ``true`` if this string represents a valid integer. A valid integer only .. rst-class:: classref-method -:ref:`bool` **is_valid_ip_address** **(** **)** |const| +:ref:`bool` **is_valid_ip_address**\ (\ ) |const| Returns ``true`` if this string represents a well-formatted IPv4 or IPv6 address. This method considers `reserved IP addresses `__ such as ``"0.0.0.0"`` and ``"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"`` as valid. @@ -1096,7 +1096,7 @@ Returns ``true`` if this string represents a well-formatted IPv4 or IPv6 address .. rst-class:: classref-method -:ref:`String` **join** **(** :ref:`PackedStringArray` parts **)** |const| +:ref:`String` **join**\ (\ parts\: :ref:`PackedStringArray`\ ) |const| Returns the concatenation of ``parts``' elements, with each element separated by the string calling this method. This method is the opposite of :ref:`split`. @@ -1130,7 +1130,7 @@ Returns the concatenation of ``parts``' elements, with each element separated by .. rst-class:: classref-method -:ref:`String` **json_escape** **(** **)** |const| +:ref:`String` **json_escape**\ (\ ) |const| Returns a copy of the string with special characters escaped using the JSON standard. Because it closely matches the C standard, it is possible to use :ref:`c_unescape` to unescape the string, if necessary. @@ -1142,7 +1142,7 @@ Returns a copy of the string with special characters escaped using the JSON stan .. rst-class:: classref-method -:ref:`String` **left** **(** :ref:`int` length **)** |const| +:ref:`String` **left**\ (\ length\: :ref:`int`\ ) |const| Returns the first ``length`` characters from the beginning of the string. If ``length`` is negative, strips the last ``length`` characters from the string's end. @@ -1159,7 +1159,7 @@ Returns the first ``length`` characters from the beginning of the string. If ``l .. rst-class:: classref-method -:ref:`int` **length** **(** **)** |const| +:ref:`int` **length**\ (\ ) |const| Returns the number of characters in the string. Empty strings (``""``) always return ``0``. See also :ref:`is_empty`. @@ -1171,7 +1171,7 @@ Returns the number of characters in the string. Empty strings (``""``) always re .. rst-class:: classref-method -:ref:`String` **lpad** **(** :ref:`int` min_length, :ref:`String` character=" " **)** |const| +:ref:`String` **lpad**\ (\ min_length\: :ref:`int`, character\: :ref:`String` = " "\ ) |const| Formats the string to be at least ``min_length`` long by adding ``character``\ s to the left of the string, if necessary. See also :ref:`rpad`. @@ -1183,7 +1183,7 @@ Formats the string to be at least ``min_length`` long by adding ``character``\ s .. rst-class:: classref-method -:ref:`String` **lstrip** **(** :ref:`String` chars **)** |const| +:ref:`String` **lstrip**\ (\ chars\: :ref:`String`\ ) |const| Removes a set of characters defined in ``chars`` from the string's beginning. See also :ref:`rstrip`. @@ -1197,7 +1197,7 @@ Removes a set of characters defined in ``chars`` from the string's beginning. Se .. rst-class:: classref-method -:ref:`bool` **match** **(** :ref:`String` expr **)** |const| +:ref:`bool` **match**\ (\ expr\: :ref:`String`\ ) |const| Does a simple expression match (also called "glob" or "globbing"), where ``*`` matches zero or more arbitrary characters and ``?`` matches any single character except a period (``.``). An empty string or empty expression always evaluates to ``false``. @@ -1209,7 +1209,7 @@ Does a simple expression match (also called "glob" or "globbing"), where ``*`` m .. rst-class:: classref-method -:ref:`bool` **matchn** **(** :ref:`String` expr **)** |const| +:ref:`bool` **matchn**\ (\ expr\: :ref:`String`\ ) |const| Does a simple **case-insensitive** expression match, where ``*`` matches zero or more arbitrary characters and ``?`` matches any single character except a period (``.``). An empty string or empty expression always evaluates to ``false``. @@ -1221,7 +1221,7 @@ Does a simple **case-insensitive** expression match, where ``*`` matches zero or .. rst-class:: classref-method -:ref:`PackedByteArray` **md5_buffer** **(** **)** |const| +:ref:`PackedByteArray` **md5_buffer**\ (\ ) |const| Returns the `MD5 hash `__ of the string as a :ref:`PackedByteArray`. @@ -1233,7 +1233,7 @@ Returns the `MD5 hash `__ of the string as a .. rst-class:: classref-method -:ref:`String` **md5_text** **(** **)** |const| +:ref:`String` **md5_text**\ (\ ) |const| Returns the `MD5 hash `__ of the string as another **String**. @@ -1245,7 +1245,7 @@ Returns the `MD5 hash `__ of the string as an .. rst-class:: classref-method -:ref:`int` **naturalcasecmp_to** **(** :ref:`String` to **)** |const| +:ref:`int` **naturalcasecmp_to**\ (\ to\: :ref:`String`\ ) |const| Performs a **case-sensitive**, *natural order* comparison to another string. Returns ``-1`` if less than, ``1`` if greater than, or ``0`` if equal. "Less than" or "greater than" are determined by the `Unicode code points `__ of each string, which roughly matches the alphabetical order. @@ -1263,7 +1263,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`int` **naturalnocasecmp_to** **(** :ref:`String` to **)** |const| +:ref:`int` **naturalnocasecmp_to**\ (\ to\: :ref:`String`\ ) |const| Performs a **case-insensitive**, *natural order* comparison to another string. Returns ``-1`` if less than, ``1`` if greater than, or ``0`` if equal. "Less than" or "greater than" are determined by the `Unicode code points `__ of each string, which roughly matches the alphabetical order. Internally, lowercase characters are converted to uppercase for the comparison. @@ -1281,7 +1281,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`int` **nocasecmp_to** **(** :ref:`String` to **)** |const| +:ref:`int` **nocasecmp_to**\ (\ to\: :ref:`String`\ ) |const| Performs a **case-insensitive** comparison to another string. Returns ``-1`` if less than, ``1`` if greater than, or ``0`` if equal. "Less than" or "greater than" are determined by the `Unicode code points `__ of each string, which roughly matches the alphabetical order. Internally, lowercase characters are converted to uppercase for the comparison. @@ -1297,7 +1297,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`String` **num** **(** :ref:`float` number, :ref:`int` decimals=-1 **)** |static| +:ref:`String` **num**\ (\ number\: :ref:`float`, decimals\: :ref:`int` = -1\ ) |static| Converts a :ref:`float` to a string representation of a decimal number, with the number of decimal places specified in ``decimals``. @@ -1329,7 +1329,7 @@ Trailing zeros are not included in the string. The last digit is rounded, not tr .. rst-class:: classref-method -:ref:`String` **num_int64** **(** :ref:`int` number, :ref:`int` base=10, :ref:`bool` capitalize_hex=false **)** |static| +:ref:`String` **num_int64**\ (\ number\: :ref:`int`, base\: :ref:`int` = 10, capitalize_hex\: :ref:`bool` = false\ ) |static| Converts the given ``number`` to a string representation, with the given ``base``. @@ -1345,7 +1345,7 @@ If ``capitalize_hex`` is ``true``, digits higher than 9 are represented in upper .. rst-class:: classref-method -:ref:`String` **num_scientific** **(** :ref:`float` number **)** |static| +:ref:`String` **num_scientific**\ (\ number\: :ref:`float`\ ) |static| Converts the given ``number`` to a string representation, in scientific notation. @@ -1378,7 +1378,7 @@ Converts the given ``number`` to a string representation, in scientific notation .. rst-class:: classref-method -:ref:`String` **num_uint64** **(** :ref:`int` number, :ref:`int` base=10, :ref:`bool` capitalize_hex=false **)** |static| +:ref:`String` **num_uint64**\ (\ number\: :ref:`int`, base\: :ref:`int` = 10, capitalize_hex\: :ref:`bool` = false\ ) |static| Converts the given unsigned :ref:`int` to a string representation, with the given ``base``. @@ -1394,7 +1394,7 @@ If ``capitalize_hex`` is ``true``, digits higher than 9 are represented in upper .. rst-class:: classref-method -:ref:`String` **pad_decimals** **(** :ref:`int` digits **)** |const| +:ref:`String` **pad_decimals**\ (\ digits\: :ref:`int`\ ) |const| Formats the string representing a number to have an exact number of ``digits`` *after* the decimal point. @@ -1406,7 +1406,7 @@ Formats the string representing a number to have an exact number of ``digits`` * .. rst-class:: classref-method -:ref:`String` **pad_zeros** **(** :ref:`int` digits **)** |const| +:ref:`String` **pad_zeros**\ (\ digits\: :ref:`int`\ ) |const| Formats the string representing a number to have an exact number of ``digits`` *before* the decimal point. @@ -1418,7 +1418,7 @@ Formats the string representing a number to have an exact number of ``digits`` * .. rst-class:: classref-method -:ref:`String` **path_join** **(** :ref:`String` file **)** |const| +:ref:`String` **path_join**\ (\ file\: :ref:`String`\ ) |const| Concatenates ``file`` at the end of the string as a subpath, adding ``/`` if necessary. @@ -1432,7 +1432,7 @@ Concatenates ``file`` at the end of the string as a subpath, adding ``/`` if nec .. rst-class:: classref-method -:ref:`String` **repeat** **(** :ref:`int` count **)** |const| +:ref:`String` **repeat**\ (\ count\: :ref:`int`\ ) |const| Repeats this string a number of times. ``count`` needs to be greater than ``0``. Otherwise, returns an empty string. @@ -1444,7 +1444,7 @@ Repeats this string a number of times. ``count`` needs to be greater than ``0``. .. rst-class:: classref-method -:ref:`String` **replace** **(** :ref:`String` what, :ref:`String` forwhat **)** |const| +:ref:`String` **replace**\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| Replaces all occurrences of ``what`` inside the string with the given ``forwhat``. @@ -1456,7 +1456,7 @@ Replaces all occurrences of ``what`` inside the string with the given ``forwhat` .. rst-class:: classref-method -:ref:`String` **replacen** **(** :ref:`String` what, :ref:`String` forwhat **)** |const| +:ref:`String` **replacen**\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| Replaces all **case-insensitive** occurrences of ``what`` inside the string with the given ``forwhat``. @@ -1468,7 +1468,7 @@ Replaces all **case-insensitive** occurrences of ``what`` inside the string with .. rst-class:: classref-method -:ref:`String` **reverse** **(** **)** |const| +:ref:`String` **reverse**\ (\ ) |const| Returns the copy of this string in reverse order. @@ -1480,7 +1480,7 @@ Returns the copy of this string in reverse order. .. rst-class:: classref-method -:ref:`int` **rfind** **(** :ref:`String` what, :ref:`int` from=-1 **)** |const| +:ref:`int` **rfind**\ (\ what\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| Returns the index of the **last** occurrence of ``what`` in this string, or ``-1`` if there are none. The search's start can be specified with ``from``, continuing to the beginning of the string. This method is the reverse of :ref:`find`. @@ -1492,7 +1492,7 @@ Returns the index of the **last** occurrence of ``what`` in this string, or ``-1 .. rst-class:: classref-method -:ref:`int` **rfindn** **(** :ref:`String` what, :ref:`int` from=-1 **)** |const| +:ref:`int` **rfindn**\ (\ what\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| Returns the index of the **last** **case-insensitive** occurrence of ``what`` in this string, or ``-1`` if there are none. The starting search index can be specified with ``from``, continuing to the beginning of the string. This method is the reverse of :ref:`findn`. @@ -1504,7 +1504,7 @@ Returns the index of the **last** **case-insensitive** occurrence of ``what`` in .. rst-class:: classref-method -:ref:`String` **right** **(** :ref:`int` length **)** |const| +:ref:`String` **right**\ (\ length\: :ref:`int`\ ) |const| Returns the last ``length`` characters from the end of the string. If ``length`` is negative, strips the first ``length`` characters from the string's beginning. @@ -1521,7 +1521,7 @@ Returns the last ``length`` characters from the end of the string. If ``length`` .. rst-class:: classref-method -:ref:`String` **rpad** **(** :ref:`int` min_length, :ref:`String` character=" " **)** |const| +:ref:`String` **rpad**\ (\ min_length\: :ref:`int`, character\: :ref:`String` = " "\ ) |const| Formats the string to be at least ``min_length`` long, by adding ``character``\ s to the right of the string, if necessary. See also :ref:`lpad`. @@ -1533,7 +1533,7 @@ Formats the string to be at least ``min_length`` long, by adding ``character``\ .. rst-class:: classref-method -:ref:`PackedStringArray` **rsplit** **(** :ref:`String` delimiter="", :ref:`bool` allow_empty=true, :ref:`int` maxsplit=0 **)** |const| +:ref:`PackedStringArray` **rsplit**\ (\ delimiter\: :ref:`String` = "", allow_empty\: :ref:`bool` = true, maxsplit\: :ref:`int` = 0\ ) |const| Splits the string using a ``delimiter`` and returns an array of the substrings, starting from the end of the string. The splits in the returned array appear in the same order as the original string. If ``delimiter`` is an empty string, each substring will be a single character. @@ -1569,7 +1569,7 @@ If ``maxsplit`` is greater than ``0``, the number of splits may not exceed ``max .. rst-class:: classref-method -:ref:`String` **rstrip** **(** :ref:`String` chars **)** |const| +:ref:`String` **rstrip**\ (\ chars\: :ref:`String`\ ) |const| Removes a set of characters defined in ``chars`` from the string's end. See also :ref:`lstrip`. @@ -1583,7 +1583,7 @@ Removes a set of characters defined in ``chars`` from the string's end. See also .. rst-class:: classref-method -:ref:`PackedByteArray` **sha1_buffer** **(** **)** |const| +:ref:`PackedByteArray` **sha1_buffer**\ (\ ) |const| Returns the `SHA-1 `__ hash of the string as a :ref:`PackedByteArray`. @@ -1595,7 +1595,7 @@ Returns the `SHA-1 `__ hash of the string a .. rst-class:: classref-method -:ref:`String` **sha1_text** **(** **)** |const| +:ref:`String` **sha1_text**\ (\ ) |const| Returns the `SHA-1 `__ hash of the string as another **String**. @@ -1607,7 +1607,7 @@ Returns the `SHA-1 `__ hash of the string a .. rst-class:: classref-method -:ref:`PackedByteArray` **sha256_buffer** **(** **)** |const| +:ref:`PackedByteArray` **sha256_buffer**\ (\ ) |const| Returns the `SHA-256 `__ hash of the string as a :ref:`PackedByteArray`. @@ -1619,7 +1619,7 @@ Returns the `SHA-256 `__ hash of the string .. rst-class:: classref-method -:ref:`String` **sha256_text** **(** **)** |const| +:ref:`String` **sha256_text**\ (\ ) |const| Returns the `SHA-256 `__ hash of the string as another **String**. @@ -1631,7 +1631,7 @@ Returns the `SHA-256 `__ hash of the string .. rst-class:: classref-method -:ref:`float` **similarity** **(** :ref:`String` text **)** |const| +:ref:`float` **similarity**\ (\ text\: :ref:`String`\ ) |const| Returns the similarity index (`Sorensen-Dice coefficient `__) of this string compared to another. A result of ``1.0`` means totally similar, while ``0.0`` means totally dissimilar. @@ -1650,7 +1650,7 @@ Returns the similarity index (`Sorensen-Dice coefficient ` **simplify_path** **(** **)** |const| +:ref:`String` **simplify_path**\ (\ ) |const| If the string is a valid file path, converts the string into a canonical path. This is the shortest possible path, without ``"./"``, and all the unnecessary ``".."`` and ``"/"``. @@ -1667,7 +1667,7 @@ If the string is a valid file path, converts the string into a canonical path. T .. rst-class:: classref-method -:ref:`PackedStringArray` **split** **(** :ref:`String` delimiter="", :ref:`bool` allow_empty=true, :ref:`int` maxsplit=0 **)** |const| +:ref:`PackedStringArray` **split**\ (\ delimiter\: :ref:`String` = "", allow_empty\: :ref:`bool` = true, maxsplit\: :ref:`int` = 0\ ) |const| Splits the string using a ``delimiter`` and returns an array of the substrings. If ``delimiter`` is an empty string, each substring will be a single character. This method is the opposite of :ref:`join`. @@ -1710,7 +1710,7 @@ If ``maxsplit`` is greater than ``0``, the number of splits may not exceed ``max .. rst-class:: classref-method -:ref:`PackedFloat64Array` **split_floats** **(** :ref:`String` delimiter, :ref:`bool` allow_empty=true **)** |const| +:ref:`PackedFloat64Array` **split_floats**\ (\ delimiter\: :ref:`String`, allow_empty\: :ref:`bool` = true\ ) |const| Splits the string into floats by using a ``delimiter`` and returns a :ref:`PackedFloat64Array`. @@ -1730,7 +1730,7 @@ If ``allow_empty`` is ``false``, empty or invalid :ref:`float` conv .. rst-class:: classref-method -:ref:`String` **strip_edges** **(** :ref:`bool` left=true, :ref:`bool` right=true **)** |const| +:ref:`String` **strip_edges**\ (\ left\: :ref:`bool` = true, right\: :ref:`bool` = true\ ) |const| Strips all non-printable characters from the beginning and the end of the string. These include spaces, tabulations (``\t``), and newlines (``\n`` ``\r``). @@ -1744,7 +1744,7 @@ If ``left`` is ``false``, ignores the string's beginning. Likewise, if ``right`` .. rst-class:: classref-method -:ref:`String` **strip_escapes** **(** **)** |const| +:ref:`String` **strip_escapes**\ (\ ) |const| Strips all escape characters from the string. These include all non-printable control characters of the first page of the ASCII table (values from 0 to 31), such as tabulation (``\t``) and newline (``\n``, ``\r``) characters, but *not* spaces. @@ -1756,7 +1756,7 @@ Strips all escape characters from the string. These include all non-printable co .. rst-class:: classref-method -:ref:`String` **substr** **(** :ref:`int` from, :ref:`int` len=-1 **)** |const| +:ref:`String` **substr**\ (\ from\: :ref:`int`, len\: :ref:`int` = -1\ ) |const| Returns part of the string from the position ``from`` with length ``len``. If ``len`` is ``-1`` (as by default), returns the rest of the string starting from the given position. @@ -1768,7 +1768,7 @@ Returns part of the string from the position ``from`` with length ``len``. If `` .. rst-class:: classref-method -:ref:`PackedByteArray` **to_ascii_buffer** **(** **)** |const| +:ref:`PackedByteArray` **to_ascii_buffer**\ (\ ) |const| Converts the string to an `ASCII `__/Latin-1 encoded :ref:`PackedByteArray`. This method is slightly faster than :ref:`to_utf8_buffer`, but replaces all unsupported characters with spaces. This is the inverse of :ref:`PackedByteArray.get_string_from_ascii`. @@ -1780,7 +1780,7 @@ Converts the string to an `ASCII `__/Latin- .. rst-class:: classref-method -:ref:`String` **to_camel_case** **(** **)** |const| +:ref:`String` **to_camel_case**\ (\ ) |const| Returns the string converted to ``camelCase``. @@ -1792,7 +1792,7 @@ Returns the string converted to ``camelCase``. .. rst-class:: classref-method -:ref:`float` **to_float** **(** **)** |const| +:ref:`float` **to_float**\ (\ ) |const| Converts the string representing a decimal number into a :ref:`float`. This method stops on the first non-number character, except the first decimal point (``.``) and the exponent letter (``e``). See also :ref:`is_valid_float`. @@ -1812,7 +1812,7 @@ Converts the string representing a decimal number into a :ref:`float` **to_int** **(** **)** |const| +:ref:`int` **to_int**\ (\ ) |const| Converts the string representing an integer number into an :ref:`int`. This method removes any non-number character and stops at the first decimal point (``.``). See also :ref:`is_valid_int`. @@ -1831,7 +1831,7 @@ Converts the string representing an integer number into an :ref:`int` .. rst-class:: classref-method -:ref:`String` **to_lower** **(** **)** |const| +:ref:`String` **to_lower**\ (\ ) |const| Returns the string converted to ``lowercase``. @@ -1843,7 +1843,7 @@ Returns the string converted to ``lowercase``. .. rst-class:: classref-method -:ref:`String` **to_pascal_case** **(** **)** |const| +:ref:`String` **to_pascal_case**\ (\ ) |const| Returns the string converted to ``PascalCase``. @@ -1855,7 +1855,7 @@ Returns the string converted to ``PascalCase``. .. rst-class:: classref-method -:ref:`String` **to_snake_case** **(** **)** |const| +:ref:`String` **to_snake_case**\ (\ ) |const| Returns the string converted to ``snake_case``. @@ -1886,7 +1886,7 @@ Returns the string converted to ``snake_case``. .. rst-class:: classref-method -:ref:`String` **to_upper** **(** **)** |const| +:ref:`String` **to_upper**\ (\ ) |const| Returns the string converted to ``UPPERCASE``. @@ -1898,7 +1898,7 @@ Returns the string converted to ``UPPERCASE``. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_utf8_buffer** **(** **)** |const| +:ref:`PackedByteArray` **to_utf8_buffer**\ (\ ) |const| Converts the string to a `UTF-8 `__ encoded :ref:`PackedByteArray`. This method is slightly slower than :ref:`to_ascii_buffer`, but supports all UTF-8 characters. For most cases, prefer using this method. This is the inverse of :ref:`PackedByteArray.get_string_from_utf8`. @@ -1910,7 +1910,7 @@ Converts the string to a `UTF-8 `__ encoded .. rst-class:: classref-method -:ref:`PackedByteArray` **to_utf16_buffer** **(** **)** |const| +:ref:`PackedByteArray` **to_utf16_buffer**\ (\ ) |const| Converts the string to a `UTF-16 `__ encoded :ref:`PackedByteArray`. This is the inverse of :ref:`PackedByteArray.get_string_from_utf16`. @@ -1922,7 +1922,7 @@ Converts the string to a `UTF-16 `__ encod .. rst-class:: classref-method -:ref:`PackedByteArray` **to_utf32_buffer** **(** **)** |const| +:ref:`PackedByteArray` **to_utf32_buffer**\ (\ ) |const| Converts the string to a `UTF-32 `__ encoded :ref:`PackedByteArray`. This is the inverse of :ref:`PackedByteArray.get_string_from_utf32`. @@ -1934,7 +1934,7 @@ Converts the string to a `UTF-32 `__ encod .. rst-class:: classref-method -:ref:`PackedByteArray` **to_wchar_buffer** **(** **)** |const| +:ref:`PackedByteArray` **to_wchar_buffer**\ (\ ) |const| Converts the string to a `wide character `__ (``wchar_t``, UTF-16 on Windows, UTF-32 on other platforms) encoded :ref:`PackedByteArray`. This is the inverse of :ref:`PackedByteArray.get_string_from_wchar`. @@ -1946,7 +1946,7 @@ Converts the string to a `wide character ` **trim_prefix** **(** :ref:`String` prefix **)** |const| +:ref:`String` **trim_prefix**\ (\ prefix\: :ref:`String`\ ) |const| Removes the given ``prefix`` from the start of the string, or returns the string unchanged. @@ -1958,7 +1958,7 @@ Removes the given ``prefix`` from the start of the string, or returns the string .. rst-class:: classref-method -:ref:`String` **trim_suffix** **(** :ref:`String` suffix **)** |const| +:ref:`String` **trim_suffix**\ (\ suffix\: :ref:`String`\ ) |const| Removes the given ``suffix`` from the end of the string, or returns the string unchanged. @@ -1970,7 +1970,7 @@ Removes the given ``suffix`` from the end of the string, or returns the string u .. rst-class:: classref-method -:ref:`int` **unicode_at** **(** :ref:`int` at **)** |const| +:ref:`int` **unicode_at**\ (\ at\: :ref:`int`\ ) |const| Returns the character code at position ``at``. @@ -1982,7 +1982,7 @@ Returns the character code at position ``at``. .. rst-class:: classref-method -:ref:`String` **uri_decode** **(** **)** |const| +:ref:`String` **uri_decode**\ (\ ) |const| Decodes the string from its URL-encoded format. This method is meant to properly decode the parameters in a URL when receiving an HTTP request. See also :ref:`uri_encode`. @@ -2009,7 +2009,7 @@ Decodes the string from its URL-encoded format. This method is meant to properly .. rst-class:: classref-method -:ref:`String` **uri_encode** **(** **)** |const| +:ref:`String` **uri_encode**\ (\ ) |const| Encodes the string to URL-friendly format. This method is meant to properly encode the parameters in a URL when sending an HTTP request. See also :ref:`uri_decode`. @@ -2040,7 +2040,7 @@ Encodes the string to URL-friendly format. This method is meant to properly enco .. rst-class:: classref-method -:ref:`String` **validate_filename** **(** **)** |const| +:ref:`String` **validate_filename**\ (\ ) |const| Returns a copy of the string with all characters that are not allowed in :ref:`is_valid_filename` replaced with underscores. @@ -2052,7 +2052,7 @@ Returns a copy of the string with all characters that are not allowed in :ref:`i .. rst-class:: classref-method -:ref:`String` **validate_node_name** **(** **)** |const| +:ref:`String` **validate_node_name**\ (\ ) |const| Returns a copy of the string with all characters that are not allowed in :ref:`Node.name` (``.`` ``:`` ``@`` ``/`` ``"`` ``%``) replaced with underscores. @@ -2064,7 +2064,7 @@ Returns a copy of the string with all characters that are not allowed in :ref:`N .. rst-class:: classref-method -:ref:`String` **xml_escape** **(** :ref:`bool` escape_quotes=false **)** |const| +:ref:`String` **xml_escape**\ (\ escape_quotes\: :ref:`bool` = false\ ) |const| Returns a copy of the string with special characters escaped using the XML standard. If ``escape_quotes`` is ``true``, the single quote (``'``) and double quote (``"``) characters are also escaped. @@ -2076,7 +2076,7 @@ Returns a copy of the string with special characters escaped using the XML stand .. rst-class:: classref-method -:ref:`String` **xml_unescape** **(** **)** |const| +:ref:`String` **xml_unescape**\ (\ ) |const| Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard. @@ -2093,7 +2093,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`String` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`String`\ ) Returns ``true`` if both strings do not contain the same sequence of characters. @@ -2105,7 +2105,7 @@ Returns ``true`` if both strings do not contain the same sequence of characters. .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`StringName` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`StringName`\ ) Returns ``true`` if this **String** is not equivalent to the given :ref:`StringName`. @@ -2117,7 +2117,7 @@ Returns ``true`` if this **String** is not equivalent to the given :ref:`StringN .. rst-class:: classref-operator -:ref:`String` **operator %** **(** :ref:`Variant` right **)** +:ref:`String` **operator %**\ (\ right\: :ref:`Variant`\ ) Formats the **String**, replacing the placeholders with one or more parameters. To pass multiple parameters, ``right`` needs to be an :ref:`Array`. @@ -2142,7 +2142,7 @@ For more information, see the :doc:`GDScript format strings <../tutorials/script .. rst-class:: classref-operator -:ref:`String` **operator +** **(** :ref:`String` right **)** +:ref:`String` **operator +**\ (\ right\: :ref:`String`\ ) Appends ``right`` at the end of this **String**, also known as a string concatenation. @@ -2154,7 +2154,7 @@ Appends ``right`` at the end of this **String**, also known as a string concaten .. rst-class:: classref-operator -:ref:`String` **operator +** **(** :ref:`StringName` right **)** +:ref:`String` **operator +**\ (\ right\: :ref:`StringName`\ ) Appends ``right`` at the end of this **String**, returning a **String**. This is also known as a string concatenation. @@ -2166,7 +2166,7 @@ Appends ``right`` at the end of this **String**, returning a **String**. This is .. rst-class:: classref-operator -:ref:`bool` **operator <** **(** :ref:`String` right **)** +:ref:`bool` **operator <**\ (\ right\: :ref:`String`\ ) Returns ``true`` if the left **String** comes before ``right`` in `Unicode order `__, which roughly matches the alphabetical order. Useful for sorting. @@ -2178,7 +2178,7 @@ Returns ``true`` if the left **String** comes before ``right`` in `Unicode order .. rst-class:: classref-operator -:ref:`bool` **operator <=** **(** :ref:`String` right **)** +:ref:`bool` **operator <=**\ (\ right\: :ref:`String`\ ) Returns ``true`` if the left **String** comes before ``right`` in `Unicode order `__, which roughly matches the alphabetical order, or if both are equal. @@ -2190,7 +2190,7 @@ Returns ``true`` if the left **String** comes before ``right`` in `Unicode order .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`String` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`String`\ ) Returns ``true`` if both strings contain the same sequence of characters. @@ -2202,7 +2202,7 @@ Returns ``true`` if both strings contain the same sequence of characters. .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`StringName` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`StringName`\ ) Returns ``true`` if this **String** is equivalent to the given :ref:`StringName`. @@ -2214,7 +2214,7 @@ Returns ``true`` if this **String** is equivalent to the given :ref:`StringName< .. rst-class:: classref-operator -:ref:`bool` **operator >** **(** :ref:`String` right **)** +:ref:`bool` **operator >**\ (\ right\: :ref:`String`\ ) Returns ``true`` if the left **String** comes after ``right`` in `Unicode order `__, which roughly matches the alphabetical order. Useful for sorting. @@ -2226,7 +2226,7 @@ Returns ``true`` if the left **String** comes after ``right`` in `Unicode order .. rst-class:: classref-operator -:ref:`bool` **operator >=** **(** :ref:`String` right **)** +:ref:`bool` **operator >=**\ (\ right\: :ref:`String`\ ) Returns ``true`` if the left **String** comes after ``right`` in `Unicode order `__, which roughly matches the alphabetical order, or if both are equal. @@ -2238,7 +2238,7 @@ Returns ``true`` if the left **String** comes after ``right`` in `Unicode order .. rst-class:: classref-operator -:ref:`String` **operator []** **(** :ref:`int` index **)** +:ref:`String` **operator []**\ (\ index\: :ref:`int`\ ) Returns a new **String** that only contains the character at ``index``. Indices start from ``0``. If ``index`` is greater or equal to ``0``, the character is fetched starting from the beginning of the string. If ``index`` is a negative value, it is fetched starting from the end. Accessing a string out-of-bounds will cause a run-time error, pausing the project execution if run from the editor. @@ -2249,3 +2249,4 @@ Returns a new **String** that only contains the character at ``index``. Indices .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_stringname.rst b/classes/class_stringname.rst index 9ec5c496d20..013beae3326 100644 --- a/classes/class_stringname.rst +++ b/classes/class_stringname.rst @@ -41,13 +41,13 @@ Constructors .. table:: :widths: auto - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`StringName` **(** **)** | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`StringName` **(** :ref:`StringName` from **)** | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`StringName` **(** :ref:`String` from **)** | - +-------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`StringName`\ (\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`StringName`\ (\ from\: :ref:`StringName`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`StringName`\ (\ from\: :ref:`String`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -57,203 +57,203 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`begins_with` **(** :ref:`String` text **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`bigrams` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`bin_to_int` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`c_escape` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`c_unescape` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`capitalize` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`casecmp_to` **(** :ref:`String` to **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`contains` **(** :ref:`String` what **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`count` **(** :ref:`String` what, :ref:`int` from=0, :ref:`int` to=0 **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`countn` **(** :ref:`String` what, :ref:`int` from=0, :ref:`int` to=0 **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`dedent` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`ends_with` **(** :ref:`String` text **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`erase` **(** :ref:`int` position, :ref:`int` chars=1 **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`find` **(** :ref:`String` what, :ref:`int` from=0 **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`findn` **(** :ref:`String` what, :ref:`int` from=0 **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`format` **(** :ref:`Variant` values, :ref:`String` placeholder="{_}" **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_base_dir` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_basename` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_extension` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_file` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_slice` **(** :ref:`String` delimiter, :ref:`int` slice **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_slice_count` **(** :ref:`String` delimiter **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_slicec` **(** :ref:`int` delimiter, :ref:`int` slice **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`hash` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`hex_decode` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`hex_to_int` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`indent` **(** :ref:`String` prefix **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`insert` **(** :ref:`int` position, :ref:`String` what **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_absolute_path` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_relative_path` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_subsequence_of` **(** :ref:`String` text **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_subsequence_ofn` **(** :ref:`String` text **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_filename` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_float` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_hex_number` **(** :ref:`bool` with_prefix=false **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_html_color` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_identifier` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_int` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_ip_address` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`join` **(** :ref:`PackedStringArray` parts **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`json_escape` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`left` **(** :ref:`int` length **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`length` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`lpad` **(** :ref:`int` min_length, :ref:`String` character=" " **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`lstrip` **(** :ref:`String` chars **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`match` **(** :ref:`String` expr **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`matchn` **(** :ref:`String` expr **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`md5_buffer` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`md5_text` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`naturalcasecmp_to` **(** :ref:`String` to **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`naturalnocasecmp_to` **(** :ref:`String` to **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`nocasecmp_to` **(** :ref:`String` to **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`pad_decimals` **(** :ref:`int` digits **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`pad_zeros` **(** :ref:`int` digits **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`path_join` **(** :ref:`String` file **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`repeat` **(** :ref:`int` count **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`replace` **(** :ref:`String` what, :ref:`String` forwhat **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`replacen` **(** :ref:`String` what, :ref:`String` forwhat **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`reverse` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfind` **(** :ref:`String` what, :ref:`int` from=-1 **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rfindn` **(** :ref:`String` what, :ref:`int` from=-1 **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`right` **(** :ref:`int` length **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rpad` **(** :ref:`int` min_length, :ref:`String` character=" " **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`rsplit` **(** :ref:`String` delimiter="", :ref:`bool` allow_empty=true, :ref:`int` maxsplit=0 **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rstrip` **(** :ref:`String` chars **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`sha1_buffer` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`sha1_text` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`sha256_buffer` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`sha256_text` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`similarity` **(** :ref:`String` text **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`simplify_path` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`split` **(** :ref:`String` delimiter="", :ref:`bool` allow_empty=true, :ref:`int` maxsplit=0 **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat64Array` | :ref:`split_floats` **(** :ref:`String` delimiter, :ref:`bool` allow_empty=true **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`strip_edges` **(** :ref:`bool` left=true, :ref:`bool` right=true **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`strip_escapes` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`substr` **(** :ref:`int` from, :ref:`int` len=-1 **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_ascii_buffer` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`to_camel_case` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`to_float` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`to_int` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`to_lower` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`to_pascal_case` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`to_snake_case` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`to_upper` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_utf8_buffer` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_utf16_buffer` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_utf32_buffer` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`to_wchar_buffer` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`trim_prefix` **(** :ref:`String` prefix **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`trim_suffix` **(** :ref:`String` suffix **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`unicode_at` **(** :ref:`int` at **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`uri_decode` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`uri_encode` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`validate_filename` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`validate_node_name` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`xml_escape` **(** :ref:`bool` escape_quotes=false **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`xml_unescape` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`begins_with`\ (\ text\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`bigrams`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`bin_to_int`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`c_escape`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`c_unescape`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`capitalize`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`casecmp_to`\ (\ to\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`contains`\ (\ what\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`count`\ (\ what\: :ref:`String`, from\: :ref:`int` = 0, to\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`countn`\ (\ what\: :ref:`String`, from\: :ref:`int` = 0, to\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`dedent`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`ends_with`\ (\ text\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`erase`\ (\ position\: :ref:`int`, chars\: :ref:`int` = 1\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`find`\ (\ what\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`findn`\ (\ what\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`format`\ (\ values\: :ref:`Variant`, placeholder\: :ref:`String` = "{_}"\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_base_dir`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_basename`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_extension`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_file`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_slice`\ (\ delimiter\: :ref:`String`, slice\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_slice_count`\ (\ delimiter\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_slicec`\ (\ delimiter\: :ref:`int`, slice\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`hash`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`hex_decode`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`hex_to_int`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`indent`\ (\ prefix\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`insert`\ (\ position\: :ref:`int`, what\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_absolute_path`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_relative_path`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_subsequence_of`\ (\ text\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_subsequence_ofn`\ (\ text\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_filename`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_float`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_hex_number`\ (\ with_prefix\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_html_color`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_identifier`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_int`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_ip_address`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`join`\ (\ parts\: :ref:`PackedStringArray`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`json_escape`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`left`\ (\ length\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`length`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`lpad`\ (\ min_length\: :ref:`int`, character\: :ref:`String` = " "\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`lstrip`\ (\ chars\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`match`\ (\ expr\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`matchn`\ (\ expr\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`md5_buffer`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`md5_text`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`naturalcasecmp_to`\ (\ to\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`naturalnocasecmp_to`\ (\ to\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`nocasecmp_to`\ (\ to\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`pad_decimals`\ (\ digits\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`pad_zeros`\ (\ digits\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`path_join`\ (\ file\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`repeat`\ (\ count\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`replace`\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`replacen`\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`reverse`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfind`\ (\ what\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rfindn`\ (\ what\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`right`\ (\ length\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`rpad`\ (\ min_length\: :ref:`int`, character\: :ref:`String` = " "\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`rsplit`\ (\ delimiter\: :ref:`String` = "", allow_empty\: :ref:`bool` = true, maxsplit\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`rstrip`\ (\ chars\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`sha1_buffer`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`sha1_text`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`sha256_buffer`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`sha256_text`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`similarity`\ (\ text\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`simplify_path`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`split`\ (\ delimiter\: :ref:`String` = "", allow_empty\: :ref:`bool` = true, maxsplit\: :ref:`int` = 0\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat64Array` | :ref:`split_floats`\ (\ delimiter\: :ref:`String`, allow_empty\: :ref:`bool` = true\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`strip_edges`\ (\ left\: :ref:`bool` = true, right\: :ref:`bool` = true\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`strip_escapes`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`substr`\ (\ from\: :ref:`int`, len\: :ref:`int` = -1\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_ascii_buffer`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`to_camel_case`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`to_float`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`to_int`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`to_lower`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`to_pascal_case`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`to_snake_case`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`to_upper`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_utf8_buffer`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_utf16_buffer`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_utf32_buffer`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_wchar_buffer`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`trim_prefix`\ (\ prefix\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`trim_suffix`\ (\ suffix\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`unicode_at`\ (\ at\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`uri_decode`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`uri_encode`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`validate_filename`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`validate_node_name`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`xml_escape`\ (\ escape_quotes\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`xml_unescape`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -263,29 +263,29 @@ Operators .. table:: :widths: auto - +-----------------------------+---------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`String` right **)** | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`StringName` right **)** | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`operator %` **(** :ref:`Variant` right **)** | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`operator +` **(** :ref:`String` right **)** | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`operator +` **(** :ref:`StringName` right **)** | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<` **(** :ref:`StringName` right **)** | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<=` **(** :ref:`StringName` right **)** | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`String` right **)** | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`StringName` right **)** | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >` **(** :ref:`StringName` right **)** | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >=` **(** :ref:`StringName` right **)** | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------+ + +-----------------------------+------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`String`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`StringName`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`operator %`\ (\ right\: :ref:`Variant`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`operator +`\ (\ right\: :ref:`String`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`operator +`\ (\ right\: :ref:`StringName`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<`\ (\ right\: :ref:`StringName`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<=`\ (\ right\: :ref:`StringName`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`String`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`StringName`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >`\ (\ right\: :ref:`StringName`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >=`\ (\ right\: :ref:`StringName`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -300,7 +300,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`StringName` **StringName** **(** **)** +:ref:`StringName` **StringName**\ (\ ) Constructs an empty **StringName**. @@ -310,7 +310,7 @@ Constructs an empty **StringName**. .. rst-class:: classref-constructor -:ref:`StringName` **StringName** **(** :ref:`StringName` from **)** +:ref:`StringName` **StringName**\ (\ from\: :ref:`StringName`\ ) Constructs a **StringName** as a copy of the given **StringName**. @@ -320,7 +320,7 @@ Constructs a **StringName** as a copy of the given **StringName**. .. rst-class:: classref-constructor -:ref:`StringName` **StringName** **(** :ref:`String` from **)** +:ref:`StringName` **StringName**\ (\ from\: :ref:`String`\ ) Creates a new **StringName** from the given :ref:`String`. In GDScript, ``StringName("example")`` is equivalent to ``&"example"``. @@ -337,7 +337,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **begins_with** **(** :ref:`String` text **)** |const| +:ref:`bool` **begins_with**\ (\ text\: :ref:`String`\ ) |const| Returns ``true`` if the string begins with the given ``text``. See also :ref:`ends_with`. @@ -349,7 +349,7 @@ Returns ``true`` if the string begins with the given ``text``. See also :ref:`en .. rst-class:: classref-method -:ref:`PackedStringArray` **bigrams** **(** **)** |const| +:ref:`PackedStringArray` **bigrams**\ (\ ) |const| Returns an array containing the bigrams (pairs of consecutive characters) of this string. @@ -365,7 +365,7 @@ Returns an array containing the bigrams (pairs of consecutive characters) of thi .. rst-class:: classref-method -:ref:`int` **bin_to_int** **(** **)** |const| +:ref:`int` **bin_to_int**\ (\ ) |const| Converts the string representing a binary number into an :ref:`int`. The string may optionally be prefixed with ``"0b"``, and an additional ``-`` prefix for negative numbers. @@ -394,7 +394,7 @@ Converts the string representing a binary number into an :ref:`int`. .. rst-class:: classref-method -:ref:`String` **c_escape** **(** **)** |const| +:ref:`String` **c_escape**\ (\ ) |const| Returns a copy of the string with special characters escaped using the C language standard. @@ -406,7 +406,7 @@ Returns a copy of the string with special characters escaped using the C languag .. rst-class:: classref-method -:ref:`String` **c_unescape** **(** **)** |const| +:ref:`String` **c_unescape**\ (\ ) |const| Returns a copy of the string with escaped characters replaced by their meanings. Supported escape sequences are ``\'``, ``\"``, ``\\``, ``\a``, ``\b``, ``\f``, ``\n``, ``\r``, ``\t``, ``\v``. @@ -420,7 +420,7 @@ Returns a copy of the string with escaped characters replaced by their meanings. .. rst-class:: classref-method -:ref:`String` **capitalize** **(** **)** |const| +:ref:`String` **capitalize**\ (\ ) |const| Changes the appearance of the string: replaces underscores (``_``) with spaces, adds spaces before uppercase letters in the middle of a word, converts all letters to lowercase, then converts the first one and each one following a space to uppercase. @@ -449,7 +449,7 @@ Changes the appearance of the string: replaces underscores (``_``) with spaces, .. rst-class:: classref-method -:ref:`int` **casecmp_to** **(** :ref:`String` to **)** |const| +:ref:`int` **casecmp_to**\ (\ to\: :ref:`String`\ ) |const| Performs a case-sensitive comparison to another string. Returns ``-1`` if less than, ``1`` if greater than, or ``0`` if equal. "Less than" and "greater than" are determined by the `Unicode code points `__ of each string, which roughly matches the alphabetical order. @@ -465,7 +465,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`bool` **contains** **(** :ref:`String` what **)** |const| +:ref:`bool` **contains**\ (\ what\: :ref:`String`\ ) |const| Returns ``true`` if the string contains ``what``. In GDScript, this corresponds to the ``in`` operator. @@ -495,7 +495,7 @@ If you need to know where ``what`` is within the string, use :ref:`find` **count** **(** :ref:`String` what, :ref:`int` from=0, :ref:`int` to=0 **)** |const| +:ref:`int` **count**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0, to\: :ref:`int` = 0\ ) |const| Returns the number of occurrences of the substring ``what`` between ``from`` and ``to`` positions. If ``to`` is 0, the search continues until the end of the string. @@ -507,7 +507,7 @@ Returns the number of occurrences of the substring ``what`` between ``from`` and .. rst-class:: classref-method -:ref:`int` **countn** **(** :ref:`String` what, :ref:`int` from=0, :ref:`int` to=0 **)** |const| +:ref:`int` **countn**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0, to\: :ref:`int` = 0\ ) |const| Returns the number of occurrences of the substring ``what`` between ``from`` and ``to`` positions, **ignoring case**. If ``to`` is 0, the search continues until the end of the string. @@ -519,7 +519,7 @@ Returns the number of occurrences of the substring ``what`` between ``from`` and .. rst-class:: classref-method -:ref:`String` **dedent** **(** **)** |const| +:ref:`String` **dedent**\ (\ ) |const| Returns a copy of the string with indentation (leading tabs and spaces) removed. See also :ref:`indent` to add indentation. @@ -531,7 +531,7 @@ Returns a copy of the string with indentation (leading tabs and spaces) removed. .. rst-class:: classref-method -:ref:`bool` **ends_with** **(** :ref:`String` text **)** |const| +:ref:`bool` **ends_with**\ (\ text\: :ref:`String`\ ) |const| Returns ``true`` if the string ends with the given ``text``. See also :ref:`begins_with`. @@ -543,7 +543,7 @@ Returns ``true`` if the string ends with the given ``text``. See also :ref:`begi .. rst-class:: classref-method -:ref:`String` **erase** **(** :ref:`int` position, :ref:`int` chars=1 **)** |const| +:ref:`String` **erase**\ (\ position\: :ref:`int`, chars\: :ref:`int` = 1\ ) |const| Returns a string with ``chars`` characters erased starting from ``position``. If ``chars`` goes beyond the string's length given the specified ``position``, fewer characters will be erased from the returned string. Returns an empty string if either ``position`` or ``chars`` is negative. Returns the original string unmodified if ``chars`` is ``0``. @@ -555,7 +555,7 @@ Returns a string with ``chars`` characters erased starting from ``position``. If .. rst-class:: classref-method -:ref:`int` **find** **(** :ref:`String` what, :ref:`int` from=0 **)** |const| +:ref:`int` **find**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| Returns the index of the **first** occurrence of ``what`` in this string, or ``-1`` if there are none. The search's start can be specified with ``from``, continuing to the end of the string. @@ -590,7 +590,7 @@ Returns the index of the **first** occurrence of ``what`` in this string, or ``- .. rst-class:: classref-method -:ref:`int` **findn** **(** :ref:`String` what, :ref:`int` from=0 **)** |const| +:ref:`int` **findn**\ (\ what\: :ref:`String`, from\: :ref:`int` = 0\ ) |const| Returns the index of the **first** **case-insensitive** occurrence of ``what`` in this string, or ``-1`` if there are none. The starting search index can be specified with ``from``, continuing to the end of the string. @@ -602,7 +602,7 @@ Returns the index of the **first** **case-insensitive** occurrence of ``what`` i .. rst-class:: classref-method -:ref:`String` **format** **(** :ref:`Variant` values, :ref:`String` placeholder="{_}" **)** |const| +:ref:`String` **format**\ (\ values\: :ref:`Variant`, placeholder\: :ref:`String` = "{_}"\ ) |const| Formats the string by replacing all occurrences of ``placeholder`` with the elements of ``values``. @@ -637,7 +637,7 @@ See also the :doc:`GDScript format string <../tutorials/scripting/gdscript/gdscr .. rst-class:: classref-method -:ref:`String` **get_base_dir** **(** **)** |const| +:ref:`String` **get_base_dir**\ (\ ) |const| If the string is a valid file path, returns the base directory name. @@ -653,7 +653,7 @@ If the string is a valid file path, returns the base directory name. .. rst-class:: classref-method -:ref:`String` **get_basename** **(** **)** |const| +:ref:`String` **get_basename**\ (\ ) |const| If the string is a valid file path, returns the full file path, without the extension. @@ -669,7 +669,7 @@ If the string is a valid file path, returns the full file path, without the exte .. rst-class:: classref-method -:ref:`String` **get_extension** **(** **)** |const| +:ref:`String` **get_extension**\ (\ ) |const| If the string is a valid file name or path, returns the file extension without the leading period (``.``). Otherwise, returns an empty string. @@ -693,7 +693,7 @@ If the string is a valid file name or path, returns the file extension without t .. rst-class:: classref-method -:ref:`String` **get_file** **(** **)** |const| +:ref:`String` **get_file**\ (\ ) |const| If the string is a valid file path, returns the file name, including the extension. @@ -709,7 +709,7 @@ If the string is a valid file path, returns the file name, including the extensi .. rst-class:: classref-method -:ref:`String` **get_slice** **(** :ref:`String` delimiter, :ref:`int` slice **)** |const| +:ref:`String` **get_slice**\ (\ delimiter\: :ref:`String`, slice\: :ref:`int`\ ) |const| Splits the string using a ``delimiter`` and returns the substring at index ``slice``. Returns an empty string if the ``slice`` does not exist. @@ -729,7 +729,7 @@ This is faster than :ref:`split`, if you only nee .. rst-class:: classref-method -:ref:`int` **get_slice_count** **(** :ref:`String` delimiter **)** |const| +:ref:`int` **get_slice_count**\ (\ delimiter\: :ref:`String`\ ) |const| Returns the total number of slices when the string is split with the given ``delimiter`` (see :ref:`split`). @@ -741,7 +741,7 @@ Returns the total number of slices when the string is split with the given ``del .. rst-class:: classref-method -:ref:`String` **get_slicec** **(** :ref:`int` delimiter, :ref:`int` slice **)** |const| +:ref:`String` **get_slicec**\ (\ delimiter\: :ref:`int`, slice\: :ref:`int`\ ) |const| Splits the string using a Unicode character with code ``delimiter`` and returns the substring at index ``slice``. Returns an empty string if the ``slice`` does not exist. @@ -755,7 +755,7 @@ This is faster than :ref:`split`, if you only nee .. rst-class:: classref-method -:ref:`int` **hash** **(** **)** |const| +:ref:`int` **hash**\ (\ ) |const| Returns the 32-bit hash value representing the string's contents. @@ -769,7 +769,7 @@ Returns the 32-bit hash value representing the string's contents. .. rst-class:: classref-method -:ref:`PackedByteArray` **hex_decode** **(** **)** |const| +:ref:`PackedByteArray` **hex_decode**\ (\ ) |const| Decodes a hexadecimal string as a :ref:`PackedByteArray`. @@ -798,7 +798,7 @@ Decodes a hexadecimal string as a :ref:`PackedByteArray`. .. rst-class:: classref-method -:ref:`int` **hex_to_int** **(** **)** |const| +:ref:`int` **hex_to_int**\ (\ ) |const| Converts the string representing a hexadecimal number into an :ref:`int`. The string may be optionally prefixed with ``"0x"``, and an additional ``-`` prefix for negative numbers. @@ -825,7 +825,7 @@ Converts the string representing a hexadecimal number into an :ref:`int` **indent** **(** :ref:`String` prefix **)** |const| +:ref:`String` **indent**\ (\ prefix\: :ref:`String`\ ) |const| Indents every line of the string with the given ``prefix``. Empty lines are not indented. See also :ref:`dedent` to remove indentation. @@ -839,7 +839,7 @@ For example, the string can be indented with two tabulations using ``"\t\t"``, o .. rst-class:: classref-method -:ref:`String` **insert** **(** :ref:`int` position, :ref:`String` what **)** |const| +:ref:`String` **insert**\ (\ position\: :ref:`int`, what\: :ref:`String`\ ) |const| Inserts ``what`` at the given ``position`` in the string. @@ -851,7 +851,7 @@ Inserts ``what`` at the given ``position`` in the string. .. rst-class:: classref-method -:ref:`bool` **is_absolute_path** **(** **)** |const| +:ref:`bool` **is_absolute_path**\ (\ ) |const| Returns ``true`` if the string is a path to a file or directory, and its starting point is explicitly defined. This method is the opposite of :ref:`is_relative_path`. @@ -865,7 +865,7 @@ This includes all paths starting with ``"res://"``, ``"user://"``, ``"C:\"``, `` .. rst-class:: classref-method -:ref:`bool` **is_empty** **(** **)** |const| +:ref:`bool` **is_empty**\ (\ ) |const| Returns ``true`` if the string's length is ``0`` (``""``). See also :ref:`length`. @@ -877,7 +877,7 @@ Returns ``true`` if the string's length is ``0`` (``""``). See also :ref:`length .. rst-class:: classref-method -:ref:`bool` **is_relative_path** **(** **)** |const| +:ref:`bool` **is_relative_path**\ (\ ) |const| Returns ``true`` if the string is a path, and its starting point is dependent on context. The path could begin from the current directory, or the current :ref:`Node` (if the string is derived from a :ref:`NodePath`), and may sometimes be prefixed with ``"./"``. This method is the opposite of :ref:`is_absolute_path`. @@ -889,7 +889,7 @@ Returns ``true`` if the string is a path, and its starting point is dependent on .. rst-class:: classref-method -:ref:`bool` **is_subsequence_of** **(** :ref:`String` text **)** |const| +:ref:`bool` **is_subsequence_of**\ (\ text\: :ref:`String`\ ) |const| Returns ``true`` if all characters of this string can be found in ``text`` in their original order. @@ -910,7 +910,7 @@ Returns ``true`` if all characters of this string can be found in ``text`` in th .. rst-class:: classref-method -:ref:`bool` **is_subsequence_ofn** **(** :ref:`String` text **)** |const| +:ref:`bool` **is_subsequence_ofn**\ (\ text\: :ref:`String`\ ) |const| Returns ``true`` if all characters of this string can be found in ``text`` in their original order, **ignoring case**. @@ -922,7 +922,7 @@ Returns ``true`` if all characters of this string can be found in ``text`` in th .. rst-class:: classref-method -:ref:`bool` **is_valid_filename** **(** **)** |const| +:ref:`bool` **is_valid_filename**\ (\ ) |const| Returns ``true`` if this string does not contain characters that are not allowed in file names (``:`` ``/`` ``\`` ``?`` ``*`` ``"`` ``|`` ``%`` ``<`` ``>``). @@ -934,7 +934,7 @@ Returns ``true`` if this string does not contain characters that are not allowed .. rst-class:: classref-method -:ref:`bool` **is_valid_float** **(** **)** |const| +:ref:`bool` **is_valid_float**\ (\ ) |const| Returns ``true`` if this string represents a valid floating-point number. A valid float may contain only digits, one decimal point (``.``), and the exponent letter (``e``). It may also be prefixed with a positive (``+``) or negative (``-``) sign. Any valid integer is also a valid float (see :ref:`is_valid_int`). See also :ref:`to_float`. @@ -953,7 +953,7 @@ Returns ``true`` if this string represents a valid floating-point number. A vali .. rst-class:: classref-method -:ref:`bool` **is_valid_hex_number** **(** :ref:`bool` with_prefix=false **)** |const| +:ref:`bool` **is_valid_hex_number**\ (\ with_prefix\: :ref:`bool` = false\ ) |const| Returns ``true`` if this string is a valid hexadecimal number. A valid hexadecimal number only contains digits or letters ``A`` to ``F`` (either uppercase or lowercase), and may be prefixed with a positive (``+``) or negative (``-``) sign. @@ -975,7 +975,7 @@ If ``with_prefix`` is ``true``, the hexadecimal number needs to prefixed by ``"0 .. rst-class:: classref-method -:ref:`bool` **is_valid_html_color** **(** **)** |const| +:ref:`bool` **is_valid_html_color**\ (\ ) |const| Returns ``true`` if this string is a valid color in hexadecimal HTML notation. The string must be a hexadecimal value (see :ref:`is_valid_hex_number`) of either 3, 4, 6 or 8 digits, and may be prefixed by a hash sign (``#``). Other HTML notations for colors, such as names or ``hsl()``, are not considered valid. See also :ref:`Color.html`. @@ -987,7 +987,7 @@ Returns ``true`` if this string is a valid color in hexadecimal HTML notation. T .. rst-class:: classref-method -:ref:`bool` **is_valid_identifier** **(** **)** |const| +:ref:`bool` **is_valid_identifier**\ (\ ) |const| Returns ``true`` if this string is a valid identifier. A valid identifier may contain only letters, digits and underscores (``_``), and the first character may not be a digit. @@ -1006,7 +1006,7 @@ Returns ``true`` if this string is a valid identifier. A valid identifier may co .. rst-class:: classref-method -:ref:`bool` **is_valid_int** **(** **)** |const| +:ref:`bool` **is_valid_int**\ (\ ) |const| Returns ``true`` if this string represents a valid integer. A valid integer only contains digits, and may be prefixed with a positive (``+``) or negative (``-``) sign. See also :ref:`to_int`. @@ -1026,7 +1026,7 @@ Returns ``true`` if this string represents a valid integer. A valid integer only .. rst-class:: classref-method -:ref:`bool` **is_valid_ip_address** **(** **)** |const| +:ref:`bool` **is_valid_ip_address**\ (\ ) |const| Returns ``true`` if this string represents a well-formatted IPv4 or IPv6 address. This method considers `reserved IP addresses `__ such as ``"0.0.0.0"`` and ``"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"`` as valid. @@ -1038,7 +1038,7 @@ Returns ``true`` if this string represents a well-formatted IPv4 or IPv6 address .. rst-class:: classref-method -:ref:`String` **join** **(** :ref:`PackedStringArray` parts **)** |const| +:ref:`String` **join**\ (\ parts\: :ref:`PackedStringArray`\ ) |const| Returns the concatenation of ``parts``' elements, with each element separated by the string calling this method. This method is the opposite of :ref:`split`. @@ -1072,7 +1072,7 @@ Returns the concatenation of ``parts``' elements, with each element separated by .. rst-class:: classref-method -:ref:`String` **json_escape** **(** **)** |const| +:ref:`String` **json_escape**\ (\ ) |const| Returns a copy of the string with special characters escaped using the JSON standard. Because it closely matches the C standard, it is possible to use :ref:`c_unescape` to unescape the string, if necessary. @@ -1084,7 +1084,7 @@ Returns a copy of the string with special characters escaped using the JSON stan .. rst-class:: classref-method -:ref:`String` **left** **(** :ref:`int` length **)** |const| +:ref:`String` **left**\ (\ length\: :ref:`int`\ ) |const| Returns the first ``length`` characters from the beginning of the string. If ``length`` is negative, strips the last ``length`` characters from the string's end. @@ -1101,7 +1101,7 @@ Returns the first ``length`` characters from the beginning of the string. If ``l .. rst-class:: classref-method -:ref:`int` **length** **(** **)** |const| +:ref:`int` **length**\ (\ ) |const| Returns the number of characters in the string. Empty strings (``""``) always return ``0``. See also :ref:`is_empty`. @@ -1113,7 +1113,7 @@ Returns the number of characters in the string. Empty strings (``""``) always re .. rst-class:: classref-method -:ref:`String` **lpad** **(** :ref:`int` min_length, :ref:`String` character=" " **)** |const| +:ref:`String` **lpad**\ (\ min_length\: :ref:`int`, character\: :ref:`String` = " "\ ) |const| Formats the string to be at least ``min_length`` long by adding ``character``\ s to the left of the string, if necessary. See also :ref:`rpad`. @@ -1125,7 +1125,7 @@ Formats the string to be at least ``min_length`` long by adding ``character``\ s .. rst-class:: classref-method -:ref:`String` **lstrip** **(** :ref:`String` chars **)** |const| +:ref:`String` **lstrip**\ (\ chars\: :ref:`String`\ ) |const| Removes a set of characters defined in ``chars`` from the string's beginning. See also :ref:`rstrip`. @@ -1139,7 +1139,7 @@ Removes a set of characters defined in ``chars`` from the string's beginning. Se .. rst-class:: classref-method -:ref:`bool` **match** **(** :ref:`String` expr **)** |const| +:ref:`bool` **match**\ (\ expr\: :ref:`String`\ ) |const| Does a simple expression match (also called "glob" or "globbing"), where ``*`` matches zero or more arbitrary characters and ``?`` matches any single character except a period (``.``). An empty string or empty expression always evaluates to ``false``. @@ -1151,7 +1151,7 @@ Does a simple expression match (also called "glob" or "globbing"), where ``*`` m .. rst-class:: classref-method -:ref:`bool` **matchn** **(** :ref:`String` expr **)** |const| +:ref:`bool` **matchn**\ (\ expr\: :ref:`String`\ ) |const| Does a simple **case-insensitive** expression match, where ``*`` matches zero or more arbitrary characters and ``?`` matches any single character except a period (``.``). An empty string or empty expression always evaluates to ``false``. @@ -1163,7 +1163,7 @@ Does a simple **case-insensitive** expression match, where ``*`` matches zero or .. rst-class:: classref-method -:ref:`PackedByteArray` **md5_buffer** **(** **)** |const| +:ref:`PackedByteArray` **md5_buffer**\ (\ ) |const| Returns the `MD5 hash `__ of the string as a :ref:`PackedByteArray`. @@ -1175,7 +1175,7 @@ Returns the `MD5 hash `__ of the string as a .. rst-class:: classref-method -:ref:`String` **md5_text** **(** **)** |const| +:ref:`String` **md5_text**\ (\ ) |const| Returns the `MD5 hash `__ of the string as another :ref:`String`. @@ -1187,7 +1187,7 @@ Returns the `MD5 hash `__ of the string as an .. rst-class:: classref-method -:ref:`int` **naturalcasecmp_to** **(** :ref:`String` to **)** |const| +:ref:`int` **naturalcasecmp_to**\ (\ to\: :ref:`String`\ ) |const| Performs a **case-sensitive**, *natural order* comparison to another string. Returns ``-1`` if less than, ``1`` if greater than, or ``0`` if equal. "Less than" or "greater than" are determined by the `Unicode code points `__ of each string, which roughly matches the alphabetical order. @@ -1205,7 +1205,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`int` **naturalnocasecmp_to** **(** :ref:`String` to **)** |const| +:ref:`int` **naturalnocasecmp_to**\ (\ to\: :ref:`String`\ ) |const| Performs a **case-insensitive**, *natural order* comparison to another string. Returns ``-1`` if less than, ``1`` if greater than, or ``0`` if equal. "Less than" or "greater than" are determined by the `Unicode code points `__ of each string, which roughly matches the alphabetical order. Internally, lowercase characters are converted to uppercase for the comparison. @@ -1223,7 +1223,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`int` **nocasecmp_to** **(** :ref:`String` to **)** |const| +:ref:`int` **nocasecmp_to**\ (\ to\: :ref:`String`\ ) |const| Performs a **case-insensitive** comparison to another string. Returns ``-1`` if less than, ``1`` if greater than, or ``0`` if equal. "Less than" or "greater than" are determined by the `Unicode code points `__ of each string, which roughly matches the alphabetical order. Internally, lowercase characters are converted to uppercase for the comparison. @@ -1239,7 +1239,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` .. rst-class:: classref-method -:ref:`String` **pad_decimals** **(** :ref:`int` digits **)** |const| +:ref:`String` **pad_decimals**\ (\ digits\: :ref:`int`\ ) |const| Formats the string representing a number to have an exact number of ``digits`` *after* the decimal point. @@ -1251,7 +1251,7 @@ Formats the string representing a number to have an exact number of ``digits`` * .. rst-class:: classref-method -:ref:`String` **pad_zeros** **(** :ref:`int` digits **)** |const| +:ref:`String` **pad_zeros**\ (\ digits\: :ref:`int`\ ) |const| Formats the string representing a number to have an exact number of ``digits`` *before* the decimal point. @@ -1263,7 +1263,7 @@ Formats the string representing a number to have an exact number of ``digits`` * .. rst-class:: classref-method -:ref:`String` **path_join** **(** :ref:`String` file **)** |const| +:ref:`String` **path_join**\ (\ file\: :ref:`String`\ ) |const| Concatenates ``file`` at the end of the string as a subpath, adding ``/`` if necessary. @@ -1277,7 +1277,7 @@ Concatenates ``file`` at the end of the string as a subpath, adding ``/`` if nec .. rst-class:: classref-method -:ref:`String` **repeat** **(** :ref:`int` count **)** |const| +:ref:`String` **repeat**\ (\ count\: :ref:`int`\ ) |const| Repeats this string a number of times. ``count`` needs to be greater than ``0``. Otherwise, returns an empty string. @@ -1289,7 +1289,7 @@ Repeats this string a number of times. ``count`` needs to be greater than ``0``. .. rst-class:: classref-method -:ref:`String` **replace** **(** :ref:`String` what, :ref:`String` forwhat **)** |const| +:ref:`String` **replace**\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| Replaces all occurrences of ``what`` inside the string with the given ``forwhat``. @@ -1301,7 +1301,7 @@ Replaces all occurrences of ``what`` inside the string with the given ``forwhat` .. rst-class:: classref-method -:ref:`String` **replacen** **(** :ref:`String` what, :ref:`String` forwhat **)** |const| +:ref:`String` **replacen**\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| Replaces all **case-insensitive** occurrences of ``what`` inside the string with the given ``forwhat``. @@ -1313,7 +1313,7 @@ Replaces all **case-insensitive** occurrences of ``what`` inside the string with .. rst-class:: classref-method -:ref:`String` **reverse** **(** **)** |const| +:ref:`String` **reverse**\ (\ ) |const| Returns the copy of this string in reverse order. @@ -1325,7 +1325,7 @@ Returns the copy of this string in reverse order. .. rst-class:: classref-method -:ref:`int` **rfind** **(** :ref:`String` what, :ref:`int` from=-1 **)** |const| +:ref:`int` **rfind**\ (\ what\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| Returns the index of the **last** occurrence of ``what`` in this string, or ``-1`` if there are none. The search's start can be specified with ``from``, continuing to the beginning of the string. This method is the reverse of :ref:`find`. @@ -1337,7 +1337,7 @@ Returns the index of the **last** occurrence of ``what`` in this string, or ``-1 .. rst-class:: classref-method -:ref:`int` **rfindn** **(** :ref:`String` what, :ref:`int` from=-1 **)** |const| +:ref:`int` **rfindn**\ (\ what\: :ref:`String`, from\: :ref:`int` = -1\ ) |const| Returns the index of the **last** **case-insensitive** occurrence of ``what`` in this string, or ``-1`` if there are none. The starting search index can be specified with ``from``, continuing to the beginning of the string. This method is the reverse of :ref:`findn`. @@ -1349,7 +1349,7 @@ Returns the index of the **last** **case-insensitive** occurrence of ``what`` in .. rst-class:: classref-method -:ref:`String` **right** **(** :ref:`int` length **)** |const| +:ref:`String` **right**\ (\ length\: :ref:`int`\ ) |const| Returns the last ``length`` characters from the end of the string. If ``length`` is negative, strips the first ``length`` characters from the string's beginning. @@ -1366,7 +1366,7 @@ Returns the last ``length`` characters from the end of the string. If ``length`` .. rst-class:: classref-method -:ref:`String` **rpad** **(** :ref:`int` min_length, :ref:`String` character=" " **)** |const| +:ref:`String` **rpad**\ (\ min_length\: :ref:`int`, character\: :ref:`String` = " "\ ) |const| Formats the string to be at least ``min_length`` long, by adding ``character``\ s to the right of the string, if necessary. See also :ref:`lpad`. @@ -1378,7 +1378,7 @@ Formats the string to be at least ``min_length`` long, by adding ``character``\ .. rst-class:: classref-method -:ref:`PackedStringArray` **rsplit** **(** :ref:`String` delimiter="", :ref:`bool` allow_empty=true, :ref:`int` maxsplit=0 **)** |const| +:ref:`PackedStringArray` **rsplit**\ (\ delimiter\: :ref:`String` = "", allow_empty\: :ref:`bool` = true, maxsplit\: :ref:`int` = 0\ ) |const| Splits the string using a ``delimiter`` and returns an array of the substrings, starting from the end of the string. The splits in the returned array appear in the same order as the original string. If ``delimiter`` is an empty string, each substring will be a single character. @@ -1414,7 +1414,7 @@ If ``maxsplit`` is greater than ``0``, the number of splits may not exceed ``max .. rst-class:: classref-method -:ref:`String` **rstrip** **(** :ref:`String` chars **)** |const| +:ref:`String` **rstrip**\ (\ chars\: :ref:`String`\ ) |const| Removes a set of characters defined in ``chars`` from the string's end. See also :ref:`lstrip`. @@ -1428,7 +1428,7 @@ Removes a set of characters defined in ``chars`` from the string's end. See also .. rst-class:: classref-method -:ref:`PackedByteArray` **sha1_buffer** **(** **)** |const| +:ref:`PackedByteArray` **sha1_buffer**\ (\ ) |const| Returns the `SHA-1 `__ hash of the string as a :ref:`PackedByteArray`. @@ -1440,7 +1440,7 @@ Returns the `SHA-1 `__ hash of the string a .. rst-class:: classref-method -:ref:`String` **sha1_text** **(** **)** |const| +:ref:`String` **sha1_text**\ (\ ) |const| Returns the `SHA-1 `__ hash of the string as another :ref:`String`. @@ -1452,7 +1452,7 @@ Returns the `SHA-1 `__ hash of the string a .. rst-class:: classref-method -:ref:`PackedByteArray` **sha256_buffer** **(** **)** |const| +:ref:`PackedByteArray` **sha256_buffer**\ (\ ) |const| Returns the `SHA-256 `__ hash of the string as a :ref:`PackedByteArray`. @@ -1464,7 +1464,7 @@ Returns the `SHA-256 `__ hash of the string .. rst-class:: classref-method -:ref:`String` **sha256_text** **(** **)** |const| +:ref:`String` **sha256_text**\ (\ ) |const| Returns the `SHA-256 `__ hash of the string as another :ref:`String`. @@ -1476,7 +1476,7 @@ Returns the `SHA-256 `__ hash of the string .. rst-class:: classref-method -:ref:`float` **similarity** **(** :ref:`String` text **)** |const| +:ref:`float` **similarity**\ (\ text\: :ref:`String`\ ) |const| Returns the similarity index (`Sorensen-Dice coefficient `__) of this string compared to another. A result of ``1.0`` means totally similar, while ``0.0`` means totally dissimilar. @@ -1495,7 +1495,7 @@ Returns the similarity index (`Sorensen-Dice coefficient ` **simplify_path** **(** **)** |const| +:ref:`String` **simplify_path**\ (\ ) |const| If the string is a valid file path, converts the string into a canonical path. This is the shortest possible path, without ``"./"``, and all the unnecessary ``".."`` and ``"/"``. @@ -1512,7 +1512,7 @@ If the string is a valid file path, converts the string into a canonical path. T .. rst-class:: classref-method -:ref:`PackedStringArray` **split** **(** :ref:`String` delimiter="", :ref:`bool` allow_empty=true, :ref:`int` maxsplit=0 **)** |const| +:ref:`PackedStringArray` **split**\ (\ delimiter\: :ref:`String` = "", allow_empty\: :ref:`bool` = true, maxsplit\: :ref:`int` = 0\ ) |const| Splits the string using a ``delimiter`` and returns an array of the substrings. If ``delimiter`` is an empty string, each substring will be a single character. This method is the opposite of :ref:`join`. @@ -1555,7 +1555,7 @@ If ``maxsplit`` is greater than ``0``, the number of splits may not exceed ``max .. rst-class:: classref-method -:ref:`PackedFloat64Array` **split_floats** **(** :ref:`String` delimiter, :ref:`bool` allow_empty=true **)** |const| +:ref:`PackedFloat64Array` **split_floats**\ (\ delimiter\: :ref:`String`, allow_empty\: :ref:`bool` = true\ ) |const| Splits the string into floats by using a ``delimiter`` and returns a :ref:`PackedFloat64Array`. @@ -1575,7 +1575,7 @@ If ``allow_empty`` is ``false``, empty or invalid :ref:`float` conv .. rst-class:: classref-method -:ref:`String` **strip_edges** **(** :ref:`bool` left=true, :ref:`bool` right=true **)** |const| +:ref:`String` **strip_edges**\ (\ left\: :ref:`bool` = true, right\: :ref:`bool` = true\ ) |const| Strips all non-printable characters from the beginning and the end of the string. These include spaces, tabulations (``\t``), and newlines (``\n`` ``\r``). @@ -1589,7 +1589,7 @@ If ``left`` is ``false``, ignores the string's beginning. Likewise, if ``right`` .. rst-class:: classref-method -:ref:`String` **strip_escapes** **(** **)** |const| +:ref:`String` **strip_escapes**\ (\ ) |const| Strips all escape characters from the string. These include all non-printable control characters of the first page of the ASCII table (values from 0 to 31), such as tabulation (``\t``) and newline (``\n``, ``\r``) characters, but *not* spaces. @@ -1601,7 +1601,7 @@ Strips all escape characters from the string. These include all non-printable co .. rst-class:: classref-method -:ref:`String` **substr** **(** :ref:`int` from, :ref:`int` len=-1 **)** |const| +:ref:`String` **substr**\ (\ from\: :ref:`int`, len\: :ref:`int` = -1\ ) |const| Returns part of the string from the position ``from`` with length ``len``. If ``len`` is ``-1`` (as by default), returns the rest of the string starting from the given position. @@ -1613,7 +1613,7 @@ Returns part of the string from the position ``from`` with length ``len``. If `` .. rst-class:: classref-method -:ref:`PackedByteArray` **to_ascii_buffer** **(** **)** |const| +:ref:`PackedByteArray` **to_ascii_buffer**\ (\ ) |const| Converts the string to an `ASCII `__/Latin-1 encoded :ref:`PackedByteArray`. This method is slightly faster than :ref:`to_utf8_buffer`, but replaces all unsupported characters with spaces. @@ -1625,7 +1625,7 @@ Converts the string to an `ASCII `__/Latin- .. rst-class:: classref-method -:ref:`String` **to_camel_case** **(** **)** |const| +:ref:`String` **to_camel_case**\ (\ ) |const| Returns the string converted to ``camelCase``. @@ -1637,7 +1637,7 @@ Returns the string converted to ``camelCase``. .. rst-class:: classref-method -:ref:`float` **to_float** **(** **)** |const| +:ref:`float` **to_float**\ (\ ) |const| Converts the string representing a decimal number into a :ref:`float`. This method stops on the first non-number character, except the first decimal point (``.``) and the exponent letter (``e``). See also :ref:`is_valid_float`. @@ -1657,7 +1657,7 @@ Converts the string representing a decimal number into a :ref:`float` **to_int** **(** **)** |const| +:ref:`int` **to_int**\ (\ ) |const| Converts the string representing an integer number into an :ref:`int`. This method removes any non-number character and stops at the first decimal point (``.``). See also :ref:`is_valid_int`. @@ -1676,7 +1676,7 @@ Converts the string representing an integer number into an :ref:`int` .. rst-class:: classref-method -:ref:`String` **to_lower** **(** **)** |const| +:ref:`String` **to_lower**\ (\ ) |const| Returns the string converted to ``lowercase``. @@ -1688,7 +1688,7 @@ Returns the string converted to ``lowercase``. .. rst-class:: classref-method -:ref:`String` **to_pascal_case** **(** **)** |const| +:ref:`String` **to_pascal_case**\ (\ ) |const| Returns the string converted to ``PascalCase``. @@ -1700,7 +1700,7 @@ Returns the string converted to ``PascalCase``. .. rst-class:: classref-method -:ref:`String` **to_snake_case** **(** **)** |const| +:ref:`String` **to_snake_case**\ (\ ) |const| Returns the string converted to ``snake_case``. @@ -1731,7 +1731,7 @@ Returns the string converted to ``snake_case``. .. rst-class:: classref-method -:ref:`String` **to_upper** **(** **)** |const| +:ref:`String` **to_upper**\ (\ ) |const| Returns the string converted to ``UPPERCASE``. @@ -1743,7 +1743,7 @@ Returns the string converted to ``UPPERCASE``. .. rst-class:: classref-method -:ref:`PackedByteArray` **to_utf8_buffer** **(** **)** |const| +:ref:`PackedByteArray` **to_utf8_buffer**\ (\ ) |const| Converts the string to a `UTF-8 `__ encoded :ref:`PackedByteArray`. This method is slightly slower than :ref:`to_ascii_buffer`, but supports all UTF-8 characters. For most cases, prefer using this method. @@ -1755,7 +1755,7 @@ Converts the string to a `UTF-8 `__ encoded .. rst-class:: classref-method -:ref:`PackedByteArray` **to_utf16_buffer** **(** **)** |const| +:ref:`PackedByteArray` **to_utf16_buffer**\ (\ ) |const| Converts the string to a `UTF-16 `__ encoded :ref:`PackedByteArray`. @@ -1767,7 +1767,7 @@ Converts the string to a `UTF-16 `__ encod .. rst-class:: classref-method -:ref:`PackedByteArray` **to_utf32_buffer** **(** **)** |const| +:ref:`PackedByteArray` **to_utf32_buffer**\ (\ ) |const| Converts the string to a `UTF-32 `__ encoded :ref:`PackedByteArray`. @@ -1779,7 +1779,7 @@ Converts the string to a `UTF-32 `__ encod .. rst-class:: classref-method -:ref:`PackedByteArray` **to_wchar_buffer** **(** **)** |const| +:ref:`PackedByteArray` **to_wchar_buffer**\ (\ ) |const| Converts the string to a `wide character `__ (``wchar_t``, UTF-16 on Windows, UTF-32 on other platforms) encoded :ref:`PackedByteArray`. @@ -1791,7 +1791,7 @@ Converts the string to a `wide character ` **trim_prefix** **(** :ref:`String` prefix **)** |const| +:ref:`String` **trim_prefix**\ (\ prefix\: :ref:`String`\ ) |const| Removes the given ``prefix`` from the start of the string, or returns the string unchanged. @@ -1803,7 +1803,7 @@ Removes the given ``prefix`` from the start of the string, or returns the string .. rst-class:: classref-method -:ref:`String` **trim_suffix** **(** :ref:`String` suffix **)** |const| +:ref:`String` **trim_suffix**\ (\ suffix\: :ref:`String`\ ) |const| Removes the given ``suffix`` from the end of the string, or returns the string unchanged. @@ -1815,7 +1815,7 @@ Removes the given ``suffix`` from the end of the string, or returns the string u .. rst-class:: classref-method -:ref:`int` **unicode_at** **(** :ref:`int` at **)** |const| +:ref:`int` **unicode_at**\ (\ at\: :ref:`int`\ ) |const| Returns the character code at position ``at``. @@ -1827,7 +1827,7 @@ Returns the character code at position ``at``. .. rst-class:: classref-method -:ref:`String` **uri_decode** **(** **)** |const| +:ref:`String` **uri_decode**\ (\ ) |const| Decodes the string from its URL-encoded format. This method is meant to properly decode the parameters in a URL when receiving an HTTP request. @@ -1854,7 +1854,7 @@ Decodes the string from its URL-encoded format. This method is meant to properly .. rst-class:: classref-method -:ref:`String` **uri_encode** **(** **)** |const| +:ref:`String` **uri_encode**\ (\ ) |const| Encodes the string to URL-friendly format. This method is meant to properly encode the parameters in a URL when sending an HTTP request. @@ -1885,7 +1885,7 @@ Encodes the string to URL-friendly format. This method is meant to properly enco .. rst-class:: classref-method -:ref:`String` **validate_filename** **(** **)** |const| +:ref:`String` **validate_filename**\ (\ ) |const| Returns a copy of the string with all characters that are not allowed in :ref:`is_valid_filename` replaced with underscores. @@ -1897,7 +1897,7 @@ Returns a copy of the string with all characters that are not allowed in :ref:`i .. rst-class:: classref-method -:ref:`String` **validate_node_name** **(** **)** |const| +:ref:`String` **validate_node_name**\ (\ ) |const| Returns a copy of the string with all characters that are not allowed in :ref:`Node.name` (``.`` ``:`` ``@`` ``/`` ``"`` ``%``) replaced with underscores. @@ -1909,7 +1909,7 @@ Returns a copy of the string with all characters that are not allowed in :ref:`N .. rst-class:: classref-method -:ref:`String` **xml_escape** **(** :ref:`bool` escape_quotes=false **)** |const| +:ref:`String` **xml_escape**\ (\ escape_quotes\: :ref:`bool` = false\ ) |const| Returns a copy of the string with special characters escaped using the XML standard. If ``escape_quotes`` is ``true``, the single quote (``'``) and double quote (``"``) characters are also escaped. @@ -1921,7 +1921,7 @@ Returns a copy of the string with special characters escaped using the XML stand .. rst-class:: classref-method -:ref:`String` **xml_unescape** **(** **)** |const| +:ref:`String` **xml_unescape**\ (\ ) |const| Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard. @@ -1938,7 +1938,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`String` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`String`\ ) Returns ``true`` if this **StringName** is not equivalent to the given :ref:`String`. @@ -1950,7 +1950,7 @@ Returns ``true`` if this **StringName** is not equivalent to the given :ref:`Str .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`StringName` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`StringName`\ ) Returns ``true`` if the **StringName** and ``right`` do not refer to the same name. Comparisons between **StringName**\ s are much faster than regular :ref:`String` comparisons. @@ -1962,7 +1962,7 @@ Returns ``true`` if the **StringName** and ``right`` do not refer to the same na .. rst-class:: classref-operator -:ref:`String` **operator %** **(** :ref:`Variant` right **)** +:ref:`String` **operator %**\ (\ right\: :ref:`Variant`\ ) Formats the **StringName**, replacing the placeholders with one or more parameters, returning a :ref:`String`. To pass multiple parameters, ``right`` needs to be an :ref:`Array`. @@ -1978,7 +1978,7 @@ For more information, see the :doc:`GDScript format strings <../tutorials/script .. rst-class:: classref-operator -:ref:`String` **operator +** **(** :ref:`String` right **)** +:ref:`String` **operator +**\ (\ right\: :ref:`String`\ ) Appends ``right`` at the end of this **StringName**, returning a :ref:`String`. This is also known as a string concatenation. @@ -1990,7 +1990,7 @@ Appends ``right`` at the end of this **StringName**, returning a :ref:`String` **operator +** **(** :ref:`StringName` right **)** +:ref:`String` **operator +**\ (\ right\: :ref:`StringName`\ ) Appends ``right`` at the end of this **StringName**, returning a :ref:`String`. This is also known as a string concatenation. @@ -2002,7 +2002,7 @@ Appends ``right`` at the end of this **StringName**, returning a :ref:`String` **operator <** **(** :ref:`StringName` right **)** +:ref:`bool` **operator <**\ (\ right\: :ref:`StringName`\ ) Returns ``true`` if the left **StringName**'s pointer comes before ``right``. Note that this will not match their `Unicode order `__. @@ -2014,7 +2014,7 @@ Returns ``true`` if the left **StringName**'s pointer comes before ``right``. No .. rst-class:: classref-operator -:ref:`bool` **operator <=** **(** :ref:`StringName` right **)** +:ref:`bool` **operator <=**\ (\ right\: :ref:`StringName`\ ) Returns ``true`` if the left **StringName**'s pointer comes before ``right`` or if they are the same. Note that this will not match their `Unicode order `__. @@ -2026,7 +2026,7 @@ Returns ``true`` if the left **StringName**'s pointer comes before ``right`` or .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`String` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`String`\ ) Returns ``true`` if this **StringName** is equivalent to the given :ref:`String`. @@ -2038,7 +2038,7 @@ Returns ``true`` if this **StringName** is equivalent to the given :ref:`String< .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`StringName` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`StringName`\ ) Returns ``true`` if the **StringName** and ``right`` refer to the same name. Comparisons between **StringName**\ s are much faster than regular :ref:`String` comparisons. @@ -2050,7 +2050,7 @@ Returns ``true`` if the **StringName** and ``right`` refer to the same name. Com .. rst-class:: classref-operator -:ref:`bool` **operator >** **(** :ref:`StringName` right **)** +:ref:`bool` **operator >**\ (\ right\: :ref:`StringName`\ ) Returns ``true`` if the left **StringName**'s pointer comes after ``right``. Note that this will not match their `Unicode order `__. @@ -2062,7 +2062,7 @@ Returns ``true`` if the left **StringName**'s pointer comes after ``right``. Not .. rst-class:: classref-operator -:ref:`bool` **operator >=** **(** :ref:`StringName` right **)** +:ref:`bool` **operator >=**\ (\ right\: :ref:`StringName`\ ) Returns ``true`` if the left **StringName**'s pointer comes after ``right`` or if they are the same. Note that this will not match their `Unicode order `__. @@ -2073,3 +2073,4 @@ Returns ``true`` if the left **StringName**'s pointer comes after ``right`` or i .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 55a5f986b82..788021b7cac 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -51,33 +51,33 @@ Methods .. table:: :widths: auto - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_draw` **(** :ref:`RID` to_canvas_item, :ref:`Rect2` rect **)** |virtual| |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`_get_draw_rect` **(** :ref:`Rect2` rect **)** |virtual| |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_minimum_size` **(** **)** |virtual| |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_test_mask` **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** |virtual| |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_content_margin` **(** :ref:`Side` margin **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`CanvasItem` | :ref:`get_current_item_drawn` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_margin` **(** :ref:`Side` margin **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_offset` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_content_margin` **(** :ref:`Side` margin, :ref:`float` offset **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_content_margin_all` **(** :ref:`float` offset **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`test_mask` **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_draw`\ (\ to_canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`\ ) |virtual| |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`_get_draw_rect`\ (\ rect\: :ref:`Rect2`\ ) |virtual| |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_minimum_size`\ (\ ) |virtual| |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_test_mask`\ (\ point\: :ref:`Vector2`, rect\: :ref:`Rect2`\ ) |virtual| |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw`\ (\ canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_content_margin`\ (\ margin\: :ref:`Side`\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CanvasItem` | :ref:`get_current_item_drawn`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_margin`\ (\ margin\: :ref:`Side`\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_minimum_size`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_offset`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_content_margin`\ (\ margin\: :ref:`Side`, offset\: :ref:`float`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_content_margin_all`\ (\ offset\: :ref:`float`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`test_mask`\ (\ point\: :ref:`Vector2`, rect\: :ref:`Rect2`\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -96,8 +96,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_content_margin** **(** :ref:`Side` margin, :ref:`float` offset **)** -- :ref:`float` **get_content_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_content_margin**\ (\ margin\: :ref:`Side`, offset\: :ref:`float`\ ) +- :ref:`float` **get_content_margin**\ (\ margin\: :ref:`Side`\ ) |const| The bottom margin for the contents of this style box. Increasing this value reduces the space available to the contents from the bottom. @@ -119,8 +119,8 @@ It is up to the code using this style box to decide what these contents are: for .. rst-class:: classref-property-setget -- void **set_content_margin** **(** :ref:`Side` margin, :ref:`float` offset **)** -- :ref:`float` **get_content_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_content_margin**\ (\ margin\: :ref:`Side`, offset\: :ref:`float`\ ) +- :ref:`float` **get_content_margin**\ (\ margin\: :ref:`Side`\ ) |const| The left margin for the contents of this style box. Increasing this value reduces the space available to the contents from the left. @@ -138,8 +138,8 @@ Refer to :ref:`content_margin_bottom` margin, :ref:`float` offset **)** -- :ref:`float` **get_content_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_content_margin**\ (\ margin\: :ref:`Side`, offset\: :ref:`float`\ ) +- :ref:`float` **get_content_margin**\ (\ margin\: :ref:`Side`\ ) |const| The right margin for the contents of this style box. Increasing this value reduces the space available to the contents from the right. @@ -157,8 +157,8 @@ Refer to :ref:`content_margin_bottom` margin, :ref:`float` offset **)** -- :ref:`float` **get_content_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_content_margin**\ (\ margin\: :ref:`Side`, offset\: :ref:`float`\ ) +- :ref:`float` **get_content_margin**\ (\ margin\: :ref:`Side`\ ) |const| The top margin for the contents of this style box. Increasing this value reduces the space available to the contents from the top. @@ -177,7 +177,7 @@ Method Descriptions .. rst-class:: classref-method -void **_draw** **(** :ref:`RID` to_canvas_item, :ref:`Rect2` rect **)** |virtual| |const| +|void| **_draw**\ (\ to_canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`\ ) |virtual| |const| .. container:: contribute @@ -191,7 +191,7 @@ void **_draw** **(** :ref:`RID` to_canvas_item, :ref:`Rect2` **_get_draw_rect** **(** :ref:`Rect2` rect **)** |virtual| |const| +:ref:`Rect2` **_get_draw_rect**\ (\ rect\: :ref:`Rect2`\ ) |virtual| |const| .. container:: contribute @@ -205,7 +205,7 @@ void **_draw** **(** :ref:`RID` to_canvas_item, :ref:`Rect2` **_get_minimum_size** **(** **)** |virtual| |const| +:ref:`Vector2` **_get_minimum_size**\ (\ ) |virtual| |const| Virtual method to be implemented by the user. Returns a custom minimum size that the stylebox must respect when drawing. By default :ref:`get_minimum_size` only takes content margins into account. This method can be overridden to add another size restriction. A combination of the default behavior and the output of this method will be used, to account for both sizes. @@ -217,7 +217,7 @@ Virtual method to be implemented by the user. Returns a custom minimum size that .. rst-class:: classref-method -:ref:`bool` **_test_mask** **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** |virtual| |const| +:ref:`bool` **_test_mask**\ (\ point\: :ref:`Vector2`, rect\: :ref:`Rect2`\ ) |virtual| |const| .. container:: contribute @@ -231,7 +231,7 @@ Virtual method to be implemented by the user. Returns a custom minimum size that .. rst-class:: classref-method -void **draw** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** |const| +|void| **draw**\ (\ canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`\ ) |const| Draws this stylebox using a canvas item identified by the given :ref:`RID`. @@ -245,7 +245,7 @@ The :ref:`RID` value can either be the result of :ref:`CanvasItem.get .. rst-class:: classref-method -:ref:`float` **get_content_margin** **(** :ref:`Side` margin **)** |const| +:ref:`float` **get_content_margin**\ (\ margin\: :ref:`Side`\ ) |const| Returns the default margin of the specified :ref:`Side`. @@ -257,7 +257,7 @@ Returns the default margin of the specified :ref:`Side`. .. rst-class:: classref-method -:ref:`CanvasItem` **get_current_item_drawn** **(** **)** |const| +:ref:`CanvasItem` **get_current_item_drawn**\ (\ ) |const| Returns the :ref:`CanvasItem` that handles its :ref:`CanvasItem.NOTIFICATION_DRAW` or :ref:`CanvasItem._draw` callback at this moment. @@ -269,7 +269,7 @@ Returns the :ref:`CanvasItem` that handles its :ref:`CanvasIte .. rst-class:: classref-method -:ref:`float` **get_margin** **(** :ref:`Side` margin **)** |const| +:ref:`float` **get_margin**\ (\ margin\: :ref:`Side`\ ) |const| Returns the content margin offset for the specified :ref:`Side`. @@ -283,7 +283,7 @@ Positive values reduce size inwards, unlike :ref:`Control`'s marg .. rst-class:: classref-method -:ref:`Vector2` **get_minimum_size** **(** **)** |const| +:ref:`Vector2` **get_minimum_size**\ (\ ) |const| Returns the minimum size that this stylebox can be shrunk to. @@ -295,7 +295,7 @@ Returns the minimum size that this stylebox can be shrunk to. .. rst-class:: classref-method -:ref:`Vector2` **get_offset** **(** **)** |const| +:ref:`Vector2` **get_offset**\ (\ ) |const| Returns the "offset" of a stylebox. This helper function returns a value equivalent to ``Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))``. @@ -307,7 +307,7 @@ Returns the "offset" of a stylebox. This helper function returns a value equival .. rst-class:: classref-method -void **set_content_margin** **(** :ref:`Side` margin, :ref:`float` offset **)** +|void| **set_content_margin**\ (\ margin\: :ref:`Side`, offset\: :ref:`float`\ ) Sets the default value of the specified :ref:`Side` to ``offset`` pixels. @@ -319,7 +319,7 @@ Sets the default value of the specified :ref:`Side` to ` .. rst-class:: classref-method -void **set_content_margin_all** **(** :ref:`float` offset **)** +|void| **set_content_margin_all**\ (\ offset\: :ref:`float`\ ) Sets the default margin to ``offset`` pixels for all sides. @@ -331,7 +331,7 @@ Sets the default margin to ``offset`` pixels for all sides. .. rst-class:: classref-method -:ref:`bool` **test_mask** **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** |const| +:ref:`bool` **test_mask**\ (\ point\: :ref:`Vector2`, rect\: :ref:`Rect2`\ ) |const| Test a position in a rectangle, return whether it passes the mask test. @@ -342,3 +342,4 @@ Test a position in a rectangle, return whether it passes the mask test. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_styleboxempty.rst b/classes/class_styleboxempty.rst index 3c0255d0ad2..d4bd63143bc 100644 --- a/classes/class_styleboxempty.rst +++ b/classes/class_styleboxempty.rst @@ -28,3 +28,4 @@ An empty :ref:`StyleBox` that can be used to display nothing ins .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index 36a65dcb709..628eb37f241 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -102,27 +102,27 @@ Methods .. table:: :widths: auto - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_border_width` **(** :ref:`Side` margin **)** |const| | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_border_width_min` **(** **)** |const| | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_corner_radius` **(** :ref:`Corner` corner **)** |const| | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_expand_margin` **(** :ref:`Side` margin **)** |const| | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_border_width` **(** :ref:`Side` margin, :ref:`int` width **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_border_width_all` **(** :ref:`int` width **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_corner_radius` **(** :ref:`Corner` corner, :ref:`int` radius **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_corner_radius_all` **(** :ref:`int` radius **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_expand_margin` **(** :ref:`Side` margin, :ref:`float` size **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_border_width`\ (\ margin\: :ref:`Side`\ ) |const| | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_border_width_min`\ (\ ) |const| | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_corner_radius`\ (\ corner\: :ref:`Corner`\ ) |const| | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_expand_margin`\ (\ margin\: :ref:`Side`\ ) |const| | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_border_width`\ (\ margin\: :ref:`Side`, width\: :ref:`int`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_border_width_all`\ (\ width\: :ref:`int`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_corner_radius`\ (\ corner\: :ref:`Corner`, radius\: :ref:`int`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_corner_radius_all`\ (\ radius\: :ref:`int`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_expand_margin`\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_expand_margin_all`\ (\ size\: :ref:`float`\ ) | + +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -141,8 +141,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_anti_aliased** **(** :ref:`bool` value **)** -- :ref:`bool` **is_anti_aliased** **(** **)** +- |void| **set_anti_aliased**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_anti_aliased**\ (\ ) Antialiasing draws a small ring around the edges, which fades to transparency. As a result, edges look much smoother. This is only noticeable when using rounded corners or :ref:`skew`. @@ -160,8 +160,8 @@ Antialiasing draws a small ring around the edges, which fades to transparency. A .. rst-class:: classref-property-setget -- void **set_aa_size** **(** :ref:`float` value **)** -- :ref:`float` **get_aa_size** **(** **)** +- |void| **set_aa_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_aa_size**\ (\ ) This changes the size of the antialiasing effect. ``1.0`` is recommended for an optimal result at 100% scale, identical to how rounded rectangles are rendered in web browsers and most vector drawing software. @@ -179,8 +179,8 @@ This changes the size of the antialiasing effect. ``1.0`` is recommended for an .. rst-class:: classref-property-setget -- void **set_bg_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_bg_color** **(** **)** +- |void| **set_bg_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_bg_color**\ (\ ) The background color of the stylebox. @@ -196,8 +196,8 @@ The background color of the stylebox. .. rst-class:: classref-property-setget -- void **set_border_blend** **(** :ref:`bool` value **)** -- :ref:`bool` **get_border_blend** **(** **)** +- |void| **set_border_blend**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_border_blend**\ (\ ) If ``true``, the border will fade into the background color. @@ -213,8 +213,8 @@ If ``true``, the border will fade into the background color. .. rst-class:: classref-property-setget -- void **set_border_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_border_color** **(** **)** +- |void| **set_border_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_border_color**\ (\ ) Sets the color of the border. @@ -230,8 +230,8 @@ Sets the color of the border. .. rst-class:: classref-property-setget -- void **set_border_width** **(** :ref:`Side` margin, :ref:`int` width **)** -- :ref:`int` **get_border_width** **(** :ref:`Side` margin **)** |const| +- |void| **set_border_width**\ (\ margin\: :ref:`Side`, width\: :ref:`int`\ ) +- :ref:`int` **get_border_width**\ (\ margin\: :ref:`Side`\ ) |const| Border width for the bottom border. @@ -247,8 +247,8 @@ Border width for the bottom border. .. rst-class:: classref-property-setget -- void **set_border_width** **(** :ref:`Side` margin, :ref:`int` width **)** -- :ref:`int` **get_border_width** **(** :ref:`Side` margin **)** |const| +- |void| **set_border_width**\ (\ margin\: :ref:`Side`, width\: :ref:`int`\ ) +- :ref:`int` **get_border_width**\ (\ margin\: :ref:`Side`\ ) |const| Border width for the left border. @@ -264,8 +264,8 @@ Border width for the left border. .. rst-class:: classref-property-setget -- void **set_border_width** **(** :ref:`Side` margin, :ref:`int` width **)** -- :ref:`int` **get_border_width** **(** :ref:`Side` margin **)** |const| +- |void| **set_border_width**\ (\ margin\: :ref:`Side`, width\: :ref:`int`\ ) +- :ref:`int` **get_border_width**\ (\ margin\: :ref:`Side`\ ) |const| Border width for the right border. @@ -281,8 +281,8 @@ Border width for the right border. .. rst-class:: classref-property-setget -- void **set_border_width** **(** :ref:`Side` margin, :ref:`int` width **)** -- :ref:`int` **get_border_width** **(** :ref:`Side` margin **)** |const| +- |void| **set_border_width**\ (\ margin\: :ref:`Side`, width\: :ref:`int`\ ) +- :ref:`int` **get_border_width**\ (\ margin\: :ref:`Side`\ ) |const| Border width for the top border. @@ -298,8 +298,8 @@ Border width for the top border. .. rst-class:: classref-property-setget -- void **set_corner_detail** **(** :ref:`int` value **)** -- :ref:`int` **get_corner_detail** **(** **)** +- |void| **set_corner_detail**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_corner_detail**\ (\ ) This sets the number of vertices used for each corner. Higher values result in rounder corners but take more processing power to compute. When choosing a value, you should take the corner radius (:ref:`set_corner_radius_all`) into account. @@ -319,8 +319,8 @@ A corner detail of ``1`` will result in chamfered corners instead of rounded cor .. rst-class:: classref-property-setget -- void **set_corner_radius** **(** :ref:`Corner` corner, :ref:`int` radius **)** -- :ref:`int` **get_corner_radius** **(** :ref:`Corner` corner **)** |const| +- |void| **set_corner_radius**\ (\ corner\: :ref:`Corner`, radius\: :ref:`int`\ ) +- :ref:`int` **get_corner_radius**\ (\ corner\: :ref:`Corner`\ ) |const| The bottom-left corner's radius. If ``0``, the corner is not rounded. @@ -336,8 +336,8 @@ The bottom-left corner's radius. If ``0``, the corner is not rounded. .. rst-class:: classref-property-setget -- void **set_corner_radius** **(** :ref:`Corner` corner, :ref:`int` radius **)** -- :ref:`int` **get_corner_radius** **(** :ref:`Corner` corner **)** |const| +- |void| **set_corner_radius**\ (\ corner\: :ref:`Corner`, radius\: :ref:`int`\ ) +- :ref:`int` **get_corner_radius**\ (\ corner\: :ref:`Corner`\ ) |const| The bottom-right corner's radius. If ``0``, the corner is not rounded. @@ -353,8 +353,8 @@ The bottom-right corner's radius. If ``0``, the corner is not rounded. .. rst-class:: classref-property-setget -- void **set_corner_radius** **(** :ref:`Corner` corner, :ref:`int` radius **)** -- :ref:`int` **get_corner_radius** **(** :ref:`Corner` corner **)** |const| +- |void| **set_corner_radius**\ (\ corner\: :ref:`Corner`, radius\: :ref:`int`\ ) +- :ref:`int` **get_corner_radius**\ (\ corner\: :ref:`Corner`\ ) |const| The top-left corner's radius. If ``0``, the corner is not rounded. @@ -370,8 +370,8 @@ The top-left corner's radius. If ``0``, the corner is not rounded. .. rst-class:: classref-property-setget -- void **set_corner_radius** **(** :ref:`Corner` corner, :ref:`int` radius **)** -- :ref:`int` **get_corner_radius** **(** :ref:`Corner` corner **)** |const| +- |void| **set_corner_radius**\ (\ corner\: :ref:`Corner`, radius\: :ref:`int`\ ) +- :ref:`int` **get_corner_radius**\ (\ corner\: :ref:`Corner`\ ) |const| The top-right corner's radius. If ``0``, the corner is not rounded. @@ -387,8 +387,8 @@ The top-right corner's radius. If ``0``, the corner is not rounded. .. rst-class:: classref-property-setget -- void **set_draw_center** **(** :ref:`bool` value **)** -- :ref:`bool` **is_draw_center_enabled** **(** **)** +- |void| **set_draw_center**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_draw_center_enabled**\ (\ ) Toggles drawing of the inner part of the stylebox. @@ -404,8 +404,8 @@ Toggles drawing of the inner part of the stylebox. .. rst-class:: classref-property-setget -- void **set_expand_margin** **(** :ref:`Side` margin, :ref:`float` size **)** -- :ref:`float` **get_expand_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) +- :ref:`float` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| Expands the stylebox outside of the control rect on the bottom edge. Useful in combination with :ref:`border_width_bottom` to draw a border outside the control rect. @@ -423,8 +423,8 @@ Expands the stylebox outside of the control rect on the bottom edge. Useful in c .. rst-class:: classref-property-setget -- void **set_expand_margin** **(** :ref:`Side` margin, :ref:`float` size **)** -- :ref:`float` **get_expand_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) +- :ref:`float` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| Expands the stylebox outside of the control rect on the left edge. Useful in combination with :ref:`border_width_left` to draw a border outside the control rect. @@ -442,8 +442,8 @@ Expands the stylebox outside of the control rect on the left edge. Useful in com .. rst-class:: classref-property-setget -- void **set_expand_margin** **(** :ref:`Side` margin, :ref:`float` size **)** -- :ref:`float` **get_expand_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) +- :ref:`float` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| Expands the stylebox outside of the control rect on the right edge. Useful in combination with :ref:`border_width_right` to draw a border outside the control rect. @@ -461,8 +461,8 @@ Expands the stylebox outside of the control rect on the right edge. Useful in co .. rst-class:: classref-property-setget -- void **set_expand_margin** **(** :ref:`Side` margin, :ref:`float` size **)** -- :ref:`float` **get_expand_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) +- :ref:`float` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| Expands the stylebox outside of the control rect on the top edge. Useful in combination with :ref:`border_width_top` to draw a border outside the control rect. @@ -480,8 +480,8 @@ Expands the stylebox outside of the control rect on the top edge. Useful in comb .. rst-class:: classref-property-setget -- void **set_shadow_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_shadow_color** **(** **)** +- |void| **set_shadow_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_shadow_color**\ (\ ) The color of the shadow. This has no effect if :ref:`shadow_size` is lower than 1. @@ -497,8 +497,8 @@ The color of the shadow. This has no effect if :ref:`shadow_size` value **)** -- :ref:`Vector2` **get_shadow_offset** **(** **)** +- |void| **set_shadow_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_shadow_offset**\ (\ ) The shadow offset in pixels. Adjusts the position of the shadow relatively to the stylebox. @@ -514,8 +514,8 @@ The shadow offset in pixels. Adjusts the position of the shadow relatively to th .. rst-class:: classref-property-setget -- void **set_shadow_size** **(** :ref:`int` value **)** -- :ref:`int` **get_shadow_size** **(** **)** +- |void| **set_shadow_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_shadow_size**\ (\ ) The shadow size in pixels. @@ -531,8 +531,8 @@ The shadow size in pixels. .. rst-class:: classref-property-setget -- void **set_skew** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_skew** **(** **)** +- |void| **set_skew**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_skew**\ (\ ) If set to a non-zero value on either axis, :ref:`skew` distorts the StyleBox horizontally and/or vertically. This can be used for "futuristic"-style UIs. Positive values skew the StyleBox towards the right (X axis) and upwards (Y axis), while negative values skew the StyleBox towards the left (X axis) and downwards (Y axis). @@ -551,7 +551,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_border_width** **(** :ref:`Side` margin **)** |const| +:ref:`int` **get_border_width**\ (\ margin\: :ref:`Side`\ ) |const| Returns the specified :ref:`Side`'s border width. @@ -563,7 +563,7 @@ Returns the specified :ref:`Side`'s border width. .. rst-class:: classref-method -:ref:`int` **get_border_width_min** **(** **)** |const| +:ref:`int` **get_border_width_min**\ (\ ) |const| Returns the smallest border width out of all four borders. @@ -575,7 +575,7 @@ Returns the smallest border width out of all four borders. .. rst-class:: classref-method -:ref:`int` **get_corner_radius** **(** :ref:`Corner` corner **)** |const| +:ref:`int` **get_corner_radius**\ (\ corner\: :ref:`Corner`\ ) |const| Returns the given ``corner``'s radius. See :ref:`Corner` for possible values. @@ -587,7 +587,7 @@ Returns the given ``corner``'s radius. See :ref:`Corner` **get_expand_margin** **(** :ref:`Side` margin **)** |const| +:ref:`float` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| Returns the size of the specified :ref:`Side`'s expand margin. @@ -599,7 +599,7 @@ Returns the size of the specified :ref:`Side`'s expand m .. rst-class:: classref-method -void **set_border_width** **(** :ref:`Side` margin, :ref:`int` width **)** +|void| **set_border_width**\ (\ margin\: :ref:`Side`, width\: :ref:`int`\ ) Sets the specified :ref:`Side`'s border width to ``width`` pixels. @@ -611,7 +611,7 @@ Sets the specified :ref:`Side`'s border width to ``width .. rst-class:: classref-method -void **set_border_width_all** **(** :ref:`int` width **)** +|void| **set_border_width_all**\ (\ width\: :ref:`int`\ ) Sets the border width to ``width`` pixels for all sides. @@ -623,7 +623,7 @@ Sets the border width to ``width`` pixels for all sides. .. rst-class:: classref-method -void **set_corner_radius** **(** :ref:`Corner` corner, :ref:`int` radius **)** +|void| **set_corner_radius**\ (\ corner\: :ref:`Corner`, radius\: :ref:`int`\ ) Sets the corner radius to ``radius`` pixels for the given ``corner``. See :ref:`Corner` for possible values. @@ -635,7 +635,7 @@ Sets the corner radius to ``radius`` pixels for the given ``corner``. See :ref:` .. rst-class:: classref-method -void **set_corner_radius_all** **(** :ref:`int` radius **)** +|void| **set_corner_radius_all**\ (\ radius\: :ref:`int`\ ) Sets the corner radius to ``radius`` pixels for all corners. @@ -647,7 +647,7 @@ Sets the corner radius to ``radius`` pixels for all corners. .. rst-class:: classref-method -void **set_expand_margin** **(** :ref:`Side` margin, :ref:`float` size **)** +|void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) Sets the expand margin to ``size`` pixels for the specified :ref:`Side`. @@ -659,7 +659,7 @@ Sets the expand margin to ``size`` pixels for the specified :ref:`Side` size **)** +|void| **set_expand_margin_all**\ (\ size\: :ref:`float`\ ) Sets the expand margin to ``size`` pixels for all sides. @@ -670,3 +670,4 @@ Sets the expand margin to ``size`` pixels for all sides. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_styleboxline.rst b/classes/class_styleboxline.rst index 6e39da7d8c9..888e7711126 100644 --- a/classes/class_styleboxline.rst +++ b/classes/class_styleboxline.rst @@ -58,8 +58,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_color** **(** :ref:`Color` value **)** -- :ref:`Color` **get_color** **(** **)** +- |void| **set_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_color**\ (\ ) The line's color. @@ -75,8 +75,8 @@ The line's color. .. rst-class:: classref-property-setget -- void **set_grow_begin** **(** :ref:`float` value **)** -- :ref:`float` **get_grow_begin** **(** **)** +- |void| **set_grow_begin**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_grow_begin**\ (\ ) The number of pixels the line will extend before the **StyleBoxLine**'s bounds. If set to a negative value, the line will begin inside the **StyleBoxLine**'s bounds. @@ -92,8 +92,8 @@ The number of pixels the line will extend before the **StyleBoxLine**'s bounds. .. rst-class:: classref-property-setget -- void **set_grow_end** **(** :ref:`float` value **)** -- :ref:`float` **get_grow_end** **(** **)** +- |void| **set_grow_end**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_grow_end**\ (\ ) The number of pixels the line will extend past the **StyleBoxLine**'s bounds. If set to a negative value, the line will end inside the **StyleBoxLine**'s bounds. @@ -109,8 +109,8 @@ The number of pixels the line will extend past the **StyleBoxLine**'s bounds. If .. rst-class:: classref-property-setget -- void **set_thickness** **(** :ref:`int` value **)** -- :ref:`int` **get_thickness** **(** **)** +- |void| **set_thickness**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_thickness**\ (\ ) The line's thickness in pixels. @@ -126,8 +126,8 @@ The line's thickness in pixels. .. rst-class:: classref-property-setget -- void **set_vertical** **(** :ref:`bool` value **)** -- :ref:`bool` **is_vertical** **(** **)** +- |void| **set_vertical**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_vertical**\ (\ ) If ``true``, the line will be vertical. If ``false``, the line will be horizontal. @@ -138,3 +138,4 @@ If ``true``, the line will be vertical. If ``false``, the line will be horizonta .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index 8e8749cedc2..a3b0757179f 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -67,19 +67,19 @@ Methods .. table:: :widths: auto - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_expand_margin` **(** :ref:`Side` margin **)** |const| | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_texture_margin` **(** :ref:`Side` margin **)** |const| | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_expand_margin` **(** :ref:`Side` margin, :ref:`float` size **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_texture_margin` **(** :ref:`Side` margin, :ref:`float` size **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_texture_margin_all` **(** :ref:`float` size **)** | - +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_expand_margin`\ (\ margin\: :ref:`Side`\ ) |const| | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_texture_margin`\ (\ margin\: :ref:`Side`\ ) |const| | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_expand_margin`\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_expand_margin_all`\ (\ size\: :ref:`float`\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_texture_margin`\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_texture_margin_all`\ (\ size\: :ref:`float`\ ) | + +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -137,8 +137,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_h_axis_stretch_mode** **(** :ref:`AxisStretchMode` value **)** -- :ref:`AxisStretchMode` **get_h_axis_stretch_mode** **(** **)** +- |void| **set_h_axis_stretch_mode**\ (\ value\: :ref:`AxisStretchMode`\ ) +- :ref:`AxisStretchMode` **get_h_axis_stretch_mode**\ (\ ) Controls how the stylebox's texture will be stretched or tiled horizontally. See :ref:`AxisStretchMode` for possible values. @@ -154,8 +154,8 @@ Controls how the stylebox's texture will be stretched or tiled horizontally. See .. rst-class:: classref-property-setget -- void **set_v_axis_stretch_mode** **(** :ref:`AxisStretchMode` value **)** -- :ref:`AxisStretchMode` **get_v_axis_stretch_mode** **(** **)** +- |void| **set_v_axis_stretch_mode**\ (\ value\: :ref:`AxisStretchMode`\ ) +- :ref:`AxisStretchMode` **get_v_axis_stretch_mode**\ (\ ) Controls how the stylebox's texture will be stretched or tiled vertically. See :ref:`AxisStretchMode` for possible values. @@ -171,8 +171,8 @@ Controls how the stylebox's texture will be stretched or tiled vertically. See : .. rst-class:: classref-property-setget -- void **set_draw_center** **(** :ref:`bool` value **)** -- :ref:`bool` **is_draw_center_enabled** **(** **)** +- |void| **set_draw_center**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_draw_center_enabled**\ (\ ) If ``true``, the nine-patch texture's center tile will be drawn. @@ -188,8 +188,8 @@ If ``true``, the nine-patch texture's center tile will be drawn. .. rst-class:: classref-property-setget -- void **set_expand_margin** **(** :ref:`Side` margin, :ref:`float` size **)** -- :ref:`float` **get_expand_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) +- :ref:`float` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| Expands the bottom margin of this style box when drawing, causing it to be drawn larger than requested. @@ -205,8 +205,8 @@ Expands the bottom margin of this style box when drawing, causing it to be drawn .. rst-class:: classref-property-setget -- void **set_expand_margin** **(** :ref:`Side` margin, :ref:`float` size **)** -- :ref:`float` **get_expand_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) +- :ref:`float` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| Expands the left margin of this style box when drawing, causing it to be drawn larger than requested. @@ -222,8 +222,8 @@ Expands the left margin of this style box when drawing, causing it to be drawn l .. rst-class:: classref-property-setget -- void **set_expand_margin** **(** :ref:`Side` margin, :ref:`float` size **)** -- :ref:`float` **get_expand_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) +- :ref:`float` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| Expands the right margin of this style box when drawing, causing it to be drawn larger than requested. @@ -239,8 +239,8 @@ Expands the right margin of this style box when drawing, causing it to be drawn .. rst-class:: classref-property-setget -- void **set_expand_margin** **(** :ref:`Side` margin, :ref:`float` size **)** -- :ref:`float` **get_expand_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) +- :ref:`float` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| Expands the top margin of this style box when drawing, causing it to be drawn larger than requested. @@ -256,8 +256,8 @@ Expands the top margin of this style box when drawing, causing it to be drawn la .. rst-class:: classref-property-setget -- void **set_modulate** **(** :ref:`Color` value **)** -- :ref:`Color` **get_modulate** **(** **)** +- |void| **set_modulate**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_modulate**\ (\ ) Modulates the color of the texture when this style box is drawn. @@ -273,8 +273,8 @@ Modulates the color of the texture when this style box is drawn. .. rst-class:: classref-property-setget -- void **set_region_rect** **(** :ref:`Rect2` value **)** -- :ref:`Rect2` **get_region_rect** **(** **)** +- |void| **set_region_rect**\ (\ value\: :ref:`Rect2`\ ) +- :ref:`Rect2` **get_region_rect**\ (\ ) Species a sub-region of the texture to use. @@ -294,8 +294,8 @@ If empty (``Rect2(0, 0, 0, 0)``), the whole texture will be used. .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ ) The texture to use when drawing this style box. @@ -311,8 +311,8 @@ The texture to use when drawing this style box. .. rst-class:: classref-property-setget -- void **set_texture_margin** **(** :ref:`Side` margin, :ref:`float` size **)** -- :ref:`float` **get_texture_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_texture_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) +- :ref:`float` **get_texture_margin**\ (\ margin\: :ref:`Side`\ ) |const| Increases the bottom margin of the 3×3 texture box. @@ -332,8 +332,8 @@ This is also the value used as fallback for :ref:`StyleBox.content_margin_bottom .. rst-class:: classref-property-setget -- void **set_texture_margin** **(** :ref:`Side` margin, :ref:`float` size **)** -- :ref:`float` **get_texture_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_texture_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) +- :ref:`float` **get_texture_margin**\ (\ margin\: :ref:`Side`\ ) |const| Increases the left margin of the 3×3 texture box. @@ -353,8 +353,8 @@ This is also the value used as fallback for :ref:`StyleBox.content_margin_left` margin, :ref:`float` size **)** -- :ref:`float` **get_texture_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_texture_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) +- :ref:`float` **get_texture_margin**\ (\ margin\: :ref:`Side`\ ) |const| Increases the right margin of the 3×3 texture box. @@ -374,8 +374,8 @@ This is also the value used as fallback for :ref:`StyleBox.content_margin_right< .. rst-class:: classref-property-setget -- void **set_texture_margin** **(** :ref:`Side` margin, :ref:`float` size **)** -- :ref:`float` **get_texture_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_texture_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) +- :ref:`float` **get_texture_margin**\ (\ margin\: :ref:`Side`\ ) |const| Increases the top margin of the 3×3 texture box. @@ -396,7 +396,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_expand_margin** **(** :ref:`Side` margin **)** |const| +:ref:`float` **get_expand_margin**\ (\ margin\: :ref:`Side`\ ) |const| Returns the expand margin size of the specified :ref:`Side`. @@ -408,7 +408,7 @@ Returns the expand margin size of the specified :ref:`Side` **get_texture_margin** **(** :ref:`Side` margin **)** |const| +:ref:`float` **get_texture_margin**\ (\ margin\: :ref:`Side`\ ) |const| Returns the margin size of the specified :ref:`Side`. @@ -420,7 +420,7 @@ Returns the margin size of the specified :ref:`Side`. .. rst-class:: classref-method -void **set_expand_margin** **(** :ref:`Side` margin, :ref:`float` size **)** +|void| **set_expand_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) Sets the expand margin to ``size`` pixels for the specified :ref:`Side`. @@ -432,7 +432,7 @@ Sets the expand margin to ``size`` pixels for the specified :ref:`Side` size **)** +|void| **set_expand_margin_all**\ (\ size\: :ref:`float`\ ) Sets the expand margin to ``size`` pixels for all sides. @@ -444,7 +444,7 @@ Sets the expand margin to ``size`` pixels for all sides. .. rst-class:: classref-method -void **set_texture_margin** **(** :ref:`Side` margin, :ref:`float` size **)** +|void| **set_texture_margin**\ (\ margin\: :ref:`Side`, size\: :ref:`float`\ ) Sets the margin to ``size`` pixels for the specified :ref:`Side`. @@ -456,7 +456,7 @@ Sets the margin to ``size`` pixels for the specified :ref:`Side` size **)** +|void| **set_texture_margin_all**\ (\ size\: :ref:`float`\ ) Sets the margin to ``size`` pixels for all sides. @@ -467,3 +467,4 @@ Sets the margin to ``size`` pixels for all sides. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_subviewport.rst b/classes/class_subviewport.rst index 890a7a73acb..048fb291b97 100644 --- a/classes/class_subviewport.rst +++ b/classes/class_subviewport.rst @@ -170,8 +170,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_clear_mode** **(** :ref:`ClearMode` value **)** -- :ref:`ClearMode` **get_clear_mode** **(** **)** +- |void| **set_clear_mode**\ (\ value\: :ref:`ClearMode`\ ) +- :ref:`ClearMode` **get_clear_mode**\ (\ ) The clear mode when the sub-viewport is used as a render target. @@ -189,8 +189,8 @@ The clear mode when the sub-viewport is used as a render target. .. rst-class:: classref-property-setget -- void **set_update_mode** **(** :ref:`UpdateMode` value **)** -- :ref:`UpdateMode` **get_update_mode** **(** **)** +- |void| **set_update_mode**\ (\ value\: :ref:`UpdateMode`\ ) +- :ref:`UpdateMode` **get_update_mode**\ (\ ) The update mode when the sub-viewport is used as a render target. @@ -206,8 +206,8 @@ The update mode when the sub-viewport is used as a render target. .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`Vector2i` value **)** -- :ref:`Vector2i` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_size**\ (\ ) The width and height of the sub-viewport. Must be set to a value greater than or equal to 2 pixels on both dimensions. Otherwise, nothing will be displayed. @@ -225,8 +225,8 @@ The width and height of the sub-viewport. Must be set to a value greater than or .. rst-class:: classref-property-setget -- void **set_size_2d_override** **(** :ref:`Vector2i` value **)** -- :ref:`Vector2i` **get_size_2d_override** **(** **)** +- |void| **set_size_2d_override**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_size_2d_override**\ (\ ) The 2D size override of the sub-viewport. If either the width or height is ``0``, the override is disabled. @@ -242,8 +242,8 @@ The 2D size override of the sub-viewport. If either the width or height is ``0`` .. rst-class:: classref-property-setget -- void **set_size_2d_override_stretch** **(** :ref:`bool` value **)** -- :ref:`bool` **is_size_2d_override_stretch_enabled** **(** **)** +- |void| **set_size_2d_override_stretch**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_size_2d_override_stretch_enabled**\ (\ ) If ``true``, the 2D size override affects stretch as well. @@ -254,3 +254,4 @@ If ``true``, the 2D size override affects stretch as well. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_subviewportcontainer.rst b/classes/class_subviewportcontainer.rst index a356227552a..3499e89508f 100644 --- a/classes/class_subviewportcontainer.rst +++ b/classes/class_subviewportcontainer.rst @@ -49,9 +49,9 @@ Methods .. table:: :widths: auto - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_propagate_input_event` **(** :ref:`InputEvent` event **)** |virtual| |const| | - +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_propagate_input_event`\ (\ event\: :ref:`InputEvent`\ ) |virtual| |const| | + +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -70,8 +70,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_stretch** **(** :ref:`bool` value **)** -- :ref:`bool` **is_stretch_enabled** **(** **)** +- |void| **set_stretch**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_stretch_enabled**\ (\ ) If ``true``, the sub-viewport will be automatically resized to the control's size. @@ -89,8 +89,8 @@ If ``true``, the sub-viewport will be automatically resized to the control's siz .. rst-class:: classref-property-setget -- void **set_stretch_shrink** **(** :ref:`int` value **)** -- :ref:`int` **get_stretch_shrink** **(** **)** +- |void| **set_stretch_shrink**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_stretch_shrink**\ (\ ) Divides the sub-viewport's effective resolution by this value while preserving its scale. This can be used to speed up rendering. @@ -111,7 +111,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **_propagate_input_event** **(** :ref:`InputEvent` event **)** |virtual| |const| +:ref:`bool` **_propagate_input_event**\ (\ event\: :ref:`InputEvent`\ ) |virtual| |const| **Experimental:** This method may be changed or removed in future versions. @@ -124,3 +124,4 @@ Virtual method to be implemented by the user. If it returns ``true``, the ``even .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index 9a7e44d4e67..c135c29b7cd 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -69,71 +69,71 @@ Methods .. table:: :widths: auto - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_index` **(** :ref:`int` index **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_triangle_fan` **(** :ref:`PackedVector3Array` vertices, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`PackedColorArray` colors=PackedColorArray(), :ref:`PackedVector2Array` uv2s=PackedVector2Array(), :ref:`PackedVector3Array` normals=PackedVector3Array(), :ref:`Plane[]` tangents=[] **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_vertex` **(** :ref:`Vector3` vertex **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`append_from` **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform3D` transform **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`begin` **(** :ref:`PrimitiveType` primitive **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ArrayMesh` | :ref:`commit` **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=0 **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`commit_to_arrays` **(** **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_from` **(** :ref:`Mesh` existing, :ref:`int` surface **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_from_blend_shape` **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`String` blend_shape **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`deindex` **(** **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`generate_lod` **(** :ref:`float` nd_threshold, :ref:`int` target_index_count=3 **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`generate_normals` **(** :ref:`bool` flip=false **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`generate_tangents` **(** **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`get_aabb` **(** **)** |const| | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`CustomFormat` | :ref:`get_custom_format` **(** :ref:`int` channel_index **)** |const| | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PrimitiveType` | :ref:`get_primitive_type` **(** **)** |const| | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SkinWeightCount` | :ref:`get_skin_weight_count` **(** **)** |const| | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`index` **(** **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`optimize_indices_for_cache` **(** **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bones` **(** :ref:`PackedInt32Array` bones **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_color` **(** :ref:`Color` color **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_custom` **(** :ref:`int` channel_index, :ref:`Color` custom_color **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_custom_format` **(** :ref:`int` channel_index, :ref:`CustomFormat` format **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_material` **(** :ref:`Material` material **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_normal` **(** :ref:`Vector3` normal **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_skin_weight_count` **(** :ref:`SkinWeightCount` count **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_smooth_group` **(** :ref:`int` index **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tangent` **(** :ref:`Plane` tangent **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_uv` **(** :ref:`Vector2` uv **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_uv2` **(** :ref:`Vector2` uv2 **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_weights` **(** :ref:`PackedFloat32Array` weights **)** | - +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_index`\ (\ index\: :ref:`int`\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_triangle_fan`\ (\ vertices\: :ref:`PackedVector3Array`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), colors\: :ref:`PackedColorArray` = PackedColorArray(), uv2s\: :ref:`PackedVector2Array` = PackedVector2Array(), normals\: :ref:`PackedVector3Array` = PackedVector3Array(), tangents\: :ref:`Array`\[:ref:`Plane`\] = []\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_vertex`\ (\ vertex\: :ref:`Vector3`\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`append_from`\ (\ existing\: :ref:`Mesh`, surface\: :ref:`int`, transform\: :ref:`Transform3D`\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`begin`\ (\ primitive\: :ref:`PrimitiveType`\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ArrayMesh` | :ref:`commit`\ (\ existing\: :ref:`ArrayMesh` = null, flags\: :ref:`int` = 0\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`commit_to_arrays`\ (\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_from`\ (\ existing\: :ref:`Mesh`, surface\: :ref:`int`\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_from_blend_shape`\ (\ existing\: :ref:`Mesh`, surface\: :ref:`int`, blend_shape\: :ref:`String`\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`deindex`\ (\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`generate_lod`\ (\ nd_threshold\: :ref:`float`, target_index_count\: :ref:`int` = 3\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`generate_normals`\ (\ flip\: :ref:`bool` = false\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`generate_tangents`\ (\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`get_aabb`\ (\ ) |const| | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CustomFormat` | :ref:`get_custom_format`\ (\ channel_index\: :ref:`int`\ ) |const| | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PrimitiveType` | :ref:`get_primitive_type`\ (\ ) |const| | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SkinWeightCount` | :ref:`get_skin_weight_count`\ (\ ) |const| | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`index`\ (\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`optimize_indices_for_cache`\ (\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bones`\ (\ bones\: :ref:`PackedInt32Array`\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_color`\ (\ color\: :ref:`Color`\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom`\ (\ channel_index\: :ref:`int`, custom_color\: :ref:`Color`\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_format`\ (\ channel_index\: :ref:`int`, format\: :ref:`CustomFormat`\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_material`\ (\ material\: :ref:`Material`\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_normal`\ (\ normal\: :ref:`Vector3`\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_skin_weight_count`\ (\ count\: :ref:`SkinWeightCount`\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_smooth_group`\ (\ index\: :ref:`int`\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tangent`\ (\ tangent\: :ref:`Plane`\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_uv`\ (\ uv\: :ref:`Vector2`\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_uv2`\ (\ uv2\: :ref:`Vector2`\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_weights`\ (\ weights\: :ref:`PackedFloat32Array`\ ) | + +----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -261,7 +261,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_index** **(** :ref:`int` index **)** +|void| **add_index**\ (\ index\: :ref:`int`\ ) Adds a vertex to index array if you are using indexed vertices. Does not need to be called before adding vertices. @@ -273,7 +273,7 @@ Adds a vertex to index array if you are using indexed vertices. Does not need to .. rst-class:: classref-method -void **add_triangle_fan** **(** :ref:`PackedVector3Array` vertices, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`PackedColorArray` colors=PackedColorArray(), :ref:`PackedVector2Array` uv2s=PackedVector2Array(), :ref:`PackedVector3Array` normals=PackedVector3Array(), :ref:`Plane[]` tangents=[] **)** +|void| **add_triangle_fan**\ (\ vertices\: :ref:`PackedVector3Array`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), colors\: :ref:`PackedColorArray` = PackedColorArray(), uv2s\: :ref:`PackedVector2Array` = PackedVector2Array(), normals\: :ref:`PackedVector3Array` = PackedVector3Array(), tangents\: :ref:`Array`\[:ref:`Plane`\] = []\ ) Inserts a triangle fan made of array data into :ref:`Mesh` being constructed. @@ -287,7 +287,7 @@ Requires the primitive type be set to :ref:`Mesh.PRIMITIVE_TRIANGLES` vertex **)** +|void| **add_vertex**\ (\ vertex\: :ref:`Vector3`\ ) Specifies the position of current vertex. Should be called after specifying other vertex properties (e.g. Color, UV). @@ -299,7 +299,7 @@ Specifies the position of current vertex. Should be called after specifying othe .. rst-class:: classref-method -void **append_from** **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform3D` transform **)** +|void| **append_from**\ (\ existing\: :ref:`Mesh`, surface\: :ref:`int`, transform\: :ref:`Transform3D`\ ) Append vertices from a given :ref:`Mesh` surface onto the current vertex array with specified :ref:`Transform3D`. @@ -311,7 +311,7 @@ Append vertices from a given :ref:`Mesh` surface onto the current ve .. rst-class:: classref-method -void **begin** **(** :ref:`PrimitiveType` primitive **)** +|void| **begin**\ (\ primitive\: :ref:`PrimitiveType`\ ) Called before adding any vertices. Takes the primitive type as an argument (e.g. :ref:`Mesh.PRIMITIVE_TRIANGLES`). @@ -323,7 +323,7 @@ Called before adding any vertices. Takes the primitive type as an argument (e.g. .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clear all information passed into the surface tool so far. @@ -335,7 +335,7 @@ Clear all information passed into the surface tool so far. .. rst-class:: classref-method -:ref:`ArrayMesh` **commit** **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=0 **)** +:ref:`ArrayMesh` **commit**\ (\ existing\: :ref:`ArrayMesh` = null, flags\: :ref:`int` = 0\ ) Returns a constructed :ref:`ArrayMesh` from current information passed in. If an existing :ref:`ArrayMesh` is passed in as an argument, will add an extra surface to the existing :ref:`ArrayMesh`. @@ -349,7 +349,7 @@ Returns a constructed :ref:`ArrayMesh` from current information .. rst-class:: classref-method -:ref:`Array` **commit_to_arrays** **(** **)** +:ref:`Array` **commit_to_arrays**\ (\ ) Commits the data to the same format used by :ref:`ArrayMesh.add_surface_from_arrays`. This way you can further process the mesh data using the :ref:`ArrayMesh` API. @@ -361,7 +361,7 @@ Commits the data to the same format used by :ref:`ArrayMesh.add_surface_from_arr .. rst-class:: classref-method -void **create_from** **(** :ref:`Mesh` existing, :ref:`int` surface **)** +|void| **create_from**\ (\ existing\: :ref:`Mesh`, surface\: :ref:`int`\ ) Creates a vertex array from an existing :ref:`Mesh`. @@ -373,7 +373,7 @@ Creates a vertex array from an existing :ref:`Mesh`. .. rst-class:: classref-method -void **create_from_blend_shape** **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`String` blend_shape **)** +|void| **create_from_blend_shape**\ (\ existing\: :ref:`Mesh`, surface\: :ref:`int`, blend_shape\: :ref:`String`\ ) Creates a vertex array from the specified blend shape of an existing :ref:`Mesh`. This can be used to extract a specific pose from a blend shape. @@ -385,7 +385,7 @@ Creates a vertex array from the specified blend shape of an existing :ref:`Mesh< .. rst-class:: classref-method -void **deindex** **(** **)** +|void| **deindex**\ (\ ) Removes the index array by expanding the vertex array. @@ -397,9 +397,9 @@ Removes the index array by expanding the vertex array. .. rst-class:: classref-method -:ref:`PackedInt32Array` **generate_lod** **(** :ref:`float` nd_threshold, :ref:`int` target_index_count=3 **)** +:ref:`PackedInt32Array` **generate_lod**\ (\ nd_threshold\: :ref:`float`, target_index_count\: :ref:`int` = 3\ ) -**Deprecated:** Unused internally and fails to preserve normals or UVs. Consider using :ref:`ImporterMesh.generate_lods` instead. +**Deprecated:** This method is unused internally, as it does not preserve normals or UVs. Consider using :ref:`ImporterMesh.generate_lods` instead. Generates a LOD for a given ``nd_threshold`` in linear units (square root of quadric error metric), using at most ``target_index_count`` indices. @@ -411,7 +411,7 @@ Generates a LOD for a given ``nd_threshold`` in linear units (square root of qua .. rst-class:: classref-method -void **generate_normals** **(** :ref:`bool` flip=false **)** +|void| **generate_normals**\ (\ flip\: :ref:`bool` = false\ ) Generates normals from vertices so you do not have to do it manually. If ``flip`` is ``true``, the resulting normals will be inverted. :ref:`generate_normals` should be called *after* generating geometry and *before* committing the mesh using :ref:`commit` or :ref:`commit_to_arrays`. For correct display of normal-mapped surfaces, you will also have to generate tangents using :ref:`generate_tangents`. @@ -427,7 +427,7 @@ Generates normals from vertices so you do not have to do it manually. If ``flip` .. rst-class:: classref-method -void **generate_tangents** **(** **)** +|void| **generate_tangents**\ (\ ) Generates a tangent vector for each vertex. Requires that each vertex have UVs and normals set already (see :ref:`generate_normals`). @@ -439,7 +439,7 @@ Generates a tangent vector for each vertex. Requires that each vertex have UVs a .. rst-class:: classref-method -:ref:`AABB` **get_aabb** **(** **)** |const| +:ref:`AABB` **get_aabb**\ (\ ) |const| Returns the axis-aligned bounding box of the vertex positions. @@ -451,7 +451,7 @@ Returns the axis-aligned bounding box of the vertex positions. .. rst-class:: classref-method -:ref:`CustomFormat` **get_custom_format** **(** :ref:`int` channel_index **)** |const| +:ref:`CustomFormat` **get_custom_format**\ (\ channel_index\: :ref:`int`\ ) |const| Returns the format for custom ``channel_index`` (currently up to 4). Returns :ref:`CUSTOM_MAX` if this custom channel is unused. @@ -463,7 +463,7 @@ Returns the format for custom ``channel_index`` (currently up to 4). Returns :re .. rst-class:: classref-method -:ref:`PrimitiveType` **get_primitive_type** **(** **)** |const| +:ref:`PrimitiveType` **get_primitive_type**\ (\ ) |const| Returns the type of mesh geometry, such as :ref:`Mesh.PRIMITIVE_TRIANGLES`. @@ -475,7 +475,7 @@ Returns the type of mesh geometry, such as :ref:`Mesh.PRIMITIVE_TRIANGLES` **get_skin_weight_count** **(** **)** |const| +:ref:`SkinWeightCount` **get_skin_weight_count**\ (\ ) |const| By default, returns :ref:`SKIN_4_WEIGHTS` to indicate only 4 bone influences per vertex are used. @@ -491,7 +491,7 @@ Returns :ref:`SKIN_8_WEIGHTS` if up t .. rst-class:: classref-method -void **index** **(** **)** +|void| **index**\ (\ ) Shrinks the vertex array by creating an index array. This can improve performance by avoiding vertex reuse. @@ -503,7 +503,7 @@ Shrinks the vertex array by creating an index array. This can improve performanc .. rst-class:: classref-method -void **optimize_indices_for_cache** **(** **)** +|void| **optimize_indices_for_cache**\ (\ ) Optimizes triangle sorting for performance. Requires that :ref:`get_primitive_type` is :ref:`Mesh.PRIMITIVE_TRIANGLES`. @@ -515,7 +515,7 @@ Optimizes triangle sorting for performance. Requires that :ref:`get_primitive_ty .. rst-class:: classref-method -void **set_bones** **(** :ref:`PackedInt32Array` bones **)** +|void| **set_bones**\ (\ bones\: :ref:`PackedInt32Array`\ ) Specifies an array of bones to use for the *next* vertex. ``bones`` must contain 4 integers. @@ -527,7 +527,7 @@ Specifies an array of bones to use for the *next* vertex. ``bones`` must contain .. rst-class:: classref-method -void **set_color** **(** :ref:`Color` color **)** +|void| **set_color**\ (\ color\: :ref:`Color`\ ) Specifies a :ref:`Color` to use for the *next* vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. @@ -541,7 +541,7 @@ Specifies a :ref:`Color` to use for the *next* vertex. If every ver .. rst-class:: classref-method -void **set_custom** **(** :ref:`int` channel_index, :ref:`Color` custom_color **)** +|void| **set_custom**\ (\ channel_index\: :ref:`int`, custom_color\: :ref:`Color`\ ) Sets the custom value on this vertex for ``channel_index``. @@ -555,7 +555,7 @@ Sets the custom value on this vertex for ``channel_index``. .. rst-class:: classref-method -void **set_custom_format** **(** :ref:`int` channel_index, :ref:`CustomFormat` format **)** +|void| **set_custom_format**\ (\ channel_index\: :ref:`int`, format\: :ref:`CustomFormat`\ ) Sets the color format for this custom ``channel_index``. Use :ref:`CUSTOM_MAX` to disable. @@ -569,7 +569,7 @@ Must be invoked after :ref:`begin` and should be .. rst-class:: classref-method -void **set_material** **(** :ref:`Material` material **)** +|void| **set_material**\ (\ material\: :ref:`Material`\ ) Sets :ref:`Material` to be used by the :ref:`Mesh` you are constructing. @@ -581,7 +581,7 @@ Sets :ref:`Material` to be used by the :ref:`Mesh` y .. rst-class:: classref-method -void **set_normal** **(** :ref:`Vector3` normal **)** +|void| **set_normal**\ (\ normal\: :ref:`Vector3`\ ) Specifies a normal to use for the *next* vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. @@ -593,7 +593,7 @@ Specifies a normal to use for the *next* vertex. If every vertex needs to have t .. rst-class:: classref-method -void **set_skin_weight_count** **(** :ref:`SkinWeightCount` count **)** +|void| **set_skin_weight_count**\ (\ count\: :ref:`SkinWeightCount`\ ) Set to :ref:`SKIN_8_WEIGHTS` to indicate that up to 8 bone influences per vertex may be used. @@ -609,7 +609,7 @@ By default, only 4 bone influences are used (:ref:`SKIN_4_WEIGHTS` index **)** +|void| **set_smooth_group**\ (\ index\: :ref:`int`\ ) Specifies the smooth group to use for the *next* vertex. If this is never called, all vertices will have the default smooth group of ``0`` and will be smoothed with adjacent vertices of the same group. To produce a mesh with flat normals, set the smooth group to ``-1``. @@ -623,7 +623,7 @@ Specifies the smooth group to use for the *next* vertex. If this is never called .. rst-class:: classref-method -void **set_tangent** **(** :ref:`Plane` tangent **)** +|void| **set_tangent**\ (\ tangent\: :ref:`Plane`\ ) Specifies a tangent to use for the *next* vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. @@ -635,7 +635,7 @@ Specifies a tangent to use for the *next* vertex. If every vertex needs to have .. rst-class:: classref-method -void **set_uv** **(** :ref:`Vector2` uv **)** +|void| **set_uv**\ (\ uv\: :ref:`Vector2`\ ) Specifies a set of UV coordinates to use for the *next* vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. @@ -647,7 +647,7 @@ Specifies a set of UV coordinates to use for the *next* vertex. If every vertex .. rst-class:: classref-method -void **set_uv2** **(** :ref:`Vector2` uv2 **)** +|void| **set_uv2**\ (\ uv2\: :ref:`Vector2`\ ) Specifies an optional second set of UV coordinates to use for the *next* vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. @@ -659,7 +659,7 @@ Specifies an optional second set of UV coordinates to use for the *next* vertex. .. rst-class:: classref-method -void **set_weights** **(** :ref:`PackedFloat32Array` weights **)** +|void| **set_weights**\ (\ weights\: :ref:`PackedFloat32Array`\ ) Specifies weight values to use for the *next* vertex. ``weights`` must contain 4 values. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. @@ -670,3 +670,4 @@ Specifies weight values to use for the *next* vertex. ``weights`` must contain 4 .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_syntaxhighlighter.rst b/classes/class_syntaxhighlighter.rst index f73735a35cc..00628b4d7d4 100644 --- a/classes/class_syntaxhighlighter.rst +++ b/classes/class_syntaxhighlighter.rst @@ -33,21 +33,21 @@ Methods .. table:: :widths: auto - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_clear_highlighting_cache` **(** **)** |virtual| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_line_syntax_highlighting` **(** :ref:`int` line **)** |virtual| |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_update_cache` **(** **)** |virtual| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_highlighting_cache` **(** **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_line_syntax_highlighting` **(** :ref:`int` line **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TextEdit` | :ref:`get_text_edit` **(** **)** |const| | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`update_cache` **(** **)** | - +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_clear_highlighting_cache`\ (\ ) |virtual| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_line_syntax_highlighting`\ (\ line\: :ref:`int`\ ) |virtual| |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_update_cache`\ (\ ) |virtual| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_highlighting_cache`\ (\ ) | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_line_syntax_highlighting`\ (\ line\: :ref:`int`\ ) | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TextEdit` | :ref:`get_text_edit`\ (\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update_cache`\ (\ ) | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -62,7 +62,7 @@ Method Descriptions .. rst-class:: classref-method -void **_clear_highlighting_cache** **(** **)** |virtual| +|void| **_clear_highlighting_cache**\ (\ ) |virtual| Virtual method which can be overridden to clear any local caches. @@ -74,7 +74,7 @@ Virtual method which can be overridden to clear any local caches. .. rst-class:: classref-method -:ref:`Dictionary` **_get_line_syntax_highlighting** **(** :ref:`int` line **)** |virtual| |const| +:ref:`Dictionary` **_get_line_syntax_highlighting**\ (\ line\: :ref:`int`\ ) |virtual| |const| Virtual method which can be overridden to return syntax highlighting data. @@ -88,7 +88,7 @@ See :ref:`get_line_syntax_highlighting` **get_line_syntax_highlighting** **(** :ref:`int` line **)** +:ref:`Dictionary` **get_line_syntax_highlighting**\ (\ line\: :ref:`int`\ ) Returns syntax highlighting data for a single line. If the line is not cached, calls :ref:`_get_line_syntax_highlighting` to calculate the data. @@ -143,7 +143,7 @@ This will color columns 0-4 red, and columns 5-eol in green. .. rst-class:: classref-method -:ref:`TextEdit` **get_text_edit** **(** **)** |const| +:ref:`TextEdit` **get_text_edit**\ (\ ) |const| Returns the associated :ref:`TextEdit` node. @@ -155,7 +155,7 @@ Returns the associated :ref:`TextEdit` node. .. rst-class:: classref-method -void **update_cache** **(** **)** +|void| **update_cache**\ (\ ) Clears then updates the **SyntaxHighlighter** caches. Override :ref:`_update_cache` for a callback. @@ -168,3 +168,4 @@ Clears then updates the **SyntaxHighlighter** caches. Override :ref:`_update_cac .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_systemfont.rst b/classes/class_systemfont.rst index e246266d812..75caadcbee4 100644 --- a/classes/class_systemfont.rst +++ b/classes/class_systemfont.rst @@ -84,8 +84,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_allow_system_fallback** **(** :ref:`bool` value **)** -- :ref:`bool` **is_allow_system_fallback** **(** **)** +- |void| **set_allow_system_fallback**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_allow_system_fallback**\ (\ ) If set to ``true``, system fonts can be automatically used as fallbacks. @@ -101,8 +101,8 @@ If set to ``true``, system fonts can be automatically used as fallbacks. .. rst-class:: classref-property-setget -- void **set_antialiasing** **(** :ref:`FontAntialiasing` value **)** -- :ref:`FontAntialiasing` **get_antialiasing** **(** **)** +- |void| **set_antialiasing**\ (\ value\: :ref:`FontAntialiasing`\ ) +- :ref:`FontAntialiasing` **get_antialiasing**\ (\ ) Font anti-aliasing mode. @@ -118,8 +118,8 @@ Font anti-aliasing mode. .. rst-class:: classref-property-setget -- void **set_font_italic** **(** :ref:`bool` value **)** -- :ref:`bool` **get_font_italic** **(** **)** +- |void| **set_font_italic**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_font_italic**\ (\ ) If set to ``true``, italic or oblique font is preferred. @@ -135,8 +135,8 @@ If set to ``true``, italic or oblique font is preferred. .. rst-class:: classref-property-setget -- void **set_font_names** **(** :ref:`PackedStringArray` value **)** -- :ref:`PackedStringArray` **get_font_names** **(** **)** +- |void| **set_font_names**\ (\ value\: :ref:`PackedStringArray`\ ) +- :ref:`PackedStringArray` **get_font_names**\ (\ ) Array of font family names to search, first matching font found is used. @@ -152,8 +152,8 @@ Array of font family names to search, first matching font found is used. .. rst-class:: classref-property-setget -- void **set_font_stretch** **(** :ref:`int` value **)** -- :ref:`int` **get_font_stretch** **(** **)** +- |void| **set_font_stretch**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_font_stretch**\ (\ ) Preferred font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``. @@ -169,8 +169,8 @@ Preferred font stretch amount, compared to a normal width. A percentage value be .. rst-class:: classref-property-setget -- void **set_font_weight** **(** :ref:`int` value **)** -- :ref:`int` **get_font_weight** **(** **)** +- |void| **set_font_weight**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_font_weight**\ (\ ) Preferred weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``. @@ -186,8 +186,8 @@ Preferred weight (boldness) of the font. A value in the ``100...999`` range, nor .. rst-class:: classref-property-setget -- void **set_force_autohinter** **(** :ref:`bool` value **)** -- :ref:`bool` **is_force_autohinter** **(** **)** +- |void| **set_force_autohinter**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_force_autohinter**\ (\ ) If set to ``true``, auto-hinting is supported and preferred over font built-in hinting. @@ -203,8 +203,8 @@ If set to ``true``, auto-hinting is supported and preferred over font built-in h .. rst-class:: classref-property-setget -- void **set_generate_mipmaps** **(** :ref:`bool` value **)** -- :ref:`bool` **get_generate_mipmaps** **(** **)** +- |void| **set_generate_mipmaps**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_generate_mipmaps**\ (\ ) If set to ``true``, generate mipmaps for the font textures. @@ -220,8 +220,8 @@ If set to ``true``, generate mipmaps for the font textures. .. rst-class:: classref-property-setget -- void **set_hinting** **(** :ref:`Hinting` value **)** -- :ref:`Hinting` **get_hinting** **(** **)** +- |void| **set_hinting**\ (\ value\: :ref:`Hinting`\ ) +- :ref:`Hinting` **get_hinting**\ (\ ) Font hinting mode. @@ -237,8 +237,8 @@ Font hinting mode. .. rst-class:: classref-property-setget -- void **set_msdf_pixel_range** **(** :ref:`int` value **)** -- :ref:`int` **get_msdf_pixel_range** **(** **)** +- |void| **set_msdf_pixel_range**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_msdf_pixel_range**\ (\ ) The width of the range around the shape between the minimum and maximum representable signed distance. If using font outlines, :ref:`msdf_pixel_range` must be set to at least *twice* the size of the largest font outline. The default :ref:`msdf_pixel_range` value of ``16`` allows outline sizes up to ``8`` to look correct. @@ -254,8 +254,8 @@ The width of the range around the shape between the minimum and maximum represen .. rst-class:: classref-property-setget -- void **set_msdf_size** **(** :ref:`int` value **)** -- :ref:`int` **get_msdf_size** **(** **)** +- |void| **set_msdf_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_msdf_size**\ (\ ) Source font size used to generate MSDF textures. Higher values allow for more precision, but are slower to render and require more memory. Only increase this value if you notice a visible lack of precision in glyph rendering. @@ -271,8 +271,8 @@ Source font size used to generate MSDF textures. Higher values allow for more pr .. rst-class:: classref-property-setget -- void **set_multichannel_signed_distance_field** **(** :ref:`bool` value **)** -- :ref:`bool` **is_multichannel_signed_distance_field** **(** **)** +- |void| **set_multichannel_signed_distance_field**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_multichannel_signed_distance_field**\ (\ ) If set to ``true``, glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. @@ -288,8 +288,8 @@ If set to ``true``, glyphs of all sizes are rendered using single multichannel s .. rst-class:: classref-property-setget -- void **set_oversampling** **(** :ref:`float` value **)** -- :ref:`float` **get_oversampling** **(** **)** +- |void| **set_oversampling**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_oversampling**\ (\ ) Font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. @@ -305,8 +305,8 @@ Font oversampling factor, if set to ``0.0`` global oversampling factor is used i .. rst-class:: classref-property-setget -- void **set_subpixel_positioning** **(** :ref:`SubpixelPositioning` value **)** -- :ref:`SubpixelPositioning` **get_subpixel_positioning** **(** **)** +- |void| **set_subpixel_positioning**\ (\ value\: :ref:`SubpixelPositioning`\ ) +- :ref:`SubpixelPositioning` **get_subpixel_positioning**\ (\ ) Font glyph subpixel positioning mode. Subpixel positioning provides shaper text and better kerning for smaller font sizes, at the cost of memory usage and font rasterization speed. Use :ref:`TextServer.SUBPIXEL_POSITIONING_AUTO` to automatically enable it based on the font size. @@ -317,3 +317,4 @@ Font glyph subpixel positioning mode. Subpixel positioning provides shaper text .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_tabbar.rst b/classes/class_tabbar.rst index 7cd5f9db199..fab2aed319f 100644 --- a/classes/class_tabbar.rst +++ b/classes/class_tabbar.rst @@ -65,67 +65,67 @@ Methods .. table:: :widths: auto - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_tab` **(** :ref:`String` title="", :ref:`Texture2D` icon=null **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_tabs` **(** **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`ensure_tab_visible` **(** :ref:`int` idx **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_offset_buttons_visible` **(** **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_previous_tab` **(** **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_tab_button_icon` **(** :ref:`int` tab_idx **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_tab_icon_max_width` **(** :ref:`int` tab_idx **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_tab_idx_at_point` **(** :ref:`Vector2` point **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_tab_language` **(** :ref:`int` tab_idx **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_tab_metadata` **(** :ref:`int` tab_idx **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_tab_offset` **(** **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_tab_rect` **(** :ref:`int` tab_idx **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TextDirection` | :ref:`get_tab_text_direction` **(** :ref:`int` tab_idx **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_tab_disabled` **(** :ref:`int` tab_idx **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_tab_hidden` **(** :ref:`int` tab_idx **)** |const| | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_tab` **(** :ref:`int` from, :ref:`int` to **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_tab` **(** :ref:`int` tab_idx **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`select_next_available` **(** **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`select_previous_available` **(** **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_button_icon` **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_hidden` **(** :ref:`int` tab_idx, :ref:`bool` hidden **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_icon_max_width` **(** :ref:`int` tab_idx, :ref:`int` width **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_language` **(** :ref:`int` tab_idx, :ref:`String` language **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_metadata` **(** :ref:`int` tab_idx, :ref:`Variant` metadata **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_text_direction` **(** :ref:`int` tab_idx, :ref:`TextDirection` direction **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | - +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_tab`\ (\ title\: :ref:`String` = "", icon\: :ref:`Texture2D` = null\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_tabs`\ (\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`ensure_tab_visible`\ (\ idx\: :ref:`int`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_offset_buttons_visible`\ (\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_previous_tab`\ (\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_tab_button_icon`\ (\ tab_idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_tab_icon`\ (\ tab_idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tab_icon_max_width`\ (\ tab_idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tab_idx_at_point`\ (\ point\: :ref:`Vector2`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_tab_language`\ (\ tab_idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_tab_metadata`\ (\ tab_idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tab_offset`\ (\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_tab_rect`\ (\ tab_idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`get_tab_text_direction`\ (\ tab_idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_tab_title`\ (\ tab_idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_tab_disabled`\ (\ tab_idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_tab_hidden`\ (\ tab_idx\: :ref:`int`\ ) |const| | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_tab`\ (\ from\: :ref:`int`, to\: :ref:`int`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_tab`\ (\ tab_idx\: :ref:`int`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`select_next_available`\ (\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`select_previous_available`\ (\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tab_button_icon`\ (\ tab_idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tab_disabled`\ (\ tab_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tab_hidden`\ (\ tab_idx\: :ref:`int`, hidden\: :ref:`bool`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tab_icon`\ (\ tab_idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tab_icon_max_width`\ (\ tab_idx\: :ref:`int`, width\: :ref:`int`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tab_language`\ (\ tab_idx\: :ref:`int`, language\: :ref:`String`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tab_metadata`\ (\ tab_idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tab_text_direction`\ (\ tab_idx\: :ref:`int`, direction\: :ref:`TextDirection`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tab_title`\ (\ tab_idx\: :ref:`int`, title\: :ref:`String`\ ) | + +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -198,7 +198,7 @@ Signals .. rst-class:: classref-signal -**active_tab_rearranged** **(** :ref:`int` idx_to **)** +**active_tab_rearranged**\ (\ idx_to\: :ref:`int`\ ) Emitted when the active tab is rearranged via mouse drag. See :ref:`drag_to_rearrange_enabled`. @@ -210,7 +210,7 @@ Emitted when the active tab is rearranged via mouse drag. See :ref:`drag_to_rear .. rst-class:: classref-signal -**tab_button_pressed** **(** :ref:`int` tab **)** +**tab_button_pressed**\ (\ tab\: :ref:`int`\ ) Emitted when a tab's right button is pressed. See :ref:`set_tab_button_icon`. @@ -222,7 +222,7 @@ Emitted when a tab's right button is pressed. See :ref:`set_tab_button_icon` tab **)** +**tab_changed**\ (\ tab\: :ref:`int`\ ) Emitted when switching to another tab. @@ -234,7 +234,7 @@ Emitted when switching to another tab. .. rst-class:: classref-signal -**tab_clicked** **(** :ref:`int` tab **)** +**tab_clicked**\ (\ tab\: :ref:`int`\ ) Emitted when a tab is clicked, even if it is the current tab. @@ -246,7 +246,7 @@ Emitted when a tab is clicked, even if it is the current tab. .. rst-class:: classref-signal -**tab_close_pressed** **(** :ref:`int` tab **)** +**tab_close_pressed**\ (\ tab\: :ref:`int`\ ) Emitted when a tab's close button is pressed. @@ -273,7 +273,7 @@ Emitted when a tab's close button is pressed. .. rst-class:: classref-signal -**tab_hovered** **(** :ref:`int` tab **)** +**tab_hovered**\ (\ tab\: :ref:`int`\ ) Emitted when a tab is hovered by the mouse. @@ -285,7 +285,7 @@ Emitted when a tab is hovered by the mouse. .. rst-class:: classref-signal -**tab_rmb_clicked** **(** :ref:`int` tab **)** +**tab_rmb_clicked**\ (\ tab\: :ref:`int`\ ) Emitted when a tab is right-clicked. :ref:`select_with_rmb` must be enabled. @@ -297,7 +297,7 @@ Emitted when a tab is right-clicked. :ref:`select_with_rmb` tab **)** +**tab_selected**\ (\ tab\: :ref:`int`\ ) Emitted when a tab is selected via click, directional input, or script, even if it is the current tab. @@ -407,8 +407,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_clip_tabs** **(** :ref:`bool` value **)** -- :ref:`bool` **get_clip_tabs** **(** **)** +- |void| **set_clip_tabs**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_clip_tabs**\ (\ ) If ``true``, tabs overflowing this node's width will be hidden, displaying two navigation buttons instead. Otherwise, this node's minimum size is updated so that all tabs are visible. @@ -424,8 +424,8 @@ If ``true``, tabs overflowing this node's width will be hidden, displaying two n .. rst-class:: classref-property-setget -- void **set_current_tab** **(** :ref:`int` value **)** -- :ref:`int` **get_current_tab** **(** **)** +- |void| **set_current_tab**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_current_tab**\ (\ ) The index of the current selected tab. A value of ``-1`` means that no tab is selected and can only be set when :ref:`deselect_enabled` is ``true`` or if all tabs are hidden or disabled. @@ -441,8 +441,8 @@ The index of the current selected tab. A value of ``-1`` means that no tab is se .. rst-class:: classref-property-setget -- void **set_deselect_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **get_deselect_enabled** **(** **)** +- |void| **set_deselect_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_deselect_enabled**\ (\ ) If ``true``, all tabs can be deselected so that no tab is selected. Click on the current tab to deselect it. @@ -458,8 +458,8 @@ If ``true``, all tabs can be deselected so that no tab is selected. Click on the .. rst-class:: classref-property-setget -- void **set_drag_to_rearrange_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **get_drag_to_rearrange_enabled** **(** **)** +- |void| **set_drag_to_rearrange_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_drag_to_rearrange_enabled**\ (\ ) If ``true``, tabs can be rearranged with mouse drag. @@ -475,8 +475,8 @@ If ``true``, tabs can be rearranged with mouse drag. .. rst-class:: classref-property-setget -- void **set_max_tab_width** **(** :ref:`int` value **)** -- :ref:`int` **get_max_tab_width** **(** **)** +- |void| **set_max_tab_width**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_tab_width**\ (\ ) Sets the maximum width which all tabs should be limited to. Unlimited if set to ``0``. @@ -492,8 +492,8 @@ Sets the maximum width which all tabs should be limited to. Unlimited if set to .. rst-class:: classref-property-setget -- void **set_scroll_to_selected** **(** :ref:`bool` value **)** -- :ref:`bool` **get_scroll_to_selected** **(** **)** +- |void| **set_scroll_to_selected**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_scroll_to_selected**\ (\ ) If ``true``, the tab offset will be changed to keep the currently selected tab visible. @@ -509,8 +509,8 @@ If ``true``, the tab offset will be changed to keep the currently selected tab v .. rst-class:: classref-property-setget -- void **set_scrolling_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **get_scrolling_enabled** **(** **)** +- |void| **set_scrolling_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_scrolling_enabled**\ (\ ) if ``true``, the mouse's scroll wheel can be used to navigate the scroll view. @@ -526,8 +526,8 @@ if ``true``, the mouse's scroll wheel can be used to navigate the scroll view. .. rst-class:: classref-property-setget -- void **set_select_with_rmb** **(** :ref:`bool` value **)** -- :ref:`bool` **get_select_with_rmb** **(** **)** +- |void| **set_select_with_rmb**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_select_with_rmb**\ (\ ) If ``true``, enables selecting a tab with the right mouse button. @@ -543,8 +543,8 @@ If ``true``, enables selecting a tab with the right mouse button. .. rst-class:: classref-property-setget -- void **set_tab_alignment** **(** :ref:`AlignmentMode` value **)** -- :ref:`AlignmentMode` **get_tab_alignment** **(** **)** +- |void| **set_tab_alignment**\ (\ value\: :ref:`AlignmentMode`\ ) +- :ref:`AlignmentMode` **get_tab_alignment**\ (\ ) Sets the position at which tabs will be placed. See :ref:`AlignmentMode` for details. @@ -560,8 +560,8 @@ Sets the position at which tabs will be placed. See :ref:`AlignmentMode` value **)** -- :ref:`CloseButtonDisplayPolicy` **get_tab_close_display_policy** **(** **)** +- |void| **set_tab_close_display_policy**\ (\ value\: :ref:`CloseButtonDisplayPolicy`\ ) +- :ref:`CloseButtonDisplayPolicy` **get_tab_close_display_policy**\ (\ ) Sets when the close button will appear on the tabs. See :ref:`CloseButtonDisplayPolicy` for details. @@ -577,8 +577,8 @@ Sets when the close button will appear on the tabs. See :ref:`CloseButtonDisplay .. rst-class:: classref-property-setget -- void **set_tab_count** **(** :ref:`int` value **)** -- :ref:`int` **get_tab_count** **(** **)** +- |void| **set_tab_count**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_tab_count**\ (\ ) The number of tabs currently in the bar. @@ -594,8 +594,8 @@ The number of tabs currently in the bar. .. rst-class:: classref-property-setget -- void **set_tabs_rearrange_group** **(** :ref:`int` value **)** -- :ref:`int` **get_tabs_rearrange_group** **(** **)** +- |void| **set_tabs_rearrange_group**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_tabs_rearrange_group**\ (\ ) **TabBar**\ s with the same rearrange group ID will allow dragging the tabs between them. Enable drag with :ref:`drag_to_rearrange_enabled`. @@ -614,7 +614,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_tab** **(** :ref:`String` title="", :ref:`Texture2D` icon=null **)** +|void| **add_tab**\ (\ title\: :ref:`String` = "", icon\: :ref:`Texture2D` = null\ ) Adds a new tab. @@ -626,7 +626,7 @@ Adds a new tab. .. rst-class:: classref-method -void **clear_tabs** **(** **)** +|void| **clear_tabs**\ (\ ) Clears all tabs. @@ -638,7 +638,7 @@ Clears all tabs. .. rst-class:: classref-method -void **ensure_tab_visible** **(** :ref:`int` idx **)** +|void| **ensure_tab_visible**\ (\ idx\: :ref:`int`\ ) Moves the scroll view to make the tab visible. @@ -650,7 +650,7 @@ Moves the scroll view to make the tab visible. .. rst-class:: classref-method -:ref:`bool` **get_offset_buttons_visible** **(** **)** |const| +:ref:`bool` **get_offset_buttons_visible**\ (\ ) |const| Returns ``true`` if the offset buttons (the ones that appear when there's not enough space for all tabs) are visible. @@ -662,7 +662,7 @@ Returns ``true`` if the offset buttons (the ones that appear when there's not en .. rst-class:: classref-method -:ref:`int` **get_previous_tab** **(** **)** |const| +:ref:`int` **get_previous_tab**\ (\ ) |const| Returns the previously active tab index. @@ -674,7 +674,7 @@ Returns the previously active tab index. .. rst-class:: classref-method -:ref:`Texture2D` **get_tab_button_icon** **(** :ref:`int` tab_idx **)** |const| +:ref:`Texture2D` **get_tab_button_icon**\ (\ tab_idx\: :ref:`int`\ ) |const| Returns the icon for the right button of the tab at index ``tab_idx`` or ``null`` if the right button has no icon. @@ -686,7 +686,7 @@ Returns the icon for the right button of the tab at index ``tab_idx`` or ``null` .. rst-class:: classref-method -:ref:`Texture2D` **get_tab_icon** **(** :ref:`int` tab_idx **)** |const| +:ref:`Texture2D` **get_tab_icon**\ (\ tab_idx\: :ref:`int`\ ) |const| Returns the icon for the tab at index ``tab_idx`` or ``null`` if the tab has no icon. @@ -698,7 +698,7 @@ Returns the icon for the tab at index ``tab_idx`` or ``null`` if the tab has no .. rst-class:: classref-method -:ref:`int` **get_tab_icon_max_width** **(** :ref:`int` tab_idx **)** |const| +:ref:`int` **get_tab_icon_max_width**\ (\ tab_idx\: :ref:`int`\ ) |const| Returns the maximum allowed width of the icon for the tab at index ``tab_idx``. @@ -710,7 +710,7 @@ Returns the maximum allowed width of the icon for the tab at index ``tab_idx``. .. rst-class:: classref-method -:ref:`int` **get_tab_idx_at_point** **(** :ref:`Vector2` point **)** |const| +:ref:`int` **get_tab_idx_at_point**\ (\ point\: :ref:`Vector2`\ ) |const| Returns the index of the tab at local coordinates ``point``. Returns ``-1`` if the point is outside the control boundaries or if there's no tab at the queried position. @@ -722,7 +722,7 @@ Returns the index of the tab at local coordinates ``point``. Returns ``-1`` if t .. rst-class:: classref-method -:ref:`String` **get_tab_language** **(** :ref:`int` tab_idx **)** |const| +:ref:`String` **get_tab_language**\ (\ tab_idx\: :ref:`int`\ ) |const| Returns tab title language code. @@ -734,7 +734,7 @@ Returns tab title language code. .. rst-class:: classref-method -:ref:`Variant` **get_tab_metadata** **(** :ref:`int` tab_idx **)** |const| +:ref:`Variant` **get_tab_metadata**\ (\ tab_idx\: :ref:`int`\ ) |const| Returns the metadata value set to the tab at index ``tab_idx`` using :ref:`set_tab_metadata`. If no metadata was previously set, returns ``null`` by default. @@ -746,7 +746,7 @@ Returns the metadata value set to the tab at index ``tab_idx`` using :ref:`set_t .. rst-class:: classref-method -:ref:`int` **get_tab_offset** **(** **)** |const| +:ref:`int` **get_tab_offset**\ (\ ) |const| Returns the number of hidden tabs offsetted to the left. @@ -758,7 +758,7 @@ Returns the number of hidden tabs offsetted to the left. .. rst-class:: classref-method -:ref:`Rect2` **get_tab_rect** **(** :ref:`int` tab_idx **)** |const| +:ref:`Rect2` **get_tab_rect**\ (\ tab_idx\: :ref:`int`\ ) |const| Returns tab :ref:`Rect2` with local position and size. @@ -770,7 +770,7 @@ Returns tab :ref:`Rect2` with local position and size. .. rst-class:: classref-method -:ref:`TextDirection` **get_tab_text_direction** **(** :ref:`int` tab_idx **)** |const| +:ref:`TextDirection` **get_tab_text_direction**\ (\ tab_idx\: :ref:`int`\ ) |const| Returns tab title text base writing direction. @@ -782,7 +782,7 @@ Returns tab title text base writing direction. .. rst-class:: classref-method -:ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** |const| +:ref:`String` **get_tab_title**\ (\ tab_idx\: :ref:`int`\ ) |const| Returns the title of the tab at index ``tab_idx``. @@ -794,7 +794,7 @@ Returns the title of the tab at index ``tab_idx``. .. rst-class:: classref-method -:ref:`bool` **is_tab_disabled** **(** :ref:`int` tab_idx **)** |const| +:ref:`bool` **is_tab_disabled**\ (\ tab_idx\: :ref:`int`\ ) |const| Returns ``true`` if the tab at index ``tab_idx`` is disabled. @@ -806,7 +806,7 @@ Returns ``true`` if the tab at index ``tab_idx`` is disabled. .. rst-class:: classref-method -:ref:`bool` **is_tab_hidden** **(** :ref:`int` tab_idx **)** |const| +:ref:`bool` **is_tab_hidden**\ (\ tab_idx\: :ref:`int`\ ) |const| Returns ``true`` if the tab at index ``tab_idx`` is hidden. @@ -818,7 +818,7 @@ Returns ``true`` if the tab at index ``tab_idx`` is hidden. .. rst-class:: classref-method -void **move_tab** **(** :ref:`int` from, :ref:`int` to **)** +|void| **move_tab**\ (\ from\: :ref:`int`, to\: :ref:`int`\ ) Moves a tab from ``from`` to ``to``. @@ -830,7 +830,7 @@ Moves a tab from ``from`` to ``to``. .. rst-class:: classref-method -void **remove_tab** **(** :ref:`int` tab_idx **)** +|void| **remove_tab**\ (\ tab_idx\: :ref:`int`\ ) Removes the tab at index ``tab_idx``. @@ -842,7 +842,7 @@ Removes the tab at index ``tab_idx``. .. rst-class:: classref-method -:ref:`bool` **select_next_available** **(** **)** +:ref:`bool` **select_next_available**\ (\ ) Selects the first available tab with greater index than the currently selected. Returns ``true`` if tab selection changed. @@ -854,7 +854,7 @@ Selects the first available tab with greater index than the currently selected. .. rst-class:: classref-method -:ref:`bool` **select_previous_available** **(** **)** +:ref:`bool` **select_previous_available**\ (\ ) Selects the first available tab with lower index than the currently selected. Returns ``true`` if tab selection changed. @@ -866,7 +866,7 @@ Selects the first available tab with lower index than the currently selected. Re .. rst-class:: classref-method -void **set_tab_button_icon** **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** +|void| **set_tab_button_icon**\ (\ tab_idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) Sets an ``icon`` for the button of the tab at index ``tab_idx`` (located to the right, before the close button), making it visible and clickable (See :ref:`tab_button_pressed`). Giving it a ``null`` value will hide the button. @@ -878,7 +878,7 @@ Sets an ``icon`` for the button of the tab at index ``tab_idx`` (located to the .. rst-class:: classref-method -void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** +|void| **set_tab_disabled**\ (\ tab_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) If ``disabled`` is ``true``, disables the tab at index ``tab_idx``, making it non-interactable. @@ -890,7 +890,7 @@ If ``disabled`` is ``true``, disables the tab at index ``tab_idx``, making it no .. rst-class:: classref-method -void **set_tab_hidden** **(** :ref:`int` tab_idx, :ref:`bool` hidden **)** +|void| **set_tab_hidden**\ (\ tab_idx\: :ref:`int`, hidden\: :ref:`bool`\ ) If ``hidden`` is ``true``, hides the tab at index ``tab_idx``, making it disappear from the tab area. @@ -902,7 +902,7 @@ If ``hidden`` is ``true``, hides the tab at index ``tab_idx``, making it disappe .. rst-class:: classref-method -void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** +|void| **set_tab_icon**\ (\ tab_idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) Sets an ``icon`` for the tab at index ``tab_idx``. @@ -914,7 +914,7 @@ Sets an ``icon`` for the tab at index ``tab_idx``. .. rst-class:: classref-method -void **set_tab_icon_max_width** **(** :ref:`int` tab_idx, :ref:`int` width **)** +|void| **set_tab_icon_max_width**\ (\ tab_idx\: :ref:`int`, width\: :ref:`int`\ ) Sets the maximum allowed width of the icon for the tab at index ``tab_idx``. This limit is applied on top of the default size of the icon and on top of :ref:`icon_max_width`. The height is adjusted according to the icon's ratio. @@ -926,7 +926,7 @@ Sets the maximum allowed width of the icon for the tab at index ``tab_idx``. Thi .. rst-class:: classref-method -void **set_tab_language** **(** :ref:`int` tab_idx, :ref:`String` language **)** +|void| **set_tab_language**\ (\ tab_idx\: :ref:`int`, language\: :ref:`String`\ ) Sets language code of tab title used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -938,7 +938,7 @@ Sets language code of tab title used for line-breaking and text shaping algorith .. rst-class:: classref-method -void **set_tab_metadata** **(** :ref:`int` tab_idx, :ref:`Variant` metadata **)** +|void| **set_tab_metadata**\ (\ tab_idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) Sets the metadata value for the tab at index ``tab_idx``, which can be retrieved later using :ref:`get_tab_metadata`. @@ -950,7 +950,7 @@ Sets the metadata value for the tab at index ``tab_idx``, which can be retrieved .. rst-class:: classref-method -void **set_tab_text_direction** **(** :ref:`int` tab_idx, :ref:`TextDirection` direction **)** +|void| **set_tab_text_direction**\ (\ tab_idx\: :ref:`int`, direction\: :ref:`TextDirection`\ ) Sets tab title base writing direction. @@ -962,7 +962,7 @@ Sets tab title base writing direction. .. rst-class:: classref-method -void **set_tab_title** **(** :ref:`int` tab_idx, :ref:`String` title **)** +|void| **set_tab_title**\ (\ tab_idx\: :ref:`int`, title\: :ref:`String`\ ) Sets a ``title`` for the tab at index ``tab_idx``. @@ -1270,3 +1270,4 @@ The style of the other, unselected tabs. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index c56585004db..4fece69f553 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -70,53 +70,53 @@ Methods .. table:: :widths: auto - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Control` | :ref:`get_current_tab_control` **(** **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Popup` | :ref:`get_popup` **(** **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_previous_tab` **(** **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TabBar` | :ref:`get_tab_bar` **(** **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_tab_button_icon` **(** :ref:`int` tab_idx **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Control` | :ref:`get_tab_control` **(** :ref:`int` tab_idx **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_tab_count` **(** **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_tab_idx_at_point` **(** :ref:`Vector2` point **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_tab_idx_from_control` **(** :ref:`Control` control **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_tab_metadata` **(** :ref:`int` tab_idx **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_tab_disabled` **(** :ref:`int` tab_idx **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_tab_hidden` **(** :ref:`int` tab_idx **)** |const| | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`select_next_available` **(** **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`select_previous_available` **(** **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_popup` **(** :ref:`Node` popup **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_button_icon` **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_hidden` **(** :ref:`int` tab_idx, :ref:`bool` hidden **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_metadata` **(** :ref:`int` tab_idx, :ref:`Variant` metadata **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Control` | :ref:`get_current_tab_control`\ (\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Popup` | :ref:`get_popup`\ (\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_previous_tab`\ (\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TabBar` | :ref:`get_tab_bar`\ (\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_tab_button_icon`\ (\ tab_idx\: :ref:`int`\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Control` | :ref:`get_tab_control`\ (\ tab_idx\: :ref:`int`\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tab_count`\ (\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_tab_icon`\ (\ tab_idx\: :ref:`int`\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tab_idx_at_point`\ (\ point\: :ref:`Vector2`\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tab_idx_from_control`\ (\ control\: :ref:`Control`\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_tab_metadata`\ (\ tab_idx\: :ref:`int`\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_tab_title`\ (\ tab_idx\: :ref:`int`\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_tab_disabled`\ (\ tab_idx\: :ref:`int`\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_tab_hidden`\ (\ tab_idx\: :ref:`int`\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`select_next_available`\ (\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`select_previous_available`\ (\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_popup`\ (\ popup\: :ref:`Node`\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tab_button_icon`\ (\ tab_idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tab_disabled`\ (\ tab_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tab_hidden`\ (\ tab_idx\: :ref:`int`, hidden\: :ref:`bool`\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tab_icon`\ (\ tab_idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tab_metadata`\ (\ tab_idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tab_title`\ (\ tab_idx\: :ref:`int`, title\: :ref:`String`\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -193,7 +193,7 @@ Signals .. rst-class:: classref-signal -**active_tab_rearranged** **(** :ref:`int` idx_to **)** +**active_tab_rearranged**\ (\ idx_to\: :ref:`int`\ ) Emitted when the active tab is rearranged via mouse drag. See :ref:`drag_to_rearrange_enabled`. @@ -205,7 +205,7 @@ Emitted when the active tab is rearranged via mouse drag. See :ref:`drag_to_rear .. rst-class:: classref-signal -**pre_popup_pressed** **(** **)** +**pre_popup_pressed**\ (\ ) Emitted when the **TabContainer**'s :ref:`Popup` button is clicked. See :ref:`set_popup` for details. @@ -217,7 +217,7 @@ Emitted when the **TabContainer**'s :ref:`Popup` button is clicked. .. rst-class:: classref-signal -**tab_button_pressed** **(** :ref:`int` tab **)** +**tab_button_pressed**\ (\ tab\: :ref:`int`\ ) Emitted when the user clicks on the button icon on this tab. @@ -229,7 +229,7 @@ Emitted when the user clicks on the button icon on this tab. .. rst-class:: classref-signal -**tab_changed** **(** :ref:`int` tab **)** +**tab_changed**\ (\ tab\: :ref:`int`\ ) Emitted when switching to another tab. @@ -241,7 +241,7 @@ Emitted when switching to another tab. .. rst-class:: classref-signal -**tab_clicked** **(** :ref:`int` tab **)** +**tab_clicked**\ (\ tab\: :ref:`int`\ ) Emitted when a tab is clicked, even if it is the current tab. @@ -253,7 +253,7 @@ Emitted when a tab is clicked, even if it is the current tab. .. rst-class:: classref-signal -**tab_hovered** **(** :ref:`int` tab **)** +**tab_hovered**\ (\ tab\: :ref:`int`\ ) Emitted when a tab is hovered by the mouse. @@ -265,7 +265,7 @@ Emitted when a tab is hovered by the mouse. .. rst-class:: classref-signal -**tab_selected** **(** :ref:`int` tab **)** +**tab_selected**\ (\ tab\: :ref:`int`\ ) Emitted when a tab is selected via click, directional input, or script, even if it is the current tab. @@ -325,8 +325,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_all_tabs_in_front** **(** :ref:`bool` value **)** -- :ref:`bool` **is_all_tabs_in_front** **(** **)** +- |void| **set_all_tabs_in_front**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_all_tabs_in_front**\ (\ ) If ``true``, all tabs are drawn in front of the panel. If ``false``, inactive tabs are drawn behind the panel. @@ -342,8 +342,8 @@ If ``true``, all tabs are drawn in front of the panel. If ``false``, inactive ta .. rst-class:: classref-property-setget -- void **set_clip_tabs** **(** :ref:`bool` value **)** -- :ref:`bool` **get_clip_tabs** **(** **)** +- |void| **set_clip_tabs**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_clip_tabs**\ (\ ) If ``true``, tabs overflowing this node's width will be hidden, displaying two navigation buttons instead. Otherwise, this node's minimum size is updated so that all tabs are visible. @@ -359,8 +359,8 @@ If ``true``, tabs overflowing this node's width will be hidden, displaying two n .. rst-class:: classref-property-setget -- void **set_current_tab** **(** :ref:`int` value **)** -- :ref:`int` **get_current_tab** **(** **)** +- |void| **set_current_tab**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_current_tab**\ (\ ) The current tab index. When set, this index's :ref:`Control` node's ``visible`` property is set to ``true`` and all others are set to ``false``. @@ -378,8 +378,8 @@ A value of ``-1`` means that no tab is selected. .. rst-class:: classref-property-setget -- void **set_deselect_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **get_deselect_enabled** **(** **)** +- |void| **set_deselect_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_deselect_enabled**\ (\ ) If ``true``, all tabs can be deselected so that no tab is selected. Click on the :ref:`current_tab` to deselect it. @@ -397,8 +397,8 @@ Only the tab header will be shown if no tabs are selected. .. rst-class:: classref-property-setget -- void **set_drag_to_rearrange_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **get_drag_to_rearrange_enabled** **(** **)** +- |void| **set_drag_to_rearrange_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_drag_to_rearrange_enabled**\ (\ ) If ``true``, tabs can be rearranged with mouse drag. @@ -414,8 +414,8 @@ If ``true``, tabs can be rearranged with mouse drag. .. rst-class:: classref-property-setget -- void **set_tab_alignment** **(** :ref:`AlignmentMode` value **)** -- :ref:`AlignmentMode` **get_tab_alignment** **(** **)** +- |void| **set_tab_alignment**\ (\ value\: :ref:`AlignmentMode`\ ) +- :ref:`AlignmentMode` **get_tab_alignment**\ (\ ) Sets the position at which tabs will be placed. See :ref:`AlignmentMode` for details. @@ -431,8 +431,8 @@ Sets the position at which tabs will be placed. See :ref:`AlignmentMode` value **)** -- :ref:`FocusMode` **get_tab_focus_mode** **(** **)** +- |void| **set_tab_focus_mode**\ (\ value\: :ref:`FocusMode`\ ) +- :ref:`FocusMode` **get_tab_focus_mode**\ (\ ) The focus access mode for the internal :ref:`TabBar` node. @@ -448,8 +448,8 @@ The focus access mode for the internal :ref:`TabBar` node. .. rst-class:: classref-property-setget -- void **set_tabs_position** **(** :ref:`TabPosition` value **)** -- :ref:`TabPosition` **get_tabs_position** **(** **)** +- |void| **set_tabs_position**\ (\ value\: :ref:`TabPosition`\ ) +- :ref:`TabPosition` **get_tabs_position**\ (\ ) Sets the position of the tab bar. See :ref:`TabPosition` for details. @@ -465,8 +465,8 @@ Sets the position of the tab bar. See :ref:`TabPosition` value **)** -- :ref:`int` **get_tabs_rearrange_group** **(** **)** +- |void| **set_tabs_rearrange_group**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_tabs_rearrange_group**\ (\ ) **TabContainer**\ s with the same rearrange group ID will allow dragging the tabs between them. Enable drag with :ref:`drag_to_rearrange_enabled`. @@ -484,8 +484,8 @@ Setting this to ``-1`` will disable rearranging between **TabContainer**\ s. .. rst-class:: classref-property-setget -- void **set_tabs_visible** **(** :ref:`bool` value **)** -- :ref:`bool` **are_tabs_visible** **(** **)** +- |void| **set_tabs_visible**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **are_tabs_visible**\ (\ ) If ``true``, tabs are visible. If ``false``, tabs' content and titles are hidden. @@ -501,8 +501,8 @@ If ``true``, tabs are visible. If ``false``, tabs' content and titles are hidden .. rst-class:: classref-property-setget -- void **set_use_hidden_tabs_for_min_size** **(** :ref:`bool` value **)** -- :ref:`bool` **get_use_hidden_tabs_for_min_size** **(** **)** +- |void| **set_use_hidden_tabs_for_min_size**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_hidden_tabs_for_min_size**\ (\ ) If ``true``, children :ref:`Control` nodes that are hidden have their minimum size take into account in the total, instead of only the currently visible one. @@ -519,7 +519,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Control` **get_current_tab_control** **(** **)** |const| +:ref:`Control` **get_current_tab_control**\ (\ ) |const| Returns the child :ref:`Control` node located at the active tab index. @@ -531,7 +531,7 @@ Returns the child :ref:`Control` node located at the active tab i .. rst-class:: classref-method -:ref:`Popup` **get_popup** **(** **)** |const| +:ref:`Popup` **get_popup**\ (\ ) |const| Returns the :ref:`Popup` node instance if one has been set already with :ref:`set_popup`. @@ -545,7 +545,7 @@ Returns the :ref:`Popup` node instance if one has been set already .. rst-class:: classref-method -:ref:`int` **get_previous_tab** **(** **)** |const| +:ref:`int` **get_previous_tab**\ (\ ) |const| Returns the previously active tab index. @@ -557,7 +557,7 @@ Returns the previously active tab index. .. rst-class:: classref-method -:ref:`TabBar` **get_tab_bar** **(** **)** |const| +:ref:`TabBar` **get_tab_bar**\ (\ ) |const| Returns the :ref:`TabBar` contained in this container. @@ -571,7 +571,7 @@ Returns the :ref:`TabBar` contained in this container. .. rst-class:: classref-method -:ref:`Texture2D` **get_tab_button_icon** **(** :ref:`int` tab_idx **)** |const| +:ref:`Texture2D` **get_tab_button_icon**\ (\ tab_idx\: :ref:`int`\ ) |const| Returns the button icon from the tab at index ``tab_idx``. @@ -583,7 +583,7 @@ Returns the button icon from the tab at index ``tab_idx``. .. rst-class:: classref-method -:ref:`Control` **get_tab_control** **(** :ref:`int` tab_idx **)** |const| +:ref:`Control` **get_tab_control**\ (\ tab_idx\: :ref:`int`\ ) |const| Returns the :ref:`Control` node from the tab at index ``tab_idx``. @@ -595,7 +595,7 @@ Returns the :ref:`Control` node from the tab at index ``tab_idx`` .. rst-class:: classref-method -:ref:`int` **get_tab_count** **(** **)** |const| +:ref:`int` **get_tab_count**\ (\ ) |const| Returns the number of tabs. @@ -607,7 +607,7 @@ Returns the number of tabs. .. rst-class:: classref-method -:ref:`Texture2D` **get_tab_icon** **(** :ref:`int` tab_idx **)** |const| +:ref:`Texture2D` **get_tab_icon**\ (\ tab_idx\: :ref:`int`\ ) |const| Returns the :ref:`Texture2D` for the tab at index ``tab_idx`` or ``null`` if the tab has no :ref:`Texture2D`. @@ -619,7 +619,7 @@ Returns the :ref:`Texture2D` for the tab at index ``tab_idx`` o .. rst-class:: classref-method -:ref:`int` **get_tab_idx_at_point** **(** :ref:`Vector2` point **)** |const| +:ref:`int` **get_tab_idx_at_point**\ (\ point\: :ref:`Vector2`\ ) |const| Returns the index of the tab at local coordinates ``point``. Returns ``-1`` if the point is outside the control boundaries or if there's no tab at the queried position. @@ -631,7 +631,7 @@ Returns the index of the tab at local coordinates ``point``. Returns ``-1`` if t .. rst-class:: classref-method -:ref:`int` **get_tab_idx_from_control** **(** :ref:`Control` control **)** |const| +:ref:`int` **get_tab_idx_from_control**\ (\ control\: :ref:`Control`\ ) |const| Returns the index of the tab tied to the given ``control``. The control must be a child of the **TabContainer**. @@ -643,7 +643,7 @@ Returns the index of the tab tied to the given ``control``. The control must be .. rst-class:: classref-method -:ref:`Variant` **get_tab_metadata** **(** :ref:`int` tab_idx **)** |const| +:ref:`Variant` **get_tab_metadata**\ (\ tab_idx\: :ref:`int`\ ) |const| Returns the metadata value set to the tab at index ``tab_idx`` using :ref:`set_tab_metadata`. If no metadata was previously set, returns ``null`` by default. @@ -655,7 +655,7 @@ Returns the metadata value set to the tab at index ``tab_idx`` using :ref:`set_t .. rst-class:: classref-method -:ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** |const| +:ref:`String` **get_tab_title**\ (\ tab_idx\: :ref:`int`\ ) |const| Returns the title of the tab at index ``tab_idx``. Tab titles default to the name of the indexed child node, but this can be overridden with :ref:`set_tab_title`. @@ -667,7 +667,7 @@ Returns the title of the tab at index ``tab_idx``. Tab titles default to the nam .. rst-class:: classref-method -:ref:`bool` **is_tab_disabled** **(** :ref:`int` tab_idx **)** |const| +:ref:`bool` **is_tab_disabled**\ (\ tab_idx\: :ref:`int`\ ) |const| Returns ``true`` if the tab at index ``tab_idx`` is disabled. @@ -679,7 +679,7 @@ Returns ``true`` if the tab at index ``tab_idx`` is disabled. .. rst-class:: classref-method -:ref:`bool` **is_tab_hidden** **(** :ref:`int` tab_idx **)** |const| +:ref:`bool` **is_tab_hidden**\ (\ tab_idx\: :ref:`int`\ ) |const| Returns ``true`` if the tab at index ``tab_idx`` is hidden. @@ -691,7 +691,7 @@ Returns ``true`` if the tab at index ``tab_idx`` is hidden. .. rst-class:: classref-method -:ref:`bool` **select_next_available** **(** **)** +:ref:`bool` **select_next_available**\ (\ ) Selects the first available tab with greater index than the currently selected. Returns ``true`` if tab selection changed. @@ -703,7 +703,7 @@ Selects the first available tab with greater index than the currently selected. .. rst-class:: classref-method -:ref:`bool` **select_previous_available** **(** **)** +:ref:`bool` **select_previous_available**\ (\ ) Selects the first available tab with lower index than the currently selected. Returns ``true`` if tab selection changed. @@ -715,7 +715,7 @@ Selects the first available tab with lower index than the currently selected. Re .. rst-class:: classref-method -void **set_popup** **(** :ref:`Node` popup **)** +|void| **set_popup**\ (\ popup\: :ref:`Node`\ ) If set on a :ref:`Popup` node instance, a popup menu icon appears in the top-right corner of the **TabContainer** (setting it to ``null`` will make it go away). Clicking it will expand the :ref:`Popup` node. @@ -727,7 +727,7 @@ If set on a :ref:`Popup` node instance, a popup menu icon appears i .. rst-class:: classref-method -void **set_tab_button_icon** **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** +|void| **set_tab_button_icon**\ (\ tab_idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) Sets the button icon from the tab at index ``tab_idx``. @@ -739,7 +739,7 @@ Sets the button icon from the tab at index ``tab_idx``. .. rst-class:: classref-method -void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** +|void| **set_tab_disabled**\ (\ tab_idx\: :ref:`int`, disabled\: :ref:`bool`\ ) If ``disabled`` is ``true``, disables the tab at index ``tab_idx``, making it non-interactable. @@ -751,7 +751,7 @@ If ``disabled`` is ``true``, disables the tab at index ``tab_idx``, making it no .. rst-class:: classref-method -void **set_tab_hidden** **(** :ref:`int` tab_idx, :ref:`bool` hidden **)** +|void| **set_tab_hidden**\ (\ tab_idx\: :ref:`int`, hidden\: :ref:`bool`\ ) If ``hidden`` is ``true``, hides the tab at index ``tab_idx``, making it disappear from the tab area. @@ -763,7 +763,7 @@ If ``hidden`` is ``true``, hides the tab at index ``tab_idx``, making it disappe .. rst-class:: classref-method -void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** +|void| **set_tab_icon**\ (\ tab_idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) Sets an icon for the tab at index ``tab_idx``. @@ -775,7 +775,7 @@ Sets an icon for the tab at index ``tab_idx``. .. rst-class:: classref-method -void **set_tab_metadata** **(** :ref:`int` tab_idx, :ref:`Variant` metadata **)** +|void| **set_tab_metadata**\ (\ tab_idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) Sets the metadata value for the tab at index ``tab_idx``, which can be retrieved later using :ref:`get_tab_metadata`. @@ -787,7 +787,7 @@ Sets the metadata value for the tab at index ``tab_idx``, which can be retrieved .. rst-class:: classref-method -void **set_tab_title** **(** :ref:`int` tab_idx, :ref:`String` title **)** +|void| **set_tab_title**\ (\ tab_idx\: :ref:`int`, title\: :ref:`String`\ ) Sets a custom title for the tab at index ``tab_idx`` (tab titles default to the name of the indexed child node). Set it back to the child's name to make the tab default to it again. @@ -1121,3 +1121,4 @@ The style for the background fill of the :ref:`TabBar` area. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_tcpserver.rst b/classes/class_tcpserver.rst index 7f52bfe32a6..eb0f3a7580b 100644 --- a/classes/class_tcpserver.rst +++ b/classes/class_tcpserver.rst @@ -31,19 +31,19 @@ Methods .. table:: :widths: auto - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_local_port` **(** **)** |const| | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_connection_available` **(** **)** |const| | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_listening` **(** **)** |const| | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*" **)** | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`stop` **(** **)** | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StreamPeerTCP` | :ref:`take_connection` **(** **)** | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_local_port`\ (\ ) |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_connection_available`\ (\ ) |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_listening`\ (\ ) |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`listen`\ (\ port\: :ref:`int`, bind_address\: :ref:`String` = "*"\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop`\ (\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StreamPeerTCP` | :ref:`take_connection`\ (\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -58,7 +58,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_local_port** **(** **)** |const| +:ref:`int` **get_local_port**\ (\ ) |const| Returns the local port this server is listening to. @@ -70,7 +70,7 @@ Returns the local port this server is listening to. .. rst-class:: classref-method -:ref:`bool` **is_connection_available** **(** **)** |const| +:ref:`bool` **is_connection_available**\ (\ ) |const| Returns ``true`` if a connection is available for taking. @@ -82,7 +82,7 @@ Returns ``true`` if a connection is available for taking. .. rst-class:: classref-method -:ref:`bool` **is_listening** **(** **)** |const| +:ref:`bool` **is_listening**\ (\ ) |const| Returns ``true`` if the server is currently listening for connections. @@ -94,7 +94,7 @@ Returns ``true`` if the server is currently listening for connections. .. rst-class:: classref-method -:ref:`Error` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*" **)** +:ref:`Error` **listen**\ (\ port\: :ref:`int`, bind_address\: :ref:`String` = "*"\ ) Listen on the ``port`` binding to ``bind_address``. @@ -112,7 +112,7 @@ If ``bind_address`` is set to any valid address (e.g. ``"192.168.1.101"``, ``":: .. rst-class:: classref-method -void **stop** **(** **)** +|void| **stop**\ (\ ) Stops listening. @@ -124,7 +124,7 @@ Stops listening. .. rst-class:: classref-method -:ref:`StreamPeerTCP` **take_connection** **(** **)** +:ref:`StreamPeerTCP` **take_connection**\ (\ ) If a connection is available, returns a StreamPeerTCP with the connection. @@ -135,3 +135,4 @@ If a connection is available, returns a StreamPeerTCP with the connection. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index c747759aa7a..374334ae945 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: textarea + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -123,289 +126,289 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_backspace` **(** :ref:`int` caret_index **)** |virtual| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_copy` **(** :ref:`int` caret_index **)** |virtual| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_cut` **(** :ref:`int` caret_index **)** |virtual| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_handle_unicode_input` **(** :ref:`int` unicode_char, :ref:`int` caret_index **)** |virtual| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_paste` **(** :ref:`int` caret_index **)** |virtual| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_paste_primary_clipboard` **(** :ref:`int` caret_index **)** |virtual| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`add_caret` **(** :ref:`int` line, :ref:`int` col **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_caret_at_carets` **(** :ref:`bool` below **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_gutter` **(** :ref:`int` at=-1 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_selection_for_next_occurrence` **(** **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`adjust_carets_after_edit` **(** :ref:`int` caret, :ref:`int` from_line, :ref:`int` from_col, :ref:`int` to_line, :ref:`int` to_col **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`adjust_viewport_to_caret` **(** :ref:`int` caret_index=0 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`apply_ime` **(** **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`backspace` **(** :ref:`int` caret_index=-1 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`begin_complex_operation` **(** **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`cancel_ime` **(** **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`center_viewport_to_caret` **(** :ref:`int` caret_index=0 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_undo_history` **(** **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`copy` **(** :ref:`int` caret_index=-1 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`cut` **(** :ref:`int` caret_index=-1 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`delete_selection` **(** :ref:`int` caret_index=-1 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`deselect` **(** :ref:`int` caret_index=-1 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`end_action` **(** **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`end_complex_operation` **(** **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_caret_column` **(** :ref:`int` caret_index=0 **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_caret_count` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_caret_draw_pos` **(** :ref:`int` caret_index=0 **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_caret_index_edit_order` **(** **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_caret_line` **(** :ref:`int` caret_index=0 **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_caret_wrap_index` **(** :ref:`int` caret_index=0 **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_first_non_whitespace_column` **(** :ref:`int` line **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_first_visible_line` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_gutter_count` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_gutter_name` **(** :ref:`int` gutter **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GutterType` | :ref:`get_gutter_type` **(** :ref:`int` gutter **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_gutter_width` **(** :ref:`int` gutter **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`HScrollBar` | :ref:`get_h_scroll_bar` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_indent_level` **(** :ref:`int` line **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_last_full_visible_line` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_last_full_visible_line_wrap_index` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_last_unhidden_line` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_line_background_color` **(** :ref:`int` line **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_line_column_at_pos` **(** :ref:`Vector2i` position, :ref:`bool` allow_out_of_bounds=true **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_count` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_line_gutter_icon` **(** :ref:`int` line, :ref:`int` gutter **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_line_gutter_item_color` **(** :ref:`int` line, :ref:`int` gutter **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_line_gutter_metadata` **(** :ref:`int` line, :ref:`int` gutter **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_line_gutter_text` **(** :ref:`int` line, :ref:`int` gutter **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_height` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_width` **(** :ref:`int` line, :ref:`int` wrap_index=-1 **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_wrap_count` **(** :ref:`int` line **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_wrap_index_at_column` **(** :ref:`int` line, :ref:`int` column **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_line_wrapped_text` **(** :ref:`int` line **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_local_mouse_pos` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PopupMenu` | :ref:`get_menu` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_minimap_line_at_pos` **(** :ref:`Vector2i` position **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_minimap_visible_lines` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_next_visible_line_index_offset_from` **(** :ref:`int` line, :ref:`int` wrap_index, :ref:`int` visible_amount **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_next_visible_line_offset_from` **(** :ref:`int` line, :ref:`int` visible_amount **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_pos_at_line_column` **(** :ref:`int` line, :ref:`int` column **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`get_rect_at_line_column` **(** :ref:`int` line, :ref:`int` column **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_saved_version` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_scroll_pos_for_line` **(** :ref:`int` line, :ref:`int` wrap_index=0 **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_selected_text` **(** :ref:`int` caret_index=-1 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_column` **(** :ref:`int` caret_index=0 **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_from_column` **(** :ref:`int` caret_index=0 **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_from_line` **(** :ref:`int` caret_index=0 **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_line` **(** :ref:`int` caret_index=0 **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SelectionMode` | :ref:`get_selection_mode` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_to_column` **(** :ref:`int` caret_index=0 **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selection_to_line` **(** :ref:`int` caret_index=0 **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_tab_size` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_total_gutter_width` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_total_visible_line_count` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VScrollBar` | :ref:`get_v_scroll_bar` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_version` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_visible_line_count` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_visible_line_count_in_range` **(** :ref:`int` from_line, :ref:`int` to_line **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_word_at_pos` **(** :ref:`Vector2` position **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_word_under_caret` **(** :ref:`int` caret_index=-1 **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_ime_text` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_redo` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_selection` **(** :ref:`int` caret_index=-1 **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_undo` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`insert_line_at` **(** :ref:`int` line, :ref:`String` text **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`insert_text_at_caret` **(** :ref:`String` text, :ref:`int` caret_index=-1 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_caret_visible` **(** :ref:`int` caret_index=0 **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_dragging_cursor` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_gutter_clickable` **(** :ref:`int` gutter **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_gutter_drawn` **(** :ref:`int` gutter **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_gutter_overwritable` **(** :ref:`int` gutter **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_line_gutter_clickable` **(** :ref:`int` line, :ref:`int` gutter **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_line_wrapped` **(** :ref:`int` line **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_menu_visible` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_mouse_over_selection` **(** :ref:`bool` edges, :ref:`int` caret_index=-1 **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_overtype_mode_enabled` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`menu_option` **(** :ref:`int` option **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`merge_gutters` **(** :ref:`int` from_line, :ref:`int` to_line **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`merge_overlapping_carets` **(** **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`paste` **(** :ref:`int` caret_index=-1 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`paste_primary_clipboard` **(** :ref:`int` caret_index=-1 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`redo` **(** **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_caret` **(** :ref:`int` caret **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_gutter` **(** :ref:`int` gutter **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_secondary_carets` **(** **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_text` **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`search` **(** :ref:`String` text, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_colum **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`select` **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column, :ref:`int` caret_index=0 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`select_all` **(** **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`select_word_under_caret` **(** :ref:`int` caret_index=-1 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_caret_column` **(** :ref:`int` column, :ref:`bool` adjust_viewport=true, :ref:`int` caret_index=0 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_caret_line` **(** :ref:`int` line, :ref:`bool` adjust_viewport=true, :ref:`bool` can_be_hidden=true, :ref:`int` wrap_index=0, :ref:`int` caret_index=0 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_gutter_clickable` **(** :ref:`int` gutter, :ref:`bool` clickable **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_gutter_custom_draw` **(** :ref:`int` column, :ref:`Callable` draw_callback **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_gutter_draw` **(** :ref:`int` gutter, :ref:`bool` draw **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_gutter_name` **(** :ref:`int` gutter, :ref:`String` name **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_gutter_overwritable` **(** :ref:`int` gutter, :ref:`bool` overwritable **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_gutter_type` **(** :ref:`int` gutter, :ref:`GutterType` type **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_gutter_width` **(** :ref:`int` gutter, :ref:`int` width **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_line` **(** :ref:`int` line, :ref:`String` new_text **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_line_as_center_visible` **(** :ref:`int` line, :ref:`int` wrap_index=0 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_line_as_first_visible` **(** :ref:`int` line, :ref:`int` wrap_index=0 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_line_as_last_visible` **(** :ref:`int` line, :ref:`int` wrap_index=0 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_line_background_color` **(** :ref:`int` line, :ref:`Color` color **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_line_gutter_clickable` **(** :ref:`int` line, :ref:`int` gutter, :ref:`bool` clickable **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_line_gutter_icon` **(** :ref:`int` line, :ref:`int` gutter, :ref:`Texture2D` icon **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_line_gutter_item_color` **(** :ref:`int` line, :ref:`int` gutter, :ref:`Color` color **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_line_gutter_metadata` **(** :ref:`int` line, :ref:`int` gutter, :ref:`Variant` metadata **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_line_gutter_text` **(** :ref:`int` line, :ref:`int` gutter, :ref:`String` text **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_overtype_mode_enabled` **(** :ref:`bool` enabled **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_search_flags` **(** :ref:`int` flags **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_search_text` **(** :ref:`String` search_text **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_selection_mode` **(** :ref:`SelectionMode` mode, :ref:`int` line=-1, :ref:`int` column=-1, :ref:`int` caret_index=0 **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_size` **(** :ref:`int` size **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tooltip_request_func` **(** :ref:`Callable` callback **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`start_action` **(** :ref:`EditAction` action **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`swap_lines` **(** :ref:`int` from_line, :ref:`int` to_line **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`tag_saved_version` **(** **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`undo` **(** **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_backspace`\ (\ caret_index\: :ref:`int`\ ) |virtual| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_copy`\ (\ caret_index\: :ref:`int`\ ) |virtual| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_cut`\ (\ caret_index\: :ref:`int`\ ) |virtual| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_handle_unicode_input`\ (\ unicode_char\: :ref:`int`, caret_index\: :ref:`int`\ ) |virtual| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_paste`\ (\ caret_index\: :ref:`int`\ ) |virtual| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_paste_primary_clipboard`\ (\ caret_index\: :ref:`int`\ ) |virtual| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`add_caret`\ (\ line\: :ref:`int`, col\: :ref:`int`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_caret_at_carets`\ (\ below\: :ref:`bool`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_gutter`\ (\ at\: :ref:`int` = -1\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_selection_for_next_occurrence`\ (\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`adjust_carets_after_edit`\ (\ caret\: :ref:`int`, from_line\: :ref:`int`, from_col\: :ref:`int`, to_line\: :ref:`int`, to_col\: :ref:`int`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`adjust_viewport_to_caret`\ (\ caret_index\: :ref:`int` = 0\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`apply_ime`\ (\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`backspace`\ (\ caret_index\: :ref:`int` = -1\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`begin_complex_operation`\ (\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cancel_ime`\ (\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`center_viewport_to_caret`\ (\ caret_index\: :ref:`int` = 0\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_undo_history`\ (\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`copy`\ (\ caret_index\: :ref:`int` = -1\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cut`\ (\ caret_index\: :ref:`int` = -1\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`delete_selection`\ (\ caret_index\: :ref:`int` = -1\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`deselect`\ (\ caret_index\: :ref:`int` = -1\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`end_action`\ (\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`end_complex_operation`\ (\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_caret_column`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_caret_count`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_caret_draw_pos`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_caret_index_edit_order`\ (\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_caret_line`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_caret_wrap_index`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_first_non_whitespace_column`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_first_visible_line`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_gutter_count`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_gutter_name`\ (\ gutter\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GutterType` | :ref:`get_gutter_type`\ (\ gutter\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_gutter_width`\ (\ gutter\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`HScrollBar` | :ref:`get_h_scroll_bar`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_indent_level`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_last_full_visible_line`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_last_full_visible_line_wrap_index`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_last_unhidden_line`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_line`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_line_background_color`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_line_column_at_pos`\ (\ position\: :ref:`Vector2i`, allow_out_of_bounds\: :ref:`bool` = true\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_count`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_line_gutter_icon`\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_line_gutter_item_color`\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_line_gutter_metadata`\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_line_gutter_text`\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_height`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_width`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = -1\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_wrap_count`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_wrap_index_at_column`\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_line_wrapped_text`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_local_mouse_pos`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PopupMenu` | :ref:`get_menu`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_minimap_line_at_pos`\ (\ position\: :ref:`Vector2i`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_minimap_visible_lines`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_next_visible_line_index_offset_from`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int`, visible_amount\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_next_visible_line_offset_from`\ (\ line\: :ref:`int`, visible_amount\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_pos_at_line_column`\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`get_rect_at_line_column`\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_saved_version`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_scroll_pos_for_line`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_selected_text`\ (\ caret_index\: :ref:`int` = -1\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_column`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_from_column`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_from_line`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_line`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SelectionMode` | :ref:`get_selection_mode`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_to_column`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selection_to_line`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tab_size`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_total_gutter_width`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_total_visible_line_count`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`VScrollBar` | :ref:`get_v_scroll_bar`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_version`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_visible_line_count`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_visible_line_count_in_range`\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_word_at_pos`\ (\ position\: :ref:`Vector2`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_word_under_caret`\ (\ caret_index\: :ref:`int` = -1\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_ime_text`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_redo`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_selection`\ (\ caret_index\: :ref:`int` = -1\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_undo`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`insert_line_at`\ (\ line\: :ref:`int`, text\: :ref:`String`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`insert_text_at_caret`\ (\ text\: :ref:`String`, caret_index\: :ref:`int` = -1\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_caret_visible`\ (\ caret_index\: :ref:`int` = 0\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_dragging_cursor`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_gutter_clickable`\ (\ gutter\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_gutter_drawn`\ (\ gutter\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_gutter_overwritable`\ (\ gutter\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_line_gutter_clickable`\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_line_wrapped`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_menu_visible`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_mouse_over_selection`\ (\ edges\: :ref:`bool`, caret_index\: :ref:`int` = -1\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_overtype_mode_enabled`\ (\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`menu_option`\ (\ option\: :ref:`int`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`merge_gutters`\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`merge_overlapping_carets`\ (\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`paste`\ (\ caret_index\: :ref:`int` = -1\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`paste_primary_clipboard`\ (\ caret_index\: :ref:`int` = -1\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`redo`\ (\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_caret`\ (\ caret\: :ref:`int`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_gutter`\ (\ gutter\: :ref:`int`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_secondary_carets`\ (\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_text`\ (\ from_line\: :ref:`int`, from_column\: :ref:`int`, to_line\: :ref:`int`, to_column\: :ref:`int`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`search`\ (\ text\: :ref:`String`, flags\: :ref:`int`, from_line\: :ref:`int`, from_colum\: :ref:`int`\ ) |const| | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select`\ (\ from_line\: :ref:`int`, from_column\: :ref:`int`, to_line\: :ref:`int`, to_column\: :ref:`int`, caret_index\: :ref:`int` = 0\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select_all`\ (\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select_word_under_caret`\ (\ caret_index\: :ref:`int` = -1\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_caret_column`\ (\ column\: :ref:`int`, adjust_viewport\: :ref:`bool` = true, caret_index\: :ref:`int` = 0\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_caret_line`\ (\ line\: :ref:`int`, adjust_viewport\: :ref:`bool` = true, can_be_hidden\: :ref:`bool` = true, wrap_index\: :ref:`int` = 0, caret_index\: :ref:`int` = 0\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gutter_clickable`\ (\ gutter\: :ref:`int`, clickable\: :ref:`bool`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gutter_custom_draw`\ (\ column\: :ref:`int`, draw_callback\: :ref:`Callable`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gutter_draw`\ (\ gutter\: :ref:`int`, draw\: :ref:`bool`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gutter_name`\ (\ gutter\: :ref:`int`, name\: :ref:`String`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gutter_overwritable`\ (\ gutter\: :ref:`int`, overwritable\: :ref:`bool`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gutter_type`\ (\ gutter\: :ref:`int`, type\: :ref:`GutterType`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gutter_width`\ (\ gutter\: :ref:`int`, width\: :ref:`int`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line`\ (\ line\: :ref:`int`, new_text\: :ref:`String`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_as_center_visible`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_as_first_visible`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_as_last_visible`\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_background_color`\ (\ line\: :ref:`int`, color\: :ref:`Color`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_gutter_clickable`\ (\ line\: :ref:`int`, gutter\: :ref:`int`, clickable\: :ref:`bool`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_gutter_icon`\ (\ line\: :ref:`int`, gutter\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_gutter_item_color`\ (\ line\: :ref:`int`, gutter\: :ref:`int`, color\: :ref:`Color`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_gutter_metadata`\ (\ line\: :ref:`int`, gutter\: :ref:`int`, metadata\: :ref:`Variant`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_line_gutter_text`\ (\ line\: :ref:`int`, gutter\: :ref:`int`, text\: :ref:`String`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_overtype_mode_enabled`\ (\ enabled\: :ref:`bool`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_search_flags`\ (\ flags\: :ref:`int`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_search_text`\ (\ search_text\: :ref:`String`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_selection_mode`\ (\ mode\: :ref:`SelectionMode`, line\: :ref:`int` = -1, column\: :ref:`int` = -1, caret_index\: :ref:`int` = 0\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tab_size`\ (\ size\: :ref:`int`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tooltip_request_func`\ (\ callback\: :ref:`Callable`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`start_action`\ (\ action\: :ref:`EditAction`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`swap_lines`\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tag_saved_version`\ (\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`undo`\ (\ ) | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -476,7 +479,7 @@ Signals .. rst-class:: classref-signal -**caret_changed** **(** **)** +**caret_changed**\ (\ ) Emitted when the caret changes position. @@ -488,7 +491,7 @@ Emitted when the caret changes position. .. rst-class:: classref-signal -**gutter_added** **(** **)** +**gutter_added**\ (\ ) Emitted when a gutter is added. @@ -500,7 +503,7 @@ Emitted when a gutter is added. .. rst-class:: classref-signal -**gutter_clicked** **(** :ref:`int` line, :ref:`int` gutter **)** +**gutter_clicked**\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) Emitted when a gutter is clicked. @@ -512,7 +515,7 @@ Emitted when a gutter is clicked. .. rst-class:: classref-signal -**gutter_removed** **(** **)** +**gutter_removed**\ (\ ) Emitted when a gutter is removed. @@ -524,7 +527,7 @@ Emitted when a gutter is removed. .. rst-class:: classref-signal -**lines_edited_from** **(** :ref:`int` from_line, :ref:`int` to_line **)** +**lines_edited_from**\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) Emitted immediately when the text changes. @@ -538,7 +541,7 @@ When text is added ``from_line`` will be less than ``to_line``. On a remove ``to .. rst-class:: classref-signal -**text_changed** **(** **)** +**text_changed**\ (\ ) Emitted when the text changes. @@ -550,7 +553,7 @@ Emitted when the text changes. .. rst-class:: classref-signal -**text_set** **(** **)** +**text_set**\ (\ ) Emitted when :ref:`clear` is called or :ref:`text` is set. @@ -1046,8 +1049,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_autowrap_mode** **(** :ref:`AutowrapMode` value **)** -- :ref:`AutowrapMode` **get_autowrap_mode** **(** **)** +- |void| **set_autowrap_mode**\ (\ value\: :ref:`AutowrapMode`\ ) +- :ref:`AutowrapMode` **get_autowrap_mode**\ (\ ) If :ref:`wrap_mode` is set to :ref:`LINE_WRAPPING_BOUNDARY`, sets text wrapping mode. To see how each mode behaves, see :ref:`AutowrapMode`. @@ -1063,8 +1066,8 @@ If :ref:`wrap_mode` is set to :ref:`LINE_WRAP .. rst-class:: classref-property-setget -- void **set_caret_blink_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_caret_blink_enabled** **(** **)** +- |void| **set_caret_blink_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_caret_blink_enabled**\ (\ ) If ``true``, makes the caret blink. @@ -1080,8 +1083,8 @@ If ``true``, makes the caret blink. .. rst-class:: classref-property-setget -- void **set_caret_blink_interval** **(** :ref:`float` value **)** -- :ref:`float` **get_caret_blink_interval** **(** **)** +- |void| **set_caret_blink_interval**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_caret_blink_interval**\ (\ ) The interval at which the caret blinks (in seconds). @@ -1097,8 +1100,8 @@ The interval at which the caret blinks (in seconds). .. rst-class:: classref-property-setget -- void **set_draw_caret_when_editable_disabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_drawing_caret_when_editable_disabled** **(** **)** +- |void| **set_draw_caret_when_editable_disabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_drawing_caret_when_editable_disabled**\ (\ ) If ``true``, caret will be visible when :ref:`editable` is disabled. @@ -1114,8 +1117,8 @@ If ``true``, caret will be visible when :ref:`editable` value **)** -- :ref:`bool` **is_caret_mid_grapheme_enabled** **(** **)** +- |void| **set_caret_mid_grapheme_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_caret_mid_grapheme_enabled**\ (\ ) Allow moving caret, selecting and removing the individual composite character components. @@ -1133,8 +1136,8 @@ Allow moving caret, selecting and removing the individual composite character co .. rst-class:: classref-property-setget -- void **set_move_caret_on_right_click_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_move_caret_on_right_click_enabled** **(** **)** +- |void| **set_move_caret_on_right_click_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_move_caret_on_right_click_enabled**\ (\ ) If ``true``, a right-click moves the caret at the mouse position before displaying the context menu. @@ -1152,8 +1155,8 @@ If ``false``, the context menu ignores mouse location. .. rst-class:: classref-property-setget -- void **set_multiple_carets_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_multiple_carets_enabled** **(** **)** +- |void| **set_multiple_carets_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_multiple_carets_enabled**\ (\ ) Sets if multiple carets are allowed. @@ -1169,8 +1172,8 @@ Sets if multiple carets are allowed. .. rst-class:: classref-property-setget -- void **set_caret_type** **(** :ref:`CaretType` value **)** -- :ref:`CaretType` **get_caret_type** **(** **)** +- |void| **set_caret_type**\ (\ value\: :ref:`CaretType`\ ) +- :ref:`CaretType` **get_caret_type**\ (\ ) Set the type of caret to draw. @@ -1186,8 +1189,8 @@ Set the type of caret to draw. .. rst-class:: classref-property-setget -- void **set_context_menu_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_context_menu_enabled** **(** **)** +- |void| **set_context_menu_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_context_menu_enabled**\ (\ ) If ``true``, a right-click displays the context menu. @@ -1203,8 +1206,8 @@ If ``true``, a right-click displays the context menu. .. rst-class:: classref-property-setget -- void **set_deselect_on_focus_loss_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_deselect_on_focus_loss_enabled** **(** **)** +- |void| **set_deselect_on_focus_loss_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_deselect_on_focus_loss_enabled**\ (\ ) If ``true``, the selected text will be deselected when focus is lost. @@ -1220,8 +1223,8 @@ If ``true``, the selected text will be deselected when focus is lost. .. rst-class:: classref-property-setget -- void **set_drag_and_drop_selection_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_drag_and_drop_selection_enabled** **(** **)** +- |void| **set_drag_and_drop_selection_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_drag_and_drop_selection_enabled**\ (\ ) If ``true``, allow drag and drop of selected text. @@ -1237,8 +1240,8 @@ If ``true``, allow drag and drop of selected text. .. rst-class:: classref-property-setget -- void **set_draw_control_chars** **(** :ref:`bool` value **)** -- :ref:`bool` **get_draw_control_chars** **(** **)** +- |void| **set_draw_control_chars**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_draw_control_chars**\ (\ ) If ``true``, control characters are displayed. @@ -1254,8 +1257,8 @@ If ``true``, control characters are displayed. .. rst-class:: classref-property-setget -- void **set_draw_spaces** **(** :ref:`bool` value **)** -- :ref:`bool` **is_drawing_spaces** **(** **)** +- |void| **set_draw_spaces**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_drawing_spaces**\ (\ ) If ``true``, the "space" character will have a visible representation. @@ -1271,8 +1274,8 @@ If ``true``, the "space" character will have a visible representation. .. rst-class:: classref-property-setget -- void **set_draw_tabs** **(** :ref:`bool` value **)** -- :ref:`bool` **is_drawing_tabs** **(** **)** +- |void| **set_draw_tabs**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_drawing_tabs**\ (\ ) If ``true``, the "tab" character will have a visible representation. @@ -1288,8 +1291,8 @@ If ``true``, the "tab" character will have a visible representation. .. rst-class:: classref-property-setget -- void **set_editable** **(** :ref:`bool` value **)** -- :ref:`bool` **is_editable** **(** **)** +- |void| **set_editable**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_editable**\ (\ ) If ``false``, existing text cannot be modified and new text cannot be added. @@ -1305,8 +1308,8 @@ If ``false``, existing text cannot be modified and new text cannot be added. .. rst-class:: classref-property-setget -- void **set_highlight_all_occurrences** **(** :ref:`bool` value **)** -- :ref:`bool` **is_highlight_all_occurrences_enabled** **(** **)** +- |void| **set_highlight_all_occurrences**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_highlight_all_occurrences_enabled**\ (\ ) If ``true``, all occurrences of the selected text will be highlighted. @@ -1322,8 +1325,8 @@ If ``true``, all occurrences of the selected text will be highlighted. .. rst-class:: classref-property-setget -- void **set_highlight_current_line** **(** :ref:`bool` value **)** -- :ref:`bool` **is_highlight_current_line_enabled** **(** **)** +- |void| **set_highlight_current_line**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_highlight_current_line_enabled**\ (\ ) If ``true``, the line containing the cursor is highlighted. @@ -1339,8 +1342,8 @@ If ``true``, the line containing the cursor is highlighted. .. rst-class:: classref-property-setget -- void **set_language** **(** :ref:`String` value **)** -- :ref:`String` **get_language** **(** **)** +- |void| **set_language**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_language**\ (\ ) Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -1356,8 +1359,8 @@ Language code used for line-breaking and text shaping algorithms, if left empty .. rst-class:: classref-property-setget -- void **set_middle_mouse_paste_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_middle_mouse_paste_enabled** **(** **)** +- |void| **set_middle_mouse_paste_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_middle_mouse_paste_enabled**\ (\ ) If ``false``, using middle mouse button to paste clipboard will be disabled. @@ -1375,8 +1378,8 @@ If ``false``, using middle mouse button to paste clipboard will be disabled. .. rst-class:: classref-property-setget -- void **set_draw_minimap** **(** :ref:`bool` value **)** -- :ref:`bool` **is_drawing_minimap** **(** **)** +- |void| **set_draw_minimap**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_drawing_minimap**\ (\ ) If ``true``, a minimap is shown, providing an outline of your source code. @@ -1392,8 +1395,8 @@ If ``true``, a minimap is shown, providing an outline of your source code. .. rst-class:: classref-property-setget -- void **set_minimap_width** **(** :ref:`int` value **)** -- :ref:`int` **get_minimap_width** **(** **)** +- |void| **set_minimap_width**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_minimap_width**\ (\ ) The width, in pixels, of the minimap. @@ -1409,8 +1412,8 @@ The width, in pixels, of the minimap. .. rst-class:: classref-property-setget -- void **set_placeholder** **(** :ref:`String` value **)** -- :ref:`String` **get_placeholder** **(** **)** +- |void| **set_placeholder**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_placeholder**\ (\ ) Text shown when the **TextEdit** is empty. It is **not** the **TextEdit**'s default value (see :ref:`text`). @@ -1426,8 +1429,8 @@ Text shown when the **TextEdit** is empty. It is **not** the **TextEdit**'s defa .. rst-class:: classref-property-setget -- void **set_fit_content_height_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_fit_content_height_enabled** **(** **)** +- |void| **set_fit_content_height_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_fit_content_height_enabled**\ (\ ) If ``true``, **TextEdit** will disable vertical scroll and fit minimum height to the number of visible lines. @@ -1443,8 +1446,8 @@ If ``true``, **TextEdit** will disable vertical scroll and fit minimum height to .. rst-class:: classref-property-setget -- void **set_h_scroll** **(** :ref:`int` value **)** -- :ref:`int` **get_h_scroll** **(** **)** +- |void| **set_h_scroll**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_h_scroll**\ (\ ) If there is a horizontal scrollbar, this determines the current horizontal scroll value in pixels. @@ -1460,8 +1463,8 @@ If there is a horizontal scrollbar, this determines the current horizontal scrol .. rst-class:: classref-property-setget -- void **set_scroll_past_end_of_file_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_scroll_past_end_of_file_enabled** **(** **)** +- |void| **set_scroll_past_end_of_file_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_scroll_past_end_of_file_enabled**\ (\ ) Allow scrolling past the last line into "virtual" space. @@ -1477,8 +1480,8 @@ Allow scrolling past the last line into "virtual" space. .. rst-class:: classref-property-setget -- void **set_smooth_scroll_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_smooth_scroll_enabled** **(** **)** +- |void| **set_smooth_scroll_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_smooth_scroll_enabled**\ (\ ) Scroll smoothly over the text rather than jumping to the next location. @@ -1494,8 +1497,8 @@ Scroll smoothly over the text rather than jumping to the next location. .. rst-class:: classref-property-setget -- void **set_v_scroll_speed** **(** :ref:`float` value **)** -- :ref:`float` **get_v_scroll_speed** **(** **)** +- |void| **set_v_scroll_speed**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_v_scroll_speed**\ (\ ) Sets the scroll speed with the minimap or when :ref:`scroll_smooth` is enabled. @@ -1511,8 +1514,8 @@ Sets the scroll speed with the minimap or when :ref:`scroll_smooth` value **)** -- :ref:`float` **get_v_scroll** **(** **)** +- |void| **set_v_scroll**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_v_scroll**\ (\ ) If there is a vertical scrollbar, this determines the current vertical scroll value in line numbers, starting at 0 for the top line. @@ -1528,8 +1531,8 @@ If there is a vertical scrollbar, this determines the current vertical scroll va .. rst-class:: classref-property-setget -- void **set_selecting_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_selecting_enabled** **(** **)** +- |void| **set_selecting_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_selecting_enabled**\ (\ ) If ``true``, text can be selected. @@ -1547,8 +1550,8 @@ If ``false``, text can not be selected by the user or by the :ref:`select` value **)** -- :ref:`bool` **is_shortcut_keys_enabled** **(** **)** +- |void| **set_shortcut_keys_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_shortcut_keys_enabled**\ (\ ) If ``true``, shortcut keys for context menu items are enabled, even if the context menu is disabled. @@ -1564,8 +1567,8 @@ If ``true``, shortcut keys for context menu items are enabled, even if the conte .. rst-class:: classref-property-setget -- void **set_structured_text_bidi_override** **(** :ref:`StructuredTextParser` value **)** -- :ref:`StructuredTextParser` **get_structured_text_bidi_override** **(** **)** +- |void| **set_structured_text_bidi_override**\ (\ value\: :ref:`StructuredTextParser`\ ) +- :ref:`StructuredTextParser` **get_structured_text_bidi_override**\ (\ ) Set BiDi algorithm override for the structured text. @@ -1581,8 +1584,8 @@ Set BiDi algorithm override for the structured text. .. rst-class:: classref-property-setget -- void **set_structured_text_bidi_override_options** **(** :ref:`Array` value **)** -- :ref:`Array` **get_structured_text_bidi_override_options** **(** **)** +- |void| **set_structured_text_bidi_override_options**\ (\ value\: :ref:`Array`\ ) +- :ref:`Array` **get_structured_text_bidi_override_options**\ (\ ) Set additional options for BiDi override. @@ -1598,8 +1601,8 @@ Set additional options for BiDi override. .. rst-class:: classref-property-setget -- void **set_syntax_highlighter** **(** :ref:`SyntaxHighlighter` value **)** -- :ref:`SyntaxHighlighter` **get_syntax_highlighter** **(** **)** +- |void| **set_syntax_highlighter**\ (\ value\: :ref:`SyntaxHighlighter`\ ) +- :ref:`SyntaxHighlighter` **get_syntax_highlighter**\ (\ ) Sets the :ref:`SyntaxHighlighter` to use. @@ -1615,8 +1618,8 @@ Sets the :ref:`SyntaxHighlighter` to use. .. rst-class:: classref-property-setget -- void **set_text** **(** :ref:`String` value **)** -- :ref:`String` **get_text** **(** **)** +- |void| **set_text**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_text**\ (\ ) String value of the **TextEdit**. @@ -1632,8 +1635,8 @@ String value of the **TextEdit**. .. rst-class:: classref-property-setget -- void **set_text_direction** **(** :ref:`TextDirection` value **)** -- :ref:`TextDirection` **get_text_direction** **(** **)** +- |void| **set_text_direction**\ (\ value\: :ref:`TextDirection`\ ) +- :ref:`TextDirection` **get_text_direction**\ (\ ) Base text writing direction. @@ -1649,8 +1652,8 @@ Base text writing direction. .. rst-class:: classref-property-setget -- void **set_virtual_keyboard_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_virtual_keyboard_enabled** **(** **)** +- |void| **set_virtual_keyboard_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_virtual_keyboard_enabled**\ (\ ) If ``true``, the native virtual keyboard is shown when focused on platforms that support it. @@ -1666,8 +1669,8 @@ If ``true``, the native virtual keyboard is shown when focused on platforms that .. rst-class:: classref-property-setget -- void **set_line_wrapping_mode** **(** :ref:`LineWrappingMode` value **)** -- :ref:`LineWrappingMode` **get_line_wrapping_mode** **(** **)** +- |void| **set_line_wrapping_mode**\ (\ value\: :ref:`LineWrappingMode`\ ) +- :ref:`LineWrappingMode` **get_line_wrapping_mode**\ (\ ) Sets the line wrapping mode to use. @@ -1684,7 +1687,7 @@ Method Descriptions .. rst-class:: classref-method -void **_backspace** **(** :ref:`int` caret_index **)** |virtual| +|void| **_backspace**\ (\ caret_index\: :ref:`int`\ ) |virtual| Override this method to define what happens when the user presses the backspace key. @@ -1696,7 +1699,7 @@ Override this method to define what happens when the user presses the backspace .. rst-class:: classref-method -void **_copy** **(** :ref:`int` caret_index **)** |virtual| +|void| **_copy**\ (\ caret_index\: :ref:`int`\ ) |virtual| Override this method to define what happens when the user performs a copy operation. @@ -1708,7 +1711,7 @@ Override this method to define what happens when the user performs a copy operat .. rst-class:: classref-method -void **_cut** **(** :ref:`int` caret_index **)** |virtual| +|void| **_cut**\ (\ caret_index\: :ref:`int`\ ) |virtual| Override this method to define what happens when the user performs a cut operation. @@ -1720,7 +1723,7 @@ Override this method to define what happens when the user performs a cut operati .. rst-class:: classref-method -void **_handle_unicode_input** **(** :ref:`int` unicode_char, :ref:`int` caret_index **)** |virtual| +|void| **_handle_unicode_input**\ (\ unicode_char\: :ref:`int`, caret_index\: :ref:`int`\ ) |virtual| Override this method to define what happens when the user types in the provided key ``unicode_char``. @@ -1732,7 +1735,7 @@ Override this method to define what happens when the user types in the provided .. rst-class:: classref-method -void **_paste** **(** :ref:`int` caret_index **)** |virtual| +|void| **_paste**\ (\ caret_index\: :ref:`int`\ ) |virtual| Override this method to define what happens when the user performs a paste operation. @@ -1744,7 +1747,7 @@ Override this method to define what happens when the user performs a paste opera .. rst-class:: classref-method -void **_paste_primary_clipboard** **(** :ref:`int` caret_index **)** |virtual| +|void| **_paste_primary_clipboard**\ (\ caret_index\: :ref:`int`\ ) |virtual| Override this method to define what happens when the user performs a paste operation with middle mouse button. @@ -1758,7 +1761,7 @@ Override this method to define what happens when the user performs a paste opera .. rst-class:: classref-method -:ref:`int` **add_caret** **(** :ref:`int` line, :ref:`int` col **)** +:ref:`int` **add_caret**\ (\ line\: :ref:`int`, col\: :ref:`int`\ ) Adds a new caret at the given location. Returns the index of the new caret, or ``-1`` if the location is invalid. @@ -1770,7 +1773,7 @@ Adds a new caret at the given location. Returns the index of the new caret, or ` .. rst-class:: classref-method -void **add_caret_at_carets** **(** :ref:`bool` below **)** +|void| **add_caret_at_carets**\ (\ below\: :ref:`bool`\ ) Adds an additional caret above or below every caret. If ``below`` is true the new caret will be added below and above otherwise. @@ -1782,7 +1785,7 @@ Adds an additional caret above or below every caret. If ``below`` is true the ne .. rst-class:: classref-method -void **add_gutter** **(** :ref:`int` at=-1 **)** +|void| **add_gutter**\ (\ at\: :ref:`int` = -1\ ) Register a new gutter to this **TextEdit**. Use ``at`` to have a specific gutter order. A value of ``-1`` appends the gutter to the right. @@ -1794,7 +1797,7 @@ Register a new gutter to this **TextEdit**. Use ``at`` to have a specific gutter .. rst-class:: classref-method -void **add_selection_for_next_occurrence** **(** **)** +|void| **add_selection_for_next_occurrence**\ (\ ) Adds a selection and a caret for the next occurrence of the current selection. If there is no active selection, selects word under caret. @@ -1806,7 +1809,7 @@ Adds a selection and a caret for the next occurrence of the current selection. I .. rst-class:: classref-method -void **adjust_carets_after_edit** **(** :ref:`int` caret, :ref:`int` from_line, :ref:`int` from_col, :ref:`int` to_line, :ref:`int` to_col **)** +|void| **adjust_carets_after_edit**\ (\ caret\: :ref:`int`, from_line\: :ref:`int`, from_col\: :ref:`int`, to_line\: :ref:`int`, to_col\: :ref:`int`\ ) Reposition the carets affected by the edit. This assumes edits are applied in edit order, see :ref:`get_caret_index_edit_order`. @@ -1818,7 +1821,7 @@ Reposition the carets affected by the edit. This assumes edits are applied in ed .. rst-class:: classref-method -void **adjust_viewport_to_caret** **(** :ref:`int` caret_index=0 **)** +|void| **adjust_viewport_to_caret**\ (\ caret_index\: :ref:`int` = 0\ ) Adjust the viewport so the caret is visible. @@ -1830,7 +1833,7 @@ Adjust the viewport so the caret is visible. .. rst-class:: classref-method -void **apply_ime** **(** **)** +|void| **apply_ime**\ (\ ) Applies text from the `Input Method Editor `__ (IME) to each caret and closes the IME if it is open. @@ -1842,7 +1845,7 @@ Applies text from the `Input Method Editor ` caret_index=-1 **)** +|void| **backspace**\ (\ caret_index\: :ref:`int` = -1\ ) Called when the user presses the backspace key. Can be overridden with :ref:`_backspace`. @@ -1854,7 +1857,7 @@ Called when the user presses the backspace key. Can be overridden with :ref:`_ba .. rst-class:: classref-method -void **begin_complex_operation** **(** **)** +|void| **begin_complex_operation**\ (\ ) Starts a multipart edit. All edits will be treated as one action until :ref:`end_complex_operation` is called. @@ -1866,7 +1869,7 @@ Starts a multipart edit. All edits will be treated as one action until :ref:`end .. rst-class:: classref-method -void **cancel_ime** **(** **)** +|void| **cancel_ime**\ (\ ) Closes the `Input Method Editor `__ (IME) if it is open. Any text in the IME will be lost. @@ -1878,7 +1881,7 @@ Closes the `Input Method Editor `__ .. rst-class:: classref-method -void **center_viewport_to_caret** **(** :ref:`int` caret_index=0 **)** +|void| **center_viewport_to_caret**\ (\ caret_index\: :ref:`int` = 0\ ) Centers the viewport on the line the editing caret is at. This also resets the :ref:`scroll_horizontal` value to ``0``. @@ -1890,7 +1893,7 @@ Centers the viewport on the line the editing caret is at. This also resets the : .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Performs a full reset of **TextEdit**, including undo history. @@ -1902,7 +1905,7 @@ Performs a full reset of **TextEdit**, including undo history. .. rst-class:: classref-method -void **clear_undo_history** **(** **)** +|void| **clear_undo_history**\ (\ ) Clears the undo history. @@ -1914,7 +1917,7 @@ Clears the undo history. .. rst-class:: classref-method -void **copy** **(** :ref:`int` caret_index=-1 **)** +|void| **copy**\ (\ caret_index\: :ref:`int` = -1\ ) Copies the current text selection. Can be overridden with :ref:`_copy`. @@ -1926,7 +1929,7 @@ Copies the current text selection. Can be overridden with :ref:`_copy` caret_index=-1 **)** +|void| **cut**\ (\ caret_index\: :ref:`int` = -1\ ) Cut's the current selection. Can be overridden with :ref:`_cut`. @@ -1938,7 +1941,7 @@ Cut's the current selection. Can be overridden with :ref:`_cut` caret_index=-1 **)** +|void| **delete_selection**\ (\ caret_index\: :ref:`int` = -1\ ) Deletes the selected text. @@ -1950,7 +1953,7 @@ Deletes the selected text. .. rst-class:: classref-method -void **deselect** **(** :ref:`int` caret_index=-1 **)** +|void| **deselect**\ (\ caret_index\: :ref:`int` = -1\ ) Deselects the current selection. @@ -1962,7 +1965,7 @@ Deselects the current selection. .. rst-class:: classref-method -void **end_action** **(** **)** +|void| **end_action**\ (\ ) Marks the end of steps in the current action started with :ref:`start_action`. @@ -1974,7 +1977,7 @@ Marks the end of steps in the current action started with :ref:`start_action`. If called outside a complex operation, the current operation is pushed onto the undo/redo stack. @@ -1986,7 +1989,7 @@ Ends a multipart edit, started with :ref:`begin_complex_operation` **get_caret_column** **(** :ref:`int` caret_index=0 **)** |const| +:ref:`int` **get_caret_column**\ (\ caret_index\: :ref:`int` = 0\ ) |const| Returns the column the editing caret is at. @@ -1998,7 +2001,7 @@ Returns the column the editing caret is at. .. rst-class:: classref-method -:ref:`int` **get_caret_count** **(** **)** |const| +:ref:`int` **get_caret_count**\ (\ ) |const| Returns the number of carets in this **TextEdit**. @@ -2010,7 +2013,7 @@ Returns the number of carets in this **TextEdit**. .. rst-class:: classref-method -:ref:`Vector2` **get_caret_draw_pos** **(** :ref:`int` caret_index=0 **)** |const| +:ref:`Vector2` **get_caret_draw_pos**\ (\ caret_index\: :ref:`int` = 0\ ) |const| Returns the caret pixel draw position. @@ -2022,7 +2025,7 @@ Returns the caret pixel draw position. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_caret_index_edit_order** **(** **)** +:ref:`PackedInt32Array` **get_caret_index_edit_order**\ (\ ) Returns a list of caret indexes in their edit order, this done from bottom to top. Edit order refers to the way actions such as :ref:`insert_text_at_caret` are applied. @@ -2034,7 +2037,7 @@ Returns a list of caret indexes in their edit order, this done from bottom to to .. rst-class:: classref-method -:ref:`int` **get_caret_line** **(** :ref:`int` caret_index=0 **)** |const| +:ref:`int` **get_caret_line**\ (\ caret_index\: :ref:`int` = 0\ ) |const| Returns the line the editing caret is on. @@ -2046,7 +2049,7 @@ Returns the line the editing caret is on. .. rst-class:: classref-method -:ref:`int` **get_caret_wrap_index** **(** :ref:`int` caret_index=0 **)** |const| +:ref:`int` **get_caret_wrap_index**\ (\ caret_index\: :ref:`int` = 0\ ) |const| Returns the wrap index the editing caret is on. @@ -2058,7 +2061,7 @@ Returns the wrap index the editing caret is on. .. rst-class:: classref-method -:ref:`int` **get_first_non_whitespace_column** **(** :ref:`int` line **)** |const| +:ref:`int` **get_first_non_whitespace_column**\ (\ line\: :ref:`int`\ ) |const| Returns the first column containing a non-whitespace character. @@ -2070,7 +2073,7 @@ Returns the first column containing a non-whitespace character. .. rst-class:: classref-method -:ref:`int` **get_first_visible_line** **(** **)** |const| +:ref:`int` **get_first_visible_line**\ (\ ) |const| Returns the first visible line. @@ -2082,7 +2085,7 @@ Returns the first visible line. .. rst-class:: classref-method -:ref:`int` **get_gutter_count** **(** **)** |const| +:ref:`int` **get_gutter_count**\ (\ ) |const| Returns the number of gutters registered. @@ -2094,7 +2097,7 @@ Returns the number of gutters registered. .. rst-class:: classref-method -:ref:`String` **get_gutter_name** **(** :ref:`int` gutter **)** |const| +:ref:`String` **get_gutter_name**\ (\ gutter\: :ref:`int`\ ) |const| Returns the name of the gutter at the given index. @@ -2106,7 +2109,7 @@ Returns the name of the gutter at the given index. .. rst-class:: classref-method -:ref:`GutterType` **get_gutter_type** **(** :ref:`int` gutter **)** |const| +:ref:`GutterType` **get_gutter_type**\ (\ gutter\: :ref:`int`\ ) |const| Returns the type of the gutter at the given index. @@ -2118,7 +2121,7 @@ Returns the type of the gutter at the given index. .. rst-class:: classref-method -:ref:`int` **get_gutter_width** **(** :ref:`int` gutter **)** |const| +:ref:`int` **get_gutter_width**\ (\ gutter\: :ref:`int`\ ) |const| Returns the width of the gutter at the given index. @@ -2130,7 +2133,7 @@ Returns the width of the gutter at the given index. .. rst-class:: classref-method -:ref:`HScrollBar` **get_h_scroll_bar** **(** **)** |const| +:ref:`HScrollBar` **get_h_scroll_bar**\ (\ ) |const| Returns the :ref:`HScrollBar` used by **TextEdit**. @@ -2142,7 +2145,7 @@ Returns the :ref:`HScrollBar` used by **TextEdit**. .. rst-class:: classref-method -:ref:`int` **get_indent_level** **(** :ref:`int` line **)** |const| +:ref:`int` **get_indent_level**\ (\ line\: :ref:`int`\ ) |const| Returns the number of spaces and ``tab * tab_size`` before the first char. @@ -2154,7 +2157,7 @@ Returns the number of spaces and ``tab * tab_size`` before the first char. .. rst-class:: classref-method -:ref:`int` **get_last_full_visible_line** **(** **)** |const| +:ref:`int` **get_last_full_visible_line**\ (\ ) |const| Returns the last visible line. Use :ref:`get_last_full_visible_line_wrap_index` for the wrap index. @@ -2166,7 +2169,7 @@ Returns the last visible line. Use :ref:`get_last_full_visible_line_wrap_index` **get_last_full_visible_line_wrap_index** **(** **)** |const| +:ref:`int` **get_last_full_visible_line_wrap_index**\ (\ ) |const| Returns the last visible wrap index of the last visible line. @@ -2178,7 +2181,7 @@ Returns the last visible wrap index of the last visible line. .. rst-class:: classref-method -:ref:`int` **get_last_unhidden_line** **(** **)** |const| +:ref:`int` **get_last_unhidden_line**\ (\ ) |const| Returns the last unhidden line in the entire **TextEdit**. @@ -2190,7 +2193,7 @@ Returns the last unhidden line in the entire **TextEdit**. .. rst-class:: classref-method -:ref:`String` **get_line** **(** :ref:`int` line **)** |const| +:ref:`String` **get_line**\ (\ line\: :ref:`int`\ ) |const| Returns the text of a specific line. @@ -2202,7 +2205,7 @@ Returns the text of a specific line. .. rst-class:: classref-method -:ref:`Color` **get_line_background_color** **(** :ref:`int` line **)** |const| +:ref:`Color` **get_line_background_color**\ (\ line\: :ref:`int`\ ) |const| Returns the current background color of the line. ``Color(0, 0, 0, 0)`` is returned if no color is set. @@ -2214,7 +2217,7 @@ Returns the current background color of the line. ``Color(0, 0, 0, 0)`` is retur .. rst-class:: classref-method -:ref:`Vector2i` **get_line_column_at_pos** **(** :ref:`Vector2i` position, :ref:`bool` allow_out_of_bounds=true **)** |const| +:ref:`Vector2i` **get_line_column_at_pos**\ (\ position\: :ref:`Vector2i`, allow_out_of_bounds\: :ref:`bool` = true\ ) |const| Returns the line and column at the given position. In the returned vector, ``x`` is the column, ``y`` is the line. If ``allow_out_of_bounds`` is ``false`` and the position is not over the text, both vector values will be set to ``-1``. @@ -2226,7 +2229,7 @@ Returns the line and column at the given position. In the returned vector, ``x`` .. rst-class:: classref-method -:ref:`int` **get_line_count** **(** **)** |const| +:ref:`int` **get_line_count**\ (\ ) |const| Returns the number of lines in the text. @@ -2238,7 +2241,7 @@ Returns the number of lines in the text. .. rst-class:: classref-method -:ref:`Texture2D` **get_line_gutter_icon** **(** :ref:`int` line, :ref:`int` gutter **)** |const| +:ref:`Texture2D` **get_line_gutter_icon**\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| Returns the icon currently in ``gutter`` at ``line``. @@ -2250,7 +2253,7 @@ Returns the icon currently in ``gutter`` at ``line``. .. rst-class:: classref-method -:ref:`Color` **get_line_gutter_item_color** **(** :ref:`int` line, :ref:`int` gutter **)** |const| +:ref:`Color` **get_line_gutter_item_color**\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| Returns the color currently in ``gutter`` at ``line``. @@ -2262,7 +2265,7 @@ Returns the color currently in ``gutter`` at ``line``. .. rst-class:: classref-method -:ref:`Variant` **get_line_gutter_metadata** **(** :ref:`int` line, :ref:`int` gutter **)** |const| +:ref:`Variant` **get_line_gutter_metadata**\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| Returns the metadata currently in ``gutter`` at ``line``. @@ -2274,7 +2277,7 @@ Returns the metadata currently in ``gutter`` at ``line``. .. rst-class:: classref-method -:ref:`String` **get_line_gutter_text** **(** :ref:`int` line, :ref:`int` gutter **)** |const| +:ref:`String` **get_line_gutter_text**\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| Returns the text currently in ``gutter`` at ``line``. @@ -2286,7 +2289,7 @@ Returns the text currently in ``gutter`` at ``line``. .. rst-class:: classref-method -:ref:`int` **get_line_height** **(** **)** |const| +:ref:`int` **get_line_height**\ (\ ) |const| Returns the maximum value of the line height among all lines. @@ -2300,7 +2303,7 @@ Returns the maximum value of the line height among all lines. .. rst-class:: classref-method -:ref:`int` **get_line_width** **(** :ref:`int` line, :ref:`int` wrap_index=-1 **)** |const| +:ref:`int` **get_line_width**\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = -1\ ) |const| Returns the width in pixels of the ``wrap_index`` on ``line``. @@ -2312,7 +2315,7 @@ Returns the width in pixels of the ``wrap_index`` on ``line``. .. rst-class:: classref-method -:ref:`int` **get_line_wrap_count** **(** :ref:`int` line **)** |const| +:ref:`int` **get_line_wrap_count**\ (\ line\: :ref:`int`\ ) |const| Returns the number of times the given line is wrapped. @@ -2324,7 +2327,7 @@ Returns the number of times the given line is wrapped. .. rst-class:: classref-method -:ref:`int` **get_line_wrap_index_at_column** **(** :ref:`int` line, :ref:`int` column **)** |const| +:ref:`int` **get_line_wrap_index_at_column**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| Returns the wrap index of the given line column. @@ -2336,7 +2339,7 @@ Returns the wrap index of the given line column. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_line_wrapped_text** **(** :ref:`int` line **)** |const| +:ref:`PackedStringArray` **get_line_wrapped_text**\ (\ line\: :ref:`int`\ ) |const| Returns an array of :ref:`String`\ s representing each wrapped index. @@ -2348,7 +2351,7 @@ Returns an array of :ref:`String`\ s representing each wrapped ind .. rst-class:: classref-method -:ref:`Vector2` **get_local_mouse_pos** **(** **)** |const| +:ref:`Vector2` **get_local_mouse_pos**\ (\ ) |const| Returns the local mouse position adjusted for the text direction. @@ -2360,7 +2363,7 @@ Returns the local mouse position adjusted for the text direction. .. rst-class:: classref-method -:ref:`PopupMenu` **get_menu** **(** **)** |const| +:ref:`PopupMenu` **get_menu**\ (\ ) |const| Returns the :ref:`PopupMenu` of this **TextEdit**. By default, this menu is displayed when right-clicking on the **TextEdit**. @@ -2419,7 +2422,7 @@ You can add custom menu items or remove standard ones. Make sure your IDs don't .. rst-class:: classref-method -:ref:`int` **get_minimap_line_at_pos** **(** :ref:`Vector2i` position **)** |const| +:ref:`int` **get_minimap_line_at_pos**\ (\ position\: :ref:`Vector2i`\ ) |const| Returns the equivalent minimap line at ``position``. @@ -2431,7 +2434,7 @@ Returns the equivalent minimap line at ``position``. .. rst-class:: classref-method -:ref:`int` **get_minimap_visible_lines** **(** **)** |const| +:ref:`int` **get_minimap_visible_lines**\ (\ ) |const| Returns the number of lines that may be drawn on the minimap. @@ -2443,7 +2446,7 @@ Returns the number of lines that may be drawn on the minimap. .. rst-class:: classref-method -:ref:`Vector2i` **get_next_visible_line_index_offset_from** **(** :ref:`int` line, :ref:`int` wrap_index, :ref:`int` visible_amount **)** |const| +:ref:`Vector2i` **get_next_visible_line_index_offset_from**\ (\ line\: :ref:`int`, wrap_index\: :ref:`int`, visible_amount\: :ref:`int`\ ) |const| Similar to :ref:`get_next_visible_line_offset_from`, but takes into account the line wrap indexes. In the returned vector, ``x`` is the line, ``y`` is the wrap index. @@ -2455,7 +2458,7 @@ Similar to :ref:`get_next_visible_line_offset_from` **get_next_visible_line_offset_from** **(** :ref:`int` line, :ref:`int` visible_amount **)** |const| +:ref:`int` **get_next_visible_line_offset_from**\ (\ line\: :ref:`int`, visible_amount\: :ref:`int`\ ) |const| Returns the count to the next visible line from ``line`` to ``line + visible_amount``. Can also count backwards. For example if a **TextEdit** has 5 lines with lines 2 and 3 hidden, calling this with ``line = 1, visible_amount = 1`` would return 3. @@ -2467,7 +2470,7 @@ Returns the count to the next visible line from ``line`` to ``line + visible_amo .. rst-class:: classref-method -:ref:`Vector2i` **get_pos_at_line_column** **(** :ref:`int` line, :ref:`int` column **)** |const| +:ref:`Vector2i` **get_pos_at_line_column**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| Returns the local position for the given ``line`` and ``column``. If ``x`` or ``y`` of the returned vector equal ``-1``, the position is outside of the viewable area of the control. @@ -2481,7 +2484,7 @@ Returns the local position for the given ``line`` and ``column``. If ``x`` or `` .. rst-class:: classref-method -:ref:`Rect2i` **get_rect_at_line_column** **(** :ref:`int` line, :ref:`int` column **)** |const| +:ref:`Rect2i` **get_rect_at_line_column**\ (\ line\: :ref:`int`, column\: :ref:`int`\ ) |const| Returns the local position and size for the grapheme at the given ``line`` and ``column``. If ``x`` or ``y`` position of the returned rect equal ``-1``, the position is outside of the viewable area of the control. @@ -2495,7 +2498,7 @@ Returns the local position and size for the grapheme at the given ``line`` and ` .. rst-class:: classref-method -:ref:`int` **get_saved_version** **(** **)** |const| +:ref:`int` **get_saved_version**\ (\ ) |const| Returns the last tagged saved version from :ref:`tag_saved_version`. @@ -2507,7 +2510,7 @@ Returns the last tagged saved version from :ref:`tag_saved_version` **get_scroll_pos_for_line** **(** :ref:`int` line, :ref:`int` wrap_index=0 **)** |const| +:ref:`float` **get_scroll_pos_for_line**\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) |const| Returns the scroll position for ``wrap_index`` of ``line``. @@ -2519,7 +2522,7 @@ Returns the scroll position for ``wrap_index`` of ``line``. .. rst-class:: classref-method -:ref:`String` **get_selected_text** **(** :ref:`int` caret_index=-1 **)** +:ref:`String` **get_selected_text**\ (\ caret_index\: :ref:`int` = -1\ ) Returns the text inside the selection of a caret, or all the carets if ``caret_index`` is its default value ``-1``. @@ -2531,7 +2534,7 @@ Returns the text inside the selection of a caret, or all the carets if ``caret_i .. rst-class:: classref-method -:ref:`int` **get_selection_column** **(** :ref:`int` caret_index=0 **)** |const| +:ref:`int` **get_selection_column**\ (\ caret_index\: :ref:`int` = 0\ ) |const| Returns the original start column of the selection. @@ -2543,7 +2546,7 @@ Returns the original start column of the selection. .. rst-class:: classref-method -:ref:`int` **get_selection_from_column** **(** :ref:`int` caret_index=0 **)** |const| +:ref:`int` **get_selection_from_column**\ (\ caret_index\: :ref:`int` = 0\ ) |const| Returns the selection begin column. @@ -2555,7 +2558,7 @@ Returns the selection begin column. .. rst-class:: classref-method -:ref:`int` **get_selection_from_line** **(** :ref:`int` caret_index=0 **)** |const| +:ref:`int` **get_selection_from_line**\ (\ caret_index\: :ref:`int` = 0\ ) |const| Returns the selection begin line. @@ -2567,7 +2570,7 @@ Returns the selection begin line. .. rst-class:: classref-method -:ref:`int` **get_selection_line** **(** :ref:`int` caret_index=0 **)** |const| +:ref:`int` **get_selection_line**\ (\ caret_index\: :ref:`int` = 0\ ) |const| Returns the original start line of the selection. @@ -2579,7 +2582,7 @@ Returns the original start line of the selection. .. rst-class:: classref-method -:ref:`SelectionMode` **get_selection_mode** **(** **)** |const| +:ref:`SelectionMode` **get_selection_mode**\ (\ ) |const| Returns the current selection mode. @@ -2591,7 +2594,7 @@ Returns the current selection mode. .. rst-class:: classref-method -:ref:`int` **get_selection_to_column** **(** :ref:`int` caret_index=0 **)** |const| +:ref:`int` **get_selection_to_column**\ (\ caret_index\: :ref:`int` = 0\ ) |const| Returns the selection end column. @@ -2603,7 +2606,7 @@ Returns the selection end column. .. rst-class:: classref-method -:ref:`int` **get_selection_to_line** **(** :ref:`int` caret_index=0 **)** |const| +:ref:`int` **get_selection_to_line**\ (\ caret_index\: :ref:`int` = 0\ ) |const| Returns the selection end line. @@ -2615,7 +2618,7 @@ Returns the selection end line. .. rst-class:: classref-method -:ref:`int` **get_tab_size** **(** **)** |const| +:ref:`int` **get_tab_size**\ (\ ) |const| Returns the **TextEdit**'s' tab size. @@ -2627,7 +2630,7 @@ Returns the **TextEdit**'s' tab size. .. rst-class:: classref-method -:ref:`int` **get_total_gutter_width** **(** **)** |const| +:ref:`int` **get_total_gutter_width**\ (\ ) |const| Returns the total width of all gutters and internal padding. @@ -2639,7 +2642,7 @@ Returns the total width of all gutters and internal padding. .. rst-class:: classref-method -:ref:`int` **get_total_visible_line_count** **(** **)** |const| +:ref:`int` **get_total_visible_line_count**\ (\ ) |const| Returns the number of lines that may be drawn. @@ -2651,7 +2654,7 @@ Returns the number of lines that may be drawn. .. rst-class:: classref-method -:ref:`VScrollBar` **get_v_scroll_bar** **(** **)** |const| +:ref:`VScrollBar` **get_v_scroll_bar**\ (\ ) |const| Returns the :ref:`VScrollBar` of the **TextEdit**. @@ -2663,7 +2666,7 @@ Returns the :ref:`VScrollBar` of the **TextEdit**. .. rst-class:: classref-method -:ref:`int` **get_version** **(** **)** |const| +:ref:`int` **get_version**\ (\ ) |const| Returns the current version of the **TextEdit**. The version is a count of recorded operations by the undo/redo history. @@ -2675,7 +2678,7 @@ Returns the current version of the **TextEdit**. The version is a count of recor .. rst-class:: classref-method -:ref:`int` **get_visible_line_count** **(** **)** |const| +:ref:`int` **get_visible_line_count**\ (\ ) |const| Returns the number of visible lines, including wrapped text. @@ -2687,7 +2690,7 @@ Returns the number of visible lines, including wrapped text. .. rst-class:: classref-method -:ref:`int` **get_visible_line_count_in_range** **(** :ref:`int` from_line, :ref:`int` to_line **)** |const| +:ref:`int` **get_visible_line_count_in_range**\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) |const| Returns the total number of visible + wrapped lines between the two lines. @@ -2699,7 +2702,7 @@ Returns the total number of visible + wrapped lines between the two lines. .. rst-class:: classref-method -:ref:`String` **get_word_at_pos** **(** :ref:`Vector2` position **)** |const| +:ref:`String` **get_word_at_pos**\ (\ position\: :ref:`Vector2`\ ) |const| Returns the word at ``position``. @@ -2711,7 +2714,7 @@ Returns the word at ``position``. .. rst-class:: classref-method -:ref:`String` **get_word_under_caret** **(** :ref:`int` caret_index=-1 **)** |const| +:ref:`String` **get_word_under_caret**\ (\ caret_index\: :ref:`int` = -1\ ) |const| Returns a :ref:`String` text with the word under the caret's location. @@ -2723,7 +2726,7 @@ Returns a :ref:`String` text with the word under the caret's locat .. rst-class:: classref-method -:ref:`bool` **has_ime_text** **(** **)** |const| +:ref:`bool` **has_ime_text**\ (\ ) |const| Returns ``true`` if the user has text in the `Input Method Editor `__ (IME). @@ -2735,7 +2738,7 @@ Returns ``true`` if the user has text in the `Input Method Editor ` **has_redo** **(** **)** |const| +:ref:`bool` **has_redo**\ (\ ) |const| Returns ``true`` if a "redo" action is available. @@ -2747,7 +2750,7 @@ Returns ``true`` if a "redo" action is available. .. rst-class:: classref-method -:ref:`bool` **has_selection** **(** :ref:`int` caret_index=-1 **)** |const| +:ref:`bool` **has_selection**\ (\ caret_index\: :ref:`int` = -1\ ) |const| Returns ``true`` if the user has selected text. @@ -2759,7 +2762,7 @@ Returns ``true`` if the user has selected text. .. rst-class:: classref-method -:ref:`bool` **has_undo** **(** **)** |const| +:ref:`bool` **has_undo**\ (\ ) |const| Returns ``true`` if an "undo" action is available. @@ -2771,7 +2774,7 @@ Returns ``true`` if an "undo" action is available. .. rst-class:: classref-method -void **insert_line_at** **(** :ref:`int` line, :ref:`String` text **)** +|void| **insert_line_at**\ (\ line\: :ref:`int`, text\: :ref:`String`\ ) Inserts a new line with ``text`` at ``line``. @@ -2783,7 +2786,7 @@ Inserts a new line with ``text`` at ``line``. .. rst-class:: classref-method -void **insert_text_at_caret** **(** :ref:`String` text, :ref:`int` caret_index=-1 **)** +|void| **insert_text_at_caret**\ (\ text\: :ref:`String`, caret_index\: :ref:`int` = -1\ ) Insert the specified text at the caret position. @@ -2795,7 +2798,7 @@ Insert the specified text at the caret position. .. rst-class:: classref-method -:ref:`bool` **is_caret_visible** **(** :ref:`int` caret_index=0 **)** |const| +:ref:`bool` **is_caret_visible**\ (\ caret_index\: :ref:`int` = 0\ ) |const| Returns ``true`` if the caret is visible on the screen. @@ -2807,7 +2810,7 @@ Returns ``true`` if the caret is visible on the screen. .. rst-class:: classref-method -:ref:`bool` **is_dragging_cursor** **(** **)** |const| +:ref:`bool` **is_dragging_cursor**\ (\ ) |const| Returns ``true`` if the user is dragging their mouse for scrolling or selecting. @@ -2819,7 +2822,7 @@ Returns ``true`` if the user is dragging their mouse for scrolling or selecting. .. rst-class:: classref-method -:ref:`bool` **is_gutter_clickable** **(** :ref:`int` gutter **)** |const| +:ref:`bool` **is_gutter_clickable**\ (\ gutter\: :ref:`int`\ ) |const| Returns whether the gutter is clickable. @@ -2831,7 +2834,7 @@ Returns whether the gutter is clickable. .. rst-class:: classref-method -:ref:`bool` **is_gutter_drawn** **(** :ref:`int` gutter **)** |const| +:ref:`bool` **is_gutter_drawn**\ (\ gutter\: :ref:`int`\ ) |const| Returns whether the gutter is currently drawn. @@ -2843,7 +2846,7 @@ Returns whether the gutter is currently drawn. .. rst-class:: classref-method -:ref:`bool` **is_gutter_overwritable** **(** :ref:`int` gutter **)** |const| +:ref:`bool` **is_gutter_overwritable**\ (\ gutter\: :ref:`int`\ ) |const| Returns whether the gutter is overwritable. @@ -2855,7 +2858,7 @@ Returns whether the gutter is overwritable. .. rst-class:: classref-method -:ref:`bool` **is_line_gutter_clickable** **(** :ref:`int` line, :ref:`int` gutter **)** |const| +:ref:`bool` **is_line_gutter_clickable**\ (\ line\: :ref:`int`, gutter\: :ref:`int`\ ) |const| Returns whether the gutter on the given line is clickable. @@ -2867,7 +2870,7 @@ Returns whether the gutter on the given line is clickable. .. rst-class:: classref-method -:ref:`bool` **is_line_wrapped** **(** :ref:`int` line **)** |const| +:ref:`bool` **is_line_wrapped**\ (\ line\: :ref:`int`\ ) |const| Returns if the given line is wrapped. @@ -2879,7 +2882,7 @@ Returns if the given line is wrapped. .. rst-class:: classref-method -:ref:`bool` **is_menu_visible** **(** **)** |const| +:ref:`bool` **is_menu_visible**\ (\ ) |const| Returns whether the menu is visible. Use this instead of ``get_menu().visible`` to improve performance (so the creation of the menu is avoided). @@ -2891,7 +2894,7 @@ Returns whether the menu is visible. Use this instead of ``get_menu().visible`` .. rst-class:: classref-method -:ref:`bool` **is_mouse_over_selection** **(** :ref:`bool` edges, :ref:`int` caret_index=-1 **)** |const| +:ref:`bool` **is_mouse_over_selection**\ (\ edges\: :ref:`bool`, caret_index\: :ref:`int` = -1\ ) |const| Returns whether the mouse is over selection. If ``edges`` is ``true``, the edges are considered part of the selection. @@ -2903,7 +2906,7 @@ Returns whether the mouse is over selection. If ``edges`` is ``true``, the edges .. rst-class:: classref-method -:ref:`bool` **is_overtype_mode_enabled** **(** **)** |const| +:ref:`bool` **is_overtype_mode_enabled**\ (\ ) |const| Returns whether the user is in overtype mode. @@ -2915,7 +2918,7 @@ Returns whether the user is in overtype mode. .. rst-class:: classref-method -void **menu_option** **(** :ref:`int` option **)** +|void| **menu_option**\ (\ option\: :ref:`int`\ ) Executes a given action as defined in the :ref:`MenuItems` enum. @@ -2927,7 +2930,7 @@ Executes a given action as defined in the :ref:`MenuItems` from_line, :ref:`int` to_line **)** +|void| **merge_gutters**\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) Merge the gutters from ``from_line`` into ``to_line``. Only overwritable gutters will be copied. @@ -2939,7 +2942,7 @@ Merge the gutters from ``from_line`` into ``to_line``. Only overwritable gutters .. rst-class:: classref-method -void **merge_overlapping_carets** **(** **)** +|void| **merge_overlapping_carets**\ (\ ) Merges any overlapping carets. Will favor the newest caret, or the caret with a selection. @@ -2953,7 +2956,7 @@ Merges any overlapping carets. Will favor the newest caret, or the caret with a .. rst-class:: classref-method -void **paste** **(** :ref:`int` caret_index=-1 **)** +|void| **paste**\ (\ caret_index\: :ref:`int` = -1\ ) Paste at the current location. Can be overridden with :ref:`_paste`. @@ -2965,7 +2968,7 @@ Paste at the current location. Can be overridden with :ref:`_paste` caret_index=-1 **)** +|void| **paste_primary_clipboard**\ (\ caret_index\: :ref:`int` = -1\ ) Pastes the primary clipboard. @@ -2977,7 +2980,7 @@ Pastes the primary clipboard. .. rst-class:: classref-method -void **redo** **(** **)** +|void| **redo**\ (\ ) Perform redo operation. @@ -2989,7 +2992,7 @@ Perform redo operation. .. rst-class:: classref-method -void **remove_caret** **(** :ref:`int` caret **)** +|void| **remove_caret**\ (\ caret\: :ref:`int`\ ) Removes the given caret index. @@ -3003,7 +3006,7 @@ Removes the given caret index. .. rst-class:: classref-method -void **remove_gutter** **(** :ref:`int` gutter **)** +|void| **remove_gutter**\ (\ gutter\: :ref:`int`\ ) Removes the gutter from this **TextEdit**. @@ -3015,7 +3018,7 @@ Removes the gutter from this **TextEdit**. .. rst-class:: classref-method -void **remove_secondary_carets** **(** **)** +|void| **remove_secondary_carets**\ (\ ) Removes all additional carets. @@ -3027,7 +3030,7 @@ Removes all additional carets. .. rst-class:: classref-method -void **remove_text** **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** +|void| **remove_text**\ (\ from_line\: :ref:`int`, from_column\: :ref:`int`, to_line\: :ref:`int`, to_column\: :ref:`int`\ ) Removes text between the given positions. @@ -3041,7 +3044,7 @@ Removes text between the given positions. .. rst-class:: classref-method -:ref:`Vector2i` **search** **(** :ref:`String` text, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_colum **)** |const| +:ref:`Vector2i` **search**\ (\ text\: :ref:`String`, flags\: :ref:`int`, from_line\: :ref:`int`, from_colum\: :ref:`int`\ ) |const| Perform a search inside the text. Search flags can be specified in the :ref:`SearchFlags` enum. @@ -3078,7 +3081,7 @@ In the returned vector, ``x`` is the column, ``y`` is the line. If no results ar .. rst-class:: classref-method -void **select** **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column, :ref:`int` caret_index=0 **)** +|void| **select**\ (\ from_line\: :ref:`int`, from_column\: :ref:`int`, to_line\: :ref:`int`, to_column\: :ref:`int`, caret_index\: :ref:`int` = 0\ ) Perform selection, from line/column to line/column. @@ -3092,7 +3095,7 @@ If :ref:`selecting_enabled` is ``fals .. rst-class:: classref-method -void **select_all** **(** **)** +|void| **select_all**\ (\ ) Select all the text. @@ -3106,7 +3109,7 @@ If :ref:`selecting_enabled` is ``fals .. rst-class:: classref-method -void **select_word_under_caret** **(** :ref:`int` caret_index=-1 **)** +|void| **select_word_under_caret**\ (\ caret_index\: :ref:`int` = -1\ ) Selects the word under the caret. @@ -3118,7 +3121,7 @@ Selects the word under the caret. .. rst-class:: classref-method -void **set_caret_column** **(** :ref:`int` column, :ref:`bool` adjust_viewport=true, :ref:`int` caret_index=0 **)** +|void| **set_caret_column**\ (\ column\: :ref:`int`, adjust_viewport\: :ref:`bool` = true, caret_index\: :ref:`int` = 0\ ) Moves the caret to the specified ``column`` index. @@ -3134,7 +3137,7 @@ If ``adjust_viewport`` is ``true``, the viewport will center at the caret positi .. rst-class:: classref-method -void **set_caret_line** **(** :ref:`int` line, :ref:`bool` adjust_viewport=true, :ref:`bool` can_be_hidden=true, :ref:`int` wrap_index=0, :ref:`int` caret_index=0 **)** +|void| **set_caret_line**\ (\ line\: :ref:`int`, adjust_viewport\: :ref:`bool` = true, can_be_hidden\: :ref:`bool` = true, wrap_index\: :ref:`int` = 0, caret_index\: :ref:`int` = 0\ ) Moves the caret to the specified ``line`` index. @@ -3152,7 +3155,7 @@ If ``can_be_hidden`` is ``true``, the specified ``line`` can be hidden. .. rst-class:: classref-method -void **set_gutter_clickable** **(** :ref:`int` gutter, :ref:`bool` clickable **)** +|void| **set_gutter_clickable**\ (\ gutter\: :ref:`int`, clickable\: :ref:`bool`\ ) Sets the gutter as clickable. This will change the mouse cursor to a pointing hand when hovering over the gutter. @@ -3164,7 +3167,7 @@ Sets the gutter as clickable. This will change the mouse cursor to a pointing ha .. rst-class:: classref-method -void **set_gutter_custom_draw** **(** :ref:`int` column, :ref:`Callable` draw_callback **)** +|void| **set_gutter_custom_draw**\ (\ column\: :ref:`int`, draw_callback\: :ref:`Callable`\ ) Set a custom draw method for the gutter. The callback method must take the following args: ``line: int, gutter: int, Area: Rect2``. @@ -3176,7 +3179,7 @@ Set a custom draw method for the gutter. The callback method must take the follo .. rst-class:: classref-method -void **set_gutter_draw** **(** :ref:`int` gutter, :ref:`bool` draw **)** +|void| **set_gutter_draw**\ (\ gutter\: :ref:`int`, draw\: :ref:`bool`\ ) Sets whether the gutter should be drawn. @@ -3188,7 +3191,7 @@ Sets whether the gutter should be drawn. .. rst-class:: classref-method -void **set_gutter_name** **(** :ref:`int` gutter, :ref:`String` name **)** +|void| **set_gutter_name**\ (\ gutter\: :ref:`int`, name\: :ref:`String`\ ) Sets the name of the gutter. @@ -3200,7 +3203,7 @@ Sets the name of the gutter. .. rst-class:: classref-method -void **set_gutter_overwritable** **(** :ref:`int` gutter, :ref:`bool` overwritable **)** +|void| **set_gutter_overwritable**\ (\ gutter\: :ref:`int`, overwritable\: :ref:`bool`\ ) Sets the gutter to overwritable. See :ref:`merge_gutters`. @@ -3212,7 +3215,7 @@ Sets the gutter to overwritable. See :ref:`merge_gutters` gutter, :ref:`GutterType` type **)** +|void| **set_gutter_type**\ (\ gutter\: :ref:`int`, type\: :ref:`GutterType`\ ) Sets the type of gutter. @@ -3224,7 +3227,7 @@ Sets the type of gutter. .. rst-class:: classref-method -void **set_gutter_width** **(** :ref:`int` gutter, :ref:`int` width **)** +|void| **set_gutter_width**\ (\ gutter\: :ref:`int`, width\: :ref:`int`\ ) Set the width of the gutter. @@ -3236,7 +3239,7 @@ Set the width of the gutter. .. rst-class:: classref-method -void **set_line** **(** :ref:`int` line, :ref:`String` new_text **)** +|void| **set_line**\ (\ line\: :ref:`int`, new_text\: :ref:`String`\ ) Sets the text for a specific line. @@ -3248,7 +3251,7 @@ Sets the text for a specific line. .. rst-class:: classref-method -void **set_line_as_center_visible** **(** :ref:`int` line, :ref:`int` wrap_index=0 **)** +|void| **set_line_as_center_visible**\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) Positions the ``wrap_index`` of ``line`` at the center of the viewport. @@ -3260,7 +3263,7 @@ Positions the ``wrap_index`` of ``line`` at the center of the viewport. .. rst-class:: classref-method -void **set_line_as_first_visible** **(** :ref:`int` line, :ref:`int` wrap_index=0 **)** +|void| **set_line_as_first_visible**\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) Positions the ``wrap_index`` of ``line`` at the top of the viewport. @@ -3272,7 +3275,7 @@ Positions the ``wrap_index`` of ``line`` at the top of the viewport. .. rst-class:: classref-method -void **set_line_as_last_visible** **(** :ref:`int` line, :ref:`int` wrap_index=0 **)** +|void| **set_line_as_last_visible**\ (\ line\: :ref:`int`, wrap_index\: :ref:`int` = 0\ ) Positions the ``wrap_index`` of ``line`` at the bottom of the viewport. @@ -3284,7 +3287,7 @@ Positions the ``wrap_index`` of ``line`` at the bottom of the viewport. .. rst-class:: classref-method -void **set_line_background_color** **(** :ref:`int` line, :ref:`Color` color **)** +|void| **set_line_background_color**\ (\ line\: :ref:`int`, color\: :ref:`Color`\ ) Sets the current background color of the line. Set to ``Color(0, 0, 0, 0)`` for no color. @@ -3296,7 +3299,7 @@ Sets the current background color of the line. Set to ``Color(0, 0, 0, 0)`` for .. rst-class:: classref-method -void **set_line_gutter_clickable** **(** :ref:`int` line, :ref:`int` gutter, :ref:`bool` clickable **)** +|void| **set_line_gutter_clickable**\ (\ line\: :ref:`int`, gutter\: :ref:`int`, clickable\: :ref:`bool`\ ) If ``clickable`` is ``true``, makes the ``gutter`` on ``line`` clickable. See :ref:`gutter_clicked`. @@ -3308,7 +3311,7 @@ If ``clickable`` is ``true``, makes the ``gutter`` on ``line`` clickable. See :r .. rst-class:: classref-method -void **set_line_gutter_icon** **(** :ref:`int` line, :ref:`int` gutter, :ref:`Texture2D` icon **)** +|void| **set_line_gutter_icon**\ (\ line\: :ref:`int`, gutter\: :ref:`int`, icon\: :ref:`Texture2D`\ ) Sets the icon for ``gutter`` on ``line`` to ``icon``. @@ -3320,7 +3323,7 @@ Sets the icon for ``gutter`` on ``line`` to ``icon``. .. rst-class:: classref-method -void **set_line_gutter_item_color** **(** :ref:`int` line, :ref:`int` gutter, :ref:`Color` color **)** +|void| **set_line_gutter_item_color**\ (\ line\: :ref:`int`, gutter\: :ref:`int`, color\: :ref:`Color`\ ) Sets the color for ``gutter`` on ``line`` to ``color``. @@ -3332,7 +3335,7 @@ Sets the color for ``gutter`` on ``line`` to ``color``. .. rst-class:: classref-method -void **set_line_gutter_metadata** **(** :ref:`int` line, :ref:`int` gutter, :ref:`Variant` metadata **)** +|void| **set_line_gutter_metadata**\ (\ line\: :ref:`int`, gutter\: :ref:`int`, metadata\: :ref:`Variant`\ ) Sets the metadata for ``gutter`` on ``line`` to ``metadata``. @@ -3344,7 +3347,7 @@ Sets the metadata for ``gutter`` on ``line`` to ``metadata``. .. rst-class:: classref-method -void **set_line_gutter_text** **(** :ref:`int` line, :ref:`int` gutter, :ref:`String` text **)** +|void| **set_line_gutter_text**\ (\ line\: :ref:`int`, gutter\: :ref:`int`, text\: :ref:`String`\ ) Sets the text for ``gutter`` on ``line`` to ``text``. @@ -3356,7 +3359,7 @@ Sets the text for ``gutter`` on ``line`` to ``text``. .. rst-class:: classref-method -void **set_overtype_mode_enabled** **(** :ref:`bool` enabled **)** +|void| **set_overtype_mode_enabled**\ (\ enabled\: :ref:`bool`\ ) If ``true``, sets the user into overtype mode. When the user types in this mode, it will override existing text. @@ -3368,7 +3371,7 @@ If ``true``, sets the user into overtype mode. When the user types in this mode, .. rst-class:: classref-method -void **set_search_flags** **(** :ref:`int` flags **)** +|void| **set_search_flags**\ (\ flags\: :ref:`int`\ ) Sets the search ``flags``. This is used with :ref:`set_search_text` to highlight occurrences of the searched text. Search flags can be specified from the :ref:`SearchFlags` enum. @@ -3380,7 +3383,7 @@ Sets the search ``flags``. This is used with :ref:`set_search_text` search_text **)** +|void| **set_search_text**\ (\ search_text\: :ref:`String`\ ) Sets the search text. See :ref:`set_search_flags`. @@ -3392,7 +3395,7 @@ Sets the search text. See :ref:`set_search_flags` mode, :ref:`int` line=-1, :ref:`int` column=-1, :ref:`int` caret_index=0 **)** +|void| **set_selection_mode**\ (\ mode\: :ref:`SelectionMode`, line\: :ref:`int` = -1, column\: :ref:`int` = -1, caret_index\: :ref:`int` = 0\ ) Sets the current selection mode. @@ -3404,7 +3407,7 @@ Sets the current selection mode. .. rst-class:: classref-method -void **set_tab_size** **(** :ref:`int` size **)** +|void| **set_tab_size**\ (\ size\: :ref:`int`\ ) Sets the tab size for the **TextEdit** to use. @@ -3416,7 +3419,7 @@ Sets the tab size for the **TextEdit** to use. .. rst-class:: classref-method -void **set_tooltip_request_func** **(** :ref:`Callable` callback **)** +|void| **set_tooltip_request_func**\ (\ callback\: :ref:`Callable`\ ) Provide custom tooltip text. The callback method must take the following args: ``hovered_word: String``. @@ -3428,7 +3431,7 @@ Provide custom tooltip text. The callback method must take the following args: ` .. rst-class:: classref-method -void **start_action** **(** :ref:`EditAction` action **)** +|void| **start_action**\ (\ action\: :ref:`EditAction`\ ) Starts an action, will end the current action if ``action`` is different. @@ -3442,7 +3445,7 @@ An action will also end after a call to :ref:`end_action` from_line, :ref:`int` to_line **)** +|void| **swap_lines**\ (\ from_line\: :ref:`int`, to_line\: :ref:`int`\ ) Swaps the two lines. @@ -3454,7 +3457,7 @@ Swaps the two lines. .. rst-class:: classref-method -void **tag_saved_version** **(** **)** +|void| **tag_saved_version**\ (\ ) Tag the current version as saved. @@ -3466,7 +3469,7 @@ Tag the current version as saved. .. rst-class:: classref-method -void **undo** **(** **)** +|void| **undo**\ (\ ) Perform undo operation. @@ -3760,3 +3763,4 @@ Sets the :ref:`StyleBox` of this **TextEdit** when :ref:`editabl .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_textline.rst b/classes/class_textline.rst index 0f69e797601..32266616c78 100644 --- a/classes/class_textline.rst +++ b/classes/class_textline.rst @@ -36,7 +36,7 @@ Properties +---------------------------------------------------------------------------+-----------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`ellipsis_char` | ``"…"`` | +---------------------------------------------------------------------------+-----------------------------------------------------------------------------+-----------+ - | |bitfield|\<:ref:`JustificationFlag`\> | :ref:`flags` | ``3`` | + | |bitfield|\[:ref:`JustificationFlag`\] | :ref:`flags` | ``3`` | +---------------------------------------------------------------------------+-----------------------------------------------------------------------------+-----------+ | :ref:`Orientation` | :ref:`orientation` | ``0`` | +---------------------------------------------------------------------------+-----------------------------------------------------------------------------+-----------+ @@ -57,43 +57,43 @@ Methods .. table:: :widths: auto - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`add_object` **(** :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align=5, :ref:`int` length=1, :ref:`float` baseline=0.0 **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`add_string` **(** :ref:`String` text, :ref:`Font` font, :ref:`int` font_size, :ref:`String` language="", :ref:`Variant` meta=null **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw` **(** :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_outline` **(** :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`int` outline_size=1, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_ascent` **(** **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_descent` **(** **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_underline_position` **(** **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_underline_thickness` **(** **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_width` **(** **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_object_rect` **(** :ref:`Variant` key **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_objects` **(** **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_size` **(** **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`hit_test` **(** :ref:`float` coords **)** |const| | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`resize_object` **(** :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align=5, :ref:`float` baseline=0.0 **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bidi_override` **(** :ref:`Array` override **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`tab_align` **(** :ref:`PackedFloat32Array` tab_stops **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`add_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`add_string`\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_ascent`\ (\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_descent`\ (\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_underline_position`\ (\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_underline_thickness`\ (\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_width`\ (\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_object_rect`\ (\ key\: :ref:`Variant`\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_objects`\ (\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_size`\ (\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`hit_test`\ (\ coords\: :ref:`float`\ ) |const| | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`resize_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bidi_override`\ (\ override\: :ref:`Array`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tab_align`\ (\ tab_stops\: :ref:`PackedFloat32Array`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -112,8 +112,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_horizontal_alignment** **(** :ref:`HorizontalAlignment` value **)** -- :ref:`HorizontalAlignment` **get_horizontal_alignment** **(** **)** +- |void| **set_horizontal_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) +- :ref:`HorizontalAlignment` **get_horizontal_alignment**\ (\ ) Sets text alignment within the line as if the line was horizontal. @@ -129,8 +129,8 @@ Sets text alignment within the line as if the line was horizontal. .. rst-class:: classref-property-setget -- void **set_direction** **(** :ref:`Direction` value **)** -- :ref:`Direction` **get_direction** **(** **)** +- |void| **set_direction**\ (\ value\: :ref:`Direction`\ ) +- :ref:`Direction` **get_direction**\ (\ ) Text writing direction. @@ -146,8 +146,8 @@ Text writing direction. .. rst-class:: classref-property-setget -- void **set_ellipsis_char** **(** :ref:`String` value **)** -- :ref:`String` **get_ellipsis_char** **(** **)** +- |void| **set_ellipsis_char**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_ellipsis_char**\ (\ ) Ellipsis character used for text clipping. @@ -159,12 +159,12 @@ Ellipsis character used for text clipping. .. rst-class:: classref-property -|bitfield|\<:ref:`JustificationFlag`\> **flags** = ``3`` +|bitfield|\[:ref:`JustificationFlag`\] **flags** = ``3`` .. rst-class:: classref-property-setget -- void **set_flags** **(** |bitfield|\<:ref:`JustificationFlag`\> value **)** -- |bitfield|\<:ref:`JustificationFlag`\> **get_flags** **(** **)** +- |void| **set_flags**\ (\ value\: |bitfield|\[:ref:`JustificationFlag`\]\ ) +- |bitfield|\[:ref:`JustificationFlag`\] **get_flags**\ (\ ) Line alignment rules. For more info see :ref:`TextServer`. @@ -180,8 +180,8 @@ Line alignment rules. For more info see :ref:`TextServer`. .. rst-class:: classref-property-setget -- void **set_orientation** **(** :ref:`Orientation` value **)** -- :ref:`Orientation` **get_orientation** **(** **)** +- |void| **set_orientation**\ (\ value\: :ref:`Orientation`\ ) +- :ref:`Orientation` **get_orientation**\ (\ ) Text orientation. @@ -197,8 +197,8 @@ Text orientation. .. rst-class:: classref-property-setget -- void **set_preserve_control** **(** :ref:`bool` value **)** -- :ref:`bool` **get_preserve_control** **(** **)** +- |void| **set_preserve_control**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_preserve_control**\ (\ ) If set to ``true`` text will display control characters. @@ -214,8 +214,8 @@ If set to ``true`` text will display control characters. .. rst-class:: classref-property-setget -- void **set_preserve_invalid** **(** :ref:`bool` value **)** -- :ref:`bool` **get_preserve_invalid** **(** **)** +- |void| **set_preserve_invalid**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_preserve_invalid**\ (\ ) If set to ``true`` text will display invalid characters. @@ -231,8 +231,8 @@ If set to ``true`` text will display invalid characters. .. rst-class:: classref-property-setget -- void **set_text_overrun_behavior** **(** :ref:`OverrunBehavior` value **)** -- :ref:`OverrunBehavior` **get_text_overrun_behavior** **(** **)** +- |void| **set_text_overrun_behavior**\ (\ value\: :ref:`OverrunBehavior`\ ) +- :ref:`OverrunBehavior` **get_text_overrun_behavior**\ (\ ) Sets the clipping behavior when the text exceeds the text line's set width. See :ref:`OverrunBehavior` for a description of all modes. @@ -248,8 +248,8 @@ Sets the clipping behavior when the text exceeds the text line's set width. See .. rst-class:: classref-property-setget -- void **set_width** **(** :ref:`float` value **)** -- :ref:`float` **get_width** **(** **)** +- |void| **set_width**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_width**\ (\ ) Text line width. @@ -266,7 +266,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **add_object** **(** :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align=5, :ref:`int` length=1, :ref:`float` baseline=0.0 **)** +:ref:`bool` **add_object**\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) Adds inline object to the text buffer, ``key`` must be unique. In the text, object is represented as ``length`` object replacement characters. @@ -278,7 +278,7 @@ Adds inline object to the text buffer, ``key`` must be unique. In the text, obje .. rst-class:: classref-method -:ref:`bool` **add_string** **(** :ref:`String` text, :ref:`Font` font, :ref:`int` font_size, :ref:`String` language="", :ref:`Variant` meta=null **)** +:ref:`bool` **add_string**\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) Adds text span and font to draw it. @@ -290,7 +290,7 @@ Adds text span and font to draw it. .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears text line (removes text and inline objects). @@ -302,7 +302,7 @@ Clears text line (removes text and inline objects). .. rst-class:: classref-method -void **draw** **(** :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| +|void| **draw**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| Draw text into a canvas item at a given position, with ``color``. ``pos`` specifies the top left corner of the bounding box. @@ -314,7 +314,7 @@ Draw text into a canvas item at a given position, with ``color``. ``pos`` specif .. rst-class:: classref-method -void **draw_outline** **(** :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`int` outline_size=1, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| +|void| **draw_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| Draw text into a canvas item at a given position, with ``color``. ``pos`` specifies the top left corner of the bounding box. @@ -326,7 +326,7 @@ Draw text into a canvas item at a given position, with ``color``. ``pos`` specif .. rst-class:: classref-method -:ref:`float` **get_line_ascent** **(** **)** |const| +:ref:`float` **get_line_ascent**\ (\ ) |const| Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). @@ -338,7 +338,7 @@ Returns the text ascent (number of pixels above the baseline for horizontal layo .. rst-class:: classref-method -:ref:`float` **get_line_descent** **(** **)** |const| +:ref:`float` **get_line_descent**\ (\ ) |const| Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). @@ -350,7 +350,7 @@ Returns the text descent (number of pixels below the baseline for horizontal lay .. rst-class:: classref-method -:ref:`float` **get_line_underline_position** **(** **)** |const| +:ref:`float` **get_line_underline_position**\ (\ ) |const| Returns pixel offset of the underline below the baseline. @@ -362,7 +362,7 @@ Returns pixel offset of the underline below the baseline. .. rst-class:: classref-method -:ref:`float` **get_line_underline_thickness** **(** **)** |const| +:ref:`float` **get_line_underline_thickness**\ (\ ) |const| Returns thickness of the underline. @@ -374,7 +374,7 @@ Returns thickness of the underline. .. rst-class:: classref-method -:ref:`float` **get_line_width** **(** **)** |const| +:ref:`float` **get_line_width**\ (\ ) |const| Returns width (for horizontal layout) or height (for vertical) of the text. @@ -386,7 +386,7 @@ Returns width (for horizontal layout) or height (for vertical) of the text. .. rst-class:: classref-method -:ref:`Rect2` **get_object_rect** **(** :ref:`Variant` key **)** |const| +:ref:`Rect2` **get_object_rect**\ (\ key\: :ref:`Variant`\ ) |const| Returns bounding rectangle of the inline object. @@ -398,7 +398,7 @@ Returns bounding rectangle of the inline object. .. rst-class:: classref-method -:ref:`Array` **get_objects** **(** **)** |const| +:ref:`Array` **get_objects**\ (\ ) |const| Returns array of inline objects. @@ -410,7 +410,7 @@ Returns array of inline objects. .. rst-class:: classref-method -:ref:`RID` **get_rid** **(** **)** |const| +:ref:`RID` **get_rid**\ (\ ) |const| Returns TextServer buffer RID. @@ -422,7 +422,7 @@ Returns TextServer buffer RID. .. rst-class:: classref-method -:ref:`Vector2` **get_size** **(** **)** |const| +:ref:`Vector2` **get_size**\ (\ ) |const| Returns size of the bounding box of the text. @@ -434,7 +434,7 @@ Returns size of the bounding box of the text. .. rst-class:: classref-method -:ref:`int` **hit_test** **(** :ref:`float` coords **)** |const| +:ref:`int` **hit_test**\ (\ coords\: :ref:`float`\ ) |const| Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position. @@ -446,7 +446,7 @@ Returns caret character offset at the specified pixel offset at the baseline. Th .. rst-class:: classref-method -:ref:`bool` **resize_object** **(** :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align=5, :ref:`float` baseline=0.0 **)** +:ref:`bool` **resize_object**\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) Sets new size and alignment of embedded object. @@ -458,7 +458,7 @@ Sets new size and alignment of embedded object. .. rst-class:: classref-method -void **set_bidi_override** **(** :ref:`Array` override **)** +|void| **set_bidi_override**\ (\ override\: :ref:`Array`\ ) Overrides BiDi for the structured text. @@ -472,7 +472,7 @@ Override ranges should cover full source text without overlaps. BiDi algorithm w .. rst-class:: classref-method -void **tab_align** **(** :ref:`PackedFloat32Array` tab_stops **)** +|void| **tab_align**\ (\ tab_stops\: :ref:`PackedFloat32Array`\ ) Aligns text to the given tab-stops. @@ -483,3 +483,4 @@ Aligns text to the given tab-stops. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_textmesh.rst b/classes/class_textmesh.rst index 3eb1c2e79b4..0403ece32e4 100644 --- a/classes/class_textmesh.rst +++ b/classes/class_textmesh.rst @@ -53,7 +53,7 @@ Properties +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------+ | :ref:`HorizontalAlignment` | :ref:`horizontal_alignment` | ``1`` | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------+ - | |bitfield|\<:ref:`JustificationFlag`\> | :ref:`justification_flags` | ``163`` | + | |bitfield|\[:ref:`JustificationFlag`\] | :ref:`justification_flags` | ``163`` | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------+ | :ref:`String` | :ref:`language` | ``""`` | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------+ @@ -95,8 +95,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_autowrap_mode** **(** :ref:`AutowrapMode` value **)** -- :ref:`AutowrapMode` **get_autowrap_mode** **(** **)** +- |void| **set_autowrap_mode**\ (\ value\: :ref:`AutowrapMode`\ ) +- :ref:`AutowrapMode` **get_autowrap_mode**\ (\ ) If set to something other than :ref:`TextServer.AUTOWRAP_OFF`, the text gets wrapped inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. To see how each mode behaves, see :ref:`AutowrapMode`. @@ -112,8 +112,8 @@ If set to something other than :ref:`TextServer.AUTOWRAP_OFF` value **)** -- :ref:`float` **get_curve_step** **(** **)** +- |void| **set_curve_step**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_curve_step**\ (\ ) Step (in pixels) used to approximate Bézier curves. @@ -129,8 +129,8 @@ Step (in pixels) used to approximate Bézier curves. .. rst-class:: classref-property-setget -- void **set_depth** **(** :ref:`float` value **)** -- :ref:`float` **get_depth** **(** **)** +- |void| **set_depth**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_depth**\ (\ ) Depths of the mesh, if set to ``0.0`` only front surface, is generated, and UV layout is changed to use full texture for the front face only. @@ -146,8 +146,8 @@ Depths of the mesh, if set to ``0.0`` only front surface, is generated, and UV l .. rst-class:: classref-property-setget -- void **set_font** **(** :ref:`Font` value **)** -- :ref:`Font` **get_font** **(** **)** +- |void| **set_font**\ (\ value\: :ref:`Font`\ ) +- :ref:`Font` **get_font**\ (\ ) Font configuration used to display text. @@ -163,8 +163,8 @@ Font configuration used to display text. .. rst-class:: classref-property-setget -- void **set_font_size** **(** :ref:`int` value **)** -- :ref:`int` **get_font_size** **(** **)** +- |void| **set_font_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_font_size**\ (\ ) Font size of the **TextMesh**'s text. @@ -180,8 +180,8 @@ Font size of the **TextMesh**'s text. .. rst-class:: classref-property-setget -- void **set_horizontal_alignment** **(** :ref:`HorizontalAlignment` value **)** -- :ref:`HorizontalAlignment` **get_horizontal_alignment** **(** **)** +- |void| **set_horizontal_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) +- :ref:`HorizontalAlignment` **get_horizontal_alignment**\ (\ ) Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify. Set it to one of the :ref:`HorizontalAlignment` constants. @@ -193,12 +193,12 @@ Controls the text's horizontal alignment. Supports left, center, right, and fill .. rst-class:: classref-property -|bitfield|\<:ref:`JustificationFlag`\> **justification_flags** = ``163`` +|bitfield|\[:ref:`JustificationFlag`\] **justification_flags** = ``163`` .. rst-class:: classref-property-setget -- void **set_justification_flags** **(** |bitfield|\<:ref:`JustificationFlag`\> value **)** -- |bitfield|\<:ref:`JustificationFlag`\> **get_justification_flags** **(** **)** +- |void| **set_justification_flags**\ (\ value\: |bitfield|\[:ref:`JustificationFlag`\]\ ) +- |bitfield|\[:ref:`JustificationFlag`\] **get_justification_flags**\ (\ ) Line fill alignment rules. For more info see :ref:`JustificationFlag`. @@ -214,8 +214,8 @@ Line fill alignment rules. For more info see :ref:`JustificationFlag` value **)** -- :ref:`String` **get_language** **(** **)** +- |void| **set_language**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_language**\ (\ ) Language code used for text shaping algorithms, if left empty current locale is used instead. @@ -231,8 +231,8 @@ Language code used for text shaping algorithms, if left empty current locale is .. rst-class:: classref-property-setget -- void **set_line_spacing** **(** :ref:`float` value **)** -- :ref:`float` **get_line_spacing** **(** **)** +- |void| **set_line_spacing**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_line_spacing**\ (\ ) Vertical space between lines in multiline **TextMesh**. @@ -248,8 +248,8 @@ Vertical space between lines in multiline **TextMesh**. .. rst-class:: classref-property-setget -- void **set_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_offset** **(** **)** +- |void| **set_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_offset**\ (\ ) The text drawing offset (in pixels). @@ -265,8 +265,8 @@ The text drawing offset (in pixels). .. rst-class:: classref-property-setget -- void **set_pixel_size** **(** :ref:`float` value **)** -- :ref:`float` **get_pixel_size** **(** **)** +- |void| **set_pixel_size**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_pixel_size**\ (\ ) The size of one pixel's width on the text to scale it in 3D. @@ -282,8 +282,8 @@ The size of one pixel's width on the text to scale it in 3D. .. rst-class:: classref-property-setget -- void **set_structured_text_bidi_override** **(** :ref:`StructuredTextParser` value **)** -- :ref:`StructuredTextParser` **get_structured_text_bidi_override** **(** **)** +- |void| **set_structured_text_bidi_override**\ (\ value\: :ref:`StructuredTextParser`\ ) +- :ref:`StructuredTextParser` **get_structured_text_bidi_override**\ (\ ) Set BiDi algorithm override for the structured text. @@ -299,8 +299,8 @@ Set BiDi algorithm override for the structured text. .. rst-class:: classref-property-setget -- void **set_structured_text_bidi_override_options** **(** :ref:`Array` value **)** -- :ref:`Array` **get_structured_text_bidi_override_options** **(** **)** +- |void| **set_structured_text_bidi_override_options**\ (\ value\: :ref:`Array`\ ) +- :ref:`Array` **get_structured_text_bidi_override_options**\ (\ ) Set additional options for BiDi override. @@ -316,8 +316,8 @@ Set additional options for BiDi override. .. rst-class:: classref-property-setget -- void **set_text** **(** :ref:`String` value **)** -- :ref:`String` **get_text** **(** **)** +- |void| **set_text**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_text**\ (\ ) The text to generate mesh from. @@ -333,8 +333,8 @@ The text to generate mesh from. .. rst-class:: classref-property-setget -- void **set_text_direction** **(** :ref:`Direction` value **)** -- :ref:`Direction` **get_text_direction** **(** **)** +- |void| **set_text_direction**\ (\ value\: :ref:`Direction`\ ) +- :ref:`Direction` **get_text_direction**\ (\ ) Base text writing direction. @@ -350,8 +350,8 @@ Base text writing direction. .. rst-class:: classref-property-setget -- void **set_uppercase** **(** :ref:`bool` value **)** -- :ref:`bool` **is_uppercase** **(** **)** +- |void| **set_uppercase**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_uppercase**\ (\ ) If ``true``, all the text displays as UPPERCASE. @@ -367,8 +367,8 @@ If ``true``, all the text displays as UPPERCASE. .. rst-class:: classref-property-setget -- void **set_vertical_alignment** **(** :ref:`VerticalAlignment` value **)** -- :ref:`VerticalAlignment` **get_vertical_alignment** **(** **)** +- |void| **set_vertical_alignment**\ (\ value\: :ref:`VerticalAlignment`\ ) +- :ref:`VerticalAlignment` **get_vertical_alignment**\ (\ ) Controls the text's vertical alignment. Supports top, center, bottom. Set it to one of the :ref:`VerticalAlignment` constants. @@ -384,8 +384,8 @@ Controls the text's vertical alignment. Supports top, center, bottom. Set it to .. rst-class:: classref-property-setget -- void **set_width** **(** :ref:`float` value **)** -- :ref:`float` **get_width** **(** **)** +- |void| **set_width**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_width**\ (\ ) Text width (in pixels), used for fill alignment. @@ -396,3 +396,4 @@ Text width (in pixels), used for fill alignment. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_textparagraph.rst b/classes/class_textparagraph.rst index 20f8d6ddb5d..cab48907aa8 100644 --- a/classes/class_textparagraph.rst +++ b/classes/class_textparagraph.rst @@ -32,7 +32,7 @@ Properties +---------------------------------------------------------------------------+----------------------------------------------------------------------------------+-----------+ | :ref:`HorizontalAlignment` | :ref:`alignment` | ``0`` | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------+-----------+ - | |bitfield|\<:ref:`LineBreakFlag`\> | :ref:`break_flags` | ``3`` | + | |bitfield|\[:ref:`LineBreakFlag`\] | :ref:`break_flags` | ``3`` | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`custom_punctuation` | ``""`` | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------+-----------+ @@ -40,7 +40,7 @@ Properties +---------------------------------------------------------------------------+----------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`ellipsis_char` | ``"…"`` | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------+-----------+ - | |bitfield|\<:ref:`JustificationFlag`\> | :ref:`justification_flags` | ``163`` | + | |bitfield|\[:ref:`JustificationFlag`\] | :ref:`justification_flags` | ``163`` | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`max_lines_visible` | ``-1`` | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------+-----------+ @@ -63,71 +63,71 @@ Methods .. table:: :widths: auto - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`add_object` **(** :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align=5, :ref:`int` length=1, :ref:`float` baseline=0.0 **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`add_string` **(** :ref:`String` text, :ref:`Font` font, :ref:`int` font_size, :ref:`String` language="", :ref:`Variant` meta=null **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_dropcap` **(** **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw` **(** :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`Color` color=Color(1, 1, 1, 1), :ref:`Color` dc_color=Color(1, 1, 1, 1) **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_dropcap` **(** :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_dropcap_outline` **(** :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`int` outline_size=1, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_line` **(** :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`int` line, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_line_outline` **(** :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`int` line, :ref:`int` outline_size=1, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_outline` **(** :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`int` outline_size=1, :ref:`Color` color=Color(1, 1, 1, 1), :ref:`Color` dc_color=Color(1, 1, 1, 1) **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_dropcap_lines` **(** **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_dropcap_rid` **(** **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_dropcap_size` **(** **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_ascent` **(** :ref:`int` line **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_count` **(** **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_descent` **(** :ref:`int` line **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_line_object_rect` **(** :ref:`int` line, :ref:`Variant` key **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_line_objects` **(** :ref:`int` line **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_line_range` **(** :ref:`int` line **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_line_rid` **(** :ref:`int` line **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_line_size` **(** :ref:`int` line **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_underline_position` **(** :ref:`int` line **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_underline_thickness` **(** :ref:`int` line **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_width` **(** :ref:`int` line **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_non_wrapped_size` **(** **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_size` **(** **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`hit_test` **(** :ref:`Vector2` coords **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`resize_object` **(** :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align=5, :ref:`float` baseline=0.0 **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_bidi_override` **(** :ref:`Array` override **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`set_dropcap` **(** :ref:`String` text, :ref:`Font` font, :ref:`int` font_size, :ref:`Rect2` dropcap_margins=Rect2(0, 0, 0, 0), :ref:`String` language="" **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`tab_align` **(** :ref:`PackedFloat32Array` tab_stops **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`add_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`add_string`\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_dropcap`\ (\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_dropcap`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_dropcap_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_line`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_line_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_dropcap_lines`\ (\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_dropcap_rid`\ (\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_dropcap_size`\ (\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_ascent`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_count`\ (\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_descent`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_line_object_rect`\ (\ line\: :ref:`int`, key\: :ref:`Variant`\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_line_objects`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_line_range`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_line_rid`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_line_size`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_underline_position`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_underline_thickness`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_width`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_non_wrapped_size`\ (\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_size`\ (\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`hit_test`\ (\ coords\: :ref:`Vector2`\ ) |const| | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`resize_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bidi_override`\ (\ override\: :ref:`Array`\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`set_dropcap`\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, dropcap_margins\: :ref:`Rect2` = Rect2(0, 0, 0, 0), language\: :ref:`String` = ""\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tab_align`\ (\ tab_stops\: :ref:`PackedFloat32Array`\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -146,8 +146,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_alignment** **(** :ref:`HorizontalAlignment` value **)** -- :ref:`HorizontalAlignment` **get_alignment** **(** **)** +- |void| **set_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) +- :ref:`HorizontalAlignment` **get_alignment**\ (\ ) Paragraph horizontal alignment. @@ -159,12 +159,12 @@ Paragraph horizontal alignment. .. rst-class:: classref-property -|bitfield|\<:ref:`LineBreakFlag`\> **break_flags** = ``3`` +|bitfield|\[:ref:`LineBreakFlag`\] **break_flags** = ``3`` .. rst-class:: classref-property-setget -- void **set_break_flags** **(** |bitfield|\<:ref:`LineBreakFlag`\> value **)** -- |bitfield|\<:ref:`LineBreakFlag`\> **get_break_flags** **(** **)** +- |void| **set_break_flags**\ (\ value\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) +- |bitfield|\[:ref:`LineBreakFlag`\] **get_break_flags**\ (\ ) Line breaking rules. For more info see :ref:`TextServer`. @@ -180,8 +180,8 @@ Line breaking rules. For more info see :ref:`TextServer`. .. rst-class:: classref-property-setget -- void **set_custom_punctuation** **(** :ref:`String` value **)** -- :ref:`String` **get_custom_punctuation** **(** **)** +- |void| **set_custom_punctuation**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_custom_punctuation**\ (\ ) Custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. @@ -197,8 +197,8 @@ Custom punctuation character list, used for word breaking. If set to empty strin .. rst-class:: classref-property-setget -- void **set_direction** **(** :ref:`Direction` value **)** -- :ref:`Direction` **get_direction** **(** **)** +- |void| **set_direction**\ (\ value\: :ref:`Direction`\ ) +- :ref:`Direction` **get_direction**\ (\ ) Text writing direction. @@ -214,8 +214,8 @@ Text writing direction. .. rst-class:: classref-property-setget -- void **set_ellipsis_char** **(** :ref:`String` value **)** -- :ref:`String` **get_ellipsis_char** **(** **)** +- |void| **set_ellipsis_char**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_ellipsis_char**\ (\ ) Ellipsis character used for text clipping. @@ -227,12 +227,12 @@ Ellipsis character used for text clipping. .. rst-class:: classref-property -|bitfield|\<:ref:`JustificationFlag`\> **justification_flags** = ``163`` +|bitfield|\[:ref:`JustificationFlag`\] **justification_flags** = ``163`` .. rst-class:: classref-property-setget -- void **set_justification_flags** **(** |bitfield|\<:ref:`JustificationFlag`\> value **)** -- |bitfield|\<:ref:`JustificationFlag`\> **get_justification_flags** **(** **)** +- |void| **set_justification_flags**\ (\ value\: |bitfield|\[:ref:`JustificationFlag`\]\ ) +- |bitfield|\[:ref:`JustificationFlag`\] **get_justification_flags**\ (\ ) Line fill alignment rules. For more info see :ref:`JustificationFlag`. @@ -248,8 +248,8 @@ Line fill alignment rules. For more info see :ref:`JustificationFlag` value **)** -- :ref:`int` **get_max_lines_visible** **(** **)** +- |void| **set_max_lines_visible**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_lines_visible**\ (\ ) Limits the lines of text shown. @@ -265,8 +265,8 @@ Limits the lines of text shown. .. rst-class:: classref-property-setget -- void **set_orientation** **(** :ref:`Orientation` value **)** -- :ref:`Orientation` **get_orientation** **(** **)** +- |void| **set_orientation**\ (\ value\: :ref:`Orientation`\ ) +- :ref:`Orientation` **get_orientation**\ (\ ) Text orientation. @@ -282,8 +282,8 @@ Text orientation. .. rst-class:: classref-property-setget -- void **set_preserve_control** **(** :ref:`bool` value **)** -- :ref:`bool` **get_preserve_control** **(** **)** +- |void| **set_preserve_control**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_preserve_control**\ (\ ) If set to ``true`` text will display control characters. @@ -299,8 +299,8 @@ If set to ``true`` text will display control characters. .. rst-class:: classref-property-setget -- void **set_preserve_invalid** **(** :ref:`bool` value **)** -- :ref:`bool` **get_preserve_invalid** **(** **)** +- |void| **set_preserve_invalid**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_preserve_invalid**\ (\ ) If set to ``true`` text will display invalid characters. @@ -316,8 +316,8 @@ If set to ``true`` text will display invalid characters. .. rst-class:: classref-property-setget -- void **set_text_overrun_behavior** **(** :ref:`OverrunBehavior` value **)** -- :ref:`OverrunBehavior` **get_text_overrun_behavior** **(** **)** +- |void| **set_text_overrun_behavior**\ (\ value\: :ref:`OverrunBehavior`\ ) +- :ref:`OverrunBehavior` **get_text_overrun_behavior**\ (\ ) Sets the clipping behavior when the text exceeds the paragraph's set width. See :ref:`OverrunBehavior` for a description of all modes. @@ -333,8 +333,8 @@ Sets the clipping behavior when the text exceeds the paragraph's set width. See .. rst-class:: classref-property-setget -- void **set_width** **(** :ref:`float` value **)** -- :ref:`float` **get_width** **(** **)** +- |void| **set_width**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_width**\ (\ ) Paragraph width. @@ -351,7 +351,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **add_object** **(** :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align=5, :ref:`int` length=1, :ref:`float` baseline=0.0 **)** +:ref:`bool` **add_object**\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) Adds inline object to the text buffer, ``key`` must be unique. In the text, object is represented as ``length`` object replacement characters. @@ -363,7 +363,7 @@ Adds inline object to the text buffer, ``key`` must be unique. In the text, obje .. rst-class:: classref-method -:ref:`bool` **add_string** **(** :ref:`String` text, :ref:`Font` font, :ref:`int` font_size, :ref:`String` language="", :ref:`Variant` meta=null **)** +:ref:`bool` **add_string**\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) Adds text span and font to draw it. @@ -375,7 +375,7 @@ Adds text span and font to draw it. .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears text paragraph (removes text and inline objects). @@ -387,7 +387,7 @@ Clears text paragraph (removes text and inline objects). .. rst-class:: classref-method -void **clear_dropcap** **(** **)** +|void| **clear_dropcap**\ (\ ) Removes dropcap. @@ -399,7 +399,7 @@ Removes dropcap. .. rst-class:: classref-method -void **draw** **(** :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`Color` color=Color(1, 1, 1, 1), :ref:`Color` dc_color=Color(1, 1, 1, 1) **)** |const| +|void| **draw**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| Draw all lines of the text and drop cap into a canvas item at a given position, with ``color``. ``pos`` specifies the top left corner of the bounding box. @@ -411,7 +411,7 @@ Draw all lines of the text and drop cap into a canvas item at a given position, .. rst-class:: classref-method -void **draw_dropcap** **(** :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| +|void| **draw_dropcap**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| Draw drop cap into a canvas item at a given position, with ``color``. ``pos`` specifies the top left corner of the bounding box. @@ -423,7 +423,7 @@ Draw drop cap into a canvas item at a given position, with ``color``. ``pos`` sp .. rst-class:: classref-method -void **draw_dropcap_outline** **(** :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`int` outline_size=1, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| +|void| **draw_dropcap_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| Draw drop cap outline into a canvas item at a given position, with ``color``. ``pos`` specifies the top left corner of the bounding box. @@ -435,7 +435,7 @@ Draw drop cap outline into a canvas item at a given position, with ``color``. `` .. rst-class:: classref-method -void **draw_line** **(** :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`int` line, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| +|void| **draw_line**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| Draw single line of text into a canvas item at a given position, with ``color``. ``pos`` specifies the top left corner of the bounding box. @@ -447,7 +447,7 @@ Draw single line of text into a canvas item at a given position, with ``color``. .. rst-class:: classref-method -void **draw_line_outline** **(** :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`int` line, :ref:`int` outline_size=1, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| +|void| **draw_line_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| Draw outline of the single line of text into a canvas item at a given position, with ``color``. ``pos`` specifies the top left corner of the bounding box. @@ -459,7 +459,7 @@ Draw outline of the single line of text into a canvas item at a given position, .. rst-class:: classref-method -void **draw_outline** **(** :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`int` outline_size=1, :ref:`Color` color=Color(1, 1, 1, 1), :ref:`Color` dc_color=Color(1, 1, 1, 1) **)** |const| +|void| **draw_outline**\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| Draw outlines of all lines of the text and drop cap into a canvas item at a given position, with ``color``. ``pos`` specifies the top left corner of the bounding box. @@ -471,7 +471,7 @@ Draw outlines of all lines of the text and drop cap into a canvas item at a give .. rst-class:: classref-method -:ref:`int` **get_dropcap_lines** **(** **)** |const| +:ref:`int` **get_dropcap_lines**\ (\ ) |const| Returns number of lines used by dropcap. @@ -483,7 +483,7 @@ Returns number of lines used by dropcap. .. rst-class:: classref-method -:ref:`RID` **get_dropcap_rid** **(** **)** |const| +:ref:`RID` **get_dropcap_rid**\ (\ ) |const| Returns drop cap text buffer RID. @@ -495,7 +495,7 @@ Returns drop cap text buffer RID. .. rst-class:: classref-method -:ref:`Vector2` **get_dropcap_size** **(** **)** |const| +:ref:`Vector2` **get_dropcap_size**\ (\ ) |const| Returns drop cap bounding box size. @@ -507,7 +507,7 @@ Returns drop cap bounding box size. .. rst-class:: classref-method -:ref:`float` **get_line_ascent** **(** :ref:`int` line **)** |const| +:ref:`float` **get_line_ascent**\ (\ line\: :ref:`int`\ ) |const| Returns the text line ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). @@ -519,7 +519,7 @@ Returns the text line ascent (number of pixels above the baseline for horizontal .. rst-class:: classref-method -:ref:`int` **get_line_count** **(** **)** |const| +:ref:`int` **get_line_count**\ (\ ) |const| Returns number of lines in the paragraph. @@ -531,7 +531,7 @@ Returns number of lines in the paragraph. .. rst-class:: classref-method -:ref:`float` **get_line_descent** **(** :ref:`int` line **)** |const| +:ref:`float` **get_line_descent**\ (\ line\: :ref:`int`\ ) |const| Returns the text line descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). @@ -543,7 +543,7 @@ Returns the text line descent (number of pixels below the baseline for horizonta .. rst-class:: classref-method -:ref:`Rect2` **get_line_object_rect** **(** :ref:`int` line, :ref:`Variant` key **)** |const| +:ref:`Rect2` **get_line_object_rect**\ (\ line\: :ref:`int`, key\: :ref:`Variant`\ ) |const| Returns bounding rectangle of the inline object. @@ -555,7 +555,7 @@ Returns bounding rectangle of the inline object. .. rst-class:: classref-method -:ref:`Array` **get_line_objects** **(** :ref:`int` line **)** |const| +:ref:`Array` **get_line_objects**\ (\ line\: :ref:`int`\ ) |const| Returns array of inline objects in the line. @@ -567,7 +567,7 @@ Returns array of inline objects in the line. .. rst-class:: classref-method -:ref:`Vector2i` **get_line_range** **(** :ref:`int` line **)** |const| +:ref:`Vector2i` **get_line_range**\ (\ line\: :ref:`int`\ ) |const| Returns character range of the line. @@ -579,7 +579,7 @@ Returns character range of the line. .. rst-class:: classref-method -:ref:`RID` **get_line_rid** **(** :ref:`int` line **)** |const| +:ref:`RID` **get_line_rid**\ (\ line\: :ref:`int`\ ) |const| Returns TextServer line buffer RID. @@ -591,7 +591,7 @@ Returns TextServer line buffer RID. .. rst-class:: classref-method -:ref:`Vector2` **get_line_size** **(** :ref:`int` line **)** |const| +:ref:`Vector2` **get_line_size**\ (\ line\: :ref:`int`\ ) |const| Returns size of the bounding box of the line of text. @@ -603,7 +603,7 @@ Returns size of the bounding box of the line of text. .. rst-class:: classref-method -:ref:`float` **get_line_underline_position** **(** :ref:`int` line **)** |const| +:ref:`float` **get_line_underline_position**\ (\ line\: :ref:`int`\ ) |const| Returns pixel offset of the underline below the baseline. @@ -615,7 +615,7 @@ Returns pixel offset of the underline below the baseline. .. rst-class:: classref-method -:ref:`float` **get_line_underline_thickness** **(** :ref:`int` line **)** |const| +:ref:`float` **get_line_underline_thickness**\ (\ line\: :ref:`int`\ ) |const| Returns thickness of the underline. @@ -627,7 +627,7 @@ Returns thickness of the underline. .. rst-class:: classref-method -:ref:`float` **get_line_width** **(** :ref:`int` line **)** |const| +:ref:`float` **get_line_width**\ (\ line\: :ref:`int`\ ) |const| Returns width (for horizontal layout) or height (for vertical) of the line of text. @@ -639,7 +639,7 @@ Returns width (for horizontal layout) or height (for vertical) of the line of te .. rst-class:: classref-method -:ref:`Vector2` **get_non_wrapped_size** **(** **)** |const| +:ref:`Vector2` **get_non_wrapped_size**\ (\ ) |const| Returns the size of the bounding box of the paragraph, without line breaks. @@ -651,7 +651,7 @@ Returns the size of the bounding box of the paragraph, without line breaks. .. rst-class:: classref-method -:ref:`RID` **get_rid** **(** **)** |const| +:ref:`RID` **get_rid**\ (\ ) |const| Returns TextServer full string buffer RID. @@ -663,7 +663,7 @@ Returns TextServer full string buffer RID. .. rst-class:: classref-method -:ref:`Vector2` **get_size** **(** **)** |const| +:ref:`Vector2` **get_size**\ (\ ) |const| Returns the size of the bounding box of the paragraph. @@ -675,7 +675,7 @@ Returns the size of the bounding box of the paragraph. .. rst-class:: classref-method -:ref:`int` **hit_test** **(** :ref:`Vector2` coords **)** |const| +:ref:`int` **hit_test**\ (\ coords\: :ref:`Vector2`\ ) |const| Returns caret character offset at the specified coordinates. This function always returns a valid position. @@ -687,7 +687,7 @@ Returns caret character offset at the specified coordinates. This function alway .. rst-class:: classref-method -:ref:`bool` **resize_object** **(** :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align=5, :ref:`float` baseline=0.0 **)** +:ref:`bool` **resize_object**\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) Sets new size and alignment of embedded object. @@ -699,7 +699,7 @@ Sets new size and alignment of embedded object. .. rst-class:: classref-method -void **set_bidi_override** **(** :ref:`Array` override **)** +|void| **set_bidi_override**\ (\ override\: :ref:`Array`\ ) Overrides BiDi for the structured text. @@ -713,7 +713,7 @@ Override ranges should cover full source text without overlaps. BiDi algorithm w .. rst-class:: classref-method -:ref:`bool` **set_dropcap** **(** :ref:`String` text, :ref:`Font` font, :ref:`int` font_size, :ref:`Rect2` dropcap_margins=Rect2(0, 0, 0, 0), :ref:`String` language="" **)** +:ref:`bool` **set_dropcap**\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, dropcap_margins\: :ref:`Rect2` = Rect2(0, 0, 0, 0), language\: :ref:`String` = ""\ ) Sets drop cap, overrides previously set drop cap. Drop cap (dropped capital) is a decorative element at the beginning of a paragraph that is larger than the rest of the text. @@ -725,7 +725,7 @@ Sets drop cap, overrides previously set drop cap. Drop cap (dropped capital) is .. rst-class:: classref-method -void **tab_align** **(** :ref:`PackedFloat32Array` tab_stops **)** +|void| **tab_align**\ (\ tab_stops\: :ref:`PackedFloat32Array`\ ) Aligns paragraph to the given tab-stops. @@ -736,3 +736,4 @@ Aligns paragraph to the given tab-stops. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_textserver.rst b/classes/class_textserver.rst index 311c20edf31..80fff1d6be2 100644 --- a/classes/class_textserver.rst +++ b/classes/class_textserver.rst @@ -31,421 +31,421 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`create_font` **(** **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`create_font_linked_variation` **(** :ref:`RID` font_rid **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`create_shaped_text` **(** :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_hex_code_box` **(** :ref:`RID` canvas, :ref:`int` size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_clear_glyphs` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_clear_kerning_map` **(** :ref:`RID` font_rid, :ref:`int` size **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_clear_size_cache` **(** :ref:`RID` font_rid **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_clear_textures` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_draw_glyph` **(** :ref:`RID` font_rid, :ref:`RID` canvas, :ref:`int` size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_draw_glyph_outline` **(** :ref:`RID` font_rid, :ref:`RID` canvas, :ref:`int` size, :ref:`int` outline_size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`FontAntialiasing` | :ref:`font_get_antialiasing` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`font_get_ascent` **(** :ref:`RID` font_rid, :ref:`int` size **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`font_get_baseline_offset` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_char_from_glyph_index` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph_index **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`font_get_descent` **(** :ref:`RID` font_rid, :ref:`int` size **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`font_get_embolden` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_face_count` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_face_index` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_fixed_size` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`FixedSizeScaleMode` | :ref:`font_get_fixed_size_scale_mode` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_get_generate_mipmaps` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`font_get_global_oversampling` **(** **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`font_get_glyph_advance` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`font_get_glyph_contours` **(** :ref:`RID` font, :ref:`int` size, :ref:`int` index **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_glyph_index` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` char, :ref:`int` variation_selector **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`font_get_glyph_list` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`font_get_glyph_offset` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`font_get_glyph_size` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_glyph_texture_idx` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`font_get_glyph_texture_rid` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`font_get_glyph_texture_size` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`font_get_glyph_uv_rect` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Hinting` | :ref:`font_get_hinting` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`font_get_kerning` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i[]` | :ref:`font_get_kerning_list` **(** :ref:`RID` font_rid, :ref:`int` size **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_get_language_support_override` **(** :ref:`RID` font_rid, :ref:`String` language **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`font_get_language_support_overrides` **(** :ref:`RID` font_rid **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_msdf_pixel_range` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_msdf_size` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`font_get_name` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`font_get_opentype_feature_overrides` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`font_get_ot_name_strings` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`font_get_oversampling` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`font_get_scale` **(** :ref:`RID` font_rid, :ref:`int` size **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_get_script_support_override` **(** :ref:`RID` font_rid, :ref:`String` script **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`font_get_script_support_overrides` **(** :ref:`RID` font_rid **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i[]` | :ref:`font_get_size_cache_list` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_spacing` **(** :ref:`RID` font_rid, :ref:`SpacingType` spacing **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_stretch` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`FontStyle`\> | :ref:`font_get_style` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`font_get_style_name` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SubpixelPositioning` | :ref:`font_get_subpixel_positioning` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`font_get_supported_chars` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_texture_count` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`font_get_texture_image` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`font_get_texture_offsets` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`font_get_transform` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`font_get_underline_position` **(** :ref:`RID` font_rid, :ref:`int` size **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`font_get_underline_thickness` **(** :ref:`RID` font_rid, :ref:`int` size **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`font_get_variation_coordinates` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`font_get_weight` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_has_char` **(** :ref:`RID` font_rid, :ref:`int` char **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_is_allow_system_fallback` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_is_force_autohinter` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_is_language_supported` **(** :ref:`RID` font_rid, :ref:`String` language **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_is_multichannel_signed_distance_field` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`font_is_script_supported` **(** :ref:`RID` font_rid, :ref:`String` script **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_remove_glyph` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_remove_kerning` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_remove_language_support_override` **(** :ref:`RID` font_rid, :ref:`String` language **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_remove_script_support_override` **(** :ref:`RID` font_rid, :ref:`String` script **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_remove_size_cache` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_remove_texture` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_render_glyph` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` index **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_render_range` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` start, :ref:`int` end **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_allow_system_fallback` **(** :ref:`RID` font_rid, :ref:`bool` allow_system_fallback **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_antialiasing` **(** :ref:`RID` font_rid, :ref:`FontAntialiasing` antialiasing **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_ascent` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` ascent **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_baseline_offset` **(** :ref:`RID` font_rid, :ref:`float` baseline_offset **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_data` **(** :ref:`RID` font_rid, :ref:`PackedByteArray` data **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_descent` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` descent **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_embolden` **(** :ref:`RID` font_rid, :ref:`float` strength **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_face_index` **(** :ref:`RID` font_rid, :ref:`int` face_index **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_fixed_size` **(** :ref:`RID` font_rid, :ref:`int` fixed_size **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_fixed_size_scale_mode` **(** :ref:`RID` font_rid, :ref:`FixedSizeScaleMode` fixed_size_scale_mode **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_force_autohinter` **(** :ref:`RID` font_rid, :ref:`bool` force_autohinter **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_generate_mipmaps` **(** :ref:`RID` font_rid, :ref:`bool` generate_mipmaps **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_global_oversampling` **(** :ref:`float` oversampling **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_glyph_advance` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph, :ref:`Vector2` advance **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_glyph_offset` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Vector2` offset **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_glyph_size` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Vector2` gl_size **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_glyph_texture_idx` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`int` texture_idx **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_glyph_uv_rect` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Rect2` uv_rect **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_hinting` **(** :ref:`RID` font_rid, :ref:`Hinting` hinting **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_kerning` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair, :ref:`Vector2` kerning **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_language_support_override` **(** :ref:`RID` font_rid, :ref:`String` language, :ref:`bool` supported **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_msdf_pixel_range` **(** :ref:`RID` font_rid, :ref:`int` msdf_pixel_range **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_msdf_size` **(** :ref:`RID` font_rid, :ref:`int` msdf_size **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_multichannel_signed_distance_field` **(** :ref:`RID` font_rid, :ref:`bool` msdf **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_name` **(** :ref:`RID` font_rid, :ref:`String` name **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_opentype_feature_overrides` **(** :ref:`RID` font_rid, :ref:`Dictionary` overrides **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_oversampling` **(** :ref:`RID` font_rid, :ref:`float` oversampling **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_scale` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` scale **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_script_support_override` **(** :ref:`RID` font_rid, :ref:`String` script, :ref:`bool` supported **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_spacing` **(** :ref:`RID` font_rid, :ref:`SpacingType` spacing, :ref:`int` value **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_stretch` **(** :ref:`RID` font_rid, :ref:`int` weight **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_style` **(** :ref:`RID` font_rid, |bitfield|\<:ref:`FontStyle`\> style **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_style_name` **(** :ref:`RID` font_rid, :ref:`String` name **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_subpixel_positioning` **(** :ref:`RID` font_rid, :ref:`SubpixelPositioning` subpixel_positioning **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_texture_image` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`Image` image **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_texture_offsets` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`PackedInt32Array` offset **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_transform` **(** :ref:`RID` font_rid, :ref:`Transform2D` transform **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_underline_position` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` underline_position **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_underline_thickness` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` underline_thickness **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_variation_coordinates` **(** :ref:`RID` font_rid, :ref:`Dictionary` variation_coordinates **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`font_set_weight` **(** :ref:`RID` font_rid, :ref:`int` weight **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`font_supported_feature_list` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`font_supported_variation_list` **(** :ref:`RID` font_rid **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`format_number` **(** :ref:`String` number, :ref:`String` language="" **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`free_rid` **(** :ref:`RID` rid **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_features` **(** **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_hex_code_box_size` **(** :ref:`int` size, :ref:`int` index **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_name` **(** **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_support_data_filename` **(** **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_support_data_info` **(** **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has` **(** :ref:`RID` rid **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_feature` **(** :ref:`Feature` feature **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`is_confusable` **(** :ref:`String` string, :ref:`PackedStringArray` dict **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_locale_right_to_left` **(** :ref:`String` locale **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_identifier` **(** :ref:`String` string **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`load_support_data` **(** :ref:`String` filename **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`name_to_tag` **(** :ref:`String` name **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`parse_number` **(** :ref:`String` number, :ref:`String` language="" **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i[]` | :ref:`parse_structured_text` **(** :ref:`StructuredTextParser` parser_type, :ref:`Array` args, :ref:`String` text **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`percent_sign` **(** :ref:`String` language="" **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`save_support_data` **(** :ref:`String` filename **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_get_span_count` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`shaped_get_span_meta` **(** :ref:`RID` shaped, :ref:`int` index **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shaped_set_span_update_font` **(** :ref:`RID` shaped, :ref:`int` index, :ref:`RID[]` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features={} **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`shaped_text_add_object` **(** :ref:`RID` shaped, :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align=5, :ref:`int` length=1, :ref:`float` baseline=0.0 **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`shaped_text_add_string` **(** :ref:`RID` shaped, :ref:`String` text, :ref:`RID[]` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features={}, :ref:`String` language="", :ref:`Variant` meta=null **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shaped_text_clear` **(** :ref:`RID` rid **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_closest_character_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shaped_text_draw` **(** :ref:`RID` shaped, :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`float` clip_l=-1, :ref:`float` clip_r=-1, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shaped_text_draw_outline` **(** :ref:`RID` shaped, :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`float` clip_l=-1, :ref:`float` clip_r=-1, :ref:`int` outline_size=1, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`shaped_text_fit_to_width` **(** :ref:`RID` shaped, :ref:`float` width, |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3 **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`shaped_text_get_ascent` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`shaped_text_get_carets` **(** :ref:`RID` shaped, :ref:`int` position **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`shaped_text_get_character_breaks` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_get_custom_ellipsis` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`shaped_text_get_custom_punctuation` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`shaped_text_get_descent` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Direction` | :ref:`shaped_text_get_direction` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Direction` | :ref:`shaped_text_get_dominant_direction_in_range` **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` end **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_get_ellipsis_glyph_count` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`shaped_text_get_ellipsis_glyphs` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_get_ellipsis_pos` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_get_glyph_count` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`shaped_text_get_glyphs` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`shaped_text_get_grapheme_bounds` **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Direction` | :ref:`shaped_text_get_inferred_direction` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`shaped_text_get_line_breaks` **(** :ref:`RID` shaped, :ref:`float` width, :ref:`int` start=0, |bitfield|\<:ref:`LineBreakFlag`\> break_flags=3 **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`shaped_text_get_line_breaks_adv` **(** :ref:`RID` shaped, :ref:`PackedFloat32Array` width, :ref:`int` start=0, :ref:`bool` once=true, |bitfield|\<:ref:`LineBreakFlag`\> break_flags=3 **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`shaped_text_get_object_rect` **(** :ref:`RID` shaped, :ref:`Variant` key **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`shaped_text_get_objects` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Orientation` | :ref:`shaped_text_get_orientation` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`shaped_text_get_parent` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`shaped_text_get_preserve_control` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`shaped_text_get_preserve_invalid` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`shaped_text_get_range` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`shaped_text_get_selection` **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` end **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`shaped_text_get_size` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_get_spacing` **(** :ref:`RID` shaped, :ref:`SpacingType` spacing **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_get_trim_pos` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`shaped_text_get_underline_position` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`shaped_text_get_underline_thickness` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`shaped_text_get_width` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`shaped_text_get_word_breaks` **(** :ref:`RID` shaped, |bitfield|\<:ref:`GraphemeFlag`\> grapheme_flags=264 **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`shaped_text_has_visible_chars` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_hit_test_grapheme` **(** :ref:`RID` shaped, :ref:`float` coords **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_hit_test_position` **(** :ref:`RID` shaped, :ref:`float` coords **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`shaped_text_is_ready` **(** :ref:`RID` shaped **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_next_character_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_next_grapheme_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shaped_text_overrun_trim_to_width` **(** :ref:`RID` shaped, :ref:`float` width=0, |bitfield|\<:ref:`TextOverrunFlag`\> overrun_trim_flags=0 **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_prev_character_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`shaped_text_prev_grapheme_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`shaped_text_resize_object` **(** :ref:`RID` shaped, :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align=5, :ref:`float` baseline=0.0 **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shaped_text_set_bidi_override` **(** :ref:`RID` shaped, :ref:`Array` override **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shaped_text_set_custom_ellipsis` **(** :ref:`RID` shaped, :ref:`int` char **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shaped_text_set_custom_punctuation` **(** :ref:`RID` shaped, :ref:`String` punct **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shaped_text_set_direction` **(** :ref:`RID` shaped, :ref:`Direction` direction=0 **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shaped_text_set_orientation` **(** :ref:`RID` shaped, :ref:`Orientation` orientation=0 **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shaped_text_set_preserve_control` **(** :ref:`RID` shaped, :ref:`bool` enabled **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shaped_text_set_preserve_invalid` **(** :ref:`RID` shaped, :ref:`bool` enabled **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`shaped_text_set_spacing` **(** :ref:`RID` shaped, :ref:`SpacingType` spacing, :ref:`int` value **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`shaped_text_shape` **(** :ref:`RID` shaped **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`shaped_text_sort_logical` **(** :ref:`RID` shaped **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`shaped_text_substr` **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` length **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`shaped_text_tab_align` **(** :ref:`RID` shaped, :ref:`PackedFloat32Array` tab_stops **)** | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`spoof_check` **(** :ref:`String` string **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`string_get_character_breaks` **(** :ref:`String` string, :ref:`String` language="" **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`string_get_word_breaks` **(** :ref:`String` string, :ref:`String` language="", :ref:`int` chars_per_line=0 **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`string_to_lower` **(** :ref:`String` string, :ref:`String` language="" **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`string_to_upper` **(** :ref:`String` string, :ref:`String` language="" **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`strip_diacritics` **(** :ref:`String` string **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`tag_to_name` **(** :ref:`int` tag **)** |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`create_font`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`create_font_linked_variation`\ (\ font_rid\: :ref:`RID`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`create_shaped_text`\ (\ direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_hex_code_box`\ (\ canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_clear_glyphs`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_clear_kerning_map`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_clear_size_cache`\ (\ font_rid\: :ref:`RID`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_clear_textures`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_draw_glyph`\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_draw_glyph_outline`\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, outline_size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FontAntialiasing` | :ref:`font_get_antialiasing`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`font_get_ascent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`font_get_baseline_offset`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_char_from_glyph_index`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`font_get_descent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`font_get_embolden`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_face_count`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_face_index`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_fixed_size`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FixedSizeScaleMode` | :ref:`font_get_fixed_size_scale_mode`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_get_generate_mipmaps`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`font_get_global_oversampling`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`font_get_glyph_advance`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`font_get_glyph_contours`\ (\ font\: :ref:`RID`, size\: :ref:`int`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_glyph_index`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`font_get_glyph_list`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`font_get_glyph_offset`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`font_get_glyph_size`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_glyph_texture_idx`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`font_get_glyph_texture_rid`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`font_get_glyph_texture_size`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`font_get_glyph_uv_rect`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Hinting` | :ref:`font_get_hinting`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`font_get_kerning`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`font_get_kerning_list`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_get_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`font_get_language_support_overrides`\ (\ font_rid\: :ref:`RID`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_msdf_pixel_range`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_msdf_size`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`font_get_name`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`font_get_opentype_feature_overrides`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`font_get_ot_name_strings`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`font_get_oversampling`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`font_get_scale`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_get_script_support_override`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`font_get_script_support_overrides`\ (\ font_rid\: :ref:`RID`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`font_get_size_cache_list`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_spacing`\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_stretch`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`FontStyle`\] | :ref:`font_get_style`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`font_get_style_name`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SubpixelPositioning` | :ref:`font_get_subpixel_positioning`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`font_get_supported_chars`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_texture_count`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`font_get_texture_image`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`font_get_texture_offsets`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`font_get_transform`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`font_get_underline_position`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`font_get_underline_thickness`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`font_get_variation_coordinates`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`font_get_weight`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_has_char`\ (\ font_rid\: :ref:`RID`, char\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_is_allow_system_fallback`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_is_force_autohinter`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_is_language_supported`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_is_multichannel_signed_distance_field`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_is_script_supported`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_remove_glyph`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_remove_kerning`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_remove_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_remove_script_support_override`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_remove_size_cache`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_remove_texture`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_render_glyph`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, index\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_render_range`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, start\: :ref:`int`, end\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_allow_system_fallback`\ (\ font_rid\: :ref:`RID`, allow_system_fallback\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_antialiasing`\ (\ font_rid\: :ref:`RID`, antialiasing\: :ref:`FontAntialiasing`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_ascent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, ascent\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_baseline_offset`\ (\ font_rid\: :ref:`RID`, baseline_offset\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_data`\ (\ font_rid\: :ref:`RID`, data\: :ref:`PackedByteArray`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_descent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, descent\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_embolden`\ (\ font_rid\: :ref:`RID`, strength\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_face_index`\ (\ font_rid\: :ref:`RID`, face_index\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_fixed_size`\ (\ font_rid\: :ref:`RID`, fixed_size\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_fixed_size_scale_mode`\ (\ font_rid\: :ref:`RID`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_force_autohinter`\ (\ font_rid\: :ref:`RID`, force_autohinter\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_generate_mipmaps`\ (\ font_rid\: :ref:`RID`, generate_mipmaps\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_global_oversampling`\ (\ oversampling\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_glyph_advance`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_glyph_offset`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_glyph_size`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_glyph_texture_idx`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_glyph_uv_rect`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_hinting`\ (\ font_rid\: :ref:`RID`, hinting\: :ref:`Hinting`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_kerning`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`, kerning\: :ref:`Vector2`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`, supported\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_msdf_pixel_range`\ (\ font_rid\: :ref:`RID`, msdf_pixel_range\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_msdf_size`\ (\ font_rid\: :ref:`RID`, msdf_size\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_multichannel_signed_distance_field`\ (\ font_rid\: :ref:`RID`, msdf\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_name`\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_opentype_feature_overrides`\ (\ font_rid\: :ref:`RID`, overrides\: :ref:`Dictionary`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_oversampling`\ (\ font_rid\: :ref:`RID`, oversampling\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_scale`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, scale\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_script_support_override`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`, supported\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_spacing`\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_stretch`\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_style`\ (\ font_rid\: :ref:`RID`, style\: |bitfield|\[:ref:`FontStyle`\]\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_style_name`\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_subpixel_positioning`\ (\ font_rid\: :ref:`RID`, subpixel_positioning\: :ref:`SubpixelPositioning`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_texture_image`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_texture_offsets`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, offset\: :ref:`PackedInt32Array`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_transform`\ (\ font_rid\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_underline_position`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_underline_thickness`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_variation_coordinates`\ (\ font_rid\: :ref:`RID`, variation_coordinates\: :ref:`Dictionary`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_weight`\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`font_supported_feature_list`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`font_supported_variation_list`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`format_number`\ (\ number\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`free_rid`\ (\ rid\: :ref:`RID`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_features`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_hex_code_box_size`\ (\ size\: :ref:`int`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_name`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_support_data_filename`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_support_data_info`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has`\ (\ rid\: :ref:`RID`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_feature`\ (\ feature\: :ref:`Feature`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`is_confusable`\ (\ string\: :ref:`String`, dict\: :ref:`PackedStringArray`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_locale_right_to_left`\ (\ locale\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_identifier`\ (\ string\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`load_support_data`\ (\ filename\: :ref:`String`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`name_to_tag`\ (\ name\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`parse_number`\ (\ number\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector3i`\] | :ref:`parse_structured_text`\ (\ parser_type\: :ref:`StructuredTextParser`, args\: :ref:`Array`, text\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`percent_sign`\ (\ language\: :ref:`String` = ""\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`save_support_data`\ (\ filename\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_get_span_count`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`shaped_get_span_meta`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_set_span_update_font`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary` = {}\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shaped_text_add_object`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shaped_text_add_string`\ (\ shaped\: :ref:`RID`, text\: :ref:`String`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary` = {}, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_clear`\ (\ rid\: :ref:`RID`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_closest_character_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_draw`\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float` = -1, clip_r\: :ref:`float` = -1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_draw_outline`\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float` = -1, clip_r\: :ref:`float` = -1, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`shaped_text_fit_to_width`\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`shaped_text_get_ascent`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`shaped_text_get_carets`\ (\ shaped\: :ref:`RID`, position\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`shaped_text_get_character_breaks`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_get_custom_ellipsis`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`shaped_text_get_custom_punctuation`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`shaped_text_get_descent`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Direction` | :ref:`shaped_text_get_direction`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Direction` | :ref:`shaped_text_get_dominant_direction_in_range`\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_get_ellipsis_glyph_count`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`shaped_text_get_ellipsis_glyphs`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_get_ellipsis_pos`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_get_glyph_count`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`shaped_text_get_glyphs`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`shaped_text_get_grapheme_bounds`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Direction` | :ref:`shaped_text_get_inferred_direction`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`shaped_text_get_line_breaks`\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, start\: :ref:`int` = 0, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`shaped_text_get_line_breaks_adv`\ (\ shaped\: :ref:`RID`, width\: :ref:`PackedFloat32Array`, start\: :ref:`int` = 0, once\: :ref:`bool` = true, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`shaped_text_get_object_rect`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`shaped_text_get_objects`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Orientation` | :ref:`shaped_text_get_orientation`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`shaped_text_get_parent`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shaped_text_get_preserve_control`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shaped_text_get_preserve_invalid`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`shaped_text_get_range`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`shaped_text_get_selection`\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`shaped_text_get_size`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_get_spacing`\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_get_trim_pos`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`shaped_text_get_underline_position`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`shaped_text_get_underline_thickness`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`shaped_text_get_width`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`shaped_text_get_word_breaks`\ (\ shaped\: :ref:`RID`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\] = 264\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shaped_text_has_visible_chars`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_hit_test_grapheme`\ (\ shaped\: :ref:`RID`, coords\: :ref:`float`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_hit_test_position`\ (\ shaped\: :ref:`RID`, coords\: :ref:`float`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shaped_text_is_ready`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_next_character_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_next_grapheme_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_overrun_trim_to_width`\ (\ shaped\: :ref:`RID`, width\: :ref:`float` = 0, overrun_trim_flags\: |bitfield|\[:ref:`TextOverrunFlag`\] = 0\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_prev_character_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_prev_grapheme_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shaped_text_resize_object`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_set_bidi_override`\ (\ shaped\: :ref:`RID`, override\: :ref:`Array`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_set_custom_ellipsis`\ (\ shaped\: :ref:`RID`, char\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_set_custom_punctuation`\ (\ shaped\: :ref:`RID`, punct\: :ref:`String`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_set_direction`\ (\ shaped\: :ref:`RID`, direction\: :ref:`Direction` = 0\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_set_orientation`\ (\ shaped\: :ref:`RID`, orientation\: :ref:`Orientation` = 0\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_set_preserve_control`\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_set_preserve_invalid`\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`shaped_text_set_spacing`\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`shaped_text_shape`\ (\ shaped\: :ref:`RID`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`shaped_text_sort_logical`\ (\ shaped\: :ref:`RID`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`shaped_text_substr`\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, length\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`shaped_text_tab_align`\ (\ shaped\: :ref:`RID`, tab_stops\: :ref:`PackedFloat32Array`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`spoof_check`\ (\ string\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`string_get_character_breaks`\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`string_get_word_breaks`\ (\ string\: :ref:`String`, language\: :ref:`String` = "", chars_per_line\: :ref:`int` = 0\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`string_to_lower`\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`string_to_upper`\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`strip_diacritics`\ (\ string\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`tag_to_name`\ (\ tag\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -1072,6 +1072,14 @@ It is safe to insert a U+0640 before this grapheme for elongation. Grapheme is an object replacement character for the embedded object. +.. _class_TextServer_constant_GRAPHEME_IS_SOFT_HYPHEN: + +.. rst-class:: classref-enumeration-constant + +:ref:`GraphemeFlag` **GRAPHEME_IS_SOFT_HYPHEN** = ``8192`` + +Grapheme is a soft hyphen. + .. rst-class:: classref-item-separator ---- @@ -1533,7 +1541,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`RID` **create_font** **(** **)** +:ref:`RID` **create_font**\ (\ ) Creates a new, empty font cache entry resource. To free the resulting resource, use the :ref:`free_rid` method. @@ -1545,7 +1553,7 @@ Creates a new, empty font cache entry resource. To free the resulting resource, .. rst-class:: classref-method -:ref:`RID` **create_font_linked_variation** **(** :ref:`RID` font_rid **)** +:ref:`RID` **create_font_linked_variation**\ (\ font_rid\: :ref:`RID`\ ) Creates a new variation existing font which is reusing the same glyph cache and font data. To free the resulting resource, use the :ref:`free_rid` method. @@ -1557,7 +1565,7 @@ Creates a new variation existing font which is reusing the same glyph cache and .. rst-class:: classref-method -:ref:`RID` **create_shaped_text** **(** :ref:`Direction` direction=0, :ref:`Orientation` orientation=0 **)** +:ref:`RID` **create_shaped_text**\ (\ direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0\ ) Creates new buffer for complex text layout, with the given ``direction`` and ``orientation``. To free the resulting buffer, use :ref:`free_rid` method. @@ -1573,7 +1581,7 @@ Creates new buffer for complex text layout, with the given ``direction`` and ``o .. rst-class:: classref-method -void **draw_hex_code_box** **(** :ref:`RID` canvas, :ref:`int` size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color **)** |const| +|void| **draw_hex_code_box**\ (\ canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |const| Draws box displaying character hexadecimal code. Used for replacing missing characters. @@ -1585,7 +1593,7 @@ Draws box displaying character hexadecimal code. Used for replacing missing char .. rst-class:: classref-method -void **font_clear_glyphs** **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** +|void| **font_clear_glyphs**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) Removes all rendered glyphs information from the cache entry. @@ -1599,7 +1607,7 @@ Removes all rendered glyphs information from the cache entry. .. rst-class:: classref-method -void **font_clear_kerning_map** **(** :ref:`RID` font_rid, :ref:`int` size **)** +|void| **font_clear_kerning_map**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) Removes all kerning overrides. @@ -1611,7 +1619,7 @@ Removes all kerning overrides. .. rst-class:: classref-method -void **font_clear_size_cache** **(** :ref:`RID` font_rid **)** +|void| **font_clear_size_cache**\ (\ font_rid\: :ref:`RID`\ ) Removes all font sizes from the cache entry. @@ -1623,7 +1631,7 @@ Removes all font sizes from the cache entry. .. rst-class:: classref-method -void **font_clear_textures** **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** +|void| **font_clear_textures**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) Removes all textures from font cache entry. @@ -1637,7 +1645,7 @@ Removes all textures from font cache entry. .. rst-class:: classref-method -void **font_draw_glyph** **(** :ref:`RID` font_rid, :ref:`RID` canvas, :ref:`int` size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| +|void| **font_draw_glyph**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| Draws single glyph into a canvas item at the position, using ``font_rid`` at the size ``size``. @@ -1653,7 +1661,7 @@ Draws single glyph into a canvas item at the position, using ``font_rid`` at the .. rst-class:: classref-method -void **font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RID` canvas, :ref:`int` size, :ref:`int` outline_size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| +|void| **font_draw_glyph_outline**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, outline_size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| Draws single glyph outline of size ``outline_size`` into a canvas item at the position, using ``font_rid`` at the size ``size``. @@ -1669,7 +1677,7 @@ Draws single glyph outline of size ``outline_size`` into a canvas item at the po .. rst-class:: classref-method -:ref:`FontAntialiasing` **font_get_antialiasing** **(** :ref:`RID` font_rid **)** |const| +:ref:`FontAntialiasing` **font_get_antialiasing**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns font anti-aliasing mode. @@ -1681,7 +1689,7 @@ Returns font anti-aliasing mode. .. rst-class:: classref-method -:ref:`float` **font_get_ascent** **(** :ref:`RID` font_rid, :ref:`int` size **)** |const| +:ref:`float` **font_get_ascent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| Returns the font ascent (number of pixels above the baseline). @@ -1693,7 +1701,7 @@ Returns the font ascent (number of pixels above the baseline). .. rst-class:: classref-method -:ref:`float` **font_get_baseline_offset** **(** :ref:`RID` font_rid **)** |const| +:ref:`float` **font_get_baseline_offset**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns extra baseline offset (as a fraction of font height). @@ -1705,7 +1713,7 @@ Returns extra baseline offset (as a fraction of font height). .. rst-class:: classref-method -:ref:`int` **font_get_char_from_glyph_index** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph_index **)** |const| +:ref:`int` **font_get_char_from_glyph_index**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |const| Returns character code associated with ``glyph_index``, or ``0`` if ``glyph_index`` is invalid. See :ref:`font_get_glyph_index`. @@ -1717,7 +1725,7 @@ Returns character code associated with ``glyph_index``, or ``0`` if ``glyph_inde .. rst-class:: classref-method -:ref:`float` **font_get_descent** **(** :ref:`RID` font_rid, :ref:`int` size **)** |const| +:ref:`float` **font_get_descent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| Returns the font descent (number of pixels below the baseline). @@ -1729,7 +1737,7 @@ Returns the font descent (number of pixels below the baseline). .. rst-class:: classref-method -:ref:`float` **font_get_embolden** **(** :ref:`RID` font_rid **)** |const| +:ref:`float` **font_get_embolden**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns font embolden strength. @@ -1741,7 +1749,7 @@ Returns font embolden strength. .. rst-class:: classref-method -:ref:`int` **font_get_face_count** **(** :ref:`RID` font_rid **)** |const| +:ref:`int` **font_get_face_count**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns number of faces in the TrueType / OpenType collection. @@ -1753,7 +1761,7 @@ Returns number of faces in the TrueType / OpenType collection. .. rst-class:: classref-method -:ref:`int` **font_get_face_index** **(** :ref:`RID` font_rid **)** |const| +:ref:`int` **font_get_face_index**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns an active face index in the TrueType / OpenType collection. @@ -1765,7 +1773,7 @@ Returns an active face index in the TrueType / OpenType collection. .. rst-class:: classref-method -:ref:`int` **font_get_fixed_size** **(** :ref:`RID` font_rid **)** |const| +:ref:`int` **font_get_fixed_size**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns bitmap font fixed size. @@ -1777,7 +1785,7 @@ Returns bitmap font fixed size. .. rst-class:: classref-method -:ref:`FixedSizeScaleMode` **font_get_fixed_size_scale_mode** **(** :ref:`RID` font_rid **)** |const| +:ref:`FixedSizeScaleMode` **font_get_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns bitmap font scaling mode. @@ -1789,7 +1797,7 @@ Returns bitmap font scaling mode. .. rst-class:: classref-method -:ref:`bool` **font_get_generate_mipmaps** **(** :ref:`RID` font_rid **)** |const| +:ref:`bool` **font_get_generate_mipmaps**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns ``true`` if font texture mipmap generation is enabled. @@ -1801,7 +1809,7 @@ Returns ``true`` if font texture mipmap generation is enabled. .. rst-class:: classref-method -:ref:`float` **font_get_global_oversampling** **(** **)** |const| +:ref:`float` **font_get_global_oversampling**\ (\ ) |const| Returns the font oversampling factor, shared by all fonts in the TextServer. @@ -1813,7 +1821,7 @@ Returns the font oversampling factor, shared by all fonts in the TextServer. .. rst-class:: classref-method -:ref:`Vector2` **font_get_glyph_advance** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph **)** |const| +:ref:`Vector2` **font_get_glyph_advance**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |const| Returns glyph advance (offset of the next glyph). @@ -1827,7 +1835,7 @@ Returns glyph advance (offset of the next glyph). .. rst-class:: classref-method -:ref:`Dictionary` **font_get_glyph_contours** **(** :ref:`RID` font, :ref:`int` size, :ref:`int` index **)** |const| +:ref:`Dictionary` **font_get_glyph_contours**\ (\ font\: :ref:`RID`, size\: :ref:`int`, index\: :ref:`int`\ ) |const| Returns outline contours of the glyph as a :ref:`Dictionary` with the following contents: @@ -1845,7 +1853,7 @@ Returns outline contours of the glyph as a :ref:`Dictionary` w .. rst-class:: classref-method -:ref:`int` **font_get_glyph_index** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` char, :ref:`int` variation_selector **)** |const| +:ref:`int` **font_get_glyph_index**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |const| Returns the glyph index of a ``char``, optionally modified by the ``variation_selector``. See :ref:`font_get_char_from_glyph_index`. @@ -1857,7 +1865,7 @@ Returns the glyph index of a ``char``, optionally modified by the ``variation_se .. rst-class:: classref-method -:ref:`PackedInt32Array` **font_get_glyph_list** **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |const| +:ref:`PackedInt32Array` **font_get_glyph_list**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |const| Returns list of rendered glyphs in the cache entry. @@ -1869,7 +1877,7 @@ Returns list of rendered glyphs in the cache entry. .. rst-class:: classref-method -:ref:`Vector2` **font_get_glyph_offset** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| +:ref:`Vector2` **font_get_glyph_offset**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| Returns glyph offset from the baseline. @@ -1881,7 +1889,7 @@ Returns glyph offset from the baseline. .. rst-class:: classref-method -:ref:`Vector2` **font_get_glyph_size** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| +:ref:`Vector2` **font_get_glyph_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| Returns size of the glyph. @@ -1893,7 +1901,7 @@ Returns size of the glyph. .. rst-class:: classref-method -:ref:`int` **font_get_glyph_texture_idx** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| +:ref:`int` **font_get_glyph_texture_idx**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| Returns index of the cache texture containing the glyph. @@ -1905,7 +1913,7 @@ Returns index of the cache texture containing the glyph. .. rst-class:: classref-method -:ref:`RID` **font_get_glyph_texture_rid** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| +:ref:`RID` **font_get_glyph_texture_rid**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| Returns resource ID of the cache texture containing the glyph. @@ -1919,7 +1927,7 @@ Returns resource ID of the cache texture containing the glyph. .. rst-class:: classref-method -:ref:`Vector2` **font_get_glyph_texture_size** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| +:ref:`Vector2` **font_get_glyph_texture_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| Returns size of the cache texture containing the glyph. @@ -1933,7 +1941,7 @@ Returns size of the cache texture containing the glyph. .. rst-class:: classref-method -:ref:`Rect2` **font_get_glyph_uv_rect** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |const| +:ref:`Rect2` **font_get_glyph_uv_rect**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |const| Returns rectangle in the cache texture containing the glyph. @@ -1945,7 +1953,7 @@ Returns rectangle in the cache texture containing the glyph. .. rst-class:: classref-method -:ref:`Hinting` **font_get_hinting** **(** :ref:`RID` font_rid **)** |const| +:ref:`Hinting` **font_get_hinting**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns the font hinting mode. Used by dynamic fonts only. @@ -1957,7 +1965,7 @@ Returns the font hinting mode. Used by dynamic fonts only. .. rst-class:: classref-method -:ref:`Vector2` **font_get_kerning** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair **)** |const| +:ref:`Vector2` **font_get_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |const| Returns kerning for the pair of glyphs. @@ -1969,7 +1977,7 @@ Returns kerning for the pair of glyphs. .. rst-class:: classref-method -:ref:`Vector2i[]` **font_get_kerning_list** **(** :ref:`RID` font_rid, :ref:`int` size **)** |const| +:ref:`Array`\[:ref:`Vector2i`\] **font_get_kerning_list**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| Returns list of the kerning overrides. @@ -1981,7 +1989,7 @@ Returns list of the kerning overrides. .. rst-class:: classref-method -:ref:`bool` **font_get_language_support_override** **(** :ref:`RID` font_rid, :ref:`String` language **)** +:ref:`bool` **font_get_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) Returns ``true`` if support override is enabled for the ``language``. @@ -1993,7 +2001,7 @@ Returns ``true`` if support override is enabled for the ``language``. .. rst-class:: classref-method -:ref:`PackedStringArray` **font_get_language_support_overrides** **(** :ref:`RID` font_rid **)** +:ref:`PackedStringArray` **font_get_language_support_overrides**\ (\ font_rid\: :ref:`RID`\ ) Returns list of language support overrides. @@ -2005,7 +2013,7 @@ Returns list of language support overrides. .. rst-class:: classref-method -:ref:`int` **font_get_msdf_pixel_range** **(** :ref:`RID` font_rid **)** |const| +:ref:`int` **font_get_msdf_pixel_range**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns the width of the range around the shape between the minimum and maximum representable signed distance. @@ -2017,7 +2025,7 @@ Returns the width of the range around the shape between the minimum and maximum .. rst-class:: classref-method -:ref:`int` **font_get_msdf_size** **(** :ref:`RID` font_rid **)** |const| +:ref:`int` **font_get_msdf_size**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns source font size used to generate MSDF textures. @@ -2029,7 +2037,7 @@ Returns source font size used to generate MSDF textures. .. rst-class:: classref-method -:ref:`String` **font_get_name** **(** :ref:`RID` font_rid **)** |const| +:ref:`String` **font_get_name**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns font family name. @@ -2041,7 +2049,7 @@ Returns font family name. .. rst-class:: classref-method -:ref:`Dictionary` **font_get_opentype_feature_overrides** **(** :ref:`RID` font_rid **)** |const| +:ref:`Dictionary` **font_get_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns font OpenType feature set override. @@ -2053,7 +2061,7 @@ Returns font OpenType feature set override. .. rst-class:: classref-method -:ref:`Dictionary` **font_get_ot_name_strings** **(** :ref:`RID` font_rid **)** |const| +:ref:`Dictionary` **font_get_ot_name_strings**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns :ref:`Dictionary` with OpenType font name strings (localized font names, version, description, license information, sample text, etc.). @@ -2065,7 +2073,7 @@ Returns :ref:`Dictionary` with OpenType font name strings (loc .. rst-class:: classref-method -:ref:`float` **font_get_oversampling** **(** :ref:`RID` font_rid **)** |const| +:ref:`float` **font_get_oversampling**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only. @@ -2077,7 +2085,7 @@ Returns font oversampling factor, if set to ``0.0`` global oversampling factor i .. rst-class:: classref-method -:ref:`float` **font_get_scale** **(** :ref:`RID` font_rid, :ref:`int` size **)** |const| +:ref:`float` **font_get_scale**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| Returns scaling factor of the color bitmap font. @@ -2089,7 +2097,7 @@ Returns scaling factor of the color bitmap font. .. rst-class:: classref-method -:ref:`bool` **font_get_script_support_override** **(** :ref:`RID` font_rid, :ref:`String` script **)** +:ref:`bool` **font_get_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) Returns ``true`` if support override is enabled for the ``script``. @@ -2101,7 +2109,7 @@ Returns ``true`` if support override is enabled for the ``script``. .. rst-class:: classref-method -:ref:`PackedStringArray` **font_get_script_support_overrides** **(** :ref:`RID` font_rid **)** +:ref:`PackedStringArray` **font_get_script_support_overrides**\ (\ font_rid\: :ref:`RID`\ ) Returns list of script support overrides. @@ -2113,7 +2121,7 @@ Returns list of script support overrides. .. rst-class:: classref-method -:ref:`Vector2i[]` **font_get_size_cache_list** **(** :ref:`RID` font_rid **)** |const| +:ref:`Array`\[:ref:`Vector2i`\] **font_get_size_cache_list**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns list of the font sizes in the cache. Each size is :ref:`Vector2i` with font size and outline size. @@ -2125,7 +2133,7 @@ Returns list of the font sizes in the cache. Each size is :ref:`Vector2i` **font_get_spacing** **(** :ref:`RID` font_rid, :ref:`SpacingType` spacing **)** |const| +:ref:`int` **font_get_spacing**\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |const| Returns the spacing for ``spacing`` (see :ref:`SpacingType`) in pixels (not relative to the font size). @@ -2137,7 +2145,7 @@ Returns the spacing for ``spacing`` (see :ref:`SpacingType` **font_get_stretch** **(** :ref:`RID` font_rid **)** |const| +:ref:`int` **font_get_stretch**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``. @@ -2149,7 +2157,7 @@ Returns font stretch amount, compared to a normal width. A percentage value betw .. rst-class:: classref-method -|bitfield|\<:ref:`FontStyle`\> **font_get_style** **(** :ref:`RID` font_rid **)** |const| +|bitfield|\[:ref:`FontStyle`\] **font_get_style**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns font style flags, see :ref:`FontStyle`. @@ -2161,7 +2169,7 @@ Returns font style flags, see :ref:`FontStyle`. .. rst-class:: classref-method -:ref:`String` **font_get_style_name** **(** :ref:`RID` font_rid **)** |const| +:ref:`String` **font_get_style_name**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns font style name. @@ -2173,7 +2181,7 @@ Returns font style name. .. rst-class:: classref-method -:ref:`SubpixelPositioning` **font_get_subpixel_positioning** **(** :ref:`RID` font_rid **)** |const| +:ref:`SubpixelPositioning` **font_get_subpixel_positioning**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns font subpixel glyph positioning mode. @@ -2185,7 +2193,7 @@ Returns font subpixel glyph positioning mode. .. rst-class:: classref-method -:ref:`String` **font_get_supported_chars** **(** :ref:`RID` font_rid **)** |const| +:ref:`String` **font_get_supported_chars**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns a string containing all the characters available in the font. @@ -2197,7 +2205,7 @@ Returns a string containing all the characters available in the font. .. rst-class:: classref-method -:ref:`int` **font_get_texture_count** **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |const| +:ref:`int` **font_get_texture_count**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |const| Returns number of textures used by font cache entry. @@ -2209,7 +2217,7 @@ Returns number of textures used by font cache entry. .. rst-class:: classref-method -:ref:`Image` **font_get_texture_image** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |const| +:ref:`Image` **font_get_texture_image**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| Returns font cache texture image data. @@ -2221,7 +2229,7 @@ Returns font cache texture image data. .. rst-class:: classref-method -:ref:`PackedInt32Array` **font_get_texture_offsets** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |const| +:ref:`PackedInt32Array` **font_get_texture_offsets**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |const| Returns array containing glyph packing data. @@ -2233,7 +2241,7 @@ Returns array containing glyph packing data. .. rst-class:: classref-method -:ref:`Transform2D` **font_get_transform** **(** :ref:`RID` font_rid **)** |const| +:ref:`Transform2D` **font_get_transform**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns 2D transform applied to the font outlines. @@ -2245,7 +2253,7 @@ Returns 2D transform applied to the font outlines. .. rst-class:: classref-method -:ref:`float` **font_get_underline_position** **(** :ref:`RID` font_rid, :ref:`int` size **)** |const| +:ref:`float` **font_get_underline_position**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| Returns pixel offset of the underline below the baseline. @@ -2257,7 +2265,7 @@ Returns pixel offset of the underline below the baseline. .. rst-class:: classref-method -:ref:`float` **font_get_underline_thickness** **(** :ref:`RID` font_rid, :ref:`int` size **)** |const| +:ref:`float` **font_get_underline_thickness**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |const| Returns thickness of the underline in pixels. @@ -2269,7 +2277,7 @@ Returns thickness of the underline in pixels. .. rst-class:: classref-method -:ref:`Dictionary` **font_get_variation_coordinates** **(** :ref:`RID` font_rid **)** |const| +:ref:`Dictionary` **font_get_variation_coordinates**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns variation coordinates for the specified font cache entry. See :ref:`font_supported_variation_list` for more info. @@ -2281,7 +2289,7 @@ Returns variation coordinates for the specified font cache entry. See :ref:`font .. rst-class:: classref-method -:ref:`int` **font_get_weight** **(** :ref:`RID` font_rid **)** |const| +:ref:`int` **font_get_weight**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``. @@ -2293,7 +2301,7 @@ Returns weight (boldness) of the font. A value in the ``100...999`` range, norma .. rst-class:: classref-method -:ref:`bool` **font_has_char** **(** :ref:`RID` font_rid, :ref:`int` char **)** |const| +:ref:`bool` **font_has_char**\ (\ font_rid\: :ref:`RID`, char\: :ref:`int`\ ) |const| Returns ``true`` if a Unicode ``char`` is available in the font. @@ -2305,7 +2313,7 @@ Returns ``true`` if a Unicode ``char`` is available in the font. .. rst-class:: classref-method -:ref:`bool` **font_is_allow_system_fallback** **(** :ref:`RID` font_rid **)** |const| +:ref:`bool` **font_is_allow_system_fallback**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns ``true`` if system fonts can be automatically used as fallbacks. @@ -2317,7 +2325,7 @@ Returns ``true`` if system fonts can be automatically used as fallbacks. .. rst-class:: classref-method -:ref:`bool` **font_is_force_autohinter** **(** :ref:`RID` font_rid **)** |const| +:ref:`bool` **font_is_force_autohinter**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns ``true`` if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only. @@ -2329,7 +2337,7 @@ Returns ``true`` if auto-hinting is supported and preferred over font built-in h .. rst-class:: classref-method -:ref:`bool` **font_is_language_supported** **(** :ref:`RID` font_rid, :ref:`String` language **)** |const| +:ref:`bool` **font_is_language_supported**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |const| Returns ``true``, if font supports given language (`ISO 639 `__ code). @@ -2341,7 +2349,7 @@ Returns ``true``, if font supports given language (`ISO 639 ` **font_is_multichannel_signed_distance_field** **(** :ref:`RID` font_rid **)** |const| +:ref:`bool` **font_is_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns ``true`` if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. @@ -2353,7 +2361,7 @@ Returns ``true`` if glyphs of all sizes are rendered using single multichannel s .. rst-class:: classref-method -:ref:`bool` **font_is_script_supported** **(** :ref:`RID` font_rid, :ref:`String` script **)** |const| +:ref:`bool` **font_is_script_supported**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |const| Returns ``true``, if font supports given script (ISO 15924 code). @@ -2365,7 +2373,7 @@ Returns ``true``, if font supports given script (ISO 15924 code). .. rst-class:: classref-method -void **font_remove_glyph** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** +|void| **font_remove_glyph**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) Removes specified rendered glyph information from the cache entry. @@ -2379,7 +2387,7 @@ Removes specified rendered glyph information from the cache entry. .. rst-class:: classref-method -void **font_remove_kerning** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair **)** +|void| **font_remove_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) Removes kerning override for the pair of glyphs. @@ -2391,7 +2399,7 @@ Removes kerning override for the pair of glyphs. .. rst-class:: classref-method -void **font_remove_language_support_override** **(** :ref:`RID` font_rid, :ref:`String` language **)** +|void| **font_remove_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) Remove language support override. @@ -2403,7 +2411,7 @@ Remove language support override. .. rst-class:: classref-method -void **font_remove_script_support_override** **(** :ref:`RID` font_rid, :ref:`String` script **)** +|void| **font_remove_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) Removes script support override. @@ -2415,7 +2423,7 @@ Removes script support override. .. rst-class:: classref-method -void **font_remove_size_cache** **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** +|void| **font_remove_size_cache**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) Removes specified font size from the cache entry. @@ -2427,7 +2435,7 @@ Removes specified font size from the cache entry. .. rst-class:: classref-method -void **font_remove_texture** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** +|void| **font_remove_texture**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) Removes specified texture from the cache entry. @@ -2441,7 +2449,7 @@ Removes specified texture from the cache entry. .. rst-class:: classref-method -void **font_render_glyph** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` index **)** +|void| **font_render_glyph**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, index\: :ref:`int`\ ) Renders specified glyph to the font cache texture. @@ -2453,7 +2461,7 @@ Renders specified glyph to the font cache texture. .. rst-class:: classref-method -void **font_render_range** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` start, :ref:`int` end **)** +|void| **font_render_range**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, start\: :ref:`int`, end\: :ref:`int`\ ) Renders the range of characters to the font cache texture. @@ -2465,7 +2473,7 @@ Renders the range of characters to the font cache texture. .. rst-class:: classref-method -void **font_set_allow_system_fallback** **(** :ref:`RID` font_rid, :ref:`bool` allow_system_fallback **)** +|void| **font_set_allow_system_fallback**\ (\ font_rid\: :ref:`RID`, allow_system_fallback\: :ref:`bool`\ ) If set to ``true``, system fonts can be automatically used as fallbacks. @@ -2477,7 +2485,7 @@ If set to ``true``, system fonts can be automatically used as fallbacks. .. rst-class:: classref-method -void **font_set_antialiasing** **(** :ref:`RID` font_rid, :ref:`FontAntialiasing` antialiasing **)** +|void| **font_set_antialiasing**\ (\ font_rid\: :ref:`RID`, antialiasing\: :ref:`FontAntialiasing`\ ) Sets font anti-aliasing mode. @@ -2489,7 +2497,7 @@ Sets font anti-aliasing mode. .. rst-class:: classref-method -void **font_set_ascent** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` ascent **)** +|void| **font_set_ascent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, ascent\: :ref:`float`\ ) Sets the font ascent (number of pixels above the baseline). @@ -2501,7 +2509,7 @@ Sets the font ascent (number of pixels above the baseline). .. rst-class:: classref-method -void **font_set_baseline_offset** **(** :ref:`RID` font_rid, :ref:`float` baseline_offset **)** +|void| **font_set_baseline_offset**\ (\ font_rid\: :ref:`RID`, baseline_offset\: :ref:`float`\ ) Sets extra baseline offset (as a fraction of font height). @@ -2513,7 +2521,7 @@ Sets extra baseline offset (as a fraction of font height). .. rst-class:: classref-method -void **font_set_data** **(** :ref:`RID` font_rid, :ref:`PackedByteArray` data **)** +|void| **font_set_data**\ (\ font_rid\: :ref:`RID`, data\: :ref:`PackedByteArray`\ ) Sets font source data, e.g contents of the dynamic font source file. @@ -2525,7 +2533,7 @@ Sets font source data, e.g contents of the dynamic font source file. .. rst-class:: classref-method -void **font_set_descent** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` descent **)** +|void| **font_set_descent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, descent\: :ref:`float`\ ) Sets the font descent (number of pixels below the baseline). @@ -2537,7 +2545,7 @@ Sets the font descent (number of pixels below the baseline). .. rst-class:: classref-method -void **font_set_embolden** **(** :ref:`RID` font_rid, :ref:`float` strength **)** +|void| **font_set_embolden**\ (\ font_rid\: :ref:`RID`, strength\: :ref:`float`\ ) Sets font embolden strength. If ``strength`` is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. @@ -2549,7 +2557,7 @@ Sets font embolden strength. If ``strength`` is not equal to zero, emboldens the .. rst-class:: classref-method -void **font_set_face_index** **(** :ref:`RID` font_rid, :ref:`int` face_index **)** +|void| **font_set_face_index**\ (\ font_rid\: :ref:`RID`, face_index\: :ref:`int`\ ) Sets an active face index in the TrueType / OpenType collection. @@ -2561,7 +2569,7 @@ Sets an active face index in the TrueType / OpenType collection. .. rst-class:: classref-method -void **font_set_fixed_size** **(** :ref:`RID` font_rid, :ref:`int` fixed_size **)** +|void| **font_set_fixed_size**\ (\ font_rid\: :ref:`RID`, fixed_size\: :ref:`int`\ ) Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes. @@ -2573,7 +2581,7 @@ Sets bitmap font fixed size. If set to value greater than zero, same cache entry .. rst-class:: classref-method -void **font_set_fixed_size_scale_mode** **(** :ref:`RID` font_rid, :ref:`FixedSizeScaleMode` fixed_size_scale_mode **)** +|void| **font_set_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode`\ ) Sets bitmap font scaling mode. This property is used only if ``fixed_size`` is greater than zero. @@ -2585,7 +2593,7 @@ Sets bitmap font scaling mode. This property is used only if ``fixed_size`` is g .. rst-class:: classref-method -void **font_set_force_autohinter** **(** :ref:`RID` font_rid, :ref:`bool` force_autohinter **)** +|void| **font_set_force_autohinter**\ (\ font_rid\: :ref:`RID`, force_autohinter\: :ref:`bool`\ ) If set to ``true`` auto-hinting is preferred over font built-in hinting. @@ -2597,7 +2605,7 @@ If set to ``true`` auto-hinting is preferred over font built-in hinting. .. rst-class:: classref-method -void **font_set_generate_mipmaps** **(** :ref:`RID` font_rid, :ref:`bool` generate_mipmaps **)** +|void| **font_set_generate_mipmaps**\ (\ font_rid\: :ref:`RID`, generate_mipmaps\: :ref:`bool`\ ) If set to ``true`` font texture mipmap generation is enabled. @@ -2609,7 +2617,7 @@ If set to ``true`` font texture mipmap generation is enabled. .. rst-class:: classref-method -void **font_set_global_oversampling** **(** :ref:`float` oversampling **)** +|void| **font_set_global_oversampling**\ (\ oversampling\: :ref:`float`\ ) Sets oversampling factor, shared by all font in the TextServer. @@ -2623,7 +2631,7 @@ Sets oversampling factor, shared by all font in the TextServer. .. rst-class:: classref-method -void **font_set_glyph_advance** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph, :ref:`Vector2` advance **)** +|void| **font_set_glyph_advance**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) Sets glyph advance (offset of the next glyph). @@ -2637,7 +2645,7 @@ Sets glyph advance (offset of the next glyph). .. rst-class:: classref-method -void **font_set_glyph_offset** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Vector2` offset **)** +|void| **font_set_glyph_offset**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) Sets glyph offset from the baseline. @@ -2649,7 +2657,7 @@ Sets glyph offset from the baseline. .. rst-class:: classref-method -void **font_set_glyph_size** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Vector2` gl_size **)** +|void| **font_set_glyph_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) Sets size of the glyph. @@ -2661,7 +2669,7 @@ Sets size of the glyph. .. rst-class:: classref-method -void **font_set_glyph_texture_idx** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`int` texture_idx **)** +|void| **font_set_glyph_texture_idx**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) Sets index of the cache texture containing the glyph. @@ -2673,7 +2681,7 @@ Sets index of the cache texture containing the glyph. .. rst-class:: classref-method -void **font_set_glyph_uv_rect** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Rect2` uv_rect **)** +|void| **font_set_glyph_uv_rect**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) Sets rectangle in the cache texture containing the glyph. @@ -2685,7 +2693,7 @@ Sets rectangle in the cache texture containing the glyph. .. rst-class:: classref-method -void **font_set_hinting** **(** :ref:`RID` font_rid, :ref:`Hinting` hinting **)** +|void| **font_set_hinting**\ (\ font_rid\: :ref:`RID`, hinting\: :ref:`Hinting`\ ) Sets font hinting mode. Used by dynamic fonts only. @@ -2697,7 +2705,7 @@ Sets font hinting mode. Used by dynamic fonts only. .. rst-class:: classref-method -void **font_set_kerning** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair, :ref:`Vector2` kerning **)** +|void| **font_set_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`, kerning\: :ref:`Vector2`\ ) Sets kerning for the pair of glyphs. @@ -2709,7 +2717,7 @@ Sets kerning for the pair of glyphs. .. rst-class:: classref-method -void **font_set_language_support_override** **(** :ref:`RID` font_rid, :ref:`String` language, :ref:`bool` supported **)** +|void| **font_set_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`, supported\: :ref:`bool`\ ) Adds override for :ref:`font_is_language_supported`. @@ -2721,7 +2729,7 @@ Adds override for :ref:`font_is_language_supported` font_rid, :ref:`int` msdf_pixel_range **)** +|void| **font_set_msdf_pixel_range**\ (\ font_rid\: :ref:`RID`, msdf_pixel_range\: :ref:`int`\ ) Sets the width of the range around the shape between the minimum and maximum representable signed distance. @@ -2733,7 +2741,7 @@ Sets the width of the range around the shape between the minimum and maximum rep .. rst-class:: classref-method -void **font_set_msdf_size** **(** :ref:`RID` font_rid, :ref:`int` msdf_size **)** +|void| **font_set_msdf_size**\ (\ font_rid\: :ref:`RID`, msdf_size\: :ref:`int`\ ) Sets source font size used to generate MSDF textures. @@ -2745,7 +2753,7 @@ Sets source font size used to generate MSDF textures. .. rst-class:: classref-method -void **font_set_multichannel_signed_distance_field** **(** :ref:`RID` font_rid, :ref:`bool` msdf **)** +|void| **font_set_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID`, msdf\: :ref:`bool`\ ) If set to ``true``, glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. MSDF rendering allows displaying the font at any scaling factor without blurriness, and without incurring a CPU cost when the font size changes (since the font no longer needs to be rasterized on the CPU). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes. @@ -2759,7 +2767,7 @@ If set to ``true``, glyphs of all sizes are rendered using single multichannel s .. rst-class:: classref-method -void **font_set_name** **(** :ref:`RID` font_rid, :ref:`String` name **)** +|void| **font_set_name**\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) Sets the font family name. @@ -2771,7 +2779,7 @@ Sets the font family name. .. rst-class:: classref-method -void **font_set_opentype_feature_overrides** **(** :ref:`RID` font_rid, :ref:`Dictionary` overrides **)** +|void| **font_set_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID`, overrides\: :ref:`Dictionary`\ ) Sets font OpenType feature set override. @@ -2783,7 +2791,7 @@ Sets font OpenType feature set override. .. rst-class:: classref-method -void **font_set_oversampling** **(** :ref:`RID` font_rid, :ref:`float` oversampling **)** +|void| **font_set_oversampling**\ (\ font_rid\: :ref:`RID`, oversampling\: :ref:`float`\ ) Sets font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only. @@ -2795,7 +2803,7 @@ Sets font oversampling factor, if set to ``0.0`` global oversampling factor is u .. rst-class:: classref-method -void **font_set_scale** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` scale **)** +|void| **font_set_scale**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, scale\: :ref:`float`\ ) Sets scaling factor of the color bitmap font. @@ -2807,7 +2815,7 @@ Sets scaling factor of the color bitmap font. .. rst-class:: classref-method -void **font_set_script_support_override** **(** :ref:`RID` font_rid, :ref:`String` script, :ref:`bool` supported **)** +|void| **font_set_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`, supported\: :ref:`bool`\ ) Adds override for :ref:`font_is_script_supported`. @@ -2819,7 +2827,7 @@ Adds override for :ref:`font_is_script_supported` font_rid, :ref:`SpacingType` spacing, :ref:`int` value **)** +|void| **font_set_spacing**\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) Sets the spacing for ``spacing`` (see :ref:`SpacingType`) to ``value`` in pixels (not relative to the font size). @@ -2831,7 +2839,7 @@ Sets the spacing for ``spacing`` (see :ref:`SpacingType` font_rid, :ref:`int` weight **)** +|void| **font_set_stretch**\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) Sets font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``. @@ -2845,7 +2853,7 @@ Sets font stretch amount, compared to a normal width. A percentage value between .. rst-class:: classref-method -void **font_set_style** **(** :ref:`RID` font_rid, |bitfield|\<:ref:`FontStyle`\> style **)** +|void| **font_set_style**\ (\ font_rid\: :ref:`RID`, style\: |bitfield|\[:ref:`FontStyle`\]\ ) Sets the font style flags, see :ref:`FontStyle`. @@ -2859,7 +2867,7 @@ Sets the font style flags, see :ref:`FontStyle`. .. rst-class:: classref-method -void **font_set_style_name** **(** :ref:`RID` font_rid, :ref:`String` name **)** +|void| **font_set_style_name**\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) Sets the font style name. @@ -2871,7 +2879,7 @@ Sets the font style name. .. rst-class:: classref-method -void **font_set_subpixel_positioning** **(** :ref:`RID` font_rid, :ref:`SubpixelPositioning` subpixel_positioning **)** +|void| **font_set_subpixel_positioning**\ (\ font_rid\: :ref:`RID`, subpixel_positioning\: :ref:`SubpixelPositioning`\ ) Sets font subpixel glyph positioning mode. @@ -2883,7 +2891,7 @@ Sets font subpixel glyph positioning mode. .. rst-class:: classref-method -void **font_set_texture_image** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`Image` image **)** +|void| **font_set_texture_image**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) Sets font cache texture image data. @@ -2895,7 +2903,7 @@ Sets font cache texture image data. .. rst-class:: classref-method -void **font_set_texture_offsets** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`PackedInt32Array` offset **)** +|void| **font_set_texture_offsets**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, offset\: :ref:`PackedInt32Array`\ ) Sets array containing glyph packing data. @@ -2907,7 +2915,7 @@ Sets array containing glyph packing data. .. rst-class:: classref-method -void **font_set_transform** **(** :ref:`RID` font_rid, :ref:`Transform2D` transform **)** +|void| **font_set_transform**\ (\ font_rid\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs. @@ -2921,7 +2929,7 @@ For example, to simulate italic typeface by slanting, apply the following transf .. rst-class:: classref-method -void **font_set_underline_position** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` underline_position **)** +|void| **font_set_underline_position**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) Sets pixel offset of the underline below the baseline. @@ -2933,7 +2941,7 @@ Sets pixel offset of the underline below the baseline. .. rst-class:: classref-method -void **font_set_underline_thickness** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` underline_thickness **)** +|void| **font_set_underline_thickness**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) Sets thickness of the underline in pixels. @@ -2945,7 +2953,7 @@ Sets thickness of the underline in pixels. .. rst-class:: classref-method -void **font_set_variation_coordinates** **(** :ref:`RID` font_rid, :ref:`Dictionary` variation_coordinates **)** +|void| **font_set_variation_coordinates**\ (\ font_rid\: :ref:`RID`, variation_coordinates\: :ref:`Dictionary`\ ) Sets variation coordinates for the specified font cache entry. See :ref:`font_supported_variation_list` for more info. @@ -2957,7 +2965,7 @@ Sets variation coordinates for the specified font cache entry. See :ref:`font_su .. rst-class:: classref-method -void **font_set_weight** **(** :ref:`RID` font_rid, :ref:`int` weight **)** +|void| **font_set_weight**\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) Sets weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``. @@ -2971,7 +2979,7 @@ Sets weight (boldness) of the font. A value in the ``100...999`` range, normal f .. rst-class:: classref-method -:ref:`Dictionary` **font_supported_feature_list** **(** :ref:`RID` font_rid **)** |const| +:ref:`Dictionary` **font_supported_feature_list**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns the dictionary of the supported OpenType features. @@ -2983,7 +2991,7 @@ Returns the dictionary of the supported OpenType features. .. rst-class:: classref-method -:ref:`Dictionary` **font_supported_variation_list** **(** :ref:`RID` font_rid **)** |const| +:ref:`Dictionary` **font_supported_variation_list**\ (\ font_rid\: :ref:`RID`\ ) |const| Returns the dictionary of the supported OpenType variation coordinates. @@ -2995,7 +3003,7 @@ Returns the dictionary of the supported OpenType variation coordinates. .. rst-class:: classref-method -:ref:`String` **format_number** **(** :ref:`String` number, :ref:`String` language="" **)** |const| +:ref:`String` **format_number**\ (\ number\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| Converts a number from the Western Arabic (0..9) to the numeral systems used in ``language``. @@ -3009,7 +3017,7 @@ If ``language`` is omitted, the active locale will be used. .. rst-class:: classref-method -void **free_rid** **(** :ref:`RID` rid **)** +|void| **free_rid**\ (\ rid\: :ref:`RID`\ ) Frees an object created by this **TextServer**. @@ -3021,7 +3029,7 @@ Frees an object created by this **TextServer**. .. rst-class:: classref-method -:ref:`int` **get_features** **(** **)** |const| +:ref:`int` **get_features**\ (\ ) |const| Returns text server features, see :ref:`Feature`. @@ -3033,7 +3041,7 @@ Returns text server features, see :ref:`Feature`. .. rst-class:: classref-method -:ref:`Vector2` **get_hex_code_box_size** **(** :ref:`int` size, :ref:`int` index **)** |const| +:ref:`Vector2` **get_hex_code_box_size**\ (\ size\: :ref:`int`, index\: :ref:`int`\ ) |const| Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters). @@ -3045,7 +3053,7 @@ Returns size of the replacement character (box with character hexadecimal code t .. rst-class:: classref-method -:ref:`String` **get_name** **(** **)** |const| +:ref:`String` **get_name**\ (\ ) |const| Returns the name of the server interface. @@ -3057,7 +3065,7 @@ Returns the name of the server interface. .. rst-class:: classref-method -:ref:`String` **get_support_data_filename** **(** **)** |const| +:ref:`String` **get_support_data_filename**\ (\ ) |const| Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename. @@ -3069,7 +3077,7 @@ Returns default TextServer database (e.g. ICU break iterators and dictionaries) .. rst-class:: classref-method -:ref:`String` **get_support_data_info** **(** **)** |const| +:ref:`String` **get_support_data_info**\ (\ ) |const| Returns TextServer database (e.g. ICU break iterators and dictionaries) description. @@ -3081,7 +3089,7 @@ Returns TextServer database (e.g. ICU break iterators and dictionaries) descript .. rst-class:: classref-method -:ref:`bool` **has** **(** :ref:`RID` rid **)** +:ref:`bool` **has**\ (\ rid\: :ref:`RID`\ ) Returns ``true`` if ``rid`` is valid resource owned by this text server. @@ -3093,7 +3101,7 @@ Returns ``true`` if ``rid`` is valid resource owned by this text server. .. rst-class:: classref-method -:ref:`bool` **has_feature** **(** :ref:`Feature` feature **)** |const| +:ref:`bool` **has_feature**\ (\ feature\: :ref:`Feature`\ ) |const| Returns ``true`` if the server supports a feature. @@ -3105,7 +3113,7 @@ Returns ``true`` if the server supports a feature. .. rst-class:: classref-method -:ref:`int` **is_confusable** **(** :ref:`String` string, :ref:`PackedStringArray` dict **)** |const| +:ref:`int` **is_confusable**\ (\ string\: :ref:`String`, dict\: :ref:`PackedStringArray`\ ) |const| Returns index of the first string in ``dict`` which is visually confusable with the ``string``, or ``-1`` if none is found. @@ -3121,7 +3129,7 @@ Returns index of the first string in ``dict`` which is visually confusable with .. rst-class:: classref-method -:ref:`bool` **is_locale_right_to_left** **(** :ref:`String` locale **)** |const| +:ref:`bool` **is_locale_right_to_left**\ (\ locale\: :ref:`String`\ ) |const| Returns ``true`` if locale is right-to-left. @@ -3133,7 +3141,7 @@ Returns ``true`` if locale is right-to-left. .. rst-class:: classref-method -:ref:`bool` **is_valid_identifier** **(** :ref:`String` string **)** |const| +:ref:`bool` **is_valid_identifier**\ (\ string\: :ref:`String`\ ) |const| Returns ``true`` if ``string`` is a valid identifier. @@ -3161,7 +3169,7 @@ If the :ref:`FEATURE_UNICODE_IDENTIFIERS` **load_support_data** **(** :ref:`String` filename **)** +:ref:`bool` **load_support_data**\ (\ filename\: :ref:`String`\ ) Loads optional TextServer database (e.g. ICU break iterators and dictionaries). @@ -3175,7 +3183,7 @@ Loads optional TextServer database (e.g. ICU break iterators and dictionaries). .. rst-class:: classref-method -:ref:`int` **name_to_tag** **(** :ref:`String` name **)** |const| +:ref:`int` **name_to_tag**\ (\ name\: :ref:`String`\ ) |const| Converts readable feature, variation, script or language name to OpenType tag. @@ -3187,7 +3195,7 @@ Converts readable feature, variation, script or language name to OpenType tag. .. rst-class:: classref-method -:ref:`String` **parse_number** **(** :ref:`String` number, :ref:`String` language="" **)** |const| +:ref:`String` **parse_number**\ (\ number\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| Converts ``number`` from the numeral systems used in ``language`` to Western Arabic (0..9). @@ -3199,7 +3207,7 @@ Converts ``number`` from the numeral systems used in ``language`` to Western Ara .. rst-class:: classref-method -:ref:`Vector3i[]` **parse_structured_text** **(** :ref:`StructuredTextParser` parser_type, :ref:`Array` args, :ref:`String` text **)** |const| +:ref:`Array`\[:ref:`Vector3i`\] **parse_structured_text**\ (\ parser_type\: :ref:`StructuredTextParser`, args\: :ref:`Array`, text\: :ref:`String`\ ) |const| Default implementation of the BiDi algorithm override function. See :ref:`StructuredTextParser` for more info. @@ -3211,7 +3219,7 @@ Default implementation of the BiDi algorithm override function. See :ref:`Struct .. rst-class:: classref-method -:ref:`String` **percent_sign** **(** :ref:`String` language="" **)** |const| +:ref:`String` **percent_sign**\ (\ language\: :ref:`String` = ""\ ) |const| Returns percent sign used in the ``language``. @@ -3223,7 +3231,7 @@ Returns percent sign used in the ``language``. .. rst-class:: classref-method -:ref:`bool` **save_support_data** **(** :ref:`String` filename **)** |const| +:ref:`bool` **save_support_data**\ (\ filename\: :ref:`String`\ ) |const| Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file. @@ -3237,7 +3245,7 @@ Saves optional TextServer database (e.g. ICU break iterators and dictionaries) t .. rst-class:: classref-method -:ref:`int` **shaped_get_span_count** **(** :ref:`RID` shaped **)** |const| +:ref:`int` **shaped_get_span_count**\ (\ shaped\: :ref:`RID`\ ) |const| Returns number of text spans added using :ref:`shaped_text_add_string` or :ref:`shaped_text_add_object`. @@ -3249,7 +3257,7 @@ Returns number of text spans added using :ref:`shaped_text_add_string` **shaped_get_span_meta** **(** :ref:`RID` shaped, :ref:`int` index **)** |const| +:ref:`Variant` **shaped_get_span_meta**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| Returns text span metadata. @@ -3261,7 +3269,7 @@ Returns text span metadata. .. rst-class:: classref-method -void **shaped_set_span_update_font** **(** :ref:`RID` shaped, :ref:`int` index, :ref:`RID[]` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features={} **)** +|void| **shaped_set_span_update_font**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary` = {}\ ) Changes text span font, font size and OpenType features, without changing the text. @@ -3273,7 +3281,7 @@ Changes text span font, font size and OpenType features, without changing the te .. rst-class:: classref-method -:ref:`bool` **shaped_text_add_object** **(** :ref:`RID` shaped, :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align=5, :ref:`int` length=1, :ref:`float` baseline=0.0 **)** +:ref:`bool` **shaped_text_add_object**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) Adds inline object to the text buffer, ``key`` must be unique. In the text, object is represented as ``length`` object replacement characters. @@ -3285,7 +3293,7 @@ Adds inline object to the text buffer, ``key`` must be unique. In the text, obje .. rst-class:: classref-method -:ref:`bool` **shaped_text_add_string** **(** :ref:`RID` shaped, :ref:`String` text, :ref:`RID[]` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features={}, :ref:`String` language="", :ref:`Variant` meta=null **)** +:ref:`bool` **shaped_text_add_string**\ (\ shaped\: :ref:`RID`, text\: :ref:`String`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary` = {}, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) Adds text span and font to draw it to the text buffer. @@ -3297,7 +3305,7 @@ Adds text span and font to draw it to the text buffer. .. rst-class:: classref-method -void **shaped_text_clear** **(** :ref:`RID` rid **)** +|void| **shaped_text_clear**\ (\ rid\: :ref:`RID`\ ) Clears text buffer (removes text and inline objects). @@ -3309,7 +3317,7 @@ Clears text buffer (removes text and inline objects). .. rst-class:: classref-method -:ref:`int` **shaped_text_closest_character_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| +:ref:`int` **shaped_text_closest_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| Returns composite character position closest to the ``pos``. @@ -3321,7 +3329,7 @@ Returns composite character position closest to the ``pos``. .. rst-class:: classref-method -void **shaped_text_draw** **(** :ref:`RID` shaped, :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`float` clip_l=-1, :ref:`float` clip_r=-1, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| +|void| **shaped_text_draw**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float` = -1, clip_r\: :ref:`float` = -1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| Draw shaped text into a canvas item at a given position, with ``color``. ``pos`` specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). @@ -3333,7 +3341,7 @@ Draw shaped text into a canvas item at a given position, with ``color``. ``pos`` .. rst-class:: classref-method -void **shaped_text_draw_outline** **(** :ref:`RID` shaped, :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`float` clip_l=-1, :ref:`float` clip_r=-1, :ref:`int` outline_size=1, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| +|void| **shaped_text_draw_outline**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float` = -1, clip_r\: :ref:`float` = -1, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| Draw the outline of the shaped text into a canvas item at a given position, with ``color``. ``pos`` specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). @@ -3345,7 +3353,7 @@ Draw the outline of the shaped text into a canvas item at a given position, with .. rst-class:: classref-method -:ref:`float` **shaped_text_fit_to_width** **(** :ref:`RID` shaped, :ref:`float` width, |bitfield|\<:ref:`JustificationFlag`\> justification_flags=3 **)** +:ref:`float` **shaped_text_fit_to_width**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3\ ) Adjusts text width to fit to specified width, returns new text width. @@ -3357,7 +3365,7 @@ Adjusts text width to fit to specified width, returns new text width. .. rst-class:: classref-method -:ref:`float` **shaped_text_get_ascent** **(** :ref:`RID` shaped **)** |const| +:ref:`float` **shaped_text_get_ascent**\ (\ shaped\: :ref:`RID`\ ) |const| Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). @@ -3371,7 +3379,7 @@ Returns the text ascent (number of pixels above the baseline for horizontal layo .. rst-class:: classref-method -:ref:`Dictionary` **shaped_text_get_carets** **(** :ref:`RID` shaped, :ref:`int` position **)** |const| +:ref:`Dictionary` **shaped_text_get_carets**\ (\ shaped\: :ref:`RID`, position\: :ref:`int`\ ) |const| Returns shapes of the carets corresponding to the character offset ``position`` in the text. Returned caret shape is 1 pixel wide rectangle. @@ -3383,7 +3391,7 @@ Returns shapes of the carets corresponding to the character offset ``position`` .. rst-class:: classref-method -:ref:`PackedInt32Array` **shaped_text_get_character_breaks** **(** :ref:`RID` shaped **)** |const| +:ref:`PackedInt32Array` **shaped_text_get_character_breaks**\ (\ shaped\: :ref:`RID`\ ) |const| Returns array of the composite character boundaries. @@ -3395,7 +3403,7 @@ Returns array of the composite character boundaries. .. rst-class:: classref-method -:ref:`int` **shaped_text_get_custom_ellipsis** **(** :ref:`RID` shaped **)** |const| +:ref:`int` **shaped_text_get_custom_ellipsis**\ (\ shaped\: :ref:`RID`\ ) |const| Returns ellipsis character used for text clipping. @@ -3407,7 +3415,7 @@ Returns ellipsis character used for text clipping. .. rst-class:: classref-method -:ref:`String` **shaped_text_get_custom_punctuation** **(** :ref:`RID` shaped **)** |const| +:ref:`String` **shaped_text_get_custom_punctuation**\ (\ shaped\: :ref:`RID`\ ) |const| Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. @@ -3419,7 +3427,7 @@ Returns custom punctuation character list, used for word breaking. If set to emp .. rst-class:: classref-method -:ref:`float` **shaped_text_get_descent** **(** :ref:`RID` shaped **)** |const| +:ref:`float` **shaped_text_get_descent**\ (\ shaped\: :ref:`RID`\ ) |const| Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). @@ -3433,7 +3441,7 @@ Returns the text descent (number of pixels below the baseline for horizontal lay .. rst-class:: classref-method -:ref:`Direction` **shaped_text_get_direction** **(** :ref:`RID` shaped **)** |const| +:ref:`Direction` **shaped_text_get_direction**\ (\ shaped\: :ref:`RID`\ ) |const| Returns direction of the text. @@ -3445,7 +3453,7 @@ Returns direction of the text. .. rst-class:: classref-method -:ref:`Direction` **shaped_text_get_dominant_direction_in_range** **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` end **)** |const| +:ref:`Direction` **shaped_text_get_dominant_direction_in_range**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |const| Returns dominant direction of in the range of text. @@ -3457,7 +3465,7 @@ Returns dominant direction of in the range of text. .. rst-class:: classref-method -:ref:`int` **shaped_text_get_ellipsis_glyph_count** **(** :ref:`RID` shaped **)** |const| +:ref:`int` **shaped_text_get_ellipsis_glyph_count**\ (\ shaped\: :ref:`RID`\ ) |const| Returns number of glyphs in the ellipsis. @@ -3469,7 +3477,7 @@ Returns number of glyphs in the ellipsis. .. rst-class:: classref-method -:ref:`Dictionary[]` **shaped_text_get_ellipsis_glyphs** **(** :ref:`RID` shaped **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **shaped_text_get_ellipsis_glyphs**\ (\ shaped\: :ref:`RID`\ ) |const| Returns array of the glyphs in the ellipsis. @@ -3481,7 +3489,7 @@ Returns array of the glyphs in the ellipsis. .. rst-class:: classref-method -:ref:`int` **shaped_text_get_ellipsis_pos** **(** :ref:`RID` shaped **)** |const| +:ref:`int` **shaped_text_get_ellipsis_pos**\ (\ shaped\: :ref:`RID`\ ) |const| Returns position of the ellipsis. @@ -3493,7 +3501,7 @@ Returns position of the ellipsis. .. rst-class:: classref-method -:ref:`int` **shaped_text_get_glyph_count** **(** :ref:`RID` shaped **)** |const| +:ref:`int` **shaped_text_get_glyph_count**\ (\ shaped\: :ref:`RID`\ ) |const| Returns number of glyphs in the buffer. @@ -3505,7 +3513,7 @@ Returns number of glyphs in the buffer. .. rst-class:: classref-method -:ref:`Dictionary[]` **shaped_text_get_glyphs** **(** :ref:`RID` shaped **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **shaped_text_get_glyphs**\ (\ shaped\: :ref:`RID`\ ) |const| Returns an array of glyphs in the visual order. @@ -3517,7 +3525,7 @@ Returns an array of glyphs in the visual order. .. rst-class:: classref-method -:ref:`Vector2` **shaped_text_get_grapheme_bounds** **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| +:ref:`Vector2` **shaped_text_get_grapheme_bounds**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| Returns composite character's bounds as offsets from the start of the line. @@ -3529,7 +3537,7 @@ Returns composite character's bounds as offsets from the start of the line. .. rst-class:: classref-method -:ref:`Direction` **shaped_text_get_inferred_direction** **(** :ref:`RID` shaped **)** |const| +:ref:`Direction` **shaped_text_get_inferred_direction**\ (\ shaped\: :ref:`RID`\ ) |const| Returns direction of the text, inferred by the BiDi algorithm. @@ -3541,7 +3549,7 @@ Returns direction of the text, inferred by the BiDi algorithm. .. rst-class:: classref-method -:ref:`PackedInt32Array` **shaped_text_get_line_breaks** **(** :ref:`RID` shaped, :ref:`float` width, :ref:`int` start=0, |bitfield|\<:ref:`LineBreakFlag`\> break_flags=3 **)** |const| +:ref:`PackedInt32Array` **shaped_text_get_line_breaks**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, start\: :ref:`int` = 0, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3\ ) |const| Breaks text to the lines and returns character ranges for each line. @@ -3553,7 +3561,7 @@ Breaks text to the lines and returns character ranges for each line. .. rst-class:: classref-method -:ref:`PackedInt32Array` **shaped_text_get_line_breaks_adv** **(** :ref:`RID` shaped, :ref:`PackedFloat32Array` width, :ref:`int` start=0, :ref:`bool` once=true, |bitfield|\<:ref:`LineBreakFlag`\> break_flags=3 **)** |const| +:ref:`PackedInt32Array` **shaped_text_get_line_breaks_adv**\ (\ shaped\: :ref:`RID`, width\: :ref:`PackedFloat32Array`, start\: :ref:`int` = 0, once\: :ref:`bool` = true, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3\ ) |const| Breaks text to the lines and columns. Returns character ranges for each segment. @@ -3565,7 +3573,7 @@ Breaks text to the lines and columns. Returns character ranges for each segment. .. rst-class:: classref-method -:ref:`Rect2` **shaped_text_get_object_rect** **(** :ref:`RID` shaped, :ref:`Variant` key **)** |const| +:ref:`Rect2` **shaped_text_get_object_rect**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |const| Returns bounding rectangle of the inline object. @@ -3577,7 +3585,7 @@ Returns bounding rectangle of the inline object. .. rst-class:: classref-method -:ref:`Array` **shaped_text_get_objects** **(** :ref:`RID` shaped **)** |const| +:ref:`Array` **shaped_text_get_objects**\ (\ shaped\: :ref:`RID`\ ) |const| Returns array of inline objects. @@ -3589,7 +3597,7 @@ Returns array of inline objects. .. rst-class:: classref-method -:ref:`Orientation` **shaped_text_get_orientation** **(** :ref:`RID` shaped **)** |const| +:ref:`Orientation` **shaped_text_get_orientation**\ (\ shaped\: :ref:`RID`\ ) |const| Returns text orientation. @@ -3601,7 +3609,7 @@ Returns text orientation. .. rst-class:: classref-method -:ref:`RID` **shaped_text_get_parent** **(** :ref:`RID` shaped **)** |const| +:ref:`RID` **shaped_text_get_parent**\ (\ shaped\: :ref:`RID`\ ) |const| Returns the parent buffer from which the substring originates. @@ -3613,7 +3621,7 @@ Returns the parent buffer from which the substring originates. .. rst-class:: classref-method -:ref:`bool` **shaped_text_get_preserve_control** **(** :ref:`RID` shaped **)** |const| +:ref:`bool` **shaped_text_get_preserve_control**\ (\ shaped\: :ref:`RID`\ ) |const| Returns ``true`` if text buffer is configured to display control characters. @@ -3625,7 +3633,7 @@ Returns ``true`` if text buffer is configured to display control characters. .. rst-class:: classref-method -:ref:`bool` **shaped_text_get_preserve_invalid** **(** :ref:`RID` shaped **)** |const| +:ref:`bool` **shaped_text_get_preserve_invalid**\ (\ shaped\: :ref:`RID`\ ) |const| Returns ``true`` if text buffer is configured to display hexadecimal codes in place of invalid characters. @@ -3639,7 +3647,7 @@ Returns ``true`` if text buffer is configured to display hexadecimal codes in pl .. rst-class:: classref-method -:ref:`Vector2i` **shaped_text_get_range** **(** :ref:`RID` shaped **)** |const| +:ref:`Vector2i` **shaped_text_get_range**\ (\ shaped\: :ref:`RID`\ ) |const| Returns substring buffer character range in the parent buffer. @@ -3651,7 +3659,7 @@ Returns substring buffer character range in the parent buffer. .. rst-class:: classref-method -:ref:`PackedVector2Array` **shaped_text_get_selection** **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` end **)** |const| +:ref:`PackedVector2Array` **shaped_text_get_selection**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |const| Returns selection rectangles for the specified character range. @@ -3663,7 +3671,7 @@ Returns selection rectangles for the specified character range. .. rst-class:: classref-method -:ref:`Vector2` **shaped_text_get_size** **(** :ref:`RID` shaped **)** |const| +:ref:`Vector2` **shaped_text_get_size**\ (\ shaped\: :ref:`RID`\ ) |const| Returns size of the text. @@ -3675,7 +3683,7 @@ Returns size of the text. .. rst-class:: classref-method -:ref:`int` **shaped_text_get_spacing** **(** :ref:`RID` shaped, :ref:`SpacingType` spacing **)** |const| +:ref:`int` **shaped_text_get_spacing**\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |const| Returns extra spacing added between glyphs or lines in pixels. @@ -3687,7 +3695,7 @@ Returns extra spacing added between glyphs or lines in pixels. .. rst-class:: classref-method -:ref:`int` **shaped_text_get_trim_pos** **(** :ref:`RID` shaped **)** |const| +:ref:`int` **shaped_text_get_trim_pos**\ (\ shaped\: :ref:`RID`\ ) |const| Returns the position of the overrun trim. @@ -3699,7 +3707,7 @@ Returns the position of the overrun trim. .. rst-class:: classref-method -:ref:`float` **shaped_text_get_underline_position** **(** :ref:`RID` shaped **)** |const| +:ref:`float` **shaped_text_get_underline_position**\ (\ shaped\: :ref:`RID`\ ) |const| Returns pixel offset of the underline below the baseline. @@ -3711,7 +3719,7 @@ Returns pixel offset of the underline below the baseline. .. rst-class:: classref-method -:ref:`float` **shaped_text_get_underline_thickness** **(** :ref:`RID` shaped **)** |const| +:ref:`float` **shaped_text_get_underline_thickness**\ (\ shaped\: :ref:`RID`\ ) |const| Returns thickness of the underline. @@ -3723,7 +3731,7 @@ Returns thickness of the underline. .. rst-class:: classref-method -:ref:`float` **shaped_text_get_width** **(** :ref:`RID` shaped **)** |const| +:ref:`float` **shaped_text_get_width**\ (\ shaped\: :ref:`RID`\ ) |const| Returns width (for horizontal layout) or height (for vertical) of the text. @@ -3735,7 +3743,7 @@ Returns width (for horizontal layout) or height (for vertical) of the text. .. rst-class:: classref-method -:ref:`PackedInt32Array` **shaped_text_get_word_breaks** **(** :ref:`RID` shaped, |bitfield|\<:ref:`GraphemeFlag`\> grapheme_flags=264 **)** |const| +:ref:`PackedInt32Array` **shaped_text_get_word_breaks**\ (\ shaped\: :ref:`RID`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\] = 264\ ) |const| Breaks text into words and returns array of character ranges. Use ``grapheme_flags`` to set what characters are used for breaking (see :ref:`GraphemeFlag`). @@ -3747,7 +3755,7 @@ Breaks text into words and returns array of character ranges. Use ``grapheme_fla .. rst-class:: classref-method -:ref:`bool` **shaped_text_has_visible_chars** **(** :ref:`RID` shaped **)** |const| +:ref:`bool` **shaped_text_has_visible_chars**\ (\ shaped\: :ref:`RID`\ ) |const| Returns ``true`` if text buffer contains any visible characters. @@ -3759,7 +3767,7 @@ Returns ``true`` if text buffer contains any visible characters. .. rst-class:: classref-method -:ref:`int` **shaped_text_hit_test_grapheme** **(** :ref:`RID` shaped, :ref:`float` coords **)** |const| +:ref:`int` **shaped_text_hit_test_grapheme**\ (\ shaped\: :ref:`RID`, coords\: :ref:`float`\ ) |const| Returns grapheme index at the specified pixel offset at the baseline, or ``-1`` if none is found. @@ -3771,7 +3779,7 @@ Returns grapheme index at the specified pixel offset at the baseline, or ``-1`` .. rst-class:: classref-method -:ref:`int` **shaped_text_hit_test_position** **(** :ref:`RID` shaped, :ref:`float` coords **)** |const| +:ref:`int` **shaped_text_hit_test_position**\ (\ shaped\: :ref:`RID`, coords\: :ref:`float`\ ) |const| Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position. @@ -3783,7 +3791,7 @@ Returns caret character offset at the specified pixel offset at the baseline. Th .. rst-class:: classref-method -:ref:`bool` **shaped_text_is_ready** **(** :ref:`RID` shaped **)** |const| +:ref:`bool` **shaped_text_is_ready**\ (\ shaped\: :ref:`RID`\ ) |const| Returns ``true`` if buffer is successfully shaped. @@ -3795,7 +3803,7 @@ Returns ``true`` if buffer is successfully shaped. .. rst-class:: classref-method -:ref:`int` **shaped_text_next_character_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| +:ref:`int` **shaped_text_next_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| Returns composite character end position closest to the ``pos``. @@ -3807,7 +3815,7 @@ Returns composite character end position closest to the ``pos``. .. rst-class:: classref-method -:ref:`int` **shaped_text_next_grapheme_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| +:ref:`int` **shaped_text_next_grapheme_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| Returns grapheme end position closest to the ``pos``. @@ -3819,7 +3827,7 @@ Returns grapheme end position closest to the ``pos``. .. rst-class:: classref-method -void **shaped_text_overrun_trim_to_width** **(** :ref:`RID` shaped, :ref:`float` width=0, |bitfield|\<:ref:`TextOverrunFlag`\> overrun_trim_flags=0 **)** +|void| **shaped_text_overrun_trim_to_width**\ (\ shaped\: :ref:`RID`, width\: :ref:`float` = 0, overrun_trim_flags\: |bitfield|\[:ref:`TextOverrunFlag`\] = 0\ ) Trims text if it exceeds the given width. @@ -3831,7 +3839,7 @@ Trims text if it exceeds the given width. .. rst-class:: classref-method -:ref:`int` **shaped_text_prev_character_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| +:ref:`int` **shaped_text_prev_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| Returns composite character start position closest to the ``pos``. @@ -3843,7 +3851,7 @@ Returns composite character start position closest to the ``pos``. .. rst-class:: classref-method -:ref:`int` **shaped_text_prev_grapheme_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| +:ref:`int` **shaped_text_prev_grapheme_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |const| Returns grapheme start position closest to the ``pos``. @@ -3855,7 +3863,7 @@ Returns grapheme start position closest to the ``pos``. .. rst-class:: classref-method -:ref:`bool` **shaped_text_resize_object** **(** :ref:`RID` shaped, :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align=5, :ref:`float` baseline=0.0 **)** +:ref:`bool` **shaped_text_resize_object**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) Sets new size and alignment of embedded object. @@ -3867,7 +3875,7 @@ Sets new size and alignment of embedded object. .. rst-class:: classref-method -void **shaped_text_set_bidi_override** **(** :ref:`RID` shaped, :ref:`Array` override **)** +|void| **shaped_text_set_bidi_override**\ (\ shaped\: :ref:`RID`, override\: :ref:`Array`\ ) Overrides BiDi for the structured text. @@ -3881,7 +3889,7 @@ Override ranges should cover full source text without overlaps. BiDi algorithm w .. rst-class:: classref-method -void **shaped_text_set_custom_ellipsis** **(** :ref:`RID` shaped, :ref:`int` char **)** +|void| **shaped_text_set_custom_ellipsis**\ (\ shaped\: :ref:`RID`, char\: :ref:`int`\ ) Sets ellipsis character used for text clipping. @@ -3893,7 +3901,7 @@ Sets ellipsis character used for text clipping. .. rst-class:: classref-method -void **shaped_text_set_custom_punctuation** **(** :ref:`RID` shaped, :ref:`String` punct **)** +|void| **shaped_text_set_custom_punctuation**\ (\ shaped\: :ref:`RID`, punct\: :ref:`String`\ ) Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. @@ -3905,7 +3913,7 @@ Sets custom punctuation character list, used for word breaking. If set to empty .. rst-class:: classref-method -void **shaped_text_set_direction** **(** :ref:`RID` shaped, :ref:`Direction` direction=0 **)** +|void| **shaped_text_set_direction**\ (\ shaped\: :ref:`RID`, direction\: :ref:`Direction` = 0\ ) Sets desired text direction. If set to :ref:`DIRECTION_AUTO`, direction will be detected based on the buffer contents and current locale. @@ -3919,7 +3927,7 @@ Sets desired text direction. If set to :ref:`DIRECTION_AUTO` shaped, :ref:`Orientation` orientation=0 **)** +|void| **shaped_text_set_orientation**\ (\ shaped\: :ref:`RID`, orientation\: :ref:`Orientation` = 0\ ) Sets desired text orientation. @@ -3933,7 +3941,7 @@ Sets desired text orientation. .. rst-class:: classref-method -void **shaped_text_set_preserve_control** **(** :ref:`RID` shaped, :ref:`bool` enabled **)** +|void| **shaped_text_set_preserve_control**\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) If set to ``true`` text buffer will display control characters. @@ -3945,7 +3953,7 @@ If set to ``true`` text buffer will display control characters. .. rst-class:: classref-method -void **shaped_text_set_preserve_invalid** **(** :ref:`RID` shaped, :ref:`bool` enabled **)** +|void| **shaped_text_set_preserve_invalid**\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) If set to ``true`` text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed. @@ -3957,7 +3965,7 @@ If set to ``true`` text buffer will display invalid characters as hexadecimal co .. rst-class:: classref-method -void **shaped_text_set_spacing** **(** :ref:`RID` shaped, :ref:`SpacingType` spacing, :ref:`int` value **)** +|void| **shaped_text_set_spacing**\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) Sets extra spacing added between glyphs or lines in pixels. @@ -3969,7 +3977,7 @@ Sets extra spacing added between glyphs or lines in pixels. .. rst-class:: classref-method -:ref:`bool` **shaped_text_shape** **(** :ref:`RID` shaped **)** +:ref:`bool` **shaped_text_shape**\ (\ shaped\: :ref:`RID`\ ) Shapes buffer if it's not shaped. Returns ``true`` if the string is shaped successfully. @@ -3983,7 +3991,7 @@ Shapes buffer if it's not shaped. Returns ``true`` if the string is shaped succe .. rst-class:: classref-method -:ref:`Dictionary[]` **shaped_text_sort_logical** **(** :ref:`RID` shaped **)** +:ref:`Array`\[:ref:`Dictionary`\] **shaped_text_sort_logical**\ (\ shaped\: :ref:`RID`\ ) Returns text glyphs in the logical order. @@ -3995,7 +4003,7 @@ Returns text glyphs in the logical order. .. rst-class:: classref-method -:ref:`RID` **shaped_text_substr** **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` length **)** |const| +:ref:`RID` **shaped_text_substr**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, length\: :ref:`int`\ ) |const| Returns text buffer for the substring of the text in the ``shaped`` text buffer (including inline objects). @@ -4007,7 +4015,7 @@ Returns text buffer for the substring of the text in the ``shaped`` text buffer .. rst-class:: classref-method -:ref:`float` **shaped_text_tab_align** **(** :ref:`RID` shaped, :ref:`PackedFloat32Array` tab_stops **)** +:ref:`float` **shaped_text_tab_align**\ (\ shaped\: :ref:`RID`, tab_stops\: :ref:`PackedFloat32Array`\ ) Aligns shaped text to the given tab-stops. @@ -4019,7 +4027,7 @@ Aligns shaped text to the given tab-stops. .. rst-class:: classref-method -:ref:`bool` **spoof_check** **(** :ref:`String` string **)** |const| +:ref:`bool` **spoof_check**\ (\ string\: :ref:`String`\ ) |const| Returns ``true`` if ``string`` is likely to be an attempt at confusing the reader. @@ -4033,7 +4041,7 @@ Returns ``true`` if ``string`` is likely to be an attempt at confusing the reade .. rst-class:: classref-method -:ref:`PackedInt32Array` **string_get_character_breaks** **(** :ref:`String` string, :ref:`String` language="" **)** |const| +:ref:`PackedInt32Array` **string_get_character_breaks**\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| Returns array of the composite character boundaries. @@ -4050,7 +4058,7 @@ Returns array of the composite character boundaries. .. rst-class:: classref-method -:ref:`PackedInt32Array` **string_get_word_breaks** **(** :ref:`String` string, :ref:`String` language="", :ref:`int` chars_per_line=0 **)** |const| +:ref:`PackedInt32Array` **string_get_word_breaks**\ (\ string\: :ref:`String`, language\: :ref:`String` = "", chars_per_line\: :ref:`int` = 0\ ) |const| Returns an array of the word break boundaries. Elements in the returned array are the offsets of the start and end of words. Therefore the length of the array is always even. @@ -4070,7 +4078,7 @@ When ``chars_per_line`` is greater than zero, line break boundaries are returned .. rst-class:: classref-method -:ref:`String` **string_to_lower** **(** :ref:`String` string, :ref:`String` language="" **)** |const| +:ref:`String` **string_to_lower**\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| Returns the string converted to lowercase. @@ -4086,7 +4094,7 @@ Returns the string converted to lowercase. .. rst-class:: classref-method -:ref:`String` **string_to_upper** **(** :ref:`String` string, :ref:`String` language="" **)** |const| +:ref:`String` **string_to_upper**\ (\ string\: :ref:`String`, language\: :ref:`String` = ""\ ) |const| Returns the string converted to uppercase. @@ -4102,7 +4110,7 @@ Returns the string converted to uppercase. .. rst-class:: classref-method -:ref:`String` **strip_diacritics** **(** :ref:`String` string **)** |const| +:ref:`String` **strip_diacritics**\ (\ string\: :ref:`String`\ ) |const| Strips diacritics from the string. @@ -4116,7 +4124,7 @@ Strips diacritics from the string. .. rst-class:: classref-method -:ref:`String` **tag_to_name** **(** :ref:`int` tag **)** |const| +:ref:`String` **tag_to_name**\ (\ tag\: :ref:`int`\ ) |const| Converts OpenType tag to readable feature, variation, script or language name. @@ -4127,3 +4135,4 @@ Converts OpenType tag to readable feature, variation, script or language name. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_textserveradvanced.rst b/classes/class_textserveradvanced.rst index 819fbea5f15..beed8294dd6 100644 --- a/classes/class_textserveradvanced.rst +++ b/classes/class_textserveradvanced.rst @@ -28,3 +28,4 @@ An implementation of :ref:`TextServer` that uses HarfBuzz, ICU .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_textserverdummy.rst b/classes/class_textserverdummy.rst index 8e65c928b71..932e4df4fa5 100644 --- a/classes/class_textserverdummy.rst +++ b/classes/class_textserverdummy.rst @@ -43,3 +43,4 @@ The command line argument ``--text-driver Dummy`` (case-sensitive) can be used t .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_textserverextension.rst b/classes/class_textserverextension.rst index 502c1e62129..7721d4167ea 100644 --- a/classes/class_textserverextension.rst +++ b/classes/class_textserverextension.rst @@ -31,427 +31,427 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_cleanup` **(** **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_create_font` **(** **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_create_font_linked_variation` **(** :ref:`RID` font_rid **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_create_shaped_text` **(** :ref:`Direction` direction, :ref:`Orientation` orientation **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_draw_hex_code_box` **(** :ref:`RID` canvas, :ref:`int` size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_clear_glyphs` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_clear_kerning_map` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_clear_size_cache` **(** :ref:`RID` font_rid **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_clear_textures` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_draw_glyph` **(** :ref:`RID` font_rid, :ref:`RID` canvas, :ref:`int` size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_draw_glyph_outline` **(** :ref:`RID` font_rid, :ref:`RID` canvas, :ref:`int` size, :ref:`int` outline_size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`FontAntialiasing` | :ref:`_font_get_antialiasing` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_font_get_ascent` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_font_get_baseline_offset` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_char_from_glyph_index` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph_index **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_font_get_descent` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_font_get_embolden` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_face_count` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_face_index` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_fixed_size` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`FixedSizeScaleMode` | :ref:`_font_get_fixed_size_scale_mode` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_get_generate_mipmaps` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_font_get_global_oversampling` **(** **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_font_get_glyph_advance` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_font_get_glyph_contours` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` index **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_glyph_index` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` char, :ref:`int` variation_selector **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_font_get_glyph_list` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_font_get_glyph_offset` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_font_get_glyph_size` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_glyph_texture_idx` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_font_get_glyph_texture_rid` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_font_get_glyph_texture_size` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`_font_get_glyph_uv_rect` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Hinting` | :ref:`_font_get_hinting` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_font_get_kerning` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i[]` | :ref:`_font_get_kerning_list` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_get_language_support_override` **(** :ref:`RID` font_rid, :ref:`String` language **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_font_get_language_support_overrides` **(** :ref:`RID` font_rid **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_msdf_pixel_range` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_msdf_size` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_font_get_name` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_font_get_opentype_feature_overrides` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_font_get_ot_name_strings` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_font_get_oversampling` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_font_get_scale` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_get_script_support_override` **(** :ref:`RID` font_rid, :ref:`String` script **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_font_get_script_support_overrides` **(** :ref:`RID` font_rid **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i[]` | :ref:`_font_get_size_cache_list` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_spacing` **(** :ref:`RID` font_rid, :ref:`SpacingType` spacing **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_stretch` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`FontStyle`\> | :ref:`_font_get_style` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_font_get_style_name` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SubpixelPositioning` | :ref:`_font_get_subpixel_positioning` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_font_get_supported_chars` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_texture_count` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`_font_get_texture_image` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_font_get_texture_offsets` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`_font_get_transform` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_font_get_underline_position` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_font_get_underline_thickness` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_font_get_variation_coordinates` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_font_get_weight` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_has_char` **(** :ref:`RID` font_rid, :ref:`int` char **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_is_allow_system_fallback` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_is_force_autohinter` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_is_language_supported` **(** :ref:`RID` font_rid, :ref:`String` language **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_is_multichannel_signed_distance_field` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_font_is_script_supported` **(** :ref:`RID` font_rid, :ref:`String` script **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_remove_glyph` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_remove_kerning` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_remove_language_support_override` **(** :ref:`RID` font_rid, :ref:`String` language **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_remove_script_support_override` **(** :ref:`RID` font_rid, :ref:`String` script **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_remove_size_cache` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_remove_texture` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_render_glyph` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` index **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_render_range` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` start, :ref:`int` end **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_allow_system_fallback` **(** :ref:`RID` font_rid, :ref:`bool` allow_system_fallback **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_antialiasing` **(** :ref:`RID` font_rid, :ref:`FontAntialiasing` antialiasing **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_ascent` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` ascent **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_baseline_offset` **(** :ref:`RID` font_rid, :ref:`float` baseline_offset **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_data` **(** :ref:`RID` font_rid, :ref:`PackedByteArray` data **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_data_ptr` **(** :ref:`RID` font_rid, const uint8_t* data_ptr, :ref:`int` data_size **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_descent` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` descent **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_embolden` **(** :ref:`RID` font_rid, :ref:`float` strength **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_face_index` **(** :ref:`RID` font_rid, :ref:`int` face_index **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_fixed_size` **(** :ref:`RID` font_rid, :ref:`int` fixed_size **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_fixed_size_scale_mode` **(** :ref:`RID` font_rid, :ref:`FixedSizeScaleMode` fixed_size_scale_mode **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_force_autohinter` **(** :ref:`RID` font_rid, :ref:`bool` force_autohinter **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_generate_mipmaps` **(** :ref:`RID` font_rid, :ref:`bool` generate_mipmaps **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_global_oversampling` **(** :ref:`float` oversampling **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_glyph_advance` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph, :ref:`Vector2` advance **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_glyph_offset` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Vector2` offset **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_glyph_size` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Vector2` gl_size **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_glyph_texture_idx` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`int` texture_idx **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_glyph_uv_rect` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Rect2` uv_rect **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_hinting` **(** :ref:`RID` font_rid, :ref:`Hinting` hinting **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_kerning` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair, :ref:`Vector2` kerning **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_language_support_override` **(** :ref:`RID` font_rid, :ref:`String` language, :ref:`bool` supported **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_msdf_pixel_range` **(** :ref:`RID` font_rid, :ref:`int` msdf_pixel_range **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_msdf_size` **(** :ref:`RID` font_rid, :ref:`int` msdf_size **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_multichannel_signed_distance_field` **(** :ref:`RID` font_rid, :ref:`bool` msdf **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_name` **(** :ref:`RID` font_rid, :ref:`String` name **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_opentype_feature_overrides` **(** :ref:`RID` font_rid, :ref:`Dictionary` overrides **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_oversampling` **(** :ref:`RID` font_rid, :ref:`float` oversampling **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_scale` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` scale **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_script_support_override` **(** :ref:`RID` font_rid, :ref:`String` script, :ref:`bool` supported **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_spacing` **(** :ref:`RID` font_rid, :ref:`SpacingType` spacing, :ref:`int` value **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_stretch` **(** :ref:`RID` font_rid, :ref:`int` stretch **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_style` **(** :ref:`RID` font_rid, |bitfield|\<:ref:`FontStyle`\> style **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_style_name` **(** :ref:`RID` font_rid, :ref:`String` name_style **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_subpixel_positioning` **(** :ref:`RID` font_rid, :ref:`SubpixelPositioning` subpixel_positioning **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_texture_image` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`Image` image **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_texture_offsets` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`PackedInt32Array` offset **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_transform` **(** :ref:`RID` font_rid, :ref:`Transform2D` transform **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_underline_position` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` underline_position **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_underline_thickness` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` underline_thickness **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_variation_coordinates` **(** :ref:`RID` font_rid, :ref:`Dictionary` variation_coordinates **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_font_set_weight` **(** :ref:`RID` font_rid, :ref:`int` weight **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_font_supported_feature_list` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_font_supported_variation_list` **(** :ref:`RID` font_rid **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_format_number` **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_free_rid` **(** :ref:`RID` rid **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_features` **(** **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_hex_code_box_size` **(** :ref:`int` size, :ref:`int` index **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_name` **(** **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_support_data_filename` **(** **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_support_data_info` **(** **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has` **(** :ref:`RID` rid **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_feature` **(** :ref:`Feature` feature **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_is_confusable` **(** :ref:`String` string, :ref:`PackedStringArray` dict **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_locale_right_to_left` **(** :ref:`String` locale **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_valid_identifier` **(** :ref:`String` string **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_load_support_data` **(** :ref:`String` filename **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_name_to_tag` **(** :ref:`String` name **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_parse_number` **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i[]` | :ref:`_parse_structured_text` **(** :ref:`StructuredTextParser` parser_type, :ref:`Array` args, :ref:`String` text **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_percent_sign` **(** :ref:`String` language **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_save_support_data` **(** :ref:`String` filename **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_get_span_count` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_shaped_get_span_meta` **(** :ref:`RID` shaped, :ref:`int` index **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shaped_set_span_update_font` **(** :ref:`RID` shaped, :ref:`int` index, :ref:`RID[]` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shaped_text_add_object` **(** :ref:`RID` shaped, :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align, :ref:`int` length, :ref:`float` baseline **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shaped_text_add_string` **(** :ref:`RID` shaped, :ref:`String` text, :ref:`RID[]` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features, :ref:`String` language, :ref:`Variant` meta **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shaped_text_clear` **(** :ref:`RID` shaped **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_closest_character_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shaped_text_draw` **(** :ref:`RID` shaped, :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`float` clip_l, :ref:`float` clip_r, :ref:`Color` color **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shaped_text_draw_outline` **(** :ref:`RID` shaped, :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`float` clip_l, :ref:`float` clip_r, :ref:`int` outline_size, :ref:`Color` color **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shaped_text_fit_to_width` **(** :ref:`RID` shaped, :ref:`float` width, |bitfield|\<:ref:`JustificationFlag`\> justification_flags **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shaped_text_get_ascent` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shaped_text_get_carets` **(** :ref:`RID` shaped, :ref:`int` position, CaretInfo* caret **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_shaped_text_get_character_breaks` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_get_custom_ellipsis` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_shaped_text_get_custom_punctuation` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shaped_text_get_descent` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Direction` | :ref:`_shaped_text_get_direction` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_get_dominant_direction_in_range` **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` end **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_get_ellipsis_glyph_count` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | const Glyph* | :ref:`_shaped_text_get_ellipsis_glyphs` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_get_ellipsis_pos` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_get_glyph_count` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | const Glyph* | :ref:`_shaped_text_get_glyphs` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_shaped_text_get_grapheme_bounds` **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Direction` | :ref:`_shaped_text_get_inferred_direction` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_shaped_text_get_line_breaks` **(** :ref:`RID` shaped, :ref:`float` width, :ref:`int` start, |bitfield|\<:ref:`LineBreakFlag`\> break_flags **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_shaped_text_get_line_breaks_adv` **(** :ref:`RID` shaped, :ref:`PackedFloat32Array` width, :ref:`int` start, :ref:`bool` once, |bitfield|\<:ref:`LineBreakFlag`\> break_flags **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`_shaped_text_get_object_rect` **(** :ref:`RID` shaped, :ref:`Variant` key **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`_shaped_text_get_objects` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Orientation` | :ref:`_shaped_text_get_orientation` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_shaped_text_get_parent` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shaped_text_get_preserve_control` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shaped_text_get_preserve_invalid` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`_shaped_text_get_range` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`_shaped_text_get_selection` **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` end **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_shaped_text_get_size` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_get_spacing` **(** :ref:`RID` shaped, :ref:`SpacingType` spacing **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_get_trim_pos` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shaped_text_get_underline_position` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shaped_text_get_underline_thickness` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shaped_text_get_width` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_shaped_text_get_word_breaks` **(** :ref:`RID` shaped, |bitfield|\<:ref:`GraphemeFlag`\> grapheme_flags **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_hit_test_grapheme` **(** :ref:`RID` shaped, :ref:`float` coord **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_hit_test_position` **(** :ref:`RID` shaped, :ref:`float` coord **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shaped_text_is_ready` **(** :ref:`RID` shaped **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_next_character_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_next_grapheme_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shaped_text_overrun_trim_to_width` **(** :ref:`RID` shaped, :ref:`float` width, |bitfield|\<:ref:`TextOverrunFlag`\> trim_flags **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_prev_character_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_shaped_text_prev_grapheme_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shaped_text_resize_object` **(** :ref:`RID` shaped, :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align, :ref:`float` baseline **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shaped_text_set_bidi_override` **(** :ref:`RID` shaped, :ref:`Array` override **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shaped_text_set_custom_ellipsis` **(** :ref:`RID` shaped, :ref:`int` char **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shaped_text_set_custom_punctuation` **(** :ref:`RID` shaped, :ref:`String` punct **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shaped_text_set_direction` **(** :ref:`RID` shaped, :ref:`Direction` direction **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shaped_text_set_orientation` **(** :ref:`RID` shaped, :ref:`Orientation` orientation **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shaped_text_set_preserve_control` **(** :ref:`RID` shaped, :ref:`bool` enabled **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shaped_text_set_preserve_invalid` **(** :ref:`RID` shaped, :ref:`bool` enabled **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_shaped_text_set_spacing` **(** :ref:`RID` shaped, :ref:`SpacingType` spacing, :ref:`int` value **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shaped_text_shape` **(** :ref:`RID` shaped **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | const Glyph* | :ref:`_shaped_text_sort_logical` **(** :ref:`RID` shaped **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`_shaped_text_substr` **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` length **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_shaped_text_tab_align` **(** :ref:`RID` shaped, :ref:`PackedFloat32Array` tab_stops **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shaped_text_update_breaks` **(** :ref:`RID` shaped **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_shaped_text_update_justification_ops` **(** :ref:`RID` shaped **)** |virtual| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_spoof_check` **(** :ref:`String` string **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_string_get_character_breaks` **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`_string_get_word_breaks` **(** :ref:`String` string, :ref:`String` language, :ref:`int` chars_per_line **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_string_to_lower` **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_string_to_upper` **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_strip_diacritics` **(** :ref:`String` string **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_tag_to_name` **(** :ref:`int` tag **)** |virtual| |const| | - +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_cleanup`\ (\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_create_font`\ (\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_create_font_linked_variation`\ (\ font_rid\: :ref:`RID`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_create_shaped_text`\ (\ direction\: :ref:`Direction`, orientation\: :ref:`Orientation`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_draw_hex_code_box`\ (\ canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_clear_glyphs`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_clear_kerning_map`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_clear_size_cache`\ (\ font_rid\: :ref:`RID`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_clear_textures`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_draw_glyph`\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_draw_glyph_outline`\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, outline_size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FontAntialiasing` | :ref:`_font_get_antialiasing`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_font_get_ascent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_font_get_baseline_offset`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_char_from_glyph_index`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_font_get_descent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_font_get_embolden`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_face_count`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_face_index`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_fixed_size`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FixedSizeScaleMode` | :ref:`_font_get_fixed_size_scale_mode`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_get_generate_mipmaps`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_font_get_global_oversampling`\ (\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_font_get_glyph_advance`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_font_get_glyph_contours`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_glyph_index`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_font_get_glyph_list`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_font_get_glyph_offset`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_font_get_glyph_size`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_glyph_texture_idx`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_font_get_glyph_texture_rid`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_font_get_glyph_texture_size`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`_font_get_glyph_uv_rect`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Hinting` | :ref:`_font_get_hinting`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_font_get_kerning`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`_font_get_kerning_list`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_get_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_font_get_language_support_overrides`\ (\ font_rid\: :ref:`RID`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_msdf_pixel_range`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_msdf_size`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_font_get_name`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_font_get_opentype_feature_overrides`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_font_get_ot_name_strings`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_font_get_oversampling`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_font_get_scale`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_get_script_support_override`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_font_get_script_support_overrides`\ (\ font_rid\: :ref:`RID`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`_font_get_size_cache_list`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_spacing`\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_stretch`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`FontStyle`\] | :ref:`_font_get_style`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_font_get_style_name`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SubpixelPositioning` | :ref:`_font_get_subpixel_positioning`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_font_get_supported_chars`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_texture_count`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`_font_get_texture_image`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_font_get_texture_offsets`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`_font_get_transform`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_font_get_underline_position`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_font_get_underline_thickness`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_font_get_variation_coordinates`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_font_get_weight`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_has_char`\ (\ font_rid\: :ref:`RID`, char\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_is_allow_system_fallback`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_is_force_autohinter`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_is_language_supported`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_is_multichannel_signed_distance_field`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_is_script_supported`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_remove_glyph`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_remove_kerning`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_remove_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_remove_script_support_override`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_remove_size_cache`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_remove_texture`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_render_glyph`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, index\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_render_range`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_allow_system_fallback`\ (\ font_rid\: :ref:`RID`, allow_system_fallback\: :ref:`bool`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_antialiasing`\ (\ font_rid\: :ref:`RID`, antialiasing\: :ref:`FontAntialiasing`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_ascent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, ascent\: :ref:`float`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_baseline_offset`\ (\ font_rid\: :ref:`RID`, baseline_offset\: :ref:`float`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_data`\ (\ font_rid\: :ref:`RID`, data\: :ref:`PackedByteArray`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_data_ptr`\ (\ font_rid\: :ref:`RID`, data_ptr\: ``const uint8_t*``, data_size\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_descent`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, descent\: :ref:`float`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_embolden`\ (\ font_rid\: :ref:`RID`, strength\: :ref:`float`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_face_index`\ (\ font_rid\: :ref:`RID`, face_index\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_fixed_size`\ (\ font_rid\: :ref:`RID`, fixed_size\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_fixed_size_scale_mode`\ (\ font_rid\: :ref:`RID`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_force_autohinter`\ (\ font_rid\: :ref:`RID`, force_autohinter\: :ref:`bool`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_generate_mipmaps`\ (\ font_rid\: :ref:`RID`, generate_mipmaps\: :ref:`bool`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_global_oversampling`\ (\ oversampling\: :ref:`float`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_glyph_advance`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_glyph_offset`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_glyph_size`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_glyph_texture_idx`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_glyph_uv_rect`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_hinting`\ (\ font_rid\: :ref:`RID`, hinting\: :ref:`Hinting`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_kerning`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`, kerning\: :ref:`Vector2`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`, supported\: :ref:`bool`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_msdf_pixel_range`\ (\ font_rid\: :ref:`RID`, msdf_pixel_range\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_msdf_size`\ (\ font_rid\: :ref:`RID`, msdf_size\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_multichannel_signed_distance_field`\ (\ font_rid\: :ref:`RID`, msdf\: :ref:`bool`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_name`\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_opentype_feature_overrides`\ (\ font_rid\: :ref:`RID`, overrides\: :ref:`Dictionary`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_oversampling`\ (\ font_rid\: :ref:`RID`, oversampling\: :ref:`float`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_scale`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, scale\: :ref:`float`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_script_support_override`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`, supported\: :ref:`bool`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_spacing`\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_stretch`\ (\ font_rid\: :ref:`RID`, stretch\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_style`\ (\ font_rid\: :ref:`RID`, style\: |bitfield|\[:ref:`FontStyle`\]\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_style_name`\ (\ font_rid\: :ref:`RID`, name_style\: :ref:`String`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_subpixel_positioning`\ (\ font_rid\: :ref:`RID`, subpixel_positioning\: :ref:`SubpixelPositioning`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_texture_image`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_texture_offsets`\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, offset\: :ref:`PackedInt32Array`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_transform`\ (\ font_rid\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_underline_position`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_underline_thickness`\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_variation_coordinates`\ (\ font_rid\: :ref:`RID`, variation_coordinates\: :ref:`Dictionary`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_weight`\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_font_supported_feature_list`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_font_supported_variation_list`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_format_number`\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_free_rid`\ (\ rid\: :ref:`RID`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_features`\ (\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_hex_code_box_size`\ (\ size\: :ref:`int`, index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_name`\ (\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_support_data_filename`\ (\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_support_data_info`\ (\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has`\ (\ rid\: :ref:`RID`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_feature`\ (\ feature\: :ref:`Feature`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_is_confusable`\ (\ string\: :ref:`String`, dict\: :ref:`PackedStringArray`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_locale_right_to_left`\ (\ locale\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_valid_identifier`\ (\ string\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_load_support_data`\ (\ filename\: :ref:`String`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_name_to_tag`\ (\ name\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_parse_number`\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector3i`\] | :ref:`_parse_structured_text`\ (\ parser_type\: :ref:`StructuredTextParser`, args\: :ref:`Array`, text\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_percent_sign`\ (\ language\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_save_support_data`\ (\ filename\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_get_span_count`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_shaped_get_span_meta`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_set_span_update_font`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shaped_text_add_object`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, length\: :ref:`int`, baseline\: :ref:`float`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shaped_text_add_string`\ (\ shaped\: :ref:`RID`, text\: :ref:`String`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`, language\: :ref:`String`, meta\: :ref:`Variant`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_clear`\ (\ shaped\: :ref:`RID`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_closest_character_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_draw`\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float`, clip_r\: :ref:`float`, color\: :ref:`Color`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_draw_outline`\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float`, clip_r\: :ref:`float`, outline_size\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shaped_text_fit_to_width`\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\]\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shaped_text_get_ascent`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_get_carets`\ (\ shaped\: :ref:`RID`, position\: :ref:`int`, caret\: ``CaretInfo*``\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_shaped_text_get_character_breaks`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_get_custom_ellipsis`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_shaped_text_get_custom_punctuation`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shaped_text_get_descent`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Direction` | :ref:`_shaped_text_get_direction`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_get_dominant_direction_in_range`\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_get_ellipsis_glyph_count`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ``const Glyph*`` | :ref:`_shaped_text_get_ellipsis_glyphs`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_get_ellipsis_pos`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_get_glyph_count`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ``const Glyph*`` | :ref:`_shaped_text_get_glyphs`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_shaped_text_get_grapheme_bounds`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Direction` | :ref:`_shaped_text_get_inferred_direction`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_shaped_text_get_line_breaks`\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, start\: :ref:`int`, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_shaped_text_get_line_breaks_adv`\ (\ shaped\: :ref:`RID`, width\: :ref:`PackedFloat32Array`, start\: :ref:`int`, once\: :ref:`bool`, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`_shaped_text_get_object_rect`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`_shaped_text_get_objects`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Orientation` | :ref:`_shaped_text_get_orientation`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_shaped_text_get_parent`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shaped_text_get_preserve_control`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shaped_text_get_preserve_invalid`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`_shaped_text_get_range`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`_shaped_text_get_selection`\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_shaped_text_get_size`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_get_spacing`\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_get_trim_pos`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shaped_text_get_underline_position`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shaped_text_get_underline_thickness`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shaped_text_get_width`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_shaped_text_get_word_breaks`\ (\ shaped\: :ref:`RID`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\]\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_hit_test_grapheme`\ (\ shaped\: :ref:`RID`, coord\: :ref:`float`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_hit_test_position`\ (\ shaped\: :ref:`RID`, coord\: :ref:`float`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shaped_text_is_ready`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_next_character_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_next_grapheme_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_overrun_trim_to_width`\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, trim_flags\: |bitfield|\[:ref:`TextOverrunFlag`\]\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_prev_character_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_prev_grapheme_pos`\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shaped_text_resize_object`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, baseline\: :ref:`float`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_set_bidi_override`\ (\ shaped\: :ref:`RID`, override\: :ref:`Array`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_set_custom_ellipsis`\ (\ shaped\: :ref:`RID`, char\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_set_custom_punctuation`\ (\ shaped\: :ref:`RID`, punct\: :ref:`String`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_set_direction`\ (\ shaped\: :ref:`RID`, direction\: :ref:`Direction`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_set_orientation`\ (\ shaped\: :ref:`RID`, orientation\: :ref:`Orientation`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_set_preserve_control`\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_set_preserve_invalid`\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_shaped_text_set_spacing`\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shaped_text_shape`\ (\ shaped\: :ref:`RID`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ``const Glyph*`` | :ref:`_shaped_text_sort_logical`\ (\ shaped\: :ref:`RID`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_shaped_text_substr`\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, length\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_shaped_text_tab_align`\ (\ shaped\: :ref:`RID`, tab_stops\: :ref:`PackedFloat32Array`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shaped_text_update_breaks`\ (\ shaped\: :ref:`RID`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_shaped_text_update_justification_ops`\ (\ shaped\: :ref:`RID`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_spoof_check`\ (\ string\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_string_get_character_breaks`\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_string_get_word_breaks`\ (\ string\: :ref:`String`, language\: :ref:`String`, chars_per_line\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_string_to_lower`\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_string_to_upper`\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_strip_diacritics`\ (\ string\: :ref:`String`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_tag_to_name`\ (\ tag\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -466,7 +466,7 @@ Method Descriptions .. rst-class:: classref-method -void **_cleanup** **(** **)** |virtual| +|void| **_cleanup**\ (\ ) |virtual| .. container:: contribute @@ -480,7 +480,7 @@ void **_cleanup** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_create_font** **(** **)** |virtual| +:ref:`RID` **_create_font**\ (\ ) |virtual| .. container:: contribute @@ -494,7 +494,7 @@ void **_cleanup** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_create_font_linked_variation** **(** :ref:`RID` font_rid **)** |virtual| +:ref:`RID` **_create_font_linked_variation**\ (\ font_rid\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -508,7 +508,7 @@ void **_cleanup** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`RID` **_create_shaped_text** **(** :ref:`Direction` direction, :ref:`Orientation` orientation **)** |virtual| +:ref:`RID` **_create_shaped_text**\ (\ direction\: :ref:`Direction`, orientation\: :ref:`Orientation`\ ) |virtual| .. container:: contribute @@ -522,7 +522,7 @@ void **_cleanup** **(** **)** |virtual| .. rst-class:: classref-method -void **_draw_hex_code_box** **(** :ref:`RID` canvas, :ref:`int` size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color **)** |virtual| |const| +|void| **_draw_hex_code_box**\ (\ canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| .. container:: contribute @@ -536,7 +536,7 @@ void **_draw_hex_code_box** **(** :ref:`RID` canvas, :ref:`int` font_rid, :ref:`Vector2i` size **)** |virtual| +|void| **_font_clear_glyphs**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| .. container:: contribute @@ -550,7 +550,7 @@ void **_font_clear_glyphs** **(** :ref:`RID` font_rid, :ref:`Vector2i .. rst-class:: classref-method -void **_font_clear_kerning_map** **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| +|void| **_font_clear_kerning_map**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -564,7 +564,7 @@ void **_font_clear_kerning_map** **(** :ref:`RID` font_rid, :ref:`int .. rst-class:: classref-method -void **_font_clear_size_cache** **(** :ref:`RID` font_rid **)** |virtual| +|void| **_font_clear_size_cache**\ (\ font_rid\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -578,7 +578,7 @@ void **_font_clear_size_cache** **(** :ref:`RID` font_rid **)** |virt .. rst-class:: classref-method -void **_font_clear_textures** **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| +|void| **_font_clear_textures**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| .. container:: contribute @@ -592,7 +592,7 @@ void **_font_clear_textures** **(** :ref:`RID` font_rid, :ref:`Vector .. rst-class:: classref-method -void **_font_draw_glyph** **(** :ref:`RID` font_rid, :ref:`RID` canvas, :ref:`int` size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color **)** |virtual| |const| +|void| **_font_draw_glyph**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| .. container:: contribute @@ -606,7 +606,7 @@ void **_font_draw_glyph** **(** :ref:`RID` font_rid, :ref:`RID` font_rid, :ref:`RID` canvas, :ref:`int` size, :ref:`int` outline_size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color **)** |virtual| |const| +|void| **_font_draw_glyph_outline**\ (\ font_rid\: :ref:`RID`, canvas\: :ref:`RID`, size\: :ref:`int`, outline_size\: :ref:`int`, pos\: :ref:`Vector2`, index\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| .. container:: contribute @@ -620,7 +620,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`FontAntialiasing` **_font_get_antialiasing** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`FontAntialiasing` **_font_get_antialiasing**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -634,7 +634,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`float` **_font_get_ascent** **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| +:ref:`float` **_font_get_ascent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -648,7 +648,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`float` **_font_get_baseline_offset** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`float` **_font_get_baseline_offset**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -662,7 +662,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`int` **_font_get_char_from_glyph_index** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph_index **)** |virtual| |const| +:ref:`int` **_font_get_char_from_glyph_index**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_index\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -676,7 +676,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`float` **_font_get_descent** **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| +:ref:`float` **_font_get_descent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -690,7 +690,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`float` **_font_get_embolden** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`float` **_font_get_embolden**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -704,7 +704,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`int` **_font_get_face_count** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`int` **_font_get_face_count**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -718,7 +718,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`int` **_font_get_face_index** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`int` **_font_get_face_index**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -732,7 +732,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`int` **_font_get_fixed_size** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`int` **_font_get_fixed_size**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -746,7 +746,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`FixedSizeScaleMode` **_font_get_fixed_size_scale_mode** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`FixedSizeScaleMode` **_font_get_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -760,7 +760,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`bool` **_font_get_generate_mipmaps** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`bool` **_font_get_generate_mipmaps**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -774,7 +774,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`float` **_font_get_global_oversampling** **(** **)** |virtual| |const| +:ref:`float` **_font_get_global_oversampling**\ (\ ) |virtual| |const| .. container:: contribute @@ -788,7 +788,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`Vector2` **_font_get_glyph_advance** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph **)** |virtual| |const| +:ref:`Vector2` **_font_get_glyph_advance**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -802,7 +802,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`Dictionary` **_font_get_glyph_contours** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` index **)** |virtual| |const| +:ref:`Dictionary` **_font_get_glyph_contours**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, index\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -816,7 +816,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`int` **_font_get_glyph_index** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` char, :ref:`int` variation_selector **)** |virtual| |const| +:ref:`int` **_font_get_glyph_index**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, char\: :ref:`int`, variation_selector\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -830,7 +830,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`PackedInt32Array` **_font_get_glyph_list** **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| |const| +:ref:`PackedInt32Array` **_font_get_glyph_list**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |const| .. container:: contribute @@ -844,7 +844,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`Vector2` **_font_get_glyph_offset** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| +:ref:`Vector2` **_font_get_glyph_offset**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -858,7 +858,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`Vector2` **_font_get_glyph_size** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| +:ref:`Vector2` **_font_get_glyph_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -872,7 +872,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`int` **_font_get_glyph_texture_idx** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| +:ref:`int` **_font_get_glyph_texture_idx**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -886,7 +886,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`RID` **_font_get_glyph_texture_rid** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| +:ref:`RID` **_font_get_glyph_texture_rid**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -900,7 +900,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`Vector2` **_font_get_glyph_texture_size** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| +:ref:`Vector2` **_font_get_glyph_texture_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -914,7 +914,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`Rect2` **_font_get_glyph_uv_rect** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| +:ref:`Rect2` **_font_get_glyph_uv_rect**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -928,7 +928,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`Hinting` **_font_get_hinting** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`Hinting` **_font_get_hinting**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -942,7 +942,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`Vector2` **_font_get_kerning** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair **)** |virtual| |const| +:ref:`Vector2` **_font_get_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |virtual| |const| .. container:: contribute @@ -956,7 +956,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`Vector2i[]` **_font_get_kerning_list** **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| +:ref:`Array`\[:ref:`Vector2i`\] **_font_get_kerning_list**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -970,7 +970,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`bool` **_font_get_language_support_override** **(** :ref:`RID` font_rid, :ref:`String` language **)** |virtual| +:ref:`bool` **_font_get_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| .. container:: contribute @@ -984,7 +984,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`PackedStringArray` **_font_get_language_support_overrides** **(** :ref:`RID` font_rid **)** |virtual| +:ref:`PackedStringArray` **_font_get_language_support_overrides**\ (\ font_rid\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -998,7 +998,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`int` **_font_get_msdf_pixel_range** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`int` **_font_get_msdf_pixel_range**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1012,7 +1012,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`int` **_font_get_msdf_size** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`int` **_font_get_msdf_size**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1026,7 +1026,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`String` **_font_get_name** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`String` **_font_get_name**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1040,7 +1040,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`Dictionary` **_font_get_opentype_feature_overrides** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`Dictionary` **_font_get_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1054,7 +1054,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`Dictionary` **_font_get_ot_name_strings** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`Dictionary` **_font_get_ot_name_strings**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1068,7 +1068,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`float` **_font_get_oversampling** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`float` **_font_get_oversampling**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1082,7 +1082,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`float` **_font_get_scale** **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| +:ref:`float` **_font_get_scale**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -1096,7 +1096,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`bool` **_font_get_script_support_override** **(** :ref:`RID` font_rid, :ref:`String` script **)** |virtual| +:ref:`bool` **_font_get_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| .. container:: contribute @@ -1110,7 +1110,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`PackedStringArray` **_font_get_script_support_overrides** **(** :ref:`RID` font_rid **)** |virtual| +:ref:`PackedStringArray` **_font_get_script_support_overrides**\ (\ font_rid\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -1124,7 +1124,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`Vector2i[]` **_font_get_size_cache_list** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`Array`\[:ref:`Vector2i`\] **_font_get_size_cache_list**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1138,7 +1138,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`int` **_font_get_spacing** **(** :ref:`RID` font_rid, :ref:`SpacingType` spacing **)** |virtual| |const| +:ref:`int` **_font_get_spacing**\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |virtual| |const| .. container:: contribute @@ -1152,7 +1152,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`int` **_font_get_stretch** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`int` **_font_get_stretch**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1166,7 +1166,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -|bitfield|\<:ref:`FontStyle`\> **_font_get_style** **(** :ref:`RID` font_rid **)** |virtual| |const| +|bitfield|\[:ref:`FontStyle`\] **_font_get_style**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1180,7 +1180,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`String` **_font_get_style_name** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`String` **_font_get_style_name**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1194,7 +1194,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`SubpixelPositioning` **_font_get_subpixel_positioning** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`SubpixelPositioning` **_font_get_subpixel_positioning**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1208,7 +1208,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`String` **_font_get_supported_chars** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`String` **_font_get_supported_chars**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1222,7 +1222,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`int` **_font_get_texture_count** **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| |const| +:ref:`int` **_font_get_texture_count**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| |const| .. container:: contribute @@ -1236,7 +1236,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`Image` **_font_get_texture_image** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |virtual| |const| +:ref:`Image` **_font_get_texture_image**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -1250,7 +1250,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`PackedInt32Array` **_font_get_texture_offsets** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |virtual| |const| +:ref:`PackedInt32Array` **_font_get_texture_offsets**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -1264,7 +1264,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`Transform2D` **_font_get_transform** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`Transform2D` **_font_get_transform**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1278,7 +1278,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`float` **_font_get_underline_position** **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| +:ref:`float` **_font_get_underline_position**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -1292,7 +1292,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`float` **_font_get_underline_thickness** **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| +:ref:`float` **_font_get_underline_thickness**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -1306,7 +1306,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`Dictionary` **_font_get_variation_coordinates** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`Dictionary` **_font_get_variation_coordinates**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1320,7 +1320,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`int` **_font_get_weight** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`int` **_font_get_weight**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1334,7 +1334,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`bool` **_font_has_char** **(** :ref:`RID` font_rid, :ref:`int` char **)** |virtual| |const| +:ref:`bool` **_font_has_char**\ (\ font_rid\: :ref:`RID`, char\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -1348,7 +1348,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`bool` **_font_is_allow_system_fallback** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`bool` **_font_is_allow_system_fallback**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1362,7 +1362,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`bool` **_font_is_force_autohinter** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`bool` **_font_is_force_autohinter**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1376,7 +1376,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`bool` **_font_is_language_supported** **(** :ref:`RID` font_rid, :ref:`String` language **)** |virtual| |const| +:ref:`bool` **_font_is_language_supported**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -1390,7 +1390,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`bool` **_font_is_multichannel_signed_distance_field** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`bool` **_font_is_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -1404,7 +1404,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -:ref:`bool` **_font_is_script_supported** **(** :ref:`RID` font_rid, :ref:`String` script **)** |virtual| |const| +:ref:`bool` **_font_is_script_supported**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -1418,7 +1418,7 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI .. rst-class:: classref-method -void **_font_remove_glyph** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| +|void| **_font_remove_glyph**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1432,7 +1432,7 @@ void **_font_remove_glyph** **(** :ref:`RID` font_rid, :ref:`Vector2i .. rst-class:: classref-method -void **_font_remove_kerning** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair **)** |virtual| +|void| **_font_remove_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`\ ) |virtual| .. container:: contribute @@ -1446,7 +1446,7 @@ void **_font_remove_kerning** **(** :ref:`RID` font_rid, :ref:`int` font_rid, :ref:`String` language **)** |virtual| +|void| **_font_remove_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| .. container:: contribute @@ -1460,7 +1460,7 @@ void **_font_remove_language_support_override** **(** :ref:`RID` font .. rst-class:: classref-method -void **_font_remove_script_support_override** **(** :ref:`RID` font_rid, :ref:`String` script **)** |virtual| +|void| **_font_remove_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| .. container:: contribute @@ -1474,7 +1474,7 @@ void **_font_remove_script_support_override** **(** :ref:`RID` font_r .. rst-class:: classref-method -void **_font_remove_size_cache** **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| +|void| **_font_remove_size_cache**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`\ ) |virtual| .. container:: contribute @@ -1488,7 +1488,7 @@ void **_font_remove_size_cache** **(** :ref:`RID` font_rid, :ref:`Vec .. rst-class:: classref-method -void **_font_remove_texture** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |virtual| +|void| **_font_remove_texture**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1502,7 +1502,7 @@ void **_font_remove_texture** **(** :ref:`RID` font_rid, :ref:`Vector .. rst-class:: classref-method -void **_font_render_glyph** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` index **)** |virtual| +|void| **_font_render_glyph**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, index\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1516,7 +1516,7 @@ void **_font_render_glyph** **(** :ref:`RID` font_rid, :ref:`Vector2i .. rst-class:: classref-method -void **_font_render_range** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` start, :ref:`int` end **)** |virtual| +|void| **_font_render_range**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1530,7 +1530,7 @@ void **_font_render_range** **(** :ref:`RID` font_rid, :ref:`Vector2i .. rst-class:: classref-method -void **_font_set_allow_system_fallback** **(** :ref:`RID` font_rid, :ref:`bool` allow_system_fallback **)** |virtual| +|void| **_font_set_allow_system_fallback**\ (\ font_rid\: :ref:`RID`, allow_system_fallback\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1544,7 +1544,7 @@ void **_font_set_allow_system_fallback** **(** :ref:`RID` font_rid, : .. rst-class:: classref-method -void **_font_set_antialiasing** **(** :ref:`RID` font_rid, :ref:`FontAntialiasing` antialiasing **)** |virtual| +|void| **_font_set_antialiasing**\ (\ font_rid\: :ref:`RID`, antialiasing\: :ref:`FontAntialiasing`\ ) |virtual| .. container:: contribute @@ -1558,7 +1558,7 @@ void **_font_set_antialiasing** **(** :ref:`RID` font_rid, :ref:`Font .. rst-class:: classref-method -void **_font_set_ascent** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` ascent **)** |virtual| +|void| **_font_set_ascent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, ascent\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1572,7 +1572,7 @@ void **_font_set_ascent** **(** :ref:`RID` font_rid, :ref:`int` font_rid, :ref:`float` baseline_offset **)** |virtual| +|void| **_font_set_baseline_offset**\ (\ font_rid\: :ref:`RID`, baseline_offset\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1586,7 +1586,7 @@ void **_font_set_baseline_offset** **(** :ref:`RID` font_rid, :ref:`f .. rst-class:: classref-method -void **_font_set_data** **(** :ref:`RID` font_rid, :ref:`PackedByteArray` data **)** |virtual| +|void| **_font_set_data**\ (\ font_rid\: :ref:`RID`, data\: :ref:`PackedByteArray`\ ) |virtual| .. container:: contribute @@ -1600,7 +1600,7 @@ void **_font_set_data** **(** :ref:`RID` font_rid, :ref:`PackedByteAr .. rst-class:: classref-method -void **_font_set_data_ptr** **(** :ref:`RID` font_rid, const uint8_t* data_ptr, :ref:`int` data_size **)** |virtual| +|void| **_font_set_data_ptr**\ (\ font_rid\: :ref:`RID`, data_ptr\: ``const uint8_t*``, data_size\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1614,7 +1614,7 @@ void **_font_set_data_ptr** **(** :ref:`RID` font_rid, const uint8_t* .. rst-class:: classref-method -void **_font_set_descent** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` descent **)** |virtual| +|void| **_font_set_descent**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, descent\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1628,7 +1628,7 @@ void **_font_set_descent** **(** :ref:`RID` font_rid, :ref:`int` font_rid, :ref:`float` strength **)** |virtual| +|void| **_font_set_embolden**\ (\ font_rid\: :ref:`RID`, strength\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1642,7 +1642,7 @@ void **_font_set_embolden** **(** :ref:`RID` font_rid, :ref:`float` font_rid, :ref:`int` face_index **)** |virtual| +|void| **_font_set_face_index**\ (\ font_rid\: :ref:`RID`, face_index\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1656,7 +1656,7 @@ void **_font_set_face_index** **(** :ref:`RID` font_rid, :ref:`int` font_rid, :ref:`int` fixed_size **)** |virtual| +|void| **_font_set_fixed_size**\ (\ font_rid\: :ref:`RID`, fixed_size\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1670,7 +1670,7 @@ void **_font_set_fixed_size** **(** :ref:`RID` font_rid, :ref:`int` font_rid, :ref:`FixedSizeScaleMode` fixed_size_scale_mode **)** |virtual| +|void| **_font_set_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode`\ ) |virtual| .. container:: contribute @@ -1684,7 +1684,7 @@ void **_font_set_fixed_size_scale_mode** **(** :ref:`RID` font_rid, : .. rst-class:: classref-method -void **_font_set_force_autohinter** **(** :ref:`RID` font_rid, :ref:`bool` force_autohinter **)** |virtual| +|void| **_font_set_force_autohinter**\ (\ font_rid\: :ref:`RID`, force_autohinter\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1698,7 +1698,7 @@ void **_font_set_force_autohinter** **(** :ref:`RID` font_rid, :ref:` .. rst-class:: classref-method -void **_font_set_generate_mipmaps** **(** :ref:`RID` font_rid, :ref:`bool` generate_mipmaps **)** |virtual| +|void| **_font_set_generate_mipmaps**\ (\ font_rid\: :ref:`RID`, generate_mipmaps\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1712,7 +1712,7 @@ void **_font_set_generate_mipmaps** **(** :ref:`RID` font_rid, :ref:` .. rst-class:: classref-method -void **_font_set_global_oversampling** **(** :ref:`float` oversampling **)** |virtual| +|void| **_font_set_global_oversampling**\ (\ oversampling\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1726,7 +1726,7 @@ void **_font_set_global_oversampling** **(** :ref:`float` oversampl .. rst-class:: classref-method -void **_font_set_glyph_advance** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph, :ref:`Vector2` advance **)** |virtual| +|void| **_font_set_glyph_advance**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph\: :ref:`int`, advance\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -1740,7 +1740,7 @@ void **_font_set_glyph_advance** **(** :ref:`RID` font_rid, :ref:`int .. rst-class:: classref-method -void **_font_set_glyph_offset** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Vector2` offset **)** |virtual| +|void| **_font_set_glyph_offset**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, offset\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -1754,7 +1754,7 @@ void **_font_set_glyph_offset** **(** :ref:`RID` font_rid, :ref:`Vect .. rst-class:: classref-method -void **_font_set_glyph_size** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Vector2` gl_size **)** |virtual| +|void| **_font_set_glyph_size**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, gl_size\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -1768,7 +1768,7 @@ void **_font_set_glyph_size** **(** :ref:`RID` font_rid, :ref:`Vector .. rst-class:: classref-method -void **_font_set_glyph_texture_idx** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`int` texture_idx **)** |virtual| +|void| **_font_set_glyph_texture_idx**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, texture_idx\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1782,7 +1782,7 @@ void **_font_set_glyph_texture_idx** **(** :ref:`RID` font_rid, :ref: .. rst-class:: classref-method -void **_font_set_glyph_uv_rect** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Rect2` uv_rect **)** |virtual| +|void| **_font_set_glyph_uv_rect**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, glyph\: :ref:`int`, uv_rect\: :ref:`Rect2`\ ) |virtual| .. container:: contribute @@ -1796,7 +1796,7 @@ void **_font_set_glyph_uv_rect** **(** :ref:`RID` font_rid, :ref:`Vec .. rst-class:: classref-method -void **_font_set_hinting** **(** :ref:`RID` font_rid, :ref:`Hinting` hinting **)** |virtual| +|void| **_font_set_hinting**\ (\ font_rid\: :ref:`RID`, hinting\: :ref:`Hinting`\ ) |virtual| .. container:: contribute @@ -1810,7 +1810,7 @@ void **_font_set_hinting** **(** :ref:`RID` font_rid, :ref:`Hinting` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair, :ref:`Vector2` kerning **)** |virtual| +|void| **_font_set_kerning**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, glyph_pair\: :ref:`Vector2i`, kerning\: :ref:`Vector2`\ ) |virtual| .. container:: contribute @@ -1824,7 +1824,7 @@ void **_font_set_kerning** **(** :ref:`RID` font_rid, :ref:`int` font_rid, :ref:`String` language, :ref:`bool` supported **)** |virtual| +|void| **_font_set_language_support_override**\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`, supported\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1838,7 +1838,7 @@ void **_font_set_language_support_override** **(** :ref:`RID` font_ri .. rst-class:: classref-method -void **_font_set_msdf_pixel_range** **(** :ref:`RID` font_rid, :ref:`int` msdf_pixel_range **)** |virtual| +|void| **_font_set_msdf_pixel_range**\ (\ font_rid\: :ref:`RID`, msdf_pixel_range\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1852,7 +1852,7 @@ void **_font_set_msdf_pixel_range** **(** :ref:`RID` font_rid, :ref:` .. rst-class:: classref-method -void **_font_set_msdf_size** **(** :ref:`RID` font_rid, :ref:`int` msdf_size **)** |virtual| +|void| **_font_set_msdf_size**\ (\ font_rid\: :ref:`RID`, msdf_size\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1866,7 +1866,7 @@ void **_font_set_msdf_size** **(** :ref:`RID` font_rid, :ref:`int` font_rid, :ref:`bool` msdf **)** |virtual| +|void| **_font_set_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID`, msdf\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1880,7 +1880,7 @@ void **_font_set_multichannel_signed_distance_field** **(** :ref:`RID .. rst-class:: classref-method -void **_font_set_name** **(** :ref:`RID` font_rid, :ref:`String` name **)** |virtual| +|void| **_font_set_name**\ (\ font_rid\: :ref:`RID`, name\: :ref:`String`\ ) |virtual| .. container:: contribute @@ -1894,7 +1894,7 @@ void **_font_set_name** **(** :ref:`RID` font_rid, :ref:`String` font_rid, :ref:`Dictionary` overrides **)** |virtual| +|void| **_font_set_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID`, overrides\: :ref:`Dictionary`\ ) |virtual| .. container:: contribute @@ -1908,7 +1908,7 @@ void **_font_set_opentype_feature_overrides** **(** :ref:`RID` font_r .. rst-class:: classref-method -void **_font_set_oversampling** **(** :ref:`RID` font_rid, :ref:`float` oversampling **)** |virtual| +|void| **_font_set_oversampling**\ (\ font_rid\: :ref:`RID`, oversampling\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1922,7 +1922,7 @@ void **_font_set_oversampling** **(** :ref:`RID` font_rid, :ref:`floa .. rst-class:: classref-method -void **_font_set_scale** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` scale **)** |virtual| +|void| **_font_set_scale**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, scale\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -1936,7 +1936,7 @@ void **_font_set_scale** **(** :ref:`RID` font_rid, :ref:`int` font_rid, :ref:`String` script, :ref:`bool` supported **)** |virtual| +|void| **_font_set_script_support_override**\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`, supported\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -1950,7 +1950,7 @@ void **_font_set_script_support_override** **(** :ref:`RID` font_rid, .. rst-class:: classref-method -void **_font_set_spacing** **(** :ref:`RID` font_rid, :ref:`SpacingType` spacing, :ref:`int` value **)** |virtual| +|void| **_font_set_spacing**\ (\ font_rid\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1964,7 +1964,7 @@ void **_font_set_spacing** **(** :ref:`RID` font_rid, :ref:`SpacingTy .. rst-class:: classref-method -void **_font_set_stretch** **(** :ref:`RID` font_rid, :ref:`int` stretch **)** |virtual| +|void| **_font_set_stretch**\ (\ font_rid\: :ref:`RID`, stretch\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -1978,7 +1978,7 @@ void **_font_set_stretch** **(** :ref:`RID` font_rid, :ref:`int` font_rid, |bitfield|\<:ref:`FontStyle`\> style **)** |virtual| +|void| **_font_set_style**\ (\ font_rid\: :ref:`RID`, style\: |bitfield|\[:ref:`FontStyle`\]\ ) |virtual| .. container:: contribute @@ -1992,7 +1992,7 @@ void **_font_set_style** **(** :ref:`RID` font_rid, |bitfield|\<:ref: .. rst-class:: classref-method -void **_font_set_style_name** **(** :ref:`RID` font_rid, :ref:`String` name_style **)** |virtual| +|void| **_font_set_style_name**\ (\ font_rid\: :ref:`RID`, name_style\: :ref:`String`\ ) |virtual| .. container:: contribute @@ -2006,7 +2006,7 @@ void **_font_set_style_name** **(** :ref:`RID` font_rid, :ref:`String .. rst-class:: classref-method -void **_font_set_subpixel_positioning** **(** :ref:`RID` font_rid, :ref:`SubpixelPositioning` subpixel_positioning **)** |virtual| +|void| **_font_set_subpixel_positioning**\ (\ font_rid\: :ref:`RID`, subpixel_positioning\: :ref:`SubpixelPositioning`\ ) |virtual| .. container:: contribute @@ -2020,7 +2020,7 @@ void **_font_set_subpixel_positioning** **(** :ref:`RID` font_rid, :r .. rst-class:: classref-method -void **_font_set_texture_image** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`Image` image **)** |virtual| +|void| **_font_set_texture_image**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, image\: :ref:`Image`\ ) |virtual| .. container:: contribute @@ -2034,7 +2034,7 @@ void **_font_set_texture_image** **(** :ref:`RID` font_rid, :ref:`Vec .. rst-class:: classref-method -void **_font_set_texture_offsets** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`PackedInt32Array` offset **)** |virtual| +|void| **_font_set_texture_offsets**\ (\ font_rid\: :ref:`RID`, size\: :ref:`Vector2i`, texture_index\: :ref:`int`, offset\: :ref:`PackedInt32Array`\ ) |virtual| .. container:: contribute @@ -2048,7 +2048,7 @@ void **_font_set_texture_offsets** **(** :ref:`RID` font_rid, :ref:`V .. rst-class:: classref-method -void **_font_set_transform** **(** :ref:`RID` font_rid, :ref:`Transform2D` transform **)** |virtual| +|void| **_font_set_transform**\ (\ font_rid\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) |virtual| .. container:: contribute @@ -2062,7 +2062,7 @@ void **_font_set_transform** **(** :ref:`RID` font_rid, :ref:`Transfo .. rst-class:: classref-method -void **_font_set_underline_position** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` underline_position **)** |virtual| +|void| **_font_set_underline_position**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_position\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -2076,7 +2076,7 @@ void **_font_set_underline_position** **(** :ref:`RID` font_rid, :ref .. rst-class:: classref-method -void **_font_set_underline_thickness** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` underline_thickness **)** |virtual| +|void| **_font_set_underline_thickness**\ (\ font_rid\: :ref:`RID`, size\: :ref:`int`, underline_thickness\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -2090,7 +2090,7 @@ void **_font_set_underline_thickness** **(** :ref:`RID` font_rid, :re .. rst-class:: classref-method -void **_font_set_variation_coordinates** **(** :ref:`RID` font_rid, :ref:`Dictionary` variation_coordinates **)** |virtual| +|void| **_font_set_variation_coordinates**\ (\ font_rid\: :ref:`RID`, variation_coordinates\: :ref:`Dictionary`\ ) |virtual| .. container:: contribute @@ -2104,7 +2104,7 @@ void **_font_set_variation_coordinates** **(** :ref:`RID` font_rid, : .. rst-class:: classref-method -void **_font_set_weight** **(** :ref:`RID` font_rid, :ref:`int` weight **)** |virtual| +|void| **_font_set_weight**\ (\ font_rid\: :ref:`RID`, weight\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -2118,7 +2118,7 @@ void **_font_set_weight** **(** :ref:`RID` font_rid, :ref:`int` **_font_supported_feature_list** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`Dictionary` **_font_supported_feature_list**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2132,7 +2132,7 @@ void **_font_set_weight** **(** :ref:`RID` font_rid, :ref:`int` **_font_supported_variation_list** **(** :ref:`RID` font_rid **)** |virtual| |const| +:ref:`Dictionary` **_font_supported_variation_list**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2146,7 +2146,7 @@ void **_font_set_weight** **(** :ref:`RID` font_rid, :ref:`int` **_format_number** **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| +:ref:`String` **_format_number**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -2160,7 +2160,7 @@ void **_font_set_weight** **(** :ref:`RID` font_rid, :ref:`int` rid **)** |virtual| +|void| **_free_rid**\ (\ rid\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -2174,7 +2174,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_get_features** **(** **)** |virtual| |const| +:ref:`int` **_get_features**\ (\ ) |virtual| |const| .. container:: contribute @@ -2188,7 +2188,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`Vector2` **_get_hex_code_box_size** **(** :ref:`int` size, :ref:`int` index **)** |virtual| |const| +:ref:`Vector2` **_get_hex_code_box_size**\ (\ size\: :ref:`int`, index\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -2202,7 +2202,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`String` **_get_name** **(** **)** |virtual| |const| +:ref:`String` **_get_name**\ (\ ) |virtual| |const| .. container:: contribute @@ -2216,7 +2216,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`String` **_get_support_data_filename** **(** **)** |virtual| |const| +:ref:`String` **_get_support_data_filename**\ (\ ) |virtual| |const| .. container:: contribute @@ -2230,7 +2230,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`String` **_get_support_data_info** **(** **)** |virtual| |const| +:ref:`String` **_get_support_data_info**\ (\ ) |virtual| |const| .. container:: contribute @@ -2244,7 +2244,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_has** **(** :ref:`RID` rid **)** |virtual| +:ref:`bool` **_has**\ (\ rid\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -2258,7 +2258,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_has_feature** **(** :ref:`Feature` feature **)** |virtual| |const| +:ref:`bool` **_has_feature**\ (\ feature\: :ref:`Feature`\ ) |virtual| |const| .. container:: contribute @@ -2272,7 +2272,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_is_confusable** **(** :ref:`String` string, :ref:`PackedStringArray` dict **)** |virtual| |const| +:ref:`int` **_is_confusable**\ (\ string\: :ref:`String`, dict\: :ref:`PackedStringArray`\ ) |virtual| |const| .. container:: contribute @@ -2286,7 +2286,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_is_locale_right_to_left** **(** :ref:`String` locale **)** |virtual| |const| +:ref:`bool` **_is_locale_right_to_left**\ (\ locale\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -2300,7 +2300,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_is_valid_identifier** **(** :ref:`String` string **)** |virtual| |const| +:ref:`bool` **_is_valid_identifier**\ (\ string\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -2314,7 +2314,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_load_support_data** **(** :ref:`String` filename **)** |virtual| +:ref:`bool` **_load_support_data**\ (\ filename\: :ref:`String`\ ) |virtual| .. container:: contribute @@ -2328,7 +2328,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_name_to_tag** **(** :ref:`String` name **)** |virtual| |const| +:ref:`int` **_name_to_tag**\ (\ name\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -2342,7 +2342,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`String` **_parse_number** **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| +:ref:`String` **_parse_number**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -2356,7 +2356,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`Vector3i[]` **_parse_structured_text** **(** :ref:`StructuredTextParser` parser_type, :ref:`Array` args, :ref:`String` text **)** |virtual| |const| +:ref:`Array`\[:ref:`Vector3i`\] **_parse_structured_text**\ (\ parser_type\: :ref:`StructuredTextParser`, args\: :ref:`Array`, text\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -2370,7 +2370,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`String` **_percent_sign** **(** :ref:`String` language **)** |virtual| |const| +:ref:`String` **_percent_sign**\ (\ language\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -2384,7 +2384,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_save_support_data** **(** :ref:`String` filename **)** |virtual| |const| +:ref:`bool` **_save_support_data**\ (\ filename\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -2398,7 +2398,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_shaped_get_span_count** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`int` **_shaped_get_span_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2412,7 +2412,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -:ref:`Variant` **_shaped_get_span_meta** **(** :ref:`RID` shaped, :ref:`int` index **)** |virtual| |const| +:ref:`Variant` **_shaped_get_span_meta**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -2426,7 +2426,7 @@ void **_free_rid** **(** :ref:`RID` rid **)** |virtual| .. rst-class:: classref-method -void **_shaped_set_span_update_font** **(** :ref:`RID` shaped, :ref:`int` index, :ref:`RID[]` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features **)** |virtual| +|void| **_shaped_set_span_update_font**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`\ ) |virtual| .. container:: contribute @@ -2440,7 +2440,7 @@ void **_shaped_set_span_update_font** **(** :ref:`RID` shaped, :ref:` .. rst-class:: classref-method -:ref:`bool` **_shaped_text_add_object** **(** :ref:`RID` shaped, :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align, :ref:`int` length, :ref:`float` baseline **)** |virtual| +:ref:`bool` **_shaped_text_add_object**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, length\: :ref:`int`, baseline\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -2454,7 +2454,7 @@ void **_shaped_set_span_update_font** **(** :ref:`RID` shaped, :ref:` .. rst-class:: classref-method -:ref:`bool` **_shaped_text_add_string** **(** :ref:`RID` shaped, :ref:`String` text, :ref:`RID[]` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features, :ref:`String` language, :ref:`Variant` meta **)** |virtual| +:ref:`bool` **_shaped_text_add_string**\ (\ shaped\: :ref:`RID`, text\: :ref:`String`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`, language\: :ref:`String`, meta\: :ref:`Variant`\ ) |virtual| .. container:: contribute @@ -2468,7 +2468,7 @@ void **_shaped_set_span_update_font** **(** :ref:`RID` shaped, :ref:` .. rst-class:: classref-method -void **_shaped_text_clear** **(** :ref:`RID` shaped **)** |virtual| +|void| **_shaped_text_clear**\ (\ shaped\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -2482,7 +2482,7 @@ void **_shaped_text_clear** **(** :ref:`RID` shaped **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_shaped_text_closest_character_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| +:ref:`int` **_shaped_text_closest_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -2496,7 +2496,7 @@ void **_shaped_text_clear** **(** :ref:`RID` shaped **)** |virtual| .. rst-class:: classref-method -void **_shaped_text_draw** **(** :ref:`RID` shaped, :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`float` clip_l, :ref:`float` clip_r, :ref:`Color` color **)** |virtual| |const| +|void| **_shaped_text_draw**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float`, clip_r\: :ref:`float`, color\: :ref:`Color`\ ) |virtual| |const| .. container:: contribute @@ -2510,7 +2510,7 @@ void **_shaped_text_draw** **(** :ref:`RID` shaped, :ref:`RID` shaped, :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`float` clip_l, :ref:`float` clip_r, :ref:`int` outline_size, :ref:`Color` color **)** |virtual| |const| +|void| **_shaped_text_draw_outline**\ (\ shaped\: :ref:`RID`, canvas\: :ref:`RID`, pos\: :ref:`Vector2`, clip_l\: :ref:`float`, clip_r\: :ref:`float`, outline_size\: :ref:`int`, color\: :ref:`Color`\ ) |virtual| |const| .. container:: contribute @@ -2524,7 +2524,7 @@ void **_shaped_text_draw_outline** **(** :ref:`RID` shaped, :ref:`RID .. rst-class:: classref-method -:ref:`float` **_shaped_text_fit_to_width** **(** :ref:`RID` shaped, :ref:`float` width, |bitfield|\<:ref:`JustificationFlag`\> justification_flags **)** |virtual| +:ref:`float` **_shaped_text_fit_to_width**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\]\ ) |virtual| .. container:: contribute @@ -2538,7 +2538,7 @@ void **_shaped_text_draw_outline** **(** :ref:`RID` shaped, :ref:`RID .. rst-class:: classref-method -:ref:`float` **_shaped_text_get_ascent** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`float` **_shaped_text_get_ascent**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2552,7 +2552,7 @@ void **_shaped_text_draw_outline** **(** :ref:`RID` shaped, :ref:`RID .. rst-class:: classref-method -void **_shaped_text_get_carets** **(** :ref:`RID` shaped, :ref:`int` position, CaretInfo* caret **)** |virtual| |const| +|void| **_shaped_text_get_carets**\ (\ shaped\: :ref:`RID`, position\: :ref:`int`, caret\: ``CaretInfo*``\ ) |virtual| |const| .. container:: contribute @@ -2566,7 +2566,7 @@ void **_shaped_text_get_carets** **(** :ref:`RID` shaped, :ref:`int` **_shaped_text_get_character_breaks** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`PackedInt32Array` **_shaped_text_get_character_breaks**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2580,7 +2580,7 @@ void **_shaped_text_get_carets** **(** :ref:`RID` shaped, :ref:`int` **_shaped_text_get_custom_ellipsis** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`int` **_shaped_text_get_custom_ellipsis**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2594,7 +2594,7 @@ void **_shaped_text_get_carets** **(** :ref:`RID` shaped, :ref:`int` **_shaped_text_get_custom_punctuation** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`String` **_shaped_text_get_custom_punctuation**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2608,7 +2608,7 @@ void **_shaped_text_get_carets** **(** :ref:`RID` shaped, :ref:`int` **_shaped_text_get_descent** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`float` **_shaped_text_get_descent**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2622,7 +2622,7 @@ void **_shaped_text_get_carets** **(** :ref:`RID` shaped, :ref:`int` **_shaped_text_get_direction** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`Direction` **_shaped_text_get_direction**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2636,7 +2636,7 @@ void **_shaped_text_get_carets** **(** :ref:`RID` shaped, :ref:`int` **_shaped_text_get_dominant_direction_in_range** **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` end **)** |virtual| |const| +:ref:`int` **_shaped_text_get_dominant_direction_in_range**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -2650,7 +2650,7 @@ void **_shaped_text_get_carets** **(** :ref:`RID` shaped, :ref:`int` **_shaped_text_get_ellipsis_glyph_count** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`int` **_shaped_text_get_ellipsis_glyph_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2664,7 +2664,7 @@ void **_shaped_text_get_carets** **(** :ref:`RID` shaped, :ref:`int` shaped **)** |virtual| |const| +``const Glyph*`` **_shaped_text_get_ellipsis_glyphs**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2678,7 +2678,7 @@ const Glyph* **_shaped_text_get_ellipsis_glyphs** **(** :ref:`RID` sh .. rst-class:: classref-method -:ref:`int` **_shaped_text_get_ellipsis_pos** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`int` **_shaped_text_get_ellipsis_pos**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2692,7 +2692,7 @@ const Glyph* **_shaped_text_get_ellipsis_glyphs** **(** :ref:`RID` sh .. rst-class:: classref-method -:ref:`int` **_shaped_text_get_glyph_count** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`int` **_shaped_text_get_glyph_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2706,7 +2706,7 @@ const Glyph* **_shaped_text_get_ellipsis_glyphs** **(** :ref:`RID` sh .. rst-class:: classref-method -const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)** |virtual| |const| +``const Glyph*`` **_shaped_text_get_glyphs**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2720,7 +2720,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`Vector2` **_shaped_text_get_grapheme_bounds** **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| +:ref:`Vector2` **_shaped_text_get_grapheme_bounds**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -2734,7 +2734,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`Direction` **_shaped_text_get_inferred_direction** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`Direction` **_shaped_text_get_inferred_direction**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2748,7 +2748,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`PackedInt32Array` **_shaped_text_get_line_breaks** **(** :ref:`RID` shaped, :ref:`float` width, :ref:`int` start, |bitfield|\<:ref:`LineBreakFlag`\> break_flags **)** |virtual| |const| +:ref:`PackedInt32Array` **_shaped_text_get_line_breaks**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, start\: :ref:`int`, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) |virtual| |const| .. container:: contribute @@ -2762,7 +2762,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`PackedInt32Array` **_shaped_text_get_line_breaks_adv** **(** :ref:`RID` shaped, :ref:`PackedFloat32Array` width, :ref:`int` start, :ref:`bool` once, |bitfield|\<:ref:`LineBreakFlag`\> break_flags **)** |virtual| |const| +:ref:`PackedInt32Array` **_shaped_text_get_line_breaks_adv**\ (\ shaped\: :ref:`RID`, width\: :ref:`PackedFloat32Array`, start\: :ref:`int`, once\: :ref:`bool`, break_flags\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) |virtual| |const| .. container:: contribute @@ -2776,7 +2776,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`Rect2` **_shaped_text_get_object_rect** **(** :ref:`RID` shaped, :ref:`Variant` key **)** |virtual| |const| +:ref:`Rect2` **_shaped_text_get_object_rect**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`\ ) |virtual| |const| .. container:: contribute @@ -2790,7 +2790,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`Array` **_shaped_text_get_objects** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`Array` **_shaped_text_get_objects**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2804,7 +2804,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`Orientation` **_shaped_text_get_orientation** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`Orientation` **_shaped_text_get_orientation**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2818,7 +2818,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`RID` **_shaped_text_get_parent** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`RID` **_shaped_text_get_parent**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2832,7 +2832,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`bool` **_shaped_text_get_preserve_control** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`bool` **_shaped_text_get_preserve_control**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2846,7 +2846,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`bool` **_shaped_text_get_preserve_invalid** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`bool` **_shaped_text_get_preserve_invalid**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2860,7 +2860,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`Vector2i` **_shaped_text_get_range** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`Vector2i` **_shaped_text_get_range**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2874,7 +2874,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`PackedVector2Array` **_shaped_text_get_selection** **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` end **)** |virtual| |const| +:ref:`PackedVector2Array` **_shaped_text_get_selection**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, end\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -2888,7 +2888,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`Vector2` **_shaped_text_get_size** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`Vector2` **_shaped_text_get_size**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2902,7 +2902,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`int` **_shaped_text_get_spacing** **(** :ref:`RID` shaped, :ref:`SpacingType` spacing **)** |virtual| |const| +:ref:`int` **_shaped_text_get_spacing**\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`\ ) |virtual| |const| .. container:: contribute @@ -2916,7 +2916,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`int` **_shaped_text_get_trim_pos** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`int` **_shaped_text_get_trim_pos**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2930,7 +2930,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`float` **_shaped_text_get_underline_position** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`float` **_shaped_text_get_underline_position**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2944,7 +2944,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`float` **_shaped_text_get_underline_thickness** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`float` **_shaped_text_get_underline_thickness**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2958,7 +2958,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`float` **_shaped_text_get_width** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`float` **_shaped_text_get_width**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -2972,7 +2972,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`PackedInt32Array` **_shaped_text_get_word_breaks** **(** :ref:`RID` shaped, |bitfield|\<:ref:`GraphemeFlag`\> grapheme_flags **)** |virtual| |const| +:ref:`PackedInt32Array` **_shaped_text_get_word_breaks**\ (\ shaped\: :ref:`RID`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag`\]\ ) |virtual| |const| .. container:: contribute @@ -2986,7 +2986,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`int` **_shaped_text_hit_test_grapheme** **(** :ref:`RID` shaped, :ref:`float` coord **)** |virtual| |const| +:ref:`int` **_shaped_text_hit_test_grapheme**\ (\ shaped\: :ref:`RID`, coord\: :ref:`float`\ ) |virtual| |const| .. container:: contribute @@ -3000,7 +3000,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`int` **_shaped_text_hit_test_position** **(** :ref:`RID` shaped, :ref:`float` coord **)** |virtual| |const| +:ref:`int` **_shaped_text_hit_test_position**\ (\ shaped\: :ref:`RID`, coord\: :ref:`float`\ ) |virtual| |const| .. container:: contribute @@ -3014,7 +3014,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`bool` **_shaped_text_is_ready** **(** :ref:`RID` shaped **)** |virtual| |const| +:ref:`bool` **_shaped_text_is_ready**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| .. container:: contribute @@ -3028,7 +3028,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`int` **_shaped_text_next_character_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| +:ref:`int` **_shaped_text_next_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -3042,7 +3042,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -:ref:`int` **_shaped_text_next_grapheme_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| +:ref:`int` **_shaped_text_next_grapheme_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -3056,7 +3056,7 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* .. rst-class:: classref-method -void **_shaped_text_overrun_trim_to_width** **(** :ref:`RID` shaped, :ref:`float` width, |bitfield|\<:ref:`TextOverrunFlag`\> trim_flags **)** |virtual| +|void| **_shaped_text_overrun_trim_to_width**\ (\ shaped\: :ref:`RID`, width\: :ref:`float`, trim_flags\: |bitfield|\[:ref:`TextOverrunFlag`\]\ ) |virtual| .. container:: contribute @@ -3070,7 +3070,7 @@ void **_shaped_text_overrun_trim_to_width** **(** :ref:`RID` shaped, .. rst-class:: classref-method -:ref:`int` **_shaped_text_prev_character_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| +:ref:`int` **_shaped_text_prev_character_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -3084,7 +3084,7 @@ void **_shaped_text_overrun_trim_to_width** **(** :ref:`RID` shaped, .. rst-class:: classref-method -:ref:`int` **_shaped_text_prev_grapheme_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| +:ref:`int` **_shaped_text_prev_grapheme_pos**\ (\ shaped\: :ref:`RID`, pos\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -3098,7 +3098,7 @@ void **_shaped_text_overrun_trim_to_width** **(** :ref:`RID` shaped, .. rst-class:: classref-method -:ref:`bool` **_shaped_text_resize_object** **(** :ref:`RID` shaped, :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align, :ref:`float` baseline **)** |virtual| +:ref:`bool` **_shaped_text_resize_object**\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, baseline\: :ref:`float`\ ) |virtual| .. container:: contribute @@ -3112,7 +3112,7 @@ void **_shaped_text_overrun_trim_to_width** **(** :ref:`RID` shaped, .. rst-class:: classref-method -void **_shaped_text_set_bidi_override** **(** :ref:`RID` shaped, :ref:`Array` override **)** |virtual| +|void| **_shaped_text_set_bidi_override**\ (\ shaped\: :ref:`RID`, override\: :ref:`Array`\ ) |virtual| .. container:: contribute @@ -3126,7 +3126,7 @@ void **_shaped_text_set_bidi_override** **(** :ref:`RID` shaped, :ref .. rst-class:: classref-method -void **_shaped_text_set_custom_ellipsis** **(** :ref:`RID` shaped, :ref:`int` char **)** |virtual| +|void| **_shaped_text_set_custom_ellipsis**\ (\ shaped\: :ref:`RID`, char\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -3140,7 +3140,7 @@ void **_shaped_text_set_custom_ellipsis** **(** :ref:`RID` shaped, :r .. rst-class:: classref-method -void **_shaped_text_set_custom_punctuation** **(** :ref:`RID` shaped, :ref:`String` punct **)** |virtual| +|void| **_shaped_text_set_custom_punctuation**\ (\ shaped\: :ref:`RID`, punct\: :ref:`String`\ ) |virtual| .. container:: contribute @@ -3154,7 +3154,7 @@ void **_shaped_text_set_custom_punctuation** **(** :ref:`RID` shaped, .. rst-class:: classref-method -void **_shaped_text_set_direction** **(** :ref:`RID` shaped, :ref:`Direction` direction **)** |virtual| +|void| **_shaped_text_set_direction**\ (\ shaped\: :ref:`RID`, direction\: :ref:`Direction`\ ) |virtual| .. container:: contribute @@ -3168,7 +3168,7 @@ void **_shaped_text_set_direction** **(** :ref:`RID` shaped, :ref:`Di .. rst-class:: classref-method -void **_shaped_text_set_orientation** **(** :ref:`RID` shaped, :ref:`Orientation` orientation **)** |virtual| +|void| **_shaped_text_set_orientation**\ (\ shaped\: :ref:`RID`, orientation\: :ref:`Orientation`\ ) |virtual| .. container:: contribute @@ -3182,7 +3182,7 @@ void **_shaped_text_set_orientation** **(** :ref:`RID` shaped, :ref:` .. rst-class:: classref-method -void **_shaped_text_set_preserve_control** **(** :ref:`RID` shaped, :ref:`bool` enabled **)** |virtual| +|void| **_shaped_text_set_preserve_control**\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -3196,7 +3196,7 @@ void **_shaped_text_set_preserve_control** **(** :ref:`RID` shaped, : .. rst-class:: classref-method -void **_shaped_text_set_preserve_invalid** **(** :ref:`RID` shaped, :ref:`bool` enabled **)** |virtual| +|void| **_shaped_text_set_preserve_invalid**\ (\ shaped\: :ref:`RID`, enabled\: :ref:`bool`\ ) |virtual| .. container:: contribute @@ -3210,7 +3210,7 @@ void **_shaped_text_set_preserve_invalid** **(** :ref:`RID` shaped, : .. rst-class:: classref-method -void **_shaped_text_set_spacing** **(** :ref:`RID` shaped, :ref:`SpacingType` spacing, :ref:`int` value **)** |virtual| +|void| **_shaped_text_set_spacing**\ (\ shaped\: :ref:`RID`, spacing\: :ref:`SpacingType`, value\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -3224,7 +3224,7 @@ void **_shaped_text_set_spacing** **(** :ref:`RID` shaped, :ref:`Spac .. rst-class:: classref-method -:ref:`bool` **_shaped_text_shape** **(** :ref:`RID` shaped **)** |virtual| +:ref:`bool` **_shaped_text_shape**\ (\ shaped\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -3238,7 +3238,7 @@ void **_shaped_text_set_spacing** **(** :ref:`RID` shaped, :ref:`Spac .. rst-class:: classref-method -const Glyph* **_shaped_text_sort_logical** **(** :ref:`RID` shaped **)** |virtual| +``const Glyph*`` **_shaped_text_sort_logical**\ (\ shaped\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -3252,7 +3252,7 @@ const Glyph* **_shaped_text_sort_logical** **(** :ref:`RID` shaped ** .. rst-class:: classref-method -:ref:`RID` **_shaped_text_substr** **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` length **)** |virtual| |const| +:ref:`RID` **_shaped_text_substr**\ (\ shaped\: :ref:`RID`, start\: :ref:`int`, length\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -3266,7 +3266,7 @@ const Glyph* **_shaped_text_sort_logical** **(** :ref:`RID` shaped ** .. rst-class:: classref-method -:ref:`float` **_shaped_text_tab_align** **(** :ref:`RID` shaped, :ref:`PackedFloat32Array` tab_stops **)** |virtual| +:ref:`float` **_shaped_text_tab_align**\ (\ shaped\: :ref:`RID`, tab_stops\: :ref:`PackedFloat32Array`\ ) |virtual| .. container:: contribute @@ -3280,7 +3280,7 @@ const Glyph* **_shaped_text_sort_logical** **(** :ref:`RID` shaped ** .. rst-class:: classref-method -:ref:`bool` **_shaped_text_update_breaks** **(** :ref:`RID` shaped **)** |virtual| +:ref:`bool` **_shaped_text_update_breaks**\ (\ shaped\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -3294,7 +3294,7 @@ const Glyph* **_shaped_text_sort_logical** **(** :ref:`RID` shaped ** .. rst-class:: classref-method -:ref:`bool` **_shaped_text_update_justification_ops** **(** :ref:`RID` shaped **)** |virtual| +:ref:`bool` **_shaped_text_update_justification_ops**\ (\ shaped\: :ref:`RID`\ ) |virtual| .. container:: contribute @@ -3308,7 +3308,7 @@ const Glyph* **_shaped_text_sort_logical** **(** :ref:`RID` shaped ** .. rst-class:: classref-method -:ref:`bool` **_spoof_check** **(** :ref:`String` string **)** |virtual| |const| +:ref:`bool` **_spoof_check**\ (\ string\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -3322,7 +3322,7 @@ const Glyph* **_shaped_text_sort_logical** **(** :ref:`RID` shaped ** .. rst-class:: classref-method -:ref:`PackedInt32Array` **_string_get_character_breaks** **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| +:ref:`PackedInt32Array` **_string_get_character_breaks**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -3336,7 +3336,7 @@ const Glyph* **_shaped_text_sort_logical** **(** :ref:`RID` shaped ** .. rst-class:: classref-method -:ref:`PackedInt32Array` **_string_get_word_breaks** **(** :ref:`String` string, :ref:`String` language, :ref:`int` chars_per_line **)** |virtual| |const| +:ref:`PackedInt32Array` **_string_get_word_breaks**\ (\ string\: :ref:`String`, language\: :ref:`String`, chars_per_line\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -3350,7 +3350,7 @@ const Glyph* **_shaped_text_sort_logical** **(** :ref:`RID` shaped ** .. rst-class:: classref-method -:ref:`String` **_string_to_lower** **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| +:ref:`String` **_string_to_lower**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -3364,7 +3364,7 @@ const Glyph* **_shaped_text_sort_logical** **(** :ref:`RID` shaped ** .. rst-class:: classref-method -:ref:`String` **_string_to_upper** **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| +:ref:`String` **_string_to_upper**\ (\ string\: :ref:`String`, language\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -3378,7 +3378,7 @@ const Glyph* **_shaped_text_sort_logical** **(** :ref:`RID` shaped ** .. rst-class:: classref-method -:ref:`String` **_strip_diacritics** **(** :ref:`String` string **)** |virtual| |const| +:ref:`String` **_strip_diacritics**\ (\ string\: :ref:`String`\ ) |virtual| |const| .. container:: contribute @@ -3392,7 +3392,7 @@ const Glyph* **_shaped_text_sort_logical** **(** :ref:`RID` shaped ** .. rst-class:: classref-method -:ref:`String` **_tag_to_name** **(** :ref:`int` tag **)** |virtual| |const| +:ref:`String` **_tag_to_name**\ (\ tag\: :ref:`int`\ ) |virtual| |const| .. container:: contribute @@ -3405,3 +3405,4 @@ const Glyph* **_shaped_text_sort_logical** **(** :ref:`RID` shaped ** .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_textserverfallback.rst b/classes/class_textserverfallback.rst index 69a98d507e7..ff8fba457b0 100644 --- a/classes/class_textserverfallback.rst +++ b/classes/class_textserverfallback.rst @@ -30,3 +30,4 @@ A fallback implementation of Godot's text server. This fallback is faster than : .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_textservermanager.rst b/classes/class_textservermanager.rst index 0932f6e0cad..37e5319a372 100644 --- a/classes/class_textservermanager.rst +++ b/classes/class_textservermanager.rst @@ -31,23 +31,23 @@ Methods .. table:: :widths: auto - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_interface` **(** :ref:`TextServer` interface **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TextServer` | :ref:`find_interface` **(** :ref:`String` name **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TextServer` | :ref:`get_interface` **(** :ref:`int` idx **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_interface_count` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`get_interfaces` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TextServer` | :ref:`get_primary_interface` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_interface` **(** :ref:`TextServer` interface **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_primary_interface` **(** :ref:`TextServer` index **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_interface`\ (\ interface\: :ref:`TextServer`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TextServer` | :ref:`find_interface`\ (\ name\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TextServer` | :ref:`get_interface`\ (\ idx\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_interface_count`\ (\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_interfaces`\ (\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TextServer` | :ref:`get_primary_interface`\ (\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_interface`\ (\ interface\: :ref:`TextServer`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_primary_interface`\ (\ index\: :ref:`TextServer`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -62,7 +62,7 @@ Signals .. rst-class:: classref-signal -**interface_added** **(** :ref:`StringName` interface_name **)** +**interface_added**\ (\ interface_name\: :ref:`StringName`\ ) Emitted when a new interface has been added. @@ -74,7 +74,7 @@ Emitted when a new interface has been added. .. rst-class:: classref-signal -**interface_removed** **(** :ref:`StringName` interface_name **)** +**interface_removed**\ (\ interface_name\: :ref:`StringName`\ ) Emitted when an interface is removed. @@ -91,7 +91,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_interface** **(** :ref:`TextServer` interface **)** +|void| **add_interface**\ (\ interface\: :ref:`TextServer`\ ) Registers a :ref:`TextServer` interface. @@ -103,7 +103,7 @@ Registers a :ref:`TextServer` interface. .. rst-class:: classref-method -:ref:`TextServer` **find_interface** **(** :ref:`String` name **)** |const| +:ref:`TextServer` **find_interface**\ (\ name\: :ref:`String`\ ) |const| Finds an interface by its ``name``. @@ -115,7 +115,7 @@ Finds an interface by its ``name``. .. rst-class:: classref-method -:ref:`TextServer` **get_interface** **(** :ref:`int` idx **)** |const| +:ref:`TextServer` **get_interface**\ (\ idx\: :ref:`int`\ ) |const| Returns the interface registered at a given index. @@ -127,7 +127,7 @@ Returns the interface registered at a given index. .. rst-class:: classref-method -:ref:`int` **get_interface_count** **(** **)** |const| +:ref:`int` **get_interface_count**\ (\ ) |const| Returns the number of interfaces currently registered. @@ -139,7 +139,7 @@ Returns the number of interfaces currently registered. .. rst-class:: classref-method -:ref:`Dictionary[]` **get_interfaces** **(** **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_interfaces**\ (\ ) |const| Returns a list of available interfaces, with the index and name of each interface. @@ -151,7 +151,7 @@ Returns a list of available interfaces, with the index and name of each interfac .. rst-class:: classref-method -:ref:`TextServer` **get_primary_interface** **(** **)** |const| +:ref:`TextServer` **get_primary_interface**\ (\ ) |const| Returns the primary :ref:`TextServer` interface currently in use. @@ -163,7 +163,7 @@ Returns the primary :ref:`TextServer` interface currently in u .. rst-class:: classref-method -void **remove_interface** **(** :ref:`TextServer` interface **)** +|void| **remove_interface**\ (\ interface\: :ref:`TextServer`\ ) Removes an interface. All fonts and shaped text caches should be freed before removing an interface. @@ -175,7 +175,7 @@ Removes an interface. All fonts and shaped text caches should be freed before re .. rst-class:: classref-method -void **set_primary_interface** **(** :ref:`TextServer` index **)** +|void| **set_primary_interface**\ (\ index\: :ref:`TextServer`\ ) Sets the primary :ref:`TextServer` interface. @@ -186,3 +186,4 @@ Sets the primary :ref:`TextServer` interface. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 246ba9a41a9..afd74fd2f5e 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -30,3 +30,4 @@ Description .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_texture2d.rst b/classes/class_texture2d.rst index 146f0829271..a72af9a5381 100644 --- a/classes/class_texture2d.rst +++ b/classes/class_texture2d.rst @@ -37,39 +37,39 @@ Methods .. table:: :widths: auto - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_draw` **(** :ref:`RID` to_canvas_item, :ref:`Vector2` pos, :ref:`Color` modulate, :ref:`bool` transpose **)** |virtual| |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_draw_rect` **(** :ref:`RID` to_canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate, :ref:`bool` transpose **)** |virtual| |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_draw_rect_region` **(** :ref:`RID` to_canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate, :ref:`bool` transpose, :ref:`bool` clip_uv **)** |virtual| |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_height` **(** **)** |virtual| |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_width` **(** **)** |virtual| |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_alpha` **(** **)** |virtual| |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_pixel_opaque` **(** :ref:`int` x, :ref:`int` y **)** |virtual| |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`create_placeholder` **(** **)** |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false **)** |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_rect` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false **)** |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`draw_rect_region` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false, :ref:`bool` clip_uv=true **)** |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_height` **(** **)** |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`get_image` **(** **)** |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_size` **(** **)** |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_width` **(** **)** |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_alpha` **(** **)** |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_draw`\ (\ to_canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, modulate\: :ref:`Color`, transpose\: :ref:`bool`\ ) |virtual| |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_draw_rect`\ (\ to_canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`, tile\: :ref:`bool`, modulate\: :ref:`Color`, transpose\: :ref:`bool`\ ) |virtual| |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_draw_rect_region`\ (\ to_canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color`, transpose\: :ref:`bool`, clip_uv\: :ref:`bool`\ ) |virtual| |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_height`\ (\ ) |virtual| |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_width`\ (\ ) |virtual| |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_alpha`\ (\ ) |virtual| |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_pixel_opaque`\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) |virtual| |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`create_placeholder`\ (\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw`\ (\ canvas_item\: :ref:`RID`, position\: :ref:`Vector2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_rect`\ (\ canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`, tile\: :ref:`bool`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_rect_region`\ (\ canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false, clip_uv\: :ref:`bool` = true\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_height`\ (\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`get_image`\ (\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_size`\ (\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_width`\ (\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_alpha`\ (\ ) |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -84,7 +84,7 @@ Method Descriptions .. rst-class:: classref-method -void **_draw** **(** :ref:`RID` to_canvas_item, :ref:`Vector2` pos, :ref:`Color` modulate, :ref:`bool` transpose **)** |virtual| |const| +|void| **_draw**\ (\ to_canvas_item\: :ref:`RID`, pos\: :ref:`Vector2`, modulate\: :ref:`Color`, transpose\: :ref:`bool`\ ) |virtual| |const| Called when the entire **Texture2D** is requested to be drawn over a :ref:`CanvasItem`, with the top-left offset specified in ``pos``. ``modulate`` specifies a multiplier for the colors being drawn, while ``transpose`` specifies whether drawing should be performed in column-major order instead of row-major order (resulting in 90-degree clockwise rotation). @@ -98,7 +98,7 @@ Called when the entire **Texture2D** is requested to be drawn over a :ref:`Canva .. rst-class:: classref-method -void **_draw_rect** **(** :ref:`RID` to_canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate, :ref:`bool` transpose **)** |virtual| |const| +|void| **_draw_rect**\ (\ to_canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`, tile\: :ref:`bool`, modulate\: :ref:`Color`, transpose\: :ref:`bool`\ ) |virtual| |const| Called when the **Texture2D** is requested to be drawn onto :ref:`CanvasItem`'s specified ``rect``. ``modulate`` specifies a multiplier for the colors being drawn, while ``transpose`` specifies whether drawing should be performed in column-major order instead of row-major order (resulting in 90-degree clockwise rotation). @@ -112,7 +112,7 @@ Called when the **Texture2D** is requested to be drawn onto :ref:`CanvasItem` to_canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate, :ref:`bool` transpose, :ref:`bool` clip_uv **)** |virtual| |const| +|void| **_draw_rect_region**\ (\ to_canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color`, transpose\: :ref:`bool`, clip_uv\: :ref:`bool`\ ) |virtual| |const| Called when a part of the **Texture2D** specified by ``src_rect``'s coordinates is requested to be drawn onto :ref:`CanvasItem`'s specified ``rect``. ``modulate`` specifies a multiplier for the colors being drawn, while ``transpose`` specifies whether drawing should be performed in column-major order instead of row-major order (resulting in 90-degree clockwise rotation). @@ -126,7 +126,7 @@ Called when a part of the **Texture2D** specified by ``src_rect``'s coordinates .. rst-class:: classref-method -:ref:`int` **_get_height** **(** **)** |virtual| |const| +:ref:`int` **_get_height**\ (\ ) |virtual| |const| Called when the **Texture2D**'s height is queried. @@ -138,7 +138,7 @@ Called when the **Texture2D**'s height is queried. .. rst-class:: classref-method -:ref:`int` **_get_width** **(** **)** |virtual| |const| +:ref:`int` **_get_width**\ (\ ) |virtual| |const| Called when the **Texture2D**'s width is queried. @@ -150,7 +150,7 @@ Called when the **Texture2D**'s width is queried. .. rst-class:: classref-method -:ref:`bool` **_has_alpha** **(** **)** |virtual| |const| +:ref:`bool` **_has_alpha**\ (\ ) |virtual| |const| Called when the presence of an alpha channel in the **Texture2D** is queried. @@ -162,7 +162,7 @@ Called when the presence of an alpha channel in the **Texture2D** is queried. .. rst-class:: classref-method -:ref:`bool` **_is_pixel_opaque** **(** :ref:`int` x, :ref:`int` y **)** |virtual| |const| +:ref:`bool` **_is_pixel_opaque**\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) |virtual| |const| Called when a pixel's opaque state in the **Texture2D** is queried at the specified ``(x, y)`` position. @@ -174,7 +174,7 @@ Called when a pixel's opaque state in the **Texture2D** is queried at the specif .. rst-class:: classref-method -:ref:`Resource` **create_placeholder** **(** **)** |const| +:ref:`Resource` **create_placeholder**\ (\ ) |const| Creates a placeholder version of this resource (:ref:`PlaceholderTexture2D`). @@ -186,7 +186,7 @@ Creates a placeholder version of this resource (:ref:`PlaceholderTexture2D` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false **)** |const| +|void| **draw**\ (\ canvas_item\: :ref:`RID`, position\: :ref:`Vector2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) |const| Draws the texture using a :ref:`CanvasItem` with the :ref:`RenderingServer` API at the specified ``position``. @@ -198,7 +198,7 @@ Draws the texture using a :ref:`CanvasItem` with the :ref:`Ren .. rst-class:: classref-method -void **draw_rect** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false **)** |const| +|void| **draw_rect**\ (\ canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`, tile\: :ref:`bool`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) |const| Draws the texture using a :ref:`CanvasItem` with the :ref:`RenderingServer` API. @@ -210,7 +210,7 @@ Draws the texture using a :ref:`CanvasItem` with the :ref:`Ren .. rst-class:: classref-method -void **draw_rect_region** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false, :ref:`bool` clip_uv=true **)** |const| +|void| **draw_rect_region**\ (\ canvas_item\: :ref:`RID`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false, clip_uv\: :ref:`bool` = true\ ) |const| Draws a part of the texture using a :ref:`CanvasItem` with the :ref:`RenderingServer` API. @@ -222,7 +222,7 @@ Draws a part of the texture using a :ref:`CanvasItem` with the .. rst-class:: classref-method -:ref:`int` **get_height** **(** **)** |const| +:ref:`int` **get_height**\ (\ ) |const| Returns the texture height in pixels. @@ -234,7 +234,7 @@ Returns the texture height in pixels. .. rst-class:: classref-method -:ref:`Image` **get_image** **(** **)** |const| +:ref:`Image` **get_image**\ (\ ) |const| Returns an :ref:`Image` that is a copy of data from this **Texture2D** (a new :ref:`Image` is created each time). :ref:`Image`\ s can be accessed and manipulated directly. @@ -250,7 +250,7 @@ Returns an :ref:`Image` that is a copy of data from this **Texture2 .. rst-class:: classref-method -:ref:`Vector2` **get_size** **(** **)** |const| +:ref:`Vector2` **get_size**\ (\ ) |const| Returns the texture size in pixels. @@ -262,7 +262,7 @@ Returns the texture size in pixels. .. rst-class:: classref-method -:ref:`int` **get_width** **(** **)** |const| +:ref:`int` **get_width**\ (\ ) |const| Returns the texture width in pixels. @@ -274,7 +274,7 @@ Returns the texture width in pixels. .. rst-class:: classref-method -:ref:`bool` **has_alpha** **(** **)** |const| +:ref:`bool` **has_alpha**\ (\ ) |const| Returns ``true`` if this **Texture2D** has an alpha channel. @@ -285,3 +285,4 @@ Returns ``true`` if this **Texture2D** has an alpha channel. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_texture2darray.rst b/classes/class_texture2darray.rst index c5684ef19f4..1763b66bbe9 100644 --- a/classes/class_texture2darray.rst +++ b/classes/class_texture2darray.rst @@ -33,9 +33,9 @@ Methods .. table:: :widths: auto - +---------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`create_placeholder` **(** **)** |const| | - +---------------------------------+-----------------------------------------------------------------------------------------------+ + +---------------------------------+-----------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`create_placeholder`\ (\ ) |const| | + +---------------------------------+-----------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -50,7 +50,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Resource` **create_placeholder** **(** **)** |const| +:ref:`Resource` **create_placeholder**\ (\ ) |const| Creates a placeholder version of this resource (:ref:`PlaceholderTexture2DArray`). @@ -61,3 +61,4 @@ Creates a placeholder version of this resource (:ref:`PlaceholderTexture2DArray< .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_texture2darrayrd.rst b/classes/class_texture2darrayrd.rst index 80b6ba94627..496e8d8d51f 100644 --- a/classes/class_texture2darrayrd.rst +++ b/classes/class_texture2darrayrd.rst @@ -28,3 +28,4 @@ This texture array class allows you to use a 2D array texture created directly o .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_texture2drd.rst b/classes/class_texture2drd.rst index 3a5147bd6ec..b058c42c322 100644 --- a/classes/class_texture2drd.rst +++ b/classes/class_texture2drd.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_texture_rd_rid** **(** :ref:`RID` value **)** -- :ref:`RID` **get_texture_rd_rid** **(** **)** +- |void| **set_texture_rd_rid**\ (\ value\: :ref:`RID`\ ) +- :ref:`RID` **get_texture_rd_rid**\ (\ ) The RID of the texture object created on the :ref:`RenderingDevice`. @@ -64,3 +64,4 @@ The RID of the texture object created on the :ref:`RenderingDevice`, :ref:`ImageTexture3D`, :ref:`NoiseTexture3D`, :ref:`PlaceholderTexture3D`, :ref:`Texture3DRD` -Base class for 3-dimensionnal textures. +Base class for 3-dimensional textures. .. rst-class:: classref-introduction-group @@ -35,33 +35,33 @@ Methods .. table:: :widths: auto - +----------------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`Image[]` | :ref:`_get_data` **(** **)** |virtual| |const| | - +----------------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_depth` **(** **)** |virtual| |const| | - +----------------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`Format` | :ref:`_get_format` **(** **)** |virtual| |const| | - +----------------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_height` **(** **)** |virtual| |const| | - +----------------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_width` **(** **)** |virtual| |const| | - +----------------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_mipmaps` **(** **)** |virtual| |const| | - +----------------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`create_placeholder` **(** **)** |const| | - +----------------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`Image[]` | :ref:`get_data` **(** **)** |const| | - +----------------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_depth` **(** **)** |const| | - +----------------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`Format` | :ref:`get_format` **(** **)** |const| | - +----------------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_height` **(** **)** |const| | - +----------------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_width` **(** **)** |const| | - +----------------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_mipmaps` **(** **)** |const| | - +----------------------------------+------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Image`\] | :ref:`_get_data`\ (\ ) |virtual| |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_depth`\ (\ ) |virtual| |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`Format` | :ref:`_get_format`\ (\ ) |virtual| |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_height`\ (\ ) |virtual| |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_width`\ (\ ) |virtual| |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_mipmaps`\ (\ ) |virtual| |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`create_placeholder`\ (\ ) |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Image`\] | :ref:`get_data`\ (\ ) |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_depth`\ (\ ) |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`Format` | :ref:`get_format`\ (\ ) |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_height`\ (\ ) |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_width`\ (\ ) |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_mipmaps`\ (\ ) |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -76,7 +76,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Image[]` **_get_data** **(** **)** |virtual| |const| +:ref:`Array`\[:ref:`Image`\] **_get_data**\ (\ ) |virtual| |const| Called when the **Texture3D**'s data is queried. @@ -88,7 +88,7 @@ Called when the **Texture3D**'s data is queried. .. rst-class:: classref-method -:ref:`int` **_get_depth** **(** **)** |virtual| |const| +:ref:`int` **_get_depth**\ (\ ) |virtual| |const| Called when the **Texture3D**'s depth is queried. @@ -100,7 +100,7 @@ Called when the **Texture3D**'s depth is queried. .. rst-class:: classref-method -:ref:`Format` **_get_format** **(** **)** |virtual| |const| +:ref:`Format` **_get_format**\ (\ ) |virtual| |const| Called when the **Texture3D**'s format is queried. @@ -112,7 +112,7 @@ Called when the **Texture3D**'s format is queried. .. rst-class:: classref-method -:ref:`int` **_get_height** **(** **)** |virtual| |const| +:ref:`int` **_get_height**\ (\ ) |virtual| |const| Called when the **Texture3D**'s height is queried. @@ -124,7 +124,7 @@ Called when the **Texture3D**'s height is queried. .. rst-class:: classref-method -:ref:`int` **_get_width** **(** **)** |virtual| |const| +:ref:`int` **_get_width**\ (\ ) |virtual| |const| Called when the **Texture3D**'s width is queried. @@ -136,7 +136,7 @@ Called when the **Texture3D**'s width is queried. .. rst-class:: classref-method -:ref:`bool` **_has_mipmaps** **(** **)** |virtual| |const| +:ref:`bool` **_has_mipmaps**\ (\ ) |virtual| |const| Called when the presence of mipmaps in the **Texture3D** is queried. @@ -148,7 +148,7 @@ Called when the presence of mipmaps in the **Texture3D** is queried. .. rst-class:: classref-method -:ref:`Resource` **create_placeholder** **(** **)** |const| +:ref:`Resource` **create_placeholder**\ (\ ) |const| Creates a placeholder version of this resource (:ref:`PlaceholderTexture3D`). @@ -160,7 +160,7 @@ Creates a placeholder version of this resource (:ref:`PlaceholderTexture3D` **get_data** **(** **)** |const| +:ref:`Array`\[:ref:`Image`\] **get_data**\ (\ ) |const| Returns the **Texture3D**'s data as an array of :ref:`Image`\ s. Each :ref:`Image` represents a *slice* of the **Texture3D**, with different slices mapping to different depth (Z axis) levels. @@ -172,7 +172,7 @@ Returns the **Texture3D**'s data as an array of :ref:`Image`\ s. Ea .. rst-class:: classref-method -:ref:`int` **get_depth** **(** **)** |const| +:ref:`int` **get_depth**\ (\ ) |const| Returns the **Texture3D**'s depth in pixels. Depth is typically represented by the Z axis (a dimension not present in :ref:`Texture2D`). @@ -184,7 +184,7 @@ Returns the **Texture3D**'s depth in pixels. Depth is typically represented by t .. rst-class:: classref-method -:ref:`Format` **get_format** **(** **)** |const| +:ref:`Format` **get_format**\ (\ ) |const| Returns the current format being used by this texture. See :ref:`Format` for details. @@ -196,7 +196,7 @@ Returns the current format being used by this texture. See :ref:`Format` **get_height** **(** **)** |const| +:ref:`int` **get_height**\ (\ ) |const| Returns the **Texture3D**'s height in pixels. Width is typically represented by the Y axis. @@ -208,7 +208,7 @@ Returns the **Texture3D**'s height in pixels. Width is typically represented by .. rst-class:: classref-method -:ref:`int` **get_width** **(** **)** |const| +:ref:`int` **get_width**\ (\ ) |const| Returns the **Texture3D**'s width in pixels. Width is typically represented by the X axis. @@ -220,7 +220,7 @@ Returns the **Texture3D**'s width in pixels. Width is typically represented by t .. rst-class:: classref-method -:ref:`bool` **has_mipmaps** **(** **)** |const| +:ref:`bool` **has_mipmaps**\ (\ ) |const| Returns ``true`` if the **Texture3D** has generated mipmaps. @@ -231,3 +231,4 @@ Returns ``true`` if the **Texture3D** has generated mipmaps. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_texture3drd.rst b/classes/class_texture3drd.rst index 4b5dc493866..670690092b4 100644 --- a/classes/class_texture3drd.rst +++ b/classes/class_texture3drd.rst @@ -50,8 +50,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_texture_rd_rid** **(** :ref:`RID` value **)** -- :ref:`RID` **get_texture_rd_rid** **(** **)** +- |void| **set_texture_rd_rid**\ (\ value\: :ref:`RID`\ ) +- :ref:`RID` **get_texture_rd_rid**\ (\ ) The RID of the texture object created on the :ref:`RenderingDevice`. @@ -62,3 +62,4 @@ The RID of the texture object created on the :ref:`RenderingDevice` value **)** -- :ref:`bool` **is_flipped_h** **(** **)** +- |void| **set_flip_h**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_flipped_h**\ (\ ) If ``true``, texture is flipped horizontally. @@ -167,8 +167,8 @@ If ``true``, texture is flipped horizontally. .. rst-class:: classref-property-setget -- void **set_flip_v** **(** :ref:`bool` value **)** -- :ref:`bool` **is_flipped_v** **(** **)** +- |void| **set_flip_v**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_flipped_v**\ (\ ) If ``true``, texture is flipped vertically. @@ -184,8 +184,8 @@ If ``true``, texture is flipped vertically. .. rst-class:: classref-property-setget -- void **set_ignore_texture_size** **(** :ref:`bool` value **)** -- :ref:`bool` **get_ignore_texture_size** **(** **)** +- |void| **set_ignore_texture_size**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_ignore_texture_size**\ (\ ) If ``true``, the size of the texture won't be considered for minimum size calculation, so the **TextureButton** can be shrunk down past the texture size. @@ -201,8 +201,8 @@ If ``true``, the size of the texture won't be considered for minimum size calcul .. rst-class:: classref-property-setget -- void **set_stretch_mode** **(** :ref:`StretchMode` value **)** -- :ref:`StretchMode` **get_stretch_mode** **(** **)** +- |void| **set_stretch_mode**\ (\ value\: :ref:`StretchMode`\ ) +- :ref:`StretchMode` **get_stretch_mode**\ (\ ) Controls the texture's behavior when you resize the node's bounding rectangle. See the :ref:`StretchMode` constants for available options. @@ -218,8 +218,8 @@ Controls the texture's behavior when you resize the node's bounding rectangle. S .. rst-class:: classref-property-setget -- void **set_click_mask** **(** :ref:`BitMap` value **)** -- :ref:`BitMap` **get_click_mask** **(** **)** +- |void| **set_click_mask**\ (\ value\: :ref:`BitMap`\ ) +- :ref:`BitMap` **get_click_mask**\ (\ ) Pure black and white :ref:`BitMap` image to use for click detection. On the mask, white pixels represent the button's clickable area. Use it to create buttons with curved shapes. @@ -235,8 +235,8 @@ Pure black and white :ref:`BitMap` image to use for click detectio .. rst-class:: classref-property-setget -- void **set_texture_disabled** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_texture_disabled** **(** **)** +- |void| **set_texture_disabled**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture_disabled**\ (\ ) Texture to display when the node is disabled. See :ref:`BaseButton.disabled`. @@ -252,8 +252,8 @@ Texture to display when the node is disabled. See :ref:`BaseButton.disabled` value **)** -- :ref:`Texture2D` **get_texture_focused** **(** **)** +- |void| **set_texture_focused**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture_focused**\ (\ ) Texture to display when the node has mouse or keyboard focus. :ref:`texture_focused` is displayed *over* the base texture, so a partially transparent texture should be used to ensure the base texture remains visible. A texture that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a fully transparent texture of any size. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. @@ -269,8 +269,8 @@ Texture to display when the node has mouse or keyboard focus. :ref:`texture_focu .. rst-class:: classref-property-setget -- void **set_texture_hover** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_texture_hover** **(** **)** +- |void| **set_texture_hover**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture_hover**\ (\ ) Texture to display when the mouse hovers the node. @@ -286,8 +286,8 @@ Texture to display when the mouse hovers the node. .. rst-class:: classref-property-setget -- void **set_texture_normal** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_texture_normal** **(** **)** +- |void| **set_texture_normal**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture_normal**\ (\ ) Texture to display by default, when the node is **not** in the disabled, hover or pressed state. This texture is still displayed in the focused state, with :ref:`texture_focused` drawn on top. @@ -303,8 +303,8 @@ Texture to display by default, when the node is **not** in the disabled, hover o .. rst-class:: classref-property-setget -- void **set_texture_pressed** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_texture_pressed** **(** **)** +- |void| **set_texture_pressed**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture_pressed**\ (\ ) Texture to display on mouse down over the node, if the node has keyboard focus and the player presses the Enter key or if the player presses the :ref:`BaseButton.shortcut` key. @@ -315,3 +315,4 @@ Texture to display on mouse down over the node, if the node has keyboard focus a .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_texturecubemaparrayrd.rst b/classes/class_texturecubemaparrayrd.rst index f4bc4ef4399..0ffa4901019 100644 --- a/classes/class_texturecubemaparrayrd.rst +++ b/classes/class_texturecubemaparrayrd.rst @@ -28,3 +28,4 @@ This texture class allows you to use a cubemap array texture created directly on .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_texturecubemaprd.rst b/classes/class_texturecubemaprd.rst index aae757029ab..efe58952e85 100644 --- a/classes/class_texturecubemaprd.rst +++ b/classes/class_texturecubemaprd.rst @@ -28,3 +28,4 @@ This texture class allows you to use a cubemap texture created directly on the : .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_texturelayered.rst b/classes/class_texturelayered.rst index 45af51b263f..8864b89003c 100644 --- a/classes/class_texturelayered.rst +++ b/classes/class_texturelayered.rst @@ -39,35 +39,35 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Format` | :ref:`_get_format` **(** **)** |virtual| |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_height` **(** **)** |virtual| |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`_get_layer_data` **(** :ref:`int` layer_index **)** |virtual| |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_layered_type` **(** **)** |virtual| |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_layers` **(** **)** |virtual| |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_width` **(** **)** |virtual| |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_has_mipmaps` **(** **)** |virtual| |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Format` | :ref:`get_format` **(** **)** |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_height` **(** **)** |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`get_layer_data` **(** :ref:`int` layer **)** |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`LayeredType` | :ref:`get_layered_type` **(** **)** |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_layers` **(** **)** |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_width` **(** **)** |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_mipmaps` **(** **)** |const| | - +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Format` | :ref:`_get_format`\ (\ ) |virtual| |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_height`\ (\ ) |virtual| |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`_get_layer_data`\ (\ layer_index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_layered_type`\ (\ ) |virtual| |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_layers`\ (\ ) |virtual| |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_width`\ (\ ) |virtual| |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_has_mipmaps`\ (\ ) |virtual| |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Format` | :ref:`get_format`\ (\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_height`\ (\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`get_layer_data`\ (\ layer\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`LayeredType` | :ref:`get_layered_type`\ (\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_layers`\ (\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_width`\ (\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_mipmaps`\ (\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -121,7 +121,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Format` **_get_format** **(** **)** |virtual| |const| +:ref:`Format` **_get_format**\ (\ ) |virtual| |const| Called when the **TextureLayered**'s format is queried. @@ -133,7 +133,7 @@ Called when the **TextureLayered**'s format is queried. .. rst-class:: classref-method -:ref:`int` **_get_height** **(** **)** |virtual| |const| +:ref:`int` **_get_height**\ (\ ) |virtual| |const| Called when the **TextureLayered**'s height is queried. @@ -145,7 +145,7 @@ Called when the **TextureLayered**'s height is queried. .. rst-class:: classref-method -:ref:`Image` **_get_layer_data** **(** :ref:`int` layer_index **)** |virtual| |const| +:ref:`Image` **_get_layer_data**\ (\ layer_index\: :ref:`int`\ ) |virtual| |const| Called when the data for a layer in the **TextureLayered** is queried. @@ -157,7 +157,7 @@ Called when the data for a layer in the **TextureLayered** is queried. .. rst-class:: classref-method -:ref:`int` **_get_layered_type** **(** **)** |virtual| |const| +:ref:`int` **_get_layered_type**\ (\ ) |virtual| |const| Called when the layers' type in the **TextureLayered** is queried. @@ -169,7 +169,7 @@ Called when the layers' type in the **TextureLayered** is queried. .. rst-class:: classref-method -:ref:`int` **_get_layers** **(** **)** |virtual| |const| +:ref:`int` **_get_layers**\ (\ ) |virtual| |const| Called when the number of layers in the **TextureLayered** is queried. @@ -181,7 +181,7 @@ Called when the number of layers in the **TextureLayered** is queried. .. rst-class:: classref-method -:ref:`int` **_get_width** **(** **)** |virtual| |const| +:ref:`int` **_get_width**\ (\ ) |virtual| |const| Called when the **TextureLayered**'s width queried. @@ -193,7 +193,7 @@ Called when the **TextureLayered**'s width queried. .. rst-class:: classref-method -:ref:`bool` **_has_mipmaps** **(** **)** |virtual| |const| +:ref:`bool` **_has_mipmaps**\ (\ ) |virtual| |const| Called when the presence of mipmaps in the **TextureLayered** is queried. @@ -205,7 +205,7 @@ Called when the presence of mipmaps in the **TextureLayered** is queried. .. rst-class:: classref-method -:ref:`Format` **get_format** **(** **)** |const| +:ref:`Format` **get_format**\ (\ ) |const| Returns the current format being used by this texture. See :ref:`Format` for details. @@ -217,7 +217,7 @@ Returns the current format being used by this texture. See :ref:`Format` **get_height** **(** **)** |const| +:ref:`int` **get_height**\ (\ ) |const| Returns the height of the texture in pixels. Height is typically represented by the Y axis. @@ -229,7 +229,7 @@ Returns the height of the texture in pixels. Height is typically represented by .. rst-class:: classref-method -:ref:`Image` **get_layer_data** **(** :ref:`int` layer **)** |const| +:ref:`Image` **get_layer_data**\ (\ layer\: :ref:`int`\ ) |const| Returns an :ref:`Image` resource with the data from specified ``layer``. @@ -241,7 +241,7 @@ Returns an :ref:`Image` resource with the data from specified ``lay .. rst-class:: classref-method -:ref:`LayeredType` **get_layered_type** **(** **)** |const| +:ref:`LayeredType` **get_layered_type**\ (\ ) |const| Returns the **TextureLayered**'s type. The type determines how the data is accessed, with cubemaps having special types. @@ -253,7 +253,7 @@ Returns the **TextureLayered**'s type. The type determines how the data is acces .. rst-class:: classref-method -:ref:`int` **get_layers** **(** **)** |const| +:ref:`int` **get_layers**\ (\ ) |const| Returns the number of referenced :ref:`Image`\ s. @@ -265,7 +265,7 @@ Returns the number of referenced :ref:`Image`\ s. .. rst-class:: classref-method -:ref:`int` **get_width** **(** **)** |const| +:ref:`int` **get_width**\ (\ ) |const| Returns the width of the texture in pixels. Width is typically represented by the X axis. @@ -277,7 +277,7 @@ Returns the width of the texture in pixels. Width is typically represented by th .. rst-class:: classref-method -:ref:`bool` **has_mipmaps** **(** **)** |const| +:ref:`bool` **has_mipmaps**\ (\ ) |const| Returns ``true`` if the layers have generated mipmaps. @@ -288,3 +288,4 @@ Returns ``true`` if the layers have generated mipmaps. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_texturelayeredrd.rst b/classes/class_texturelayeredrd.rst index a0a4519ec0f..c4db68e8321 100644 --- a/classes/class_texturelayeredrd.rst +++ b/classes/class_texturelayeredrd.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_texture_rd_rid** **(** :ref:`RID` value **)** -- :ref:`RID` **get_texture_rd_rid** **(** **)** +- |void| **set_texture_rd_rid**\ (\ value\: :ref:`RID`\ ) +- :ref:`RID` **get_texture_rd_rid**\ (\ ) The RID of the texture object created on the :ref:`RenderingDevice`. @@ -64,3 +64,4 @@ The RID of the texture object created on the :ref:`RenderingDevice` | :ref:`radial_initial_angle` | ``0.0`` | +--------------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`SizeFlags`\> | size_flags_vertical | ``1`` (overrides :ref:`Control`) | + | |bitfield|\[:ref:`SizeFlags`\] | size_flags_vertical | ``1`` (overrides :ref:`Control`) | +--------------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`float` | step | ``1.0`` (overrides :ref:`Range`) | +--------------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ @@ -77,11 +77,11 @@ Methods .. table:: :widths: auto - +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_stretch_margin` **(** :ref:`Side` margin **)** |const| | - +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_stretch_margin` **(** :ref:`Side` margin, :ref:`int` value **)** | - +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_stretch_margin`\ (\ margin\: :ref:`Side`\ ) |const| | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stretch_margin`\ (\ margin\: :ref:`Side`, value\: :ref:`int`\ ) | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -187,8 +187,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_fill_mode** **(** :ref:`int` value **)** -- :ref:`int` **get_fill_mode** **(** **)** +- |void| **set_fill_mode**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_fill_mode**\ (\ ) The fill direction. See :ref:`FillMode` for possible values. @@ -204,8 +204,8 @@ The fill direction. See :ref:`FillMode` for po .. rst-class:: classref-property-setget -- void **set_nine_patch_stretch** **(** :ref:`bool` value **)** -- :ref:`bool` **get_nine_patch_stretch** **(** **)** +- |void| **set_nine_patch_stretch**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_nine_patch_stretch**\ (\ ) If ``true``, Godot treats the bar's textures like in :ref:`NinePatchRect`. Use the ``stretch_margin_*`` properties like :ref:`stretch_margin_bottom` to set up the nine patch's 3×3 grid. When using a radial :ref:`fill_mode`, this setting will enable stretching. @@ -221,8 +221,8 @@ If ``true``, Godot treats the bar's textures like in :ref:`NinePatchRect` value **)** -- :ref:`Vector2` **get_radial_center_offset** **(** **)** +- |void| **set_radial_center_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_radial_center_offset**\ (\ ) Offsets :ref:`texture_progress` if :ref:`fill_mode` is :ref:`FILL_CLOCKWISE`, :ref:`FILL_COUNTER_CLOCKWISE`, or :ref:`FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE`. @@ -238,8 +238,8 @@ Offsets :ref:`texture_progress` value **)** -- :ref:`float` **get_fill_degrees** **(** **)** +- |void| **set_fill_degrees**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fill_degrees**\ (\ ) Upper limit for the fill of :ref:`texture_progress` if :ref:`fill_mode` is :ref:`FILL_CLOCKWISE`, :ref:`FILL_COUNTER_CLOCKWISE`, or :ref:`FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE`. When the node's ``value`` is equal to its ``max_value``, the texture fills up to this angle. @@ -257,8 +257,8 @@ See :ref:`Range.value`, :ref:`Range.max_value` value **)** -- :ref:`float` **get_radial_initial_angle** **(** **)** +- |void| **set_radial_initial_angle**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radial_initial_angle**\ (\ ) Starting angle for the fill of :ref:`texture_progress` if :ref:`fill_mode` is :ref:`FILL_CLOCKWISE`, :ref:`FILL_COUNTER_CLOCKWISE`, or :ref:`FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE`. When the node's ``value`` is equal to its ``min_value``, the texture doesn't show up at all. When the ``value`` increases, the texture fills and tends towards :ref:`radial_fill_degrees`. @@ -274,8 +274,8 @@ Starting angle for the fill of :ref:`texture_progress` margin, :ref:`int` value **)** -- :ref:`int` **get_stretch_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_stretch_margin**\ (\ margin\: :ref:`Side`, value\: :ref:`int`\ ) +- :ref:`int` **get_stretch_margin**\ (\ margin\: :ref:`Side`\ ) |const| The height of the 9-patch's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. Only effective if :ref:`nine_patch_stretch` is ``true``. @@ -291,8 +291,8 @@ The height of the 9-patch's bottom row. A margin of 16 means the 9-slice's botto .. rst-class:: classref-property-setget -- void **set_stretch_margin** **(** :ref:`Side` margin, :ref:`int` value **)** -- :ref:`int` **get_stretch_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_stretch_margin**\ (\ margin\: :ref:`Side`, value\: :ref:`int`\ ) +- :ref:`int` **get_stretch_margin**\ (\ margin\: :ref:`Side`\ ) |const| The width of the 9-patch's left column. Only effective if :ref:`nine_patch_stretch` is ``true``. @@ -308,8 +308,8 @@ The width of the 9-patch's left column. Only effective if :ref:`nine_patch_stret .. rst-class:: classref-property-setget -- void **set_stretch_margin** **(** :ref:`Side` margin, :ref:`int` value **)** -- :ref:`int` **get_stretch_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_stretch_margin**\ (\ margin\: :ref:`Side`, value\: :ref:`int`\ ) +- :ref:`int` **get_stretch_margin**\ (\ margin\: :ref:`Side`\ ) |const| The width of the 9-patch's right column. Only effective if :ref:`nine_patch_stretch` is ``true``. @@ -325,8 +325,8 @@ The width of the 9-patch's right column. Only effective if :ref:`nine_patch_stre .. rst-class:: classref-property-setget -- void **set_stretch_margin** **(** :ref:`Side` margin, :ref:`int` value **)** -- :ref:`int` **get_stretch_margin** **(** :ref:`Side` margin **)** |const| +- |void| **set_stretch_margin**\ (\ margin\: :ref:`Side`, value\: :ref:`int`\ ) +- :ref:`int` **get_stretch_margin**\ (\ margin\: :ref:`Side`\ ) |const| The height of the 9-patch's top row. Only effective if :ref:`nine_patch_stretch` is ``true``. @@ -342,8 +342,8 @@ The height of the 9-patch's top row. Only effective if :ref:`nine_patch_stretch< .. rst-class:: classref-property-setget -- void **set_over_texture** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_over_texture** **(** **)** +- |void| **set_over_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_over_texture**\ (\ ) :ref:`Texture2D` that draws over the progress bar. Use it to add highlights or an upper-frame that hides part of :ref:`texture_progress`. @@ -359,8 +359,8 @@ The height of the 9-patch's top row. Only effective if :ref:`nine_patch_stretch< .. rst-class:: classref-property-setget -- void **set_progress_texture** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_progress_texture** **(** **)** +- |void| **set_progress_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_progress_texture**\ (\ ) :ref:`Texture2D` that clips based on the node's ``value`` and :ref:`fill_mode`. As ``value`` increased, the texture fills up. It shows entirely when ``value`` reaches ``max_value``. It doesn't show at all if ``value`` is equal to ``min_value``. @@ -378,8 +378,8 @@ The ``value`` property comes from :ref:`Range`. See :ref:`Range.val .. rst-class:: classref-property-setget -- void **set_texture_progress_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_texture_progress_offset** **(** **)** +- |void| **set_texture_progress_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_texture_progress_offset**\ (\ ) The offset of :ref:`texture_progress`. Useful for :ref:`texture_over` and :ref:`texture_under` with fancy borders, to avoid transparent margins in your progress texture. @@ -395,8 +395,8 @@ The offset of :ref:`texture_progress` value **)** -- :ref:`Texture2D` **get_under_texture** **(** **)** +- |void| **set_under_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_under_texture**\ (\ ) :ref:`Texture2D` that draws under the progress bar. The bar's background. @@ -412,8 +412,8 @@ The offset of :ref:`texture_progress` value **)** -- :ref:`Color` **get_tint_over** **(** **)** +- |void| **set_tint_over**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_tint_over**\ (\ ) Multiplies the color of the bar's :ref:`texture_over` texture. The effect is similar to :ref:`CanvasItem.modulate`, except it only affects this specific texture instead of the entire node. @@ -429,8 +429,8 @@ Multiplies the color of the bar's :ref:`texture_over` value **)** -- :ref:`Color` **get_tint_progress** **(** **)** +- |void| **set_tint_progress**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_tint_progress**\ (\ ) Multiplies the color of the bar's :ref:`texture_progress` texture. @@ -446,8 +446,8 @@ Multiplies the color of the bar's :ref:`texture_progress` value **)** -- :ref:`Color` **get_tint_under** **(** **)** +- |void| **set_tint_under**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_tint_under**\ (\ ) Multiplies the color of the bar's :ref:`texture_under` texture. @@ -464,7 +464,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_stretch_margin** **(** :ref:`Side` margin **)** |const| +:ref:`int` **get_stretch_margin**\ (\ margin\: :ref:`Side`\ ) |const| Returns the stretch margin with the specified index. See :ref:`stretch_margin_bottom` and related properties. @@ -476,7 +476,7 @@ Returns the stretch margin with the specified index. See :ref:`stretch_margin_bo .. rst-class:: classref-method -void **set_stretch_margin** **(** :ref:`Side` margin, :ref:`int` value **)** +|void| **set_stretch_margin**\ (\ margin\: :ref:`Side`, value\: :ref:`int`\ ) Sets the stretch margin with the specified index. See :ref:`stretch_margin_bottom` and related properties. @@ -487,3 +487,4 @@ Sets the stretch margin with the specified index. See :ref:`stretch_margin_botto .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index 919ad6b2a43..7757575eab0 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -196,15 +196,13 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_expand_mode** **(** :ref:`ExpandMode` value **)** -- :ref:`ExpandMode` **get_expand_mode** **(** **)** +- |void| **set_expand_mode**\ (\ value\: :ref:`ExpandMode`\ ) +- :ref:`ExpandMode` **get_expand_mode**\ (\ ) -**Experimental:** This property may be changed or removed in future versions. +**Experimental:** Using :ref:`EXPAND_FIT_WIDTH`, :ref:`EXPAND_FIT_WIDTH_PROPORTIONAL`, :ref:`EXPAND_FIT_HEIGHT`, or :ref:`EXPAND_FIT_HEIGHT_PROPORTIONAL` may result in unstable behavior in some :ref:`Container` controls. This behavior may be re-evaluated and changed in the future. Defines how minimum size is determined based on the texture's size. See :ref:`ExpandMode` for options. -\ **Note:** Using :ref:`EXPAND_FIT_WIDTH`, :ref:`EXPAND_FIT_WIDTH_PROPORTIONAL`, :ref:`EXPAND_FIT_HEIGHT` or :ref:`EXPAND_FIT_HEIGHT_PROPORTIONAL` may result in unstable behavior in some containers. This functionality is being re-evaluated and will change in the future. - .. rst-class:: classref-item-separator ---- @@ -217,8 +215,8 @@ Defines how minimum size is determined based on the texture's size. See :ref:`Ex .. rst-class:: classref-property-setget -- void **set_flip_h** **(** :ref:`bool` value **)** -- :ref:`bool` **is_flipped_h** **(** **)** +- |void| **set_flip_h**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_flipped_h**\ (\ ) If ``true``, texture is flipped horizontally. @@ -234,8 +232,8 @@ If ``true``, texture is flipped horizontally. .. rst-class:: classref-property-setget -- void **set_flip_v** **(** :ref:`bool` value **)** -- :ref:`bool` **is_flipped_v** **(** **)** +- |void| **set_flip_v**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_flipped_v**\ (\ ) If ``true``, texture is flipped vertically. @@ -251,8 +249,8 @@ If ``true``, texture is flipped vertically. .. rst-class:: classref-property-setget -- void **set_stretch_mode** **(** :ref:`StretchMode` value **)** -- :ref:`StretchMode` **get_stretch_mode** **(** **)** +- |void| **set_stretch_mode**\ (\ value\: :ref:`StretchMode`\ ) +- :ref:`StretchMode` **get_stretch_mode**\ (\ ) Controls the texture's behavior when resizing the node's bounding rectangle. See :ref:`StretchMode`. @@ -268,8 +266,8 @@ Controls the texture's behavior when resizing the node's bounding rectangle. See .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ ) The node's :ref:`Texture2D` resource. @@ -280,3 +278,4 @@ The node's :ref:`Texture2D` resource. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 591f06a84dd..e4540977e41 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -58,131 +58,131 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_type` **(** :ref:`StringName` theme_type **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_color` **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_constant` **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_font` **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_font_size` **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_icon` **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_stylebox` **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_theme_item` **(** :ref:`DataType` data_type, :ref:`StringName` name, :ref:`StringName` theme_type **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_type_variation` **(** :ref:`StringName` theme_type **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_color` **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_color_list` **(** :ref:`String` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_color_type_list` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_constant` **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_constant_list` **(** :ref:`String` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_constant_type_list` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Font` | :ref:`get_font` **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_font_list` **(** :ref:`String` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_font_size` **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_font_size_list` **(** :ref:`String` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_font_size_type_list` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_font_type_list` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_icon` **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_icon_list` **(** :ref:`String` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_icon_type_list` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_stylebox_list` **(** :ref:`String` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_stylebox_type_list` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_theme_item` **(** :ref:`DataType` data_type, :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_theme_item_list` **(** :ref:`DataType` data_type, :ref:`String` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_theme_item_type_list` **(** :ref:`DataType` data_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_type_list` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_type_variation_base` **(** :ref:`StringName` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_type_variation_list` **(** :ref:`StringName` base_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_color` **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_constant` **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_default_base_scale` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_default_font` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_default_font_size` **(** **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_font` **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_font_size` **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_icon` **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_stylebox` **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_item` **(** :ref:`DataType` data_type, :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_type_variation` **(** :ref:`StringName` theme_type, :ref:`StringName` base_type **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`merge_with` **(** :ref:`Theme` other **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_type` **(** :ref:`StringName` theme_type **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rename_color` **(** :ref:`StringName` old_name, :ref:`StringName` name, :ref:`StringName` theme_type **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rename_constant` **(** :ref:`StringName` old_name, :ref:`StringName` name, :ref:`StringName` theme_type **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rename_font` **(** :ref:`StringName` old_name, :ref:`StringName` name, :ref:`StringName` theme_type **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rename_font_size` **(** :ref:`StringName` old_name, :ref:`StringName` name, :ref:`StringName` theme_type **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rename_icon` **(** :ref:`StringName` old_name, :ref:`StringName` name, :ref:`StringName` theme_type **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rename_stylebox` **(** :ref:`StringName` old_name, :ref:`StringName` name, :ref:`StringName` theme_type **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`rename_theme_item` **(** :ref:`DataType` data_type, :ref:`StringName` old_name, :ref:`StringName` name, :ref:`StringName` theme_type **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_color` **(** :ref:`StringName` name, :ref:`StringName` theme_type, :ref:`Color` color **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_constant` **(** :ref:`StringName` name, :ref:`StringName` theme_type, :ref:`int` constant **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_font` **(** :ref:`StringName` name, :ref:`StringName` theme_type, :ref:`Font` font **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_font_size` **(** :ref:`StringName` name, :ref:`StringName` theme_type, :ref:`int` font_size **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_icon` **(** :ref:`StringName` name, :ref:`StringName` theme_type, :ref:`Texture2D` texture **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_stylebox` **(** :ref:`StringName` name, :ref:`StringName` theme_type, :ref:`StyleBox` texture **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_theme_item` **(** :ref:`DataType` data_type, :ref:`StringName` name, :ref:`StringName` theme_type, :ref:`Variant` value **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_type_variation` **(** :ref:`StringName` theme_type, :ref:`StringName` base_type **)** | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_type`\ (\ theme_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_color`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_constant`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_font`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_font_size`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_icon`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_stylebox`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_theme_item`\ (\ data_type\: :ref:`DataType`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_type_variation`\ (\ theme_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_color`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_color_list`\ (\ theme_type\: :ref:`String`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_color_type_list`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_constant`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_constant_list`\ (\ theme_type\: :ref:`String`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_constant_type_list`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Font` | :ref:`get_font`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_font_list`\ (\ theme_type\: :ref:`String`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_font_size`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_font_size_list`\ (\ theme_type\: :ref:`String`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_font_size_type_list`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_font_type_list`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_icon`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_icon_list`\ (\ theme_type\: :ref:`String`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_icon_type_list`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StyleBox` | :ref:`get_stylebox`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_stylebox_list`\ (\ theme_type\: :ref:`String`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_stylebox_type_list`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_theme_item`\ (\ data_type\: :ref:`DataType`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_theme_item_list`\ (\ data_type\: :ref:`DataType`, theme_type\: :ref:`String`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_theme_item_type_list`\ (\ data_type\: :ref:`DataType`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_type_list`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_type_variation_base`\ (\ theme_type\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_type_variation_list`\ (\ base_type\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_color`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_constant`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_default_base_scale`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_default_font`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_default_font_size`\ (\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_font`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_font_size`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_icon`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_stylebox`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_item`\ (\ data_type\: :ref:`DataType`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_type_variation`\ (\ theme_type\: :ref:`StringName`, base_type\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`merge_with`\ (\ other\: :ref:`Theme`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_type`\ (\ theme_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rename_color`\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rename_constant`\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rename_font`\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rename_font_size`\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rename_icon`\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rename_stylebox`\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`rename_theme_item`\ (\ data_type\: :ref:`DataType`, old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_color`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, color\: :ref:`Color`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_constant`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, constant\: :ref:`int`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_font`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, font\: :ref:`Font`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_font_size`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, font_size\: :ref:`int`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, texture\: :ref:`Texture2D`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_stylebox`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, texture\: :ref:`StyleBox`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_theme_item`\ (\ data_type\: :ref:`DataType`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_type_variation`\ (\ theme_type\: :ref:`StringName`, base_type\: :ref:`StringName`\ ) | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -272,8 +272,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_default_base_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_default_base_scale** **(** **)** +- |void| **set_default_base_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_default_base_scale**\ (\ ) The default base scale factor of this theme resource. Used by some controls to scale their visual properties based on the global scale factor. If this value is set to ``0.0``, the global scale factor is used (see :ref:`ThemeDB.fallback_base_scale`). @@ -291,8 +291,8 @@ Use :ref:`has_default_base_scale` to .. rst-class:: classref-property-setget -- void **set_default_font** **(** :ref:`Font` value **)** -- :ref:`Font` **get_default_font** **(** **)** +- |void| **set_default_font**\ (\ value\: :ref:`Font`\ ) +- :ref:`Font` **get_default_font**\ (\ ) The default font of this theme resource. Used as the default value when trying to fetch a font resource that doesn't exist in this theme or is in invalid state. If the default font is also missing or invalid, the engine fallback value is used (see :ref:`ThemeDB.fallback_font`). @@ -310,8 +310,8 @@ Use :ref:`has_default_font` to check if thi .. rst-class:: classref-property-setget -- void **set_default_font_size** **(** :ref:`int` value **)** -- :ref:`int` **get_default_font_size** **(** **)** +- |void| **set_default_font_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_default_font_size**\ (\ ) The default font size of this theme resource. Used as the default value when trying to fetch a font size value that doesn't exist in this theme or is in invalid state. If the default font size is also missing or invalid, the engine fallback value is used (see :ref:`ThemeDB.fallback_font_size`). @@ -330,7 +330,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_type** **(** :ref:`StringName` theme_type **)** +|void| **add_type**\ (\ theme_type\: :ref:`StringName`\ ) Adds an empty theme type for every valid data type. @@ -344,7 +344,7 @@ Adds an empty theme type for every valid data type. .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Removes all the theme properties defined on the theme resource. @@ -356,7 +356,7 @@ Removes all the theme properties defined on the theme resource. .. rst-class:: classref-method -void **clear_color** **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** +|void| **clear_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) Removes the :ref:`Color` property defined by ``name`` and ``theme_type``, if it exists. @@ -370,7 +370,7 @@ Fails if it doesn't exist. Use :ref:`has_color` to .. rst-class:: classref-method -void **clear_constant** **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** +|void| **clear_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) Removes the constant property defined by ``name`` and ``theme_type``, if it exists. @@ -384,7 +384,7 @@ Fails if it doesn't exist. Use :ref:`has_constant` name, :ref:`StringName` theme_type **)** +|void| **clear_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) Removes the :ref:`Font` property defined by ``name`` and ``theme_type``, if it exists. @@ -398,7 +398,7 @@ Fails if it doesn't exist. Use :ref:`has_font` to c .. rst-class:: classref-method -void **clear_font_size** **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** +|void| **clear_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) Removes the font size property defined by ``name`` and ``theme_type``, if it exists. @@ -412,7 +412,7 @@ Fails if it doesn't exist. Use :ref:`has_font_size` name, :ref:`StringName` theme_type **)** +|void| **clear_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) Removes the icon property defined by ``name`` and ``theme_type``, if it exists. @@ -426,7 +426,7 @@ Fails if it doesn't exist. Use :ref:`has_icon` to c .. rst-class:: classref-method -void **clear_stylebox** **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** +|void| **clear_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) Removes the :ref:`StyleBox` property defined by ``name`` and ``theme_type``, if it exists. @@ -440,7 +440,7 @@ Fails if it doesn't exist. Use :ref:`has_stylebox` data_type, :ref:`StringName` name, :ref:`StringName` theme_type **)** +|void| **clear_theme_item**\ (\ data_type\: :ref:`DataType`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) Removes the theme property of ``data_type`` defined by ``name`` and ``theme_type``, if it exists. @@ -456,7 +456,7 @@ Fails if it doesn't exist. Use :ref:`has_theme_item` theme_type **)** +|void| **clear_type_variation**\ (\ theme_type\: :ref:`StringName`\ ) Unmarks ``theme_type`` as being a variation of another theme type. See :ref:`set_type_variation`. @@ -468,7 +468,7 @@ Unmarks ``theme_type`` as being a variation of another theme type. See :ref:`set .. rst-class:: classref-method -:ref:`Color` **get_color** **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| +:ref:`Color` **get_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| Returns the :ref:`Color` property defined by ``name`` and ``theme_type``, if it exists. @@ -482,7 +482,7 @@ Returns the default color value if the property doesn't exist. Use :ref:`has_col .. rst-class:: classref-method -:ref:`PackedStringArray` **get_color_list** **(** :ref:`String` theme_type **)** |const| +:ref:`PackedStringArray` **get_color_list**\ (\ theme_type\: :ref:`String`\ ) |const| Returns a list of names for :ref:`Color` properties defined with ``theme_type``. Use :ref:`get_color_type_list` to get a list of possible theme type names. @@ -494,7 +494,7 @@ Returns a list of names for :ref:`Color` properties defined with `` .. rst-class:: classref-method -:ref:`PackedStringArray` **get_color_type_list** **(** **)** |const| +:ref:`PackedStringArray` **get_color_type_list**\ (\ ) |const| Returns a list of all unique theme type names for :ref:`Color` properties. Use :ref:`get_type_list` to get a list of all unique theme types. @@ -506,7 +506,7 @@ Returns a list of all unique theme type names for :ref:`Color` prop .. rst-class:: classref-method -:ref:`int` **get_constant** **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| +:ref:`int` **get_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| Returns the constant property defined by ``name`` and ``theme_type``, if it exists. @@ -520,7 +520,7 @@ Returns ``0`` if the property doesn't exist. Use :ref:`has_constant` **get_constant_list** **(** :ref:`String` theme_type **)** |const| +:ref:`PackedStringArray` **get_constant_list**\ (\ theme_type\: :ref:`String`\ ) |const| Returns a list of names for constant properties defined with ``theme_type``. Use :ref:`get_constant_type_list` to get a list of possible theme type names. @@ -532,7 +532,7 @@ Returns a list of names for constant properties defined with ``theme_type``. Use .. rst-class:: classref-method -:ref:`PackedStringArray` **get_constant_type_list** **(** **)** |const| +:ref:`PackedStringArray` **get_constant_type_list**\ (\ ) |const| Returns a list of all unique theme type names for constant properties. Use :ref:`get_type_list` to get a list of all unique theme types. @@ -544,7 +544,7 @@ Returns a list of all unique theme type names for constant properties. Use :ref: .. rst-class:: classref-method -:ref:`Font` **get_font** **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| +:ref:`Font` **get_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| Returns the :ref:`Font` property defined by ``name`` and ``theme_type``, if it exists. @@ -560,7 +560,7 @@ Returns the engine fallback font value, if neither exist (see :ref:`ThemeDB.fall .. rst-class:: classref-method -:ref:`PackedStringArray` **get_font_list** **(** :ref:`String` theme_type **)** |const| +:ref:`PackedStringArray` **get_font_list**\ (\ theme_type\: :ref:`String`\ ) |const| Returns a list of names for :ref:`Font` properties defined with ``theme_type``. Use :ref:`get_font_type_list` to get a list of possible theme type names. @@ -572,7 +572,7 @@ Returns a list of names for :ref:`Font` properties defined with ``th .. rst-class:: classref-method -:ref:`int` **get_font_size** **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| +:ref:`int` **get_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| Returns the font size property defined by ``name`` and ``theme_type``, if it exists. @@ -588,7 +588,7 @@ Returns the engine fallback font size value, if neither exist (see :ref:`ThemeDB .. rst-class:: classref-method -:ref:`PackedStringArray` **get_font_size_list** **(** :ref:`String` theme_type **)** |const| +:ref:`PackedStringArray` **get_font_size_list**\ (\ theme_type\: :ref:`String`\ ) |const| Returns a list of names for font size properties defined with ``theme_type``. Use :ref:`get_font_size_type_list` to get a list of possible theme type names. @@ -600,7 +600,7 @@ Returns a list of names for font size properties defined with ``theme_type``. Us .. rst-class:: classref-method -:ref:`PackedStringArray` **get_font_size_type_list** **(** **)** |const| +:ref:`PackedStringArray` **get_font_size_type_list**\ (\ ) |const| Returns a list of all unique theme type names for font size properties. Use :ref:`get_type_list` to get a list of all unique theme types. @@ -612,7 +612,7 @@ Returns a list of all unique theme type names for font size properties. Use :ref .. rst-class:: classref-method -:ref:`PackedStringArray` **get_font_type_list** **(** **)** |const| +:ref:`PackedStringArray` **get_font_type_list**\ (\ ) |const| Returns a list of all unique theme type names for :ref:`Font` properties. Use :ref:`get_type_list` to get a list of all unique theme types. @@ -624,7 +624,7 @@ Returns a list of all unique theme type names for :ref:`Font` proper .. rst-class:: classref-method -:ref:`Texture2D` **get_icon** **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| +:ref:`Texture2D` **get_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| Returns the icon property defined by ``name`` and ``theme_type``, if it exists. @@ -638,7 +638,7 @@ Returns the engine fallback icon value if the property doesn't exist (see :ref:` .. rst-class:: classref-method -:ref:`PackedStringArray` **get_icon_list** **(** :ref:`String` theme_type **)** |const| +:ref:`PackedStringArray` **get_icon_list**\ (\ theme_type\: :ref:`String`\ ) |const| Returns a list of names for icon properties defined with ``theme_type``. Use :ref:`get_icon_type_list` to get a list of possible theme type names. @@ -650,7 +650,7 @@ Returns a list of names for icon properties defined with ``theme_type``. Use :re .. rst-class:: classref-method -:ref:`PackedStringArray` **get_icon_type_list** **(** **)** |const| +:ref:`PackedStringArray` **get_icon_type_list**\ (\ ) |const| Returns a list of all unique theme type names for icon properties. Use :ref:`get_type_list` to get a list of all unique theme types. @@ -662,7 +662,7 @@ Returns a list of all unique theme type names for icon properties. Use :ref:`get .. rst-class:: classref-method -:ref:`StyleBox` **get_stylebox** **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| +:ref:`StyleBox` **get_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| Returns the :ref:`StyleBox` property defined by ``name`` and ``theme_type``, if it exists. @@ -676,7 +676,7 @@ Returns the engine fallback stylebox value if the property doesn't exist (see :r .. rst-class:: classref-method -:ref:`PackedStringArray` **get_stylebox_list** **(** :ref:`String` theme_type **)** |const| +:ref:`PackedStringArray` **get_stylebox_list**\ (\ theme_type\: :ref:`String`\ ) |const| Returns a list of names for :ref:`StyleBox` properties defined with ``theme_type``. Use :ref:`get_stylebox_type_list` to get a list of possible theme type names. @@ -688,7 +688,7 @@ Returns a list of names for :ref:`StyleBox` properties defined w .. rst-class:: classref-method -:ref:`PackedStringArray` **get_stylebox_type_list** **(** **)** |const| +:ref:`PackedStringArray` **get_stylebox_type_list**\ (\ ) |const| Returns a list of all unique theme type names for :ref:`StyleBox` properties. Use :ref:`get_type_list` to get a list of all unique theme types. @@ -700,7 +700,7 @@ Returns a list of all unique theme type names for :ref:`StyleBox .. rst-class:: classref-method -:ref:`Variant` **get_theme_item** **(** :ref:`DataType` data_type, :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| +:ref:`Variant` **get_theme_item**\ (\ data_type\: :ref:`DataType`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| Returns the theme property of ``data_type`` defined by ``name`` and ``theme_type``, if it exists. @@ -716,7 +716,7 @@ Returns the engine fallback value if the property doesn't exist (see :ref:`Theme .. rst-class:: classref-method -:ref:`PackedStringArray` **get_theme_item_list** **(** :ref:`DataType` data_type, :ref:`String` theme_type **)** |const| +:ref:`PackedStringArray` **get_theme_item_list**\ (\ data_type\: :ref:`DataType`, theme_type\: :ref:`String`\ ) |const| Returns a list of names for properties of ``data_type`` defined with ``theme_type``. Use :ref:`get_theme_item_type_list` to get a list of possible theme type names. @@ -730,7 +730,7 @@ Returns a list of names for properties of ``data_type`` defined with ``theme_typ .. rst-class:: classref-method -:ref:`PackedStringArray` **get_theme_item_type_list** **(** :ref:`DataType` data_type **)** |const| +:ref:`PackedStringArray` **get_theme_item_type_list**\ (\ data_type\: :ref:`DataType`\ ) |const| Returns a list of all unique theme type names for ``data_type`` properties. Use :ref:`get_type_list` to get a list of all unique theme types. @@ -744,7 +744,7 @@ Returns a list of all unique theme type names for ``data_type`` properties. Use .. rst-class:: classref-method -:ref:`PackedStringArray` **get_type_list** **(** **)** |const| +:ref:`PackedStringArray` **get_type_list**\ (\ ) |const| Returns a list of all unique theme type names. Use the appropriate ``get_*_type_list`` method to get a list of unique theme types for a single data type. @@ -756,7 +756,7 @@ Returns a list of all unique theme type names. Use the appropriate ``get_*_type_ .. rst-class:: classref-method -:ref:`StringName` **get_type_variation_base** **(** :ref:`StringName` theme_type **)** |const| +:ref:`StringName` **get_type_variation_base**\ (\ theme_type\: :ref:`StringName`\ ) |const| Returns the name of the base theme type if ``theme_type`` is a valid variation type. Returns an empty string otherwise. @@ -768,7 +768,7 @@ Returns the name of the base theme type if ``theme_type`` is a valid variation t .. rst-class:: classref-method -:ref:`PackedStringArray` **get_type_variation_list** **(** :ref:`StringName` base_type **)** |const| +:ref:`PackedStringArray` **get_type_variation_list**\ (\ base_type\: :ref:`StringName`\ ) |const| Returns a list of all type variations for the given ``base_type``. @@ -780,7 +780,7 @@ Returns a list of all type variations for the given ``base_type``. .. rst-class:: classref-method -:ref:`bool` **has_color** **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| +:ref:`bool` **has_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| Returns ``true`` if the :ref:`Color` property defined by ``name`` and ``theme_type`` exists. @@ -794,7 +794,7 @@ Returns ``false`` if it doesn't exist. Use :ref:`set_color` **has_constant** **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| +:ref:`bool` **has_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| Returns ``true`` if the constant property defined by ``name`` and ``theme_type`` exists. @@ -808,7 +808,7 @@ Returns ``false`` if it doesn't exist. Use :ref:`set_constant` **has_default_base_scale** **(** **)** |const| +:ref:`bool` **has_default_base_scale**\ (\ ) |const| Returns ``true`` if :ref:`default_base_scale` has a valid value. @@ -822,7 +822,7 @@ Returns ``false`` if it doesn't. The value must be greater than ``0.0`` to be co .. rst-class:: classref-method -:ref:`bool` **has_default_font** **(** **)** |const| +:ref:`bool` **has_default_font**\ (\ ) |const| Returns ``true`` if :ref:`default_font` has a valid value. @@ -836,7 +836,7 @@ Returns ``false`` if it doesn't. .. rst-class:: classref-method -:ref:`bool` **has_default_font_size** **(** **)** |const| +:ref:`bool` **has_default_font_size**\ (\ ) |const| Returns ``true`` if :ref:`default_font_size` has a valid value. @@ -850,7 +850,7 @@ Returns ``false`` if it doesn't. The value must be greater than ``0`` to be cons .. rst-class:: classref-method -:ref:`bool` **has_font** **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| +:ref:`bool` **has_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| Returns ``true`` if the :ref:`Font` property defined by ``name`` and ``theme_type`` exists, or if the default theme font is set up (see :ref:`has_default_font`). @@ -864,7 +864,7 @@ Returns ``false`` if neither exist. Use :ref:`set_font` **has_font_size** **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| +:ref:`bool` **has_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| Returns ``true`` if the font size property defined by ``name`` and ``theme_type`` exists, or if the default theme font size is set up (see :ref:`has_default_font_size`). @@ -878,7 +878,7 @@ Returns ``false`` if neither exist. Use :ref:`set_font_size` **has_icon** **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| +:ref:`bool` **has_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| Returns ``true`` if the icon property defined by ``name`` and ``theme_type`` exists. @@ -892,7 +892,7 @@ Returns ``false`` if it doesn't exist. Use :ref:`set_icon` **has_stylebox** **(** :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| +:ref:`bool` **has_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| Returns ``true`` if the :ref:`StyleBox` property defined by ``name`` and ``theme_type`` exists. @@ -906,7 +906,7 @@ Returns ``false`` if it doesn't exist. Use :ref:`set_stylebox` **has_theme_item** **(** :ref:`DataType` data_type, :ref:`StringName` name, :ref:`StringName` theme_type **)** |const| +:ref:`bool` **has_theme_item**\ (\ data_type\: :ref:`DataType`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) |const| Returns ``true`` if the theme property of ``data_type`` defined by ``name`` and ``theme_type`` exists. @@ -922,7 +922,7 @@ Returns ``false`` if it doesn't exist. Use :ref:`set_theme_item` **is_type_variation** **(** :ref:`StringName` theme_type, :ref:`StringName` base_type **)** |const| +:ref:`bool` **is_type_variation**\ (\ theme_type\: :ref:`StringName`, base_type\: :ref:`StringName`\ ) |const| Returns ``true`` if ``theme_type`` is marked as a variation of ``base_type``. @@ -934,7 +934,7 @@ Returns ``true`` if ``theme_type`` is marked as a variation of ``base_type``. .. rst-class:: classref-method -void **merge_with** **(** :ref:`Theme` other **)** +|void| **merge_with**\ (\ other\: :ref:`Theme`\ ) Adds missing and overrides existing definitions with values from the ``other`` theme resource. @@ -948,7 +948,7 @@ Adds missing and overrides existing definitions with values from the ``other`` t .. rst-class:: classref-method -void **remove_type** **(** :ref:`StringName` theme_type **)** +|void| **remove_type**\ (\ theme_type\: :ref:`StringName`\ ) Removes the theme type, gracefully discarding defined theme items. If the type is a variation, this information is also erased. If the type is a base for type variations, those variations lose their base. @@ -960,7 +960,7 @@ Removes the theme type, gracefully discarding defined theme items. If the type i .. rst-class:: classref-method -void **rename_color** **(** :ref:`StringName` old_name, :ref:`StringName` name, :ref:`StringName` theme_type **)** +|void| **rename_color**\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) Renames the :ref:`Color` property defined by ``old_name`` and ``theme_type`` to ``name``, if it exists. @@ -974,7 +974,7 @@ Fails if it doesn't exist, or if a similar property with the new name already ex .. rst-class:: classref-method -void **rename_constant** **(** :ref:`StringName` old_name, :ref:`StringName` name, :ref:`StringName` theme_type **)** +|void| **rename_constant**\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) Renames the constant property defined by ``old_name`` and ``theme_type`` to ``name``, if it exists. @@ -988,7 +988,7 @@ Fails if it doesn't exist, or if a similar property with the new name already ex .. rst-class:: classref-method -void **rename_font** **(** :ref:`StringName` old_name, :ref:`StringName` name, :ref:`StringName` theme_type **)** +|void| **rename_font**\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) Renames the :ref:`Font` property defined by ``old_name`` and ``theme_type`` to ``name``, if it exists. @@ -1002,7 +1002,7 @@ Fails if it doesn't exist, or if a similar property with the new name already ex .. rst-class:: classref-method -void **rename_font_size** **(** :ref:`StringName` old_name, :ref:`StringName` name, :ref:`StringName` theme_type **)** +|void| **rename_font_size**\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) Renames the font size property defined by ``old_name`` and ``theme_type`` to ``name``, if it exists. @@ -1016,7 +1016,7 @@ Fails if it doesn't exist, or if a similar property with the new name already ex .. rst-class:: classref-method -void **rename_icon** **(** :ref:`StringName` old_name, :ref:`StringName` name, :ref:`StringName` theme_type **)** +|void| **rename_icon**\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) Renames the icon property defined by ``old_name`` and ``theme_type`` to ``name``, if it exists. @@ -1030,7 +1030,7 @@ Fails if it doesn't exist, or if a similar property with the new name already ex .. rst-class:: classref-method -void **rename_stylebox** **(** :ref:`StringName` old_name, :ref:`StringName` name, :ref:`StringName` theme_type **)** +|void| **rename_stylebox**\ (\ old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) Renames the :ref:`StyleBox` property defined by ``old_name`` and ``theme_type`` to ``name``, if it exists. @@ -1044,7 +1044,7 @@ Fails if it doesn't exist, or if a similar property with the new name already ex .. rst-class:: classref-method -void **rename_theme_item** **(** :ref:`DataType` data_type, :ref:`StringName` old_name, :ref:`StringName` name, :ref:`StringName` theme_type **)** +|void| **rename_theme_item**\ (\ data_type\: :ref:`DataType`, old_name\: :ref:`StringName`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`\ ) Renames the theme property of ``data_type`` defined by ``old_name`` and ``theme_type`` to ``name``, if it exists. @@ -1060,7 +1060,7 @@ Fails if it doesn't exist, or if a similar property with the new name already ex .. rst-class:: classref-method -void **set_color** **(** :ref:`StringName` name, :ref:`StringName` theme_type, :ref:`Color` color **)** +|void| **set_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, color\: :ref:`Color`\ ) Creates or changes the value of the :ref:`Color` property defined by ``name`` and ``theme_type``. Use :ref:`clear_color` to remove the property. @@ -1072,7 +1072,7 @@ Creates or changes the value of the :ref:`Color` property defined b .. rst-class:: classref-method -void **set_constant** **(** :ref:`StringName` name, :ref:`StringName` theme_type, :ref:`int` constant **)** +|void| **set_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, constant\: :ref:`int`\ ) Creates or changes the value of the constant property defined by ``name`` and ``theme_type``. Use :ref:`clear_constant` to remove the property. @@ -1084,7 +1084,7 @@ Creates or changes the value of the constant property defined by ``name`` and `` .. rst-class:: classref-method -void **set_font** **(** :ref:`StringName` name, :ref:`StringName` theme_type, :ref:`Font` font **)** +|void| **set_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, font\: :ref:`Font`\ ) Creates or changes the value of the :ref:`Font` property defined by ``name`` and ``theme_type``. Use :ref:`clear_font` to remove the property. @@ -1096,7 +1096,7 @@ Creates or changes the value of the :ref:`Font` property defined by .. rst-class:: classref-method -void **set_font_size** **(** :ref:`StringName` name, :ref:`StringName` theme_type, :ref:`int` font_size **)** +|void| **set_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, font_size\: :ref:`int`\ ) Creates or changes the value of the font size property defined by ``name`` and ``theme_type``. Use :ref:`clear_font_size` to remove the property. @@ -1108,7 +1108,7 @@ Creates or changes the value of the font size property defined by ``name`` and ` .. rst-class:: classref-method -void **set_icon** **(** :ref:`StringName` name, :ref:`StringName` theme_type, :ref:`Texture2D` texture **)** +|void| **set_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, texture\: :ref:`Texture2D`\ ) Creates or changes the value of the icon property defined by ``name`` and ``theme_type``. Use :ref:`clear_icon` to remove the property. @@ -1120,7 +1120,7 @@ Creates or changes the value of the icon property defined by ``name`` and ``them .. rst-class:: classref-method -void **set_stylebox** **(** :ref:`StringName` name, :ref:`StringName` theme_type, :ref:`StyleBox` texture **)** +|void| **set_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName`, texture\: :ref:`StyleBox`\ ) Creates or changes the value of the :ref:`StyleBox` property defined by ``name`` and ``theme_type``. Use :ref:`clear_stylebox` to remove the property. @@ -1132,7 +1132,7 @@ Creates or changes the value of the :ref:`StyleBox` property def .. rst-class:: classref-method -void **set_theme_item** **(** :ref:`DataType` data_type, :ref:`StringName` name, :ref:`StringName` theme_type, :ref:`Variant` value **)** +|void| **set_theme_item**\ (\ data_type\: :ref:`DataType`, name\: :ref:`StringName`, theme_type\: :ref:`StringName`, value\: :ref:`Variant`\ ) Creates or changes the value of the theme property of ``data_type`` defined by ``name`` and ``theme_type``. Use :ref:`clear_theme_item` to remove the property. @@ -1148,7 +1148,7 @@ Fails if the ``value`` type is not accepted by ``data_type``. .. rst-class:: classref-method -void **set_type_variation** **(** :ref:`StringName` theme_type, :ref:`StringName` base_type **)** +|void| **set_type_variation**\ (\ theme_type\: :ref:`StringName`, base_type\: :ref:`StringName`\ ) Marks ``theme_type`` as a variation of ``base_type``. @@ -1165,3 +1165,4 @@ Variations can also be nested, i.e. ``base_type`` can be another variation. If a .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_themedb.rst b/classes/class_themedb.rst index 588be34fff3..94da2332ccb 100644 --- a/classes/class_themedb.rst +++ b/classes/class_themedb.rst @@ -51,11 +51,11 @@ Methods .. table:: :widths: auto - +---------------------------+------------------------------------------------------------------------------+ - | :ref:`Theme` | :ref:`get_default_theme` **(** **)** | - +---------------------------+------------------------------------------------------------------------------+ - | :ref:`Theme` | :ref:`get_project_theme` **(** **)** | - +---------------------------+------------------------------------------------------------------------------+ + +---------------------------+------------------------------------------------------------------------+ + | :ref:`Theme` | :ref:`get_default_theme`\ (\ ) | + +---------------------------+------------------------------------------------------------------------+ + | :ref:`Theme` | :ref:`get_project_theme`\ (\ ) | + +---------------------------+------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -70,7 +70,7 @@ Signals .. rst-class:: classref-signal -**fallback_changed** **(** **)** +**fallback_changed**\ (\ ) Emitted when one of the fallback values had been changed. Use it to refresh the look of controls that may rely on the fallback theme items. @@ -91,8 +91,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_fallback_base_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_fallback_base_scale** **(** **)** +- |void| **set_fallback_base_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fallback_base_scale**\ (\ ) The fallback base scale factor of every :ref:`Control` node and :ref:`Theme` resource. Used when no other value is available to the control. @@ -110,8 +110,8 @@ See also :ref:`Theme.default_base_scale .. rst-class:: classref-property-setget -- void **set_fallback_font** **(** :ref:`Font` value **)** -- :ref:`Font` **get_fallback_font** **(** **)** +- |void| **set_fallback_font**\ (\ value\: :ref:`Font`\ ) +- :ref:`Font` **get_fallback_font**\ (\ ) The fallback font of every :ref:`Control` node and :ref:`Theme` resource. Used when no other value is available to the control. @@ -129,8 +129,8 @@ See also :ref:`Theme.default_font`. .. rst-class:: classref-property-setget -- void **set_fallback_font_size** **(** :ref:`int` value **)** -- :ref:`int` **get_fallback_font_size** **(** **)** +- |void| **set_fallback_font_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_fallback_font_size**\ (\ ) The fallback font size of every :ref:`Control` node and :ref:`Theme` resource. Used when no other value is available to the control. @@ -148,8 +148,8 @@ See also :ref:`Theme.default_font_size`. .. rst-class:: classref-property-setget -- void **set_fallback_icon** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_fallback_icon** **(** **)** +- |void| **set_fallback_icon**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_fallback_icon**\ (\ ) The fallback icon of every :ref:`Control` node and :ref:`Theme` resource. Used when no other value is available to the control. @@ -165,8 +165,8 @@ The fallback icon of every :ref:`Control` node and :ref:`Theme` value **)** -- :ref:`StyleBox` **get_fallback_stylebox** **(** **)** +- |void| **set_fallback_stylebox**\ (\ value\: :ref:`StyleBox`\ ) +- :ref:`StyleBox` **get_fallback_stylebox**\ (\ ) The fallback stylebox of every :ref:`Control` node and :ref:`Theme` resource. Used when no other value is available to the control. @@ -183,7 +183,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Theme` **get_default_theme** **(** **)** +:ref:`Theme` **get_default_theme**\ (\ ) Returns a reference to the default engine :ref:`Theme`. This theme resource is responsible for the out-of-the-box look of :ref:`Control` nodes and cannot be overridden. @@ -195,7 +195,7 @@ Returns a reference to the default engine :ref:`Theme`. This theme .. rst-class:: classref-method -:ref:`Theme` **get_project_theme** **(** **)** +:ref:`Theme` **get_project_theme**\ (\ ) Returns a reference to the custom project :ref:`Theme`. This theme resources allows to override the default engine theme for every control node in the project. @@ -208,3 +208,4 @@ To set the project theme, see :ref:`ProjectSettings.gui/theme/custom` | :ref:`get_id` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_alive` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_started` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_thread_safety_checks_enabled` **(** :ref:`bool` enabled **)** |static| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`start` **(** :ref:`Callable` callable, :ref:`Priority` priority=1 **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`wait_to_finish` **(** **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_id`\ (\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_alive`\ (\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_started`\ (\ ) |const| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_thread_safety_checks_enabled`\ (\ enabled\: :ref:`bool`\ ) |static| | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`start`\ (\ callable\: :ref:`Callable`, priority\: :ref:`Priority` = 1\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`wait_to_finish`\ (\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -116,7 +116,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **get_id** **(** **)** |const| +:ref:`String` **get_id**\ (\ ) |const| Returns the current **Thread**'s ID, uniquely identifying it among all threads. If the **Thread** has not started running or if :ref:`wait_to_finish` has been called, this returns an empty string. @@ -128,7 +128,7 @@ Returns the current **Thread**'s ID, uniquely identifying it among all threads. .. rst-class:: classref-method -:ref:`bool` **is_alive** **(** **)** |const| +:ref:`bool` **is_alive**\ (\ ) |const| Returns ``true`` if this **Thread** is currently running the provided function. This is useful for determining if :ref:`wait_to_finish` can be called without blocking the calling thread. @@ -142,7 +142,7 @@ To check if a **Thread** is joinable, use :ref:`is_started` **is_started** **(** **)** |const| +:ref:`bool` **is_started**\ (\ ) |const| Returns ``true`` if this **Thread** has been started. Once started, this will return ``true`` until it is joined using :ref:`wait_to_finish`. For checking if a **Thread** is still executing its task, use :ref:`is_alive`. @@ -154,7 +154,7 @@ Returns ``true`` if this **Thread** has been started. Once started, this will re .. rst-class:: classref-method -void **set_thread_safety_checks_enabled** **(** :ref:`bool` enabled **)** |static| +|void| **set_thread_safety_checks_enabled**\ (\ enabled\: :ref:`bool`\ ) |static| Sets whether the thread safety checks the engine normally performs in methods of certain classes (e.g., :ref:`Node`) should happen **on the current thread**. @@ -178,7 +178,7 @@ Because of that, there may be cases where the user may want to disable them (``e .. rst-class:: classref-method -:ref:`Error` **start** **(** :ref:`Callable` callable, :ref:`Priority` priority=1 **)** +:ref:`Error` **start**\ (\ callable\: :ref:`Callable`, priority\: :ref:`Priority` = 1\ ) Starts a new **Thread** that calls ``callable``. @@ -196,7 +196,7 @@ Returns :ref:`@GlobalScope.OK` on success, or :r .. rst-class:: classref-method -:ref:`Variant` **wait_to_finish** **(** **)** +:ref:`Variant` **wait_to_finish**\ (\ ) Joins the **Thread** and waits for it to finish. Returns the output of the :ref:`Callable` passed to :ref:`start`. @@ -211,3 +211,4 @@ To determine if this can be called without blocking the calling thread, check if .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_tiledata.rst b/classes/class_tiledata.rst index ef421bc9f7d..be595fb6adf 100644 --- a/classes/class_tiledata.rst +++ b/classes/class_tiledata.rst @@ -61,55 +61,55 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_collision_polygon` **(** :ref:`int` layer_id **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_collision_polygon_one_way_margin` **(** :ref:`int` layer_id, :ref:`int` polygon_index **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`get_collision_polygon_points` **(** :ref:`int` layer_id, :ref:`int` polygon_index **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_collision_polygons_count` **(** :ref:`int` layer_id **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_constant_angular_velocity` **(** :ref:`int` layer_id **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_constant_linear_velocity` **(** :ref:`int` layer_id **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_custom_data` **(** :ref:`String` layer_name **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_custom_data_by_layer_id` **(** :ref:`int` layer_id **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`NavigationPolygon` | :ref:`get_navigation_polygon` **(** :ref:`int` layer_id, :ref:`bool` flip_h=false, :ref:`bool` flip_v=false, :ref:`bool` transpose=false **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`OccluderPolygon2D` | :ref:`get_occluder` **(** :ref:`int` layer_id, :ref:`bool` flip_h=false, :ref:`bool` flip_v=false, :ref:`bool` transpose=false **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_terrain_peering_bit` **(** :ref:`CellNeighbor` peering_bit **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_collision_polygon_one_way` **(** :ref:`int` layer_id, :ref:`int` polygon_index **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_collision_polygon` **(** :ref:`int` layer_id, :ref:`int` polygon_index **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_polygon_one_way` **(** :ref:`int` layer_id, :ref:`int` polygon_index, :ref:`bool` one_way **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_polygon_one_way_margin` **(** :ref:`int` layer_id, :ref:`int` polygon_index, :ref:`float` one_way_margin **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_polygon_points` **(** :ref:`int` layer_id, :ref:`int` polygon_index, :ref:`PackedVector2Array` polygon **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collision_polygons_count` **(** :ref:`int` layer_id, :ref:`int` polygons_count **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_constant_angular_velocity` **(** :ref:`int` layer_id, :ref:`float` velocity **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_constant_linear_velocity` **(** :ref:`int` layer_id, :ref:`Vector2` velocity **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_custom_data` **(** :ref:`String` layer_name, :ref:`Variant` value **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_custom_data_by_layer_id` **(** :ref:`int` layer_id, :ref:`Variant` value **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_navigation_polygon` **(** :ref:`int` layer_id, :ref:`NavigationPolygon` navigation_polygon **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_occluder` **(** :ref:`int` layer_id, :ref:`OccluderPolygon2D` occluder_polygon **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_terrain_peering_bit` **(** :ref:`CellNeighbor` peering_bit, :ref:`int` terrain **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_collision_polygon`\ (\ layer_id\: :ref:`int`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_collision_polygon_one_way_margin`\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`get_collision_polygon_points`\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_collision_polygons_count`\ (\ layer_id\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_constant_angular_velocity`\ (\ layer_id\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_constant_linear_velocity`\ (\ layer_id\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_custom_data`\ (\ layer_name\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_custom_data_by_layer_id`\ (\ layer_id\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`NavigationPolygon` | :ref:`get_navigation_polygon`\ (\ layer_id\: :ref:`int`, flip_h\: :ref:`bool` = false, flip_v\: :ref:`bool` = false, transpose\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`OccluderPolygon2D` | :ref:`get_occluder`\ (\ layer_id\: :ref:`int`, flip_h\: :ref:`bool` = false, flip_v\: :ref:`bool` = false, transpose\: :ref:`bool` = false\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_terrain_peering_bit`\ (\ peering_bit\: :ref:`CellNeighbor`\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_collision_polygon_one_way`\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_collision_polygon`\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_polygon_one_way`\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`, one_way\: :ref:`bool`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_polygon_one_way_margin`\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`, one_way_margin\: :ref:`float`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_polygon_points`\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`, polygon\: :ref:`PackedVector2Array`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collision_polygons_count`\ (\ layer_id\: :ref:`int`, polygons_count\: :ref:`int`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_constant_angular_velocity`\ (\ layer_id\: :ref:`int`, velocity\: :ref:`float`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_constant_linear_velocity`\ (\ layer_id\: :ref:`int`, velocity\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_data`\ (\ layer_name\: :ref:`String`, value\: :ref:`Variant`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_data_by_layer_id`\ (\ layer_id\: :ref:`int`, value\: :ref:`Variant`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_navigation_polygon`\ (\ layer_id\: :ref:`int`, navigation_polygon\: :ref:`NavigationPolygon`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_occluder`\ (\ layer_id\: :ref:`int`, occluder_polygon\: :ref:`OccluderPolygon2D`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_terrain_peering_bit`\ (\ peering_bit\: :ref:`CellNeighbor`, terrain\: :ref:`int`\ ) | + +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -124,7 +124,7 @@ Signals .. rst-class:: classref-signal -**changed** **(** **)** +**changed**\ (\ ) Emitted when any of the properties are changed. @@ -145,8 +145,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_flip_h** **(** :ref:`bool` value **)** -- :ref:`bool` **get_flip_h** **(** **)** +- |void| **set_flip_h**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_flip_h**\ (\ ) If ``true``, the tile will have its texture flipped horizontally. @@ -162,8 +162,8 @@ If ``true``, the tile will have its texture flipped horizontally. .. rst-class:: classref-property-setget -- void **set_flip_v** **(** :ref:`bool` value **)** -- :ref:`bool` **get_flip_v** **(** **)** +- |void| **set_flip_v**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_flip_v**\ (\ ) If ``true``, the tile will have its texture flipped vertically. @@ -179,8 +179,8 @@ If ``true``, the tile will have its texture flipped vertically. .. rst-class:: classref-property-setget -- void **set_material** **(** :ref:`Material` value **)** -- :ref:`Material` **get_material** **(** **)** +- |void| **set_material**\ (\ value\: :ref:`Material`\ ) +- :ref:`Material` **get_material**\ (\ ) The :ref:`Material` to use for this **TileData**. This can be a :ref:`CanvasItemMaterial` to use the default shader, or a :ref:`ShaderMaterial` to use a custom shader. @@ -196,8 +196,8 @@ The :ref:`Material` to use for this **TileData**. This can be a .. rst-class:: classref-property-setget -- void **set_modulate** **(** :ref:`Color` value **)** -- :ref:`Color` **get_modulate** **(** **)** +- |void| **set_modulate**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_modulate**\ (\ ) Color modulation of the tile. @@ -213,8 +213,8 @@ Color modulation of the tile. .. rst-class:: classref-property-setget -- void **set_probability** **(** :ref:`float` value **)** -- :ref:`float` **get_probability** **(** **)** +- |void| **set_probability**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_probability**\ (\ ) Relative probability of this tile being selected when drawing a pattern of random tiles. @@ -230,8 +230,8 @@ Relative probability of this tile being selected when drawing a pattern of rando .. rst-class:: classref-property-setget -- void **set_terrain** **(** :ref:`int` value **)** -- :ref:`int` **get_terrain** **(** **)** +- |void| **set_terrain**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_terrain**\ (\ ) ID of the terrain from the terrain set that the tile uses. @@ -247,8 +247,8 @@ ID of the terrain from the terrain set that the tile uses. .. rst-class:: classref-property-setget -- void **set_terrain_set** **(** :ref:`int` value **)** -- :ref:`int` **get_terrain_set** **(** **)** +- |void| **set_terrain_set**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_terrain_set**\ (\ ) ID of the terrain set that the tile uses. @@ -264,8 +264,8 @@ ID of the terrain set that the tile uses. .. rst-class:: classref-property-setget -- void **set_texture_origin** **(** :ref:`Vector2i` value **)** -- :ref:`Vector2i` **get_texture_origin** **(** **)** +- |void| **set_texture_origin**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_texture_origin**\ (\ ) Offsets the position of where the tile is drawn. @@ -281,8 +281,8 @@ Offsets the position of where the tile is drawn. .. rst-class:: classref-property-setget -- void **set_transpose** **(** :ref:`bool` value **)** -- :ref:`bool` **get_transpose** **(** **)** +- |void| **set_transpose**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_transpose**\ (\ ) If ``true``, the tile will display transposed, i.e. with horizontal and vertical texture UVs swapped. @@ -298,8 +298,8 @@ If ``true``, the tile will display transposed, i.e. with horizontal and vertical .. rst-class:: classref-property-setget -- void **set_y_sort_origin** **(** :ref:`int` value **)** -- :ref:`int` **get_y_sort_origin** **(** **)** +- |void| **set_y_sort_origin**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_y_sort_origin**\ (\ ) Vertical point of the tile used for determining y-sorted order. @@ -315,8 +315,8 @@ Vertical point of the tile used for determining y-sorted order. .. rst-class:: classref-property-setget -- void **set_z_index** **(** :ref:`int` value **)** -- :ref:`int` **get_z_index** **(** **)** +- |void| **set_z_index**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_z_index**\ (\ ) Ordering index of this tile, relative to :ref:`TileMap`. @@ -333,7 +333,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_collision_polygon** **(** :ref:`int` layer_id **)** +|void| **add_collision_polygon**\ (\ layer_id\: :ref:`int`\ ) Adds a collision polygon to the tile on the given TileSet physics layer. @@ -345,7 +345,7 @@ Adds a collision polygon to the tile on the given TileSet physics layer. .. rst-class:: classref-method -:ref:`float` **get_collision_polygon_one_way_margin** **(** :ref:`int` layer_id, :ref:`int` polygon_index **)** |const| +:ref:`float` **get_collision_polygon_one_way_margin**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`\ ) |const| Returns the one-way margin (for one-way platforms) of the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. @@ -357,7 +357,7 @@ Returns the one-way margin (for one-way platforms) of the polygon at index ``pol .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_collision_polygon_points** **(** :ref:`int` layer_id, :ref:`int` polygon_index **)** |const| +:ref:`PackedVector2Array` **get_collision_polygon_points**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`\ ) |const| Returns the points of the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. @@ -369,7 +369,7 @@ Returns the points of the polygon at index ``polygon_index`` for TileSet physics .. rst-class:: classref-method -:ref:`int` **get_collision_polygons_count** **(** :ref:`int` layer_id **)** |const| +:ref:`int` **get_collision_polygons_count**\ (\ layer_id\: :ref:`int`\ ) |const| Returns how many polygons the tile has for TileSet physics layer with index ``layer_id``. @@ -381,7 +381,7 @@ Returns how many polygons the tile has for TileSet physics layer with index ``la .. rst-class:: classref-method -:ref:`float` **get_constant_angular_velocity** **(** :ref:`int` layer_id **)** |const| +:ref:`float` **get_constant_angular_velocity**\ (\ layer_id\: :ref:`int`\ ) |const| Returns the constant angular velocity applied to objects colliding with this tile. @@ -393,7 +393,7 @@ Returns the constant angular velocity applied to objects colliding with this til .. rst-class:: classref-method -:ref:`Vector2` **get_constant_linear_velocity** **(** :ref:`int` layer_id **)** |const| +:ref:`Vector2` **get_constant_linear_velocity**\ (\ layer_id\: :ref:`int`\ ) |const| Returns the constant linear velocity applied to objects colliding with this tile. @@ -405,7 +405,7 @@ Returns the constant linear velocity applied to objects colliding with this tile .. rst-class:: classref-method -:ref:`Variant` **get_custom_data** **(** :ref:`String` layer_name **)** |const| +:ref:`Variant` **get_custom_data**\ (\ layer_name\: :ref:`String`\ ) |const| Returns the custom data value for custom data layer named ``layer_name``. @@ -417,7 +417,7 @@ Returns the custom data value for custom data layer named ``layer_name``. .. rst-class:: classref-method -:ref:`Variant` **get_custom_data_by_layer_id** **(** :ref:`int` layer_id **)** |const| +:ref:`Variant` **get_custom_data_by_layer_id**\ (\ layer_id\: :ref:`int`\ ) |const| Returns the custom data value for custom data layer with index ``layer_id``. @@ -429,7 +429,7 @@ Returns the custom data value for custom data layer with index ``layer_id``. .. rst-class:: classref-method -:ref:`NavigationPolygon` **get_navigation_polygon** **(** :ref:`int` layer_id, :ref:`bool` flip_h=false, :ref:`bool` flip_v=false, :ref:`bool` transpose=false **)** |const| +:ref:`NavigationPolygon` **get_navigation_polygon**\ (\ layer_id\: :ref:`int`, flip_h\: :ref:`bool` = false, flip_v\: :ref:`bool` = false, transpose\: :ref:`bool` = false\ ) |const| Returns the navigation polygon of the tile for the TileSet navigation layer with index ``layer_id``. @@ -443,7 +443,7 @@ Returns the navigation polygon of the tile for the TileSet navigation layer with .. rst-class:: classref-method -:ref:`OccluderPolygon2D` **get_occluder** **(** :ref:`int` layer_id, :ref:`bool` flip_h=false, :ref:`bool` flip_v=false, :ref:`bool` transpose=false **)** |const| +:ref:`OccluderPolygon2D` **get_occluder**\ (\ layer_id\: :ref:`int`, flip_h\: :ref:`bool` = false, flip_v\: :ref:`bool` = false, transpose\: :ref:`bool` = false\ ) |const| Returns the occluder polygon of the tile for the TileSet occlusion layer with index ``layer_id``. @@ -457,7 +457,7 @@ Returns the occluder polygon of the tile for the TileSet occlusion layer with in .. rst-class:: classref-method -:ref:`int` **get_terrain_peering_bit** **(** :ref:`CellNeighbor` peering_bit **)** |const| +:ref:`int` **get_terrain_peering_bit**\ (\ peering_bit\: :ref:`CellNeighbor`\ ) |const| Returns the tile's terrain bit for the given ``peering_bit`` direction. @@ -469,7 +469,7 @@ Returns the tile's terrain bit for the given ``peering_bit`` direction. .. rst-class:: classref-method -:ref:`bool` **is_collision_polygon_one_way** **(** :ref:`int` layer_id, :ref:`int` polygon_index **)** |const| +:ref:`bool` **is_collision_polygon_one_way**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`\ ) |const| Returns whether one-way collisions are enabled for the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. @@ -481,7 +481,7 @@ Returns whether one-way collisions are enabled for the polygon at index ``polygo .. rst-class:: classref-method -void **remove_collision_polygon** **(** :ref:`int` layer_id, :ref:`int` polygon_index **)** +|void| **remove_collision_polygon**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`\ ) Removes the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. @@ -493,7 +493,7 @@ Removes the polygon at index ``polygon_index`` for TileSet physics layer with in .. rst-class:: classref-method -void **set_collision_polygon_one_way** **(** :ref:`int` layer_id, :ref:`int` polygon_index, :ref:`bool` one_way **)** +|void| **set_collision_polygon_one_way**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`, one_way\: :ref:`bool`\ ) Enables/disables one-way collisions on the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. @@ -505,7 +505,7 @@ Enables/disables one-way collisions on the polygon at index ``polygon_index`` fo .. rst-class:: classref-method -void **set_collision_polygon_one_way_margin** **(** :ref:`int` layer_id, :ref:`int` polygon_index, :ref:`float` one_way_margin **)** +|void| **set_collision_polygon_one_way_margin**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`, one_way_margin\: :ref:`float`\ ) Enables/disables one-way collisions on the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. @@ -517,7 +517,7 @@ Enables/disables one-way collisions on the polygon at index ``polygon_index`` fo .. rst-class:: classref-method -void **set_collision_polygon_points** **(** :ref:`int` layer_id, :ref:`int` polygon_index, :ref:`PackedVector2Array` polygon **)** +|void| **set_collision_polygon_points**\ (\ layer_id\: :ref:`int`, polygon_index\: :ref:`int`, polygon\: :ref:`PackedVector2Array`\ ) Sets the points of the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. @@ -529,7 +529,7 @@ Sets the points of the polygon at index ``polygon_index`` for TileSet physics la .. rst-class:: classref-method -void **set_collision_polygons_count** **(** :ref:`int` layer_id, :ref:`int` polygons_count **)** +|void| **set_collision_polygons_count**\ (\ layer_id\: :ref:`int`, polygons_count\: :ref:`int`\ ) Sets the polygons count for TileSet physics layer with index ``layer_id``. @@ -541,7 +541,7 @@ Sets the polygons count for TileSet physics layer with index ``layer_id``. .. rst-class:: classref-method -void **set_constant_angular_velocity** **(** :ref:`int` layer_id, :ref:`float` velocity **)** +|void| **set_constant_angular_velocity**\ (\ layer_id\: :ref:`int`, velocity\: :ref:`float`\ ) Sets the constant angular velocity. This does not rotate the tile. This angular velocity is applied to objects colliding with this tile. @@ -553,7 +553,7 @@ Sets the constant angular velocity. This does not rotate the tile. This angular .. rst-class:: classref-method -void **set_constant_linear_velocity** **(** :ref:`int` layer_id, :ref:`Vector2` velocity **)** +|void| **set_constant_linear_velocity**\ (\ layer_id\: :ref:`int`, velocity\: :ref:`Vector2`\ ) Sets the constant linear velocity. This does not move the tile. This linear velocity is applied to objects colliding with this tile. This is useful to create conveyor belts. @@ -565,7 +565,7 @@ Sets the constant linear velocity. This does not move the tile. This linear velo .. rst-class:: classref-method -void **set_custom_data** **(** :ref:`String` layer_name, :ref:`Variant` value **)** +|void| **set_custom_data**\ (\ layer_name\: :ref:`String`, value\: :ref:`Variant`\ ) Sets the tile's custom data value for the TileSet custom data layer with name ``layer_name``. @@ -577,7 +577,7 @@ Sets the tile's custom data value for the TileSet custom data layer with name `` .. rst-class:: classref-method -void **set_custom_data_by_layer_id** **(** :ref:`int` layer_id, :ref:`Variant` value **)** +|void| **set_custom_data_by_layer_id**\ (\ layer_id\: :ref:`int`, value\: :ref:`Variant`\ ) Sets the tile's custom data value for the TileSet custom data layer with index ``layer_id``. @@ -589,7 +589,7 @@ Sets the tile's custom data value for the TileSet custom data layer with index ` .. rst-class:: classref-method -void **set_navigation_polygon** **(** :ref:`int` layer_id, :ref:`NavigationPolygon` navigation_polygon **)** +|void| **set_navigation_polygon**\ (\ layer_id\: :ref:`int`, navigation_polygon\: :ref:`NavigationPolygon`\ ) Sets the navigation polygon for the TileSet navigation layer with index ``layer_id``. @@ -601,7 +601,7 @@ Sets the navigation polygon for the TileSet navigation layer with index ``layer_ .. rst-class:: classref-method -void **set_occluder** **(** :ref:`int` layer_id, :ref:`OccluderPolygon2D` occluder_polygon **)** +|void| **set_occluder**\ (\ layer_id\: :ref:`int`, occluder_polygon\: :ref:`OccluderPolygon2D`\ ) Sets the occluder for the TileSet occlusion layer with index ``layer_id``. @@ -613,7 +613,7 @@ Sets the occluder for the TileSet occlusion layer with index ``layer_id``. .. rst-class:: classref-method -void **set_terrain_peering_bit** **(** :ref:`CellNeighbor` peering_bit, :ref:`int` terrain **)** +|void| **set_terrain_peering_bit**\ (\ peering_bit\: :ref:`CellNeighbor`, terrain\: :ref:`int`\ ) Sets the tile's terrain bit for the given ``peering_bit`` direction. @@ -624,3 +624,4 @@ Sets the tile's terrain bit for the given ``peering_bit`` direction. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 35567f0eebb..7e3ae7f1af1 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: gridmap + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -70,107 +73,107 @@ Methods .. table:: :widths: auto - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_tile_data_runtime_update` **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`TileData` tile_data **)** |virtual| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_use_tile_data_runtime_update` **(** :ref:`int` layer, :ref:`Vector2i` coords **)** |virtual| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_layer` **(** :ref:`int` to_position **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_layer` **(** :ref:`int` layer **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`erase_cell` **(** :ref:`int` layer, :ref:`Vector2i` coords **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`fix_invalid_tiles` **(** **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`force_update` **(** :ref:`int` layer=-1 **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_cell_alternative_tile` **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`bool` use_proxies=false **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_cell_atlas_coords` **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`bool` use_proxies=false **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_cell_source_id` **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`bool` use_proxies=false **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TileData` | :ref:`get_cell_tile_data` **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`bool` use_proxies=false **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_coords_for_body_rid` **(** :ref:`RID` body **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_layer_for_body_rid` **(** :ref:`RID` body **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_layer_modulate` **(** :ref:`int` layer **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_layer_name` **(** :ref:`int` layer **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_layer_navigation_map` **(** :ref:`int` layer **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_layer_y_sort_origin` **(** :ref:`int` layer **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_layer_z_index` **(** :ref:`int` layer **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_layers_count` **(** **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_navigation_map` **(** :ref:`int` layer **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_neighbor_cell` **(** :ref:`Vector2i` coords, :ref:`CellNeighbor` neighbor **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TileMapPattern` | :ref:`get_pattern` **(** :ref:`int` layer, :ref:`Vector2i[]` coords_array **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i[]` | :ref:`get_surrounding_cells` **(** :ref:`Vector2i` coords **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i[]` | :ref:`get_used_cells` **(** :ref:`int` layer **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i[]` | :ref:`get_used_cells_by_id` **(** :ref:`int` layer, :ref:`int` source_id=-1, :ref:`Vector2i` atlas_coords=Vector2i(-1, -1), :ref:`int` alternative_tile=-1 **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`get_used_rect` **(** **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_layer_enabled` **(** :ref:`int` layer **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_layer_navigation_enabled` **(** :ref:`int` layer **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_layer_y_sort_enabled` **(** :ref:`int` layer **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`local_to_map` **(** :ref:`Vector2` local_position **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`map_pattern` **(** :ref:`Vector2i` position_in_tilemap, :ref:`Vector2i` coords_in_pattern, :ref:`TileMapPattern` pattern **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`map_to_local` **(** :ref:`Vector2i` map_position **)** |const| | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_layer` **(** :ref:`int` layer, :ref:`int` to_position **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`notify_runtime_tile_data_update` **(** :ref:`int` layer=-1 **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_layer` **(** :ref:`int` layer **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cell` **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`int` source_id=-1, :ref:`Vector2i` atlas_coords=Vector2i(-1, -1), :ref:`int` alternative_tile=0 **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cells_terrain_connect` **(** :ref:`int` layer, :ref:`Vector2i[]` cells, :ref:`int` terrain_set, :ref:`int` terrain, :ref:`bool` ignore_empty_terrains=true **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cells_terrain_path` **(** :ref:`int` layer, :ref:`Vector2i[]` path, :ref:`int` terrain_set, :ref:`int` terrain, :ref:`bool` ignore_empty_terrains=true **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_layer_enabled` **(** :ref:`int` layer, :ref:`bool` enabled **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_layer_modulate` **(** :ref:`int` layer, :ref:`Color` modulate **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_layer_name` **(** :ref:`int` layer, :ref:`String` name **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_layer_navigation_enabled` **(** :ref:`int` layer, :ref:`bool` enabled **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_layer_navigation_map` **(** :ref:`int` layer, :ref:`RID` map **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_layer_y_sort_enabled` **(** :ref:`int` layer, :ref:`bool` y_sort_enabled **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_layer_y_sort_origin` **(** :ref:`int` layer, :ref:`int` y_sort_origin **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_layer_z_index` **(** :ref:`int` layer, :ref:`int` z_index **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_navigation_map` **(** :ref:`int` layer, :ref:`RID` map **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_pattern` **(** :ref:`int` layer, :ref:`Vector2i` position, :ref:`TileMapPattern` pattern **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`update_internals` **(** **)** | - +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_tile_data_runtime_update`\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, tile_data\: :ref:`TileData`\ ) |virtual| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_use_tile_data_runtime_update`\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`\ ) |virtual| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_layer`\ (\ to_position\: :ref:`int`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_layer`\ (\ layer\: :ref:`int`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`erase_cell`\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fix_invalid_tiles`\ (\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_update`\ (\ layer\: :ref:`int` = -1\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_cell_alternative_tile`\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, use_proxies\: :ref:`bool` = false\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_cell_atlas_coords`\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, use_proxies\: :ref:`bool` = false\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_cell_source_id`\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, use_proxies\: :ref:`bool` = false\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TileData` | :ref:`get_cell_tile_data`\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, use_proxies\: :ref:`bool` = false\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_coords_for_body_rid`\ (\ body\: :ref:`RID`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_layer_for_body_rid`\ (\ body\: :ref:`RID`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_layer_modulate`\ (\ layer\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_layer_name`\ (\ layer\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_layer_navigation_map`\ (\ layer\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_layer_y_sort_origin`\ (\ layer\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_layer_z_index`\ (\ layer\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_layers_count`\ (\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_navigation_map`\ (\ layer\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_neighbor_cell`\ (\ coords\: :ref:`Vector2i`, neighbor\: :ref:`CellNeighbor`\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TileMapPattern` | :ref:`get_pattern`\ (\ layer\: :ref:`int`, coords_array\: :ref:`Array`\[:ref:`Vector2i`\]\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`get_surrounding_cells`\ (\ coords\: :ref:`Vector2i`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`get_used_cells`\ (\ layer\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`get_used_cells_by_id`\ (\ layer\: :ref:`int`, source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = -1\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`get_used_rect`\ (\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_layer_enabled`\ (\ layer\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_layer_navigation_enabled`\ (\ layer\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_layer_y_sort_enabled`\ (\ layer\: :ref:`int`\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`local_to_map`\ (\ local_position\: :ref:`Vector2`\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`map_pattern`\ (\ position_in_tilemap\: :ref:`Vector2i`, coords_in_pattern\: :ref:`Vector2i`, pattern\: :ref:`TileMapPattern`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`map_to_local`\ (\ map_position\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_layer`\ (\ layer\: :ref:`int`, to_position\: :ref:`int`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`notify_runtime_tile_data_update`\ (\ layer\: :ref:`int` = -1\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_layer`\ (\ layer\: :ref:`int`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cell`\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = 0\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cells_terrain_connect`\ (\ layer\: :ref:`int`, cells\: :ref:`Array`\[:ref:`Vector2i`\], terrain_set\: :ref:`int`, terrain\: :ref:`int`, ignore_empty_terrains\: :ref:`bool` = true\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cells_terrain_path`\ (\ layer\: :ref:`int`, path\: :ref:`Array`\[:ref:`Vector2i`\], terrain_set\: :ref:`int`, terrain\: :ref:`int`, ignore_empty_terrains\: :ref:`bool` = true\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_layer_enabled`\ (\ layer\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_layer_modulate`\ (\ layer\: :ref:`int`, modulate\: :ref:`Color`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_layer_name`\ (\ layer\: :ref:`int`, name\: :ref:`String`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_layer_navigation_enabled`\ (\ layer\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_layer_navigation_map`\ (\ layer\: :ref:`int`, map\: :ref:`RID`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_layer_y_sort_enabled`\ (\ layer\: :ref:`int`, y_sort_enabled\: :ref:`bool`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_layer_y_sort_origin`\ (\ layer\: :ref:`int`, y_sort_origin\: :ref:`int`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_layer_z_index`\ (\ layer\: :ref:`int`, z_index\: :ref:`int`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_navigation_map`\ (\ layer\: :ref:`int`, map\: :ref:`RID`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_pattern`\ (\ layer\: :ref:`int`, position\: :ref:`Vector2i`, pattern\: :ref:`TileMapPattern`\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update_internals`\ (\ ) | + +--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -185,7 +188,7 @@ Signals .. rst-class:: classref-signal -**changed** **(** **)** +**changed**\ (\ ) Emitted when the :ref:`TileSet` of this TileMap changes. @@ -245,8 +248,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_collision_animatable** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collision_animatable** **(** **)** +- |void| **set_collision_animatable**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collision_animatable**\ (\ ) If enabled, the TileMap will see its collisions synced to the physics tick and change its collision type from static to kinematic. This is required to create TileMap-based moving platform. @@ -264,8 +267,8 @@ If enabled, the TileMap will see its collisions synced to the physics tick and c .. rst-class:: classref-property-setget -- void **set_collision_visibility_mode** **(** :ref:`VisibilityMode` value **)** -- :ref:`VisibilityMode` **get_collision_visibility_mode** **(** **)** +- |void| **set_collision_visibility_mode**\ (\ value\: :ref:`VisibilityMode`\ ) +- :ref:`VisibilityMode` **get_collision_visibility_mode**\ (\ ) Show or hide the TileMap's collision shapes. If set to :ref:`VISIBILITY_MODE_DEFAULT`, this depends on the show collision debug settings. @@ -281,8 +284,8 @@ Show or hide the TileMap's collision shapes. If set to :ref:`VISIBILITY_MODE_DEF .. rst-class:: classref-property-setget -- void **set_navigation_visibility_mode** **(** :ref:`VisibilityMode` value **)** -- :ref:`VisibilityMode` **get_navigation_visibility_mode** **(** **)** +- |void| **set_navigation_visibility_mode**\ (\ value\: :ref:`VisibilityMode`\ ) +- :ref:`VisibilityMode` **get_navigation_visibility_mode**\ (\ ) Show or hide the TileMap's navigation meshes. If set to :ref:`VISIBILITY_MODE_DEFAULT`, this depends on the show navigation debug settings. @@ -298,8 +301,8 @@ Show or hide the TileMap's navigation meshes. If set to :ref:`VISIBILITY_MODE_DE .. rst-class:: classref-property-setget -- void **set_rendering_quadrant_size** **(** :ref:`int` value **)** -- :ref:`int` **get_rendering_quadrant_size** **(** **)** +- |void| **set_rendering_quadrant_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_rendering_quadrant_size**\ (\ ) The TileMap's quadrant size. A quadrant is a group of tiles to be drawn together on a single canvas item, for optimization purposes. :ref:`rendering_quadrant_size` defines the length of a square's side, in the map's coordinate system, that forms the quadrant. Thus, the default quandrant size groups together ``16 * 16 = 256`` tiles. @@ -320,7 +323,7 @@ Method Descriptions .. rst-class:: classref-method -void **_tile_data_runtime_update** **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`TileData` tile_data **)** |virtual| +|void| **_tile_data_runtime_update**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, tile_data\: :ref:`TileData`\ ) |virtual| Called with a TileData object about to be used internally by the TileMap, allowing its modification at runtime. @@ -338,7 +341,7 @@ This method is only called if :ref:`_use_tile_data_runtime_update` **_use_tile_data_runtime_update** **(** :ref:`int` layer, :ref:`Vector2i` coords **)** |virtual| +:ref:`bool` **_use_tile_data_runtime_update**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`\ ) |virtual| Should return ``true`` if the tile at coordinates ``coords`` on layer ``layer`` requires a runtime update. @@ -354,7 +357,7 @@ Should return ``true`` if the tile at coordinates ``coords`` on layer ``layer`` .. rst-class:: classref-method -void **add_layer** **(** :ref:`int` to_position **)** +|void| **add_layer**\ (\ to_position\: :ref:`int`\ ) Adds a layer at the given position ``to_position`` in the array. If ``to_position`` is negative, the position is counted from the end, with ``-1`` adding the layer at the end of the array. @@ -366,7 +369,7 @@ Adds a layer at the given position ``to_position`` in the array. If ``to_positio .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears all cells. @@ -378,7 +381,7 @@ Clears all cells. .. rst-class:: classref-method -void **clear_layer** **(** :ref:`int` layer **)** +|void| **clear_layer**\ (\ layer\: :ref:`int`\ ) Clears all cells on the given layer. @@ -392,7 +395,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -void **erase_cell** **(** :ref:`int` layer, :ref:`Vector2i` coords **)** +|void| **erase_cell**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`\ ) Erases the cell on layer ``layer`` at coordinates ``coords``. @@ -406,7 +409,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -void **fix_invalid_tiles** **(** **)** +|void| **fix_invalid_tiles**\ (\ ) Clears cells that do not exist in the tileset. @@ -418,13 +421,11 @@ Clears cells that do not exist in the tileset. .. rst-class:: classref-method -void **force_update** **(** :ref:`int` layer=-1 **)** +|void| **force_update**\ (\ layer\: :ref:`int` = -1\ ) **Deprecated:** Use :ref:`notify_runtime_tile_data_update` and/or :ref:`update_internals` instead. -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Forces the TileMap and the layer ``layer`` to update. .. rst-class:: classref-item-separator @@ -434,7 +435,7 @@ void **force_update** **(** :ref:`int` layer=-1 **)** .. rst-class:: classref-method -:ref:`int` **get_cell_alternative_tile** **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`bool` use_proxies=false **)** |const| +:ref:`int` **get_cell_alternative_tile**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, use_proxies\: :ref:`bool` = false\ ) |const| Returns the tile alternative ID of the cell on layer ``layer`` at ``coords``. If ``use_proxies`` is ``false``, ignores the :ref:`TileSet`'s tile proxies, returning the raw alternative identifier. See :ref:`TileSet.map_tile_proxy`. @@ -448,7 +449,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`Vector2i` **get_cell_atlas_coords** **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`bool` use_proxies=false **)** |const| +:ref:`Vector2i` **get_cell_atlas_coords**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, use_proxies\: :ref:`bool` = false\ ) |const| Returns the tile atlas coordinates ID of the cell on layer ``layer`` at coordinates ``coords``. If ``use_proxies`` is ``false``, ignores the :ref:`TileSet`'s tile proxies, returning the raw alternative identifier. See :ref:`TileSet.map_tile_proxy`. @@ -462,7 +463,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`int` **get_cell_source_id** **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`bool` use_proxies=false **)** |const| +:ref:`int` **get_cell_source_id**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, use_proxies\: :ref:`bool` = false\ ) |const| Returns the tile source ID of the cell on layer ``layer`` at coordinates ``coords``. Returns ``-1`` if the cell does not exist. @@ -478,7 +479,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`TileData` **get_cell_tile_data** **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`bool` use_proxies=false **)** |const| +:ref:`TileData` **get_cell_tile_data**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, use_proxies\: :ref:`bool` = false\ ) |const| Returns the :ref:`TileData` object associated with the given cell, or ``null`` if the cell does not exist or is not a :ref:`TileSetAtlasSource`. @@ -504,7 +505,7 @@ If ``use_proxies`` is ``false``, ignores the :ref:`TileSet`'s til .. rst-class:: classref-method -:ref:`Vector2i` **get_coords_for_body_rid** **(** :ref:`RID` body **)** +:ref:`Vector2i` **get_coords_for_body_rid**\ (\ body\: :ref:`RID`\ ) Returns the coordinates of the tile for given physics body RID. Such RID can be retrieved from :ref:`KinematicCollision2D.get_collider_rid`, when colliding with a tile. @@ -516,7 +517,7 @@ Returns the coordinates of the tile for given physics body RID. Such RID can be .. rst-class:: classref-method -:ref:`int` **get_layer_for_body_rid** **(** :ref:`RID` body **)** +:ref:`int` **get_layer_for_body_rid**\ (\ body\: :ref:`RID`\ ) Returns the tilemap layer of the tile for given physics body RID. Such RID can be retrieved from :ref:`KinematicCollision2D.get_collider_rid`, when colliding with a tile. @@ -528,7 +529,7 @@ Returns the tilemap layer of the tile for given physics body RID. Such RID can b .. rst-class:: classref-method -:ref:`Color` **get_layer_modulate** **(** :ref:`int` layer **)** |const| +:ref:`Color` **get_layer_modulate**\ (\ layer\: :ref:`int`\ ) |const| Returns a TileMap layer's modulate. @@ -542,7 +543,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`String` **get_layer_name** **(** :ref:`int` layer **)** |const| +:ref:`String` **get_layer_name**\ (\ layer\: :ref:`int`\ ) |const| Returns a TileMap layer's name. @@ -556,9 +557,9 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`RID` **get_layer_navigation_map** **(** :ref:`int` layer **)** |const| +:ref:`RID` **get_layer_navigation_map**\ (\ layer\: :ref:`int`\ ) |const| -Returns the :ref:`NavigationServer2D` navigation map :ref:`RID` currently assigned to the specified TileMap ``layer``. +Returns the :ref:`RID` of the :ref:`NavigationServer2D` navigation map assigned to the specified TileMap layer ``layer``. By default the TileMap uses the default :ref:`World2D` navigation map for the first TileMap layer. For each additional TileMap layer a new navigation map is created for the additional layer. @@ -574,7 +575,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`int` **get_layer_y_sort_origin** **(** :ref:`int` layer **)** |const| +:ref:`int` **get_layer_y_sort_origin**\ (\ layer\: :ref:`int`\ ) |const| Returns a TileMap layer's Y sort origin. @@ -588,7 +589,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`int` **get_layer_z_index** **(** :ref:`int` layer **)** |const| +:ref:`int` **get_layer_z_index**\ (\ layer\: :ref:`int`\ ) |const| Returns a TileMap layer's Z-index value. @@ -602,7 +603,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`int` **get_layers_count** **(** **)** |const| +:ref:`int` **get_layers_count**\ (\ ) |const| Returns the number of layers in the TileMap. @@ -614,11 +615,11 @@ Returns the number of layers in the TileMap. .. rst-class:: classref-method -:ref:`RID` **get_navigation_map** **(** :ref:`int` layer **)** |const| +:ref:`RID` **get_navigation_map**\ (\ layer\: :ref:`int`\ ) |const| -**Deprecated:** This method may be changed or removed in future versions. +**Deprecated:** Use :ref:`get_layer_navigation_map` instead. -See :ref:`get_layer_navigation_map`. +Returns the :ref:`RID` of the :ref:`NavigationServer2D` navigation map assigned to the specified TileMap layer ``layer``. .. rst-class:: classref-item-separator @@ -628,7 +629,7 @@ See :ref:`get_layer_navigation_map` **get_neighbor_cell** **(** :ref:`Vector2i` coords, :ref:`CellNeighbor` neighbor **)** |const| +:ref:`Vector2i` **get_neighbor_cell**\ (\ coords\: :ref:`Vector2i`, neighbor\: :ref:`CellNeighbor`\ ) |const| Returns the neighboring cell to the one at coordinates ``coords``, identified by the ``neighbor`` direction. This method takes into account the different layouts a TileMap can take. @@ -640,7 +641,7 @@ Returns the neighboring cell to the one at coordinates ``coords``, identified by .. rst-class:: classref-method -:ref:`TileMapPattern` **get_pattern** **(** :ref:`int` layer, :ref:`Vector2i[]` coords_array **)** +:ref:`TileMapPattern` **get_pattern**\ (\ layer\: :ref:`int`, coords_array\: :ref:`Array`\[:ref:`Vector2i`\]\ ) Creates a new :ref:`TileMapPattern` from the given layer and set of cells. @@ -654,7 +655,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`Vector2i[]` **get_surrounding_cells** **(** :ref:`Vector2i` coords **)** +:ref:`Array`\[:ref:`Vector2i`\] **get_surrounding_cells**\ (\ coords\: :ref:`Vector2i`\ ) Returns the list of all neighbourings cells to the one at ``coords``. @@ -666,7 +667,7 @@ Returns the list of all neighbourings cells to the one at ``coords``. .. rst-class:: classref-method -:ref:`Vector2i[]` **get_used_cells** **(** :ref:`int` layer **)** |const| +:ref:`Array`\[:ref:`Vector2i`\] **get_used_cells**\ (\ layer\: :ref:`int`\ ) |const| Returns a :ref:`Vector2i` array with the positions of all cells containing a tile in the given layer. A cell is considered empty if its source identifier equals -1, its atlas coordinates identifiers is ``Vector2(-1, -1)`` and its alternative identifier is -1. @@ -680,7 +681,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`Vector2i[]` **get_used_cells_by_id** **(** :ref:`int` layer, :ref:`int` source_id=-1, :ref:`Vector2i` atlas_coords=Vector2i(-1, -1), :ref:`int` alternative_tile=-1 **)** |const| +:ref:`Array`\[:ref:`Vector2i`\] **get_used_cells_by_id**\ (\ layer\: :ref:`int`, source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = -1\ ) |const| Returns a :ref:`Vector2i` array with the positions of all cells containing a tile in the given layer. Tiles may be filtered according to their source (``source_id``), their atlas coordinates (``atlas_coords``) or alternative id (``alternative_tile``). @@ -698,7 +699,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`Rect2i` **get_used_rect** **(** **)** |const| +:ref:`Rect2i` **get_used_rect**\ (\ ) |const| Returns a rectangle enclosing the used (non-empty) tiles of the map, including all layers. @@ -710,7 +711,7 @@ Returns a rectangle enclosing the used (non-empty) tiles of the map, including a .. rst-class:: classref-method -:ref:`bool` **is_layer_enabled** **(** :ref:`int` layer **)** |const| +:ref:`bool` **is_layer_enabled**\ (\ layer\: :ref:`int`\ ) |const| Returns if a layer is enabled. @@ -724,7 +725,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`bool` **is_layer_navigation_enabled** **(** :ref:`int` layer **)** |const| +:ref:`bool` **is_layer_navigation_enabled**\ (\ layer\: :ref:`int`\ ) |const| Returns if a layer's built-in navigation regions generation is enabled. @@ -736,7 +737,7 @@ Returns if a layer's built-in navigation regions generation is enabled. .. rst-class:: classref-method -:ref:`bool` **is_layer_y_sort_enabled** **(** :ref:`int` layer **)** |const| +:ref:`bool` **is_layer_y_sort_enabled**\ (\ layer\: :ref:`int`\ ) |const| Returns if a layer Y-sorts its tiles. @@ -750,7 +751,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -:ref:`Vector2i` **local_to_map** **(** :ref:`Vector2` local_position **)** |const| +:ref:`Vector2i` **local_to_map**\ (\ local_position\: :ref:`Vector2`\ ) |const| Returns the map coordinates of the cell containing the given ``local_position``. If ``local_position`` is in global coordinates, consider using :ref:`Node2D.to_local` before passing it to this method. See also :ref:`map_to_local`. @@ -762,7 +763,7 @@ Returns the map coordinates of the cell containing the given ``local_position``. .. rst-class:: classref-method -:ref:`Vector2i` **map_pattern** **(** :ref:`Vector2i` position_in_tilemap, :ref:`Vector2i` coords_in_pattern, :ref:`TileMapPattern` pattern **)** +:ref:`Vector2i` **map_pattern**\ (\ position_in_tilemap\: :ref:`Vector2i`, coords_in_pattern\: :ref:`Vector2i`, pattern\: :ref:`TileMapPattern`\ ) Returns for the given coordinate ``coords_in_pattern`` in a :ref:`TileMapPattern` the corresponding cell coordinates if the pattern was pasted at the ``position_in_tilemap`` coordinates (see :ref:`set_pattern`). This mapping is required as in half-offset tile shapes, the mapping might not work by calculating ``position_in_tile_map + coords_in_pattern``. @@ -774,7 +775,7 @@ Returns for the given coordinate ``coords_in_pattern`` in a :ref:`TileMapPattern .. rst-class:: classref-method -:ref:`Vector2` **map_to_local** **(** :ref:`Vector2i` map_position **)** |const| +:ref:`Vector2` **map_to_local**\ (\ map_position\: :ref:`Vector2i`\ ) |const| Returns the centered position of a cell in the TileMap's local coordinate space. To convert the returned value into global coordinates, use :ref:`Node2D.to_global`. See also :ref:`local_to_map`. @@ -788,7 +789,7 @@ Returns the centered position of a cell in the TileMap's local coordinate space. .. rst-class:: classref-method -void **move_layer** **(** :ref:`int` layer, :ref:`int` to_position **)** +|void| **move_layer**\ (\ layer\: :ref:`int`, to_position\: :ref:`int`\ ) Moves the layer at index ``layer`` to the given position ``to_position`` in the array. @@ -800,7 +801,7 @@ Moves the layer at index ``layer`` to the given position ``to_position`` in the .. rst-class:: classref-method -void **notify_runtime_tile_data_update** **(** :ref:`int` layer=-1 **)** +|void| **notify_runtime_tile_data_update**\ (\ layer\: :ref:`int` = -1\ ) Notifies the TileMap node that calls to :ref:`_use_tile_data_runtime_update` or :ref:`_tile_data_runtime_update` will lead to different results. This will thus trigger a TileMap update. @@ -818,7 +819,7 @@ If ``layer`` is provided, only notifies changes for the given layer. Providing t .. rst-class:: classref-method -void **remove_layer** **(** :ref:`int` layer **)** +|void| **remove_layer**\ (\ layer\: :ref:`int`\ ) Removes the layer at index ``layer``. @@ -830,7 +831,7 @@ Removes the layer at index ``layer``. .. rst-class:: classref-method -void **set_cell** **(** :ref:`int` layer, :ref:`Vector2i` coords, :ref:`int` source_id=-1, :ref:`Vector2i` atlas_coords=Vector2i(-1, -1), :ref:`int` alternative_tile=0 **)** +|void| **set_cell**\ (\ layer\: :ref:`int`, coords\: :ref:`Vector2i`, source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = 0\ ) Sets the tile identifiers for the cell on layer ``layer`` at coordinates ``coords``. Each tile of the :ref:`TileSet` is identified using three parts: @@ -852,7 +853,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -void **set_cells_terrain_connect** **(** :ref:`int` layer, :ref:`Vector2i[]` cells, :ref:`int` terrain_set, :ref:`int` terrain, :ref:`bool` ignore_empty_terrains=true **)** +|void| **set_cells_terrain_connect**\ (\ layer\: :ref:`int`, cells\: :ref:`Array`\[:ref:`Vector2i`\], terrain_set\: :ref:`int`, terrain\: :ref:`int`, ignore_empty_terrains\: :ref:`bool` = true\ ) Update all the cells in the ``cells`` coordinates array so that they use the given ``terrain`` for the given ``terrain_set``. If an updated cell has the same terrain as one of its neighboring cells, this function tries to join the two. This function might update neighboring tiles if needed to create correct terrain transitions. @@ -870,7 +871,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -void **set_cells_terrain_path** **(** :ref:`int` layer, :ref:`Vector2i[]` path, :ref:`int` terrain_set, :ref:`int` terrain, :ref:`bool` ignore_empty_terrains=true **)** +|void| **set_cells_terrain_path**\ (\ layer\: :ref:`int`, path\: :ref:`Array`\[:ref:`Vector2i`\], terrain_set\: :ref:`int`, terrain\: :ref:`int`, ignore_empty_terrains\: :ref:`bool` = true\ ) Update all the cells in the ``path`` coordinates array so that they use the given ``terrain`` for the given ``terrain_set``. The function will also connect two successive cell in the path with the same terrain. This function might update neighboring tiles if needed to create correct terrain transitions. @@ -888,7 +889,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -void **set_layer_enabled** **(** :ref:`int` layer, :ref:`bool` enabled **)** +|void| **set_layer_enabled**\ (\ layer\: :ref:`int`, enabled\: :ref:`bool`\ ) Enables or disables the layer ``layer``. A disabled layer is not processed at all (no rendering, no physics, etc...). @@ -902,7 +903,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -void **set_layer_modulate** **(** :ref:`int` layer, :ref:`Color` modulate **)** +|void| **set_layer_modulate**\ (\ layer\: :ref:`int`, modulate\: :ref:`Color`\ ) Sets a layer's color. It will be multiplied by tile's color and TileMap's modulate. @@ -916,7 +917,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -void **set_layer_name** **(** :ref:`int` layer, :ref:`String` name **)** +|void| **set_layer_name**\ (\ layer\: :ref:`int`, name\: :ref:`String`\ ) Sets a layer's name. This is mostly useful in the editor. @@ -930,7 +931,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -void **set_layer_navigation_enabled** **(** :ref:`int` layer, :ref:`bool` enabled **)** +|void| **set_layer_navigation_enabled**\ (\ layer\: :ref:`int`, enabled\: :ref:`bool`\ ) Enables or disables a layer's built-in navigation regions generation. Disable this if you need to bake navigation regions from a TileMap using a :ref:`NavigationRegion2D` node. @@ -942,9 +943,9 @@ Enables or disables a layer's built-in navigation regions generation. Disable th .. rst-class:: classref-method -void **set_layer_navigation_map** **(** :ref:`int` layer, :ref:`RID` map **)** +|void| **set_layer_navigation_map**\ (\ layer\: :ref:`int`, map\: :ref:`RID`\ ) -Assigns a :ref:`NavigationServer2D` navigation map :ref:`RID` to the specified TileMap ``layer``. +Assigns ``map`` as a :ref:`NavigationServer2D` navigation map for the specified TileMap layer ``layer``. By default the TileMap uses the default :ref:`World2D` navigation map for the first TileMap layer. For each additional TileMap layer a new navigation map is created for the additional layer. @@ -960,7 +961,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -void **set_layer_y_sort_enabled** **(** :ref:`int` layer, :ref:`bool` y_sort_enabled **)** +|void| **set_layer_y_sort_enabled**\ (\ layer\: :ref:`int`, y_sort_enabled\: :ref:`bool`\ ) Enables or disables a layer's Y-sorting. If a layer is Y-sorted, the layer will behave as a CanvasItem node where each of its tile gets Y-sorted. @@ -976,7 +977,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -void **set_layer_y_sort_origin** **(** :ref:`int` layer, :ref:`int` y_sort_origin **)** +|void| **set_layer_y_sort_origin**\ (\ layer\: :ref:`int`, y_sort_origin\: :ref:`int`\ ) Sets a layer's Y-sort origin value. This Y-sort origin value is added to each tile's Y-sort origin value. @@ -992,7 +993,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -void **set_layer_z_index** **(** :ref:`int` layer, :ref:`int` z_index **)** +|void| **set_layer_z_index**\ (\ layer\: :ref:`int`, z_index\: :ref:`int`\ ) Sets a layers Z-index value. This Z-index is added to each tile's Z-index value. @@ -1006,11 +1007,11 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -void **set_navigation_map** **(** :ref:`int` layer, :ref:`RID` map **)** +|void| **set_navigation_map**\ (\ layer\: :ref:`int`, map\: :ref:`RID`\ ) -**Deprecated:** This method may be changed or removed in future versions. +**Deprecated:** Use :ref:`set_layer_navigation_map` instead. -See :ref:`set_layer_navigation_map`. +Assigns ``map`` as a :ref:`NavigationServer2D` navigation map for the specified TileMap layer ``layer``. .. rst-class:: classref-item-separator @@ -1020,7 +1021,7 @@ See :ref:`set_layer_navigation_map` layer, :ref:`Vector2i` position, :ref:`TileMapPattern` pattern **)** +|void| **set_pattern**\ (\ layer\: :ref:`int`, position\: :ref:`Vector2i`, pattern\: :ref:`TileMapPattern`\ ) Paste the given :ref:`TileMapPattern` at the given ``position`` and ``layer`` in the tile map. @@ -1034,7 +1035,7 @@ If ``layer`` is negative, the layers are accessed from the last one. .. rst-class:: classref-method -void **update_internals** **(** **)** +|void| **update_internals**\ (\ ) Triggers a direct update of the TileMap. Usually, calling this function is not needed, as TileMap node updates automatically when one of its properties or cells is modified. @@ -1049,3 +1050,4 @@ However, for performance reasons, those updates are batched and delayed to the e .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_tilemaplayergroup.rst b/classes/class_tilemaplayergroup.rst index 8328ae29e28..e02ad3a89ea 100644 --- a/classes/class_tilemaplayergroup.rst +++ b/classes/class_tilemaplayergroup.rst @@ -54,8 +54,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_tileset** **(** :ref:`TileSet` value **)** -- :ref:`TileSet` **get_tileset** **(** **)** +- |void| **set_tileset**\ (\ value\: :ref:`TileSet`\ ) +- :ref:`TileSet` **get_tileset**\ (\ ) The assigned :ref:`TileSet`. This TileSet will be applied to all child layers. @@ -66,3 +66,4 @@ The assigned :ref:`TileSet`. This TileSet will be applied to all .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_tilemappattern.rst b/classes/class_tilemappattern.rst index ed7bdd34fd2..afb35265924 100644 --- a/classes/class_tilemappattern.rst +++ b/classes/class_tilemappattern.rst @@ -31,27 +31,27 @@ Methods .. table:: :widths: auto - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_cell_alternative_tile` **(** :ref:`Vector2i` coords **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_cell_atlas_coords` **(** :ref:`Vector2i` coords **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_cell_source_id` **(** :ref:`Vector2i` coords **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_size` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i[]` | :ref:`get_used_cells` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_cell` **(** :ref:`Vector2i` coords **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_empty` **(** **)** |const| | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_cell` **(** :ref:`Vector2i` coords, :ref:`bool` update_size **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cell` **(** :ref:`Vector2i` coords, :ref:`int` source_id=-1, :ref:`Vector2i` atlas_coords=Vector2i(-1, -1), :ref:`int` alternative_tile=-1 **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_size` **(** :ref:`Vector2i` size **)** | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_cell_alternative_tile`\ (\ coords\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_cell_atlas_coords`\ (\ coords\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_cell_source_id`\ (\ coords\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_size`\ (\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Vector2i`\] | :ref:`get_used_cells`\ (\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_cell`\ (\ coords\: :ref:`Vector2i`\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_empty`\ (\ ) |const| | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_cell`\ (\ coords\: :ref:`Vector2i`, update_size\: :ref:`bool`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cell`\ (\ coords\: :ref:`Vector2i`, source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = -1\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_size`\ (\ size\: :ref:`Vector2i`\ ) | + +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -66,7 +66,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_cell_alternative_tile** **(** :ref:`Vector2i` coords **)** |const| +:ref:`int` **get_cell_alternative_tile**\ (\ coords\: :ref:`Vector2i`\ ) |const| Returns the tile alternative ID of the cell at ``coords``. @@ -78,7 +78,7 @@ Returns the tile alternative ID of the cell at ``coords``. .. rst-class:: classref-method -:ref:`Vector2i` **get_cell_atlas_coords** **(** :ref:`Vector2i` coords **)** |const| +:ref:`Vector2i` **get_cell_atlas_coords**\ (\ coords\: :ref:`Vector2i`\ ) |const| Returns the tile atlas coordinates ID of the cell at ``coords``. @@ -90,7 +90,7 @@ Returns the tile atlas coordinates ID of the cell at ``coords``. .. rst-class:: classref-method -:ref:`int` **get_cell_source_id** **(** :ref:`Vector2i` coords **)** |const| +:ref:`int` **get_cell_source_id**\ (\ coords\: :ref:`Vector2i`\ ) |const| Returns the tile source ID of the cell at ``coords``. @@ -102,7 +102,7 @@ Returns the tile source ID of the cell at ``coords``. .. rst-class:: classref-method -:ref:`Vector2i` **get_size** **(** **)** |const| +:ref:`Vector2i` **get_size**\ (\ ) |const| Returns the size, in cells, of the pattern. @@ -114,7 +114,7 @@ Returns the size, in cells, of the pattern. .. rst-class:: classref-method -:ref:`Vector2i[]` **get_used_cells** **(** **)** |const| +:ref:`Array`\[:ref:`Vector2i`\] **get_used_cells**\ (\ ) |const| Returns the list of used cell coordinates in the pattern. @@ -126,7 +126,7 @@ Returns the list of used cell coordinates in the pattern. .. rst-class:: classref-method -:ref:`bool` **has_cell** **(** :ref:`Vector2i` coords **)** |const| +:ref:`bool` **has_cell**\ (\ coords\: :ref:`Vector2i`\ ) |const| Returns whether the pattern has a tile at the given coordinates. @@ -138,7 +138,7 @@ Returns whether the pattern has a tile at the given coordinates. .. rst-class:: classref-method -:ref:`bool` **is_empty** **(** **)** |const| +:ref:`bool` **is_empty**\ (\ ) |const| Returns whether the pattern is empty or not. @@ -150,7 +150,7 @@ Returns whether the pattern is empty or not. .. rst-class:: classref-method -void **remove_cell** **(** :ref:`Vector2i` coords, :ref:`bool` update_size **)** +|void| **remove_cell**\ (\ coords\: :ref:`Vector2i`, update_size\: :ref:`bool`\ ) Remove the cell at the given coordinates. @@ -162,7 +162,7 @@ Remove the cell at the given coordinates. .. rst-class:: classref-method -void **set_cell** **(** :ref:`Vector2i` coords, :ref:`int` source_id=-1, :ref:`Vector2i` atlas_coords=Vector2i(-1, -1), :ref:`int` alternative_tile=-1 **)** +|void| **set_cell**\ (\ coords\: :ref:`Vector2i`, source_id\: :ref:`int` = -1, atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), alternative_tile\: :ref:`int` = -1\ ) Sets the tile identifiers for the cell at coordinates ``coords``. See :ref:`TileMap.set_cell`. @@ -174,7 +174,7 @@ Sets the tile identifiers for the cell at coordinates ``coords``. See :ref:`Tile .. rst-class:: classref-method -void **set_size** **(** :ref:`Vector2i` size **)** +|void| **set_size**\ (\ size\: :ref:`Vector2i`\ ) Sets the size of the pattern. @@ -185,3 +185,4 @@ Sets the size of the pattern. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index e46cf3364df..acf225d1387 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -78,159 +78,159 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_custom_data_layer` **(** :ref:`int` to_position=-1 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_navigation_layer` **(** :ref:`int` to_position=-1 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_occlusion_layer` **(** :ref:`int` to_position=-1 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`add_pattern` **(** :ref:`TileMapPattern` pattern, :ref:`int` index=-1 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_physics_layer` **(** :ref:`int` to_position=-1 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`add_source` **(** :ref:`TileSetSource` source, :ref:`int` atlas_source_id_override=-1 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_terrain` **(** :ref:`int` terrain_set, :ref:`int` to_position=-1 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_terrain_set` **(** :ref:`int` to_position=-1 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`cleanup_invalid_tile_proxies` **(** **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_tile_proxies` **(** **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_alternative_level_tile_proxy` **(** :ref:`int` source_from, :ref:`Vector2i` coords_from, :ref:`int` alternative_from **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_coords_level_tile_proxy` **(** :ref:`int` source_from, :ref:`Vector2i` coords_from **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_custom_data_layer_by_name` **(** :ref:`String` layer_name **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_custom_data_layer_name` **(** :ref:`int` layer_index **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant.Type` | :ref:`get_custom_data_layer_type` **(** :ref:`int` layer_index **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_custom_data_layers_count` **(** **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_navigation_layer_layer_value` **(** :ref:`int` layer_index, :ref:`int` layer_number **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_navigation_layer_layers` **(** :ref:`int` layer_index **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_navigation_layers_count` **(** **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_next_source_id` **(** **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_occlusion_layer_light_mask` **(** :ref:`int` layer_index **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_occlusion_layer_sdf_collision` **(** :ref:`int` layer_index **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_occlusion_layers_count` **(** **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TileMapPattern` | :ref:`get_pattern` **(** :ref:`int` index=-1 **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_patterns_count` **(** **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_physics_layer_collision_layer` **(** :ref:`int` layer_index **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_physics_layer_collision_mask` **(** :ref:`int` layer_index **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PhysicsMaterial` | :ref:`get_physics_layer_physics_material` **(** :ref:`int` layer_index **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_physics_layers_count` **(** **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TileSetSource` | :ref:`get_source` **(** :ref:`int` source_id **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_source_count` **(** **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_source_id` **(** :ref:`int` index **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_source_level_tile_proxy` **(** :ref:`int` source_from **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_terrain_color` **(** :ref:`int` terrain_set, :ref:`int` terrain_index **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_terrain_name` **(** :ref:`int` terrain_set, :ref:`int` terrain_index **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TerrainMode` | :ref:`get_terrain_set_mode` **(** :ref:`int` terrain_set **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_terrain_sets_count` **(** **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_terrains_count` **(** :ref:`int` terrain_set **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_alternative_level_tile_proxy` **(** :ref:`int` source_from, :ref:`Vector2i` coords_from, :ref:`int` alternative_from **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_coords_level_tile_proxy` **(** :ref:`int` source_from, :ref:`Vector2i` coords_from **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_source` **(** :ref:`int` source_id **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_source_level_tile_proxy` **(** :ref:`int` source_from **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`map_tile_proxy` **(** :ref:`int` source_from, :ref:`Vector2i` coords_from, :ref:`int` alternative_from **)** |const| | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_custom_data_layer` **(** :ref:`int` layer_index, :ref:`int` to_position **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_navigation_layer` **(** :ref:`int` layer_index, :ref:`int` to_position **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_occlusion_layer` **(** :ref:`int` layer_index, :ref:`int` to_position **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_physics_layer` **(** :ref:`int` layer_index, :ref:`int` to_position **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_terrain` **(** :ref:`int` terrain_set, :ref:`int` terrain_index, :ref:`int` to_position **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_terrain_set` **(** :ref:`int` terrain_set, :ref:`int` to_position **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_alternative_level_tile_proxy` **(** :ref:`int` source_from, :ref:`Vector2i` coords_from, :ref:`int` alternative_from **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_coords_level_tile_proxy` **(** :ref:`int` source_from, :ref:`Vector2i` coords_from **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_custom_data_layer` **(** :ref:`int` layer_index **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_navigation_layer` **(** :ref:`int` layer_index **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_occlusion_layer` **(** :ref:`int` layer_index **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_pattern` **(** :ref:`int` index **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_physics_layer` **(** :ref:`int` layer_index **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_source` **(** :ref:`int` source_id **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_source_level_tile_proxy` **(** :ref:`int` source_from **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_terrain` **(** :ref:`int` terrain_set, :ref:`int` terrain_index **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_terrain_set` **(** :ref:`int` terrain_set **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_alternative_level_tile_proxy` **(** :ref:`int` source_from, :ref:`Vector2i` coords_from, :ref:`int` alternative_from, :ref:`int` source_to, :ref:`Vector2i` coords_to, :ref:`int` alternative_to **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_coords_level_tile_proxy` **(** :ref:`int` p_source_from, :ref:`Vector2i` coords_from, :ref:`int` source_to, :ref:`Vector2i` coords_to **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_custom_data_layer_name` **(** :ref:`int` layer_index, :ref:`String` layer_name **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_custom_data_layer_type` **(** :ref:`int` layer_index, :ref:`Variant.Type` layer_type **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_navigation_layer_layer_value` **(** :ref:`int` layer_index, :ref:`int` layer_number, :ref:`bool` value **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_navigation_layer_layers` **(** :ref:`int` layer_index, :ref:`int` layers **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_occlusion_layer_light_mask` **(** :ref:`int` layer_index, :ref:`int` light_mask **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_occlusion_layer_sdf_collision` **(** :ref:`int` layer_index, :ref:`bool` sdf_collision **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_physics_layer_collision_layer` **(** :ref:`int` layer_index, :ref:`int` layer **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_physics_layer_collision_mask` **(** :ref:`int` layer_index, :ref:`int` mask **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_physics_layer_physics_material` **(** :ref:`int` layer_index, :ref:`PhysicsMaterial` physics_material **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_source_id` **(** :ref:`int` source_id, :ref:`int` new_source_id **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_source_level_tile_proxy` **(** :ref:`int` source_from, :ref:`int` source_to **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_terrain_color` **(** :ref:`int` terrain_set, :ref:`int` terrain_index, :ref:`Color` color **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_terrain_name` **(** :ref:`int` terrain_set, :ref:`int` terrain_index, :ref:`String` name **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_terrain_set_mode` **(** :ref:`int` terrain_set, :ref:`TerrainMode` mode **)** | - +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_custom_data_layer`\ (\ to_position\: :ref:`int` = -1\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_navigation_layer`\ (\ to_position\: :ref:`int` = -1\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_occlusion_layer`\ (\ to_position\: :ref:`int` = -1\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`add_pattern`\ (\ pattern\: :ref:`TileMapPattern`, index\: :ref:`int` = -1\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_physics_layer`\ (\ to_position\: :ref:`int` = -1\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`add_source`\ (\ source\: :ref:`TileSetSource`, atlas_source_id_override\: :ref:`int` = -1\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_terrain`\ (\ terrain_set\: :ref:`int`, to_position\: :ref:`int` = -1\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_terrain_set`\ (\ to_position\: :ref:`int` = -1\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cleanup_invalid_tile_proxies`\ (\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_tile_proxies`\ (\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_alternative_level_tile_proxy`\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_coords_level_tile_proxy`\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_custom_data_layer_by_name`\ (\ layer_name\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_custom_data_layer_name`\ (\ layer_index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant.Type` | :ref:`get_custom_data_layer_type`\ (\ layer_index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_custom_data_layers_count`\ (\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_navigation_layer_layer_value`\ (\ layer_index\: :ref:`int`, layer_number\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_navigation_layer_layers`\ (\ layer_index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_navigation_layers_count`\ (\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_next_source_id`\ (\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_occlusion_layer_light_mask`\ (\ layer_index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_occlusion_layer_sdf_collision`\ (\ layer_index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_occlusion_layers_count`\ (\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TileMapPattern` | :ref:`get_pattern`\ (\ index\: :ref:`int` = -1\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_patterns_count`\ (\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_physics_layer_collision_layer`\ (\ layer_index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_physics_layer_collision_mask`\ (\ layer_index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PhysicsMaterial` | :ref:`get_physics_layer_physics_material`\ (\ layer_index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_physics_layers_count`\ (\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TileSetSource` | :ref:`get_source`\ (\ source_id\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_source_count`\ (\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_source_id`\ (\ index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_source_level_tile_proxy`\ (\ source_from\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_terrain_color`\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_terrain_name`\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TerrainMode` | :ref:`get_terrain_set_mode`\ (\ terrain_set\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_terrain_sets_count`\ (\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_terrains_count`\ (\ terrain_set\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_alternative_level_tile_proxy`\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_coords_level_tile_proxy`\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_source`\ (\ source_id\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_source_level_tile_proxy`\ (\ source_from\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`map_tile_proxy`\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_custom_data_layer`\ (\ layer_index\: :ref:`int`, to_position\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_navigation_layer`\ (\ layer_index\: :ref:`int`, to_position\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_occlusion_layer`\ (\ layer_index\: :ref:`int`, to_position\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_physics_layer`\ (\ layer_index\: :ref:`int`, to_position\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_terrain`\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`, to_position\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_terrain_set`\ (\ terrain_set\: :ref:`int`, to_position\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_alternative_level_tile_proxy`\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_coords_level_tile_proxy`\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_custom_data_layer`\ (\ layer_index\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_navigation_layer`\ (\ layer_index\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_occlusion_layer`\ (\ layer_index\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_pattern`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_physics_layer`\ (\ layer_index\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_source`\ (\ source_id\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_source_level_tile_proxy`\ (\ source_from\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_terrain`\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_terrain_set`\ (\ terrain_set\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_alternative_level_tile_proxy`\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`, source_to\: :ref:`int`, coords_to\: :ref:`Vector2i`, alternative_to\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_coords_level_tile_proxy`\ (\ p_source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, source_to\: :ref:`int`, coords_to\: :ref:`Vector2i`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_data_layer_name`\ (\ layer_index\: :ref:`int`, layer_name\: :ref:`String`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_data_layer_type`\ (\ layer_index\: :ref:`int`, layer_type\: :ref:`Variant.Type`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_navigation_layer_layer_value`\ (\ layer_index\: :ref:`int`, layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_navigation_layer_layers`\ (\ layer_index\: :ref:`int`, layers\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_occlusion_layer_light_mask`\ (\ layer_index\: :ref:`int`, light_mask\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_occlusion_layer_sdf_collision`\ (\ layer_index\: :ref:`int`, sdf_collision\: :ref:`bool`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_physics_layer_collision_layer`\ (\ layer_index\: :ref:`int`, layer\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_physics_layer_collision_mask`\ (\ layer_index\: :ref:`int`, mask\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_physics_layer_physics_material`\ (\ layer_index\: :ref:`int`, physics_material\: :ref:`PhysicsMaterial`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_source_id`\ (\ source_id\: :ref:`int`, new_source_id\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_source_level_tile_proxy`\ (\ source_from\: :ref:`int`, source_to\: :ref:`int`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_terrain_color`\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`, color\: :ref:`Color`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_terrain_name`\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`, name\: :ref:`String`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_terrain_set_mode`\ (\ terrain_set\: :ref:`int`, mode\: :ref:`TerrainMode`\ ) | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -554,8 +554,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_tile_layout** **(** :ref:`TileLayout` value **)** -- :ref:`TileLayout` **get_tile_layout** **(** **)** +- |void| **set_tile_layout**\ (\ value\: :ref:`TileLayout`\ ) +- :ref:`TileLayout` **get_tile_layout**\ (\ ) For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), changes the way tiles are indexed in the TileMap grid. @@ -571,8 +571,8 @@ For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), change .. rst-class:: classref-property-setget -- void **set_tile_offset_axis** **(** :ref:`TileOffsetAxis` value **)** -- :ref:`TileOffsetAxis` **get_tile_offset_axis** **(** **)** +- |void| **set_tile_offset_axis**\ (\ value\: :ref:`TileOffsetAxis`\ ) +- :ref:`TileOffsetAxis` **get_tile_offset_axis**\ (\ ) For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), determines the offset axis. @@ -588,8 +588,8 @@ For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), determ .. rst-class:: classref-property-setget -- void **set_tile_shape** **(** :ref:`TileShape` value **)** -- :ref:`TileShape` **get_tile_shape** **(** **)** +- |void| **set_tile_shape**\ (\ value\: :ref:`TileShape`\ ) +- :ref:`TileShape` **get_tile_shape**\ (\ ) The tile shape. @@ -605,8 +605,8 @@ The tile shape. .. rst-class:: classref-property-setget -- void **set_tile_size** **(** :ref:`Vector2i` value **)** -- :ref:`Vector2i` **get_tile_size** **(** **)** +- |void| **set_tile_size**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_tile_size**\ (\ ) The tile size, in pixels. For all tile shapes, this size corresponds to the encompassing rectangle of the tile shape. This is thus the minimal cell size required in an atlas. @@ -622,8 +622,8 @@ The tile size, in pixels. For all tile shapes, this size corresponds to the enco .. rst-class:: classref-property-setget -- void **set_uv_clipping** **(** :ref:`bool` value **)** -- :ref:`bool` **is_uv_clipping** **(** **)** +- |void| **set_uv_clipping**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_uv_clipping**\ (\ ) Enables/Disable uv clipping when rendering the tiles. @@ -640,7 +640,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_custom_data_layer** **(** :ref:`int` to_position=-1 **)** +|void| **add_custom_data_layer**\ (\ to_position\: :ref:`int` = -1\ ) Adds a custom data layer to the TileSet at the given position ``to_position`` in the array. If ``to_position`` is -1, adds it at the end of the array. @@ -654,7 +654,7 @@ Custom data layers allow assigning custom properties to atlas tiles. .. rst-class:: classref-method -void **add_navigation_layer** **(** :ref:`int` to_position=-1 **)** +|void| **add_navigation_layer**\ (\ to_position\: :ref:`int` = -1\ ) Adds a navigation layer to the TileSet at the given position ``to_position`` in the array. If ``to_position`` is -1, adds it at the end of the array. @@ -668,7 +668,7 @@ Navigation layers allow assigning a navigable area to atlas tiles. .. rst-class:: classref-method -void **add_occlusion_layer** **(** :ref:`int` to_position=-1 **)** +|void| **add_occlusion_layer**\ (\ to_position\: :ref:`int` = -1\ ) Adds an occlusion layer to the TileSet at the given position ``to_position`` in the array. If ``to_position`` is -1, adds it at the end of the array. @@ -682,7 +682,7 @@ Occlusion layers allow assigning occlusion polygons to atlas tiles. .. rst-class:: classref-method -:ref:`int` **add_pattern** **(** :ref:`TileMapPattern` pattern, :ref:`int` index=-1 **)** +:ref:`int` **add_pattern**\ (\ pattern\: :ref:`TileMapPattern`, index\: :ref:`int` = -1\ ) Adds a :ref:`TileMapPattern` to be stored in the TileSet resource. If provided, insert it at the given ``index``. @@ -694,7 +694,7 @@ Adds a :ref:`TileMapPattern` to be stored in the TileSet r .. rst-class:: classref-method -void **add_physics_layer** **(** :ref:`int` to_position=-1 **)** +|void| **add_physics_layer**\ (\ to_position\: :ref:`int` = -1\ ) Adds a physics layer to the TileSet at the given position ``to_position`` in the array. If ``to_position`` is -1, adds it at the end of the array. @@ -708,7 +708,7 @@ Physics layers allow assigning collision polygons to atlas tiles. .. rst-class:: classref-method -:ref:`int` **add_source** **(** :ref:`TileSetSource` source, :ref:`int` atlas_source_id_override=-1 **)** +:ref:`int` **add_source**\ (\ source\: :ref:`TileSetSource`, atlas_source_id_override\: :ref:`int` = -1\ ) Adds a :ref:`TileSetSource` to the TileSet. If ``atlas_source_id_override`` is not -1, also set its source ID. Otherwise, a unique identifier is automatically generated. @@ -724,7 +724,7 @@ The function returns the added source ID or -1 if the source could not be added. .. rst-class:: classref-method -void **add_terrain** **(** :ref:`int` terrain_set, :ref:`int` to_position=-1 **)** +|void| **add_terrain**\ (\ terrain_set\: :ref:`int`, to_position\: :ref:`int` = -1\ ) Adds a new terrain to the given terrain set ``terrain_set`` at the given position ``to_position`` in the array. If ``to_position`` is -1, adds it at the end of the array. @@ -736,7 +736,7 @@ Adds a new terrain to the given terrain set ``terrain_set`` at the given positio .. rst-class:: classref-method -void **add_terrain_set** **(** :ref:`int` to_position=-1 **)** +|void| **add_terrain_set**\ (\ to_position\: :ref:`int` = -1\ ) Adds a new terrain set at the given position ``to_position`` in the array. If ``to_position`` is -1, adds it at the end of the array. @@ -748,7 +748,7 @@ Adds a new terrain set at the given position ``to_position`` in the array. If `` .. rst-class:: classref-method -void **cleanup_invalid_tile_proxies** **(** **)** +|void| **cleanup_invalid_tile_proxies**\ (\ ) Clears tile proxies pointing to invalid tiles. @@ -760,7 +760,7 @@ Clears tile proxies pointing to invalid tiles. .. rst-class:: classref-method -void **clear_tile_proxies** **(** **)** +|void| **clear_tile_proxies**\ (\ ) Clears all tile proxies. @@ -772,7 +772,7 @@ Clears all tile proxies. .. rst-class:: classref-method -:ref:`Array` **get_alternative_level_tile_proxy** **(** :ref:`int` source_from, :ref:`Vector2i` coords_from, :ref:`int` alternative_from **)** +:ref:`Array` **get_alternative_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`\ ) Returns the alternative-level proxy for the given identifiers. The returned array contains the three proxie's target identifiers (source ID, atlas coords ID and alternative tile ID). @@ -786,7 +786,7 @@ If the TileSet has no proxy for the given identifiers, returns an empty Array. .. rst-class:: classref-method -:ref:`Array` **get_coords_level_tile_proxy** **(** :ref:`int` source_from, :ref:`Vector2i` coords_from **)** +:ref:`Array` **get_coords_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`\ ) Returns the coordinate-level proxy for the given identifiers. The returned array contains the two target identifiers of the proxy (source ID and atlas coordinates ID). @@ -800,7 +800,7 @@ If the TileSet has no proxy for the given identifiers, returns an empty Array. .. rst-class:: classref-method -:ref:`int` **get_custom_data_layer_by_name** **(** :ref:`String` layer_name **)** |const| +:ref:`int` **get_custom_data_layer_by_name**\ (\ layer_name\: :ref:`String`\ ) |const| Returns the index of the custom data layer identified by the given name. @@ -812,7 +812,7 @@ Returns the index of the custom data layer identified by the given name. .. rst-class:: classref-method -:ref:`String` **get_custom_data_layer_name** **(** :ref:`int` layer_index **)** |const| +:ref:`String` **get_custom_data_layer_name**\ (\ layer_index\: :ref:`int`\ ) |const| Returns the name of the custom data layer identified by the given index. @@ -824,7 +824,7 @@ Returns the name of the custom data layer identified by the given index. .. rst-class:: classref-method -:ref:`Variant.Type` **get_custom_data_layer_type** **(** :ref:`int` layer_index **)** |const| +:ref:`Variant.Type` **get_custom_data_layer_type**\ (\ layer_index\: :ref:`int`\ ) |const| Returns the type of the custom data layer identified by the given index. @@ -836,7 +836,7 @@ Returns the type of the custom data layer identified by the given index. .. rst-class:: classref-method -:ref:`int` **get_custom_data_layers_count** **(** **)** |const| +:ref:`int` **get_custom_data_layers_count**\ (\ ) |const| Returns the custom data layers count. @@ -848,7 +848,7 @@ Returns the custom data layers count. .. rst-class:: classref-method -:ref:`bool` **get_navigation_layer_layer_value** **(** :ref:`int` layer_index, :ref:`int` layer_number **)** |const| +:ref:`bool` **get_navigation_layer_layer_value**\ (\ layer_index\: :ref:`int`, layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified navigation layer of the TileSet navigation data layer identified by the given ``layer_index`` is enabled, given a navigation_layers ``layer_number`` between 1 and 32. @@ -860,7 +860,7 @@ Returns whether or not the specified navigation layer of the TileSet navigation .. rst-class:: classref-method -:ref:`int` **get_navigation_layer_layers** **(** :ref:`int` layer_index **)** |const| +:ref:`int` **get_navigation_layer_layers**\ (\ layer_index\: :ref:`int`\ ) |const| Returns the navigation layers (as in the Navigation server) of the given TileSet navigation layer. @@ -872,7 +872,7 @@ Returns the navigation layers (as in the Navigation server) of the given TileSet .. rst-class:: classref-method -:ref:`int` **get_navigation_layers_count** **(** **)** |const| +:ref:`int` **get_navigation_layers_count**\ (\ ) |const| Returns the navigation layers count. @@ -884,7 +884,7 @@ Returns the navigation layers count. .. rst-class:: classref-method -:ref:`int` **get_next_source_id** **(** **)** |const| +:ref:`int` **get_next_source_id**\ (\ ) |const| Returns a new unused source ID. This generated ID is the same that a call to :ref:`add_source` would return. @@ -896,7 +896,7 @@ Returns a new unused source ID. This generated ID is the same that a call to :re .. rst-class:: classref-method -:ref:`int` **get_occlusion_layer_light_mask** **(** :ref:`int` layer_index **)** |const| +:ref:`int` **get_occlusion_layer_light_mask**\ (\ layer_index\: :ref:`int`\ ) |const| Returns the light mask of the occlusion layer. @@ -908,7 +908,7 @@ Returns the light mask of the occlusion layer. .. rst-class:: classref-method -:ref:`bool` **get_occlusion_layer_sdf_collision** **(** :ref:`int` layer_index **)** |const| +:ref:`bool` **get_occlusion_layer_sdf_collision**\ (\ layer_index\: :ref:`int`\ ) |const| Returns if the occluders from this layer use ``sdf_collision``. @@ -920,7 +920,7 @@ Returns if the occluders from this layer use ``sdf_collision``. .. rst-class:: classref-method -:ref:`int` **get_occlusion_layers_count** **(** **)** |const| +:ref:`int` **get_occlusion_layers_count**\ (\ ) |const| Returns the occlusion layers count. @@ -932,7 +932,7 @@ Returns the occlusion layers count. .. rst-class:: classref-method -:ref:`TileMapPattern` **get_pattern** **(** :ref:`int` index=-1 **)** +:ref:`TileMapPattern` **get_pattern**\ (\ index\: :ref:`int` = -1\ ) Returns the :ref:`TileMapPattern` at the given ``index``. @@ -944,7 +944,7 @@ Returns the :ref:`TileMapPattern` at the given ``index``. .. rst-class:: classref-method -:ref:`int` **get_patterns_count** **(** **)** +:ref:`int` **get_patterns_count**\ (\ ) Returns the number of :ref:`TileMapPattern` this tile set handles. @@ -956,7 +956,7 @@ Returns the number of :ref:`TileMapPattern` this tile set .. rst-class:: classref-method -:ref:`int` **get_physics_layer_collision_layer** **(** :ref:`int` layer_index **)** |const| +:ref:`int` **get_physics_layer_collision_layer**\ (\ layer_index\: :ref:`int`\ ) |const| Returns the collision layer (as in the physics server) bodies on the given TileSet's physics layer are in. @@ -968,7 +968,7 @@ Returns the collision layer (as in the physics server) bodies on the given TileS .. rst-class:: classref-method -:ref:`int` **get_physics_layer_collision_mask** **(** :ref:`int` layer_index **)** |const| +:ref:`int` **get_physics_layer_collision_mask**\ (\ layer_index\: :ref:`int`\ ) |const| Returns the collision mask of bodies on the given TileSet's physics layer. @@ -980,7 +980,7 @@ Returns the collision mask of bodies on the given TileSet's physics layer. .. rst-class:: classref-method -:ref:`PhysicsMaterial` **get_physics_layer_physics_material** **(** :ref:`int` layer_index **)** |const| +:ref:`PhysicsMaterial` **get_physics_layer_physics_material**\ (\ layer_index\: :ref:`int`\ ) |const| Returns the physics material of bodies on the given TileSet's physics layer. @@ -992,7 +992,7 @@ Returns the physics material of bodies on the given TileSet's physics layer. .. rst-class:: classref-method -:ref:`int` **get_physics_layers_count** **(** **)** |const| +:ref:`int` **get_physics_layers_count**\ (\ ) |const| Returns the physics layers count. @@ -1004,7 +1004,7 @@ Returns the physics layers count. .. rst-class:: classref-method -:ref:`TileSetSource` **get_source** **(** :ref:`int` source_id **)** |const| +:ref:`TileSetSource` **get_source**\ (\ source_id\: :ref:`int`\ ) |const| Returns the :ref:`TileSetSource` with ID ``source_id``. @@ -1016,7 +1016,7 @@ Returns the :ref:`TileSetSource` with ID ``source_id``. .. rst-class:: classref-method -:ref:`int` **get_source_count** **(** **)** |const| +:ref:`int` **get_source_count**\ (\ ) |const| Returns the number of :ref:`TileSetSource` in this TileSet. @@ -1028,7 +1028,7 @@ Returns the number of :ref:`TileSetSource` in this TileSet. .. rst-class:: classref-method -:ref:`int` **get_source_id** **(** :ref:`int` index **)** |const| +:ref:`int` **get_source_id**\ (\ index\: :ref:`int`\ ) |const| Returns the source ID for source with index ``index``. @@ -1040,7 +1040,7 @@ Returns the source ID for source with index ``index``. .. rst-class:: classref-method -:ref:`int` **get_source_level_tile_proxy** **(** :ref:`int` source_from **)** +:ref:`int` **get_source_level_tile_proxy**\ (\ source_from\: :ref:`int`\ ) Returns the source-level proxy for the given source identifier. @@ -1054,7 +1054,7 @@ If the TileSet has no proxy for the given identifier, returns -1. .. rst-class:: classref-method -:ref:`Color` **get_terrain_color** **(** :ref:`int` terrain_set, :ref:`int` terrain_index **)** |const| +:ref:`Color` **get_terrain_color**\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`\ ) |const| Returns a terrain's color. @@ -1066,7 +1066,7 @@ Returns a terrain's color. .. rst-class:: classref-method -:ref:`String` **get_terrain_name** **(** :ref:`int` terrain_set, :ref:`int` terrain_index **)** |const| +:ref:`String` **get_terrain_name**\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`\ ) |const| Returns a terrain's name. @@ -1078,7 +1078,7 @@ Returns a terrain's name. .. rst-class:: classref-method -:ref:`TerrainMode` **get_terrain_set_mode** **(** :ref:`int` terrain_set **)** |const| +:ref:`TerrainMode` **get_terrain_set_mode**\ (\ terrain_set\: :ref:`int`\ ) |const| Returns a terrain set mode. @@ -1090,7 +1090,7 @@ Returns a terrain set mode. .. rst-class:: classref-method -:ref:`int` **get_terrain_sets_count** **(** **)** |const| +:ref:`int` **get_terrain_sets_count**\ (\ ) |const| Returns the terrain sets count. @@ -1102,7 +1102,7 @@ Returns the terrain sets count. .. rst-class:: classref-method -:ref:`int` **get_terrains_count** **(** :ref:`int` terrain_set **)** |const| +:ref:`int` **get_terrains_count**\ (\ terrain_set\: :ref:`int`\ ) |const| Returns the number of terrains in the given terrain set. @@ -1114,7 +1114,7 @@ Returns the number of terrains in the given terrain set. .. rst-class:: classref-method -:ref:`bool` **has_alternative_level_tile_proxy** **(** :ref:`int` source_from, :ref:`Vector2i` coords_from, :ref:`int` alternative_from **)** +:ref:`bool` **has_alternative_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`\ ) Returns if there is an alternative-level proxy for the given identifiers. @@ -1126,7 +1126,7 @@ Returns if there is an alternative-level proxy for the given identifiers. .. rst-class:: classref-method -:ref:`bool` **has_coords_level_tile_proxy** **(** :ref:`int` source_from, :ref:`Vector2i` coords_from **)** +:ref:`bool` **has_coords_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`\ ) Returns if there is a coodinates-level proxy for the given identifiers. @@ -1138,7 +1138,7 @@ Returns if there is a coodinates-level proxy for the given identifiers. .. rst-class:: classref-method -:ref:`bool` **has_source** **(** :ref:`int` source_id **)** |const| +:ref:`bool` **has_source**\ (\ source_id\: :ref:`int`\ ) |const| Returns if this TileSet has a source for the given source ID. @@ -1150,7 +1150,7 @@ Returns if this TileSet has a source for the given source ID. .. rst-class:: classref-method -:ref:`bool` **has_source_level_tile_proxy** **(** :ref:`int` source_from **)** +:ref:`bool` **has_source_level_tile_proxy**\ (\ source_from\: :ref:`int`\ ) Returns if there is a source-level proxy for the given source ID. @@ -1162,7 +1162,7 @@ Returns if there is a source-level proxy for the given source ID. .. rst-class:: classref-method -:ref:`Array` **map_tile_proxy** **(** :ref:`int` source_from, :ref:`Vector2i` coords_from, :ref:`int` alternative_from **)** |const| +:ref:`Array` **map_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`\ ) |const| According to the configured proxies, maps the provided identifiers to a new set of identifiers. The source ID, atlas coordinates ID and alternative tile ID are returned as a 3 elements Array. @@ -1178,7 +1178,7 @@ If no proxy corresponding to provided identifiers are found, returns the same va .. rst-class:: classref-method -void **move_custom_data_layer** **(** :ref:`int` layer_index, :ref:`int` to_position **)** +|void| **move_custom_data_layer**\ (\ layer_index\: :ref:`int`, to_position\: :ref:`int`\ ) Moves the custom data layer at index ``layer_index`` to the given position ``to_position`` in the array. Also updates the atlas tiles accordingly. @@ -1190,7 +1190,7 @@ Moves the custom data layer at index ``layer_index`` to the given position ``to_ .. rst-class:: classref-method -void **move_navigation_layer** **(** :ref:`int` layer_index, :ref:`int` to_position **)** +|void| **move_navigation_layer**\ (\ layer_index\: :ref:`int`, to_position\: :ref:`int`\ ) Moves the navigation layer at index ``layer_index`` to the given position ``to_position`` in the array. Also updates the atlas tiles accordingly. @@ -1202,7 +1202,7 @@ Moves the navigation layer at index ``layer_index`` to the given position ``to_p .. rst-class:: classref-method -void **move_occlusion_layer** **(** :ref:`int` layer_index, :ref:`int` to_position **)** +|void| **move_occlusion_layer**\ (\ layer_index\: :ref:`int`, to_position\: :ref:`int`\ ) Moves the occlusion layer at index ``layer_index`` to the given position ``to_position`` in the array. Also updates the atlas tiles accordingly. @@ -1214,7 +1214,7 @@ Moves the occlusion layer at index ``layer_index`` to the given position ``to_po .. rst-class:: classref-method -void **move_physics_layer** **(** :ref:`int` layer_index, :ref:`int` to_position **)** +|void| **move_physics_layer**\ (\ layer_index\: :ref:`int`, to_position\: :ref:`int`\ ) Moves the physics layer at index ``layer_index`` to the given position ``to_position`` in the array. Also updates the atlas tiles accordingly. @@ -1226,7 +1226,7 @@ Moves the physics layer at index ``layer_index`` to the given position ``to_posi .. rst-class:: classref-method -void **move_terrain** **(** :ref:`int` terrain_set, :ref:`int` terrain_index, :ref:`int` to_position **)** +|void| **move_terrain**\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`, to_position\: :ref:`int`\ ) Moves the terrain at index ``terrain_index`` for terrain set ``terrain_set`` to the given position ``to_position`` in the array. Also updates the atlas tiles accordingly. @@ -1238,7 +1238,7 @@ Moves the terrain at index ``terrain_index`` for terrain set ``terrain_set`` to .. rst-class:: classref-method -void **move_terrain_set** **(** :ref:`int` terrain_set, :ref:`int` to_position **)** +|void| **move_terrain_set**\ (\ terrain_set\: :ref:`int`, to_position\: :ref:`int`\ ) Moves the terrain set at index ``terrain_set`` to the given position ``to_position`` in the array. Also updates the atlas tiles accordingly. @@ -1250,7 +1250,7 @@ Moves the terrain set at index ``terrain_set`` to the given position ``to_positi .. rst-class:: classref-method -void **remove_alternative_level_tile_proxy** **(** :ref:`int` source_from, :ref:`Vector2i` coords_from, :ref:`int` alternative_from **)** +|void| **remove_alternative_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`\ ) Removes an alternative-level proxy for the given identifiers. @@ -1262,7 +1262,7 @@ Removes an alternative-level proxy for the given identifiers. .. rst-class:: classref-method -void **remove_coords_level_tile_proxy** **(** :ref:`int` source_from, :ref:`Vector2i` coords_from **)** +|void| **remove_coords_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`\ ) Removes a coordinates-level proxy for the given identifiers. @@ -1274,7 +1274,7 @@ Removes a coordinates-level proxy for the given identifiers. .. rst-class:: classref-method -void **remove_custom_data_layer** **(** :ref:`int` layer_index **)** +|void| **remove_custom_data_layer**\ (\ layer_index\: :ref:`int`\ ) Removes the custom data layer at index ``layer_index``. Also updates the atlas tiles accordingly. @@ -1286,7 +1286,7 @@ Removes the custom data layer at index ``layer_index``. Also updates the atlas t .. rst-class:: classref-method -void **remove_navigation_layer** **(** :ref:`int` layer_index **)** +|void| **remove_navigation_layer**\ (\ layer_index\: :ref:`int`\ ) Removes the navigation layer at index ``layer_index``. Also updates the atlas tiles accordingly. @@ -1298,7 +1298,7 @@ Removes the navigation layer at index ``layer_index``. Also updates the atlas ti .. rst-class:: classref-method -void **remove_occlusion_layer** **(** :ref:`int` layer_index **)** +|void| **remove_occlusion_layer**\ (\ layer_index\: :ref:`int`\ ) Removes the occlusion layer at index ``layer_index``. Also updates the atlas tiles accordingly. @@ -1310,7 +1310,7 @@ Removes the occlusion layer at index ``layer_index``. Also updates the atlas til .. rst-class:: classref-method -void **remove_pattern** **(** :ref:`int` index **)** +|void| **remove_pattern**\ (\ index\: :ref:`int`\ ) Remove the :ref:`TileMapPattern` at the given index. @@ -1322,7 +1322,7 @@ Remove the :ref:`TileMapPattern` at the given index. .. rst-class:: classref-method -void **remove_physics_layer** **(** :ref:`int` layer_index **)** +|void| **remove_physics_layer**\ (\ layer_index\: :ref:`int`\ ) Removes the physics layer at index ``layer_index``. Also updates the atlas tiles accordingly. @@ -1334,7 +1334,7 @@ Removes the physics layer at index ``layer_index``. Also updates the atlas tiles .. rst-class:: classref-method -void **remove_source** **(** :ref:`int` source_id **)** +|void| **remove_source**\ (\ source_id\: :ref:`int`\ ) Removes the source with the given source ID. @@ -1346,7 +1346,7 @@ Removes the source with the given source ID. .. rst-class:: classref-method -void **remove_source_level_tile_proxy** **(** :ref:`int` source_from **)** +|void| **remove_source_level_tile_proxy**\ (\ source_from\: :ref:`int`\ ) Removes a source-level tile proxy. @@ -1358,7 +1358,7 @@ Removes a source-level tile proxy. .. rst-class:: classref-method -void **remove_terrain** **(** :ref:`int` terrain_set, :ref:`int` terrain_index **)** +|void| **remove_terrain**\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`\ ) Removes the terrain at index ``terrain_index`` in the given terrain set ``terrain_set``. Also updates the atlas tiles accordingly. @@ -1370,7 +1370,7 @@ Removes the terrain at index ``terrain_index`` in the given terrain set ``terrai .. rst-class:: classref-method -void **remove_terrain_set** **(** :ref:`int` terrain_set **)** +|void| **remove_terrain_set**\ (\ terrain_set\: :ref:`int`\ ) Removes the terrain set at index ``terrain_set``. Also updates the atlas tiles accordingly. @@ -1382,7 +1382,7 @@ Removes the terrain set at index ``terrain_set``. Also updates the atlas tiles a .. rst-class:: classref-method -void **set_alternative_level_tile_proxy** **(** :ref:`int` source_from, :ref:`Vector2i` coords_from, :ref:`int` alternative_from, :ref:`int` source_to, :ref:`Vector2i` coords_to, :ref:`int` alternative_to **)** +|void| **set_alternative_level_tile_proxy**\ (\ source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, alternative_from\: :ref:`int`, source_to\: :ref:`int`, coords_to\: :ref:`Vector2i`, alternative_to\: :ref:`int`\ ) Create an alternative-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers. @@ -1398,7 +1398,7 @@ Proxied tiles can be automatically replaced in TileMap nodes using the editor. .. rst-class:: classref-method -void **set_coords_level_tile_proxy** **(** :ref:`int` p_source_from, :ref:`Vector2i` coords_from, :ref:`int` source_to, :ref:`Vector2i` coords_to **)** +|void| **set_coords_level_tile_proxy**\ (\ p_source_from\: :ref:`int`, coords_from\: :ref:`Vector2i`, source_to\: :ref:`int`, coords_to\: :ref:`Vector2i`\ ) Creates a coordinates-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers. The alternative tile ID is kept the same when using coordinates-level proxies. @@ -1414,7 +1414,7 @@ Proxied tiles can be automatically replaced in TileMap nodes using the editor. .. rst-class:: classref-method -void **set_custom_data_layer_name** **(** :ref:`int` layer_index, :ref:`String` layer_name **)** +|void| **set_custom_data_layer_name**\ (\ layer_index\: :ref:`int`, layer_name\: :ref:`String`\ ) Sets the name of the custom data layer identified by the given index. Names are identifiers of the layer therefore if the name is already taken it will fail and raise an error. @@ -1426,7 +1426,7 @@ Sets the name of the custom data layer identified by the given index. Names are .. rst-class:: classref-method -void **set_custom_data_layer_type** **(** :ref:`int` layer_index, :ref:`Variant.Type` layer_type **)** +|void| **set_custom_data_layer_type**\ (\ layer_index\: :ref:`int`, layer_type\: :ref:`Variant.Type`\ ) Sets the type of the custom data layer identified by the given index. @@ -1438,7 +1438,7 @@ Sets the type of the custom data layer identified by the given index. .. rst-class:: classref-method -void **set_navigation_layer_layer_value** **(** :ref:`int` layer_index, :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_navigation_layer_layer_value**\ (\ layer_index\: :ref:`int`, layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified navigation layer of the TileSet navigation data layer identified by the given ``layer_index``, given a navigation_layers ``layer_number`` between 1 and 32. @@ -1450,7 +1450,7 @@ Based on ``value``, enables or disables the specified navigation layer of the Ti .. rst-class:: classref-method -void **set_navigation_layer_layers** **(** :ref:`int` layer_index, :ref:`int` layers **)** +|void| **set_navigation_layer_layers**\ (\ layer_index\: :ref:`int`, layers\: :ref:`int`\ ) Sets the navigation layers (as in the navigation server) for navigation regions in the given TileSet navigation layer. @@ -1462,7 +1462,7 @@ Sets the navigation layers (as in the navigation server) for navigation regions .. rst-class:: classref-method -void **set_occlusion_layer_light_mask** **(** :ref:`int` layer_index, :ref:`int` light_mask **)** +|void| **set_occlusion_layer_light_mask**\ (\ layer_index\: :ref:`int`, light_mask\: :ref:`int`\ ) Sets the occlusion layer (as in the rendering server) for occluders in the given TileSet occlusion layer. @@ -1474,7 +1474,7 @@ Sets the occlusion layer (as in the rendering server) for occluders in the given .. rst-class:: classref-method -void **set_occlusion_layer_sdf_collision** **(** :ref:`int` layer_index, :ref:`bool` sdf_collision **)** +|void| **set_occlusion_layer_sdf_collision**\ (\ layer_index\: :ref:`int`, sdf_collision\: :ref:`bool`\ ) Enables or disables SDF collision for occluders in the given TileSet occlusion layer. @@ -1486,7 +1486,7 @@ Enables or disables SDF collision for occluders in the given TileSet occlusion l .. rst-class:: classref-method -void **set_physics_layer_collision_layer** **(** :ref:`int` layer_index, :ref:`int` layer **)** +|void| **set_physics_layer_collision_layer**\ (\ layer_index\: :ref:`int`, layer\: :ref:`int`\ ) Sets the physics layer (as in the physics server) for bodies in the given TileSet physics layer. @@ -1498,7 +1498,7 @@ Sets the physics layer (as in the physics server) for bodies in the given TileSe .. rst-class:: classref-method -void **set_physics_layer_collision_mask** **(** :ref:`int` layer_index, :ref:`int` mask **)** +|void| **set_physics_layer_collision_mask**\ (\ layer_index\: :ref:`int`, mask\: :ref:`int`\ ) Sets the physics layer (as in the physics server) for bodies in the given TileSet physics layer. @@ -1510,7 +1510,7 @@ Sets the physics layer (as in the physics server) for bodies in the given TileSe .. rst-class:: classref-method -void **set_physics_layer_physics_material** **(** :ref:`int` layer_index, :ref:`PhysicsMaterial` physics_material **)** +|void| **set_physics_layer_physics_material**\ (\ layer_index\: :ref:`int`, physics_material\: :ref:`PhysicsMaterial`\ ) Sets the physics material for bodies in the given TileSet physics layer. @@ -1522,7 +1522,7 @@ Sets the physics material for bodies in the given TileSet physics layer. .. rst-class:: classref-method -void **set_source_id** **(** :ref:`int` source_id, :ref:`int` new_source_id **)** +|void| **set_source_id**\ (\ source_id\: :ref:`int`, new_source_id\: :ref:`int`\ ) Changes a source's ID. @@ -1534,7 +1534,7 @@ Changes a source's ID. .. rst-class:: classref-method -void **set_source_level_tile_proxy** **(** :ref:`int` source_from, :ref:`int` source_to **)** +|void| **set_source_level_tile_proxy**\ (\ source_from\: :ref:`int`, source_to\: :ref:`int`\ ) Creates a source-level proxy for the given source ID. A proxy will map set of tile identifiers to another set of identifiers. Both the atlas coordinates ID and the alternative tile ID are kept the same when using source-level proxies. @@ -1550,7 +1550,7 @@ Proxied tiles can be automatically replaced in TileMap nodes using the editor. .. rst-class:: classref-method -void **set_terrain_color** **(** :ref:`int` terrain_set, :ref:`int` terrain_index, :ref:`Color` color **)** +|void| **set_terrain_color**\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`, color\: :ref:`Color`\ ) Sets a terrain's color. This color is used for identifying the different terrains in the TileSet editor. @@ -1562,7 +1562,7 @@ Sets a terrain's color. This color is used for identifying the different terrain .. rst-class:: classref-method -void **set_terrain_name** **(** :ref:`int` terrain_set, :ref:`int` terrain_index, :ref:`String` name **)** +|void| **set_terrain_name**\ (\ terrain_set\: :ref:`int`, terrain_index\: :ref:`int`, name\: :ref:`String`\ ) Sets a terrain's name. @@ -1574,7 +1574,7 @@ Sets a terrain's name. .. rst-class:: classref-method -void **set_terrain_set_mode** **(** :ref:`int` terrain_set, :ref:`TerrainMode` mode **)** +|void| **set_terrain_set_mode**\ (\ terrain_set\: :ref:`int`, mode\: :ref:`TerrainMode`\ ) Sets a terrain mode. Each mode determines which bits of a tile shape is used to match the neighboring tiles' terrains. @@ -1585,3 +1585,4 @@ Sets a terrain mode. Each mode determines which bits of a tile shape is used to .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_tilesetatlassource.rst b/classes/class_tilesetatlassource.rst index 30624c3f5ee..993285931bc 100644 --- a/classes/class_tilesetatlassource.rst +++ b/classes/class_tilesetatlassource.rst @@ -57,69 +57,69 @@ Methods .. table:: :widths: auto - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_tiles_outside_texture` **(** **)** | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`create_alternative_tile` **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_id_override=-1 **)** | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_tile` **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` size=Vector2i(1, 1) **)** | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_atlas_grid_size` **(** **)** |const| | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_next_alternative_tile_id` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_runtime_texture` **(** **)** |const| | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`get_runtime_tile_texture_region` **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame **)** |const| | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_tile_animation_columns` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_tile_animation_frame_duration` **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame_index **)** |const| | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_tile_animation_frames_count` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TileAnimationMode` | :ref:`get_tile_animation_mode` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_tile_animation_separation` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_tile_animation_speed` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_tile_animation_total_duration` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_tile_at_coords` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TileData` | :ref:`get_tile_data` **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_tile **)** |const| | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_tile_size_in_atlas` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`get_tile_texture_region` **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame=0 **)** |const| | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`get_tiles_to_be_removed_on_change` **(** :ref:`Texture2D` texture, :ref:`Vector2i` margins, :ref:`Vector2i` separation, :ref:`Vector2i` texture_region_size **)** | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_room_for_tile` **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` size, :ref:`int` animation_columns, :ref:`Vector2i` animation_separation, :ref:`int` frames_count, :ref:`Vector2i` ignored_tile=Vector2i(-1, -1) **)** |const| | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_tiles_outside_texture` **(** **)** |const| | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_tile_in_atlas` **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` new_atlas_coords=Vector2i(-1, -1), :ref:`Vector2i` new_size=Vector2i(-1, -1) **)** | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_alternative_tile` **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_tile **)** | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_tile` **(** :ref:`Vector2i` atlas_coords **)** | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_alternative_tile_id` **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_tile, :ref:`int` new_id **)** | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tile_animation_columns` **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame_columns **)** | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tile_animation_frame_duration` **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame_index, :ref:`float` duration **)** | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tile_animation_frames_count` **(** :ref:`Vector2i` atlas_coords, :ref:`int` frames_count **)** | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tile_animation_mode` **(** :ref:`Vector2i` atlas_coords, :ref:`TileAnimationMode` mode **)** | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tile_animation_separation` **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` separation **)** | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tile_animation_speed` **(** :ref:`Vector2i` atlas_coords, :ref:`float` speed **)** | - +---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_tiles_outside_texture`\ (\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`create_alternative_tile`\ (\ atlas_coords\: :ref:`Vector2i`, alternative_id_override\: :ref:`int` = -1\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_tile`\ (\ atlas_coords\: :ref:`Vector2i`, size\: :ref:`Vector2i` = Vector2i(1, 1)\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_atlas_grid_size`\ (\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_next_alternative_tile_id`\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_runtime_texture`\ (\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`get_runtime_tile_texture_region`\ (\ atlas_coords\: :ref:`Vector2i`, frame\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tile_animation_columns`\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_tile_animation_frame_duration`\ (\ atlas_coords\: :ref:`Vector2i`, frame_index\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tile_animation_frames_count`\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TileAnimationMode` | :ref:`get_tile_animation_mode`\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_tile_animation_separation`\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_tile_animation_speed`\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_tile_animation_total_duration`\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_tile_at_coords`\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TileData` | :ref:`get_tile_data`\ (\ atlas_coords\: :ref:`Vector2i`, alternative_tile\: :ref:`int`\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_tile_size_in_atlas`\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`get_tile_texture_region`\ (\ atlas_coords\: :ref:`Vector2i`, frame\: :ref:`int` = 0\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`get_tiles_to_be_removed_on_change`\ (\ texture\: :ref:`Texture2D`, margins\: :ref:`Vector2i`, separation\: :ref:`Vector2i`, texture_region_size\: :ref:`Vector2i`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_room_for_tile`\ (\ atlas_coords\: :ref:`Vector2i`, size\: :ref:`Vector2i`, animation_columns\: :ref:`int`, animation_separation\: :ref:`Vector2i`, frames_count\: :ref:`int`, ignored_tile\: :ref:`Vector2i` = Vector2i(-1, -1)\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_tiles_outside_texture`\ (\ ) |const| | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_tile_in_atlas`\ (\ atlas_coords\: :ref:`Vector2i`, new_atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), new_size\: :ref:`Vector2i` = Vector2i(-1, -1)\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_alternative_tile`\ (\ atlas_coords\: :ref:`Vector2i`, alternative_tile\: :ref:`int`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_tile`\ (\ atlas_coords\: :ref:`Vector2i`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_alternative_tile_id`\ (\ atlas_coords\: :ref:`Vector2i`, alternative_tile\: :ref:`int`, new_id\: :ref:`int`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tile_animation_columns`\ (\ atlas_coords\: :ref:`Vector2i`, frame_columns\: :ref:`int`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tile_animation_frame_duration`\ (\ atlas_coords\: :ref:`Vector2i`, frame_index\: :ref:`int`, duration\: :ref:`float`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tile_animation_frames_count`\ (\ atlas_coords\: :ref:`Vector2i`, frames_count\: :ref:`int`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tile_animation_mode`\ (\ atlas_coords\: :ref:`Vector2i`, mode\: :ref:`TileAnimationMode`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tile_animation_separation`\ (\ atlas_coords\: :ref:`Vector2i`, separation\: :ref:`Vector2i`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tile_animation_speed`\ (\ atlas_coords\: :ref:`Vector2i`, speed\: :ref:`float`\ ) | + +---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -217,8 +217,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_margins** **(** :ref:`Vector2i` value **)** -- :ref:`Vector2i` **get_margins** **(** **)** +- |void| **set_margins**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_margins**\ (\ ) Margins, in pixels, to offset the origin of the grid in the texture. @@ -234,8 +234,8 @@ Margins, in pixels, to offset the origin of the grid in the texture. .. rst-class:: classref-property-setget -- void **set_separation** **(** :ref:`Vector2i` value **)** -- :ref:`Vector2i` **get_separation** **(** **)** +- |void| **set_separation**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_separation**\ (\ ) Separation, in pixels, between each tile texture region of the grid. @@ -251,8 +251,8 @@ Separation, in pixels, between each tile texture region of the grid. .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ ) The atlas texture. @@ -268,8 +268,8 @@ The atlas texture. .. rst-class:: classref-property-setget -- void **set_texture_region_size** **(** :ref:`Vector2i` value **)** -- :ref:`Vector2i` **get_texture_region_size** **(** **)** +- |void| **set_texture_region_size**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_texture_region_size**\ (\ ) The base tile size in the texture (in pixel). This size must be bigger than the TileSet's ``tile_size`` value. @@ -285,8 +285,8 @@ The base tile size in the texture (in pixel). This size must be bigger than the .. rst-class:: classref-property-setget -- void **set_use_texture_padding** **(** :ref:`bool` value **)** -- :ref:`bool` **get_use_texture_padding** **(** **)** +- |void| **set_use_texture_padding**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_use_texture_padding**\ (\ ) If ``true``, generates an internal texture with an additional one pixel padding around each tile. Texture padding avoids a common artifact where lines appear between tiles. @@ -305,7 +305,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear_tiles_outside_texture** **(** **)** +|void| **clear_tiles_outside_texture**\ (\ ) Removes all tiles that don't fit the available texture area. This method iterates over all the source's tiles, so it's advised to use :ref:`has_tiles_outside_texture` beforehand. @@ -317,7 +317,7 @@ Removes all tiles that don't fit the available texture area. This method iterate .. rst-class:: classref-method -:ref:`int` **create_alternative_tile** **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_id_override=-1 **)** +:ref:`int` **create_alternative_tile**\ (\ atlas_coords\: :ref:`Vector2i`, alternative_id_override\: :ref:`int` = -1\ ) Creates an alternative tile for the tile at coordinates ``atlas_coords``. If ``alternative_id_override`` is -1, give it an automatically generated unique ID, or assigns it the given ID otherwise. @@ -331,7 +331,7 @@ Returns the new alternative identifier, or -1 if the alternative could not be cr .. rst-class:: classref-method -void **create_tile** **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` size=Vector2i(1, 1) **)** +|void| **create_tile**\ (\ atlas_coords\: :ref:`Vector2i`, size\: :ref:`Vector2i` = Vector2i(1, 1)\ ) Creates a new tile at coordinates ``atlas_coords`` with the given ``size``. @@ -343,7 +343,7 @@ Creates a new tile at coordinates ``atlas_coords`` with the given ``size``. .. rst-class:: classref-method -:ref:`Vector2i` **get_atlas_grid_size** **(** **)** |const| +:ref:`Vector2i` **get_atlas_grid_size**\ (\ ) |const| Returns the atlas grid size, which depends on how many tiles can fit in the texture. It thus depends on the :ref:`texture`'s size, the atlas :ref:`margins`, and the tiles' :ref:`texture_region_size`. @@ -355,7 +355,7 @@ Returns the atlas grid size, which depends on how many tiles can fit in the text .. rst-class:: classref-method -:ref:`int` **get_next_alternative_tile_id** **(** :ref:`Vector2i` atlas_coords **)** |const| +:ref:`int` **get_next_alternative_tile_id**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| Returns the alternative ID a following call to :ref:`create_alternative_tile` would return. @@ -367,7 +367,7 @@ Returns the alternative ID a following call to :ref:`create_alternative_tile` **get_runtime_texture** **(** **)** |const| +:ref:`Texture2D` **get_runtime_texture**\ (\ ) |const| If :ref:`use_texture_padding` is ``false``, returns :ref:`texture`. Otherwise, returns and internal :ref:`ImageTexture` created that includes the padding. @@ -379,7 +379,7 @@ If :ref:`use_texture_padding` **get_runtime_tile_texture_region** **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame **)** |const| +:ref:`Rect2i` **get_runtime_tile_texture_region**\ (\ atlas_coords\: :ref:`Vector2i`, frame\: :ref:`int`\ ) |const| Returns the region of the tile at coordinates ``atlas_coords`` for the given ``frame`` inside the texture returned by :ref:`get_runtime_texture`. @@ -393,7 +393,7 @@ Returns the region of the tile at coordinates ``atlas_coords`` for the given ``f .. rst-class:: classref-method -:ref:`int` **get_tile_animation_columns** **(** :ref:`Vector2i` atlas_coords **)** |const| +:ref:`int` **get_tile_animation_columns**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| Returns how many columns the tile at ``atlas_coords`` has in its animation layout. @@ -405,7 +405,7 @@ Returns how many columns the tile at ``atlas_coords`` has in its animation layou .. rst-class:: classref-method -:ref:`float` **get_tile_animation_frame_duration** **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame_index **)** |const| +:ref:`float` **get_tile_animation_frame_duration**\ (\ atlas_coords\: :ref:`Vector2i`, frame_index\: :ref:`int`\ ) |const| Returns the animation frame duration of frame ``frame_index`` for the tile at coordinates ``atlas_coords``. @@ -417,7 +417,7 @@ Returns the animation frame duration of frame ``frame_index`` for the tile at co .. rst-class:: classref-method -:ref:`int` **get_tile_animation_frames_count** **(** :ref:`Vector2i` atlas_coords **)** |const| +:ref:`int` **get_tile_animation_frames_count**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| Returns how many animation frames has the tile at coordinates ``atlas_coords``. @@ -429,7 +429,7 @@ Returns how many animation frames has the tile at coordinates ``atlas_coords``. .. rst-class:: classref-method -:ref:`TileAnimationMode` **get_tile_animation_mode** **(** :ref:`Vector2i` atlas_coords **)** |const| +:ref:`TileAnimationMode` **get_tile_animation_mode**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| Returns the tile animation mode of the tile at ``atlas_coords``. See also :ref:`set_tile_animation_mode`. @@ -441,7 +441,7 @@ Returns the tile animation mode of the tile at ``atlas_coords``. See also :ref:` .. rst-class:: classref-method -:ref:`Vector2i` **get_tile_animation_separation** **(** :ref:`Vector2i` atlas_coords **)** |const| +:ref:`Vector2i` **get_tile_animation_separation**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| Returns the separation (as in the atlas grid) between each frame of an animated tile at coordinates ``atlas_coords``. @@ -453,7 +453,7 @@ Returns the separation (as in the atlas grid) between each frame of an animated .. rst-class:: classref-method -:ref:`float` **get_tile_animation_speed** **(** :ref:`Vector2i` atlas_coords **)** |const| +:ref:`float` **get_tile_animation_speed**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| Returns the animation speed of the tile at coordinates ``atlas_coords``. @@ -465,7 +465,7 @@ Returns the animation speed of the tile at coordinates ``atlas_coords``. .. rst-class:: classref-method -:ref:`float` **get_tile_animation_total_duration** **(** :ref:`Vector2i` atlas_coords **)** |const| +:ref:`float` **get_tile_animation_total_duration**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| Returns the sum of the sum of the frame durations of the tile at coordinates ``atlas_coords``. This value needs to be divided by the animation speed to get the actual animation loop duration. @@ -477,7 +477,7 @@ Returns the sum of the sum of the frame durations of the tile at coordinates ``a .. rst-class:: classref-method -:ref:`Vector2i` **get_tile_at_coords** **(** :ref:`Vector2i` atlas_coords **)** |const| +:ref:`Vector2i` **get_tile_at_coords**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| If there is a tile covering the ``atlas_coords`` coordinates, returns the top-left coordinates of the tile (thus its coordinate ID). Returns ``Vector2i(-1, -1)`` otherwise. @@ -489,7 +489,7 @@ If there is a tile covering the ``atlas_coords`` coordinates, returns the top-le .. rst-class:: classref-method -:ref:`TileData` **get_tile_data** **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_tile **)** |const| +:ref:`TileData` **get_tile_data**\ (\ atlas_coords\: :ref:`Vector2i`, alternative_tile\: :ref:`int`\ ) |const| Returns the :ref:`TileData` object for the given atlas coordinates and alternative ID. @@ -501,7 +501,7 @@ Returns the :ref:`TileData` object for the given atlas coordinat .. rst-class:: classref-method -:ref:`Vector2i` **get_tile_size_in_atlas** **(** :ref:`Vector2i` atlas_coords **)** |const| +:ref:`Vector2i` **get_tile_size_in_atlas**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| Returns the size of the tile (in the grid coordinates system) at coordinates ``atlas_coords``. @@ -513,7 +513,7 @@ Returns the size of the tile (in the grid coordinates system) at coordinates ``a .. rst-class:: classref-method -:ref:`Rect2i` **get_tile_texture_region** **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame=0 **)** |const| +:ref:`Rect2i` **get_tile_texture_region**\ (\ atlas_coords\: :ref:`Vector2i`, frame\: :ref:`int` = 0\ ) |const| Returns a tile's texture region in the atlas texture. For animated tiles, a ``frame`` argument might be provided for the different frames of the animation. @@ -525,7 +525,7 @@ Returns a tile's texture region in the atlas texture. For animated tiles, a ``fr .. rst-class:: classref-method -:ref:`PackedVector2Array` **get_tiles_to_be_removed_on_change** **(** :ref:`Texture2D` texture, :ref:`Vector2i` margins, :ref:`Vector2i` separation, :ref:`Vector2i` texture_region_size **)** +:ref:`PackedVector2Array` **get_tiles_to_be_removed_on_change**\ (\ texture\: :ref:`Texture2D`, margins\: :ref:`Vector2i`, separation\: :ref:`Vector2i`, texture_region_size\: :ref:`Vector2i`\ ) Returns an array of tiles coordinates ID that will be automatically removed when modifying one or several of those properties: ``texture``, ``margins``, ``separation`` or ``texture_region_size``. This can be used to undo changes that would have caused tiles data loss. @@ -537,7 +537,7 @@ Returns an array of tiles coordinates ID that will be automatically removed when .. rst-class:: classref-method -:ref:`bool` **has_room_for_tile** **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` size, :ref:`int` animation_columns, :ref:`Vector2i` animation_separation, :ref:`int` frames_count, :ref:`Vector2i` ignored_tile=Vector2i(-1, -1) **)** |const| +:ref:`bool` **has_room_for_tile**\ (\ atlas_coords\: :ref:`Vector2i`, size\: :ref:`Vector2i`, animation_columns\: :ref:`int`, animation_separation\: :ref:`Vector2i`, frames_count\: :ref:`int`, ignored_tile\: :ref:`Vector2i` = Vector2i(-1, -1)\ ) |const| Returns whether there is enough room in an atlas to create/modify a tile with the given properties. If ``ignored_tile`` is provided, act as is the given tile was not present in the atlas. This may be used when you want to modify a tile's properties. @@ -549,7 +549,7 @@ Returns whether there is enough room in an atlas to create/modify a tile with th .. rst-class:: classref-method -:ref:`bool` **has_tiles_outside_texture** **(** **)** |const| +:ref:`bool` **has_tiles_outside_texture**\ (\ ) |const| Checks if the source has any tiles that don't fit the texture area (either partially or completely). @@ -561,7 +561,7 @@ Checks if the source has any tiles that don't fit the texture area (either parti .. rst-class:: classref-method -void **move_tile_in_atlas** **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` new_atlas_coords=Vector2i(-1, -1), :ref:`Vector2i` new_size=Vector2i(-1, -1) **)** +|void| **move_tile_in_atlas**\ (\ atlas_coords\: :ref:`Vector2i`, new_atlas_coords\: :ref:`Vector2i` = Vector2i(-1, -1), new_size\: :ref:`Vector2i` = Vector2i(-1, -1)\ ) Move the tile and its alternatives at the ``atlas_coords`` coordinates to the ``new_atlas_coords`` coordinates with the ``new_size`` size. This functions will fail if a tile is already present in the given area. @@ -577,7 +577,7 @@ To avoid an error, first check if a move is possible using :ref:`has_room_for_ti .. rst-class:: classref-method -void **remove_alternative_tile** **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_tile **)** +|void| **remove_alternative_tile**\ (\ atlas_coords\: :ref:`Vector2i`, alternative_tile\: :ref:`int`\ ) Remove a tile's alternative with alternative ID ``alternative_tile``. @@ -591,7 +591,7 @@ Calling this function with ``alternative_tile`` equals to 0 will fail, as the ba .. rst-class:: classref-method -void **remove_tile** **(** :ref:`Vector2i` atlas_coords **)** +|void| **remove_tile**\ (\ atlas_coords\: :ref:`Vector2i`\ ) Remove a tile and its alternative at coordinates ``atlas_coords``. @@ -603,7 +603,7 @@ Remove a tile and its alternative at coordinates ``atlas_coords``. .. rst-class:: classref-method -void **set_alternative_tile_id** **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_tile, :ref:`int` new_id **)** +|void| **set_alternative_tile_id**\ (\ atlas_coords\: :ref:`Vector2i`, alternative_tile\: :ref:`int`, new_id\: :ref:`int`\ ) Change a tile's alternative ID from ``alternative_tile`` to ``new_id``. @@ -617,7 +617,7 @@ Calling this function with ``new_id`` of 0 will fail, as the base tile alternati .. rst-class:: classref-method -void **set_tile_animation_columns** **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame_columns **)** +|void| **set_tile_animation_columns**\ (\ atlas_coords\: :ref:`Vector2i`, frame_columns\: :ref:`int`\ ) Sets the number of columns in the animation layout of the tile at coordinates ``atlas_coords``. If set to 0, then the different frames of the animation are laid out as a single horizontal line in the atlas. @@ -629,7 +629,7 @@ Sets the number of columns in the animation layout of the tile at coordinates `` .. rst-class:: classref-method -void **set_tile_animation_frame_duration** **(** :ref:`Vector2i` atlas_coords, :ref:`int` frame_index, :ref:`float` duration **)** +|void| **set_tile_animation_frame_duration**\ (\ atlas_coords\: :ref:`Vector2i`, frame_index\: :ref:`int`, duration\: :ref:`float`\ ) Sets the animation frame ``duration`` of frame ``frame_index`` for the tile at coordinates ``atlas_coords``. @@ -641,7 +641,7 @@ Sets the animation frame ``duration`` of frame ``frame_index`` for the tile at c .. rst-class:: classref-method -void **set_tile_animation_frames_count** **(** :ref:`Vector2i` atlas_coords, :ref:`int` frames_count **)** +|void| **set_tile_animation_frames_count**\ (\ atlas_coords\: :ref:`Vector2i`, frames_count\: :ref:`int`\ ) Sets how many animation frames the tile at coordinates ``atlas_coords`` has. @@ -653,7 +653,7 @@ Sets how many animation frames the tile at coordinates ``atlas_coords`` has. .. rst-class:: classref-method -void **set_tile_animation_mode** **(** :ref:`Vector2i` atlas_coords, :ref:`TileAnimationMode` mode **)** +|void| **set_tile_animation_mode**\ (\ atlas_coords\: :ref:`Vector2i`, mode\: :ref:`TileAnimationMode`\ ) Sets the tile animation mode of the tile at ``atlas_coords`` to ``mode``. See also :ref:`get_tile_animation_mode`. @@ -665,7 +665,7 @@ Sets the tile animation mode of the tile at ``atlas_coords`` to ``mode``. See al .. rst-class:: classref-method -void **set_tile_animation_separation** **(** :ref:`Vector2i` atlas_coords, :ref:`Vector2i` separation **)** +|void| **set_tile_animation_separation**\ (\ atlas_coords\: :ref:`Vector2i`, separation\: :ref:`Vector2i`\ ) Sets the margin (in grid tiles) between each tile in the animation layout of the tile at coordinates ``atlas_coords`` has. @@ -677,7 +677,7 @@ Sets the margin (in grid tiles) between each tile in the animation layout of the .. rst-class:: classref-method -void **set_tile_animation_speed** **(** :ref:`Vector2i` atlas_coords, :ref:`float` speed **)** +|void| **set_tile_animation_speed**\ (\ atlas_coords\: :ref:`Vector2i`, speed\: :ref:`float`\ ) Sets the animation speed of the tile at coordinates ``atlas_coords`` has. @@ -688,3 +688,4 @@ Sets the animation speed of the tile at coordinates ``atlas_coords`` has. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_tilesetscenescollectionsource.rst b/classes/class_tilesetscenescollectionsource.rst index 10e762131e9..ab4e3b3d2c2 100644 --- a/classes/class_tilesetscenescollectionsource.rst +++ b/classes/class_tilesetscenescollectionsource.rst @@ -31,29 +31,29 @@ Methods .. table:: :widths: auto - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`create_scene_tile` **(** :ref:`PackedScene` packed_scene, :ref:`int` id_override=-1 **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_next_scene_tile_id` **(** **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_scene_tile_display_placeholder` **(** :ref:`int` id **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_scene_tile_id` **(** :ref:`int` index **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedScene` | :ref:`get_scene_tile_scene` **(** :ref:`int` id **)** |const| | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_scene_tiles_count` **(** **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_scene_tile_id` **(** :ref:`int` id **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_scene_tile` **(** :ref:`int` id **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_scene_tile_display_placeholder` **(** :ref:`int` id, :ref:`bool` display_placeholder **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_scene_tile_id` **(** :ref:`int` id, :ref:`int` new_id **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_scene_tile_scene` **(** :ref:`int` id, :ref:`PackedScene` packed_scene **)** | - +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`create_scene_tile`\ (\ packed_scene\: :ref:`PackedScene`, id_override\: :ref:`int` = -1\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_next_scene_tile_id`\ (\ ) |const| | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_scene_tile_display_placeholder`\ (\ id\: :ref:`int`\ ) |const| | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_scene_tile_id`\ (\ index\: :ref:`int`\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedScene` | :ref:`get_scene_tile_scene`\ (\ id\: :ref:`int`\ ) |const| | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_scene_tiles_count`\ (\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_scene_tile_id`\ (\ id\: :ref:`int`\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_scene_tile`\ (\ id\: :ref:`int`\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_scene_tile_display_placeholder`\ (\ id\: :ref:`int`, display_placeholder\: :ref:`bool`\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_scene_tile_id`\ (\ id\: :ref:`int`, new_id\: :ref:`int`\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_scene_tile_scene`\ (\ id\: :ref:`int`, packed_scene\: :ref:`PackedScene`\ ) | + +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -68,7 +68,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **create_scene_tile** **(** :ref:`PackedScene` packed_scene, :ref:`int` id_override=-1 **)** +:ref:`int` **create_scene_tile**\ (\ packed_scene\: :ref:`PackedScene`, id_override\: :ref:`int` = -1\ ) Creates a scene-based tile out of the given scene. @@ -82,7 +82,7 @@ Returns a newly generated unique ID. .. rst-class:: classref-method -:ref:`int` **get_next_scene_tile_id** **(** **)** |const| +:ref:`int` **get_next_scene_tile_id**\ (\ ) |const| Returns the scene ID a following call to :ref:`create_scene_tile` would return. @@ -94,7 +94,7 @@ Returns the scene ID a following call to :ref:`create_scene_tile` **get_scene_tile_display_placeholder** **(** :ref:`int` id **)** |const| +:ref:`bool` **get_scene_tile_display_placeholder**\ (\ id\: :ref:`int`\ ) |const| Returns whether the scene tile with ``id`` displays a placeholder in the editor. @@ -106,7 +106,7 @@ Returns whether the scene tile with ``id`` displays a placeholder in the editor. .. rst-class:: classref-method -:ref:`int` **get_scene_tile_id** **(** :ref:`int` index **)** +:ref:`int` **get_scene_tile_id**\ (\ index\: :ref:`int`\ ) Returns the scene tile ID of the scene tile at ``index``. @@ -118,7 +118,7 @@ Returns the scene tile ID of the scene tile at ``index``. .. rst-class:: classref-method -:ref:`PackedScene` **get_scene_tile_scene** **(** :ref:`int` id **)** |const| +:ref:`PackedScene` **get_scene_tile_scene**\ (\ id\: :ref:`int`\ ) |const| Returns the :ref:`PackedScene` resource of scene tile with ``id``. @@ -130,7 +130,7 @@ Returns the :ref:`PackedScene` resource of scene tile with `` .. rst-class:: classref-method -:ref:`int` **get_scene_tiles_count** **(** **)** +:ref:`int` **get_scene_tiles_count**\ (\ ) Returns the number or scene tiles this TileSet source has. @@ -142,7 +142,7 @@ Returns the number or scene tiles this TileSet source has. .. rst-class:: classref-method -:ref:`bool` **has_scene_tile_id** **(** :ref:`int` id **)** +:ref:`bool` **has_scene_tile_id**\ (\ id\: :ref:`int`\ ) Returns whether this TileSet source has a scene tile with ``id``. @@ -154,7 +154,7 @@ Returns whether this TileSet source has a scene tile with ``id``. .. rst-class:: classref-method -void **remove_scene_tile** **(** :ref:`int` id **)** +|void| **remove_scene_tile**\ (\ id\: :ref:`int`\ ) Remove the scene tile with ``id``. @@ -166,7 +166,7 @@ Remove the scene tile with ``id``. .. rst-class:: classref-method -void **set_scene_tile_display_placeholder** **(** :ref:`int` id, :ref:`bool` display_placeholder **)** +|void| **set_scene_tile_display_placeholder**\ (\ id\: :ref:`int`, display_placeholder\: :ref:`bool`\ ) Sets whether or not the scene tile with ``id`` should display a placeholder in the editor. This might be useful for scenes that are not visible. @@ -178,7 +178,7 @@ Sets whether or not the scene tile with ``id`` should display a placeholder in t .. rst-class:: classref-method -void **set_scene_tile_id** **(** :ref:`int` id, :ref:`int` new_id **)** +|void| **set_scene_tile_id**\ (\ id\: :ref:`int`, new_id\: :ref:`int`\ ) Changes a scene tile's ID from ``id`` to ``new_id``. This will fail if there is already a tile with an ID equal to ``new_id``. @@ -190,7 +190,7 @@ Changes a scene tile's ID from ``id`` to ``new_id``. This will fail if there is .. rst-class:: classref-method -void **set_scene_tile_scene** **(** :ref:`int` id, :ref:`PackedScene` packed_scene **)** +|void| **set_scene_tile_scene**\ (\ id\: :ref:`int`, packed_scene\: :ref:`PackedScene`\ ) Assigns a :ref:`PackedScene` resource to the scene tile with ``id``. This will fail if the scene does not extend CanvasItem, as positioning properties are needed to place the scene on the TileMap. @@ -201,3 +201,4 @@ Assigns a :ref:`PackedScene` resource to the scene tile with .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_tilesetsource.rst b/classes/class_tilesetsource.rst index 479f32b6730..731f230bb3e 100644 --- a/classes/class_tilesetsource.rst +++ b/classes/class_tilesetsource.rst @@ -39,19 +39,19 @@ Methods .. table:: :widths: auto - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_alternative_tile_id` **(** :ref:`Vector2i` atlas_coords, :ref:`int` index **)** |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_alternative_tiles_count` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_tile_id` **(** :ref:`int` index **)** |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_tiles_count` **(** **)** |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_alternative_tile` **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_tile **)** |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_tile` **(** :ref:`Vector2i` atlas_coords **)** |const| | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_alternative_tile_id`\ (\ atlas_coords\: :ref:`Vector2i`, index\: :ref:`int`\ ) |const| | + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_alternative_tiles_count`\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| | + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_tile_id`\ (\ index\: :ref:`int`\ ) |const| | + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tiles_count`\ (\ ) |const| | + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_alternative_tile`\ (\ atlas_coords\: :ref:`Vector2i`, alternative_tile\: :ref:`int`\ ) |const| | + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_tile`\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| | + +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -66,7 +66,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_alternative_tile_id** **(** :ref:`Vector2i` atlas_coords, :ref:`int` index **)** |const| +:ref:`int` **get_alternative_tile_id**\ (\ atlas_coords\: :ref:`Vector2i`, index\: :ref:`int`\ ) |const| Returns the alternative ID for the tile with coordinates ID ``atlas_coords`` at index ``index``. @@ -78,7 +78,7 @@ Returns the alternative ID for the tile with coordinates ID ``atlas_coords`` at .. rst-class:: classref-method -:ref:`int` **get_alternative_tiles_count** **(** :ref:`Vector2i` atlas_coords **)** |const| +:ref:`int` **get_alternative_tiles_count**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| Returns the number of alternatives tiles for the coordinates ID ``atlas_coords``. @@ -94,7 +94,7 @@ Returns -1 if there is not tile at the given coords. .. rst-class:: classref-method -:ref:`Vector2i` **get_tile_id** **(** :ref:`int` index **)** |const| +:ref:`Vector2i` **get_tile_id**\ (\ index\: :ref:`int`\ ) |const| Returns the tile coordinates ID of the tile with index ``index``. @@ -106,7 +106,7 @@ Returns the tile coordinates ID of the tile with index ``index``. .. rst-class:: classref-method -:ref:`int` **get_tiles_count** **(** **)** |const| +:ref:`int` **get_tiles_count**\ (\ ) |const| Returns how many tiles this atlas source defines (not including alternative tiles). @@ -118,7 +118,7 @@ Returns how many tiles this atlas source defines (not including alternative tile .. rst-class:: classref-method -:ref:`bool` **has_alternative_tile** **(** :ref:`Vector2i` atlas_coords, :ref:`int` alternative_tile **)** |const| +:ref:`bool` **has_alternative_tile**\ (\ atlas_coords\: :ref:`Vector2i`, alternative_tile\: :ref:`int`\ ) |const| Returns if the base tile at coordinates ``atlas_coords`` has an alternative with ID ``alternative_tile``. @@ -130,7 +130,7 @@ Returns if the base tile at coordinates ``atlas_coords`` has an alternative with .. rst-class:: classref-method -:ref:`bool` **has_tile** **(** :ref:`Vector2i` atlas_coords **)** |const| +:ref:`bool` **has_tile**\ (\ atlas_coords\: :ref:`Vector2i`\ ) |const| Returns if this atlas has a tile with coordinates ID ``atlas_coords``. @@ -141,3 +141,4 @@ Returns if this atlas has a tile with coordinates ID ``atlas_coords``. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_time.rst b/classes/class_time.rst index e9717ca618b..8455fd4d4fc 100644 --- a/classes/class_time.rst +++ b/classes/class_time.rst @@ -37,49 +37,49 @@ Methods .. table:: :widths: auto - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_date_dict_from_system` **(** :ref:`bool` utc=false **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_date_dict_from_unix_time` **(** :ref:`int` unix_time_val **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_date_string_from_system` **(** :ref:`bool` utc=false **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_date_string_from_unix_time` **(** :ref:`int` unix_time_val **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_datetime_dict_from_datetime_string` **(** :ref:`String` datetime, :ref:`bool` weekday **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_datetime_dict_from_system` **(** :ref:`bool` utc=false **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_datetime_dict_from_unix_time` **(** :ref:`int` unix_time_val **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_datetime_string_from_datetime_dict` **(** :ref:`Dictionary` datetime, :ref:`bool` use_space **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_datetime_string_from_system` **(** :ref:`bool` utc=false, :ref:`bool` use_space=false **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_datetime_string_from_unix_time` **(** :ref:`int` unix_time_val, :ref:`bool` use_space=false **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_offset_string_from_offset_minutes` **(** :ref:`int` offset_minutes **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_ticks_msec` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_ticks_usec` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_time_dict_from_system` **(** :ref:`bool` utc=false **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_time_dict_from_unix_time` **(** :ref:`int` unix_time_val **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_time_string_from_system` **(** :ref:`bool` utc=false **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_time_string_from_unix_time` **(** :ref:`int` unix_time_val **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_time_zone_from_system` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_unix_time_from_datetime_dict` **(** :ref:`Dictionary` datetime **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_unix_time_from_datetime_string` **(** :ref:`String` datetime **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_unix_time_from_system` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_date_dict_from_system`\ (\ utc\: :ref:`bool` = false\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_date_dict_from_unix_time`\ (\ unix_time_val\: :ref:`int`\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_date_string_from_system`\ (\ utc\: :ref:`bool` = false\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_date_string_from_unix_time`\ (\ unix_time_val\: :ref:`int`\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_datetime_dict_from_datetime_string`\ (\ datetime\: :ref:`String`, weekday\: :ref:`bool`\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_datetime_dict_from_system`\ (\ utc\: :ref:`bool` = false\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_datetime_dict_from_unix_time`\ (\ unix_time_val\: :ref:`int`\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_datetime_string_from_datetime_dict`\ (\ datetime\: :ref:`Dictionary`, use_space\: :ref:`bool`\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_datetime_string_from_system`\ (\ utc\: :ref:`bool` = false, use_space\: :ref:`bool` = false\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_datetime_string_from_unix_time`\ (\ unix_time_val\: :ref:`int`, use_space\: :ref:`bool` = false\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_offset_string_from_offset_minutes`\ (\ offset_minutes\: :ref:`int`\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_ticks_msec`\ (\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_ticks_usec`\ (\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_time_dict_from_system`\ (\ utc\: :ref:`bool` = false\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_time_dict_from_unix_time`\ (\ unix_time_val\: :ref:`int`\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_time_string_from_system`\ (\ utc\: :ref:`bool` = false\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_time_string_from_unix_time`\ (\ unix_time_val\: :ref:`int`\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_time_zone_from_system`\ (\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_unix_time_from_datetime_dict`\ (\ datetime\: :ref:`Dictionary`\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_unix_time_from_datetime_string`\ (\ datetime\: :ref:`String`\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_unix_time_from_system`\ (\ ) |const| | + +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -271,7 +271,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Dictionary` **get_date_dict_from_system** **(** :ref:`bool` utc=false **)** |const| +:ref:`Dictionary` **get_date_dict_from_system**\ (\ utc\: :ref:`bool` = false\ ) |const| Returns the current date as a dictionary of keys: ``year``, ``month``, ``day``, and ``weekday``. @@ -285,7 +285,7 @@ The returned values are in the system's local time when ``utc`` is ``false``, ot .. rst-class:: classref-method -:ref:`Dictionary` **get_date_dict_from_unix_time** **(** :ref:`int` unix_time_val **)** |const| +:ref:`Dictionary` **get_date_dict_from_unix_time**\ (\ unix_time_val\: :ref:`int`\ ) |const| Converts the given Unix timestamp to a dictionary of keys: ``year``, ``month``, ``day``, and ``weekday``. @@ -297,7 +297,7 @@ Converts the given Unix timestamp to a dictionary of keys: ``year``, ``month``, .. rst-class:: classref-method -:ref:`String` **get_date_string_from_system** **(** :ref:`bool` utc=false **)** |const| +:ref:`String` **get_date_string_from_system**\ (\ utc\: :ref:`bool` = false\ ) |const| Returns the current date as an ISO 8601 date string (YYYY-MM-DD). @@ -311,7 +311,7 @@ The returned values are in the system's local time when ``utc`` is ``false``, ot .. rst-class:: classref-method -:ref:`String` **get_date_string_from_unix_time** **(** :ref:`int` unix_time_val **)** |const| +:ref:`String` **get_date_string_from_unix_time**\ (\ unix_time_val\: :ref:`int`\ ) |const| Converts the given Unix timestamp to an ISO 8601 date string (YYYY-MM-DD). @@ -323,7 +323,7 @@ Converts the given Unix timestamp to an ISO 8601 date string (YYYY-MM-DD). .. rst-class:: classref-method -:ref:`Dictionary` **get_datetime_dict_from_datetime_string** **(** :ref:`String` datetime, :ref:`bool` weekday **)** |const| +:ref:`Dictionary` **get_datetime_dict_from_datetime_string**\ (\ datetime\: :ref:`String`, weekday\: :ref:`bool`\ ) |const| Converts the given ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS) to a dictionary of keys: ``year``, ``month``, ``day``, ``weekday``, ``hour``, ``minute``, and ``second``. @@ -339,7 +339,7 @@ If ``weekday`` is ``false``, then the ``weekday`` entry is excluded (the calcula .. rst-class:: classref-method -:ref:`Dictionary` **get_datetime_dict_from_system** **(** :ref:`bool` utc=false **)** |const| +:ref:`Dictionary` **get_datetime_dict_from_system**\ (\ utc\: :ref:`bool` = false\ ) |const| Returns the current date as a dictionary of keys: ``year``, ``month``, ``day``, ``weekday``, ``hour``, ``minute``, ``second``, and ``dst`` (Daylight Savings Time). @@ -351,7 +351,7 @@ Returns the current date as a dictionary of keys: ``year``, ``month``, ``day``, .. rst-class:: classref-method -:ref:`Dictionary` **get_datetime_dict_from_unix_time** **(** :ref:`int` unix_time_val **)** |const| +:ref:`Dictionary` **get_datetime_dict_from_unix_time**\ (\ unix_time_val\: :ref:`int`\ ) |const| Converts the given Unix timestamp to a dictionary of keys: ``year``, ``month``, ``day``, ``weekday``, ``hour``, ``minute``, and ``second``. @@ -365,7 +365,7 @@ The returned Dictionary's values will be the same as the :ref:`get_datetime_dict .. rst-class:: classref-method -:ref:`String` **get_datetime_string_from_datetime_dict** **(** :ref:`Dictionary` datetime, :ref:`bool` use_space **)** |const| +:ref:`String` **get_datetime_string_from_datetime_dict**\ (\ datetime\: :ref:`Dictionary`, use_space\: :ref:`bool`\ ) |const| Converts the given dictionary of keys to an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS). @@ -383,7 +383,7 @@ If ``use_space`` is ``true``, the date and time bits are separated by an empty s .. rst-class:: classref-method -:ref:`String` **get_datetime_string_from_system** **(** :ref:`bool` utc=false, :ref:`bool` use_space=false **)** |const| +:ref:`String` **get_datetime_string_from_system**\ (\ utc\: :ref:`bool` = false, use_space\: :ref:`bool` = false\ ) |const| Returns the current date and time as an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS). @@ -399,7 +399,7 @@ If ``use_space`` is ``true``, the date and time bits are separated by an empty s .. rst-class:: classref-method -:ref:`String` **get_datetime_string_from_unix_time** **(** :ref:`int` unix_time_val, :ref:`bool` use_space=false **)** |const| +:ref:`String` **get_datetime_string_from_unix_time**\ (\ unix_time_val\: :ref:`int`, use_space\: :ref:`bool` = false\ ) |const| Converts the given Unix timestamp to an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS). @@ -413,7 +413,7 @@ If ``use_space`` is ``true``, the date and time bits are separated by an empty s .. rst-class:: classref-method -:ref:`String` **get_offset_string_from_offset_minutes** **(** :ref:`int` offset_minutes **)** |const| +:ref:`String` **get_offset_string_from_offset_minutes**\ (\ offset_minutes\: :ref:`int`\ ) |const| Converts the given timezone offset in minutes to a timezone offset string. For example, -480 returns "-08:00", 345 returns "+05:45", and 0 returns "+00:00". @@ -425,7 +425,7 @@ Converts the given timezone offset in minutes to a timezone offset string. For e .. rst-class:: classref-method -:ref:`int` **get_ticks_msec** **(** **)** |const| +:ref:`int` **get_ticks_msec**\ (\ ) |const| Returns the amount of time passed in milliseconds since the engine started. @@ -439,7 +439,7 @@ Will always be positive or 0 and uses a 64-bit value (it will wrap after roughly .. rst-class:: classref-method -:ref:`int` **get_ticks_usec** **(** **)** |const| +:ref:`int` **get_ticks_usec**\ (\ ) |const| Returns the amount of time passed in microseconds since the engine started. @@ -453,7 +453,7 @@ Will always be positive or 0 and uses a 64-bit value (it will wrap after roughly .. rst-class:: classref-method -:ref:`Dictionary` **get_time_dict_from_system** **(** :ref:`bool` utc=false **)** |const| +:ref:`Dictionary` **get_time_dict_from_system**\ (\ utc\: :ref:`bool` = false\ ) |const| Returns the current time as a dictionary of keys: ``hour``, ``minute``, and ``second``. @@ -467,7 +467,7 @@ The returned values are in the system's local time when ``utc`` is ``false``, ot .. rst-class:: classref-method -:ref:`Dictionary` **get_time_dict_from_unix_time** **(** :ref:`int` unix_time_val **)** |const| +:ref:`Dictionary` **get_time_dict_from_unix_time**\ (\ unix_time_val\: :ref:`int`\ ) |const| Converts the given time to a dictionary of keys: ``hour``, ``minute``, and ``second``. @@ -479,7 +479,7 @@ Converts the given time to a dictionary of keys: ``hour``, ``minute``, and ``sec .. rst-class:: classref-method -:ref:`String` **get_time_string_from_system** **(** :ref:`bool` utc=false **)** |const| +:ref:`String` **get_time_string_from_system**\ (\ utc\: :ref:`bool` = false\ ) |const| Returns the current time as an ISO 8601 time string (HH:MM:SS). @@ -493,7 +493,7 @@ The returned values are in the system's local time when ``utc`` is ``false``, ot .. rst-class:: classref-method -:ref:`String` **get_time_string_from_unix_time** **(** :ref:`int` unix_time_val **)** |const| +:ref:`String` **get_time_string_from_unix_time**\ (\ unix_time_val\: :ref:`int`\ ) |const| Converts the given Unix timestamp to an ISO 8601 time string (HH:MM:SS). @@ -505,7 +505,7 @@ Converts the given Unix timestamp to an ISO 8601 time string (HH:MM:SS). .. rst-class:: classref-method -:ref:`Dictionary` **get_time_zone_from_system** **(** **)** |const| +:ref:`Dictionary` **get_time_zone_from_system**\ (\ ) |const| Returns the current time zone as a dictionary of keys: ``bias`` and ``name``. @@ -521,7 +521,7 @@ Returns the current time zone as a dictionary of keys: ``bias`` and ``name``. .. rst-class:: classref-method -:ref:`int` **get_unix_time_from_datetime_dict** **(** :ref:`Dictionary` datetime **)** |const| +:ref:`int` **get_unix_time_from_datetime_dict**\ (\ datetime\: :ref:`Dictionary`\ ) |const| Converts a dictionary of time values to a Unix timestamp. @@ -541,7 +541,7 @@ You can pass the output from :ref:`get_datetime_dict_from_unix_time` **get_unix_time_from_datetime_string** **(** :ref:`String` datetime **)** |const| +:ref:`int` **get_unix_time_from_datetime_string**\ (\ datetime\: :ref:`String`\ ) |const| Converts the given ISO 8601 date and/or time string to a Unix timestamp. The string can contain a date only, a time only, or both. @@ -557,7 +557,7 @@ Converts the given ISO 8601 date and/or time string to a Unix timestamp. The str .. rst-class:: classref-method -:ref:`float` **get_unix_time_from_system** **(** **)** |const| +:ref:`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. @@ -570,3 +570,4 @@ Returns the current Unix timestamp in seconds based on the system time in UTC. T .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_timer.rst b/classes/class_timer.rst index c353e06fd76..d281725fbe3 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -62,13 +62,13 @@ Methods .. table:: :widths: auto - +-------------------------+------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_stopped` **(** **)** |const| | - +-------------------------+------------------------------------------------------------------------------------------+ - | void | :ref:`start` **(** :ref:`float` time_sec=-1 **)** | - +-------------------------+------------------------------------------------------------------------------------------+ - | void | :ref:`stop` **(** **)** | - +-------------------------+------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_stopped`\ (\ ) |const| | + +-------------------------+-----------------------------------------------------------------------------------------+ + | |void| | :ref:`start`\ (\ time_sec\: :ref:`float` = -1\ ) | + +-------------------------+-----------------------------------------------------------------------------------------+ + | |void| | :ref:`stop`\ (\ ) | + +-------------------------+-----------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -83,7 +83,7 @@ Signals .. rst-class:: classref-signal -**timeout** **(** **)** +**timeout**\ (\ ) Emitted when the timer reaches the end. @@ -135,8 +135,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_autostart** **(** :ref:`bool` value **)** -- :ref:`bool` **has_autostart** **(** **)** +- |void| **set_autostart**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **has_autostart**\ (\ ) If ``true``, the timer will start immediately when it enters the scene tree. @@ -154,8 +154,8 @@ If ``true``, the timer will start immediately when it enters the scene tree. .. rst-class:: classref-property-setget -- void **set_one_shot** **(** :ref:`bool` value **)** -- :ref:`bool` **is_one_shot** **(** **)** +- |void| **set_one_shot**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_one_shot**\ (\ ) If ``true``, the timer will stop after reaching the end. Otherwise, as by default, the timer will automatically restart. @@ -171,8 +171,8 @@ If ``true``, the timer will stop after reaching the end. Otherwise, as by defaul .. rst-class:: classref-property-setget -- void **set_paused** **(** :ref:`bool` value **)** -- :ref:`bool` **is_paused** **(** **)** +- |void| **set_paused**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_paused**\ (\ ) If ``true``, the timer is paused. A paused timer does not process until this property is set back to ``false``, even when :ref:`start` is called. @@ -188,8 +188,8 @@ If ``true``, the timer is paused. A paused timer does not process until this pro .. rst-class:: classref-property-setget -- void **set_timer_process_callback** **(** :ref:`TimerProcessCallback` value **)** -- :ref:`TimerProcessCallback` **get_timer_process_callback** **(** **)** +- |void| **set_timer_process_callback**\ (\ value\: :ref:`TimerProcessCallback`\ ) +- :ref:`TimerProcessCallback` **get_timer_process_callback**\ (\ ) Specifies when the timer is updated during the main loop (see :ref:`TimerProcessCallback`). @@ -205,7 +205,7 @@ Specifies when the timer is updated during the main loop (see :ref:`TimerProcess .. rst-class:: classref-property-setget -- :ref:`float` **get_time_left** **(** **)** +- :ref:`float` **get_time_left**\ (\ ) The timer's remaining time in seconds. This is always ``0`` if the timer is stopped. @@ -223,8 +223,8 @@ The timer's remaining time in seconds. This is always ``0`` if the timer is stop .. rst-class:: classref-property-setget -- void **set_wait_time** **(** :ref:`float` value **)** -- :ref:`float` **get_wait_time** **(** **)** +- |void| **set_wait_time**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_wait_time**\ (\ ) The time required for the timer to end, in seconds. This property can also be set every time :ref:`start` is called. @@ -243,7 +243,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_stopped** **(** **)** |const| +:ref:`bool` **is_stopped**\ (\ ) |const| Returns ``true`` if the timer is stopped or has not started. @@ -255,7 +255,7 @@ Returns ``true`` if the timer is stopped or has not started. .. rst-class:: classref-method -void **start** **(** :ref:`float` time_sec=-1 **)** +|void| **start**\ (\ time_sec\: :ref:`float` = -1\ ) Starts the timer, if it was not started already. Fails if the timer is not inside the tree. If ``time_sec`` is greater than ``0``, this value is used for the :ref:`wait_time`. @@ -269,7 +269,7 @@ Starts the timer, if it was not started already. Fails if the timer is not insid .. rst-class:: classref-method -void **stop** **(** **)** +|void| **stop**\ (\ ) Stops the timer. @@ -280,3 +280,4 @@ Stops the timer. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_tlsoptions.rst b/classes/class_tlsoptions.rst index 8a31c59db85..ac89b5bd773 100644 --- a/classes/class_tlsoptions.rst +++ b/classes/class_tlsoptions.rst @@ -47,13 +47,13 @@ Methods .. table:: :widths: auto - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TLSOptions` | :ref:`client` **(** :ref:`X509Certificate` trusted_chain=null, :ref:`String` common_name_override="" **)** |static| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TLSOptions` | :ref:`client_unsafe` **(** :ref:`X509Certificate` trusted_chain=null **)** |static| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TLSOptions` | :ref:`server` **(** :ref:`CryptoKey` key, :ref:`X509Certificate` certificate **)** |static| | - +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TLSOptions` | :ref:`client`\ (\ trusted_chain\: :ref:`X509Certificate` = null, common_name_override\: :ref:`String` = ""\ ) |static| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TLSOptions` | :ref:`client_unsafe`\ (\ trusted_chain\: :ref:`X509Certificate` = null\ ) |static| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TLSOptions` | :ref:`server`\ (\ key\: :ref:`CryptoKey`, certificate\: :ref:`X509Certificate`\ ) |static| | + +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -68,7 +68,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`TLSOptions` **client** **(** :ref:`X509Certificate` trusted_chain=null, :ref:`String` common_name_override="" **)** |static| +:ref:`TLSOptions` **client**\ (\ trusted_chain\: :ref:`X509Certificate` = null, common_name_override\: :ref:`String` = ""\ ) |static| Creates a TLS client configuration which validates certificates and their common names (fully qualified domain names). @@ -84,7 +84,7 @@ You can specify a custom ``trusted_chain`` of certification authorities (the def .. rst-class:: classref-method -:ref:`TLSOptions` **client_unsafe** **(** :ref:`X509Certificate` trusted_chain=null **)** |static| +:ref:`TLSOptions` **client_unsafe**\ (\ trusted_chain\: :ref:`X509Certificate` = null\ ) |static| Creates an **unsafe** TLS client configuration where certificate validation is optional. You can optionally provide a valid ``trusted_chain``, but the common name of the certificates will never be checked. Using this configuration for purposes other than testing **is not recommended**. @@ -98,7 +98,7 @@ Creates an **unsafe** TLS client configuration where certificate validation is o .. rst-class:: classref-method -:ref:`TLSOptions` **server** **(** :ref:`CryptoKey` key, :ref:`X509Certificate` certificate **)** |static| +:ref:`TLSOptions` **server**\ (\ key\: :ref:`CryptoKey`, certificate\: :ref:`X509Certificate`\ ) |static| Creates a TLS server configuration using the provided ``key`` and ``certificate``. @@ -111,3 +111,4 @@ Creates a TLS server configuration using the provided ``key`` and ``certificate` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_torusmesh.rst b/classes/class_torusmesh.rst index c10730f1534..9da4a744887 100644 --- a/classes/class_torusmesh.rst +++ b/classes/class_torusmesh.rst @@ -56,8 +56,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_inner_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_inner_radius** **(** **)** +- |void| **set_inner_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_inner_radius**\ (\ ) The inner radius of the torus. @@ -73,8 +73,8 @@ The inner radius of the torus. .. rst-class:: classref-property-setget -- void **set_outer_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_outer_radius** **(** **)** +- |void| **set_outer_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_outer_radius**\ (\ ) The outer radius of the torus. @@ -90,8 +90,8 @@ The outer radius of the torus. .. rst-class:: classref-property-setget -- void **set_ring_segments** **(** :ref:`int` value **)** -- :ref:`int` **get_ring_segments** **(** **)** +- |void| **set_ring_segments**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_ring_segments**\ (\ ) The number of edges each ring of the torus is constructed of. @@ -107,8 +107,8 @@ The number of edges each ring of the torus is constructed of. .. rst-class:: classref-property-setget -- void **set_rings** **(** :ref:`int` value **)** -- :ref:`int` **get_rings** **(** **)** +- |void| **set_rings**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_rings**\ (\ ) The number of slices the torus is constructed of. @@ -119,3 +119,4 @@ The number of slices the torus is constructed of. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index 30d20a4a231..15fafb45d8c 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -61,9 +61,9 @@ Methods .. table:: :widths: auto - +-------------------------+----------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_pressed` **(** **)** |const| | - +-------------------------+----------------------------------------------------------------------------------+ + +-------------------------+----------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_pressed`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -78,7 +78,7 @@ Signals .. rst-class:: classref-signal -**pressed** **(** **)** +**pressed**\ (\ ) Emitted when the button is pressed (down). @@ -90,7 +90,7 @@ Emitted when the button is pressed (down). .. rst-class:: classref-signal -**released** **(** **)** +**released**\ (\ ) Emitted when the button is released (up). @@ -142,8 +142,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_action** **(** :ref:`String` value **)** -- :ref:`String` **get_action** **(** **)** +- |void| **set_action**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_action**\ (\ ) The button's action. Actions can be handled with :ref:`InputEventAction`. @@ -159,8 +159,8 @@ The button's action. Actions can be handled with :ref:`InputEventAction` value **)** -- :ref:`BitMap` **get_bitmask** **(** **)** +- |void| **set_bitmask**\ (\ value\: :ref:`BitMap`\ ) +- :ref:`BitMap` **get_bitmask**\ (\ ) The button's bitmask. @@ -176,8 +176,8 @@ The button's bitmask. .. rst-class:: classref-property-setget -- void **set_passby_press** **(** :ref:`bool` value **)** -- :ref:`bool` **is_passby_press_enabled** **(** **)** +- |void| **set_passby_press**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_passby_press_enabled**\ (\ ) If ``true``, the :ref:`pressed` and :ref:`released` signals are emitted whenever a pressed finger goes in and out of the button, even if the pressure started outside the active area of the button. @@ -195,8 +195,8 @@ If ``true``, the :ref:`pressed` and :ref .. rst-class:: classref-property-setget -- void **set_shape** **(** :ref:`Shape2D` value **)** -- :ref:`Shape2D` **get_shape** **(** **)** +- |void| **set_shape**\ (\ value\: :ref:`Shape2D`\ ) +- :ref:`Shape2D` **get_shape**\ (\ ) The button's shape. @@ -212,8 +212,8 @@ The button's shape. .. rst-class:: classref-property-setget -- void **set_shape_centered** **(** :ref:`bool` value **)** -- :ref:`bool` **is_shape_centered** **(** **)** +- |void| **set_shape_centered**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_shape_centered**\ (\ ) If ``true``, the button's shape is centered in the provided texture. If no texture is used, this property has no effect. @@ -229,8 +229,8 @@ If ``true``, the button's shape is centered in the provided texture. If no textu .. rst-class:: classref-property-setget -- void **set_shape_visible** **(** :ref:`bool` value **)** -- :ref:`bool` **is_shape_visible** **(** **)** +- |void| **set_shape_visible**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_shape_visible**\ (\ ) If ``true``, the button's shape is visible in the editor. @@ -246,8 +246,8 @@ If ``true``, the button's shape is visible in the editor. .. rst-class:: classref-property-setget -- void **set_texture_normal** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_texture_normal** **(** **)** +- |void| **set_texture_normal**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture_normal**\ (\ ) The button's texture for the normal state. @@ -263,8 +263,8 @@ The button's texture for the normal state. .. rst-class:: classref-property-setget -- void **set_texture_pressed** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_texture_pressed** **(** **)** +- |void| **set_texture_pressed**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture_pressed**\ (\ ) The button's texture for the pressed state. @@ -280,8 +280,8 @@ The button's texture for the pressed state. .. rst-class:: classref-property-setget -- void **set_visibility_mode** **(** :ref:`VisibilityMode` value **)** -- :ref:`VisibilityMode` **get_visibility_mode** **(** **)** +- |void| **set_visibility_mode**\ (\ value\: :ref:`VisibilityMode`\ ) +- :ref:`VisibilityMode` **get_visibility_mode**\ (\ ) The button's visibility mode. See :ref:`VisibilityMode` for possible values. @@ -298,7 +298,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_pressed** **(** **)** |const| +:ref:`bool` **is_pressed**\ (\ ) |const| Returns ``true`` if this button is currently pressed. @@ -309,3 +309,4 @@ Returns ``true`` if this button is currently pressed. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index eb7388fed4c..3f22eac7eaf 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -62,17 +62,17 @@ Constructors .. table:: :widths: auto - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`Transform2D` **(** **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Transform2D` from **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`float` rotation, :ref:`Vector2` position **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`float` rotation, :ref:`Vector2` scale, :ref:`float` skew, :ref:`Vector2` position **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`Transform2D`\ (\ ) | + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`Transform2D`\ (\ from\: :ref:`Transform2D`\ ) | + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`Transform2D`\ (\ rotation\: :ref:`float`, position\: :ref:`Vector2`\ ) | + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`Transform2D`\ (\ rotation\: :ref:`float`, scale\: :ref:`Vector2`, skew\: :ref:`float`, position\: :ref:`Vector2`\ ) | + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`Transform2D`\ (\ x_axis\: :ref:`Vector2`, y_axis\: :ref:`Vector2`, origin\: :ref:`Vector2`\ ) | + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -82,49 +82,49 @@ Methods .. table:: :widths: auto - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`affine_inverse` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`basis_xform` **(** :ref:`Vector2` v **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`basis_xform_inv` **(** :ref:`Vector2` v **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`determinant` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_origin` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_rotation` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_scale` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_skew` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`interpolate_with` **(** :ref:`Transform2D` xform, :ref:`float` weight **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`inverse` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_conformal` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Transform2D` xform **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_finite` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`looking_at` **(** :ref:`Vector2` target=Vector2(0, 0) **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`orthonormalized` **(** **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`rotated` **(** :ref:`float` angle **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`rotated_local` **(** :ref:`float` angle **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`scaled` **(** :ref:`Vector2` scale **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`scaled_local` **(** :ref:`Vector2` scale **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`translated` **(** :ref:`Vector2` offset **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`translated_local` **(** :ref:`Vector2` offset **)** |const| | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`affine_inverse`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`basis_xform`\ (\ v\: :ref:`Vector2`\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`basis_xform_inv`\ (\ v\: :ref:`Vector2`\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`determinant`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_origin`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_rotation`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_scale`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_skew`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`interpolate_with`\ (\ xform\: :ref:`Transform2D`, weight\: :ref:`float`\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`inverse`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_conformal`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equal_approx`\ (\ xform\: :ref:`Transform2D`\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`looking_at`\ (\ target\: :ref:`Vector2` = Vector2(0, 0)\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`orthonormalized`\ (\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`rotated`\ (\ angle\: :ref:`float`\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`rotated_local`\ (\ angle\: :ref:`float`\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`scaled`\ (\ scale\: :ref:`Vector2`\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`scaled_local`\ (\ scale\: :ref:`Vector2`\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`translated`\ (\ offset\: :ref:`Vector2`\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`translated_local`\ (\ offset\: :ref:`Vector2`\ ) |const| | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -134,29 +134,29 @@ Operators .. table:: :widths: auto - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Transform2D` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector2Array` | :ref:`operator *` **(** :ref:`PackedVector2Array` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`operator *` **(** :ref:`Rect2` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`operator *` **(** :ref:`Transform2D` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator *` **(** :ref:`Vector2` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`operator *` **(** :ref:`float` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`operator *` **(** :ref:`int` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`operator /` **(** :ref:`float` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`operator /` **(** :ref:`int` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Transform2D` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator []` **(** :ref:`int` index **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Transform2D`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector2Array` | :ref:`operator *`\ (\ right\: :ref:`PackedVector2Array`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`operator *`\ (\ right\: :ref:`Rect2`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`operator *`\ (\ right\: :ref:`Transform2D`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator *`\ (\ right\: :ref:`Vector2`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`operator *`\ (\ right\: :ref:`float`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`operator *`\ (\ right\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`operator /`\ (\ right\: :ref:`float`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`operator /`\ (\ right\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Transform2D`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -245,7 +245,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Transform2D` **Transform2D** **(** **)** +:ref:`Transform2D` **Transform2D**\ (\ ) Constructs a default-initialized **Transform2D** set to :ref:`IDENTITY`. @@ -255,7 +255,7 @@ Constructs a default-initialized **Transform2D** set to :ref:`IDENTITY` **Transform2D** **(** :ref:`Transform2D` from **)** +:ref:`Transform2D` **Transform2D**\ (\ from\: :ref:`Transform2D`\ ) Constructs a **Transform2D** as a copy of the given **Transform2D**. @@ -265,7 +265,7 @@ Constructs a **Transform2D** as a copy of the given **Transform2D**. .. rst-class:: classref-constructor -:ref:`Transform2D` **Transform2D** **(** :ref:`float` rotation, :ref:`Vector2` position **)** +:ref:`Transform2D` **Transform2D**\ (\ rotation\: :ref:`float`, position\: :ref:`Vector2`\ ) Constructs the transform from a given angle (in radians) and position. @@ -275,7 +275,7 @@ Constructs the transform from a given angle (in radians) and position. .. rst-class:: classref-constructor -:ref:`Transform2D` **Transform2D** **(** :ref:`float` rotation, :ref:`Vector2` scale, :ref:`float` skew, :ref:`Vector2` position **)** +:ref:`Transform2D` **Transform2D**\ (\ rotation\: :ref:`float`, scale\: :ref:`Vector2`, skew\: :ref:`float`, position\: :ref:`Vector2`\ ) Constructs the transform from a given angle (in radians), scale, skew (in radians) and position. @@ -285,7 +285,7 @@ Constructs the transform from a given angle (in radians), scale, skew (in radian .. rst-class:: classref-constructor -:ref:`Transform2D` **Transform2D** **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** +:ref:`Transform2D` **Transform2D**\ (\ x_axis\: :ref:`Vector2`, y_axis\: :ref:`Vector2`, origin\: :ref:`Vector2`\ ) Constructs the transform from 3 :ref:`Vector2` values representing :ref:`x`, :ref:`y`, and the :ref:`origin` (the three column vectors). @@ -302,7 +302,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Transform2D` **affine_inverse** **(** **)** |const| +:ref:`Transform2D` **affine_inverse**\ (\ ) |const| Returns the inverse of the transform, under the assumption that the basis is invertible (must have non-zero determinant). @@ -314,7 +314,7 @@ Returns the inverse of the transform, under the assumption that the basis is inv .. rst-class:: classref-method -:ref:`Vector2` **basis_xform** **(** :ref:`Vector2` v **)** |const| +:ref:`Vector2` **basis_xform**\ (\ v\: :ref:`Vector2`\ ) |const| Returns a vector transformed (multiplied) by the basis matrix. @@ -328,7 +328,7 @@ This method does not account for translation (the :ref:`origin` **basis_xform_inv** **(** :ref:`Vector2` v **)** |const| +:ref:`Vector2` **basis_xform_inv**\ (\ v\: :ref:`Vector2`\ ) |const| Returns a vector transformed (multiplied) by the inverse basis matrix, under the assumption that the basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). @@ -346,7 +346,7 @@ For non-orthonormal transforms (e.g. with scaling) ``transform.affine_inverse(). .. rst-class:: classref-method -:ref:`float` **determinant** **(** **)** |const| +:ref:`float` **determinant**\ (\ ) |const| Returns the determinant of the basis matrix. If the basis is uniformly scaled, then its determinant equals the square of the scale factor. @@ -360,7 +360,7 @@ A negative determinant means the basis was flipped, so one part of the scale is .. rst-class:: classref-method -:ref:`Vector2` **get_origin** **(** **)** |const| +:ref:`Vector2` **get_origin**\ (\ ) |const| Returns the transform's origin (translation). @@ -372,7 +372,7 @@ Returns the transform's origin (translation). .. rst-class:: classref-method -:ref:`float` **get_rotation** **(** **)** |const| +:ref:`float` **get_rotation**\ (\ ) |const| Returns the transform's rotation (in radians). @@ -384,7 +384,7 @@ Returns the transform's rotation (in radians). .. rst-class:: classref-method -:ref:`Vector2` **get_scale** **(** **)** |const| +:ref:`Vector2` **get_scale**\ (\ ) |const| Returns the scale. @@ -396,7 +396,7 @@ Returns the scale. .. rst-class:: classref-method -:ref:`float` **get_skew** **(** **)** |const| +:ref:`float` **get_skew**\ (\ ) |const| Returns the transform's skew (in radians). @@ -408,7 +408,7 @@ Returns the transform's skew (in radians). .. rst-class:: classref-method -:ref:`Transform2D` **interpolate_with** **(** :ref:`Transform2D` xform, :ref:`float` weight **)** |const| +:ref:`Transform2D` **interpolate_with**\ (\ xform\: :ref:`Transform2D`, weight\: :ref:`float`\ ) |const| Returns a transform interpolated between this transform and another by a given ``weight`` (on the range of 0.0 to 1.0). @@ -420,7 +420,7 @@ Returns a transform interpolated between this transform and another by a given ` .. rst-class:: classref-method -:ref:`Transform2D` **inverse** **(** **)** |const| +:ref:`Transform2D` **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` for non-orthonormal transforms (e.g. with scaling). @@ -432,7 +432,7 @@ Returns the inverse of the transform, under the assumption that the transformati .. rst-class:: classref-method -:ref:`bool` **is_conformal** **(** **)** |const| +:ref:`bool` **is_conformal**\ (\ ) |const| Returns ``true`` if the transform's basis is conformal, meaning it preserves angles and distance ratios, and may only be composed of rotation and uniform scale. Returns ``false`` if the transform's basis has non-uniform scale or shear/skew. This can be used to validate if the transform is non-distorted, which is important for physics and other use cases. @@ -444,7 +444,7 @@ Returns ``true`` if the transform's basis is conformal, meaning it preserves ang .. rst-class:: classref-method -:ref:`bool` **is_equal_approx** **(** :ref:`Transform2D` xform **)** |const| +:ref:`bool` **is_equal_approx**\ (\ xform\: :ref:`Transform2D`\ ) |const| Returns ``true`` if this transform and ``xform`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. @@ -456,7 +456,7 @@ Returns ``true`` if this transform and ``xform`` are approximately equal, by run .. rst-class:: classref-method -:ref:`bool` **is_finite** **(** **)** |const| +:ref:`bool` **is_finite**\ (\ ) |const| Returns ``true`` if this transform is finite, by calling :ref:`@GlobalScope.is_finite` on each component. @@ -468,7 +468,7 @@ Returns ``true`` if this transform is finite, by calling :ref:`@GlobalScope.is_f .. rst-class:: classref-method -:ref:`Transform2D` **looking_at** **(** :ref:`Vector2` target=Vector2(0, 0) **)** |const| +:ref:`Transform2D` **looking_at**\ (\ target\: :ref:`Vector2` = Vector2(0, 0)\ ) |const| Returns a copy of the transform rotated such that the rotated X-axis points towards the ``target`` position. @@ -482,7 +482,7 @@ Operations take place in global space. .. rst-class:: classref-method -:ref:`Transform2D` **orthonormalized** **(** **)** |const| +:ref:`Transform2D` **orthonormalized**\ (\ ) |const| Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors (scale of 1 or -1). @@ -494,7 +494,7 @@ Returns the transform with the basis orthogonal (90 degrees), and normalized axi .. rst-class:: classref-method -:ref:`Transform2D` **rotated** **(** :ref:`float` angle **)** |const| +:ref:`Transform2D` **rotated**\ (\ angle\: :ref:`float`\ ) |const| Returns a copy of the transform rotated by the given ``angle`` (in radians). @@ -510,7 +510,7 @@ This can be seen as transforming with respect to the global/parent frame. .. rst-class:: classref-method -:ref:`Transform2D` **rotated_local** **(** :ref:`float` angle **)** |const| +:ref:`Transform2D` **rotated_local**\ (\ angle\: :ref:`float`\ ) |const| Returns a copy of the transform rotated by the given ``angle`` (in radians). @@ -526,7 +526,7 @@ This can be seen as transforming with respect to the local frame. .. rst-class:: classref-method -:ref:`Transform2D` **scaled** **(** :ref:`Vector2` scale **)** |const| +:ref:`Transform2D` **scaled**\ (\ scale\: :ref:`Vector2`\ ) |const| Returns a copy of the transform scaled by the given ``scale`` factor. @@ -542,7 +542,7 @@ This can be seen as transforming with respect to the global/parent frame. .. rst-class:: classref-method -:ref:`Transform2D` **scaled_local** **(** :ref:`Vector2` scale **)** |const| +:ref:`Transform2D` **scaled_local**\ (\ scale\: :ref:`Vector2`\ ) |const| Returns a copy of the transform scaled by the given ``scale`` factor. @@ -558,7 +558,7 @@ This can be seen as transforming with respect to the local frame. .. rst-class:: classref-method -:ref:`Transform2D` **translated** **(** :ref:`Vector2` offset **)** |const| +:ref:`Transform2D` **translated**\ (\ offset\: :ref:`Vector2`\ ) |const| Returns a copy of the transform translated by the given ``offset``. @@ -574,7 +574,7 @@ This can be seen as transforming with respect to the global/parent frame. .. rst-class:: classref-method -:ref:`Transform2D` **translated_local** **(** :ref:`Vector2` offset **)** |const| +:ref:`Transform2D` **translated_local**\ (\ offset\: :ref:`Vector2`\ ) |const| Returns a copy of the transform translated by the given ``offset``. @@ -595,7 +595,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Transform2D` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Transform2D`\ ) Returns ``true`` if the transforms are not equal. @@ -609,7 +609,7 @@ Returns ``true`` if the transforms are not equal. .. rst-class:: classref-operator -:ref:`PackedVector2Array` **operator *** **(** :ref:`PackedVector2Array` right **)** +:ref:`PackedVector2Array` **operator ***\ (\ right\: :ref:`PackedVector2Array`\ ) Transforms (multiplies) each element of the :ref:`Vector2` array by the given **Transform2D** matrix. @@ -621,7 +621,7 @@ Transforms (multiplies) each element of the :ref:`Vector2` array .. rst-class:: classref-operator -:ref:`Rect2` **operator *** **(** :ref:`Rect2` right **)** +:ref:`Rect2` **operator ***\ (\ right\: :ref:`Rect2`\ ) Transforms (multiplies) the :ref:`Rect2` by the given **Transform2D** matrix. @@ -633,7 +633,7 @@ Transforms (multiplies) the :ref:`Rect2` by the given **Transform2D .. rst-class:: classref-operator -:ref:`Transform2D` **operator *** **(** :ref:`Transform2D` right **)** +:ref:`Transform2D` **operator ***\ (\ right\: :ref:`Transform2D`\ ) 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). @@ -645,7 +645,7 @@ Composes these two transformation matrices by multiplying them together. This ha .. rst-class:: classref-operator -:ref:`Vector2` **operator *** **(** :ref:`Vector2` right **)** +:ref:`Vector2` **operator ***\ (\ right\: :ref:`Vector2`\ ) Transforms (multiplies) the :ref:`Vector2` by the given **Transform2D** matrix. @@ -657,7 +657,7 @@ Transforms (multiplies) the :ref:`Vector2` by the given **Transfo .. rst-class:: classref-operator -:ref:`Transform2D` **operator *** **(** :ref:`float` right **)** +:ref:`Transform2D` **operator ***\ (\ right\: :ref:`float`\ ) This operator multiplies all components of the **Transform2D**, including the :ref:`origin` vector, which scales it uniformly. @@ -669,7 +669,7 @@ This operator multiplies all components of the **Transform2D**, including the :r .. rst-class:: classref-operator -:ref:`Transform2D` **operator *** **(** :ref:`int` right **)** +:ref:`Transform2D` **operator ***\ (\ right\: :ref:`int`\ ) This operator multiplies all components of the **Transform2D**, including the :ref:`origin` vector, which scales it uniformly. @@ -681,7 +681,7 @@ This operator multiplies all components of the **Transform2D**, including the :r .. rst-class:: classref-operator -:ref:`Transform2D` **operator /** **(** :ref:`float` right **)** +:ref:`Transform2D` **operator /**\ (\ right\: :ref:`float`\ ) This operator divides all components of the **Transform2D**, including the :ref:`origin` vector, which inversely scales it uniformly. @@ -693,7 +693,7 @@ This operator divides all components of the **Transform2D**, including the :ref: .. rst-class:: classref-operator -:ref:`Transform2D` **operator /** **(** :ref:`int` right **)** +:ref:`Transform2D` **operator /**\ (\ right\: :ref:`int`\ ) This operator divides all components of the **Transform2D**, including the :ref:`origin` vector, which inversely scales it uniformly. @@ -705,7 +705,7 @@ This operator divides all components of the **Transform2D**, including the :ref: .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`Transform2D` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Transform2D`\ ) Returns ``true`` if the transforms are exactly equal. @@ -719,7 +719,7 @@ Returns ``true`` if the transforms are exactly equal. .. rst-class:: classref-operator -:ref:`Vector2` **operator []** **(** :ref:`int` index **)** +:ref:`Vector2` **operator []**\ (\ index\: :ref:`int`\ ) Access transform components using their index. ``t[0]`` is equivalent to ``t.x``, ``t[1]`` is equivalent to ``t.y``, and ``t[2]`` is equivalent to ``t.origin``. @@ -730,3 +730,4 @@ Access transform components using their index. ``t[0]`` is equivalent to ``t.x`` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_transform3d.rst b/classes/class_transform3d.rst index 03930305ae9..7313fb604e6 100644 --- a/classes/class_transform3d.rst +++ b/classes/class_transform3d.rst @@ -64,17 +64,17 @@ Constructors .. table:: :widths: auto - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`Transform3D` **(** **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`Transform3D` **(** :ref:`Transform3D` from **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`Transform3D` **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`Transform3D` **(** :ref:`Projection` from **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`Transform3D` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** | - +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`Transform3D`\ (\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`Transform3D`\ (\ from\: :ref:`Transform3D`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`Transform3D`\ (\ basis\: :ref:`Basis`, origin\: :ref:`Vector3`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`Transform3D`\ (\ from\: :ref:`Projection`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`Transform3D`\ (\ x_axis\: :ref:`Vector3`, y_axis\: :ref:`Vector3`, z_axis\: :ref:`Vector3`, origin\: :ref:`Vector3`\ ) | + +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -84,33 +84,33 @@ Methods .. table:: :widths: auto - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`affine_inverse` **(** **)** |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`interpolate_with` **(** :ref:`Transform3D` xform, :ref:`float` weight **)** |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`inverse` **(** **)** |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Transform3D` xform **)** |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_finite` **(** **)** |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`looking_at` **(** :ref:`Vector3` target, :ref:`Vector3` up=Vector3(0, 1, 0), :ref:`bool` use_model_front=false **)** |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`orthonormalized` **(** **)** |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` angle **)** |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`rotated_local` **(** :ref:`Vector3` axis, :ref:`float` angle **)** |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`scaled` **(** :ref:`Vector3` scale **)** |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`scaled_local` **(** :ref:`Vector3` scale **)** |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`translated` **(** :ref:`Vector3` offset **)** |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`translated_local` **(** :ref:`Vector3` offset **)** |const| | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`affine_inverse`\ (\ ) |const| | + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`interpolate_with`\ (\ xform\: :ref:`Transform3D`, weight\: :ref:`float`\ ) |const| | + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`inverse`\ (\ ) |const| | + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equal_approx`\ (\ xform\: :ref:`Transform3D`\ ) |const| | + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`looking_at`\ (\ target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) |const| | + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`orthonormalized`\ (\ ) |const| | + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`rotated`\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| | + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`rotated_local`\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| | + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`scaled`\ (\ scale\: :ref:`Vector3`\ ) |const| | + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`scaled_local`\ (\ scale\: :ref:`Vector3`\ ) |const| | + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`translated`\ (\ offset\: :ref:`Vector3`\ ) |const| | + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`translated_local`\ (\ offset\: :ref:`Vector3`\ ) |const| | + +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -120,29 +120,29 @@ Operators .. table:: :widths: auto - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Transform3D` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`operator *` **(** :ref:`AABB` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedVector3Array` | :ref:`operator *` **(** :ref:`PackedVector3Array` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Plane` | :ref:`operator *` **(** :ref:`Plane` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`operator *` **(** :ref:`Transform3D` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator *` **(** :ref:`Vector3` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`operator *` **(** :ref:`float` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`operator *` **(** :ref:`int` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`operator /` **(** :ref:`float` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`operator /` **(** :ref:`int` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Transform3D` right **)** | - +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Transform3D`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`operator *`\ (\ right\: :ref:`AABB`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`operator *`\ (\ right\: :ref:`PackedVector3Array`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Plane` | :ref:`operator *`\ (\ right\: :ref:`Plane`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`operator *`\ (\ right\: :ref:`Transform3D`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator *`\ (\ right\: :ref:`Vector3`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`operator *`\ (\ right\: :ref:`float`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`operator *`\ (\ right\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`operator /`\ (\ right\: :ref:`float`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`operator /`\ (\ right\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Transform3D`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -227,7 +227,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Transform3D` **Transform3D** **(** **)** +:ref:`Transform3D` **Transform3D**\ (\ ) Constructs a default-initialized **Transform3D** set to :ref:`IDENTITY`. @@ -237,7 +237,7 @@ Constructs a default-initialized **Transform3D** set to :ref:`IDENTITY` **Transform3D** **(** :ref:`Transform3D` from **)** +:ref:`Transform3D` **Transform3D**\ (\ from\: :ref:`Transform3D`\ ) Constructs a **Transform3D** as a copy of the given **Transform3D**. @@ -247,7 +247,7 @@ Constructs a **Transform3D** as a copy of the given **Transform3D**. .. rst-class:: classref-constructor -:ref:`Transform3D` **Transform3D** **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** +:ref:`Transform3D` **Transform3D**\ (\ basis\: :ref:`Basis`, origin\: :ref:`Vector3`\ ) Constructs a Transform3D from a :ref:`Basis` and :ref:`Vector3`. @@ -257,7 +257,7 @@ Constructs a Transform3D from a :ref:`Basis` and :ref:`Vector3` **Transform3D** **(** :ref:`Projection` from **)** +:ref:`Transform3D` **Transform3D**\ (\ from\: :ref:`Projection`\ ) Constructs a Transform3D from a :ref:`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). @@ -267,7 +267,7 @@ Constructs a Transform3D from a :ref:`Projection` by trimming .. rst-class:: classref-constructor -:ref:`Transform3D` **Transform3D** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** +:ref:`Transform3D` **Transform3D**\ (\ x_axis\: :ref:`Vector3`, y_axis\: :ref:`Vector3`, z_axis\: :ref:`Vector3`, origin\: :ref:`Vector3`\ ) Constructs a Transform3D from four :ref:`Vector3` values (matrix columns). Each axis corresponds to local basis vectors (some of which may be scaled). @@ -284,7 +284,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Transform3D` **affine_inverse** **(** **)** |const| +:ref:`Transform3D` **affine_inverse**\ (\ ) |const| Returns the inverse of the transform, under the assumption that the basis is invertible (must have non-zero determinant). @@ -296,7 +296,7 @@ Returns the inverse of the transform, under the assumption that the basis is inv .. rst-class:: classref-method -:ref:`Transform3D` **interpolate_with** **(** :ref:`Transform3D` xform, :ref:`float` weight **)** |const| +:ref:`Transform3D` **interpolate_with**\ (\ xform\: :ref:`Transform3D`, weight\: :ref:`float`\ ) |const| Returns a transform interpolated between this transform and another by a given ``weight`` (on the range of 0.0 to 1.0). @@ -308,7 +308,7 @@ Returns a transform interpolated between this transform and another by a given ` .. rst-class:: classref-method -:ref:`Transform3D` **inverse** **(** **)** |const| +:ref:`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` for non-orthonormal transforms (e.g. with scaling). @@ -320,7 +320,7 @@ Returns the inverse of the transform, under the assumption that the transformati .. rst-class:: classref-method -:ref:`bool` **is_equal_approx** **(** :ref:`Transform3D` xform **)** |const| +:ref:`bool` **is_equal_approx**\ (\ xform\: :ref:`Transform3D`\ ) |const| Returns ``true`` if this transform and ``xform`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. @@ -332,7 +332,7 @@ Returns ``true`` if this transform and ``xform`` are approximately equal, by run .. rst-class:: classref-method -:ref:`bool` **is_finite** **(** **)** |const| +:ref:`bool` **is_finite**\ (\ ) |const| Returns ``true`` if this transform is finite, by calling :ref:`@GlobalScope.is_finite` on each component. @@ -344,7 +344,7 @@ Returns ``true`` if this transform is finite, by calling :ref:`@GlobalScope.is_f .. rst-class:: classref-method -:ref:`Transform3D` **looking_at** **(** :ref:`Vector3` target, :ref:`Vector3` up=Vector3(0, 1, 0), :ref:`bool` use_model_front=false **)** |const| +:ref:`Transform3D` **looking_at**\ (\ target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) |const| Returns a copy of the transform rotated such that the forward axis (-Z) points towards the ``target`` position. @@ -360,7 +360,7 @@ If ``use_model_front`` is ``true``, the +Z axis (asset front) is treated as forw .. rst-class:: classref-method -:ref:`Transform3D` **orthonormalized** **(** **)** |const| +:ref:`Transform3D` **orthonormalized**\ (\ ) |const| Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors (scale of 1 or -1). @@ -372,7 +372,7 @@ Returns the transform with the basis orthogonal (90 degrees), and normalized axi .. rst-class:: classref-method -:ref:`Transform3D` **rotated** **(** :ref:`Vector3` axis, :ref:`float` angle **)** |const| +:ref:`Transform3D` **rotated**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| Returns a copy of the transform rotated around the given ``axis`` by the given ``angle`` (in radians). @@ -390,7 +390,7 @@ This can be seen as transforming with respect to the global/parent frame. .. rst-class:: classref-method -:ref:`Transform3D` **rotated_local** **(** :ref:`Vector3` axis, :ref:`float` angle **)** |const| +:ref:`Transform3D` **rotated_local**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| Returns a copy of the transform rotated around the given ``axis`` by the given ``angle`` (in radians). @@ -408,7 +408,7 @@ This can be seen as transforming with respect to the local frame. .. rst-class:: classref-method -:ref:`Transform3D` **scaled** **(** :ref:`Vector3` scale **)** |const| +:ref:`Transform3D` **scaled**\ (\ scale\: :ref:`Vector3`\ ) |const| Returns a copy of the transform scaled by the given ``scale`` factor. @@ -424,7 +424,7 @@ This can be seen as transforming with respect to the global/parent frame. .. rst-class:: classref-method -:ref:`Transform3D` **scaled_local** **(** :ref:`Vector3` scale **)** |const| +:ref:`Transform3D` **scaled_local**\ (\ scale\: :ref:`Vector3`\ ) |const| Returns a copy of the transform scaled by the given ``scale`` factor. @@ -440,7 +440,7 @@ This can be seen as transforming with respect to the local frame. .. rst-class:: classref-method -:ref:`Transform3D` **translated** **(** :ref:`Vector3` offset **)** |const| +:ref:`Transform3D` **translated**\ (\ offset\: :ref:`Vector3`\ ) |const| Returns a copy of the transform translated by the given ``offset``. @@ -456,7 +456,7 @@ This can be seen as transforming with respect to the global/parent frame. .. rst-class:: classref-method -:ref:`Transform3D` **translated_local** **(** :ref:`Vector3` offset **)** |const| +:ref:`Transform3D` **translated_local**\ (\ offset\: :ref:`Vector3`\ ) |const| Returns a copy of the transform translated by the given ``offset``. @@ -477,7 +477,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Transform3D` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Transform3D`\ ) Returns ``true`` if the transforms are not equal. @@ -491,7 +491,7 @@ Returns ``true`` if the transforms are not equal. .. rst-class:: classref-operator -:ref:`AABB` **operator *** **(** :ref:`AABB` right **)** +:ref:`AABB` **operator ***\ (\ right\: :ref:`AABB`\ ) Transforms (multiplies) the :ref:`AABB` by the given **Transform3D** matrix. @@ -503,7 +503,7 @@ Transforms (multiplies) the :ref:`AABB` by the given **Transform3D** .. rst-class:: classref-operator -:ref:`PackedVector3Array` **operator *** **(** :ref:`PackedVector3Array` right **)** +:ref:`PackedVector3Array` **operator ***\ (\ right\: :ref:`PackedVector3Array`\ ) Transforms (multiplies) each element of the :ref:`Vector3` array by the given **Transform3D** matrix. @@ -515,7 +515,7 @@ Transforms (multiplies) each element of the :ref:`Vector3` array .. rst-class:: classref-operator -:ref:`Plane` **operator *** **(** :ref:`Plane` right **)** +:ref:`Plane` **operator ***\ (\ right\: :ref:`Plane`\ ) Transforms (multiplies) the :ref:`Plane` by the given **Transform3D** transformation matrix. @@ -527,7 +527,7 @@ Transforms (multiplies) the :ref:`Plane` by the given **Transform3D .. rst-class:: classref-operator -:ref:`Transform3D` **operator *** **(** :ref:`Transform3D` right **)** +:ref:`Transform3D` **operator ***\ (\ right\: :ref:`Transform3D`\ ) 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). @@ -539,7 +539,7 @@ Composes these two transformation matrices by multiplying them together. This ha .. rst-class:: classref-operator -:ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3`\ ) Transforms (multiplies) the :ref:`Vector3` by the given **Transform3D** matrix. @@ -551,7 +551,7 @@ Transforms (multiplies) the :ref:`Vector3` by the given **Transfo .. rst-class:: classref-operator -:ref:`Transform3D` **operator *** **(** :ref:`float` right **)** +:ref:`Transform3D` **operator ***\ (\ right\: :ref:`float`\ ) This operator multiplies all components of the **Transform3D**, including the :ref:`origin` vector, which scales it uniformly. @@ -563,7 +563,7 @@ This operator multiplies all components of the **Transform3D**, including the :r .. rst-class:: classref-operator -:ref:`Transform3D` **operator *** **(** :ref:`int` right **)** +:ref:`Transform3D` **operator ***\ (\ right\: :ref:`int`\ ) This operator multiplies all components of the **Transform3D**, including the :ref:`origin` vector, which scales it uniformly. @@ -575,7 +575,7 @@ This operator multiplies all components of the **Transform3D**, including the :r .. rst-class:: classref-operator -:ref:`Transform3D` **operator /** **(** :ref:`float` right **)** +:ref:`Transform3D` **operator /**\ (\ right\: :ref:`float`\ ) This operator divides all components of the **Transform3D**, including the :ref:`origin` vector, which inversely scales it uniformly. @@ -587,7 +587,7 @@ This operator divides all components of the **Transform3D**, including the :ref: .. rst-class:: classref-operator -:ref:`Transform3D` **operator /** **(** :ref:`int` right **)** +:ref:`Transform3D` **operator /**\ (\ right\: :ref:`int`\ ) This operator divides all components of the **Transform3D**, including the :ref:`origin` vector, which inversely scales it uniformly. @@ -599,7 +599,7 @@ This operator divides all components of the **Transform3D**, including the :ref: .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`Transform3D` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Transform3D`\ ) Returns ``true`` if the transforms are exactly equal. @@ -612,3 +612,4 @@ Returns ``true`` if the transforms are exactly equal. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_translation.rst b/classes/class_translation.rst index b7729738181..3d2f1e3a767 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -52,27 +52,27 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`_get_message` **(** :ref:`StringName` src_message, :ref:`StringName` context **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`_get_plural_message` **(** :ref:`StringName` src_message, :ref:`StringName` src_plural_message, :ref:`int` n, :ref:`StringName` context **)** |virtual| |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_message` **(** :ref:`StringName` src_message, :ref:`StringName` xlated_message, :ref:`StringName` context="" **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_plural_message` **(** :ref:`StringName` src_message, :ref:`PackedStringArray` xlated_messages, :ref:`StringName` context="" **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`erase_message` **(** :ref:`StringName` src_message, :ref:`StringName` context="" **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_message` **(** :ref:`StringName` src_message, :ref:`StringName` context="" **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_message_count` **(** **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_message_list` **(** **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`get_plural_message` **(** :ref:`StringName` src_message, :ref:`StringName` src_plural_message, :ref:`int` n, :ref:`StringName` context="" **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_translated_message_list` **(** **)** |const| | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`_get_message`\ (\ src_message\: :ref:`StringName`, context\: :ref:`StringName`\ ) |virtual| |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`_get_plural_message`\ (\ src_message\: :ref:`StringName`, src_plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName`\ ) |virtual| |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_message`\ (\ src_message\: :ref:`StringName`, xlated_message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_plural_message`\ (\ src_message\: :ref:`StringName`, xlated_messages\: :ref:`PackedStringArray`, context\: :ref:`StringName` = &""\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`erase_message`\ (\ src_message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_message`\ (\ src_message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_message_count`\ (\ ) |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_message_list`\ (\ ) |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`get_plural_message`\ (\ src_message\: :ref:`StringName`, src_plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_translated_message_list`\ (\ ) |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -91,8 +91,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_locale** **(** :ref:`String` value **)** -- :ref:`String` **get_locale** **(** **)** +- |void| **set_locale**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_locale**\ (\ ) The locale of the translation. @@ -109,7 +109,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`StringName` **_get_message** **(** :ref:`StringName` src_message, :ref:`StringName` context **)** |virtual| |const| +:ref:`StringName` **_get_message**\ (\ src_message\: :ref:`StringName`, context\: :ref:`StringName`\ ) |virtual| |const| Virtual method to override :ref:`get_message`. @@ -121,7 +121,7 @@ Virtual method to override :ref:`get_message` **_get_plural_message** **(** :ref:`StringName` src_message, :ref:`StringName` src_plural_message, :ref:`int` n, :ref:`StringName` context **)** |virtual| |const| +:ref:`StringName` **_get_plural_message**\ (\ src_message\: :ref:`StringName`, src_plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName`\ ) |virtual| |const| Virtual method to override :ref:`get_plural_message`. @@ -133,7 +133,7 @@ Virtual method to override :ref:`get_plural_message` src_message, :ref:`StringName` xlated_message, :ref:`StringName` context="" **)** +|void| **add_message**\ (\ src_message\: :ref:`StringName`, xlated_message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) Adds a message if nonexistent, followed by its translation. @@ -147,7 +147,7 @@ An additional context could be used to specify the translation context or differ .. rst-class:: classref-method -void **add_plural_message** **(** :ref:`StringName` src_message, :ref:`PackedStringArray` xlated_messages, :ref:`StringName` context="" **)** +|void| **add_plural_message**\ (\ src_message\: :ref:`StringName`, xlated_messages\: :ref:`PackedStringArray`, context\: :ref:`StringName` = &""\ ) Adds a message involving plural translation if nonexistent, followed by its translation. @@ -161,7 +161,7 @@ An additional context could be used to specify the translation context or differ .. rst-class:: classref-method -void **erase_message** **(** :ref:`StringName` src_message, :ref:`StringName` context="" **)** +|void| **erase_message**\ (\ src_message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) Erases a message. @@ -173,7 +173,7 @@ Erases a message. .. rst-class:: classref-method -:ref:`StringName` **get_message** **(** :ref:`StringName` src_message, :ref:`StringName` context="" **)** |const| +:ref:`StringName` **get_message**\ (\ src_message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| Returns a message's translation. @@ -185,7 +185,7 @@ Returns a message's translation. .. rst-class:: classref-method -:ref:`int` **get_message_count** **(** **)** |const| +:ref:`int` **get_message_count**\ (\ ) |const| Returns the number of existing messages. @@ -197,7 +197,7 @@ Returns the number of existing messages. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_message_list** **(** **)** |const| +:ref:`PackedStringArray` **get_message_list**\ (\ ) |const| Returns all the messages (keys). @@ -209,7 +209,7 @@ Returns all the messages (keys). .. rst-class:: classref-method -:ref:`StringName` **get_plural_message** **(** :ref:`StringName` src_message, :ref:`StringName` src_plural_message, :ref:`int` n, :ref:`StringName` context="" **)** |const| +:ref:`StringName` **get_plural_message**\ (\ src_message\: :ref:`StringName`, src_plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| Returns a message's translation involving plurals. @@ -223,7 +223,7 @@ The number ``n`` is the number or quantity of the plural object. It will be used .. rst-class:: classref-method -:ref:`PackedStringArray` **get_translated_message_list** **(** **)** |const| +:ref:`PackedStringArray` **get_translated_message_list**\ (\ ) |const| Returns all the messages (translated text). @@ -234,3 +234,4 @@ Returns all the messages (translated text). .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index f66b5e56703..be1aeb0c9f2 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -50,49 +50,49 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_translation` **(** :ref:`Translation` translation **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`compare_locales` **(** :ref:`String` locale_a, :ref:`String` locale_b **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_all_countries` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_all_languages` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_all_scripts` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_country_name` **(** :ref:`String` country **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_language_name` **(** :ref:`String` language **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_loaded_locales` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_locale` **(** **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_locale_name` **(** :ref:`String` locale **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_script_name` **(** :ref:`String` script **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_tool_locale` **(** **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Translation` | :ref:`get_translation_object` **(** :ref:`String` locale **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`pseudolocalize` **(** :ref:`StringName` message **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reload_pseudolocalization` **(** **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_translation` **(** :ref:`Translation` translation **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_locale` **(** :ref:`String` locale **)** | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`standardize_locale` **(** :ref:`String` locale **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`translate` **(** :ref:`StringName` message, :ref:`StringName` context="" **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StringName` | :ref:`translate_plural` **(** :ref:`StringName` message, :ref:`StringName` plural_message, :ref:`int` n, :ref:`StringName` context="" **)** |const| | - +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_translation`\ (\ translation\: :ref:`Translation`\ ) | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`compare_locales`\ (\ locale_a\: :ref:`String`, locale_b\: :ref:`String`\ ) |const| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_all_countries`\ (\ ) |const| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_all_languages`\ (\ ) |const| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_all_scripts`\ (\ ) |const| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_country_name`\ (\ country\: :ref:`String`\ ) |const| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_language_name`\ (\ language\: :ref:`String`\ ) |const| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_loaded_locales`\ (\ ) |const| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_locale`\ (\ ) |const| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_locale_name`\ (\ locale\: :ref:`String`\ ) |const| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_script_name`\ (\ script\: :ref:`String`\ ) |const| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_tool_locale`\ (\ ) | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Translation` | :ref:`get_translation_object`\ (\ locale\: :ref:`String`\ ) | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`pseudolocalize`\ (\ message\: :ref:`StringName`\ ) |const| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reload_pseudolocalization`\ (\ ) | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_translation`\ (\ translation\: :ref:`Translation`\ ) | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_locale`\ (\ locale\: :ref:`String`\ ) | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`standardize_locale`\ (\ locale\: :ref:`String`\ ) |const| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`translate`\ (\ message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`translate_plural`\ (\ message\: :ref:`StringName`, plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| | + +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -111,8 +111,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_pseudolocalization_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_pseudolocalization_enabled** **(** **)** +- |void| **set_pseudolocalization_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_pseudolocalization_enabled**\ (\ ) If ``true``, enables the use of pseudolocalization. See :ref:`ProjectSettings.internationalization/pseudolocalization/use_pseudolocalization` for details. @@ -129,7 +129,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_translation** **(** :ref:`Translation` translation **)** +|void| **add_translation**\ (\ translation\: :ref:`Translation`\ ) Adds a :ref:`Translation` resource. @@ -141,7 +141,7 @@ Adds a :ref:`Translation` resource. .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the server from all translations. @@ -153,7 +153,7 @@ Clears the server from all translations. .. rst-class:: classref-method -:ref:`int` **compare_locales** **(** :ref:`String` locale_a, :ref:`String` locale_b **)** |const| +:ref:`int` **compare_locales**\ (\ locale_a\: :ref:`String`, locale_b\: :ref:`String`\ ) |const| Compares two locales and returns a similarity score between ``0`` (no match) and ``10`` (full match). @@ -165,7 +165,7 @@ Compares two locales and returns a similarity score between ``0`` (no match) and .. rst-class:: classref-method -:ref:`PackedStringArray` **get_all_countries** **(** **)** |const| +:ref:`PackedStringArray` **get_all_countries**\ (\ ) |const| Returns an array of known country codes. @@ -177,7 +177,7 @@ Returns an array of known country codes. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_all_languages** **(** **)** |const| +:ref:`PackedStringArray` **get_all_languages**\ (\ ) |const| Returns array of known language codes. @@ -189,7 +189,7 @@ Returns array of known language codes. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_all_scripts** **(** **)** |const| +:ref:`PackedStringArray` **get_all_scripts**\ (\ ) |const| Returns an array of known script codes. @@ -201,7 +201,7 @@ Returns an array of known script codes. .. rst-class:: classref-method -:ref:`String` **get_country_name** **(** :ref:`String` country **)** |const| +:ref:`String` **get_country_name**\ (\ country\: :ref:`String`\ ) |const| Returns a readable country name for the ``country`` code. @@ -213,7 +213,7 @@ Returns a readable country name for the ``country`` code. .. rst-class:: classref-method -:ref:`String` **get_language_name** **(** :ref:`String` language **)** |const| +:ref:`String` **get_language_name**\ (\ language\: :ref:`String`\ ) |const| Returns a readable language name for the ``language`` code. @@ -225,7 +225,7 @@ Returns a readable language name for the ``language`` code. .. rst-class:: classref-method -:ref:`PackedStringArray` **get_loaded_locales** **(** **)** |const| +:ref:`PackedStringArray` **get_loaded_locales**\ (\ ) |const| Returns an array of all loaded locales of the project. @@ -237,7 +237,7 @@ Returns an array of all loaded locales of the project. .. rst-class:: classref-method -:ref:`String` **get_locale** **(** **)** |const| +:ref:`String` **get_locale**\ (\ ) |const| Returns the current locale of the project. @@ -251,7 +251,7 @@ See also :ref:`OS.get_locale` and :ref:`OS.get_local .. rst-class:: classref-method -:ref:`String` **get_locale_name** **(** :ref:`String` locale **)** |const| +:ref:`String` **get_locale_name**\ (\ locale\: :ref:`String`\ ) |const| Returns a locale's language and its variant (e.g. ``"en_US"`` would return ``"English (United States)"``). @@ -263,7 +263,7 @@ Returns a locale's language and its variant (e.g. ``"en_US"`` would return ``"En .. rst-class:: classref-method -:ref:`String` **get_script_name** **(** :ref:`String` script **)** |const| +:ref:`String` **get_script_name**\ (\ script\: :ref:`String`\ ) |const| Returns a readable script name for the ``script`` code. @@ -275,7 +275,7 @@ Returns a readable script name for the ``script`` code. .. rst-class:: classref-method -:ref:`String` **get_tool_locale** **(** **)** +:ref:`String` **get_tool_locale**\ (\ ) Returns the current locale of the editor. @@ -289,7 +289,7 @@ Returns the current locale of the editor. .. rst-class:: classref-method -:ref:`Translation` **get_translation_object** **(** :ref:`String` locale **)** +:ref:`Translation` **get_translation_object**\ (\ locale\: :ref:`String`\ ) Returns the :ref:`Translation` instance based on the ``locale`` passed in. @@ -303,7 +303,7 @@ It will return ``null`` if there is no :ref:`Translation` ins .. rst-class:: classref-method -:ref:`StringName` **pseudolocalize** **(** :ref:`StringName` message **)** |const| +:ref:`StringName` **pseudolocalize**\ (\ message\: :ref:`StringName`\ ) |const| Returns the pseudolocalized string based on the ``message`` passed in. @@ -315,7 +315,7 @@ Returns the pseudolocalized string based on the ``message`` passed in. .. rst-class:: classref-method -void **reload_pseudolocalization** **(** **)** +|void| **reload_pseudolocalization**\ (\ ) Reparses the pseudolocalization options and reloads the translation. @@ -327,7 +327,7 @@ Reparses the pseudolocalization options and reloads the translation. .. rst-class:: classref-method -void **remove_translation** **(** :ref:`Translation` translation **)** +|void| **remove_translation**\ (\ translation\: :ref:`Translation`\ ) Removes the given translation from the server. @@ -339,7 +339,7 @@ Removes the given translation from the server. .. rst-class:: classref-method -void **set_locale** **(** :ref:`String` locale **)** +|void| **set_locale**\ (\ locale\: :ref:`String`\ ) Sets the locale of the project. The ``locale`` string will be standardized to match known locales (e.g. ``en-US`` would be matched to ``en_US``). @@ -353,7 +353,7 @@ If translations have been loaded beforehand for the new locale, they will be app .. rst-class:: classref-method -:ref:`String` **standardize_locale** **(** :ref:`String` locale **)** |const| +:ref:`String` **standardize_locale**\ (\ locale\: :ref:`String`\ ) |const| Returns a ``locale`` string standardized to match known locales (e.g. ``en-US`` would be matched to ``en_US``). @@ -365,7 +365,7 @@ Returns a ``locale`` string standardized to match known locales (e.g. ``en-US`` .. rst-class:: classref-method -:ref:`StringName` **translate** **(** :ref:`StringName` message, :ref:`StringName` context="" **)** |const| +:ref:`StringName` **translate**\ (\ message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| Returns the current locale's translation for the given message (key) and context. @@ -377,7 +377,7 @@ Returns the current locale's translation for the given message (key) and context .. rst-class:: classref-method -:ref:`StringName` **translate_plural** **(** :ref:`StringName` message, :ref:`StringName` plural_message, :ref:`int` n, :ref:`StringName` context="" **)** |const| +:ref:`StringName` **translate_plural**\ (\ message\: :ref:`StringName`, plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| Returns the current locale's translation for the given message (key), plural message and context. @@ -390,3 +390,4 @@ The number ``n`` is the number or quantity of the plural object. It will be used .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 733f490535e..a37922ebb9e 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -102,81 +102,81 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`create_item` **(** :ref:`TreeItem` parent=null, :ref:`int` index=-1 **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`deselect_all` **(** **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`edit_selected` **(** :ref:`bool` force_edit=false **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`ensure_cursor_is_visible` **(** **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_button_id_at_position` **(** :ref:`Vector2` position **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_column_at_position` **(** :ref:`Vector2` position **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_column_expand_ratio` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_column_title` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`HorizontalAlignment` | :ref:`get_column_title_alignment` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TextDirection` | :ref:`get_column_title_direction` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_column_title_language` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_column_width` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_custom_popup_rect` **(** **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_drop_section_at_position` **(** :ref:`Vector2` position **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_edited` **(** **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_edited_column` **(** **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_item_area_rect` **(** :ref:`TreeItem` item, :ref:`int` column=-1, :ref:`int` button_index=-1 **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_item_at_position` **(** :ref:`Vector2` position **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_next_selected` **(** :ref:`TreeItem` from **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_pressed_button` **(** **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_root` **(** **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_scroll` **(** **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_selected` **(** **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selected_column` **(** **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_column_clipping_content` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_column_expanding` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`scroll_to_item` **(** :ref:`TreeItem` item, :ref:`bool` center_on_item=false **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_column_clip_content` **(** :ref:`int` column, :ref:`bool` enable **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_column_custom_minimum_width` **(** :ref:`int` column, :ref:`int` min_width **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_column_expand` **(** :ref:`int` column, :ref:`bool` expand **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_column_expand_ratio` **(** :ref:`int` column, :ref:`int` ratio **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_column_title` **(** :ref:`int` column, :ref:`String` title **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_column_title_alignment` **(** :ref:`int` column, :ref:`HorizontalAlignment` title_alignment **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_column_title_direction` **(** :ref:`int` column, :ref:`TextDirection` direction **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_column_title_language` **(** :ref:`int` column, :ref:`String` language **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_selected` **(** :ref:`TreeItem` item, :ref:`int` column **)** | - +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`create_item`\ (\ parent\: :ref:`TreeItem` = null, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`deselect_all`\ (\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`edit_selected`\ (\ force_edit\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`ensure_cursor_is_visible`\ (\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_button_id_at_position`\ (\ position\: :ref:`Vector2`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_column_at_position`\ (\ position\: :ref:`Vector2`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_column_expand_ratio`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_column_title`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`HorizontalAlignment` | :ref:`get_column_title_alignment`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`get_column_title_direction`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_column_title_language`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_column_width`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_custom_popup_rect`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_drop_section_at_position`\ (\ position\: :ref:`Vector2`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_edited`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_edited_column`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_item_area_rect`\ (\ item\: :ref:`TreeItem`, column\: :ref:`int` = -1, button_index\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_item_at_position`\ (\ position\: :ref:`Vector2`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_next_selected`\ (\ from\: :ref:`TreeItem`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_pressed_button`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_root`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_scroll`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_selected`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selected_column`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_column_clipping_content`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_column_expanding`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`scroll_to_item`\ (\ item\: :ref:`TreeItem`, center_on_item\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_column_clip_content`\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_column_custom_minimum_width`\ (\ column\: :ref:`int`, min_width\: :ref:`int`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_column_expand`\ (\ column\: :ref:`int`, expand\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_column_expand_ratio`\ (\ column\: :ref:`int`, ratio\: :ref:`int`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_column_title`\ (\ column\: :ref:`int`, title\: :ref:`String`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_column_title_alignment`\ (\ column\: :ref:`int`, title_alignment\: :ref:`HorizontalAlignment`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_column_title_direction`\ (\ column\: :ref:`int`, direction\: :ref:`TextDirection`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_column_title_language`\ (\ column\: :ref:`int`, language\: :ref:`String`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_selected`\ (\ item\: :ref:`TreeItem`, column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -327,7 +327,7 @@ Signals .. rst-class:: classref-signal -**button_clicked** **(** :ref:`TreeItem` item, :ref:`int` column, :ref:`int` id, :ref:`int` mouse_button_index **)** +**button_clicked**\ (\ item\: :ref:`TreeItem`, column\: :ref:`int`, id\: :ref:`int`, mouse_button_index\: :ref:`int`\ ) Emitted when a button on the tree was pressed (see :ref:`TreeItem.add_button`). @@ -339,7 +339,7 @@ Emitted when a button on the tree was pressed (see :ref:`TreeItem.add_button` item, :ref:`int` column **)** +**check_propagated_to_item**\ (\ item\: :ref:`TreeItem`, column\: :ref:`int`\ ) Emitted when :ref:`TreeItem.propagate_check` is called. Connect to this signal to process the items that are affected when :ref:`TreeItem.propagate_check` is invoked. The order that the items affected will be processed is as follows: the item that invoked the method, children of that item, and finally parents of that item. @@ -363,7 +363,7 @@ Emitted when :ref:`TreeItem.propagate_check` column, :ref:`int` mouse_button_index **)** +**column_title_clicked**\ (\ column\: :ref:`int`, mouse_button_index\: :ref:`int`\ ) Emitted when a column's title is clicked with either :ref:`@GlobalScope.MOUSE_BUTTON_LEFT` or :ref:`@GlobalScope.MOUSE_BUTTON_RIGHT`. @@ -375,7 +375,7 @@ Emitted when a column's title is clicked with either :ref:`@GlobalScope.MOUSE_BU .. rst-class:: classref-signal -**custom_item_clicked** **(** :ref:`int` mouse_button_index **)** +**custom_item_clicked**\ (\ mouse_button_index\: :ref:`int`\ ) Emitted when an item with :ref:`TreeItem.CELL_MODE_CUSTOM` is clicked with a mouse button. @@ -387,7 +387,7 @@ Emitted when an item with :ref:`TreeItem.CELL_MODE_CUSTOM` arrow_clicked **)** +**custom_popup_edited**\ (\ arrow_clicked\: :ref:`bool`\ ) Emitted when a cell with the :ref:`TreeItem.CELL_MODE_CUSTOM` is clicked to be edited. @@ -399,7 +399,7 @@ Emitted when a cell with the :ref:`TreeItem.CELL_MODE_CUSTOM` position, :ref:`int` mouse_button_index **)** +**empty_clicked**\ (\ position\: :ref:`Vector2`, mouse_button_index\: :ref:`int`\ ) Emitted when a mouse button is clicked in the empty space of the tree. @@ -411,7 +411,7 @@ Emitted when a mouse button is clicked in the empty space of the tree. .. rst-class:: classref-signal -**item_activated** **(** **)** +**item_activated**\ (\ ) Emitted when an item is double-clicked, or selected with a ``ui_accept`` input event (e.g. using :kbd:`Enter` or :kbd:`Space` on the keyboard). @@ -423,7 +423,7 @@ Emitted when an item is double-clicked, or selected with a ``ui_accept`` input e .. rst-class:: classref-signal -**item_collapsed** **(** :ref:`TreeItem` item **)** +**item_collapsed**\ (\ item\: :ref:`TreeItem`\ ) Emitted when an item is collapsed by a click on the folding arrow. @@ -435,7 +435,7 @@ Emitted when an item is collapsed by a click on the folding arrow. .. rst-class:: classref-signal -**item_edited** **(** **)** +**item_edited**\ (\ ) Emitted when an item is edited. @@ -447,7 +447,7 @@ Emitted when an item is edited. .. rst-class:: classref-signal -**item_icon_double_clicked** **(** **)** +**item_icon_double_clicked**\ (\ ) Emitted when an item's icon is double-clicked. For a signal that emits when any part of the item is double-clicked, see :ref:`item_activated`. @@ -459,7 +459,7 @@ Emitted when an item's icon is double-clicked. For a signal that emits when any .. rst-class:: classref-signal -**item_mouse_selected** **(** :ref:`Vector2` position, :ref:`int` mouse_button_index **)** +**item_mouse_selected**\ (\ position\: :ref:`Vector2`, mouse_button_index\: :ref:`int`\ ) Emitted when an item is selected with a mouse button. @@ -471,7 +471,7 @@ Emitted when an item is selected with a mouse button. .. rst-class:: classref-signal -**item_selected** **(** **)** +**item_selected**\ (\ ) Emitted when an item is selected. @@ -483,7 +483,7 @@ Emitted when an item is selected. .. rst-class:: classref-signal -**multi_selected** **(** :ref:`TreeItem` item, :ref:`int` column, :ref:`bool` selected **)** +**multi_selected**\ (\ item\: :ref:`TreeItem`, column\: :ref:`int`, selected\: :ref:`bool`\ ) Emitted instead of :ref:`item_selected` if :ref:`select_mode` is set to :ref:`SELECT_MULTI`. @@ -495,7 +495,7 @@ Emitted instead of :ref:`item_selected` if :ref .. rst-class:: classref-signal -**nothing_selected** **(** **)** +**nothing_selected**\ (\ ) Emitted when a left mouse button click does not select any item. @@ -601,8 +601,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_allow_reselect** **(** :ref:`bool` value **)** -- :ref:`bool` **get_allow_reselect** **(** **)** +- |void| **set_allow_reselect**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_allow_reselect**\ (\ ) If ``true``, the currently selected cell may be selected again. @@ -618,8 +618,8 @@ If ``true``, the currently selected cell may be selected again. .. rst-class:: classref-property-setget -- void **set_allow_rmb_select** **(** :ref:`bool` value **)** -- :ref:`bool` **get_allow_rmb_select** **(** **)** +- |void| **set_allow_rmb_select**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_allow_rmb_select**\ (\ ) If ``true``, a right mouse button click can select items. @@ -635,8 +635,8 @@ If ``true``, a right mouse button click can select items. .. rst-class:: classref-property-setget -- void **set_allow_search** **(** :ref:`bool` value **)** -- :ref:`bool` **get_allow_search** **(** **)** +- |void| **set_allow_search**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_allow_search**\ (\ ) If ``true``, allows navigating the **Tree** with letter keys through incremental search. @@ -652,8 +652,8 @@ If ``true``, allows navigating the **Tree** with letter keys through incremental .. rst-class:: classref-property-setget -- void **set_column_titles_visible** **(** :ref:`bool` value **)** -- :ref:`bool` **are_column_titles_visible** **(** **)** +- |void| **set_column_titles_visible**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **are_column_titles_visible**\ (\ ) If ``true``, column titles are visible. @@ -669,8 +669,8 @@ If ``true``, column titles are visible. .. rst-class:: classref-property-setget -- void **set_columns** **(** :ref:`int` value **)** -- :ref:`int` **get_columns** **(** **)** +- |void| **set_columns**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_columns**\ (\ ) The number of columns. @@ -686,8 +686,8 @@ The number of columns. .. rst-class:: classref-property-setget -- void **set_drop_mode_flags** **(** :ref:`int` value **)** -- :ref:`int` **get_drop_mode_flags** **(** **)** +- |void| **set_drop_mode_flags**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_drop_mode_flags**\ (\ ) The drop mode as an OR combination of flags. See :ref:`DropModeFlags` constants. Once dropping is done, reverts to :ref:`DROP_MODE_DISABLED`. Setting this during :ref:`Control._can_drop_data` is recommended. @@ -705,8 +705,8 @@ This controls the drop sections, i.e. the decision and drawing of possible drop .. rst-class:: classref-property-setget -- void **set_enable_recursive_folding** **(** :ref:`bool` value **)** -- :ref:`bool` **is_recursive_folding_enabled** **(** **)** +- |void| **set_enable_recursive_folding**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_recursive_folding_enabled**\ (\ ) If ``true``, recursive folding is enabled for this **Tree**. Holding down :kbd:`Shift` while clicking the fold arrow or using ``ui_right``/``ui_left`` shortcuts collapses or uncollapses the :ref:`TreeItem` and all its descendants. @@ -722,8 +722,8 @@ If ``true``, recursive folding is enabled for this **Tree**. Holding down :kbd:` .. rst-class:: classref-property-setget -- void **set_hide_folding** **(** :ref:`bool` value **)** -- :ref:`bool` **is_folding_hidden** **(** **)** +- |void| **set_hide_folding**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_folding_hidden**\ (\ ) If ``true``, the folding arrow is hidden. @@ -739,8 +739,8 @@ If ``true``, the folding arrow is hidden. .. rst-class:: classref-property-setget -- void **set_hide_root** **(** :ref:`bool` value **)** -- :ref:`bool` **is_root_hidden** **(** **)** +- |void| **set_hide_root**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_root_hidden**\ (\ ) If ``true``, the tree's root is hidden. @@ -756,8 +756,8 @@ If ``true``, the tree's root is hidden. .. rst-class:: classref-property-setget -- void **set_h_scroll_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_h_scroll_enabled** **(** **)** +- |void| **set_h_scroll_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_h_scroll_enabled**\ (\ ) If ``true``, enables horizontal scrolling. @@ -773,8 +773,8 @@ If ``true``, enables horizontal scrolling. .. rst-class:: classref-property-setget -- void **set_v_scroll_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_v_scroll_enabled** **(** **)** +- |void| **set_v_scroll_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_v_scroll_enabled**\ (\ ) If ``true``, enables vertical scrolling. @@ -790,8 +790,8 @@ If ``true``, enables vertical scrolling. .. rst-class:: classref-property-setget -- void **set_select_mode** **(** :ref:`SelectMode` value **)** -- :ref:`SelectMode` **get_select_mode** **(** **)** +- |void| **set_select_mode**\ (\ value\: :ref:`SelectMode`\ ) +- :ref:`SelectMode` **get_select_mode**\ (\ ) Allows single or multiple selection. See the :ref:`SelectMode` constants. @@ -808,7 +808,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear** **(** **)** +|void| **clear**\ (\ ) Clears the tree. This removes all items. @@ -820,7 +820,7 @@ Clears the tree. This removes all items. .. rst-class:: classref-method -:ref:`TreeItem` **create_item** **(** :ref:`TreeItem` parent=null, :ref:`int` index=-1 **)** +:ref:`TreeItem` **create_item**\ (\ parent\: :ref:`TreeItem` = null, index\: :ref:`int` = -1\ ) Creates an item in the tree and adds it as a child of ``parent``, which can be either a valid :ref:`TreeItem` or ``null``. @@ -836,7 +836,7 @@ The new item will be the ``index``-th child of parent, or it will be the last ch .. rst-class:: classref-method -void **deselect_all** **(** **)** +|void| **deselect_all**\ (\ ) Deselects all tree items (rows and columns). In :ref:`SELECT_MULTI` mode also removes selection cursor. @@ -848,7 +848,7 @@ Deselects all tree items (rows and columns). In :ref:`SELECT_MULTI` **edit_selected** **(** :ref:`bool` force_edit=false **)** +:ref:`bool` **edit_selected**\ (\ force_edit\: :ref:`bool` = false\ ) Edits the selected tree item as if it was clicked. @@ -864,7 +864,7 @@ Returns ``true`` if the item could be edited. Fails if no item is selected. .. rst-class:: classref-method -void **ensure_cursor_is_visible** **(** **)** +|void| **ensure_cursor_is_visible**\ (\ ) Makes the currently focused cell visible. @@ -880,7 +880,7 @@ This will scroll the tree if necessary. In :ref:`SELECT_ROW` **get_button_id_at_position** **(** :ref:`Vector2` position **)** |const| +:ref:`int` **get_button_id_at_position**\ (\ position\: :ref:`Vector2`\ ) |const| Returns the button ID at ``position``, or -1 if no button is there. @@ -892,7 +892,7 @@ Returns the button ID at ``position``, or -1 if no button is there. .. rst-class:: classref-method -:ref:`int` **get_column_at_position** **(** :ref:`Vector2` position **)** |const| +:ref:`int` **get_column_at_position**\ (\ position\: :ref:`Vector2`\ ) |const| Returns the column index at ``position``, or -1 if no item is there. @@ -904,7 +904,7 @@ Returns the column index at ``position``, or -1 if no item is there. .. rst-class:: classref-method -:ref:`int` **get_column_expand_ratio** **(** :ref:`int` column **)** |const| +:ref:`int` **get_column_expand_ratio**\ (\ column\: :ref:`int`\ ) |const| Returns the expand ratio assigned to the column. @@ -916,7 +916,7 @@ Returns the expand ratio assigned to the column. .. rst-class:: classref-method -:ref:`String` **get_column_title** **(** :ref:`int` column **)** |const| +:ref:`String` **get_column_title**\ (\ column\: :ref:`int`\ ) |const| Returns the column's title. @@ -928,7 +928,7 @@ Returns the column's title. .. rst-class:: classref-method -:ref:`HorizontalAlignment` **get_column_title_alignment** **(** :ref:`int` column **)** |const| +:ref:`HorizontalAlignment` **get_column_title_alignment**\ (\ column\: :ref:`int`\ ) |const| Returns the column title alignment. @@ -940,7 +940,7 @@ Returns the column title alignment. .. rst-class:: classref-method -:ref:`TextDirection` **get_column_title_direction** **(** :ref:`int` column **)** |const| +:ref:`TextDirection` **get_column_title_direction**\ (\ column\: :ref:`int`\ ) |const| Returns column title base writing direction. @@ -952,7 +952,7 @@ Returns column title base writing direction. .. rst-class:: classref-method -:ref:`String` **get_column_title_language** **(** :ref:`int` column **)** |const| +:ref:`String` **get_column_title_language**\ (\ column\: :ref:`int`\ ) |const| Returns column title language code. @@ -964,7 +964,7 @@ Returns column title language code. .. rst-class:: classref-method -:ref:`int` **get_column_width** **(** :ref:`int` column **)** |const| +:ref:`int` **get_column_width**\ (\ column\: :ref:`int`\ ) |const| Returns the column's width in pixels. @@ -976,7 +976,7 @@ Returns the column's width in pixels. .. rst-class:: classref-method -:ref:`Rect2` **get_custom_popup_rect** **(** **)** |const| +:ref:`Rect2` **get_custom_popup_rect**\ (\ ) |const| Returns the rectangle for custom popups. Helper to create custom cell controls that display a popup. See :ref:`TreeItem.set_cell_mode`. @@ -988,7 +988,7 @@ Returns the rectangle for custom popups. Helper to create custom cell controls t .. rst-class:: classref-method -:ref:`int` **get_drop_section_at_position** **(** :ref:`Vector2` position **)** |const| +:ref:`int` **get_drop_section_at_position**\ (\ position\: :ref:`Vector2`\ ) |const| Returns the drop section at ``position``, or -100 if no item is there. @@ -1004,7 +1004,7 @@ To get the item which the returned drop section is relative to, use :ref:`get_it .. rst-class:: classref-method -:ref:`TreeItem` **get_edited** **(** **)** |const| +:ref:`TreeItem` **get_edited**\ (\ ) |const| Returns the currently edited item. Can be used with :ref:`item_edited` to get the item that was modified. @@ -1041,7 +1041,7 @@ Returns the currently edited item. Can be used with :ref:`item_edited` **get_edited_column** **(** **)** |const| +:ref:`int` **get_edited_column**\ (\ ) |const| Returns the column for the currently edited item. @@ -1053,7 +1053,7 @@ Returns the column for the currently edited item. .. rst-class:: classref-method -:ref:`Rect2` **get_item_area_rect** **(** :ref:`TreeItem` item, :ref:`int` column=-1, :ref:`int` button_index=-1 **)** |const| +:ref:`Rect2` **get_item_area_rect**\ (\ item\: :ref:`TreeItem`, column\: :ref:`int` = -1, button_index\: :ref:`int` = -1\ ) |const| Returns the rectangle area for the specified :ref:`TreeItem`. If ``column`` is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. If a button index is specified, the rectangle of that button will be returned. @@ -1065,7 +1065,7 @@ Returns the rectangle area for the specified :ref:`TreeItem`. If .. rst-class:: classref-method -:ref:`TreeItem` **get_item_at_position** **(** :ref:`Vector2` position **)** |const| +:ref:`TreeItem` **get_item_at_position**\ (\ position\: :ref:`Vector2`\ ) |const| Returns the tree item at the specified position (relative to the tree origin position). @@ -1077,7 +1077,7 @@ Returns the tree item at the specified position (relative to the tree origin pos .. rst-class:: classref-method -:ref:`TreeItem` **get_next_selected** **(** :ref:`TreeItem` from **)** +:ref:`TreeItem` **get_next_selected**\ (\ from\: :ref:`TreeItem`\ ) Returns the next selected :ref:`TreeItem` after the given one, or ``null`` if the end is reached. @@ -1091,7 +1091,7 @@ If ``from`` is ``null``, this returns the first selected item. .. rst-class:: classref-method -:ref:`int` **get_pressed_button** **(** **)** |const| +:ref:`int` **get_pressed_button**\ (\ ) |const| Returns the last pressed button's index. @@ -1103,7 +1103,7 @@ Returns the last pressed button's index. .. rst-class:: classref-method -:ref:`TreeItem` **get_root** **(** **)** |const| +:ref:`TreeItem` **get_root**\ (\ ) |const| Returns the tree's root item, or ``null`` if the tree is empty. @@ -1115,7 +1115,7 @@ Returns the tree's root item, or ``null`` if the tree is empty. .. rst-class:: classref-method -:ref:`Vector2` **get_scroll** **(** **)** |const| +:ref:`Vector2` **get_scroll**\ (\ ) |const| Returns the current scrolling position. @@ -1127,7 +1127,7 @@ Returns the current scrolling position. .. rst-class:: classref-method -:ref:`TreeItem` **get_selected** **(** **)** |const| +:ref:`TreeItem` **get_selected**\ (\ ) |const| Returns the currently focused item, or ``null`` if no item is focused. @@ -1143,7 +1143,7 @@ To get the currently selected item(s), use :ref:`get_next_selected` **get_selected_column** **(** **)** |const| +:ref:`int` **get_selected_column**\ (\ ) |const| Returns the currently focused column, or -1 if no column is focused. @@ -1159,7 +1159,7 @@ To tell whether a column of an item is selected, use :ref:`TreeItem.is_selected< .. rst-class:: classref-method -:ref:`bool` **is_column_clipping_content** **(** :ref:`int` column **)** |const| +:ref:`bool` **is_column_clipping_content**\ (\ column\: :ref:`int`\ ) |const| Returns ``true`` if the column has enabled clipping (see :ref:`set_column_clip_content`). @@ -1171,7 +1171,7 @@ Returns ``true`` if the column has enabled clipping (see :ref:`set_column_clip_c .. rst-class:: classref-method -:ref:`bool` **is_column_expanding** **(** :ref:`int` column **)** |const| +:ref:`bool` **is_column_expanding**\ (\ column\: :ref:`int`\ ) |const| Returns ``true`` if the column has enabled expanding (see :ref:`set_column_expand`). @@ -1183,7 +1183,7 @@ Returns ``true`` if the column has enabled expanding (see :ref:`set_column_expan .. rst-class:: classref-method -void **scroll_to_item** **(** :ref:`TreeItem` item, :ref:`bool` center_on_item=false **)** +|void| **scroll_to_item**\ (\ item\: :ref:`TreeItem`, center_on_item\: :ref:`bool` = false\ ) Causes the **Tree** to jump to the specified :ref:`TreeItem`. @@ -1195,7 +1195,7 @@ Causes the **Tree** to jump to the specified :ref:`TreeItem`. .. rst-class:: classref-method -void **set_column_clip_content** **(** :ref:`int` column, :ref:`bool` enable **)** +|void| **set_column_clip_content**\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) Allows to enable clipping for column's content, making the content size ignored. @@ -1207,7 +1207,7 @@ Allows to enable clipping for column's content, making the content size ignored. .. rst-class:: classref-method -void **set_column_custom_minimum_width** **(** :ref:`int` column, :ref:`int` min_width **)** +|void| **set_column_custom_minimum_width**\ (\ column\: :ref:`int`, min_width\: :ref:`int`\ ) Overrides the calculated minimum width of a column. It can be set to ``0`` to restore the default behavior. Columns that have the "Expand" flag will use their "min_width" in a similar fashion to :ref:`Control.size_flags_stretch_ratio`. @@ -1219,7 +1219,7 @@ Overrides the calculated minimum width of a column. It can be set to ``0`` to re .. rst-class:: classref-method -void **set_column_expand** **(** :ref:`int` column, :ref:`bool` expand **)** +|void| **set_column_expand**\ (\ column\: :ref:`int`, expand\: :ref:`bool`\ ) If ``true``, the column will have the "Expand" flag of :ref:`Control`. Columns that have the "Expand" flag will use their expand ratio in a similar fashion to :ref:`Control.size_flags_stretch_ratio` (see :ref:`set_column_expand_ratio`). @@ -1231,7 +1231,7 @@ If ``true``, the column will have the "Expand" flag of :ref:`Control` column, :ref:`int` ratio **)** +|void| **set_column_expand_ratio**\ (\ column\: :ref:`int`, ratio\: :ref:`int`\ ) Sets the relative expand ratio for a column. See :ref:`set_column_expand`. @@ -1243,7 +1243,7 @@ Sets the relative expand ratio for a column. See :ref:`set_column_expand` column, :ref:`String` title **)** +|void| **set_column_title**\ (\ column\: :ref:`int`, title\: :ref:`String`\ ) Sets the title of a column. @@ -1255,7 +1255,7 @@ Sets the title of a column. .. rst-class:: classref-method -void **set_column_title_alignment** **(** :ref:`int` column, :ref:`HorizontalAlignment` title_alignment **)** +|void| **set_column_title_alignment**\ (\ column\: :ref:`int`, title_alignment\: :ref:`HorizontalAlignment`\ ) Sets the column title alignment. Note that :ref:`@GlobalScope.HORIZONTAL_ALIGNMENT_FILL` is not supported for column titles. @@ -1267,7 +1267,7 @@ Sets the column title alignment. Note that :ref:`@GlobalScope.HORIZONTAL_ALIGNME .. rst-class:: classref-method -void **set_column_title_direction** **(** :ref:`int` column, :ref:`TextDirection` direction **)** +|void| **set_column_title_direction**\ (\ column\: :ref:`int`, direction\: :ref:`TextDirection`\ ) Sets column title base writing direction. @@ -1279,7 +1279,7 @@ Sets column title base writing direction. .. rst-class:: classref-method -void **set_column_title_language** **(** :ref:`int` column, :ref:`String` language **)** +|void| **set_column_title_language**\ (\ column\: :ref:`int`, language\: :ref:`String`\ ) Sets language code of column title used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -1291,7 +1291,7 @@ Sets language code of column title used for line-breaking and text shaping algor .. rst-class:: classref-method -void **set_selected** **(** :ref:`TreeItem` item, :ref:`int` column **)** +|void| **set_selected**\ (\ item\: :ref:`TreeItem`, column\: :ref:`int`\ ) Selects the specified :ref:`TreeItem` and column. @@ -2065,3 +2065,4 @@ Default :ref:`StyleBox` for the title button. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 50b261a6294..58921a344f4 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -51,211 +51,211 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture2D` button, :ref:`int` id=-1, :ref:`bool` disabled=false, :ref:`String` tooltip_text="" **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_child` **(** :ref:`TreeItem` child **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`call_recursive` **(** :ref:`StringName` method, ... **)** |vararg| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_custom_bg_color` **(** :ref:`int` column **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_custom_color` **(** :ref:`int` column **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`create_child` **(** :ref:`int` index=-1 **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`deselect` **(** :ref:`int` column **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`erase_button` **(** :ref:`int` column, :ref:`int` button_index **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AutowrapMode` | :ref:`get_autowrap_mode` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_button` **(** :ref:`int` column, :ref:`int` button_index **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_button_by_id` **(** :ref:`int` column, :ref:`int` id **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_button_color` **(** :ref:`int` column, :ref:`int` id **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_button_count` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_button_id` **(** :ref:`int` column, :ref:`int` button_index **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_button_tooltip_text` **(** :ref:`int` column, :ref:`int` button_index **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeCellMode` | :ref:`get_cell_mode` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_child` **(** :ref:`int` index **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_child_count` **(** **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem[]` | :ref:`get_children` **(** **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_custom_color` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Callable` | :ref:`get_custom_draw_callback` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Font` | :ref:`get_custom_font` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_custom_font_size` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_expand_right` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_first_child` **(** **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_icon` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_icon_max_width` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_icon_modulate` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_index` **(** **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_language` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_metadata` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_next` **(** **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_next_in_tree` **(** :ref:`bool` wrap=false **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_next_visible` **(** :ref:`bool` wrap=false **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_parent` **(** **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_prev` **(** **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_prev_in_tree` **(** :ref:`bool` wrap=false **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_prev_visible` **(** :ref:`bool` wrap=false **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StructuredTextParser` | :ref:`get_structured_text_bidi_override` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_structured_text_bidi_override_options` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_suffix` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`HorizontalAlignment` | :ref:`get_text_alignment` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TextDirection` | :ref:`get_text_direction` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`OverrunBehavior` | :ref:`get_text_overrun_behavior` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_tooltip_text` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Tree` | :ref:`get_tree` **(** **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_any_collapsed` **(** :ref:`bool` only_visible=false **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_button_disabled` **(** :ref:`int` column, :ref:`int` button_index **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_checked` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_custom_set_as_button` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_edit_multiline` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_editable` **(** :ref:`int` column **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_indeterminate` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_selectable` **(** :ref:`int` column **)** |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_selected` **(** :ref:`int` column **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_after` **(** :ref:`TreeItem` item **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_before` **(** :ref:`TreeItem` item **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`propagate_check` **(** :ref:`int` column, :ref:`bool` emit_signal=true **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_child` **(** :ref:`TreeItem` child **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`select` **(** :ref:`int` column **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_autowrap_mode` **(** :ref:`int` column, :ref:`AutowrapMode` autowrap_mode **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_button` **(** :ref:`int` column, :ref:`int` button_index, :ref:`Texture2D` button **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_button_color` **(** :ref:`int` column, :ref:`int` button_index, :ref:`Color` color **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_button_disabled` **(** :ref:`int` column, :ref:`int` button_index, :ref:`bool` disabled **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_button_tooltip_text` **(** :ref:`int` column, :ref:`int` button_index, :ref:`String` tooltip **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`TreeCellMode` mode **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_checked` **(** :ref:`int` column, :ref:`bool` checked **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_collapsed_recursive` **(** :ref:`bool` enable **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_custom_as_button` **(** :ref:`int` column, :ref:`bool` enable **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_custom_bg_color` **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_custom_color` **(** :ref:`int` column, :ref:`Color` color **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`StringName` callback **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_custom_draw_callback` **(** :ref:`int` column, :ref:`Callable` callback **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_custom_font` **(** :ref:`int` column, :ref:`Font` font **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_custom_font_size` **(** :ref:`int` column, :ref:`int` font_size **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_edit_multiline` **(** :ref:`int` column, :ref:`bool` multiline **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_expand_right` **(** :ref:`int` column, :ref:`bool` enable **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture2D` texture **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_icon_max_width` **(** :ref:`int` column, :ref:`int` width **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_icon_modulate` **(** :ref:`int` column, :ref:`Color` modulate **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_icon_region` **(** :ref:`int` column, :ref:`Rect2` region **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_indeterminate` **(** :ref:`int` column, :ref:`bool` indeterminate **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_language` **(** :ref:`int` column, :ref:`String` language **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_metadata` **(** :ref:`int` column, :ref:`Variant` meta **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_range` **(** :ref:`int` column, :ref:`float` value **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_range_config` **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_selectable` **(** :ref:`int` column, :ref:`bool` selectable **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_structured_text_bidi_override` **(** :ref:`int` column, :ref:`StructuredTextParser` parser **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_structured_text_bidi_override_options` **(** :ref:`int` column, :ref:`Array` args **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_suffix` **(** :ref:`int` column, :ref:`String` text **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_text_alignment` **(** :ref:`int` column, :ref:`HorizontalAlignment` text_alignment **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_text_direction` **(** :ref:`int` column, :ref:`TextDirection` direction **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_text_overrun_behavior` **(** :ref:`int` column, :ref:`OverrunBehavior` overrun_behavior **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tooltip_text` **(** :ref:`int` column, :ref:`String` tooltip **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`uncollapse_tree` **(** **)** | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_button`\ (\ column\: :ref:`int`, button\: :ref:`Texture2D`, id\: :ref:`int` = -1, disabled\: :ref:`bool` = false, tooltip_text\: :ref:`String` = ""\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_child`\ (\ child\: :ref:`TreeItem`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`call_recursive`\ (\ method\: :ref:`StringName`, ...\ ) |vararg| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_custom_bg_color`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_custom_color`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`create_child`\ (\ index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`deselect`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`erase_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AutowrapMode` | :ref:`get_autowrap_mode`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_button_by_id`\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_button_color`\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_button_count`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_button_id`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_button_tooltip_text`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeCellMode` | :ref:`get_cell_mode`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_child`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_child_count`\ (\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`TreeItem`\] | :ref:`get_children`\ (\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_custom_bg_color`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_custom_color`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Callable` | :ref:`get_custom_draw_callback`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Font` | :ref:`get_custom_font`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_custom_font_size`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_expand_right`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_first_child`\ (\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_icon`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_icon_max_width`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_icon_modulate`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_icon_region`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_index`\ (\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_language`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_metadata`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_next`\ (\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_next_in_tree`\ (\ wrap\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_next_visible`\ (\ wrap\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_parent`\ (\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_prev`\ (\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_prev_in_tree`\ (\ wrap\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_prev_visible`\ (\ wrap\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_range`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_range_config`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StructuredTextParser` | :ref:`get_structured_text_bidi_override`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_structured_text_bidi_override_options`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_suffix`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_text`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`HorizontalAlignment` | :ref:`get_text_alignment`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`get_text_direction`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`OverrunBehavior` | :ref:`get_text_overrun_behavior`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_tooltip_text`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Tree` | :ref:`get_tree`\ (\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_any_collapsed`\ (\ only_visible\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_button_disabled`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_checked`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_custom_set_as_button`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_edit_multiline`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_editable`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_indeterminate`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_selectable`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_selected`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_after`\ (\ item\: :ref:`TreeItem`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_before`\ (\ item\: :ref:`TreeItem`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`propagate_check`\ (\ column\: :ref:`int`, emit_signal\: :ref:`bool` = true\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_child`\ (\ child\: :ref:`TreeItem`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_autowrap_mode`\ (\ column\: :ref:`int`, autowrap_mode\: :ref:`AutowrapMode`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, button\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_button_color`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, color\: :ref:`Color`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_button_disabled`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_button_tooltip_text`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cell_mode`\ (\ column\: :ref:`int`, mode\: :ref:`TreeCellMode`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_checked`\ (\ column\: :ref:`int`, checked\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collapsed_recursive`\ (\ enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_as_button`\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_bg_color`\ (\ column\: :ref:`int`, color\: :ref:`Color`, just_outline\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_color`\ (\ column\: :ref:`int`, color\: :ref:`Color`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_draw`\ (\ column\: :ref:`int`, object\: :ref:`Object`, callback\: :ref:`StringName`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_draw_callback`\ (\ column\: :ref:`int`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_font`\ (\ column\: :ref:`int`, font\: :ref:`Font`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_font_size`\ (\ column\: :ref:`int`, font_size\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_edit_multiline`\ (\ column\: :ref:`int`, multiline\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_editable`\ (\ column\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_expand_right`\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon`\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon_max_width`\ (\ column\: :ref:`int`, width\: :ref:`int`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon_modulate`\ (\ column\: :ref:`int`, modulate\: :ref:`Color`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon_region`\ (\ column\: :ref:`int`, region\: :ref:`Rect2`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_indeterminate`\ (\ column\: :ref:`int`, indeterminate\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_language`\ (\ column\: :ref:`int`, language\: :ref:`String`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_metadata`\ (\ column\: :ref:`int`, meta\: :ref:`Variant`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_range`\ (\ column\: :ref:`int`, value\: :ref:`float`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_range_config`\ (\ column\: :ref:`int`, min\: :ref:`float`, max\: :ref:`float`, step\: :ref:`float`, expr\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_selectable`\ (\ column\: :ref:`int`, selectable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_structured_text_bidi_override`\ (\ column\: :ref:`int`, parser\: :ref:`StructuredTextParser`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_structured_text_bidi_override_options`\ (\ column\: :ref:`int`, args\: :ref:`Array`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_suffix`\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_text`\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_text_alignment`\ (\ column\: :ref:`int`, text_alignment\: :ref:`HorizontalAlignment`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_text_direction`\ (\ column\: :ref:`int`, direction\: :ref:`TextDirection`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_text_overrun_behavior`\ (\ column\: :ref:`int`, overrun_behavior\: :ref:`OverrunBehavior`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tooltip_text`\ (\ column\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`uncollapse_tree`\ (\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -333,8 +333,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_collapsed** **(** :ref:`bool` value **)** -- :ref:`bool` **is_collapsed** **(** **)** +- |void| **set_collapsed**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_collapsed**\ (\ ) If ``true``, the TreeItem is collapsed. @@ -350,8 +350,8 @@ If ``true``, the TreeItem is collapsed. .. rst-class:: classref-property-setget -- void **set_custom_minimum_height** **(** :ref:`int` value **)** -- :ref:`int` **get_custom_minimum_height** **(** **)** +- |void| **set_custom_minimum_height**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_custom_minimum_height**\ (\ ) The custom minimum height. @@ -367,8 +367,8 @@ The custom minimum height. .. rst-class:: classref-property-setget -- void **set_disable_folding** **(** :ref:`bool` value **)** -- :ref:`bool` **is_folding_disabled** **(** **)** +- |void| **set_disable_folding**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_folding_disabled**\ (\ ) If ``true``, folding is disabled for this TreeItem. @@ -384,8 +384,8 @@ If ``true``, folding is disabled for this TreeItem. .. rst-class:: classref-property-setget -- void **set_visible** **(** :ref:`bool` value **)** -- :ref:`bool` **is_visible** **(** **)** +- |void| **set_visible**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_visible**\ (\ ) If ``true``, the **TreeItem** is visible (default). @@ -404,7 +404,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_button** **(** :ref:`int` column, :ref:`Texture2D` button, :ref:`int` id=-1, :ref:`bool` disabled=false, :ref:`String` tooltip_text="" **)** +|void| **add_button**\ (\ column\: :ref:`int`, button\: :ref:`Texture2D`, id\: :ref:`int` = -1, disabled\: :ref:`bool` = false, tooltip_text\: :ref:`String` = ""\ ) Adds a button with :ref:`Texture2D` ``button`` at column ``column``. The ``id`` is used to identify the button in the according :ref:`Tree.button_clicked` signal and can be different from the buttons index. If not specified, the next available index is used, which may be retrieved by calling :ref:`get_button_count` immediately before this method. Optionally, the button can be ``disabled`` and have a ``tooltip_text``. @@ -416,7 +416,7 @@ Adds a button with :ref:`Texture2D` ``button`` at column ``colu .. rst-class:: classref-method -void **add_child** **(** :ref:`TreeItem` child **)** +|void| **add_child**\ (\ child\: :ref:`TreeItem`\ ) Adds a previously unparented **TreeItem** as a direct child of this one. The ``child`` item must not be a part of any :ref:`Tree` or parented to any **TreeItem**. See also :ref:`remove_child`. @@ -428,7 +428,7 @@ Adds a previously unparented **TreeItem** as a direct child of this one. The ``c .. rst-class:: classref-method -void **call_recursive** **(** :ref:`StringName` method, ... **)** |vararg| +|void| **call_recursive**\ (\ method\: :ref:`StringName`, ...\ ) |vararg| Calls the ``method`` on the actual TreeItem and its children recursively. Pass parameters as a comma separated list. @@ -440,7 +440,7 @@ Calls the ``method`` on the actual TreeItem and its children recursively. Pass p .. rst-class:: classref-method -void **clear_custom_bg_color** **(** :ref:`int` column **)** +|void| **clear_custom_bg_color**\ (\ column\: :ref:`int`\ ) Resets the background color for the given column to default. @@ -452,7 +452,7 @@ Resets the background color for the given column to default. .. rst-class:: classref-method -void **clear_custom_color** **(** :ref:`int` column **)** +|void| **clear_custom_color**\ (\ column\: :ref:`int`\ ) Resets the color for the given column to default. @@ -464,7 +464,7 @@ Resets the color for the given column to default. .. rst-class:: classref-method -:ref:`TreeItem` **create_child** **(** :ref:`int` index=-1 **)** +:ref:`TreeItem` **create_child**\ (\ index\: :ref:`int` = -1\ ) Creates an item and adds it as a child. @@ -478,7 +478,7 @@ The new item will be inserted as position ``index`` (the default value ``-1`` me .. rst-class:: classref-method -void **deselect** **(** :ref:`int` column **)** +|void| **deselect**\ (\ column\: :ref:`int`\ ) Deselects the given column. @@ -490,7 +490,7 @@ Deselects the given column. .. rst-class:: classref-method -void **erase_button** **(** :ref:`int` column, :ref:`int` button_index **)** +|void| **erase_button**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) Removes the button at index ``button_index`` in column ``column``. @@ -502,7 +502,7 @@ Removes the button at index ``button_index`` in column ``column``. .. rst-class:: classref-method -:ref:`AutowrapMode` **get_autowrap_mode** **(** :ref:`int` column **)** |const| +:ref:`AutowrapMode` **get_autowrap_mode**\ (\ column\: :ref:`int`\ ) |const| Returns the text autowrap mode in the given ``column``. By default it is :ref:`TextServer.AUTOWRAP_OFF`. @@ -514,7 +514,7 @@ Returns the text autowrap mode in the given ``column``. By default it is :ref:`T .. rst-class:: classref-method -:ref:`Texture2D` **get_button** **(** :ref:`int` column, :ref:`int` button_index **)** |const| +:ref:`Texture2D` **get_button**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| Returns the :ref:`Texture2D` of the button at index ``button_index`` in column ``column``. @@ -526,7 +526,7 @@ Returns the :ref:`Texture2D` of the button at index ``button_in .. rst-class:: classref-method -:ref:`int` **get_button_by_id** **(** :ref:`int` column, :ref:`int` id **)** |const| +:ref:`int` **get_button_by_id**\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| Returns the button index if there is a button with ID ``id`` in column ``column``, otherwise returns -1. @@ -538,7 +538,7 @@ Returns the button index if there is a button with ID ``id`` in column ``column` .. rst-class:: classref-method -:ref:`Color` **get_button_color** **(** :ref:`int` column, :ref:`int` id **)** |const| +:ref:`Color` **get_button_color**\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| Returns the color of the button with ID ``id`` in column ``column``. If the specified button does not exist, returns :ref:`Color.BLACK`. @@ -550,7 +550,7 @@ Returns the color of the button with ID ``id`` in column ``column``. If the spec .. rst-class:: classref-method -:ref:`int` **get_button_count** **(** :ref:`int` column **)** |const| +:ref:`int` **get_button_count**\ (\ column\: :ref:`int`\ ) |const| Returns the number of buttons in column ``column``. @@ -562,7 +562,7 @@ Returns the number of buttons in column ``column``. .. rst-class:: classref-method -:ref:`int` **get_button_id** **(** :ref:`int` column, :ref:`int` button_index **)** |const| +:ref:`int` **get_button_id**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| Returns the ID for the button at index ``button_index`` in column ``column``. @@ -574,7 +574,7 @@ Returns the ID for the button at index ``button_index`` in column ``column``. .. rst-class:: classref-method -:ref:`String` **get_button_tooltip_text** **(** :ref:`int` column, :ref:`int` button_index **)** |const| +:ref:`String` **get_button_tooltip_text**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| Returns the tooltip text for the button at index ``button_index`` in column ``column``. @@ -586,7 +586,7 @@ Returns the tooltip text for the button at index ``button_index`` in column ``co .. rst-class:: classref-method -:ref:`TreeCellMode` **get_cell_mode** **(** :ref:`int` column **)** |const| +:ref:`TreeCellMode` **get_cell_mode**\ (\ column\: :ref:`int`\ ) |const| Returns the column's cell mode. @@ -598,7 +598,7 @@ Returns the column's cell mode. .. rst-class:: classref-method -:ref:`TreeItem` **get_child** **(** :ref:`int` index **)** +:ref:`TreeItem` **get_child**\ (\ index\: :ref:`int`\ ) Returns a child item by its ``index`` (see :ref:`get_child_count`). This method is often used for iterating all children of an item. @@ -612,7 +612,7 @@ Negative indices access the children from the last one. .. rst-class:: classref-method -:ref:`int` **get_child_count** **(** **)** +:ref:`int` **get_child_count**\ (\ ) Returns the number of child items. @@ -624,7 +624,7 @@ Returns the number of child items. .. rst-class:: classref-method -:ref:`TreeItem[]` **get_children** **(** **)** +:ref:`Array`\[:ref:`TreeItem`\] **get_children**\ (\ ) Returns an array of references to the item's children. @@ -636,7 +636,7 @@ Returns an array of references to the item's children. .. rst-class:: classref-method -:ref:`Color` **get_custom_bg_color** **(** :ref:`int` column **)** |const| +:ref:`Color` **get_custom_bg_color**\ (\ column\: :ref:`int`\ ) |const| Returns the custom background color of column ``column``. @@ -648,7 +648,7 @@ Returns the custom background color of column ``column``. .. rst-class:: classref-method -:ref:`Color` **get_custom_color** **(** :ref:`int` column **)** |const| +:ref:`Color` **get_custom_color**\ (\ column\: :ref:`int`\ ) |const| Returns the custom color of column ``column``. @@ -660,7 +660,7 @@ Returns the custom color of column ``column``. .. rst-class:: classref-method -:ref:`Callable` **get_custom_draw_callback** **(** :ref:`int` column **)** |const| +:ref:`Callable` **get_custom_draw_callback**\ (\ column\: :ref:`int`\ ) |const| Returns the custom callback of column ``column``. @@ -672,7 +672,7 @@ Returns the custom callback of column ``column``. .. rst-class:: classref-method -:ref:`Font` **get_custom_font** **(** :ref:`int` column **)** |const| +:ref:`Font` **get_custom_font**\ (\ column\: :ref:`int`\ ) |const| Returns custom font used to draw text in the column ``column``. @@ -684,7 +684,7 @@ Returns custom font used to draw text in the column ``column``. .. rst-class:: classref-method -:ref:`int` **get_custom_font_size** **(** :ref:`int` column **)** |const| +:ref:`int` **get_custom_font_size**\ (\ column\: :ref:`int`\ ) |const| Returns custom font size used to draw text in the column ``column``. @@ -696,7 +696,7 @@ Returns custom font size used to draw text in the column ``column``. .. rst-class:: classref-method -:ref:`bool` **get_expand_right** **(** :ref:`int` column **)** |const| +:ref:`bool` **get_expand_right**\ (\ column\: :ref:`int`\ ) |const| Returns ``true`` if ``expand_right`` is set. @@ -708,7 +708,7 @@ Returns ``true`` if ``expand_right`` is set. .. rst-class:: classref-method -:ref:`TreeItem` **get_first_child** **(** **)** |const| +:ref:`TreeItem` **get_first_child**\ (\ ) |const| Returns the TreeItem's first child. @@ -720,7 +720,7 @@ Returns the TreeItem's first child. .. rst-class:: classref-method -:ref:`Texture2D` **get_icon** **(** :ref:`int` column **)** |const| +:ref:`Texture2D` **get_icon**\ (\ column\: :ref:`int`\ ) |const| Returns the given column's icon :ref:`Texture2D`. Error if no icon is set. @@ -732,7 +732,7 @@ Returns the given column's icon :ref:`Texture2D`. Error if no i .. rst-class:: classref-method -:ref:`int` **get_icon_max_width** **(** :ref:`int` column **)** |const| +:ref:`int` **get_icon_max_width**\ (\ column\: :ref:`int`\ ) |const| Returns the maximum allowed width of the icon in the given ``column``. @@ -744,7 +744,7 @@ Returns the maximum allowed width of the icon in the given ``column``. .. rst-class:: classref-method -:ref:`Color` **get_icon_modulate** **(** :ref:`int` column **)** |const| +:ref:`Color` **get_icon_modulate**\ (\ column\: :ref:`int`\ ) |const| Returns the :ref:`Color` modulating the column's icon. @@ -756,7 +756,7 @@ Returns the :ref:`Color` modulating the column's icon. .. rst-class:: classref-method -:ref:`Rect2` **get_icon_region** **(** :ref:`int` column **)** |const| +:ref:`Rect2` **get_icon_region**\ (\ column\: :ref:`int`\ ) |const| Returns the icon :ref:`Texture2D` region as :ref:`Rect2`. @@ -768,7 +768,7 @@ Returns the icon :ref:`Texture2D` region as :ref:`Rect2` **get_index** **(** **)** +:ref:`int` **get_index**\ (\ ) Returns the node's order in the tree. For example, if called on the first child item the position is ``0``. @@ -780,7 +780,7 @@ Returns the node's order in the tree. For example, if called on the first child .. rst-class:: classref-method -:ref:`String` **get_language** **(** :ref:`int` column **)** |const| +:ref:`String` **get_language**\ (\ column\: :ref:`int`\ ) |const| Returns item's text language code. @@ -792,7 +792,7 @@ Returns item's text language code. .. rst-class:: classref-method -:ref:`Variant` **get_metadata** **(** :ref:`int` column **)** |const| +:ref:`Variant` **get_metadata**\ (\ column\: :ref:`int`\ ) |const| Returns the metadata value that was set for the given column using :ref:`set_metadata`. @@ -804,7 +804,7 @@ Returns the metadata value that was set for the given column using :ref:`set_met .. rst-class:: classref-method -:ref:`TreeItem` **get_next** **(** **)** |const| +:ref:`TreeItem` **get_next**\ (\ ) |const| Returns the next sibling TreeItem in the tree or a null object if there is none. @@ -816,7 +816,7 @@ Returns the next sibling TreeItem in the tree or a null object if there is none. .. rst-class:: classref-method -:ref:`TreeItem` **get_next_in_tree** **(** :ref:`bool` wrap=false **)** +:ref:`TreeItem` **get_next_in_tree**\ (\ wrap\: :ref:`bool` = false\ ) Returns the next TreeItem in the tree (in the context of a depth-first search) or a ``null`` object if there is none. @@ -830,7 +830,7 @@ If ``wrap`` is enabled, the method will wrap around to the first element in the .. rst-class:: classref-method -:ref:`TreeItem` **get_next_visible** **(** :ref:`bool` wrap=false **)** +:ref:`TreeItem` **get_next_visible**\ (\ wrap\: :ref:`bool` = false\ ) Returns the next visible TreeItem in the tree (in the context of a depth-first search) or a ``null`` object if there is none. @@ -844,7 +844,7 @@ If ``wrap`` is enabled, the method will wrap around to the first visible element .. rst-class:: classref-method -:ref:`TreeItem` **get_parent** **(** **)** |const| +:ref:`TreeItem` **get_parent**\ (\ ) |const| Returns the parent TreeItem or a null object if there is none. @@ -856,7 +856,7 @@ Returns the parent TreeItem or a null object if there is none. .. rst-class:: classref-method -:ref:`TreeItem` **get_prev** **(** **)** +:ref:`TreeItem` **get_prev**\ (\ ) Returns the previous sibling TreeItem in the tree or a null object if there is none. @@ -868,7 +868,7 @@ Returns the previous sibling TreeItem in the tree or a null object if there is n .. rst-class:: classref-method -:ref:`TreeItem` **get_prev_in_tree** **(** :ref:`bool` wrap=false **)** +:ref:`TreeItem` **get_prev_in_tree**\ (\ wrap\: :ref:`bool` = false\ ) Returns the previous TreeItem in the tree (in the context of a depth-first search) or a ``null`` object if there is none. @@ -882,7 +882,7 @@ If ``wrap`` is enabled, the method will wrap around to the last element in the t .. rst-class:: classref-method -:ref:`TreeItem` **get_prev_visible** **(** :ref:`bool` wrap=false **)** +:ref:`TreeItem` **get_prev_visible**\ (\ wrap\: :ref:`bool` = false\ ) Returns the previous visible sibling TreeItem in the tree (in the context of a depth-first search) or a ``null`` object if there is none. @@ -896,7 +896,7 @@ If ``wrap`` is enabled, the method will wrap around to the last visible element .. rst-class:: classref-method -:ref:`float` **get_range** **(** :ref:`int` column **)** |const| +:ref:`float` **get_range**\ (\ column\: :ref:`int`\ ) |const| Returns the value of a :ref:`CELL_MODE_RANGE` column. @@ -908,7 +908,7 @@ Returns the value of a :ref:`CELL_MODE_RANGE` **get_range_config** **(** :ref:`int` column **)** +:ref:`Dictionary` **get_range_config**\ (\ column\: :ref:`int`\ ) Returns a dictionary containing the range parameters for a given column. The keys are "min", "max", "step", and "expr". @@ -920,7 +920,7 @@ Returns a dictionary containing the range parameters for a given column. The key .. rst-class:: classref-method -:ref:`StructuredTextParser` **get_structured_text_bidi_override** **(** :ref:`int` column **)** |const| +:ref:`StructuredTextParser` **get_structured_text_bidi_override**\ (\ column\: :ref:`int`\ ) |const| .. container:: contribute @@ -934,7 +934,7 @@ Returns a dictionary containing the range parameters for a given column. The key .. rst-class:: classref-method -:ref:`Array` **get_structured_text_bidi_override_options** **(** :ref:`int` column **)** |const| +:ref:`Array` **get_structured_text_bidi_override_options**\ (\ column\: :ref:`int`\ ) |const| .. container:: contribute @@ -948,7 +948,7 @@ Returns a dictionary containing the range parameters for a given column. The key .. rst-class:: classref-method -:ref:`String` **get_suffix** **(** :ref:`int` column **)** |const| +:ref:`String` **get_suffix**\ (\ column\: :ref:`int`\ ) |const| Gets the suffix string shown after the column value. @@ -960,7 +960,7 @@ Gets the suffix string shown after the column value. .. rst-class:: classref-method -:ref:`String` **get_text** **(** :ref:`int` column **)** |const| +:ref:`String` **get_text**\ (\ column\: :ref:`int`\ ) |const| Returns the given column's text. @@ -972,7 +972,7 @@ Returns the given column's text. .. rst-class:: classref-method -:ref:`HorizontalAlignment` **get_text_alignment** **(** :ref:`int` column **)** |const| +:ref:`HorizontalAlignment` **get_text_alignment**\ (\ column\: :ref:`int`\ ) |const| Returns the given column's text alignment. @@ -984,7 +984,7 @@ Returns the given column's text alignment. .. rst-class:: classref-method -:ref:`TextDirection` **get_text_direction** **(** :ref:`int` column **)** |const| +:ref:`TextDirection` **get_text_direction**\ (\ column\: :ref:`int`\ ) |const| Returns item's text base writing direction. @@ -996,7 +996,7 @@ Returns item's text base writing direction. .. rst-class:: classref-method -:ref:`OverrunBehavior` **get_text_overrun_behavior** **(** :ref:`int` column **)** |const| +:ref:`OverrunBehavior` **get_text_overrun_behavior**\ (\ column\: :ref:`int`\ ) |const| Returns the clipping behavior when the text exceeds the item's bounding rectangle in the given ``column``. By default it is :ref:`TextServer.OVERRUN_TRIM_ELLIPSIS`. @@ -1008,7 +1008,7 @@ Returns the clipping behavior when the text exceeds the item's bounding rectangl .. rst-class:: classref-method -:ref:`String` **get_tooltip_text** **(** :ref:`int` column **)** |const| +:ref:`String` **get_tooltip_text**\ (\ column\: :ref:`int`\ ) |const| Returns the given column's tooltip text. @@ -1020,7 +1020,7 @@ Returns the given column's tooltip text. .. rst-class:: classref-method -:ref:`Tree` **get_tree** **(** **)** |const| +:ref:`Tree` **get_tree**\ (\ ) |const| Returns the :ref:`Tree` that owns this TreeItem. @@ -1032,7 +1032,7 @@ Returns the :ref:`Tree` that owns this TreeItem. .. rst-class:: classref-method -:ref:`bool` **is_any_collapsed** **(** :ref:`bool` only_visible=false **)** +:ref:`bool` **is_any_collapsed**\ (\ only_visible\: :ref:`bool` = false\ ) Returns ``true`` if this **TreeItem**, or any of its descendants, is collapsed. @@ -1046,7 +1046,7 @@ If ``only_visible`` is ``true`` it ignores non-visible **TreeItem**\ s. .. rst-class:: classref-method -:ref:`bool` **is_button_disabled** **(** :ref:`int` column, :ref:`int` button_index **)** |const| +:ref:`bool` **is_button_disabled**\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| Returns ``true`` if the button at index ``button_index`` for the given ``column`` is disabled. @@ -1058,7 +1058,7 @@ Returns ``true`` if the button at index ``button_index`` for the given ``column` .. rst-class:: classref-method -:ref:`bool` **is_checked** **(** :ref:`int` column **)** |const| +:ref:`bool` **is_checked**\ (\ column\: :ref:`int`\ ) |const| Returns ``true`` if the given ``column`` is checked. @@ -1070,7 +1070,7 @@ Returns ``true`` if the given ``column`` is checked. .. rst-class:: classref-method -:ref:`bool` **is_custom_set_as_button** **(** :ref:`int` column **)** |const| +:ref:`bool` **is_custom_set_as_button**\ (\ column\: :ref:`int`\ ) |const| .. container:: contribute @@ -1084,7 +1084,7 @@ Returns ``true`` if the given ``column`` is checked. .. rst-class:: classref-method -:ref:`bool` **is_edit_multiline** **(** :ref:`int` column **)** |const| +:ref:`bool` **is_edit_multiline**\ (\ column\: :ref:`int`\ ) |const| Returns ``true`` if the given ``column`` is multiline editable. @@ -1096,7 +1096,7 @@ Returns ``true`` if the given ``column`` is multiline editable. .. rst-class:: classref-method -:ref:`bool` **is_editable** **(** :ref:`int` column **)** +:ref:`bool` **is_editable**\ (\ column\: :ref:`int`\ ) Returns ``true`` if the given ``column`` is editable. @@ -1108,7 +1108,7 @@ Returns ``true`` if the given ``column`` is editable. .. rst-class:: classref-method -:ref:`bool` **is_indeterminate** **(** :ref:`int` column **)** |const| +:ref:`bool` **is_indeterminate**\ (\ column\: :ref:`int`\ ) |const| Returns ``true`` if the given ``column`` is indeterminate. @@ -1120,7 +1120,7 @@ Returns ``true`` if the given ``column`` is indeterminate. .. rst-class:: classref-method -:ref:`bool` **is_selectable** **(** :ref:`int` column **)** |const| +:ref:`bool` **is_selectable**\ (\ column\: :ref:`int`\ ) |const| Returns ``true`` if the given ``column`` is selectable. @@ -1132,7 +1132,7 @@ Returns ``true`` if the given ``column`` is selectable. .. rst-class:: classref-method -:ref:`bool` **is_selected** **(** :ref:`int` column **)** +:ref:`bool` **is_selected**\ (\ column\: :ref:`int`\ ) Returns ``true`` if the given ``column`` is selected. @@ -1144,7 +1144,7 @@ Returns ``true`` if the given ``column`` is selected. .. rst-class:: classref-method -void **move_after** **(** :ref:`TreeItem` item **)** +|void| **move_after**\ (\ item\: :ref:`TreeItem`\ ) Moves this TreeItem right after the given ``item``. @@ -1158,7 +1158,7 @@ Moves this TreeItem right after the given ``item``. .. rst-class:: classref-method -void **move_before** **(** :ref:`TreeItem` item **)** +|void| **move_before**\ (\ item\: :ref:`TreeItem`\ ) Moves this TreeItem right before the given ``item``. @@ -1172,7 +1172,7 @@ Moves this TreeItem right before the given ``item``. .. rst-class:: classref-method -void **propagate_check** **(** :ref:`int` column, :ref:`bool` emit_signal=true **)** +|void| **propagate_check**\ (\ column\: :ref:`int`, emit_signal\: :ref:`bool` = true\ ) Propagates this item's checked status to its children and parents for the given ``column``. It is possible to process the items affected by this method call by connecting to :ref:`Tree.check_propagated_to_item`. The order that the items affected will be processed is as follows: the item invoking this method, children of that item, and finally parents of that item. If ``emit_signal`` is ``false``, then :ref:`Tree.check_propagated_to_item` will not be emitted. @@ -1184,7 +1184,7 @@ Propagates this item's checked status to its children and parents for the given .. rst-class:: classref-method -void **remove_child** **(** :ref:`TreeItem` child **)** +|void| **remove_child**\ (\ child\: :ref:`TreeItem`\ ) Removes the given child **TreeItem** and all its children from the :ref:`Tree`. Note that it doesn't free the item from memory, so it can be reused later (see :ref:`add_child`). To completely remove a **TreeItem** use :ref:`Object.free`. @@ -1198,7 +1198,7 @@ Removes the given child **TreeItem** and all its children from the :ref:`Tree` column **)** +|void| **select**\ (\ column\: :ref:`int`\ ) Selects the given ``column``. @@ -1210,7 +1210,7 @@ Selects the given ``column``. .. rst-class:: classref-method -void **set_autowrap_mode** **(** :ref:`int` column, :ref:`AutowrapMode` autowrap_mode **)** +|void| **set_autowrap_mode**\ (\ column\: :ref:`int`, autowrap_mode\: :ref:`AutowrapMode`\ ) Sets the autowrap mode in the given ``column``. If set to something other than :ref:`TextServer.AUTOWRAP_OFF`, the text gets wrapped inside the cell's bounding rectangle. @@ -1222,7 +1222,7 @@ Sets the autowrap mode in the given ``column``. If set to something other than : .. rst-class:: classref-method -void **set_button** **(** :ref:`int` column, :ref:`int` button_index, :ref:`Texture2D` button **)** +|void| **set_button**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, button\: :ref:`Texture2D`\ ) Sets the given column's button :ref:`Texture2D` at index ``button_index`` to ``button``. @@ -1234,7 +1234,7 @@ Sets the given column's button :ref:`Texture2D` at index ``butt .. rst-class:: classref-method -void **set_button_color** **(** :ref:`int` column, :ref:`int` button_index, :ref:`Color` color **)** +|void| **set_button_color**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, color\: :ref:`Color`\ ) Sets the given column's button color at index ``button_index`` to ``color``. @@ -1246,7 +1246,7 @@ Sets the given column's button color at index ``button_index`` to ``color``. .. rst-class:: classref-method -void **set_button_disabled** **(** :ref:`int` column, :ref:`int` button_index, :ref:`bool` disabled **)** +|void| **set_button_disabled**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, disabled\: :ref:`bool`\ ) If ``true``, disables the button at index ``button_index`` in the given ``column``. @@ -1258,7 +1258,7 @@ If ``true``, disables the button at index ``button_index`` in the given ``column .. rst-class:: classref-method -void **set_button_tooltip_text** **(** :ref:`int` column, :ref:`int` button_index, :ref:`String` tooltip **)** +|void| **set_button_tooltip_text**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, tooltip\: :ref:`String`\ ) Sets the tooltip text for the button at index ``button_index`` in the given ``column``. @@ -1270,7 +1270,7 @@ Sets the tooltip text for the button at index ``button_index`` in the given ``co .. rst-class:: classref-method -void **set_cell_mode** **(** :ref:`int` column, :ref:`TreeCellMode` mode **)** +|void| **set_cell_mode**\ (\ column\: :ref:`int`, mode\: :ref:`TreeCellMode`\ ) Sets the given column's cell mode to ``mode``. See :ref:`TreeCellMode` constants. @@ -1282,7 +1282,7 @@ Sets the given column's cell mode to ``mode``. See :ref:`TreeCellMode` column, :ref:`bool` checked **)** +|void| **set_checked**\ (\ column\: :ref:`int`, checked\: :ref:`bool`\ ) If ``checked`` is ``true``, the given ``column`` is checked. Clears column's indeterminate status. @@ -1294,7 +1294,7 @@ If ``checked`` is ``true``, the given ``column`` is checked. Clears column's ind .. rst-class:: classref-method -void **set_collapsed_recursive** **(** :ref:`bool` enable **)** +|void| **set_collapsed_recursive**\ (\ enable\: :ref:`bool`\ ) Collapses or uncollapses this **TreeItem** and all the descendants of this item. @@ -1306,7 +1306,7 @@ Collapses or uncollapses this **TreeItem** and all the descendants of this item. .. rst-class:: classref-method -void **set_custom_as_button** **(** :ref:`int` column, :ref:`bool` enable **)** +|void| **set_custom_as_button**\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) .. container:: contribute @@ -1320,7 +1320,7 @@ void **set_custom_as_button** **(** :ref:`int` column, :ref:`bool` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** +|void| **set_custom_bg_color**\ (\ column\: :ref:`int`, color\: :ref:`Color`, just_outline\: :ref:`bool` = false\ ) Sets the given column's custom background color and whether to just use it as an outline. @@ -1332,7 +1332,7 @@ Sets the given column's custom background color and whether to just use it as an .. rst-class:: classref-method -void **set_custom_color** **(** :ref:`int` column, :ref:`Color` color **)** +|void| **set_custom_color**\ (\ column\: :ref:`int`, color\: :ref:`Color`\ ) Sets the given column's custom color. @@ -1344,13 +1344,13 @@ Sets the given column's custom color. .. rst-class:: classref-method -void **set_custom_draw** **(** :ref:`int` column, :ref:`Object` object, :ref:`StringName` callback **)** +|void| **set_custom_draw**\ (\ column\: :ref:`int`, object\: :ref:`Object`, callback\: :ref:`StringName`\ ) **Deprecated:** Use :ref:`set_custom_draw_callback` instead. -Sets the given column's custom draw callback to ``callback`` method on ``object``. +Sets the given column's custom draw callback to the ``callback`` method on ``object``. -The ``callback`` should accept two arguments: the **TreeItem** that is drawn and its position and size as a :ref:`Rect2`. +The method named ``callback`` should accept two arguments: the **TreeItem** that is drawn and its position and size as a :ref:`Rect2`. .. rst-class:: classref-item-separator @@ -1360,7 +1360,7 @@ The ``callback`` should accept two arguments: the **TreeItem** that is drawn and .. rst-class:: classref-method -void **set_custom_draw_callback** **(** :ref:`int` column, :ref:`Callable` callback **)** +|void| **set_custom_draw_callback**\ (\ column\: :ref:`int`, callback\: :ref:`Callable`\ ) Sets the given column's custom draw callback. Use an empty :ref:`Callable` (``Callable()``) to clear the custom callback. @@ -1374,7 +1374,7 @@ The ``callback`` should accept two arguments: the **TreeItem** that is drawn and .. rst-class:: classref-method -void **set_custom_font** **(** :ref:`int` column, :ref:`Font` font **)** +|void| **set_custom_font**\ (\ column\: :ref:`int`, font\: :ref:`Font`\ ) Sets custom font used to draw text in the given ``column``. @@ -1386,7 +1386,7 @@ Sets custom font used to draw text in the given ``column``. .. rst-class:: classref-method -void **set_custom_font_size** **(** :ref:`int` column, :ref:`int` font_size **)** +|void| **set_custom_font_size**\ (\ column\: :ref:`int`, font_size\: :ref:`int`\ ) Sets custom font size used to draw text in the given ``column``. @@ -1398,7 +1398,7 @@ Sets custom font size used to draw text in the given ``column``. .. rst-class:: classref-method -void **set_edit_multiline** **(** :ref:`int` column, :ref:`bool` multiline **)** +|void| **set_edit_multiline**\ (\ column\: :ref:`int`, multiline\: :ref:`bool`\ ) If ``multiline`` is ``true``, the given ``column`` is multiline editable. @@ -1412,7 +1412,7 @@ If ``multiline`` is ``true``, the given ``column`` is multiline editable. .. rst-class:: classref-method -void **set_editable** **(** :ref:`int` column, :ref:`bool` enabled **)** +|void| **set_editable**\ (\ column\: :ref:`int`, enabled\: :ref:`bool`\ ) If ``enabled`` is ``true``, the given ``column`` is editable. @@ -1424,7 +1424,7 @@ If ``enabled`` is ``true``, the given ``column`` is editable. .. rst-class:: classref-method -void **set_expand_right** **(** :ref:`int` column, :ref:`bool` enable **)** +|void| **set_expand_right**\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) If ``enable`` is ``true``, the given ``column`` is expanded to the right. @@ -1436,7 +1436,7 @@ If ``enable`` is ``true``, the given ``column`` is expanded to the right. .. rst-class:: classref-method -void **set_icon** **(** :ref:`int` column, :ref:`Texture2D` texture **)** +|void| **set_icon**\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) Sets the given column's icon :ref:`Texture2D`. @@ -1448,7 +1448,7 @@ Sets the given column's icon :ref:`Texture2D`. .. rst-class:: classref-method -void **set_icon_max_width** **(** :ref:`int` column, :ref:`int` width **)** +|void| **set_icon_max_width**\ (\ column\: :ref:`int`, width\: :ref:`int`\ ) Sets the maximum allowed width of the icon in the given ``column``. This limit is applied on top of the default size of the icon and on top of :ref:`Tree.icon_max_width`. The height is adjusted according to the icon's ratio. @@ -1460,7 +1460,7 @@ Sets the maximum allowed width of the icon in the given ``column``. This limit i .. rst-class:: classref-method -void **set_icon_modulate** **(** :ref:`int` column, :ref:`Color` modulate **)** +|void| **set_icon_modulate**\ (\ column\: :ref:`int`, modulate\: :ref:`Color`\ ) Modulates the given column's icon with ``modulate``. @@ -1472,7 +1472,7 @@ Modulates the given column's icon with ``modulate``. .. rst-class:: classref-method -void **set_icon_region** **(** :ref:`int` column, :ref:`Rect2` region **)** +|void| **set_icon_region**\ (\ column\: :ref:`int`, region\: :ref:`Rect2`\ ) Sets the given column's icon's texture region. @@ -1484,7 +1484,7 @@ Sets the given column's icon's texture region. .. rst-class:: classref-method -void **set_indeterminate** **(** :ref:`int` column, :ref:`bool` indeterminate **)** +|void| **set_indeterminate**\ (\ column\: :ref:`int`, indeterminate\: :ref:`bool`\ ) If ``indeterminate`` is ``true``, the given ``column`` is marked indeterminate. @@ -1498,7 +1498,7 @@ If ``indeterminate`` is ``true``, the given ``column`` is marked indeterminate. .. rst-class:: classref-method -void **set_language** **(** :ref:`int` column, :ref:`String` language **)** +|void| **set_language**\ (\ column\: :ref:`int`, language\: :ref:`String`\ ) Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -1510,7 +1510,7 @@ Sets language code of item's text used for line-breaking and text shaping algori .. rst-class:: classref-method -void **set_metadata** **(** :ref:`int` column, :ref:`Variant` meta **)** +|void| **set_metadata**\ (\ column\: :ref:`int`, meta\: :ref:`Variant`\ ) Sets the metadata value for the given column, which can be retrieved later using :ref:`get_metadata`. This can be used, for example, to store a reference to the original data. @@ -1522,7 +1522,7 @@ Sets the metadata value for the given column, which can be retrieved later using .. rst-class:: classref-method -void **set_range** **(** :ref:`int` column, :ref:`float` value **)** +|void| **set_range**\ (\ column\: :ref:`int`, value\: :ref:`float`\ ) Sets the value of a :ref:`CELL_MODE_RANGE` column. @@ -1534,7 +1534,7 @@ Sets the value of a :ref:`CELL_MODE_RANGE` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** +|void| **set_range_config**\ (\ column\: :ref:`int`, min\: :ref:`float`, max\: :ref:`float`, step\: :ref:`float`, expr\: :ref:`bool` = false\ ) Sets the range of accepted values for a column. The column must be in the :ref:`CELL_MODE_RANGE` mode. @@ -1548,7 +1548,7 @@ If ``expr`` is ``true``, the edit mode slider will use an exponential scale as w .. rst-class:: classref-method -void **set_selectable** **(** :ref:`int` column, :ref:`bool` selectable **)** +|void| **set_selectable**\ (\ column\: :ref:`int`, selectable\: :ref:`bool`\ ) If ``selectable`` is ``true``, the given ``column`` is selectable. @@ -1560,7 +1560,7 @@ If ``selectable`` is ``true``, the given ``column`` is selectable. .. rst-class:: classref-method -void **set_structured_text_bidi_override** **(** :ref:`int` column, :ref:`StructuredTextParser` parser **)** +|void| **set_structured_text_bidi_override**\ (\ column\: :ref:`int`, parser\: :ref:`StructuredTextParser`\ ) .. container:: contribute @@ -1574,7 +1574,7 @@ void **set_structured_text_bidi_override** **(** :ref:`int` column, : .. rst-class:: classref-method -void **set_structured_text_bidi_override_options** **(** :ref:`int` column, :ref:`Array` args **)** +|void| **set_structured_text_bidi_override_options**\ (\ column\: :ref:`int`, args\: :ref:`Array`\ ) .. container:: contribute @@ -1588,7 +1588,7 @@ void **set_structured_text_bidi_override_options** **(** :ref:`int` c .. rst-class:: classref-method -void **set_suffix** **(** :ref:`int` column, :ref:`String` text **)** +|void| **set_suffix**\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) Sets a string to be shown after a column's value (for example, a unit abbreviation). @@ -1600,7 +1600,7 @@ Sets a string to be shown after a column's value (for example, a unit abbreviati .. rst-class:: classref-method -void **set_text** **(** :ref:`int` column, :ref:`String` text **)** +|void| **set_text**\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) Sets the given column's text value. @@ -1612,7 +1612,7 @@ Sets the given column's text value. .. rst-class:: classref-method -void **set_text_alignment** **(** :ref:`int` column, :ref:`HorizontalAlignment` text_alignment **)** +|void| **set_text_alignment**\ (\ column\: :ref:`int`, text_alignment\: :ref:`HorizontalAlignment`\ ) Sets the given column's text alignment. See :ref:`HorizontalAlignment` for possible values. @@ -1624,7 +1624,7 @@ Sets the given column's text alignment. See :ref:`HorizontalAlignment` column, :ref:`TextDirection` direction **)** +|void| **set_text_direction**\ (\ column\: :ref:`int`, direction\: :ref:`TextDirection`\ ) Sets item's text base writing direction. @@ -1636,7 +1636,7 @@ Sets item's text base writing direction. .. rst-class:: classref-method -void **set_text_overrun_behavior** **(** :ref:`int` column, :ref:`OverrunBehavior` overrun_behavior **)** +|void| **set_text_overrun_behavior**\ (\ column\: :ref:`int`, overrun_behavior\: :ref:`OverrunBehavior`\ ) Sets the clipping behavior when the text exceeds the item's bounding rectangle in the given ``column``. @@ -1648,7 +1648,7 @@ Sets the clipping behavior when the text exceeds the item's bounding rectangle i .. rst-class:: classref-method -void **set_tooltip_text** **(** :ref:`int` column, :ref:`String` tooltip **)** +|void| **set_tooltip_text**\ (\ column\: :ref:`int`, tooltip\: :ref:`String`\ ) Sets the given column's tooltip text. @@ -1660,7 +1660,7 @@ Sets the given column's tooltip text. .. rst-class:: classref-method -void **uncollapse_tree** **(** **)** +|void| **uncollapse_tree**\ (\ ) Uncollapses all **TreeItem**\ s necessary to reveal this **TreeItem**, i.e. all ancestor **TreeItem**\ s. @@ -1671,3 +1671,4 @@ Uncollapses all **TreeItem**\ s necessary to reveal this **TreeItem**, i.e. all .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_trianglemesh.rst b/classes/class_trianglemesh.rst index 0c8228f9a1a..3b6844f6399 100644 --- a/classes/class_trianglemesh.rst +++ b/classes/class_trianglemesh.rst @@ -28,3 +28,4 @@ Mesh type used internally for collision calculations. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_tubetrailmesh.rst b/classes/class_tubetrailmesh.rst index 4adc96da0ca..86aa24b08a4 100644 --- a/classes/class_tubetrailmesh.rst +++ b/classes/class_tubetrailmesh.rst @@ -75,8 +75,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_cap_bottom** **(** :ref:`bool` value **)** -- :ref:`bool` **is_cap_bottom** **(** **)** +- |void| **set_cap_bottom**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_cap_bottom**\ (\ ) If ``true``, generates a cap at the bottom of the tube. This can be set to ``false`` to speed up generation and rendering when the cap is never seen by the camera. @@ -92,8 +92,8 @@ If ``true``, generates a cap at the bottom of the tube. This can be set to ``fal .. rst-class:: classref-property-setget -- void **set_cap_top** **(** :ref:`bool` value **)** -- :ref:`bool` **is_cap_top** **(** **)** +- |void| **set_cap_top**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_cap_top**\ (\ ) If ``true``, generates a cap at the top of the tube. This can be set to ``false`` to speed up generation and rendering when the cap is never seen by the camera. @@ -109,8 +109,8 @@ If ``true``, generates a cap at the top of the tube. This can be set to ``false` .. rst-class:: classref-property-setget -- void **set_curve** **(** :ref:`Curve` value **)** -- :ref:`Curve` **get_curve** **(** **)** +- |void| **set_curve**\ (\ value\: :ref:`Curve`\ ) +- :ref:`Curve` **get_curve**\ (\ ) Determines the radius of the tube along its length. The radius of a particular section ring is obtained by multiplying the baseline :ref:`radius` by the value of this curve at the given distance. For values smaller than ``0``, the faces will be inverted. @@ -126,8 +126,8 @@ Determines the radius of the tube along its length. The radius of a particular s .. rst-class:: classref-property-setget -- void **set_radial_steps** **(** :ref:`int` value **)** -- :ref:`int` **get_radial_steps** **(** **)** +- |void| **set_radial_steps**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_radial_steps**\ (\ ) The number of sides on the tube. For example, a value of ``5`` means the tube will be pentagonal. Higher values result in a more detailed tube at the cost of performance. @@ -143,8 +143,8 @@ The number of sides on the tube. For example, a value of ``5`` means the tube wi .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) The baseline radius of the tube. The radius of a particular section ring is obtained by multiplying this radius by the value of the :ref:`curve` at the given distance. @@ -160,8 +160,8 @@ The baseline radius of the tube. The radius of a particular section ring is obta .. rst-class:: classref-property-setget -- void **set_section_length** **(** :ref:`float` value **)** -- :ref:`float` **get_section_length** **(** **)** +- |void| **set_section_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_section_length**\ (\ ) The length of a section of the tube. @@ -177,8 +177,8 @@ The length of a section of the tube. .. rst-class:: classref-property-setget -- void **set_section_rings** **(** :ref:`int` value **)** -- :ref:`int` **get_section_rings** **(** **)** +- |void| **set_section_rings**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_section_rings**\ (\ ) The number of rings in a section. The :ref:`curve` is sampled on each ring to determine its radius. Higher values result in a more detailed tube at the cost of performance. @@ -194,8 +194,8 @@ The number of rings in a section. The :ref:`curve` value **)** -- :ref:`int` **get_sections** **(** **)** +- |void| **set_sections**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_sections**\ (\ ) The total number of sections on the tube. @@ -206,3 +206,4 @@ The total number of sections on the tube. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_tween.rst b/classes/class_tween.rst index 05d207e046e..5ee13ac0d99 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -153,55 +153,55 @@ Methods .. table:: :widths: auto - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Tween` | :ref:`bind_node` **(** :ref:`Node` node **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Tween` | :ref:`chain` **(** **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`custom_step` **(** :ref:`float` delta **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_loops_left` **(** **)** |const| | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_total_elapsed_time` **(** **)** |const| | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`interpolate_value` **(** :ref:`Variant` initial_value, :ref:`Variant` delta_value, :ref:`float` elapsed_time, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type **)** |static| | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_running` **(** **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid` **(** **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`kill` **(** **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Tween` | :ref:`parallel` **(** **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`pause` **(** **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`play` **(** **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Tween` | :ref:`set_ease` **(** :ref:`EaseType` ease **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Tween` | :ref:`set_loops` **(** :ref:`int` loops=0 **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Tween` | :ref:`set_parallel` **(** :ref:`bool` parallel=true **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Tween` | :ref:`set_pause_mode` **(** :ref:`TweenPauseMode` mode **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Tween` | :ref:`set_process_mode` **(** :ref:`TweenProcessMode` mode **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Tween` | :ref:`set_speed_scale` **(** :ref:`float` speed **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Tween` | :ref:`set_trans` **(** :ref:`TransitionType` trans **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`stop` **(** **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`CallbackTweener` | :ref:`tween_callback` **(** :ref:`Callable` callback **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`IntervalTweener` | :ref:`tween_interval` **(** :ref:`float` time **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`MethodTweener` | :ref:`tween_method` **(** :ref:`Callable` method, :ref:`Variant` from, :ref:`Variant` to, :ref:`float` duration **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PropertyTweener` | :ref:`tween_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` final_val, :ref:`float` duration **)** | - +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Tween` | :ref:`bind_node`\ (\ node\: :ref:`Node`\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Tween` | :ref:`chain`\ (\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`custom_step`\ (\ delta\: :ref:`float`\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_loops_left`\ (\ ) |const| | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_total_elapsed_time`\ (\ ) |const| | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`interpolate_value`\ (\ initial_value\: :ref:`Variant`, delta_value\: :ref:`Variant`, elapsed_time\: :ref:`float`, duration\: :ref:`float`, trans_type\: :ref:`TransitionType`, ease_type\: :ref:`EaseType`\ ) |static| | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_running`\ (\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid`\ (\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`kill`\ (\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Tween` | :ref:`parallel`\ (\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`pause`\ (\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`play`\ (\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Tween` | :ref:`set_ease`\ (\ ease\: :ref:`EaseType`\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Tween` | :ref:`set_loops`\ (\ loops\: :ref:`int` = 0\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Tween` | :ref:`set_parallel`\ (\ parallel\: :ref:`bool` = true\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Tween` | :ref:`set_pause_mode`\ (\ mode\: :ref:`TweenPauseMode`\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Tween` | :ref:`set_process_mode`\ (\ mode\: :ref:`TweenProcessMode`\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Tween` | :ref:`set_speed_scale`\ (\ speed\: :ref:`float`\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Tween` | :ref:`set_trans`\ (\ trans\: :ref:`TransitionType`\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop`\ (\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CallbackTweener` | :ref:`tween_callback`\ (\ callback\: :ref:`Callable`\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`IntervalTweener` | :ref:`tween_interval`\ (\ time\: :ref:`float`\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`MethodTweener` | :ref:`tween_method`\ (\ method\: :ref:`Callable`, from\: :ref:`Variant`, to\: :ref:`Variant`, duration\: :ref:`float`\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PropertyTweener` | :ref:`tween_property`\ (\ object\: :ref:`Object`, property\: :ref:`NodePath`, final_val\: :ref:`Variant`, duration\: :ref:`float`\ ) | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -216,7 +216,7 @@ Signals .. rst-class:: classref-signal -**finished** **(** **)** +**finished**\ (\ ) Emitted when the **Tween** has finished all tweening. Never emitted when the **Tween** is set to infinite looping (see :ref:`set_loops`). @@ -228,7 +228,7 @@ Emitted when the **Tween** has finished all tweening. Never emitted when the **T .. rst-class:: classref-signal -**loop_finished** **(** :ref:`int` loop_count **)** +**loop_finished**\ (\ loop_count\: :ref:`int`\ ) Emitted when a full loop is complete (see :ref:`set_loops`), providing the loop index. This signal is not emitted after the final loop, use :ref:`finished` instead for this case. @@ -240,7 +240,7 @@ Emitted when a full loop is complete (see :ref:`set_loops` idx **)** +**step_finished**\ (\ idx\: :ref:`int`\ ) Emitted when one step of the **Tween** is complete, providing the step index. One step is either a single :ref:`Tweener` or a group of :ref:`Tweener`\ s running in parallel. @@ -470,7 +470,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Tween` **bind_node** **(** :ref:`Node` node **)** +:ref:`Tween` **bind_node**\ (\ node\: :ref:`Node`\ ) Binds this **Tween** with the given ``node``. **Tween**\ s are processed directly by the :ref:`SceneTree`, so they run independently of the animated nodes. When you bind a :ref:`Node` with the **Tween**, the **Tween** will halt the animation when the object is not inside tree and the **Tween** will be automatically killed when the bound object is freed. Also :ref:`TWEEN_PAUSE_BOUND` will make the pausing behavior dependent on the bound node. @@ -484,7 +484,7 @@ For a shorter way to create and bind a **Tween**, you can use :ref:`Node.create_ .. rst-class:: classref-method -:ref:`Tween` **chain** **(** **)** +:ref:`Tween` **chain**\ (\ ) Used to chain two :ref:`Tweener`\ s after :ref:`set_parallel` is called with ``true``. @@ -515,7 +515,7 @@ Used to chain two :ref:`Tweener`\ s after :ref:`set_parallel` **custom_step** **(** :ref:`float` delta **)** +:ref:`bool` **custom_step**\ (\ delta\: :ref:`float`\ ) Processes the **Tween** by the given ``delta`` value, in seconds. This is mostly useful for manual control when the **Tween** is paused. It can also be used to end the **Tween** animation immediately, by setting ``delta`` longer than the whole duration of the **Tween** animation. @@ -529,7 +529,7 @@ Returns ``true`` if the **Tween** still has :ref:`Tweener`\ s tha .. rst-class:: classref-method -:ref:`int` **get_loops_left** **(** **)** |const| +:ref:`int` **get_loops_left**\ (\ ) |const| Returns the number of remaining loops for this **Tween** (see :ref:`set_loops`). A return value of ``-1`` indicates an infinitely looping **Tween**, and a return value of ``0`` indicates that the **Tween** has already finished. @@ -541,7 +541,7 @@ Returns the number of remaining loops for this **Tween** (see :ref:`set_loops` **get_total_elapsed_time** **(** **)** |const| +:ref:`float` **get_total_elapsed_time**\ (\ ) |const| Returns the total time in seconds the **Tween** has been animating (i.e. the time since it started, not counting pauses etc.). The time is affected by :ref:`set_speed_scale`, and :ref:`stop` will reset it to ``0``. @@ -555,7 +555,7 @@ Returns the total time in seconds the **Tween** has been animating (i.e. the tim .. rst-class:: classref-method -:ref:`Variant` **interpolate_value** **(** :ref:`Variant` initial_value, :ref:`Variant` delta_value, :ref:`float` elapsed_time, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type **)** |static| +:ref:`Variant` **interpolate_value**\ (\ initial_value\: :ref:`Variant`, delta_value\: :ref:`Variant`, elapsed_time\: :ref:`float`, duration\: :ref:`float`, trans_type\: :ref:`TransitionType`, ease_type\: :ref:`EaseType`\ ) |static| This method can be used for manual interpolation of a value, when you don't want **Tween** to do animating for you. It's similar to :ref:`@GlobalScope.lerp`, but with support for custom transition and easing. @@ -577,7 +577,7 @@ This method can be used for manual interpolation of a value, when you don't want .. rst-class:: classref-method -:ref:`bool` **is_running** **(** **)** +:ref:`bool` **is_running**\ (\ ) Returns whether the **Tween** is currently running, i.e. it wasn't paused and it's not finished. @@ -589,7 +589,7 @@ Returns whether the **Tween** is currently running, i.e. it wasn't paused and it .. rst-class:: classref-method -:ref:`bool` **is_valid** **(** **)** +:ref:`bool` **is_valid**\ (\ ) Returns whether the **Tween** is valid. A valid **Tween** is a **Tween** contained by the scene tree (i.e. the array from :ref:`SceneTree.get_processed_tweens` will contain this **Tween**). A **Tween** might become invalid when it has finished tweening, is killed, or when created with ``Tween.new()``. Invalid **Tween**\ s can't have :ref:`Tweener`\ s appended. @@ -601,7 +601,7 @@ Returns whether the **Tween** is valid. A valid **Tween** is a **Tween** contain .. rst-class:: classref-method -void **kill** **(** **)** +|void| **kill**\ (\ ) Aborts all tweening operations and invalidates the **Tween**. @@ -613,7 +613,7 @@ Aborts all tweening operations and invalidates the **Tween**. .. rst-class:: classref-method -:ref:`Tween` **parallel** **(** **)** +:ref:`Tween` **parallel**\ (\ ) Makes the next :ref:`Tweener` run parallelly to the previous one. @@ -650,7 +650,7 @@ You can make the **Tween** parallel by default by using :ref:`set_parallel`. @@ -664,7 +664,7 @@ Pauses the tweening. The animation can be resumed by using :ref:`play` **set_ease** **(** :ref:`EaseType` ease **)** +:ref:`Tween` **set_ease**\ (\ ease\: :ref:`EaseType`\ ) Sets the default ease type for :ref:`PropertyTweener`\ s and :ref:`MethodTweener`\ s animated by this **Tween**. @@ -690,7 +690,7 @@ If not specified, the default value is :ref:`EASE_IN_OUT` **set_loops** **(** :ref:`int` loops=0 **)** +:ref:`Tween` **set_loops**\ (\ loops\: :ref:`int` = 0\ ) Sets the number of times the tweening sequence will be repeated, i.e. ``set_loops(2)`` will run the animation twice. @@ -706,10 +706,18 @@ Calling this method without arguments will make the **Tween** run infinitely, un .. rst-class:: classref-method -:ref:`Tween` **set_parallel** **(** :ref:`bool` parallel=true **)** +:ref:`Tween` **set_parallel**\ (\ parallel\: :ref:`bool` = true\ ) If ``parallel`` is ``true``, the :ref:`Tweener`\ s appended after this method will by default run simultaneously, as opposed to sequentially. +\ **Note:** Just like with :ref:`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 ---- @@ -718,7 +726,7 @@ If ``parallel`` is ``true``, the :ref:`Tweener`\ s appended after .. rst-class:: classref-method -:ref:`Tween` **set_pause_mode** **(** :ref:`TweenPauseMode` mode **)** +:ref:`Tween` **set_pause_mode**\ (\ mode\: :ref:`TweenPauseMode`\ ) Determines the behavior of the **Tween** when the :ref:`SceneTree` is paused. Check :ref:`TweenPauseMode` for options. @@ -732,7 +740,7 @@ Default value is :ref:`TWEEN_PAUSE_BOUND .. rst-class:: classref-method -:ref:`Tween` **set_process_mode** **(** :ref:`TweenProcessMode` mode **)** +:ref:`Tween` **set_process_mode**\ (\ mode\: :ref:`TweenProcessMode`\ ) Determines whether the **Tween** should run after process frames (see :ref:`Node._process`) or physics frames (see :ref:`Node._physics_process`). @@ -746,7 +754,7 @@ Default value is :ref:`TWEEN_PROCESS_IDLE` **set_speed_scale** **(** :ref:`float` speed **)** +:ref:`Tween` **set_speed_scale**\ (\ speed\: :ref:`float`\ ) Scales the speed of tweening. This affects all :ref:`Tweener`\ s and their delays. @@ -758,7 +766,7 @@ Scales the speed of tweening. This affects all :ref:`Tweener`\ s .. rst-class:: classref-method -:ref:`Tween` **set_trans** **(** :ref:`TransitionType` trans **)** +:ref:`Tween` **set_trans**\ (\ trans\: :ref:`TransitionType`\ ) Sets the default transition type for :ref:`PropertyTweener`\ s and :ref:`MethodTweener`\ s animated by this **Tween**. @@ -772,7 +780,7 @@ If not specified, the default value is :ref:`TRANS_LINEAR`\ s. @@ -786,7 +794,7 @@ Stops the tweening and resets the **Tween** to its initial state. This will not .. rst-class:: classref-method -:ref:`CallbackTweener` **tween_callback** **(** :ref:`Callable` callback **)** +:ref:`CallbackTweener` **tween_callback**\ (\ callback\: :ref:`Callable`\ ) Creates and appends a :ref:`CallbackTweener`. This method can be used to call an arbitrary method in any object. Use :ref:`Callable.bind` to bind additional arguments for the call. @@ -835,7 +843,7 @@ Creates and appends a :ref:`CallbackTweener`. This method .. rst-class:: classref-method -:ref:`IntervalTweener` **tween_interval** **(** :ref:`float` time **)** +:ref:`IntervalTweener` **tween_interval**\ (\ time\: :ref:`float`\ ) Creates and appends an :ref:`IntervalTweener`. This method can be used to create delays in the tween animation, as an alternative to using the delay in other :ref:`Tweener`\ s, or when there's no animation (in which case the **Tween** acts as a timer). ``time`` is the length of the interval, in seconds. @@ -893,7 +901,7 @@ Creates and appends an :ref:`IntervalTweener`. This metho .. rst-class:: classref-method -:ref:`MethodTweener` **tween_method** **(** :ref:`Callable` method, :ref:`Variant` from, :ref:`Variant` to, :ref:`float` duration **)** +:ref:`MethodTweener` **tween_method**\ (\ method\: :ref:`Callable`, from\: :ref:`Variant`, to\: :ref:`Variant`, duration\: :ref:`float`\ ) Creates and appends a :ref:`MethodTweener`. This method is similar to a combination of :ref:`tween_callback` and :ref:`tween_property`. It calls a method over time with a tweened value provided as an argument. The value is tweened between ``from`` and ``to`` over the time specified by ``duration``, in seconds. Use :ref:`Callable.bind` to bind additional arguments for the call. You can use :ref:`MethodTweener.set_ease` and :ref:`MethodTweener.set_trans` to tweak the easing and transition of the value or :ref:`MethodTweener.set_delay` to delay the tweening. @@ -953,7 +961,7 @@ Creates and appends a :ref:`MethodTweener`. This method is .. rst-class:: classref-method -:ref:`PropertyTweener` **tween_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` final_val, :ref:`float` duration **)** +:ref:`PropertyTweener` **tween_property**\ (\ object\: :ref:`Object`, property\: :ref:`NodePath`, final_val\: :ref:`Variant`, duration\: :ref:`float`\ ) Creates and appends a :ref:`PropertyTweener`. This method tweens a ``property`` of an ``object`` between an initial value and ``final_val`` in a span of time equal to ``duration``, in seconds. The initial value by default is the property's value at the time the tweening of the :ref:`PropertyTweener` starts. @@ -1006,3 +1014,4 @@ will move the sprite to position (100, 200) and then to (200, 300). If you use : .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_tweener.rst b/classes/class_tweener.rst index 63b7d8cde69..c408da06e5f 100644 --- a/classes/class_tweener.rst +++ b/classes/class_tweener.rst @@ -36,7 +36,7 @@ Signals .. rst-class:: classref-signal -**finished** **(** **)** +**finished**\ (\ ) Emitted when the **Tweener** has just finished its job. @@ -47,3 +47,4 @@ Emitted when the **Tweener** has just finished its job. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_udpserver.rst b/classes/class_udpserver.rst index d49ed5ab6c8..f22f451d8ed 100644 --- a/classes/class_udpserver.rst +++ b/classes/class_udpserver.rst @@ -169,21 +169,21 @@ Methods .. table:: :widths: auto - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_local_port` **(** **)** |const| | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_connection_available` **(** **)** |const| | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_listening` **(** **)** |const| | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*" **)** | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`poll` **(** **)** | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`stop` **(** **)** | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PacketPeerUDP` | :ref:`take_connection` **(** **)** | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_local_port`\ (\ ) |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_connection_available`\ (\ ) |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_listening`\ (\ ) |const| | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`listen`\ (\ port\: :ref:`int`, bind_address\: :ref:`String` = "*"\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`poll`\ (\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop`\ (\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PacketPeerUDP` | :ref:`take_connection`\ (\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -202,8 +202,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_max_pending_connections** **(** :ref:`int` value **)** -- :ref:`int` **get_max_pending_connections** **(** **)** +- |void| **set_max_pending_connections**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_pending_connections**\ (\ ) Define the maximum number of pending connections, during :ref:`poll`, any new pending connection exceeding that value will be automatically dropped. Setting this value to ``0`` effectively prevents any new pending connection to be accepted (e.g. when all your players have connected). @@ -220,7 +220,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **get_local_port** **(** **)** |const| +:ref:`int` **get_local_port**\ (\ ) |const| Returns the local port this server is listening to. @@ -232,7 +232,7 @@ Returns the local port this server is listening to. .. rst-class:: classref-method -:ref:`bool` **is_connection_available** **(** **)** |const| +:ref:`bool` **is_connection_available**\ (\ ) |const| Returns ``true`` if a packet with a new address/port combination was received on the socket. @@ -244,7 +244,7 @@ Returns ``true`` if a packet with a new address/port combination was received on .. rst-class:: classref-method -:ref:`bool` **is_listening** **(** **)** |const| +:ref:`bool` **is_listening**\ (\ ) |const| Returns ``true`` if the socket is open and listening on a port. @@ -256,7 +256,7 @@ Returns ``true`` if the socket is open and listening on a port. .. rst-class:: classref-method -:ref:`Error` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*" **)** +:ref:`Error` **listen**\ (\ port\: :ref:`int`, bind_address\: :ref:`String` = "*"\ ) Starts the server by opening a UDP socket listening on the given ``port``. You can optionally specify a ``bind_address`` to only listen for packets sent to that address. See also :ref:`PacketPeerUDP.bind`. @@ -268,7 +268,7 @@ Starts the server by opening a UDP socket listening on the given ``port``. You c .. rst-class:: classref-method -:ref:`Error` **poll** **(** **)** +:ref:`Error` **poll**\ (\ ) Call this method at regular intervals (e.g. inside :ref:`Node._process`) to process new packets. And packet from known address/port pair will be delivered to the appropriate :ref:`PacketPeerUDP`, any packet received from an unknown address/port pair will be added as a pending connection (see :ref:`is_connection_available`, :ref:`take_connection`). The maximum number of pending connection is defined via :ref:`max_pending_connections`. @@ -280,7 +280,7 @@ Call this method at regular intervals (e.g. inside :ref:`Node._process` accepted via :ref:`take_connection` (remote peers will not be notified). @@ -292,7 +292,7 @@ Stops the server, closing the UDP socket if open. Will close all connected :ref: .. rst-class:: classref-method -:ref:`PacketPeerUDP` **take_connection** **(** **)** +:ref:`PacketPeerUDP` **take_connection**\ (\ ) Returns the first pending connection (connected to the appropriate address/port). Will return ``null`` if no new connection is available. See also :ref:`is_connection_available`, :ref:`PacketPeerUDP.connect_to_host`. @@ -303,3 +303,4 @@ Returns the first pending connection (connected to the appropriate address/port) .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index 8247e9076d4..25d7793f6e1 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -140,49 +140,49 @@ Methods .. table:: :widths: auto - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_do_method` **(** :ref:`Callable` callable **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_do_property` **(** :ref:`Object` object, :ref:`StringName` property, :ref:`Variant` value **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_do_reference` **(** :ref:`Object` object **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_undo_method` **(** :ref:`Callable` callable **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_undo_property` **(** :ref:`Object` object, :ref:`StringName` property, :ref:`Variant` value **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_undo_reference` **(** :ref:`Object` object **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_history` **(** :ref:`bool` increase_version=true **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`commit_action` **(** :ref:`bool` execute=true **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_action` **(** :ref:`String` name, :ref:`MergeMode` merge_mode=0, :ref:`bool` backward_undo_ops=false **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`end_force_keep_in_merge_ends` **(** **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_action_name` **(** :ref:`int` id **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_current_action` **(** **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_current_action_name` **(** **)** |const| | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_history_count` **(** **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_version` **(** **)** |const| | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_redo` **(** **)** |const| | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_undo` **(** **)** |const| | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_committing_action` **(** **)** |const| | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`redo` **(** **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`start_force_keep_in_merge_ends` **(** **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`undo` **(** **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_do_method`\ (\ callable\: :ref:`Callable`\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_do_property`\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_do_reference`\ (\ object\: :ref:`Object`\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_undo_method`\ (\ callable\: :ref:`Callable`\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_undo_property`\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_undo_reference`\ (\ object\: :ref:`Object`\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_history`\ (\ increase_version\: :ref:`bool` = true\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`commit_action`\ (\ execute\: :ref:`bool` = true\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`create_action`\ (\ name\: :ref:`String`, merge_mode\: :ref:`MergeMode` = 0, backward_undo_ops\: :ref:`bool` = false\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`end_force_keep_in_merge_ends`\ (\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_action_name`\ (\ id\: :ref:`int`\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_current_action`\ (\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_current_action_name`\ (\ ) |const| | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_history_count`\ (\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_version`\ (\ ) |const| | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_redo`\ (\ ) |const| | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_undo`\ (\ ) |const| | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_committing_action`\ (\ ) |const| | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`redo`\ (\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`start_force_keep_in_merge_ends`\ (\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`undo`\ (\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -197,7 +197,7 @@ Signals .. rst-class:: classref-signal -**version_changed** **(** **)** +**version_changed**\ (\ ) Called when :ref:`undo` or :ref:`redo` was called. @@ -257,8 +257,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_max_steps** **(** :ref:`int` value **)** -- :ref:`int` **get_max_steps** **(** **)** +- |void| **set_max_steps**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_steps**\ (\ ) The maximum number of steps that can be stored in the undo/redo history. If the number of stored steps exceeds this limit, older steps are removed from history and can no longer be reached by calling :ref:`undo`. A value of ``0`` or lower means no limit. @@ -275,7 +275,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_do_method** **(** :ref:`Callable` callable **)** +|void| **add_do_method**\ (\ callable\: :ref:`Callable`\ ) Register a :ref:`Callable` that will be called when the action is committed. @@ -287,7 +287,7 @@ Register a :ref:`Callable` that will be called when the action i .. rst-class:: classref-method -void **add_do_property** **(** :ref:`Object` object, :ref:`StringName` property, :ref:`Variant` value **)** +|void| **add_do_property**\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) Register a ``property`` that would change its value to ``value`` when the action is committed. @@ -299,7 +299,7 @@ Register a ``property`` that would change its value to ``value`` when the action .. rst-class:: classref-method -void **add_do_reference** **(** :ref:`Object` object **)** +|void| **add_do_reference**\ (\ object\: :ref:`Object`\ ) Register a reference for "do" that will be erased if the "do" history is lost. This is useful mostly for new nodes created for the "do" call. Do not use for resources. @@ -320,7 +320,7 @@ Register a reference for "do" that will be erased if the "do" history is lost. T .. rst-class:: classref-method -void **add_undo_method** **(** :ref:`Callable` callable **)** +|void| **add_undo_method**\ (\ callable\: :ref:`Callable`\ ) Register a :ref:`Callable` that will be called when the action is undone. @@ -332,7 +332,7 @@ Register a :ref:`Callable` that will be called when the action i .. rst-class:: classref-method -void **add_undo_property** **(** :ref:`Object` object, :ref:`StringName` property, :ref:`Variant` value **)** +|void| **add_undo_property**\ (\ object\: :ref:`Object`, property\: :ref:`StringName`, value\: :ref:`Variant`\ ) Register a ``property`` that would change its value to ``value`` when the action is undone. @@ -344,7 +344,7 @@ Register a ``property`` that would change its value to ``value`` when the action .. rst-class:: classref-method -void **add_undo_reference** **(** :ref:`Object` object **)** +|void| **add_undo_reference**\ (\ object\: :ref:`Object`\ ) Register a reference for "undo" that will be erased if the "undo" history is lost. This is useful mostly for nodes removed with the "do" call (not the "undo" call!). @@ -365,7 +365,7 @@ Register a reference for "undo" that will be erased if the "undo" history is los .. rst-class:: classref-method -void **clear_history** **(** :ref:`bool` increase_version=true **)** +|void| **clear_history**\ (\ increase_version\: :ref:`bool` = true\ ) Clear the undo/redo history and associated references. @@ -379,7 +379,7 @@ Passing ``false`` to ``increase_version`` will prevent the version number from i .. rst-class:: classref-method -void **commit_action** **(** :ref:`bool` execute=true **)** +|void| **commit_action**\ (\ execute\: :ref:`bool` = true\ ) Commit the action. If ``execute`` is ``true`` (which it is by default), all "do" methods/properties are called/set when this function is called. @@ -391,7 +391,7 @@ Commit the action. If ``execute`` is ``true`` (which it is by default), all "do" .. rst-class:: classref-method -void **create_action** **(** :ref:`String` name, :ref:`MergeMode` merge_mode=0, :ref:`bool` backward_undo_ops=false **)** +|void| **create_action**\ (\ name\: :ref:`String`, merge_mode\: :ref:`MergeMode` = 0, backward_undo_ops\: :ref:`bool` = false\ ) Create a new action. After this is called, do all your calls to :ref:`add_do_method`, :ref:`add_undo_method`, :ref:`add_do_property`, and :ref:`add_undo_property`, then commit the action with :ref:`commit_action`. @@ -407,7 +407,7 @@ The way undo operation are ordered in actions is dictated by ``backward_undo_ops .. rst-class:: classref-method -void **end_force_keep_in_merge_ends** **(** **)** +|void| **end_force_keep_in_merge_ends**\ (\ ) Stops marking operations as to be processed even if the action gets merged with another in the :ref:`MERGE_ENDS` mode. See :ref:`start_force_keep_in_merge_ends`. @@ -419,7 +419,7 @@ Stops marking operations as to be processed even if the action gets merged with .. rst-class:: classref-method -:ref:`String` **get_action_name** **(** :ref:`int` id **)** +:ref:`String` **get_action_name**\ (\ id\: :ref:`int`\ ) Gets the action name from its index. @@ -431,7 +431,7 @@ Gets the action name from its index. .. rst-class:: classref-method -:ref:`int` **get_current_action** **(** **)** +:ref:`int` **get_current_action**\ (\ ) Gets the index of the current action. @@ -443,7 +443,7 @@ Gets the index of the current action. .. rst-class:: classref-method -:ref:`String` **get_current_action_name** **(** **)** |const| +:ref:`String` **get_current_action_name**\ (\ ) |const| Gets the name of the current action, equivalent to ``get_action_name(get_current_action())``. @@ -455,7 +455,7 @@ Gets the name of the current action, equivalent to ``get_action_name(get_current .. rst-class:: classref-method -:ref:`int` **get_history_count** **(** **)** +:ref:`int` **get_history_count**\ (\ ) Returns how many elements are in the history. @@ -467,7 +467,7 @@ Returns how many elements are in the history. .. rst-class:: classref-method -:ref:`int` **get_version** **(** **)** |const| +:ref:`int` **get_version**\ (\ ) |const| Gets the version. Every time a new action is committed, the **UndoRedo**'s version number is increased automatically. @@ -481,7 +481,7 @@ This is useful mostly to check if something changed from a saved version. .. rst-class:: classref-method -:ref:`bool` **has_redo** **(** **)** |const| +:ref:`bool` **has_redo**\ (\ ) |const| Returns ``true`` if a "redo" action is available. @@ -493,7 +493,7 @@ Returns ``true`` if a "redo" action is available. .. rst-class:: classref-method -:ref:`bool` **has_undo** **(** **)** |const| +:ref:`bool` **has_undo**\ (\ ) |const| Returns ``true`` if an "undo" action is available. @@ -505,7 +505,7 @@ Returns ``true`` if an "undo" action is available. .. rst-class:: classref-method -:ref:`bool` **is_committing_action** **(** **)** |const| +:ref:`bool` **is_committing_action**\ (\ ) |const| Returns ``true`` if the **UndoRedo** is currently committing the action, i.e. running its "do" method or property change (see :ref:`commit_action`). @@ -517,7 +517,7 @@ Returns ``true`` if the **UndoRedo** is currently committing the action, i.e. ru .. rst-class:: classref-method -:ref:`bool` **redo** **(** **)** +:ref:`bool` **redo**\ (\ ) Redo the last action. @@ -529,7 +529,7 @@ Redo the last action. .. rst-class:: classref-method -void **start_force_keep_in_merge_ends** **(** **)** +|void| **start_force_keep_in_merge_ends**\ (\ ) Marks the next "do" and "undo" operations to be processed even if the action gets merged with another in the :ref:`MERGE_ENDS` mode. Return to normal operation using :ref:`end_force_keep_in_merge_ends`. @@ -541,7 +541,7 @@ Marks the next "do" and "undo" operations to be processed even if the action get .. rst-class:: classref-method -:ref:`bool` **undo** **(** **)** +:ref:`bool` **undo**\ (\ ) Undo the last action. @@ -552,3 +552,4 @@ Undo the last action. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_uniformsetcacherd.rst b/classes/class_uniformsetcacherd.rst new file mode 100644 index 00000000000..07b0eb41a94 --- /dev/null +++ b/classes/class_uniformsetcacherd.rst @@ -0,0 +1,60 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/UniformSetCacheRD.xml. + +.. _class_UniformSetCacheRD: + +UniformSetCacheRD +================= + +**Inherits:** :ref:`Object` + +Uniform set cache manager for Rendering Device based renderers. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Uniform set cache manager for Rendering Device based renderers. Provides a way to create a uniform set and reuse it in subsequent calls for as long as the uniform set exists. Uniform set will automatically be cleaned up when dependent objects are freed. + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_cache`\ (\ shader\: :ref:`RID`, set\: :ref:`int`, uniforms\: :ref:`Array`\[:ref:`RDUniform`\]\ ) |static| | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_UniformSetCacheRD_method_get_cache: + +.. rst-class:: classref-method + +:ref:`RID` **get_cache**\ (\ shader\: :ref:`RID`, set\: :ref:`int`, uniforms\: :ref:`Array`\[:ref:`RDUniform`\]\ ) |static| + +Creates/returns a cached uniform set based on the provided uniforms for a given shader. + +.. |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.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_upnp.rst b/classes/class_upnp.rst index edfc61c1e09..1e4cc837f69 100644 --- a/classes/class_upnp.rst +++ b/classes/class_upnp.rst @@ -109,29 +109,29 @@ Methods .. table:: :widths: auto - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_device` **(** :ref:`UPNPDevice` device **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`add_port_mapping` **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_devices` **(** **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`delete_port_mapping` **(** :ref:`int` port, :ref:`String` proto="UDP" **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`discover` **(** :ref:`int` timeout=2000, :ref:`int` ttl=2, :ref:`String` device_filter="InternetGatewayDevice" **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`UPNPDevice` | :ref:`get_device` **(** :ref:`int` index **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_device_count` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`UPNPDevice` | :ref:`get_gateway` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`query_external_address` **(** **)** |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_device` **(** :ref:`int` index **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_device` **(** :ref:`int` index, :ref:`UPNPDevice` device **)** | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_device`\ (\ device\: :ref:`UPNPDevice`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`add_port_mapping`\ (\ port\: :ref:`int`, port_internal\: :ref:`int` = 0, desc\: :ref:`String` = "", proto\: :ref:`String` = "UDP", duration\: :ref:`int` = 0\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_devices`\ (\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`delete_port_mapping`\ (\ port\: :ref:`int`, proto\: :ref:`String` = "UDP"\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`discover`\ (\ timeout\: :ref:`int` = 2000, ttl\: :ref:`int` = 2, device_filter\: :ref:`String` = "InternetGatewayDevice"\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`UPNPDevice` | :ref:`get_device`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_device_count`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`UPNPDevice` | :ref:`get_gateway`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`query_external_address`\ (\ ) |const| | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_device`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_device`\ (\ index\: :ref:`int`, device\: :ref:`UPNPDevice`\ ) | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -397,8 +397,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_discover_ipv6** **(** :ref:`bool` value **)** -- :ref:`bool` **is_discover_ipv6** **(** **)** +- |void| **set_discover_ipv6**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_discover_ipv6**\ (\ ) If ``true``, IPv6 is used for :ref:`UPNPDevice` discovery. @@ -414,8 +414,8 @@ If ``true``, IPv6 is used for :ref:`UPNPDevice` discovery. .. rst-class:: classref-property-setget -- void **set_discover_local_port** **(** :ref:`int` value **)** -- :ref:`int` **get_discover_local_port** **(** **)** +- |void| **set_discover_local_port**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_discover_local_port**\ (\ ) If ``0``, the local port to use for discovery is chosen automatically by the system. If ``1``, discovery will be done from the source port 1900 (same as destination port). Otherwise, the value will be used as the port. @@ -431,8 +431,8 @@ If ``0``, the local port to use for discovery is chosen automatically by the sys .. rst-class:: classref-property-setget -- void **set_discover_multicast_if** **(** :ref:`String` value **)** -- :ref:`String` **get_discover_multicast_if** **(** **)** +- |void| **set_discover_multicast_if**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_discover_multicast_if**\ (\ ) Multicast interface to use for discovery. Uses the default multicast interface if empty. @@ -449,7 +449,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_device** **(** :ref:`UPNPDevice` device **)** +|void| **add_device**\ (\ device\: :ref:`UPNPDevice`\ ) Adds the given :ref:`UPNPDevice` to the list of discovered devices. @@ -461,7 +461,7 @@ Adds the given :ref:`UPNPDevice` to the list of discovered dev .. rst-class:: classref-method -:ref:`int` **add_port_mapping** **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** |const| +:ref:`int` **add_port_mapping**\ (\ port\: :ref:`int`, port_internal\: :ref:`int` = 0, desc\: :ref:`String` = "", proto\: :ref:`String` = "UDP", duration\: :ref:`int` = 0\ ) |const| Adds a mapping to forward the external ``port`` (between 1 and 65535, although recommended to use port 1024 or above) on the default gateway (see :ref:`get_gateway`) to the ``port_internal`` on the local machine for the given protocol ``proto`` (either ``"TCP"`` or ``"UDP"``, with UDP being the default). If a port mapping for the given port and protocol combination already exists on that gateway device, this method tries to overwrite it. If that is not desired, you can retrieve the gateway manually with :ref:`get_gateway` and call :ref:`add_port_mapping` on it, if any. Note that forwarding a well-known port (below 1024) with UPnP may fail depending on the device. @@ -483,7 +483,7 @@ See :ref:`UPNPResult` for possible return values. .. rst-class:: classref-method -void **clear_devices** **(** **)** +|void| **clear_devices**\ (\ ) Clears the list of discovered devices. @@ -495,7 +495,7 @@ Clears the list of discovered devices. .. rst-class:: classref-method -:ref:`int` **delete_port_mapping** **(** :ref:`int` port, :ref:`String` proto="UDP" **)** |const| +:ref:`int` **delete_port_mapping**\ (\ port\: :ref:`int`, proto\: :ref:`String` = "UDP"\ ) |const| Deletes the port mapping for the given port and protocol combination on the default gateway (see :ref:`get_gateway`) if one exists. ``port`` must be a valid port between 1 and 65535, ``proto`` can be either ``"TCP"`` or ``"UDP"``. May be refused for mappings pointing to addresses other than this one, for well-known ports (below 1024), or for mappings not added via UPnP. See :ref:`UPNPResult` for possible return values. @@ -507,7 +507,7 @@ Deletes the port mapping for the given port and protocol combination on the defa .. rst-class:: classref-method -:ref:`int` **discover** **(** :ref:`int` timeout=2000, :ref:`int` ttl=2, :ref:`String` device_filter="InternetGatewayDevice" **)** +:ref:`int` **discover**\ (\ timeout\: :ref:`int` = 2000, ttl\: :ref:`int` = 2, device_filter\: :ref:`String` = "InternetGatewayDevice"\ ) Discovers local :ref:`UPNPDevice`\ s. Clears the list of previously discovered devices. @@ -523,7 +523,7 @@ See :ref:`UPNPResult` for possible return values. .. rst-class:: classref-method -:ref:`UPNPDevice` **get_device** **(** :ref:`int` index **)** |const| +:ref:`UPNPDevice` **get_device**\ (\ index\: :ref:`int`\ ) |const| Returns the :ref:`UPNPDevice` at the given ``index``. @@ -535,7 +535,7 @@ Returns the :ref:`UPNPDevice` at the given ``index``. .. rst-class:: classref-method -:ref:`int` **get_device_count** **(** **)** |const| +:ref:`int` **get_device_count**\ (\ ) |const| Returns the number of discovered :ref:`UPNPDevice`\ s. @@ -547,7 +547,7 @@ Returns the number of discovered :ref:`UPNPDevice`\ s. .. rst-class:: classref-method -:ref:`UPNPDevice` **get_gateway** **(** **)** |const| +:ref:`UPNPDevice` **get_gateway**\ (\ ) |const| Returns the default gateway. That is the first discovered :ref:`UPNPDevice` that is also a valid IGD (InternetGatewayDevice). @@ -559,7 +559,7 @@ Returns the default gateway. That is the first discovered :ref:`UPNPDevice` **query_external_address** **(** **)** |const| +:ref:`String` **query_external_address**\ (\ ) |const| Returns the external :ref:`IP` address of the default gateway (see :ref:`get_gateway`) as string. Returns an empty string on error. @@ -571,7 +571,7 @@ Returns the external :ref:`IP` address of the default gateway (see :re .. rst-class:: classref-method -void **remove_device** **(** :ref:`int` index **)** +|void| **remove_device**\ (\ index\: :ref:`int`\ ) Removes the device at ``index`` from the list of discovered devices. @@ -583,7 +583,7 @@ Removes the device at ``index`` from the list of discovered devices. .. rst-class:: classref-method -void **set_device** **(** :ref:`int` index, :ref:`UPNPDevice` device **)** +|void| **set_device**\ (\ index\: :ref:`int`, device\: :ref:`UPNPDevice`\ ) Sets the device at ``index`` from the list of discovered devices to ``device``. @@ -594,3 +594,4 @@ Sets the device at ``index`` from the list of discovered devices to ``device``. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_upnpdevice.rst b/classes/class_upnpdevice.rst index 245cb1f6c9f..8fc31a54f61 100644 --- a/classes/class_upnpdevice.rst +++ b/classes/class_upnpdevice.rst @@ -51,15 +51,15 @@ Methods .. table:: :widths: auto - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`add_port_mapping` **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** |const| | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`delete_port_mapping` **(** :ref:`int` port, :ref:`String` proto="UDP" **)** |const| | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_gateway` **(** **)** |const| | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`query_external_address` **(** **)** |const| | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`add_port_mapping`\ (\ port\: :ref:`int`, port_internal\: :ref:`int` = 0, desc\: :ref:`String` = "", proto\: :ref:`String` = "UDP", duration\: :ref:`int` = 0\ ) |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`delete_port_mapping`\ (\ port\: :ref:`int`, proto\: :ref:`String` = "UDP"\ ) |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_gateway`\ (\ ) |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`query_external_address`\ (\ ) |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -173,8 +173,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_description_url** **(** :ref:`String` value **)** -- :ref:`String` **get_description_url** **(** **)** +- |void| **set_description_url**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_description_url**\ (\ ) URL to the device description. @@ -190,8 +190,8 @@ URL to the device description. .. rst-class:: classref-property-setget -- void **set_igd_control_url** **(** :ref:`String` value **)** -- :ref:`String` **get_igd_control_url** **(** **)** +- |void| **set_igd_control_url**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_igd_control_url**\ (\ ) IDG control URL. @@ -207,8 +207,8 @@ IDG control URL. .. rst-class:: classref-property-setget -- void **set_igd_our_addr** **(** :ref:`String` value **)** -- :ref:`String` **get_igd_our_addr** **(** **)** +- |void| **set_igd_our_addr**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_igd_our_addr**\ (\ ) Address of the local machine in the network connecting it to this **UPNPDevice**. @@ -224,8 +224,8 @@ Address of the local machine in the network connecting it to this **UPNPDevice** .. rst-class:: classref-property-setget -- void **set_igd_service_type** **(** :ref:`String` value **)** -- :ref:`String` **get_igd_service_type** **(** **)** +- |void| **set_igd_service_type**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_igd_service_type**\ (\ ) IGD service type. @@ -241,8 +241,8 @@ IGD service type. .. rst-class:: classref-property-setget -- void **set_igd_status** **(** :ref:`IGDStatus` value **)** -- :ref:`IGDStatus` **get_igd_status** **(** **)** +- |void| **set_igd_status**\ (\ value\: :ref:`IGDStatus`\ ) +- :ref:`IGDStatus` **get_igd_status**\ (\ ) IGD status. See :ref:`IGDStatus`. @@ -258,8 +258,8 @@ IGD status. See :ref:`IGDStatus`. .. rst-class:: classref-property-setget -- void **set_service_type** **(** :ref:`String` value **)** -- :ref:`String` **get_service_type** **(** **)** +- |void| **set_service_type**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_service_type**\ (\ ) Service type. @@ -276,7 +276,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **add_port_mapping** **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** |const| +:ref:`int` **add_port_mapping**\ (\ port\: :ref:`int`, port_internal\: :ref:`int` = 0, desc\: :ref:`String` = "", proto\: :ref:`String` = "UDP", duration\: :ref:`int` = 0\ ) |const| Adds a port mapping to forward the given external port on this **UPNPDevice** for the given protocol to the local machine. See :ref:`UPNP.add_port_mapping`. @@ -288,7 +288,7 @@ Adds a port mapping to forward the given external port on this **UPNPDevice** fo .. rst-class:: classref-method -:ref:`int` **delete_port_mapping** **(** :ref:`int` port, :ref:`String` proto="UDP" **)** |const| +:ref:`int` **delete_port_mapping**\ (\ port\: :ref:`int`, proto\: :ref:`String` = "UDP"\ ) |const| Deletes the port mapping identified by the given port and protocol combination on this device. See :ref:`UPNP.delete_port_mapping`. @@ -300,7 +300,7 @@ Deletes the port mapping identified by the given port and protocol combination o .. rst-class:: classref-method -:ref:`bool` **is_valid_gateway** **(** **)** |const| +:ref:`bool` **is_valid_gateway**\ (\ ) |const| Returns ``true`` if this is a valid IGD (InternetGatewayDevice) which potentially supports port forwarding. @@ -312,7 +312,7 @@ Returns ``true`` if this is a valid IGD (InternetGatewayDevice) which potentiall .. rst-class:: classref-method -:ref:`String` **query_external_address** **(** **)** |const| +:ref:`String` **query_external_address**\ (\ ) |const| Returns the external IP address of this **UPNPDevice** or an empty string. @@ -323,3 +323,4 @@ Returns the external IP address of this **UPNPDevice** or an empty string. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_variant.rst b/classes/class_variant.rst index d01ffcd5e72..21ddd7b2b68 100644 --- a/classes/class_variant.rst +++ b/classes/class_variant.rst @@ -139,3 +139,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_vboxcontainer.rst b/classes/class_vboxcontainer.rst index e3665f466a1..21b6e0a68e6 100644 --- a/classes/class_vboxcontainer.rst +++ b/classes/class_vboxcontainer.rst @@ -39,3 +39,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index f3c098c8578..cc5d686c6d6 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -64,15 +64,15 @@ Constructors .. table:: :widths: auto - +-------------------------------+------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`Vector2` **(** **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`Vector2` **(** :ref:`Vector2` from **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`Vector2` **(** :ref:`Vector2i` from **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`Vector2` **(** :ref:`float` x, :ref:`float` y **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`Vector2`\ (\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`Vector2`\ (\ from\: :ref:`Vector2`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`Vector2`\ (\ from\: :ref:`Vector2i`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`Vector2`\ (\ x\: :ref:`float`, y\: :ref:`float`\ ) | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -82,91 +82,91 @@ Methods .. table:: :widths: auto - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`abs` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`angle` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`angle_to` **(** :ref:`Vector2` to **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`angle_to_point` **(** :ref:`Vector2` to **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`aspect` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`bezier_derivative` **(** :ref:`Vector2` control_1, :ref:`Vector2` control_2, :ref:`Vector2` end, :ref:`float` t **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`bezier_interpolate` **(** :ref:`Vector2` control_1, :ref:`Vector2` control_2, :ref:`Vector2` end, :ref:`float` t **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`bounce` **(** :ref:`Vector2` n **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`ceil` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`clamp` **(** :ref:`Vector2` min, :ref:`Vector2` max **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`cross` **(** :ref:`Vector2` with **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`cubic_interpolate` **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` weight **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`cubic_interpolate_in_time` **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` weight, :ref:`float` b_t, :ref:`float` pre_a_t, :ref:`float` post_b_t **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`direction_to` **(** :ref:`Vector2` to **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`distance_squared_to` **(** :ref:`Vector2` to **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`distance_to` **(** :ref:`Vector2` to **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`dot` **(** :ref:`Vector2` with **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`floor` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`from_angle` **(** :ref:`float` angle **)** |static| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Vector2` to **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_finite` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_normalized` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_zero_approx` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length_squared` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`lerp` **(** :ref:`Vector2` to, :ref:`float` weight **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`limit_length` **(** :ref:`float` length=1.0 **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`max_axis_index` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`min_axis_index` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`move_toward` **(** :ref:`Vector2` to, :ref:`float` delta **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`normalized` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`orthogonal` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`posmod` **(** :ref:`float` mod **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`posmodv` **(** :ref:`Vector2` modv **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`project` **(** :ref:`Vector2` b **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`reflect` **(** :ref:`Vector2` n **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`rotated` **(** :ref:`float` angle **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`round` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`sign` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`slerp` **(** :ref:`Vector2` to, :ref:`float` weight **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`slide` **(** :ref:`Vector2` n **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`snapped` **(** :ref:`Vector2` step **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`abs`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`angle`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`angle_to`\ (\ to\: :ref:`Vector2`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`angle_to_point`\ (\ to\: :ref:`Vector2`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`aspect`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`bezier_derivative`\ (\ control_1\: :ref:`Vector2`, control_2\: :ref:`Vector2`, end\: :ref:`Vector2`, t\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`bezier_interpolate`\ (\ control_1\: :ref:`Vector2`, control_2\: :ref:`Vector2`, end\: :ref:`Vector2`, t\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`bounce`\ (\ n\: :ref:`Vector2`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`ceil`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`clamp`\ (\ min\: :ref:`Vector2`, max\: :ref:`Vector2`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`cross`\ (\ with\: :ref:`Vector2`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`cubic_interpolate`\ (\ b\: :ref:`Vector2`, pre_a\: :ref:`Vector2`, post_b\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`cubic_interpolate_in_time`\ (\ b\: :ref:`Vector2`, pre_a\: :ref:`Vector2`, post_b\: :ref:`Vector2`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`direction_to`\ (\ to\: :ref:`Vector2`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`distance_squared_to`\ (\ to\: :ref:`Vector2`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`distance_to`\ (\ to\: :ref:`Vector2`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`dot`\ (\ with\: :ref:`Vector2`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`floor`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`from_angle`\ (\ angle\: :ref:`float`\ ) |static| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equal_approx`\ (\ to\: :ref:`Vector2`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_normalized`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_zero_approx`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length_squared`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`lerp`\ (\ to\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`limit_length`\ (\ length\: :ref:`float` = 1.0\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`max_axis_index`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`min_axis_index`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`move_toward`\ (\ to\: :ref:`Vector2`, delta\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`normalized`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`orthogonal`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`posmod`\ (\ mod\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`posmodv`\ (\ modv\: :ref:`Vector2`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`project`\ (\ b\: :ref:`Vector2`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`reflect`\ (\ n\: :ref:`Vector2`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`rotated`\ (\ angle\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`round`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`sign`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`slerp`\ (\ to\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`slide`\ (\ n\: :ref:`Vector2`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`snapped`\ (\ step\: :ref:`Vector2`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -176,43 +176,43 @@ Operators .. table:: :widths: auto - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Vector2` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator *` **(** :ref:`Transform2D` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator *` **(** :ref:`Vector2` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator *` **(** :ref:`float` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator *` **(** :ref:`int` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator +` **(** :ref:`Vector2` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator -` **(** :ref:`Vector2` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator /` **(** :ref:`Vector2` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator /` **(** :ref:`float` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator /` **(** :ref:`int` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<` **(** :ref:`Vector2` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<=` **(** :ref:`Vector2` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Vector2` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >` **(** :ref:`Vector2` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >=` **(** :ref:`Vector2` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator []` **(** :ref:`int` index **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator unary+` **(** **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator unary-` **(** **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Vector2`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator *`\ (\ right\: :ref:`Transform2D`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator *`\ (\ right\: :ref:`Vector2`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator *`\ (\ right\: :ref:`float`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator *`\ (\ right\: :ref:`int`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator +`\ (\ right\: :ref:`Vector2`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator -`\ (\ right\: :ref:`Vector2`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator /`\ (\ right\: :ref:`Vector2`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator /`\ (\ right\: :ref:`float`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator /`\ (\ right\: :ref:`int`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<`\ (\ right\: :ref:`Vector2`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<=`\ (\ right\: :ref:`Vector2`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Vector2`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >`\ (\ right\: :ref:`Vector2`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >=`\ (\ right\: :ref:`Vector2`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator unary+`\ (\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator unary-`\ (\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -337,7 +337,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Vector2` **Vector2** **(** **)** +:ref:`Vector2` **Vector2**\ (\ ) Constructs a default-initialized **Vector2** with all components set to ``0``. @@ -347,7 +347,7 @@ Constructs a default-initialized **Vector2** with all components set to ``0``. .. rst-class:: classref-constructor -:ref:`Vector2` **Vector2** **(** :ref:`Vector2` from **)** +:ref:`Vector2` **Vector2**\ (\ from\: :ref:`Vector2`\ ) Constructs a **Vector2** as a copy of the given **Vector2**. @@ -357,7 +357,7 @@ Constructs a **Vector2** as a copy of the given **Vector2**. .. rst-class:: classref-constructor -:ref:`Vector2` **Vector2** **(** :ref:`Vector2i` from **)** +:ref:`Vector2` **Vector2**\ (\ from\: :ref:`Vector2i`\ ) Constructs a new **Vector2** from :ref:`Vector2i`. @@ -367,7 +367,7 @@ Constructs a new **Vector2** from :ref:`Vector2i`. .. rst-class:: classref-constructor -:ref:`Vector2` **Vector2** **(** :ref:`float` x, :ref:`float` y **)** +:ref:`Vector2` **Vector2**\ (\ x\: :ref:`float`, y\: :ref:`float`\ ) Constructs a new **Vector2** from the given ``x`` and ``y``. @@ -384,7 +384,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector2` **abs** **(** **)** |const| +:ref:`Vector2` **abs**\ (\ ) |const| Returns a new vector with all components in absolute values (i.e. positive). @@ -396,7 +396,7 @@ Returns a new vector with all components in absolute values (i.e. positive). .. rst-class:: classref-method -:ref:`float` **angle** **(** **)** |const| +:ref:`float` **angle**\ (\ ) |const| Returns this vector's angle with respect to the positive X axis, or ``(1, 0)`` vector, in radians. @@ -414,7 +414,7 @@ Equivalent to the result of :ref:`@GlobalScope.atan2` **angle_to** **(** :ref:`Vector2` to **)** |const| +:ref:`float` **angle_to**\ (\ to\: :ref:`Vector2`\ ) |const| Returns the angle to the given vector, in radians. @@ -428,7 +428,7 @@ Returns the angle to the given vector, in radians. .. rst-class:: classref-method -:ref:`float` **angle_to_point** **(** :ref:`Vector2` to **)** |const| +:ref:`float` **angle_to_point**\ (\ to\: :ref:`Vector2`\ ) |const| Returns the angle between the line connecting the two points and the X axis, in radians. @@ -444,7 +444,7 @@ Returns the angle between the line connecting the two points and the X axis, in .. rst-class:: classref-method -:ref:`float` **aspect** **(** **)** |const| +:ref:`float` **aspect**\ (\ ) |const| Returns the aspect ratio of this vector, the ratio of :ref:`x` to :ref:`y`. @@ -456,7 +456,7 @@ Returns the aspect ratio of this vector, the ratio of :ref:`x` **bezier_derivative** **(** :ref:`Vector2` control_1, :ref:`Vector2` control_2, :ref:`Vector2` end, :ref:`float` t **)** |const| +:ref:`Vector2` **bezier_derivative**\ (\ control_1\: :ref:`Vector2`, control_2\: :ref:`Vector2`, end\: :ref:`Vector2`, t\: :ref:`float`\ ) |const| Returns the derivative at the given ``t`` on the `Bézier curve `__ defined by this vector and the given ``control_1``, ``control_2``, and ``end`` points. @@ -468,7 +468,7 @@ Returns the derivative at the given ``t`` on the `Bézier curve ` **bezier_interpolate** **(** :ref:`Vector2` control_1, :ref:`Vector2` control_2, :ref:`Vector2` end, :ref:`float` t **)** |const| +:ref:`Vector2` **bezier_interpolate**\ (\ control_1\: :ref:`Vector2`, control_2\: :ref:`Vector2`, end\: :ref:`Vector2`, t\: :ref:`float`\ ) |const| Returns the point at the given ``t`` on the `Bézier curve `__ defined by this vector and the given ``control_1``, ``control_2``, and ``end`` points. @@ -480,7 +480,7 @@ Returns the point at the given ``t`` on the `Bézier curve ` **bounce** **(** :ref:`Vector2` n **)** |const| +:ref:`Vector2` **bounce**\ (\ n\: :ref:`Vector2`\ ) |const| Returns a new vector "bounced off" from a plane defined by the given normal. @@ -492,7 +492,7 @@ Returns a new vector "bounced off" from a plane defined by the given normal. .. rst-class:: classref-method -:ref:`Vector2` **ceil** **(** **)** |const| +:ref:`Vector2` **ceil**\ (\ ) |const| Returns a new vector with all components rounded up (towards positive infinity). @@ -504,7 +504,7 @@ Returns a new vector with all components rounded up (towards positive infinity). .. rst-class:: classref-method -:ref:`Vector2` **clamp** **(** :ref:`Vector2` min, :ref:`Vector2` max **)** |const| +:ref:`Vector2` **clamp**\ (\ min\: :ref:`Vector2`, max\: :ref:`Vector2`\ ) |const| Returns a new vector with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -516,7 +516,7 @@ Returns a new vector with all components clamped between the components of ``min .. rst-class:: classref-method -:ref:`float` **cross** **(** :ref:`Vector2` with **)** |const| +:ref:`float` **cross**\ (\ with\: :ref:`Vector2`\ ) |const| Returns the 2D analog of the cross product for this vector and ``with``. @@ -532,7 +532,7 @@ This is the signed area of the parallelogram formed by the two vectors. If the s .. rst-class:: classref-method -:ref:`Vector2` **cubic_interpolate** **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` weight **)** |const| +:ref:`Vector2` **cubic_interpolate**\ (\ b\: :ref:`Vector2`, pre_a\: :ref:`Vector2`, post_b\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. @@ -544,7 +544,7 @@ Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and .. rst-class:: classref-method -:ref:`Vector2` **cubic_interpolate_in_time** **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` weight, :ref:`float` b_t, :ref:`float` pre_a_t, :ref:`float` post_b_t **)** |const| +:ref:`Vector2` **cubic_interpolate_in_time**\ (\ b\: :ref:`Vector2`, pre_a\: :ref:`Vector2`, post_b\: :ref:`Vector2`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. @@ -558,7 +558,7 @@ It can perform smoother interpolation than :ref:`cubic_interpolate` **direction_to** **(** :ref:`Vector2` to **)** |const| +:ref:`Vector2` **direction_to**\ (\ to\: :ref:`Vector2`\ ) |const| Returns the normalized vector pointing from this vector to ``to``. This is equivalent to using ``(b - a).normalized()``. @@ -570,7 +570,7 @@ Returns the normalized vector pointing from this vector to ``to``. This is equiv .. rst-class:: classref-method -:ref:`float` **distance_squared_to** **(** :ref:`Vector2` to **)** |const| +:ref:`float` **distance_squared_to**\ (\ to\: :ref:`Vector2`\ ) |const| Returns the squared distance between this vector and ``to``. @@ -584,7 +584,7 @@ This method runs faster than :ref:`distance_to .. rst-class:: classref-method -:ref:`float` **distance_to** **(** :ref:`Vector2` to **)** |const| +:ref:`float` **distance_to**\ (\ to\: :ref:`Vector2`\ ) |const| Returns the distance between this vector and ``to``. @@ -596,7 +596,7 @@ Returns the distance between this vector and ``to``. .. rst-class:: classref-method -:ref:`float` **dot** **(** :ref:`Vector2` with **)** |const| +:ref:`float` **dot**\ (\ with\: :ref:`Vector2`\ ) |const| Returns the dot product of this vector and ``with``. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player. @@ -614,7 +614,7 @@ When using unit (normalized) vectors, the result will always be between ``-1.0`` .. rst-class:: classref-method -:ref:`Vector2` **floor** **(** **)** |const| +:ref:`Vector2` **floor**\ (\ ) |const| Returns a new vector with all components rounded down (towards negative infinity). @@ -626,7 +626,7 @@ Returns a new vector with all components rounded down (towards negative infinity .. rst-class:: classref-method -:ref:`Vector2` **from_angle** **(** :ref:`float` angle **)** |static| +:ref:`Vector2` **from_angle**\ (\ angle\: :ref:`float`\ ) |static| Creates a unit **Vector2** rotated to the given ``angle`` in radians. This is equivalent to doing ``Vector2(cos(angle), sin(angle))`` or ``Vector2.RIGHT.rotated(angle)``. @@ -644,7 +644,7 @@ Creates a unit **Vector2** rotated to the given ``angle`` in radians. This is eq .. rst-class:: classref-method -:ref:`bool` **is_equal_approx** **(** :ref:`Vector2` to **)** |const| +:ref:`bool` **is_equal_approx**\ (\ to\: :ref:`Vector2`\ ) |const| Returns ``true`` if this vector and ``to`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. @@ -656,7 +656,7 @@ Returns ``true`` if this vector and ``to`` are approximately equal, by running : .. rst-class:: classref-method -:ref:`bool` **is_finite** **(** **)** |const| +:ref:`bool` **is_finite**\ (\ ) |const| Returns ``true`` if this vector is finite, by calling :ref:`@GlobalScope.is_finite` on each component. @@ -668,7 +668,7 @@ Returns ``true`` if this vector is finite, by calling :ref:`@GlobalScope.is_fini .. rst-class:: classref-method -:ref:`bool` **is_normalized** **(** **)** |const| +:ref:`bool` **is_normalized**\ (\ ) |const| Returns ``true`` if the vector is normalized, i.e. its length is approximately equal to 1. @@ -680,7 +680,7 @@ Returns ``true`` if the vector is normalized, i.e. its length is approximately e .. rst-class:: classref-method -:ref:`bool` **is_zero_approx** **(** **)** |const| +:ref:`bool` **is_zero_approx**\ (\ ) |const| Returns ``true`` if this vector's values are approximately zero, by running :ref:`@GlobalScope.is_zero_approx` on each component. @@ -694,7 +694,7 @@ This method is faster than using :ref:`is_equal_approx` **length** **(** **)** |const| +:ref:`float` **length**\ (\ ) |const| Returns the length (magnitude) of this vector. @@ -706,7 +706,7 @@ Returns the length (magnitude) of this vector. .. rst-class:: classref-method -:ref:`float` **length_squared** **(** **)** |const| +:ref:`float` **length_squared**\ (\ ) |const| Returns the squared length (squared magnitude) of this vector. @@ -720,7 +720,7 @@ This method runs faster than :ref:`length`, so pref .. rst-class:: classref-method -:ref:`Vector2` **lerp** **(** :ref:`Vector2` to, :ref:`float` weight **)** |const| +:ref:`Vector2` **lerp**\ (\ to\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| Returns the result of the linear interpolation between this vector and ``to`` by amount ``weight``. ``weight`` is on the range of ``0.0`` to ``1.0``, representing the amount of interpolation. @@ -732,7 +732,7 @@ Returns the result of the linear interpolation between this vector and ``to`` by .. rst-class:: classref-method -:ref:`Vector2` **limit_length** **(** :ref:`float` length=1.0 **)** |const| +:ref:`Vector2` **limit_length**\ (\ length\: :ref:`float` = 1.0\ ) |const| Returns the vector with a maximum length by limiting its length to ``length``. @@ -744,7 +744,7 @@ Returns the vector with a maximum length by limiting its length to ``length``. .. rst-class:: classref-method -:ref:`int` **max_axis_index** **(** **)** |const| +:ref:`int` **max_axis_index**\ (\ ) |const| Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_X`. @@ -756,7 +756,7 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`int` **min_axis_index** **(** **)** |const| +:ref:`int` **min_axis_index**\ (\ ) |const| Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_Y`. @@ -768,7 +768,7 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`Vector2` **move_toward** **(** :ref:`Vector2` to, :ref:`float` delta **)** |const| +:ref:`Vector2` **move_toward**\ (\ to\: :ref:`Vector2`, delta\: :ref:`float`\ ) |const| Returns a new vector moved toward ``to`` by the fixed ``delta`` amount. Will not go past the final value. @@ -780,7 +780,7 @@ Returns a new vector moved toward ``to`` by the fixed ``delta`` amount. Will not .. rst-class:: classref-method -:ref:`Vector2` **normalized** **(** **)** |const| +:ref:`Vector2` **normalized**\ (\ ) |const| Returns the result of scaling the vector to unit length. Equivalent to ``v / v.length()``. See also :ref:`is_normalized`. @@ -794,7 +794,7 @@ Returns the result of scaling the vector to unit length. Equivalent to ``v / v.l .. rst-class:: classref-method -:ref:`Vector2` **orthogonal** **(** **)** |const| +:ref:`Vector2` **orthogonal**\ (\ ) |const| Returns a perpendicular vector rotated 90 degrees counter-clockwise compared to the original, with the same length. @@ -806,7 +806,7 @@ Returns a perpendicular vector rotated 90 degrees counter-clockwise compared to .. rst-class:: classref-method -:ref:`Vector2` **posmod** **(** :ref:`float` mod **)** |const| +:ref:`Vector2` **posmod**\ (\ mod\: :ref:`float`\ ) |const| Returns a vector composed of the :ref:`@GlobalScope.fposmod` of this vector's components and ``mod``. @@ -818,7 +818,7 @@ Returns a vector composed of the :ref:`@GlobalScope.fposmod` **posmodv** **(** :ref:`Vector2` modv **)** |const| +:ref:`Vector2` **posmodv**\ (\ modv\: :ref:`Vector2`\ ) |const| Returns a vector composed of the :ref:`@GlobalScope.fposmod` of this vector's components and ``modv``'s components. @@ -830,7 +830,7 @@ Returns a vector composed of the :ref:`@GlobalScope.fposmod` **project** **(** :ref:`Vector2` b **)** |const| +:ref:`Vector2` **project**\ (\ b\: :ref:`Vector2`\ ) |const| Returns the result of projecting the vector onto the given vector ``b``. @@ -842,7 +842,7 @@ Returns the result of projecting the vector onto the given vector ``b``. .. rst-class:: classref-method -:ref:`Vector2` **reflect** **(** :ref:`Vector2` n **)** |const| +:ref:`Vector2` **reflect**\ (\ n\: :ref:`Vector2`\ ) |const| Returns the result of reflecting the vector from a line defined by the given direction vector ``n``. @@ -854,7 +854,7 @@ Returns the result of reflecting the vector from a line defined by the given dir .. rst-class:: classref-method -:ref:`Vector2` **rotated** **(** :ref:`float` angle **)** |const| +:ref:`Vector2` **rotated**\ (\ angle\: :ref:`float`\ ) |const| Returns the result of rotating this vector by ``angle`` (in radians). See also :ref:`@GlobalScope.deg_to_rad`. @@ -866,7 +866,7 @@ Returns the result of rotating this vector by ``angle`` (in radians). See also : .. rst-class:: classref-method -:ref:`Vector2` **round** **(** **)** |const| +:ref:`Vector2` **round**\ (\ ) |const| Returns a new vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. @@ -878,7 +878,7 @@ Returns a new vector with all components rounded to the nearest integer, with ha .. rst-class:: classref-method -:ref:`Vector2` **sign** **(** **)** |const| +:ref:`Vector2` **sign**\ (\ ) |const| Returns a new vector with each component set to ``1.0`` if it's positive, ``-1.0`` if it's negative, and ``0.0`` if it's zero. The result is identical to calling :ref:`@GlobalScope.sign` on each component. @@ -890,7 +890,7 @@ Returns a new vector with each component set to ``1.0`` if it's positive, ``-1.0 .. rst-class:: classref-method -:ref:`Vector2` **slerp** **(** :ref:`Vector2` to, :ref:`float` weight **)** |const| +:ref:`Vector2` **slerp**\ (\ to\: :ref:`Vector2`, weight\: :ref:`float`\ ) |const| Returns the result of spherical linear interpolation between this vector and ``to``, by amount ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. @@ -904,7 +904,7 @@ This method also handles interpolating the lengths if the input vectors have dif .. rst-class:: classref-method -:ref:`Vector2` **slide** **(** :ref:`Vector2` n **)** |const| +:ref:`Vector2` **slide**\ (\ n\: :ref:`Vector2`\ ) |const| Returns the result of sliding the vector along a plane defined by the given normal. @@ -916,7 +916,7 @@ Returns the result of sliding the vector along a plane defined by the given norm .. rst-class:: classref-method -:ref:`Vector2` **snapped** **(** :ref:`Vector2` step **)** |const| +:ref:`Vector2` **snapped**\ (\ step\: :ref:`Vector2`\ ) |const| Returns a new vector with each component snapped to the nearest multiple of the corresponding component in ``step``. This can also be used to round the components to an arbitrary number of decimals. @@ -933,7 +933,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Vector2` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Vector2`\ ) Returns ``true`` if the vectors are not equal. @@ -949,7 +949,7 @@ Returns ``true`` if the vectors are not equal. .. rst-class:: classref-operator -:ref:`Vector2` **operator *** **(** :ref:`Transform2D` right **)** +:ref:`Vector2` **operator ***\ (\ right\: :ref:`Transform2D`\ ) Inversely transforms (multiplies) the **Vector2** by the given :ref:`Transform2D` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). @@ -965,7 +965,7 @@ For transforming by inverse of an affine transformation (e.g. with scaling) ``tr .. rst-class:: classref-operator -:ref:`Vector2` **operator *** **(** :ref:`Vector2` right **)** +:ref:`Vector2` **operator ***\ (\ right\: :ref:`Vector2`\ ) Multiplies each component of the **Vector2** by the components of the given **Vector2**. @@ -981,7 +981,7 @@ Multiplies each component of the **Vector2** by the components of the given **Ve .. rst-class:: classref-operator -:ref:`Vector2` **operator *** **(** :ref:`float` right **)** +:ref:`Vector2` **operator ***\ (\ right\: :ref:`float`\ ) Multiplies each component of the **Vector2** by the given :ref:`float`. @@ -993,7 +993,7 @@ Multiplies each component of the **Vector2** by the given :ref:`float` **operator *** **(** :ref:`int` right **)** +:ref:`Vector2` **operator ***\ (\ right\: :ref:`int`\ ) Multiplies each component of the **Vector2** by the given :ref:`int`. @@ -1005,7 +1005,7 @@ Multiplies each component of the **Vector2** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`Vector2` **operator +** **(** :ref:`Vector2` right **)** +:ref:`Vector2` **operator +**\ (\ right\: :ref:`Vector2`\ ) Adds each component of the **Vector2** by the components of the given **Vector2**. @@ -1021,7 +1021,7 @@ Adds each component of the **Vector2** by the components of the given **Vector2* .. rst-class:: classref-operator -:ref:`Vector2` **operator -** **(** :ref:`Vector2` right **)** +:ref:`Vector2` **operator -**\ (\ right\: :ref:`Vector2`\ ) Subtracts each component of the **Vector2** by the components of the given **Vector2**. @@ -1037,7 +1037,7 @@ Subtracts each component of the **Vector2** by the components of the given **Vec .. rst-class:: classref-operator -:ref:`Vector2` **operator /** **(** :ref:`Vector2` right **)** +:ref:`Vector2` **operator /**\ (\ right\: :ref:`Vector2`\ ) Divides each component of the **Vector2** by the components of the given **Vector2**. @@ -1053,7 +1053,7 @@ Divides each component of the **Vector2** by the components of the given **Vecto .. rst-class:: classref-operator -:ref:`Vector2` **operator /** **(** :ref:`float` right **)** +:ref:`Vector2` **operator /**\ (\ right\: :ref:`float`\ ) Divides each component of the **Vector2** by the given :ref:`float`. @@ -1065,7 +1065,7 @@ Divides each component of the **Vector2** by the given :ref:`float` .. rst-class:: classref-operator -:ref:`Vector2` **operator /** **(** :ref:`int` right **)** +:ref:`Vector2` **operator /**\ (\ right\: :ref:`int`\ ) Divides each component of the **Vector2** by the given :ref:`int`. @@ -1077,7 +1077,7 @@ Divides each component of the **Vector2** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`bool` **operator <** **(** :ref:`Vector2` right **)** +:ref:`bool` **operator <**\ (\ right\: :ref:`Vector2`\ ) Compares two **Vector2** vectors by first checking if the X value of the left vector is less than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. @@ -1091,7 +1091,7 @@ Compares two **Vector2** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`bool` **operator <=** **(** :ref:`Vector2` right **)** +:ref:`bool` **operator <=**\ (\ right\: :ref:`Vector2`\ ) Compares two **Vector2** vectors by first checking if the X value of the left vector is less than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. @@ -1105,7 +1105,7 @@ Compares two **Vector2** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`Vector2` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Vector2`\ ) Returns ``true`` if the vectors are exactly equal. @@ -1121,7 +1121,7 @@ Returns ``true`` if the vectors are exactly equal. .. rst-class:: classref-operator -:ref:`bool` **operator >** **(** :ref:`Vector2` right **)** +:ref:`bool` **operator >**\ (\ right\: :ref:`Vector2`\ ) Compares two **Vector2** vectors by first checking if the X value of the left vector is greater than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. @@ -1135,7 +1135,7 @@ Compares two **Vector2** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`bool` **operator >=** **(** :ref:`Vector2` right **)** +:ref:`bool` **operator >=**\ (\ right\: :ref:`Vector2`\ ) Compares two **Vector2** vectors by first checking if the X value of the left vector is greater than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. @@ -1149,7 +1149,7 @@ Compares two **Vector2** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`float` **operator []** **(** :ref:`int` index **)** +:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x``, and ``v[1]`` is equivalent to ``v.y``. @@ -1161,7 +1161,7 @@ Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x` .. rst-class:: classref-operator -:ref:`Vector2` **operator unary+** **(** **)** +:ref:`Vector2` **operator unary+**\ (\ ) Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -1173,7 +1173,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`Vector2` **operator unary-** **(** **)** +:ref:`Vector2` **operator unary-**\ (\ ) Returns the negative value of the **Vector2**. This is the same as writing ``Vector2(-v.x, -v.y)``. This operation flips the direction of the vector while keeping the same magnitude. With floats, the number zero can be either positive or negative. @@ -1184,3 +1184,4 @@ Returns the negative value of the **Vector2**. This is the same as writing ``Vec .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_vector2i.rst b/classes/class_vector2i.rst index bb3fb590b6a..25613d0fbe8 100644 --- a/classes/class_vector2i.rst +++ b/classes/class_vector2i.rst @@ -56,15 +56,15 @@ Constructors .. table:: :widths: auto - +---------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`Vector2i` **(** **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`Vector2i` **(** :ref:`Vector2i` from **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`Vector2i` **(** :ref:`Vector2` from **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`Vector2i` **(** :ref:`int` x, :ref:`int` y **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`Vector2i`\ (\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`Vector2i`\ (\ from\: :ref:`Vector2i`\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`Vector2i`\ (\ from\: :ref:`Vector2`\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`Vector2i`\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -74,29 +74,29 @@ Methods .. table:: :widths: auto - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`abs` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`aspect` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`clamp` **(** :ref:`Vector2i` min, :ref:`Vector2i` max **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`distance_squared_to` **(** :ref:`Vector2i` to **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`distance_to` **(** :ref:`Vector2i` to **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`length_squared` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`max_axis_index` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`min_axis_index` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`sign` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`snapped` **(** :ref:`Vector2i` step **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`abs`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`aspect`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`clamp`\ (\ min\: :ref:`Vector2i`, max\: :ref:`Vector2i`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`distance_squared_to`\ (\ to\: :ref:`Vector2i`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`distance_to`\ (\ to\: :ref:`Vector2i`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`length_squared`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`max_axis_index`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`min_axis_index`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`sign`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`snapped`\ (\ step\: :ref:`Vector2i`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -106,45 +106,45 @@ Operators .. table:: :widths: auto - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Vector2i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`operator %` **(** :ref:`Vector2i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`operator %` **(** :ref:`int` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`operator *` **(** :ref:`Vector2i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator *` **(** :ref:`float` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`operator *` **(** :ref:`int` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`operator +` **(** :ref:`Vector2i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`operator -` **(** :ref:`Vector2i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`operator /` **(** :ref:`Vector2i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`operator /` **(** :ref:`float` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`operator /` **(** :ref:`int` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<` **(** :ref:`Vector2i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<=` **(** :ref:`Vector2i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Vector2i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >` **(** :ref:`Vector2i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >=` **(** :ref:`Vector2i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator []` **(** :ref:`int` index **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`operator unary+` **(** **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`operator unary-` **(** **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Vector2i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`operator %`\ (\ right\: :ref:`Vector2i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`operator %`\ (\ right\: :ref:`int`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`operator *`\ (\ right\: :ref:`Vector2i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator *`\ (\ right\: :ref:`float`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`operator *`\ (\ right\: :ref:`int`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`operator +`\ (\ right\: :ref:`Vector2i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`operator -`\ (\ right\: :ref:`Vector2i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`operator /`\ (\ right\: :ref:`Vector2i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`operator /`\ (\ right\: :ref:`float`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`operator /`\ (\ right\: :ref:`int`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<`\ (\ right\: :ref:`Vector2i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<=`\ (\ right\: :ref:`Vector2i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Vector2i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >`\ (\ right\: :ref:`Vector2i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >=`\ (\ right\: :ref:`Vector2i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`operator unary+`\ (\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`operator unary-`\ (\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -277,7 +277,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Vector2i` **Vector2i** **(** **)** +:ref:`Vector2i` **Vector2i**\ (\ ) Constructs a default-initialized **Vector2i** with all components set to ``0``. @@ -287,7 +287,7 @@ Constructs a default-initialized **Vector2i** with all components set to ``0``. .. rst-class:: classref-constructor -:ref:`Vector2i` **Vector2i** **(** :ref:`Vector2i` from **)** +:ref:`Vector2i` **Vector2i**\ (\ from\: :ref:`Vector2i`\ ) Constructs a **Vector2i** as a copy of the given **Vector2i**. @@ -297,7 +297,7 @@ Constructs a **Vector2i** as a copy of the given **Vector2i**. .. rst-class:: classref-constructor -:ref:`Vector2i` **Vector2i** **(** :ref:`Vector2` from **)** +:ref:`Vector2i` **Vector2i**\ (\ from\: :ref:`Vector2`\ ) Constructs a new **Vector2i** from the given :ref:`Vector2` by truncating components' fractional parts (rounding towards zero). For a different behavior consider passing the result of :ref:`Vector2.ceil`, :ref:`Vector2.floor` or :ref:`Vector2.round` to this constructor instead. @@ -307,7 +307,7 @@ Constructs a new **Vector2i** from the given :ref:`Vector2` by tr .. rst-class:: classref-constructor -:ref:`Vector2i` **Vector2i** **(** :ref:`int` x, :ref:`int` y **)** +:ref:`Vector2i` **Vector2i**\ (\ x\: :ref:`int`, y\: :ref:`int`\ ) Constructs a new **Vector2i** from the given ``x`` and ``y``. @@ -324,7 +324,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector2i` **abs** **(** **)** |const| +:ref:`Vector2i` **abs**\ (\ ) |const| Returns a new vector with all components in absolute values (i.e. positive). @@ -336,7 +336,7 @@ Returns a new vector with all components in absolute values (i.e. positive). .. rst-class:: classref-method -:ref:`float` **aspect** **(** **)** |const| +:ref:`float` **aspect**\ (\ ) |const| Returns the aspect ratio of this vector, the ratio of :ref:`x` to :ref:`y`. @@ -348,7 +348,7 @@ Returns the aspect ratio of this vector, the ratio of :ref:`x` **clamp** **(** :ref:`Vector2i` min, :ref:`Vector2i` max **)** |const| +:ref:`Vector2i` **clamp**\ (\ min\: :ref:`Vector2i`, max\: :ref:`Vector2i`\ ) |const| Returns a new vector with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -360,7 +360,7 @@ Returns a new vector with all components clamped between the components of ``min .. rst-class:: classref-method -:ref:`int` **distance_squared_to** **(** :ref:`Vector2i` to **)** |const| +:ref:`int` **distance_squared_to**\ (\ to\: :ref:`Vector2i`\ ) |const| Returns the squared distance between this vector and ``to``. @@ -374,7 +374,7 @@ This method runs faster than :ref:`distance_to` **distance_to** **(** :ref:`Vector2i` to **)** |const| +:ref:`float` **distance_to**\ (\ to\: :ref:`Vector2i`\ ) |const| Returns the distance between this vector and ``to``. @@ -386,7 +386,7 @@ Returns the distance between this vector and ``to``. .. rst-class:: classref-method -:ref:`float` **length** **(** **)** |const| +:ref:`float` **length**\ (\ ) |const| Returns the length (magnitude) of this vector. @@ -398,7 +398,7 @@ Returns the length (magnitude) of this vector. .. rst-class:: classref-method -:ref:`int` **length_squared** **(** **)** |const| +:ref:`int` **length_squared**\ (\ ) |const| Returns the squared length (squared magnitude) of this vector. @@ -412,7 +412,7 @@ This method runs faster than :ref:`length`, so pre .. rst-class:: classref-method -:ref:`int` **max_axis_index** **(** **)** |const| +:ref:`int` **max_axis_index**\ (\ ) |const| Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_X`. @@ -424,7 +424,7 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`int` **min_axis_index** **(** **)** |const| +:ref:`int` **min_axis_index**\ (\ ) |const| Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_Y`. @@ -436,7 +436,7 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`Vector2i` **sign** **(** **)** |const| +:ref:`Vector2i` **sign**\ (\ ) |const| Returns a new vector with each component set to ``1`` if it's positive, ``-1`` if it's negative, and ``0`` if it's zero. The result is identical to calling :ref:`@GlobalScope.sign` on each component. @@ -448,7 +448,7 @@ Returns a new vector with each component set to ``1`` if it's positive, ``-1`` i .. rst-class:: classref-method -:ref:`Vector2i` **snapped** **(** :ref:`Vector2i` step **)** |const| +:ref:`Vector2i` **snapped**\ (\ step\: :ref:`Vector2i`\ ) |const| Returns a new vector with each component snapped to the closest multiple of the corresponding component in ``step``. @@ -465,7 +465,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Vector2i` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Vector2i`\ ) Returns ``true`` if the vectors are not equal. @@ -477,7 +477,7 @@ Returns ``true`` if the vectors are not equal. .. rst-class:: classref-operator -:ref:`Vector2i` **operator %** **(** :ref:`Vector2i` right **)** +:ref:`Vector2i` **operator %**\ (\ right\: :ref:`Vector2i`\ ) Gets the remainder of each component of the **Vector2i** with the components of the given **Vector2i**. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. @@ -493,7 +493,7 @@ Gets the remainder of each component of the **Vector2i** with the components of .. rst-class:: classref-operator -:ref:`Vector2i` **operator %** **(** :ref:`int` right **)** +:ref:`Vector2i` **operator %**\ (\ right\: :ref:`int`\ ) Gets the remainder of each component of the **Vector2i** with the given :ref:`int`. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. @@ -509,7 +509,7 @@ Gets the remainder of each component of the **Vector2i** with the given :ref:`in .. rst-class:: classref-operator -:ref:`Vector2i` **operator *** **(** :ref:`Vector2i` right **)** +:ref:`Vector2i` **operator ***\ (\ right\: :ref:`Vector2i`\ ) Multiplies each component of the **Vector2i** by the components of the given **Vector2i**. @@ -525,7 +525,7 @@ Multiplies each component of the **Vector2i** by the components of the given **V .. rst-class:: classref-operator -:ref:`Vector2` **operator *** **(** :ref:`float` right **)** +:ref:`Vector2` **operator ***\ (\ right\: :ref:`float`\ ) Multiplies each component of the **Vector2i** by the given :ref:`float`. Returns a :ref:`Vector2`. @@ -541,7 +541,7 @@ Multiplies each component of the **Vector2i** by the given :ref:`float` **operator *** **(** :ref:`int` right **)** +:ref:`Vector2i` **operator ***\ (\ right\: :ref:`int`\ ) Multiplies each component of the **Vector2i** by the given :ref:`int`. @@ -553,7 +553,7 @@ Multiplies each component of the **Vector2i** by the given :ref:`int` .. rst-class:: classref-operator -:ref:`Vector2i` **operator +** **(** :ref:`Vector2i` right **)** +:ref:`Vector2i` **operator +**\ (\ right\: :ref:`Vector2i`\ ) Adds each component of the **Vector2i** by the components of the given **Vector2i**. @@ -569,7 +569,7 @@ Adds each component of the **Vector2i** by the components of the given **Vector2 .. rst-class:: classref-operator -:ref:`Vector2i` **operator -** **(** :ref:`Vector2i` right **)** +:ref:`Vector2i` **operator -**\ (\ right\: :ref:`Vector2i`\ ) Subtracts each component of the **Vector2i** by the components of the given **Vector2i**. @@ -585,7 +585,7 @@ Subtracts each component of the **Vector2i** by the components of the given **Ve .. rst-class:: classref-operator -:ref:`Vector2i` **operator /** **(** :ref:`Vector2i` right **)** +:ref:`Vector2i` **operator /**\ (\ right\: :ref:`Vector2i`\ ) Divides each component of the **Vector2i** by the components of the given **Vector2i**. @@ -601,7 +601,7 @@ Divides each component of the **Vector2i** by the components of the given **Vect .. rst-class:: classref-operator -:ref:`Vector2` **operator /** **(** :ref:`float` right **)** +:ref:`Vector2` **operator /**\ (\ right\: :ref:`float`\ ) Divides each component of the **Vector2i** by the given :ref:`float`. Returns a :ref:`Vector2`. @@ -617,7 +617,7 @@ Divides each component of the **Vector2i** by the given :ref:`float .. rst-class:: classref-operator -:ref:`Vector2i` **operator /** **(** :ref:`int` right **)** +:ref:`Vector2i` **operator /**\ (\ right\: :ref:`int`\ ) Divides each component of the **Vector2i** by the given :ref:`int`. @@ -629,7 +629,7 @@ Divides each component of the **Vector2i** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`bool` **operator <** **(** :ref:`Vector2i` right **)** +:ref:`bool` **operator <**\ (\ right\: :ref:`Vector2i`\ ) Compares two **Vector2i** vectors by first checking if the X value of the left vector is less than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. @@ -641,7 +641,7 @@ Compares two **Vector2i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`bool` **operator <=** **(** :ref:`Vector2i` right **)** +:ref:`bool` **operator <=**\ (\ right\: :ref:`Vector2i`\ ) Compares two **Vector2i** vectors by first checking if the X value of the left vector is less than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. @@ -653,7 +653,7 @@ Compares two **Vector2i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`Vector2i` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Vector2i`\ ) Returns ``true`` if the vectors are equal. @@ -665,7 +665,7 @@ Returns ``true`` if the vectors are equal. .. rst-class:: classref-operator -:ref:`bool` **operator >** **(** :ref:`Vector2i` right **)** +:ref:`bool` **operator >**\ (\ right\: :ref:`Vector2i`\ ) Compares two **Vector2i** vectors by first checking if the X value of the left vector is greater than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. @@ -677,7 +677,7 @@ Compares two **Vector2i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`bool` **operator >=** **(** :ref:`Vector2i` right **)** +:ref:`bool` **operator >=**\ (\ right\: :ref:`Vector2i`\ ) Compares two **Vector2i** vectors by first checking if the X value of the left vector is greater than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. @@ -689,7 +689,7 @@ Compares two **Vector2i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`int` **operator []** **(** :ref:`int` index **)** +:ref:`int` **operator []**\ (\ index\: :ref:`int`\ ) Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x``, and ``v[1]`` is equivalent to ``v.y``. @@ -701,7 +701,7 @@ Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x` .. rst-class:: classref-operator -:ref:`Vector2i` **operator unary+** **(** **)** +:ref:`Vector2i` **operator unary+**\ (\ ) Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -713,7 +713,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`Vector2i` **operator unary-** **(** **)** +:ref:`Vector2i` **operator unary-**\ (\ ) Returns the negative value of the **Vector2i**. This is the same as writing ``Vector2i(-v.x, -v.y)``. This operation flips the direction of the vector while keeping the same magnitude. @@ -724,3 +724,4 @@ Returns the negative value of the **Vector2i**. This is the same as writing ``Ve .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index 39304e75695..117526de376 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -66,15 +66,15 @@ Constructors .. table:: :widths: auto - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`Vector3` **(** **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`Vector3` **(** :ref:`Vector3` from **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`Vector3` **(** :ref:`Vector3i` from **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`Vector3` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** | - +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`Vector3`\ (\ ) | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`Vector3`\ (\ from\: :ref:`Vector3`\ ) | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`Vector3`\ (\ from\: :ref:`Vector3i`\ ) | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`Vector3`\ (\ x\: :ref:`float`, y\: :ref:`float`, z\: :ref:`float`\ ) | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -84,91 +84,91 @@ Methods .. table:: :widths: auto - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`abs` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`angle_to` **(** :ref:`Vector3` to **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`bezier_derivative` **(** :ref:`Vector3` control_1, :ref:`Vector3` control_2, :ref:`Vector3` end, :ref:`float` t **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`bezier_interpolate` **(** :ref:`Vector3` control_1, :ref:`Vector3` control_2, :ref:`Vector3` end, :ref:`float` t **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`bounce` **(** :ref:`Vector3` n **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`ceil` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`clamp` **(** :ref:`Vector3` min, :ref:`Vector3` max **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`cross` **(** :ref:`Vector3` with **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`cubic_interpolate` **(** :ref:`Vector3` b, :ref:`Vector3` pre_a, :ref:`Vector3` post_b, :ref:`float` weight **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`cubic_interpolate_in_time` **(** :ref:`Vector3` b, :ref:`Vector3` pre_a, :ref:`Vector3` post_b, :ref:`float` weight, :ref:`float` b_t, :ref:`float` pre_a_t, :ref:`float` post_b_t **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`direction_to` **(** :ref:`Vector3` to **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`distance_squared_to` **(** :ref:`Vector3` to **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3` to **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`dot` **(** :ref:`Vector3` with **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`floor` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`inverse` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Vector3` to **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_finite` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_normalized` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_zero_approx` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length_squared` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`lerp` **(** :ref:`Vector3` to, :ref:`float` weight **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`limit_length` **(** :ref:`float` length=1.0 **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`max_axis_index` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`min_axis_index` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`move_toward` **(** :ref:`Vector3` to, :ref:`float` delta **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`normalized` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`octahedron_decode` **(** :ref:`Vector2` uv **)** |static| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`octahedron_encode` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Basis` | :ref:`outer` **(** :ref:`Vector3` with **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`posmod` **(** :ref:`float` mod **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`posmodv` **(** :ref:`Vector3` modv **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`project` **(** :ref:`Vector3` b **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`reflect` **(** :ref:`Vector3` n **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` angle **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`round` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`sign` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`signed_angle_to` **(** :ref:`Vector3` to, :ref:`Vector3` axis **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`slerp` **(** :ref:`Vector3` to, :ref:`float` weight **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`slide` **(** :ref:`Vector3` n **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`snapped` **(** :ref:`Vector3` step **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`abs`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`angle_to`\ (\ to\: :ref:`Vector3`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`bezier_derivative`\ (\ control_1\: :ref:`Vector3`, control_2\: :ref:`Vector3`, end\: :ref:`Vector3`, t\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`bezier_interpolate`\ (\ control_1\: :ref:`Vector3`, control_2\: :ref:`Vector3`, end\: :ref:`Vector3`, t\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`bounce`\ (\ n\: :ref:`Vector3`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`ceil`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`clamp`\ (\ min\: :ref:`Vector3`, max\: :ref:`Vector3`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`cross`\ (\ with\: :ref:`Vector3`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`cubic_interpolate`\ (\ b\: :ref:`Vector3`, pre_a\: :ref:`Vector3`, post_b\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`cubic_interpolate_in_time`\ (\ b\: :ref:`Vector3`, pre_a\: :ref:`Vector3`, post_b\: :ref:`Vector3`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`direction_to`\ (\ to\: :ref:`Vector3`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`distance_squared_to`\ (\ to\: :ref:`Vector3`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`distance_to`\ (\ to\: :ref:`Vector3`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`dot`\ (\ with\: :ref:`Vector3`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`floor`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`inverse`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equal_approx`\ (\ to\: :ref:`Vector3`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_normalized`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_zero_approx`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length_squared`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`lerp`\ (\ to\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`limit_length`\ (\ length\: :ref:`float` = 1.0\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`max_axis_index`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`min_axis_index`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`move_toward`\ (\ to\: :ref:`Vector3`, delta\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`normalized`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`octahedron_decode`\ (\ uv\: :ref:`Vector2`\ ) |static| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`octahedron_encode`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Basis` | :ref:`outer`\ (\ with\: :ref:`Vector3`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`posmod`\ (\ mod\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`posmodv`\ (\ modv\: :ref:`Vector3`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`project`\ (\ b\: :ref:`Vector3`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`reflect`\ (\ n\: :ref:`Vector3`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`rotated`\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`round`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`sign`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`signed_angle_to`\ (\ to\: :ref:`Vector3`, axis\: :ref:`Vector3`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`slerp`\ (\ to\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`slide`\ (\ n\: :ref:`Vector3`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`snapped`\ (\ step\: :ref:`Vector3`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -178,47 +178,47 @@ Operators .. table:: :widths: auto - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Vector3` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator *` **(** :ref:`Basis` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator *` **(** :ref:`Quaternion` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator *` **(** :ref:`Transform3D` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator *` **(** :ref:`Vector3` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator *` **(** :ref:`float` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator *` **(** :ref:`int` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator +` **(** :ref:`Vector3` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator -` **(** :ref:`Vector3` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator /` **(** :ref:`Vector3` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator /` **(** :ref:`float` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator /` **(** :ref:`int` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<` **(** :ref:`Vector3` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<=` **(** :ref:`Vector3` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Vector3` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >` **(** :ref:`Vector3` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >=` **(** :ref:`Vector3` right **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator []` **(** :ref:`int` index **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator unary+` **(** **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator unary-` **(** **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Vector3`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator *`\ (\ right\: :ref:`Basis`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator *`\ (\ right\: :ref:`Quaternion`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator *`\ (\ right\: :ref:`Transform3D`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator *`\ (\ right\: :ref:`Vector3`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator *`\ (\ right\: :ref:`float`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator *`\ (\ right\: :ref:`int`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator +`\ (\ right\: :ref:`Vector3`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator -`\ (\ right\: :ref:`Vector3`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator /`\ (\ right\: :ref:`Vector3`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator /`\ (\ right\: :ref:`float`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator /`\ (\ right\: :ref:`int`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<`\ (\ right\: :ref:`Vector3`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<=`\ (\ right\: :ref:`Vector3`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Vector3`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >`\ (\ right\: :ref:`Vector3`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >=`\ (\ right\: :ref:`Vector3`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator unary+`\ (\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator unary-`\ (\ ) | + +-------------------------------+----------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -427,7 +427,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Vector3` **Vector3** **(** **)** +:ref:`Vector3` **Vector3**\ (\ ) Constructs a default-initialized **Vector3** with all components set to ``0``. @@ -437,7 +437,7 @@ Constructs a default-initialized **Vector3** with all components set to ``0``. .. rst-class:: classref-constructor -:ref:`Vector3` **Vector3** **(** :ref:`Vector3` from **)** +:ref:`Vector3` **Vector3**\ (\ from\: :ref:`Vector3`\ ) Constructs a **Vector3** as a copy of the given **Vector3**. @@ -447,7 +447,7 @@ Constructs a **Vector3** as a copy of the given **Vector3**. .. rst-class:: classref-constructor -:ref:`Vector3` **Vector3** **(** :ref:`Vector3i` from **)** +:ref:`Vector3` **Vector3**\ (\ from\: :ref:`Vector3i`\ ) Constructs a new **Vector3** from :ref:`Vector3i`. @@ -457,7 +457,7 @@ Constructs a new **Vector3** from :ref:`Vector3i`. .. rst-class:: classref-constructor -:ref:`Vector3` **Vector3** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** +:ref:`Vector3` **Vector3**\ (\ x\: :ref:`float`, y\: :ref:`float`, z\: :ref:`float`\ ) Returns a **Vector3** with the given components. @@ -474,7 +474,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3` **abs** **(** **)** |const| +:ref:`Vector3` **abs**\ (\ ) |const| Returns a new vector with all components in absolute values (i.e. positive). @@ -486,7 +486,7 @@ Returns a new vector with all components in absolute values (i.e. positive). .. rst-class:: classref-method -:ref:`float` **angle_to** **(** :ref:`Vector3` to **)** |const| +:ref:`float` **angle_to**\ (\ to\: :ref:`Vector3`\ ) |const| Returns the unsigned minimum angle to the given vector, in radians. @@ -498,7 +498,7 @@ Returns the unsigned minimum angle to the given vector, in radians. .. rst-class:: classref-method -:ref:`Vector3` **bezier_derivative** **(** :ref:`Vector3` control_1, :ref:`Vector3` control_2, :ref:`Vector3` end, :ref:`float` t **)** |const| +:ref:`Vector3` **bezier_derivative**\ (\ control_1\: :ref:`Vector3`, control_2\: :ref:`Vector3`, end\: :ref:`Vector3`, t\: :ref:`float`\ ) |const| Returns the derivative at the given ``t`` on the `Bézier curve `__ defined by this vector and the given ``control_1``, ``control_2``, and ``end`` points. @@ -510,7 +510,7 @@ Returns the derivative at the given ``t`` on the `Bézier curve ` **bezier_interpolate** **(** :ref:`Vector3` control_1, :ref:`Vector3` control_2, :ref:`Vector3` end, :ref:`float` t **)** |const| +:ref:`Vector3` **bezier_interpolate**\ (\ control_1\: :ref:`Vector3`, control_2\: :ref:`Vector3`, end\: :ref:`Vector3`, t\: :ref:`float`\ ) |const| Returns the point at the given ``t`` on the `Bézier curve `__ defined by this vector and the given ``control_1``, ``control_2``, and ``end`` points. @@ -522,7 +522,7 @@ Returns the point at the given ``t`` on the `Bézier curve ` **bounce** **(** :ref:`Vector3` n **)** |const| +:ref:`Vector3` **bounce**\ (\ n\: :ref:`Vector3`\ ) |const| Returns the vector "bounced off" from a plane defined by the given normal. @@ -534,7 +534,7 @@ Returns the vector "bounced off" from a plane defined by the given normal. .. rst-class:: classref-method -:ref:`Vector3` **ceil** **(** **)** |const| +:ref:`Vector3` **ceil**\ (\ ) |const| Returns a new vector with all components rounded up (towards positive infinity). @@ -546,7 +546,7 @@ Returns a new vector with all components rounded up (towards positive infinity). .. rst-class:: classref-method -:ref:`Vector3` **clamp** **(** :ref:`Vector3` min, :ref:`Vector3` max **)** |const| +:ref:`Vector3` **clamp**\ (\ min\: :ref:`Vector3`, max\: :ref:`Vector3`\ ) |const| Returns a new vector with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -558,7 +558,7 @@ Returns a new vector with all components clamped between the components of ``min .. rst-class:: classref-method -:ref:`Vector3` **cross** **(** :ref:`Vector3` with **)** |const| +:ref:`Vector3` **cross**\ (\ with\: :ref:`Vector3`\ ) |const| Returns the cross product of this vector and ``with``. @@ -570,7 +570,7 @@ Returns the cross product of this vector and ``with``. .. rst-class:: classref-method -:ref:`Vector3` **cubic_interpolate** **(** :ref:`Vector3` b, :ref:`Vector3` pre_a, :ref:`Vector3` post_b, :ref:`float` weight **)** |const| +:ref:`Vector3` **cubic_interpolate**\ (\ b\: :ref:`Vector3`, pre_a\: :ref:`Vector3`, post_b\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. @@ -582,7 +582,7 @@ Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and .. rst-class:: classref-method -:ref:`Vector3` **cubic_interpolate_in_time** **(** :ref:`Vector3` b, :ref:`Vector3` pre_a, :ref:`Vector3` post_b, :ref:`float` weight, :ref:`float` b_t, :ref:`float` pre_a_t, :ref:`float` post_b_t **)** |const| +:ref:`Vector3` **cubic_interpolate_in_time**\ (\ b\: :ref:`Vector3`, pre_a\: :ref:`Vector3`, post_b\: :ref:`Vector3`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. @@ -596,7 +596,7 @@ It can perform smoother interpolation than :ref:`cubic_interpolate` **direction_to** **(** :ref:`Vector3` to **)** |const| +:ref:`Vector3` **direction_to**\ (\ to\: :ref:`Vector3`\ ) |const| Returns the normalized vector pointing from this vector to ``to``. This is equivalent to using ``(b - a).normalized()``. @@ -608,7 +608,7 @@ Returns the normalized vector pointing from this vector to ``to``. This is equiv .. rst-class:: classref-method -:ref:`float` **distance_squared_to** **(** :ref:`Vector3` to **)** |const| +:ref:`float` **distance_squared_to**\ (\ to\: :ref:`Vector3`\ ) |const| Returns the squared distance between this vector and ``to``. @@ -622,7 +622,7 @@ This method runs faster than :ref:`distance_to .. rst-class:: classref-method -:ref:`float` **distance_to** **(** :ref:`Vector3` to **)** |const| +:ref:`float` **distance_to**\ (\ to\: :ref:`Vector3`\ ) |const| Returns the distance between this vector and ``to``. @@ -634,7 +634,7 @@ Returns the distance between this vector and ``to``. .. rst-class:: classref-method -:ref:`float` **dot** **(** :ref:`Vector3` with **)** |const| +:ref:`float` **dot**\ (\ with\: :ref:`Vector3`\ ) |const| Returns the dot product of this vector and ``with``. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player. @@ -652,7 +652,7 @@ When using unit (normalized) vectors, the result will always be between ``-1.0`` .. rst-class:: classref-method -:ref:`Vector3` **floor** **(** **)** |const| +:ref:`Vector3` **floor**\ (\ ) |const| Returns a new vector with all components rounded down (towards negative infinity). @@ -664,7 +664,7 @@ Returns a new vector with all components rounded down (towards negative infinity .. rst-class:: classref-method -:ref:`Vector3` **inverse** **(** **)** |const| +:ref:`Vector3` **inverse**\ (\ ) |const| Returns the inverse of the vector. This is the same as ``Vector3(1.0 / v.x, 1.0 / v.y, 1.0 / v.z)``. @@ -676,7 +676,7 @@ Returns the inverse of the vector. This is the same as ``Vector3(1.0 / v.x, 1.0 .. rst-class:: classref-method -:ref:`bool` **is_equal_approx** **(** :ref:`Vector3` to **)** |const| +:ref:`bool` **is_equal_approx**\ (\ to\: :ref:`Vector3`\ ) |const| Returns ``true`` if this vector and ``to`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. @@ -688,7 +688,7 @@ Returns ``true`` if this vector and ``to`` are approximately equal, by running : .. rst-class:: classref-method -:ref:`bool` **is_finite** **(** **)** |const| +:ref:`bool` **is_finite**\ (\ ) |const| Returns ``true`` if this vector is finite, by calling :ref:`@GlobalScope.is_finite` on each component. @@ -700,7 +700,7 @@ Returns ``true`` if this vector is finite, by calling :ref:`@GlobalScope.is_fini .. rst-class:: classref-method -:ref:`bool` **is_normalized** **(** **)** |const| +:ref:`bool` **is_normalized**\ (\ ) |const| Returns ``true`` if the vector is normalized, i.e. its length is approximately equal to 1. @@ -712,7 +712,7 @@ Returns ``true`` if the vector is normalized, i.e. its length is approximately e .. rst-class:: classref-method -:ref:`bool` **is_zero_approx** **(** **)** |const| +:ref:`bool` **is_zero_approx**\ (\ ) |const| Returns ``true`` if this vector's values are approximately zero, by running :ref:`@GlobalScope.is_zero_approx` on each component. @@ -726,7 +726,7 @@ This method is faster than using :ref:`is_equal_approx` **length** **(** **)** |const| +:ref:`float` **length**\ (\ ) |const| Returns the length (magnitude) of this vector. @@ -738,7 +738,7 @@ Returns the length (magnitude) of this vector. .. rst-class:: classref-method -:ref:`float` **length_squared** **(** **)** |const| +:ref:`float` **length_squared**\ (\ ) |const| Returns the squared length (squared magnitude) of this vector. @@ -752,7 +752,7 @@ This method runs faster than :ref:`length`, so pref .. rst-class:: classref-method -:ref:`Vector3` **lerp** **(** :ref:`Vector3` to, :ref:`float` weight **)** |const| +:ref:`Vector3` **lerp**\ (\ to\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| Returns the result of the linear interpolation between this vector and ``to`` by amount ``weight``. ``weight`` is on the range of ``0.0`` to ``1.0``, representing the amount of interpolation. @@ -764,7 +764,7 @@ Returns the result of the linear interpolation between this vector and ``to`` by .. rst-class:: classref-method -:ref:`Vector3` **limit_length** **(** :ref:`float` length=1.0 **)** |const| +:ref:`Vector3` **limit_length**\ (\ length\: :ref:`float` = 1.0\ ) |const| Returns the vector with a maximum length by limiting its length to ``length``. @@ -776,7 +776,7 @@ Returns the vector with a maximum length by limiting its length to ``length``. .. rst-class:: classref-method -:ref:`int` **max_axis_index** **(** **)** |const| +:ref:`int` **max_axis_index**\ (\ ) |const| Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_X`. @@ -788,7 +788,7 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`int` **min_axis_index** **(** **)** |const| +:ref:`int` **min_axis_index**\ (\ ) |const| Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_Z`. @@ -800,7 +800,7 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`Vector3` **move_toward** **(** :ref:`Vector3` to, :ref:`float` delta **)** |const| +:ref:`Vector3` **move_toward**\ (\ to\: :ref:`Vector3`, delta\: :ref:`float`\ ) |const| Returns a new vector moved toward ``to`` by the fixed ``delta`` amount. Will not go past the final value. @@ -812,7 +812,7 @@ Returns a new vector moved toward ``to`` by the fixed ``delta`` amount. Will not .. rst-class:: classref-method -:ref:`Vector3` **normalized** **(** **)** |const| +:ref:`Vector3` **normalized**\ (\ ) |const| Returns the result of scaling the vector to unit length. Equivalent to ``v / v.length()``. See also :ref:`is_normalized`. @@ -826,7 +826,7 @@ Returns the result of scaling the vector to unit length. Equivalent to ``v / v.l .. rst-class:: classref-method -:ref:`Vector3` **octahedron_decode** **(** :ref:`Vector2` uv **)** |static| +:ref:`Vector3` **octahedron_decode**\ (\ uv\: :ref:`Vector2`\ ) |static| Returns the **Vector3** from an octahedral-compressed form created using :ref:`octahedron_encode` (stored as a :ref:`Vector2`). @@ -838,7 +838,7 @@ Returns the **Vector3** from an octahedral-compressed form created using :ref:`o .. rst-class:: classref-method -:ref:`Vector2` **octahedron_encode** **(** **)** |const| +:ref:`Vector2` **octahedron_encode**\ (\ ) |const| Returns the octahedral-encoded (oct32) form of this **Vector3** as a :ref:`Vector2`. Since a :ref:`Vector2` occupies 1/3 less memory compared to **Vector3**, this form of compression can be used to pass greater amounts of :ref:`normalized` **Vector3**\ s without increasing storage or memory requirements. See also :ref:`octahedron_decode`. @@ -854,7 +854,7 @@ Returns the octahedral-encoded (oct32) form of this **Vector3** as a :ref:`Vecto .. rst-class:: classref-method -:ref:`Basis` **outer** **(** :ref:`Vector3` with **)** |const| +:ref:`Basis` **outer**\ (\ with\: :ref:`Vector3`\ ) |const| Returns the outer product with ``with``. @@ -866,7 +866,7 @@ Returns the outer product with ``with``. .. rst-class:: classref-method -:ref:`Vector3` **posmod** **(** :ref:`float` mod **)** |const| +:ref:`Vector3` **posmod**\ (\ mod\: :ref:`float`\ ) |const| Returns a vector composed of the :ref:`@GlobalScope.fposmod` of this vector's components and ``mod``. @@ -878,7 +878,7 @@ Returns a vector composed of the :ref:`@GlobalScope.fposmod` **posmodv** **(** :ref:`Vector3` modv **)** |const| +:ref:`Vector3` **posmodv**\ (\ modv\: :ref:`Vector3`\ ) |const| Returns a vector composed of the :ref:`@GlobalScope.fposmod` of this vector's components and ``modv``'s components. @@ -890,7 +890,7 @@ Returns a vector composed of the :ref:`@GlobalScope.fposmod` **project** **(** :ref:`Vector3` b **)** |const| +:ref:`Vector3` **project**\ (\ b\: :ref:`Vector3`\ ) |const| Returns the result of projecting the vector onto the given vector ``b``. @@ -902,7 +902,7 @@ Returns the result of projecting the vector onto the given vector ``b``. .. rst-class:: classref-method -:ref:`Vector3` **reflect** **(** :ref:`Vector3` n **)** |const| +:ref:`Vector3` **reflect**\ (\ n\: :ref:`Vector3`\ ) |const| Returns the result of reflecting the vector from a plane defined by the given normal ``n``. @@ -914,7 +914,7 @@ Returns the result of reflecting the vector from a plane defined by the given no .. rst-class:: classref-method -:ref:`Vector3` **rotated** **(** :ref:`Vector3` axis, :ref:`float` angle **)** |const| +:ref:`Vector3` **rotated**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) |const| Returns the result of rotating this vector around a given axis by ``angle`` (in radians). The axis must be a normalized vector. See also :ref:`@GlobalScope.deg_to_rad`. @@ -926,7 +926,7 @@ Returns the result of rotating this vector around a given axis by ``angle`` (in .. rst-class:: classref-method -:ref:`Vector3` **round** **(** **)** |const| +:ref:`Vector3` **round**\ (\ ) |const| Returns a new vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. @@ -938,7 +938,7 @@ Returns a new vector with all components rounded to the nearest integer, with ha .. rst-class:: classref-method -:ref:`Vector3` **sign** **(** **)** |const| +:ref:`Vector3` **sign**\ (\ ) |const| Returns a new vector with each component set to ``1.0`` if it's positive, ``-1.0`` if it's negative, and ``0.0`` if it's zero. The result is identical to calling :ref:`@GlobalScope.sign` on each component. @@ -950,7 +950,7 @@ Returns a new vector with each component set to ``1.0`` if it's positive, ``-1.0 .. rst-class:: classref-method -:ref:`float` **signed_angle_to** **(** :ref:`Vector3` to, :ref:`Vector3` axis **)** |const| +:ref:`float` **signed_angle_to**\ (\ to\: :ref:`Vector3`, axis\: :ref:`Vector3`\ ) |const| Returns the signed angle to the given vector, in radians. The sign of the angle is positive in a counter-clockwise direction and negative in a clockwise direction when viewed from the side specified by the ``axis``. @@ -962,7 +962,7 @@ Returns the signed angle to the given vector, in radians. The sign of the angle .. rst-class:: classref-method -:ref:`Vector3` **slerp** **(** :ref:`Vector3` to, :ref:`float` weight **)** |const| +:ref:`Vector3` **slerp**\ (\ to\: :ref:`Vector3`, weight\: :ref:`float`\ ) |const| Returns the result of spherical linear interpolation between this vector and ``to``, by amount ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. @@ -976,7 +976,7 @@ This method also handles interpolating the lengths if the input vectors have dif .. rst-class:: classref-method -:ref:`Vector3` **slide** **(** :ref:`Vector3` n **)** |const| +:ref:`Vector3` **slide**\ (\ n\: :ref:`Vector3`\ ) |const| Returns a new vector slid along a plane defined by the given normal. @@ -988,7 +988,7 @@ Returns a new vector slid along a plane defined by the given normal. .. rst-class:: classref-method -:ref:`Vector3` **snapped** **(** :ref:`Vector3` step **)** |const| +:ref:`Vector3` **snapped**\ (\ step\: :ref:`Vector3`\ ) |const| Returns a new vector with each component snapped to the nearest multiple of the corresponding component in ``step``. This can also be used to round the components to an arbitrary number of decimals. @@ -1005,7 +1005,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Vector3` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Vector3`\ ) Returns ``true`` if the vectors are not equal. @@ -1021,7 +1021,7 @@ Returns ``true`` if the vectors are not equal. .. rst-class:: classref-operator -:ref:`Vector3` **operator *** **(** :ref:`Basis` right **)** +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Basis`\ ) Inversely transforms (multiplies) the **Vector3** by the given :ref:`Basis` matrix, under the assumption that the basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). @@ -1037,7 +1037,7 @@ For transforming by inverse of a non-orthonormal basis (e.g. with scaling) ``bas .. rst-class:: classref-operator -:ref:`Vector3` **operator *** **(** :ref:`Quaternion` right **)** +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Quaternion`\ ) Inversely transforms (multiplies) the **Vector3** by the given :ref:`Quaternion`. @@ -1051,7 +1051,7 @@ Inversely transforms (multiplies) the **Vector3** by the given :ref:`Quaternion< .. rst-class:: classref-operator -:ref:`Vector3` **operator *** **(** :ref:`Transform3D` right **)** +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Transform3D`\ ) Inversely transforms (multiplies) the **Vector3** by the given :ref:`Transform3D` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). @@ -1067,7 +1067,7 @@ For transforming by inverse of an affine transformation (e.g. with scaling) ``tr .. rst-class:: classref-operator -:ref:`Vector3` **operator *** **(** :ref:`Vector3` right **)** +:ref:`Vector3` **operator ***\ (\ right\: :ref:`Vector3`\ ) Multiplies each component of the **Vector3** by the components of the given **Vector3**. @@ -1083,7 +1083,7 @@ Multiplies each component of the **Vector3** by the components of the given **Ve .. rst-class:: classref-operator -:ref:`Vector3` **operator *** **(** :ref:`float` right **)** +:ref:`Vector3` **operator ***\ (\ right\: :ref:`float`\ ) Multiplies each component of the **Vector3** by the given :ref:`float`. @@ -1095,7 +1095,7 @@ Multiplies each component of the **Vector3** by the given :ref:`float` **operator *** **(** :ref:`int` right **)** +:ref:`Vector3` **operator ***\ (\ right\: :ref:`int`\ ) Multiplies each component of the **Vector3** by the given :ref:`int`. @@ -1107,7 +1107,7 @@ Multiplies each component of the **Vector3** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`Vector3` **operator +** **(** :ref:`Vector3` right **)** +:ref:`Vector3` **operator +**\ (\ right\: :ref:`Vector3`\ ) Adds each component of the **Vector3** by the components of the given **Vector3**. @@ -1123,7 +1123,7 @@ Adds each component of the **Vector3** by the components of the given **Vector3* .. rst-class:: classref-operator -:ref:`Vector3` **operator -** **(** :ref:`Vector3` right **)** +:ref:`Vector3` **operator -**\ (\ right\: :ref:`Vector3`\ ) Subtracts each component of the **Vector3** by the components of the given **Vector3**. @@ -1139,7 +1139,7 @@ Subtracts each component of the **Vector3** by the components of the given **Vec .. rst-class:: classref-operator -:ref:`Vector3` **operator /** **(** :ref:`Vector3` right **)** +:ref:`Vector3` **operator /**\ (\ right\: :ref:`Vector3`\ ) Divides each component of the **Vector3** by the components of the given **Vector3**. @@ -1155,7 +1155,7 @@ Divides each component of the **Vector3** by the components of the given **Vecto .. rst-class:: classref-operator -:ref:`Vector3` **operator /** **(** :ref:`float` right **)** +:ref:`Vector3` **operator /**\ (\ right\: :ref:`float`\ ) Divides each component of the **Vector3** by the given :ref:`float`. @@ -1167,7 +1167,7 @@ Divides each component of the **Vector3** by the given :ref:`float` .. rst-class:: classref-operator -:ref:`Vector3` **operator /** **(** :ref:`int` right **)** +:ref:`Vector3` **operator /**\ (\ right\: :ref:`int`\ ) Divides each component of the **Vector3** by the given :ref:`int`. @@ -1179,7 +1179,7 @@ Divides each component of the **Vector3** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`bool` **operator <** **(** :ref:`Vector3` right **)** +:ref:`bool` **operator <**\ (\ right\: :ref:`Vector3`\ ) Compares two **Vector3** vectors by first checking if the X value of the left vector is less than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. @@ -1193,7 +1193,7 @@ Compares two **Vector3** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`bool` **operator <=** **(** :ref:`Vector3` right **)** +:ref:`bool` **operator <=**\ (\ right\: :ref:`Vector3`\ ) Compares two **Vector3** vectors by first checking if the X value of the left vector is less than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. @@ -1207,7 +1207,7 @@ Compares two **Vector3** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`Vector3` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Vector3`\ ) Returns ``true`` if the vectors are exactly equal. @@ -1223,7 +1223,7 @@ Returns ``true`` if the vectors are exactly equal. .. rst-class:: classref-operator -:ref:`bool` **operator >** **(** :ref:`Vector3` right **)** +:ref:`bool` **operator >**\ (\ right\: :ref:`Vector3`\ ) Compares two **Vector3** vectors by first checking if the X value of the left vector is greater than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. @@ -1237,7 +1237,7 @@ Compares two **Vector3** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`bool` **operator >=** **(** :ref:`Vector3` right **)** +:ref:`bool` **operator >=**\ (\ right\: :ref:`Vector3`\ ) Compares two **Vector3** vectors by first checking if the X value of the left vector is greater than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. @@ -1251,7 +1251,7 @@ Compares two **Vector3** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`float` **operator []** **(** :ref:`int` index **)** +:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x``, ``v[1]`` is equivalent to ``v.y``, and ``v[2]`` is equivalent to ``v.z``. @@ -1263,7 +1263,7 @@ Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x` .. rst-class:: classref-operator -:ref:`Vector3` **operator unary+** **(** **)** +:ref:`Vector3` **operator unary+**\ (\ ) Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -1275,7 +1275,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`Vector3` **operator unary-** **(** **)** +:ref:`Vector3` **operator unary-**\ (\ ) Returns the negative value of the **Vector3**. This is the same as writing ``Vector3(-v.x, -v.y, -v.z)``. This operation flips the direction of the vector while keeping the same magnitude. With floats, the number zero can be either positive or negative. @@ -1286,3 +1286,4 @@ Returns the negative value of the **Vector3**. This is the same as writing ``Vec .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_vector3i.rst b/classes/class_vector3i.rst index a881ea5c799..af6fddd604b 100644 --- a/classes/class_vector3i.rst +++ b/classes/class_vector3i.rst @@ -58,15 +58,15 @@ Constructors .. table:: :widths: auto - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`Vector3i` **(** **)** | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`Vector3i` **(** :ref:`Vector3i` from **)** | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`Vector3i` **(** :ref:`Vector3` from **)** | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`Vector3i` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** | - +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`Vector3i`\ (\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`Vector3i`\ (\ from\: :ref:`Vector3i`\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`Vector3i`\ (\ from\: :ref:`Vector3`\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`Vector3i`\ (\ x\: :ref:`int`, y\: :ref:`int`, z\: :ref:`int`\ ) | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -76,27 +76,27 @@ Methods .. table:: :widths: auto - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`abs` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`clamp` **(** :ref:`Vector3i` min, :ref:`Vector3i` max **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`distance_squared_to` **(** :ref:`Vector3i` to **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3i` to **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`length_squared` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`max_axis_index` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`min_axis_index` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`sign` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`snapped` **(** :ref:`Vector3i` step **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`abs`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`clamp`\ (\ min\: :ref:`Vector3i`, max\: :ref:`Vector3i`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`distance_squared_to`\ (\ to\: :ref:`Vector3i`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`distance_to`\ (\ to\: :ref:`Vector3i`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`length_squared`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`max_axis_index`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`min_axis_index`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`sign`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`snapped`\ (\ step\: :ref:`Vector3i`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -106,45 +106,45 @@ Operators .. table:: :widths: auto - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Vector3i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`operator %` **(** :ref:`Vector3i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`operator %` **(** :ref:`int` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`operator *` **(** :ref:`Vector3i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator *` **(** :ref:`float` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`operator *` **(** :ref:`int` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`operator +` **(** :ref:`Vector3i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`operator -` **(** :ref:`Vector3i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`operator /` **(** :ref:`Vector3i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`operator /` **(** :ref:`float` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`operator /` **(** :ref:`int` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<` **(** :ref:`Vector3i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<=` **(** :ref:`Vector3i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Vector3i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >` **(** :ref:`Vector3i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >=` **(** :ref:`Vector3i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator []` **(** :ref:`int` index **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`operator unary+` **(** **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`operator unary-` **(** **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Vector3i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`operator %`\ (\ right\: :ref:`Vector3i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`operator %`\ (\ right\: :ref:`int`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`operator *`\ (\ right\: :ref:`Vector3i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator *`\ (\ right\: :ref:`float`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`operator *`\ (\ right\: :ref:`int`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`operator +`\ (\ right\: :ref:`Vector3i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`operator -`\ (\ right\: :ref:`Vector3i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`operator /`\ (\ right\: :ref:`Vector3i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`operator /`\ (\ right\: :ref:`float`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`operator /`\ (\ right\: :ref:`int`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<`\ (\ right\: :ref:`Vector3i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<=`\ (\ right\: :ref:`Vector3i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Vector3i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >`\ (\ right\: :ref:`Vector3i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >=`\ (\ right\: :ref:`Vector3i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`operator unary+`\ (\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`operator unary-`\ (\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -313,7 +313,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Vector3i` **Vector3i** **(** **)** +:ref:`Vector3i` **Vector3i**\ (\ ) Constructs a default-initialized **Vector3i** with all components set to ``0``. @@ -323,7 +323,7 @@ Constructs a default-initialized **Vector3i** with all components set to ``0``. .. rst-class:: classref-constructor -:ref:`Vector3i` **Vector3i** **(** :ref:`Vector3i` from **)** +:ref:`Vector3i` **Vector3i**\ (\ from\: :ref:`Vector3i`\ ) Constructs a **Vector3i** as a copy of the given **Vector3i**. @@ -333,7 +333,7 @@ Constructs a **Vector3i** as a copy of the given **Vector3i**. .. rst-class:: classref-constructor -:ref:`Vector3i` **Vector3i** **(** :ref:`Vector3` from **)** +:ref:`Vector3i` **Vector3i**\ (\ from\: :ref:`Vector3`\ ) Constructs a new **Vector3i** from the given :ref:`Vector3` by truncating components' fractional parts (rounding towards zero). For a different behavior consider passing the result of :ref:`Vector3.ceil`, :ref:`Vector3.floor` or :ref:`Vector3.round` to this constructor instead. @@ -343,7 +343,7 @@ Constructs a new **Vector3i** from the given :ref:`Vector3` by tr .. rst-class:: classref-constructor -:ref:`Vector3i` **Vector3i** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** +:ref:`Vector3i` **Vector3i**\ (\ x\: :ref:`int`, y\: :ref:`int`, z\: :ref:`int`\ ) Returns a **Vector3i** with the given components. @@ -360,7 +360,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector3i` **abs** **(** **)** |const| +:ref:`Vector3i` **abs**\ (\ ) |const| Returns a new vector with all components in absolute values (i.e. positive). @@ -372,7 +372,7 @@ Returns a new vector with all components in absolute values (i.e. positive). .. rst-class:: classref-method -:ref:`Vector3i` **clamp** **(** :ref:`Vector3i` min, :ref:`Vector3i` max **)** |const| +:ref:`Vector3i` **clamp**\ (\ min\: :ref:`Vector3i`, max\: :ref:`Vector3i`\ ) |const| Returns a new vector with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -384,7 +384,7 @@ Returns a new vector with all components clamped between the components of ``min .. rst-class:: classref-method -:ref:`int` **distance_squared_to** **(** :ref:`Vector3i` to **)** |const| +:ref:`int` **distance_squared_to**\ (\ to\: :ref:`Vector3i`\ ) |const| Returns the squared distance between this vector and ``to``. @@ -398,7 +398,7 @@ This method runs faster than :ref:`distance_to` **distance_to** **(** :ref:`Vector3i` to **)** |const| +:ref:`float` **distance_to**\ (\ to\: :ref:`Vector3i`\ ) |const| Returns the distance between this vector and ``to``. @@ -410,7 +410,7 @@ Returns the distance between this vector and ``to``. .. rst-class:: classref-method -:ref:`float` **length** **(** **)** |const| +:ref:`float` **length**\ (\ ) |const| Returns the length (magnitude) of this vector. @@ -422,7 +422,7 @@ Returns the length (magnitude) of this vector. .. rst-class:: classref-method -:ref:`int` **length_squared** **(** **)** |const| +:ref:`int` **length_squared**\ (\ ) |const| Returns the squared length (squared magnitude) of this vector. @@ -436,7 +436,7 @@ This method runs faster than :ref:`length`, so pre .. rst-class:: classref-method -:ref:`int` **max_axis_index** **(** **)** |const| +:ref:`int` **max_axis_index**\ (\ ) |const| Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_X`. @@ -448,7 +448,7 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`int` **min_axis_index** **(** **)** |const| +:ref:`int` **min_axis_index**\ (\ ) |const| Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_Z`. @@ -460,7 +460,7 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`Vector3i` **sign** **(** **)** |const| +:ref:`Vector3i` **sign**\ (\ ) |const| Returns a new vector with each component set to ``1`` if it's positive, ``-1`` if it's negative, and ``0`` if it's zero. The result is identical to calling :ref:`@GlobalScope.sign` on each component. @@ -472,7 +472,7 @@ Returns a new vector with each component set to ``1`` if it's positive, ``-1`` i .. rst-class:: classref-method -:ref:`Vector3i` **snapped** **(** :ref:`Vector3i` step **)** |const| +:ref:`Vector3i` **snapped**\ (\ step\: :ref:`Vector3i`\ ) |const| Returns a new vector with each component snapped to the closest multiple of the corresponding component in ``step``. @@ -489,7 +489,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Vector3i` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Vector3i`\ ) Returns ``true`` if the vectors are not equal. @@ -501,7 +501,7 @@ Returns ``true`` if the vectors are not equal. .. rst-class:: classref-operator -:ref:`Vector3i` **operator %** **(** :ref:`Vector3i` right **)** +:ref:`Vector3i` **operator %**\ (\ right\: :ref:`Vector3i`\ ) Gets the remainder of each component of the **Vector3i** with the components of the given **Vector3i**. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. @@ -517,7 +517,7 @@ Gets the remainder of each component of the **Vector3i** with the components of .. rst-class:: classref-operator -:ref:`Vector3i` **operator %** **(** :ref:`int` right **)** +:ref:`Vector3i` **operator %**\ (\ right\: :ref:`int`\ ) Gets the remainder of each component of the **Vector3i** with the given :ref:`int`. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. @@ -533,7 +533,7 @@ Gets the remainder of each component of the **Vector3i** with the given :ref:`in .. rst-class:: classref-operator -:ref:`Vector3i` **operator *** **(** :ref:`Vector3i` right **)** +:ref:`Vector3i` **operator ***\ (\ right\: :ref:`Vector3i`\ ) Multiplies each component of the **Vector3i** by the components of the given **Vector3i**. @@ -549,7 +549,7 @@ Multiplies each component of the **Vector3i** by the components of the given **V .. rst-class:: classref-operator -:ref:`Vector3` **operator *** **(** :ref:`float` right **)** +:ref:`Vector3` **operator ***\ (\ right\: :ref:`float`\ ) Multiplies each component of the **Vector3i** by the given :ref:`float`. Returns a :ref:`Vector3`. @@ -565,7 +565,7 @@ Multiplies each component of the **Vector3i** by the given :ref:`float` **operator *** **(** :ref:`int` right **)** +:ref:`Vector3i` **operator ***\ (\ right\: :ref:`int`\ ) Multiplies each component of the **Vector3i** by the given :ref:`int`. @@ -577,7 +577,7 @@ Multiplies each component of the **Vector3i** by the given :ref:`int` .. rst-class:: classref-operator -:ref:`Vector3i` **operator +** **(** :ref:`Vector3i` right **)** +:ref:`Vector3i` **operator +**\ (\ right\: :ref:`Vector3i`\ ) Adds each component of the **Vector3i** by the components of the given **Vector3i**. @@ -593,7 +593,7 @@ Adds each component of the **Vector3i** by the components of the given **Vector3 .. rst-class:: classref-operator -:ref:`Vector3i` **operator -** **(** :ref:`Vector3i` right **)** +:ref:`Vector3i` **operator -**\ (\ right\: :ref:`Vector3i`\ ) Subtracts each component of the **Vector3i** by the components of the given **Vector3i**. @@ -609,7 +609,7 @@ Subtracts each component of the **Vector3i** by the components of the given **Ve .. rst-class:: classref-operator -:ref:`Vector3i` **operator /** **(** :ref:`Vector3i` right **)** +:ref:`Vector3i` **operator /**\ (\ right\: :ref:`Vector3i`\ ) Divides each component of the **Vector3i** by the components of the given **Vector3i**. @@ -625,7 +625,7 @@ Divides each component of the **Vector3i** by the components of the given **Vect .. rst-class:: classref-operator -:ref:`Vector3` **operator /** **(** :ref:`float` right **)** +:ref:`Vector3` **operator /**\ (\ right\: :ref:`float`\ ) Divides each component of the **Vector3i** by the given :ref:`float`. Returns a :ref:`Vector3`. @@ -641,7 +641,7 @@ Divides each component of the **Vector3i** by the given :ref:`float .. rst-class:: classref-operator -:ref:`Vector3i` **operator /** **(** :ref:`int` right **)** +:ref:`Vector3i` **operator /**\ (\ right\: :ref:`int`\ ) Divides each component of the **Vector3i** by the given :ref:`int`. @@ -653,7 +653,7 @@ Divides each component of the **Vector3i** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`bool` **operator <** **(** :ref:`Vector3i` right **)** +:ref:`bool` **operator <**\ (\ right\: :ref:`Vector3i`\ ) Compares two **Vector3i** vectors by first checking if the X value of the left vector is less than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. @@ -665,7 +665,7 @@ Compares two **Vector3i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`bool` **operator <=** **(** :ref:`Vector3i` right **)** +:ref:`bool` **operator <=**\ (\ right\: :ref:`Vector3i`\ ) Compares two **Vector3i** vectors by first checking if the X value of the left vector is less than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. @@ -677,7 +677,7 @@ Compares two **Vector3i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`Vector3i` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Vector3i`\ ) Returns ``true`` if the vectors are equal. @@ -689,7 +689,7 @@ Returns ``true`` if the vectors are equal. .. rst-class:: classref-operator -:ref:`bool` **operator >** **(** :ref:`Vector3i` right **)** +:ref:`bool` **operator >**\ (\ right\: :ref:`Vector3i`\ ) Compares two **Vector3i** vectors by first checking if the X value of the left vector is greater than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. @@ -701,7 +701,7 @@ Compares two **Vector3i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`bool` **operator >=** **(** :ref:`Vector3i` right **)** +:ref:`bool` **operator >=**\ (\ right\: :ref:`Vector3i`\ ) Compares two **Vector3i** vectors by first checking if the X value of the left vector is greater than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. @@ -713,7 +713,7 @@ Compares two **Vector3i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`int` **operator []** **(** :ref:`int` index **)** +:ref:`int` **operator []**\ (\ index\: :ref:`int`\ ) Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x``, ``v[1]`` is equivalent to ``v.y``, and ``v[2]`` is equivalent to ``v.z``. @@ -725,7 +725,7 @@ Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x` .. rst-class:: classref-operator -:ref:`Vector3i` **operator unary+** **(** **)** +:ref:`Vector3i` **operator unary+**\ (\ ) Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -737,7 +737,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`Vector3i` **operator unary-** **(** **)** +:ref:`Vector3i` **operator unary-**\ (\ ) Returns the negative value of the **Vector3i**. This is the same as writing ``Vector3i(-v.x, -v.y, -v.z)``. This operation flips the direction of the vector while keeping the same magnitude. @@ -748,3 +748,4 @@ Returns the negative value of the **Vector3i**. This is the same as writing ``Ve .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_vector4.rst b/classes/class_vector4.rst index 42f97b0b1b6..dba5fafcc14 100644 --- a/classes/class_vector4.rst +++ b/classes/class_vector4.rst @@ -51,15 +51,15 @@ Constructors .. table:: :widths: auto - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`Vector4` **(** **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`Vector4` **(** :ref:`Vector4` from **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`Vector4` **(** :ref:`Vector4i` from **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`Vector4` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`Vector4`\ (\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`Vector4`\ (\ from\: :ref:`Vector4`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`Vector4`\ (\ from\: :ref:`Vector4i`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`Vector4`\ (\ x\: :ref:`float`, y\: :ref:`float`, z\: :ref:`float`, w\: :ref:`float`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -69,59 +69,59 @@ Methods .. table:: :widths: auto - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`abs` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`ceil` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`clamp` **(** :ref:`Vector4` min, :ref:`Vector4` max **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`cubic_interpolate` **(** :ref:`Vector4` b, :ref:`Vector4` pre_a, :ref:`Vector4` post_b, :ref:`float` weight **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`cubic_interpolate_in_time` **(** :ref:`Vector4` b, :ref:`Vector4` pre_a, :ref:`Vector4` post_b, :ref:`float` weight, :ref:`float` b_t, :ref:`float` pre_a_t, :ref:`float` post_b_t **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`direction_to` **(** :ref:`Vector4` to **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`distance_squared_to` **(** :ref:`Vector4` to **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`distance_to` **(** :ref:`Vector4` to **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`dot` **(** :ref:`Vector4` with **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`floor` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`inverse` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Vector4` to **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_finite` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_normalized` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_zero_approx` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length_squared` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`lerp` **(** :ref:`Vector4` to, :ref:`float` weight **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`max_axis_index` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`min_axis_index` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`normalized` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`posmod` **(** :ref:`float` mod **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`posmodv` **(** :ref:`Vector4` modv **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`round` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`sign` **(** **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`snapped` **(** :ref:`Vector4` step **)** |const| | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`abs`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`ceil`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`clamp`\ (\ min\: :ref:`Vector4`, max\: :ref:`Vector4`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`cubic_interpolate`\ (\ b\: :ref:`Vector4`, pre_a\: :ref:`Vector4`, post_b\: :ref:`Vector4`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`cubic_interpolate_in_time`\ (\ b\: :ref:`Vector4`, pre_a\: :ref:`Vector4`, post_b\: :ref:`Vector4`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`direction_to`\ (\ to\: :ref:`Vector4`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`distance_squared_to`\ (\ to\: :ref:`Vector4`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`distance_to`\ (\ to\: :ref:`Vector4`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`dot`\ (\ with\: :ref:`Vector4`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`floor`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`inverse`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equal_approx`\ (\ to\: :ref:`Vector4`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_finite`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_normalized`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_zero_approx`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length_squared`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`lerp`\ (\ to\: :ref:`Vector4`, weight\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`max_axis_index`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`min_axis_index`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`normalized`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`posmod`\ (\ mod\: :ref:`float`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`posmodv`\ (\ modv\: :ref:`Vector4`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`round`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`sign`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`snapped`\ (\ step\: :ref:`Vector4`\ ) |const| | + +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -131,43 +131,43 @@ Operators .. table:: :widths: auto - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Vector4` right **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`operator *` **(** :ref:`Projection` right **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`operator *` **(** :ref:`Vector4` right **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`operator *` **(** :ref:`float` right **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`operator *` **(** :ref:`int` right **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`operator +` **(** :ref:`Vector4` right **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`operator -` **(** :ref:`Vector4` right **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`operator /` **(** :ref:`Vector4` right **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`operator /` **(** :ref:`float` right **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`operator /` **(** :ref:`int` right **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<` **(** :ref:`Vector4` right **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<=` **(** :ref:`Vector4` right **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Vector4` right **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >` **(** :ref:`Vector4` right **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >=` **(** :ref:`Vector4` right **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`operator []` **(** :ref:`int` index **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`operator unary+` **(** **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`operator unary-` **(** **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------+ + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Vector4`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator *`\ (\ right\: :ref:`Projection`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator *`\ (\ right\: :ref:`Vector4`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator *`\ (\ right\: :ref:`float`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator *`\ (\ right\: :ref:`int`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator +`\ (\ right\: :ref:`Vector4`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator -`\ (\ right\: :ref:`Vector4`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator /`\ (\ right\: :ref:`Vector4`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator /`\ (\ right\: :ref:`float`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator /`\ (\ right\: :ref:`int`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<`\ (\ right\: :ref:`Vector4`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<=`\ (\ right\: :ref:`Vector4`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Vector4`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >`\ (\ right\: :ref:`Vector4`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >=`\ (\ right\: :ref:`Vector4`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator unary+`\ (\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator unary-`\ (\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -300,7 +300,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Vector4` **Vector4** **(** **)** +:ref:`Vector4` **Vector4**\ (\ ) Constructs a default-initialized **Vector4** with all components set to ``0``. @@ -310,7 +310,7 @@ Constructs a default-initialized **Vector4** with all components set to ``0``. .. rst-class:: classref-constructor -:ref:`Vector4` **Vector4** **(** :ref:`Vector4` from **)** +:ref:`Vector4` **Vector4**\ (\ from\: :ref:`Vector4`\ ) Constructs a **Vector4** as a copy of the given **Vector4**. @@ -320,7 +320,7 @@ Constructs a **Vector4** as a copy of the given **Vector4**. .. rst-class:: classref-constructor -:ref:`Vector4` **Vector4** **(** :ref:`Vector4i` from **)** +:ref:`Vector4` **Vector4**\ (\ from\: :ref:`Vector4i`\ ) Constructs a new **Vector4** from the given :ref:`Vector4i`. @@ -330,7 +330,7 @@ Constructs a new **Vector4** from the given :ref:`Vector4i`. .. rst-class:: classref-constructor -:ref:`Vector4` **Vector4** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** +:ref:`Vector4` **Vector4**\ (\ x\: :ref:`float`, y\: :ref:`float`, z\: :ref:`float`, w\: :ref:`float`\ ) Returns a **Vector4** with the given components. @@ -347,7 +347,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector4` **abs** **(** **)** |const| +:ref:`Vector4` **abs**\ (\ ) |const| Returns a new vector with all components in absolute values (i.e. positive). @@ -359,7 +359,7 @@ Returns a new vector with all components in absolute values (i.e. positive). .. rst-class:: classref-method -:ref:`Vector4` **ceil** **(** **)** |const| +:ref:`Vector4` **ceil**\ (\ ) |const| Returns a new vector with all components rounded up (towards positive infinity). @@ -371,7 +371,7 @@ Returns a new vector with all components rounded up (towards positive infinity). .. rst-class:: classref-method -:ref:`Vector4` **clamp** **(** :ref:`Vector4` min, :ref:`Vector4` max **)** |const| +:ref:`Vector4` **clamp**\ (\ min\: :ref:`Vector4`, max\: :ref:`Vector4`\ ) |const| Returns a new vector with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -383,7 +383,7 @@ Returns a new vector with all components clamped between the components of ``min .. rst-class:: classref-method -:ref:`Vector4` **cubic_interpolate** **(** :ref:`Vector4` b, :ref:`Vector4` pre_a, :ref:`Vector4` post_b, :ref:`float` weight **)** |const| +:ref:`Vector4` **cubic_interpolate**\ (\ b\: :ref:`Vector4`, pre_a\: :ref:`Vector4`, post_b\: :ref:`Vector4`, weight\: :ref:`float`\ ) |const| Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. @@ -395,7 +395,7 @@ Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and .. rst-class:: classref-method -:ref:`Vector4` **cubic_interpolate_in_time** **(** :ref:`Vector4` b, :ref:`Vector4` pre_a, :ref:`Vector4` post_b, :ref:`float` weight, :ref:`float` b_t, :ref:`float` pre_a_t, :ref:`float` post_b_t **)** |const| +:ref:`Vector4` **cubic_interpolate_in_time**\ (\ b\: :ref:`Vector4`, pre_a\: :ref:`Vector4`, post_b\: :ref:`Vector4`, weight\: :ref:`float`, b_t\: :ref:`float`, pre_a_t\: :ref:`float`, post_b_t\: :ref:`float`\ ) |const| Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. @@ -409,7 +409,7 @@ It can perform smoother interpolation than :ref:`cubic_interpolate` **direction_to** **(** :ref:`Vector4` to **)** |const| +:ref:`Vector4` **direction_to**\ (\ to\: :ref:`Vector4`\ ) |const| Returns the normalized vector pointing from this vector to ``to``. This is equivalent to using ``(b - a).normalized()``. @@ -421,7 +421,7 @@ Returns the normalized vector pointing from this vector to ``to``. This is equiv .. rst-class:: classref-method -:ref:`float` **distance_squared_to** **(** :ref:`Vector4` to **)** |const| +:ref:`float` **distance_squared_to**\ (\ to\: :ref:`Vector4`\ ) |const| Returns the squared distance between this vector and ``to``. @@ -435,7 +435,7 @@ This method runs faster than :ref:`distance_to .. rst-class:: classref-method -:ref:`float` **distance_to** **(** :ref:`Vector4` to **)** |const| +:ref:`float` **distance_to**\ (\ to\: :ref:`Vector4`\ ) |const| Returns the distance between this vector and ``to``. @@ -447,7 +447,7 @@ Returns the distance between this vector and ``to``. .. rst-class:: classref-method -:ref:`float` **dot** **(** :ref:`Vector4` with **)** |const| +:ref:`float` **dot**\ (\ with\: :ref:`Vector4`\ ) |const| Returns the dot product of this vector and ``with``. @@ -459,7 +459,7 @@ Returns the dot product of this vector and ``with``. .. rst-class:: classref-method -:ref:`Vector4` **floor** **(** **)** |const| +:ref:`Vector4` **floor**\ (\ ) |const| Returns a new vector with all components rounded down (towards negative infinity). @@ -471,7 +471,7 @@ Returns a new vector with all components rounded down (towards negative infinity .. rst-class:: classref-method -:ref:`Vector4` **inverse** **(** **)** |const| +:ref:`Vector4` **inverse**\ (\ ) |const| Returns the inverse of the vector. This is the same as ``Vector4(1.0 / v.x, 1.0 / v.y, 1.0 / v.z, 1.0 / v.w)``. @@ -483,7 +483,7 @@ Returns the inverse of the vector. This is the same as ``Vector4(1.0 / v.x, 1.0 .. rst-class:: classref-method -:ref:`bool` **is_equal_approx** **(** :ref:`Vector4` to **)** |const| +:ref:`bool` **is_equal_approx**\ (\ to\: :ref:`Vector4`\ ) |const| Returns ``true`` if this vector and ``to`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. @@ -495,7 +495,7 @@ Returns ``true`` if this vector and ``to`` are approximately equal, by running : .. rst-class:: classref-method -:ref:`bool` **is_finite** **(** **)** |const| +:ref:`bool` **is_finite**\ (\ ) |const| Returns ``true`` if this vector is finite, by calling :ref:`@GlobalScope.is_finite` on each component. @@ -507,7 +507,7 @@ Returns ``true`` if this vector is finite, by calling :ref:`@GlobalScope.is_fini .. rst-class:: classref-method -:ref:`bool` **is_normalized** **(** **)** |const| +:ref:`bool` **is_normalized**\ (\ ) |const| Returns ``true`` if the vector is normalized, i.e. its length is approximately equal to 1. @@ -519,7 +519,7 @@ Returns ``true`` if the vector is normalized, i.e. its length is approximately e .. rst-class:: classref-method -:ref:`bool` **is_zero_approx** **(** **)** |const| +:ref:`bool` **is_zero_approx**\ (\ ) |const| Returns ``true`` if this vector's values are approximately zero, by running :ref:`@GlobalScope.is_zero_approx` on each component. @@ -533,7 +533,7 @@ This method is faster than using :ref:`is_equal_approx` **length** **(** **)** |const| +:ref:`float` **length**\ (\ ) |const| Returns the length (magnitude) of this vector. @@ -545,7 +545,7 @@ Returns the length (magnitude) of this vector. .. rst-class:: classref-method -:ref:`float` **length_squared** **(** **)** |const| +:ref:`float` **length_squared**\ (\ ) |const| Returns the squared length (squared magnitude) of this vector. @@ -559,7 +559,7 @@ This method runs faster than :ref:`length`, so pref .. rst-class:: classref-method -:ref:`Vector4` **lerp** **(** :ref:`Vector4` to, :ref:`float` weight **)** |const| +:ref:`Vector4` **lerp**\ (\ to\: :ref:`Vector4`, weight\: :ref:`float`\ ) |const| Returns the result of the linear interpolation between this vector and ``to`` by amount ``weight``. ``weight`` is on the range of ``0.0`` to ``1.0``, representing the amount of interpolation. @@ -571,7 +571,7 @@ Returns the result of the linear interpolation between this vector and ``to`` by .. rst-class:: classref-method -:ref:`int` **max_axis_index** **(** **)** |const| +:ref:`int` **max_axis_index**\ (\ ) |const| Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_X`. @@ -583,7 +583,7 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`int` **min_axis_index** **(** **)** |const| +:ref:`int` **min_axis_index**\ (\ ) |const| Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_W`. @@ -595,7 +595,7 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`Vector4` **normalized** **(** **)** |const| +:ref:`Vector4` **normalized**\ (\ ) |const| Returns the result of scaling the vector to unit length. Equivalent to ``v / v.length()``. See also :ref:`is_normalized`. @@ -609,7 +609,7 @@ Returns the result of scaling the vector to unit length. Equivalent to ``v / v.l .. rst-class:: classref-method -:ref:`Vector4` **posmod** **(** :ref:`float` mod **)** |const| +:ref:`Vector4` **posmod**\ (\ mod\: :ref:`float`\ ) |const| Returns a vector composed of the :ref:`@GlobalScope.fposmod` of this vector's components and ``mod``. @@ -621,7 +621,7 @@ Returns a vector composed of the :ref:`@GlobalScope.fposmod` **posmodv** **(** :ref:`Vector4` modv **)** |const| +:ref:`Vector4` **posmodv**\ (\ modv\: :ref:`Vector4`\ ) |const| Returns a vector composed of the :ref:`@GlobalScope.fposmod` of this vector's components and ``modv``'s components. @@ -633,7 +633,7 @@ Returns a vector composed of the :ref:`@GlobalScope.fposmod` **round** **(** **)** |const| +:ref:`Vector4` **round**\ (\ ) |const| Returns a new vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. @@ -645,7 +645,7 @@ Returns a new vector with all components rounded to the nearest integer, with ha .. rst-class:: classref-method -:ref:`Vector4` **sign** **(** **)** |const| +:ref:`Vector4` **sign**\ (\ ) |const| Returns a new vector with each component set to ``1.0`` if it's positive, ``-1.0`` if it's negative, and ``0.0`` if it's zero. The result is identical to calling :ref:`@GlobalScope.sign` on each component. @@ -657,7 +657,7 @@ Returns a new vector with each component set to ``1.0`` if it's positive, ``-1.0 .. rst-class:: classref-method -:ref:`Vector4` **snapped** **(** :ref:`Vector4` step **)** |const| +:ref:`Vector4` **snapped**\ (\ step\: :ref:`Vector4`\ ) |const| Returns a new vector with each component snapped to the nearest multiple of the corresponding component in ``step``. This can also be used to round the components to an arbitrary number of decimals. @@ -674,7 +674,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Vector4` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Vector4`\ ) Returns ``true`` if the vectors are not equal. @@ -690,7 +690,7 @@ Returns ``true`` if the vectors are not equal. .. rst-class:: classref-operator -:ref:`Vector4` **operator *** **(** :ref:`Projection` right **)** +:ref:`Vector4` **operator ***\ (\ right\: :ref:`Projection`\ ) Transforms (multiplies) the **Vector4** by the transpose of the given :ref:`Projection` matrix. @@ -704,7 +704,7 @@ For transforming by inverse of a projection ``projection.inverse() * vector`` ca .. rst-class:: classref-operator -:ref:`Vector4` **operator *** **(** :ref:`Vector4` right **)** +:ref:`Vector4` **operator ***\ (\ right\: :ref:`Vector4`\ ) Multiplies each component of the **Vector4** by the components of the given **Vector4**. @@ -720,7 +720,7 @@ Multiplies each component of the **Vector4** by the components of the given **Ve .. rst-class:: classref-operator -:ref:`Vector4` **operator *** **(** :ref:`float` right **)** +:ref:`Vector4` **operator ***\ (\ right\: :ref:`float`\ ) Multiplies each component of the **Vector4** by the given :ref:`float`. @@ -736,7 +736,7 @@ Multiplies each component of the **Vector4** by the given :ref:`float` **operator *** **(** :ref:`int` right **)** +:ref:`Vector4` **operator ***\ (\ right\: :ref:`int`\ ) Multiplies each component of the **Vector4** by the given :ref:`int`. @@ -748,7 +748,7 @@ Multiplies each component of the **Vector4** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`Vector4` **operator +** **(** :ref:`Vector4` right **)** +:ref:`Vector4` **operator +**\ (\ right\: :ref:`Vector4`\ ) Adds each component of the **Vector4** by the components of the given **Vector4**. @@ -764,7 +764,7 @@ Adds each component of the **Vector4** by the components of the given **Vector4* .. rst-class:: classref-operator -:ref:`Vector4` **operator -** **(** :ref:`Vector4` right **)** +:ref:`Vector4` **operator -**\ (\ right\: :ref:`Vector4`\ ) Subtracts each component of the **Vector4** by the components of the given **Vector4**. @@ -780,7 +780,7 @@ Subtracts each component of the **Vector4** by the components of the given **Vec .. rst-class:: classref-operator -:ref:`Vector4` **operator /** **(** :ref:`Vector4` right **)** +:ref:`Vector4` **operator /**\ (\ right\: :ref:`Vector4`\ ) Divides each component of the **Vector4** by the components of the given **Vector4**. @@ -796,7 +796,7 @@ Divides each component of the **Vector4** by the components of the given **Vecto .. rst-class:: classref-operator -:ref:`Vector4` **operator /** **(** :ref:`float` right **)** +:ref:`Vector4` **operator /**\ (\ right\: :ref:`float`\ ) Divides each component of the **Vector4** by the given :ref:`float`. @@ -812,7 +812,7 @@ Divides each component of the **Vector4** by the given :ref:`float` .. rst-class:: classref-operator -:ref:`Vector4` **operator /** **(** :ref:`int` right **)** +:ref:`Vector4` **operator /**\ (\ right\: :ref:`int`\ ) Divides each component of the **Vector4** by the given :ref:`int`. @@ -824,7 +824,7 @@ Divides each component of the **Vector4** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`bool` **operator <** **(** :ref:`Vector4` right **)** +:ref:`bool` **operator <**\ (\ right\: :ref:`Vector4`\ ) Compares two **Vector4** vectors by first checking if the X value of the left vector is less than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. @@ -838,7 +838,7 @@ Compares two **Vector4** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`bool` **operator <=** **(** :ref:`Vector4` right **)** +:ref:`bool` **operator <=**\ (\ right\: :ref:`Vector4`\ ) Compares two **Vector4** vectors by first checking if the X value of the left vector is less than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. @@ -852,7 +852,7 @@ Compares two **Vector4** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`Vector4` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Vector4`\ ) Returns ``true`` if the vectors are exactly equal. @@ -868,7 +868,7 @@ Returns ``true`` if the vectors are exactly equal. .. rst-class:: classref-operator -:ref:`bool` **operator >** **(** :ref:`Vector4` right **)** +:ref:`bool` **operator >**\ (\ right\: :ref:`Vector4`\ ) Compares two **Vector4** vectors by first checking if the X value of the left vector is greater than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. @@ -882,7 +882,7 @@ Compares two **Vector4** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`bool` **operator >=** **(** :ref:`Vector4` right **)** +:ref:`bool` **operator >=**\ (\ right\: :ref:`Vector4`\ ) Compares two **Vector4** vectors by first checking if the X value of the left vector is greater than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. @@ -896,7 +896,7 @@ Compares two **Vector4** vectors by first checking if the X value of the left ve .. rst-class:: classref-operator -:ref:`float` **operator []** **(** :ref:`int` index **)** +:ref:`float` **operator []**\ (\ index\: :ref:`int`\ ) Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x``, ``v[1]`` is equivalent to ``v.y``, ``v[2]`` is equivalent to ``v.z``, and ``v[3]`` is equivalent to ``v.w``. @@ -908,7 +908,7 @@ Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x` .. rst-class:: classref-operator -:ref:`Vector4` **operator unary+** **(** **)** +:ref:`Vector4` **operator unary+**\ (\ ) Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -920,7 +920,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`Vector4` **operator unary-** **(** **)** +:ref:`Vector4` **operator unary-**\ (\ ) Returns the negative value of the **Vector4**. This is the same as writing ``Vector4(-v.x, -v.y, -v.z, -v.w)``. This operation flips the direction of the vector while keeping the same magnitude. With floats, the number zero can be either positive or negative. @@ -931,3 +931,4 @@ Returns the negative value of the **Vector4**. This is the same as writing ``Vec .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_vector4i.rst b/classes/class_vector4i.rst index 4a26815ac30..91b138f113b 100644 --- a/classes/class_vector4i.rst +++ b/classes/class_vector4i.rst @@ -49,15 +49,15 @@ Constructors .. table:: :widths: auto - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`Vector4i` **(** **)** | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`Vector4i` **(** :ref:`Vector4i` from **)** | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`Vector4i` **(** :ref:`Vector4` from **)** | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`Vector4i` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` w **)** | - +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`Vector4i`\ (\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`Vector4i`\ (\ from\: :ref:`Vector4i`\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`Vector4i`\ (\ from\: :ref:`Vector4`\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`Vector4i`\ (\ x\: :ref:`int`, y\: :ref:`int`, z\: :ref:`int`, w\: :ref:`int`\ ) | + +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -67,27 +67,27 @@ Methods .. table:: :widths: auto - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`abs` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`clamp` **(** :ref:`Vector4i` min, :ref:`Vector4i` max **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`distance_squared_to` **(** :ref:`Vector4i` to **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`distance_to` **(** :ref:`Vector4i` to **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`length` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`length_squared` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`max_axis_index` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`min_axis_index` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`sign` **(** **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`snapped` **(** :ref:`Vector4i` step **)** |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`abs`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`clamp`\ (\ min\: :ref:`Vector4i`, max\: :ref:`Vector4i`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`distance_squared_to`\ (\ to\: :ref:`Vector4i`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`distance_to`\ (\ to\: :ref:`Vector4i`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`length`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`length_squared`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`max_axis_index`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`min_axis_index`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`sign`\ (\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`snapped`\ (\ step\: :ref:`Vector4i`\ ) |const| | + +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -97,45 +97,45 @@ Operators .. table:: :widths: auto - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator !=` **(** :ref:`Vector4i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`operator %` **(** :ref:`Vector4i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`operator %` **(** :ref:`int` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`operator *` **(** :ref:`Vector4i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`operator *` **(** :ref:`float` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`operator *` **(** :ref:`int` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`operator +` **(** :ref:`Vector4i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`operator -` **(** :ref:`Vector4i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`operator /` **(** :ref:`Vector4i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4` | :ref:`operator /` **(** :ref:`float` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`operator /` **(** :ref:`int` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<` **(** :ref:`Vector4i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator \<=` **(** :ref:`Vector4i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator ==` **(** :ref:`Vector4i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >` **(** :ref:`Vector4i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`operator >=` **(** :ref:`Vector4i` right **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`operator []` **(** :ref:`int` index **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`operator unary+` **(** **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector4i` | :ref:`operator unary-` **(** **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------+ + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator !=`\ (\ right\: :ref:`Vector4i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`operator %`\ (\ right\: :ref:`Vector4i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`operator %`\ (\ right\: :ref:`int`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`operator *`\ (\ right\: :ref:`Vector4i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator *`\ (\ right\: :ref:`float`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`operator *`\ (\ right\: :ref:`int`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`operator +`\ (\ right\: :ref:`Vector4i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`operator -`\ (\ right\: :ref:`Vector4i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`operator /`\ (\ right\: :ref:`Vector4i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4` | :ref:`operator /`\ (\ right\: :ref:`float`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`operator /`\ (\ right\: :ref:`int`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<`\ (\ right\: :ref:`Vector4i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator \<=`\ (\ right\: :ref:`Vector4i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator ==`\ (\ right\: :ref:`Vector4i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >`\ (\ right\: :ref:`Vector4i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`operator >=`\ (\ right\: :ref:`Vector4i`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`operator []`\ (\ index\: :ref:`int`\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`operator unary+`\ (\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Vector4i` | :ref:`operator unary-`\ (\ ) | + +---------------------------------+----------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -276,7 +276,7 @@ Constructor Descriptions .. rst-class:: classref-constructor -:ref:`Vector4i` **Vector4i** **(** **)** +:ref:`Vector4i` **Vector4i**\ (\ ) Constructs a default-initialized **Vector4i** with all components set to ``0``. @@ -286,7 +286,7 @@ Constructs a default-initialized **Vector4i** with all components set to ``0``. .. rst-class:: classref-constructor -:ref:`Vector4i` **Vector4i** **(** :ref:`Vector4i` from **)** +:ref:`Vector4i` **Vector4i**\ (\ from\: :ref:`Vector4i`\ ) Constructs a **Vector4i** as a copy of the given **Vector4i**. @@ -296,7 +296,7 @@ Constructs a **Vector4i** as a copy of the given **Vector4i**. .. rst-class:: classref-constructor -:ref:`Vector4i` **Vector4i** **(** :ref:`Vector4` from **)** +:ref:`Vector4i` **Vector4i**\ (\ from\: :ref:`Vector4`\ ) Constructs a new **Vector4i** from the given :ref:`Vector4` by truncating components' fractional parts (rounding towards zero). For a different behavior consider passing the result of :ref:`Vector4.ceil`, :ref:`Vector4.floor` or :ref:`Vector4.round` to this constructor instead. @@ -306,7 +306,7 @@ Constructs a new **Vector4i** from the given :ref:`Vector4` by tr .. rst-class:: classref-constructor -:ref:`Vector4i` **Vector4i** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` w **)** +:ref:`Vector4i` **Vector4i**\ (\ x\: :ref:`int`, y\: :ref:`int`, z\: :ref:`int`, w\: :ref:`int`\ ) Returns a **Vector4i** with the given components. @@ -323,7 +323,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector4i` **abs** **(** **)** |const| +:ref:`Vector4i` **abs**\ (\ ) |const| Returns a new vector with all components in absolute values (i.e. positive). @@ -335,7 +335,7 @@ Returns a new vector with all components in absolute values (i.e. positive). .. rst-class:: classref-method -:ref:`Vector4i` **clamp** **(** :ref:`Vector4i` min, :ref:`Vector4i` max **)** |const| +:ref:`Vector4i` **clamp**\ (\ min\: :ref:`Vector4i`, max\: :ref:`Vector4i`\ ) |const| Returns a new vector with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. @@ -347,7 +347,7 @@ Returns a new vector with all components clamped between the components of ``min .. rst-class:: classref-method -:ref:`int` **distance_squared_to** **(** :ref:`Vector4i` to **)** |const| +:ref:`int` **distance_squared_to**\ (\ to\: :ref:`Vector4i`\ ) |const| Returns the squared distance between this vector and ``to``. @@ -361,7 +361,7 @@ This method runs faster than :ref:`distance_to` **distance_to** **(** :ref:`Vector4i` to **)** |const| +:ref:`float` **distance_to**\ (\ to\: :ref:`Vector4i`\ ) |const| Returns the distance between this vector and ``to``. @@ -373,7 +373,7 @@ Returns the distance between this vector and ``to``. .. rst-class:: classref-method -:ref:`float` **length** **(** **)** |const| +:ref:`float` **length**\ (\ ) |const| Returns the length (magnitude) of this vector. @@ -385,7 +385,7 @@ Returns the length (magnitude) of this vector. .. rst-class:: classref-method -:ref:`int` **length_squared** **(** **)** |const| +:ref:`int` **length_squared**\ (\ ) |const| Returns the squared length (squared magnitude) of this vector. @@ -399,7 +399,7 @@ This method runs faster than :ref:`length`, so pre .. rst-class:: classref-method -:ref:`int` **max_axis_index** **(** **)** |const| +:ref:`int` **max_axis_index**\ (\ ) |const| Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_X`. @@ -411,7 +411,7 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`int` **min_axis_index** **(** **)** |const| +:ref:`int` **min_axis_index**\ (\ ) |const| Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_W`. @@ -423,7 +423,7 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all .. rst-class:: classref-method -:ref:`Vector4i` **sign** **(** **)** |const| +:ref:`Vector4i` **sign**\ (\ ) |const| Returns a new vector with each component set to ``1`` if it's positive, ``-1`` if it's negative, and ``0`` if it's zero. The result is identical to calling :ref:`@GlobalScope.sign` on each component. @@ -435,7 +435,7 @@ Returns a new vector with each component set to ``1`` if it's positive, ``-1`` i .. rst-class:: classref-method -:ref:`Vector4i` **snapped** **(** :ref:`Vector4i` step **)** |const| +:ref:`Vector4i` **snapped**\ (\ step\: :ref:`Vector4i`\ ) |const| Returns a new vector with each component snapped to the closest multiple of the corresponding component in ``step``. @@ -452,7 +452,7 @@ Operator Descriptions .. rst-class:: classref-operator -:ref:`bool` **operator !=** **(** :ref:`Vector4i` right **)** +:ref:`bool` **operator !=**\ (\ right\: :ref:`Vector4i`\ ) Returns ``true`` if the vectors are not equal. @@ -464,7 +464,7 @@ Returns ``true`` if the vectors are not equal. .. rst-class:: classref-operator -:ref:`Vector4i` **operator %** **(** :ref:`Vector4i` right **)** +:ref:`Vector4i` **operator %**\ (\ right\: :ref:`Vector4i`\ ) Gets the remainder of each component of the **Vector4i** with the components of the given **Vector4i**. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. @@ -480,7 +480,7 @@ Gets the remainder of each component of the **Vector4i** with the components of .. rst-class:: classref-operator -:ref:`Vector4i` **operator %** **(** :ref:`int` right **)** +:ref:`Vector4i` **operator %**\ (\ right\: :ref:`int`\ ) Gets the remainder of each component of the **Vector4i** with the the given :ref:`int`. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. @@ -496,7 +496,7 @@ Gets the remainder of each component of the **Vector4i** with the the given :ref .. rst-class:: classref-operator -:ref:`Vector4i` **operator *** **(** :ref:`Vector4i` right **)** +:ref:`Vector4i` **operator ***\ (\ right\: :ref:`Vector4i`\ ) Multiplies each component of the **Vector4i** by the components of the given **Vector4i**. @@ -512,7 +512,7 @@ Multiplies each component of the **Vector4i** by the components of the given **V .. rst-class:: classref-operator -:ref:`Vector4` **operator *** **(** :ref:`float` right **)** +:ref:`Vector4` **operator ***\ (\ right\: :ref:`float`\ ) Multiplies each component of the **Vector4i** by the given :ref:`float`. @@ -530,7 +530,7 @@ Returns a Vector4 value due to floating-point operations. .. rst-class:: classref-operator -:ref:`Vector4i` **operator *** **(** :ref:`int` right **)** +:ref:`Vector4i` **operator ***\ (\ right\: :ref:`int`\ ) Multiplies each component of the **Vector4i** by the given :ref:`int`. @@ -542,7 +542,7 @@ Multiplies each component of the **Vector4i** by the given :ref:`int` .. rst-class:: classref-operator -:ref:`Vector4i` **operator +** **(** :ref:`Vector4i` right **)** +:ref:`Vector4i` **operator +**\ (\ right\: :ref:`Vector4i`\ ) Adds each component of the **Vector4i** by the components of the given **Vector4i**. @@ -558,7 +558,7 @@ Adds each component of the **Vector4i** by the components of the given **Vector4 .. rst-class:: classref-operator -:ref:`Vector4i` **operator -** **(** :ref:`Vector4i` right **)** +:ref:`Vector4i` **operator -**\ (\ right\: :ref:`Vector4i`\ ) Subtracts each component of the **Vector4i** by the components of the given **Vector4i**. @@ -574,7 +574,7 @@ Subtracts each component of the **Vector4i** by the components of the given **Ve .. rst-class:: classref-operator -:ref:`Vector4i` **operator /** **(** :ref:`Vector4i` right **)** +:ref:`Vector4i` **operator /**\ (\ right\: :ref:`Vector4i`\ ) Divides each component of the **Vector4i** by the components of the given **Vector4i**. @@ -590,7 +590,7 @@ Divides each component of the **Vector4i** by the components of the given **Vect .. rst-class:: classref-operator -:ref:`Vector4` **operator /** **(** :ref:`float` right **)** +:ref:`Vector4` **operator /**\ (\ right\: :ref:`float`\ ) Divides each component of the **Vector4i** by the given :ref:`float`. @@ -608,7 +608,7 @@ Returns a Vector4 value due to floating-point operations. .. rst-class:: classref-operator -:ref:`Vector4i` **operator /** **(** :ref:`int` right **)** +:ref:`Vector4i` **operator /**\ (\ right\: :ref:`int`\ ) Divides each component of the **Vector4i** by the given :ref:`int`. @@ -620,7 +620,7 @@ Divides each component of the **Vector4i** by the given :ref:`int`. .. rst-class:: classref-operator -:ref:`bool` **operator <** **(** :ref:`Vector4i` right **)** +:ref:`bool` **operator <**\ (\ right\: :ref:`Vector4i`\ ) Compares two **Vector4i** vectors by first checking if the X value of the left vector is less than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. @@ -632,7 +632,7 @@ Compares two **Vector4i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`bool` **operator <=** **(** :ref:`Vector4i` right **)** +:ref:`bool` **operator <=**\ (\ right\: :ref:`Vector4i`\ ) Compares two **Vector4i** vectors by first checking if the X value of the left vector is less than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. @@ -644,7 +644,7 @@ Compares two **Vector4i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`bool` **operator ==** **(** :ref:`Vector4i` right **)** +:ref:`bool` **operator ==**\ (\ right\: :ref:`Vector4i`\ ) Returns ``true`` if the vectors are exactly equal. @@ -656,7 +656,7 @@ Returns ``true`` if the vectors are exactly equal. .. rst-class:: classref-operator -:ref:`bool` **operator >** **(** :ref:`Vector4i` right **)** +:ref:`bool` **operator >**\ (\ right\: :ref:`Vector4i`\ ) Compares two **Vector4i** vectors by first checking if the X value of the left vector is greater than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. @@ -668,7 +668,7 @@ Compares two **Vector4i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`bool` **operator >=** **(** :ref:`Vector4i` right **)** +:ref:`bool` **operator >=**\ (\ right\: :ref:`Vector4i`\ ) Compares two **Vector4i** vectors by first checking if the X value of the left vector is greater than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. @@ -680,7 +680,7 @@ Compares two **Vector4i** vectors by first checking if the X value of the left v .. rst-class:: classref-operator -:ref:`int` **operator []** **(** :ref:`int` index **)** +:ref:`int` **operator []**\ (\ index\: :ref:`int`\ ) Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x``, ``v[1]`` is equivalent to ``v.y``, ``v[2]`` is equivalent to ``v.z``, and ``v[3]`` is equivalent to ``v.w``. @@ -692,7 +692,7 @@ Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x` .. rst-class:: classref-operator -:ref:`Vector4i` **operator unary+** **(** **)** +:ref:`Vector4i` **operator unary+**\ (\ ) Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. @@ -704,7 +704,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, .. rst-class:: classref-operator -:ref:`Vector4i` **operator unary-** **(** **)** +:ref:`Vector4i` **operator unary-**\ (\ ) Returns the negative value of the **Vector4i**. This is the same as writing ``Vector4i(-v.x, -v.y, -v.z, -v.w)``. This operation flips the direction of the vector while keeping the same magnitude. @@ -715,3 +715,4 @@ Returns the negative value of the **Vector4i**. This is the same as writing ``Ve .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_vehiclebody3d.rst b/classes/class_vehiclebody3d.rst index 76f77ca8430..cbd02afe97b 100644 --- a/classes/class_vehiclebody3d.rst +++ b/classes/class_vehiclebody3d.rst @@ -67,8 +67,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_brake** **(** :ref:`float` value **)** -- :ref:`float` **get_brake** **(** **)** +- |void| **set_brake**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_brake**\ (\ ) Slows down the vehicle by applying a braking force. The vehicle is only slowed down if the wheels are in contact with a surface. The force you need to apply to adequately slow down your vehicle depends on the :ref:`RigidBody3D.mass` of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 30 range for hard braking. @@ -84,8 +84,8 @@ Slows down the vehicle by applying a braking force. The vehicle is only slowed d .. rst-class:: classref-property-setget -- void **set_engine_force** **(** :ref:`float` value **)** -- :ref:`float` **get_engine_force** **(** **)** +- |void| **set_engine_force**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_engine_force**\ (\ ) Accelerates the vehicle by applying an engine force. The vehicle is only sped up if the wheels that have :ref:`VehicleWheel3D.use_as_traction` set to ``true`` and are in contact with a surface. The :ref:`RigidBody3D.mass` of the vehicle has an effect on the acceleration of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 50 range for acceleration. @@ -105,8 +105,8 @@ A negative value will result in the vehicle reversing. .. rst-class:: classref-property-setget -- void **set_steering** **(** :ref:`float` value **)** -- :ref:`float` **get_steering** **(** **)** +- |void| **set_steering**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_steering**\ (\ ) The steering angle for the vehicle. Setting this to a non-zero value will result in the vehicle turning when it's moving. Wheels that have :ref:`VehicleWheel3D.use_as_steering` set to ``true`` will automatically be rotated. @@ -119,3 +119,4 @@ The steering angle for the vehicle. Setting this to a non-zero value will result .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_vehiclewheel3d.rst b/classes/class_vehiclewheel3d.rst index 5ae487e5e56..16ffdeb294f 100644 --- a/classes/class_vehiclewheel3d.rst +++ b/classes/class_vehiclewheel3d.rst @@ -76,15 +76,15 @@ Methods .. table:: :widths: auto - +-----------------------------+-------------------------------------------------------------------------------------------+ - | :ref:`Node3D` | :ref:`get_contact_body` **(** **)** |const| | - +-----------------------------+-------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_rpm` **(** **)** |const| | - +-----------------------------+-------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_skidinfo` **(** **)** |const| | - +-----------------------------+-------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_in_contact` **(** **)** |const| | - +-----------------------------+-------------------------------------------------------------------------------------------+ + +-----------------------------+-------------------------------------------------------------------------------------+ + | :ref:`Node3D` | :ref:`get_contact_body`\ (\ ) |const| | + +-----------------------------+-------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_rpm`\ (\ ) |const| | + +-----------------------------+-------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_skidinfo`\ (\ ) |const| | + +-----------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_in_contact`\ (\ ) |const| | + +-----------------------------+-------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -103,8 +103,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_brake** **(** :ref:`float` value **)** -- :ref:`float` **get_brake** **(** **)** +- |void| **set_brake**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_brake**\ (\ ) Slows down the wheel by applying a braking force. The wheel is only slowed down if it is in contact with a surface. The force you need to apply to adequately slow down your vehicle depends on the :ref:`RigidBody3D.mass` of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 30 range for hard braking. @@ -120,8 +120,8 @@ Slows down the wheel by applying a braking force. The wheel is only slowed down .. rst-class:: classref-property-setget -- void **set_damping_compression** **(** :ref:`float` value **)** -- :ref:`float` **get_damping_compression** **(** **)** +- |void| **set_damping_compression**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_damping_compression**\ (\ ) The damping applied to the spring when the spring is being compressed. This value should be between 0.0 (no damping) and 1.0. A value of 0.0 means the car will keep bouncing as the spring keeps its energy. A good value for this is around 0.3 for a normal car, 0.5 for a race car. @@ -137,8 +137,8 @@ The damping applied to the spring when the spring is being compressed. This valu .. rst-class:: classref-property-setget -- void **set_damping_relaxation** **(** :ref:`float` value **)** -- :ref:`float` **get_damping_relaxation** **(** **)** +- |void| **set_damping_relaxation**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_damping_relaxation**\ (\ ) The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slightly higher than the :ref:`damping_compression` property. For a :ref:`damping_compression` value of 0.3, try a relaxation value of 0.5. @@ -154,8 +154,8 @@ The damping applied to the spring when relaxing. This value should be between 0. .. rst-class:: classref-property-setget -- void **set_engine_force** **(** :ref:`float` value **)** -- :ref:`float` **get_engine_force** **(** **)** +- |void| **set_engine_force**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_engine_force**\ (\ ) Accelerates the wheel by applying an engine force. The wheel is only sped up if it is in contact with a surface. The :ref:`RigidBody3D.mass` of the vehicle has an effect on the acceleration of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 50 range for acceleration. @@ -175,8 +175,8 @@ A negative value will result in the wheel reversing. .. rst-class:: classref-property-setget -- void **set_steering** **(** :ref:`float` value **)** -- :ref:`float` **get_steering** **(** **)** +- |void| **set_steering**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_steering**\ (\ ) The steering angle for the wheel, in radians. Setting this to a non-zero value will result in the vehicle turning when it's moving. @@ -192,8 +192,8 @@ The steering angle for the wheel, in radians. Setting this to a non-zero value w .. rst-class:: classref-property-setget -- void **set_suspension_max_force** **(** :ref:`float` value **)** -- :ref:`float` **get_suspension_max_force** **(** **)** +- |void| **set_suspension_max_force**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_suspension_max_force**\ (\ ) The maximum force the spring can resist. This value should be higher than a quarter of the :ref:`RigidBody3D.mass` of the :ref:`VehicleBody3D` or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3× to 4× this number. @@ -209,8 +209,8 @@ The maximum force the spring can resist. This value should be higher than a quar .. rst-class:: classref-property-setget -- void **set_suspension_stiffness** **(** :ref:`float` value **)** -- :ref:`float` **get_suspension_stiffness** **(** **)** +- |void| **set_suspension_stiffness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_suspension_stiffness**\ (\ ) This value defines the stiffness of the suspension. Use a value lower than 50 for an off-road car, a value between 50 and 100 for a race car and try something around 200 for something like a Formula 1 car. @@ -226,8 +226,8 @@ This value defines the stiffness of the suspension. Use a value lower than 50 fo .. rst-class:: classref-property-setget -- void **set_suspension_travel** **(** :ref:`float` value **)** -- :ref:`float` **get_suspension_travel** **(** **)** +- |void| **set_suspension_travel**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_suspension_travel**\ (\ ) This is the distance the suspension can travel. As Godot units are equivalent to meters, keep this setting relatively low. Try a value between 0.1 and 0.3 depending on the type of car. @@ -243,8 +243,8 @@ This is the distance the suspension can travel. As Godot units are equivalent to .. rst-class:: classref-property-setget -- void **set_use_as_steering** **(** :ref:`bool` value **)** -- :ref:`bool` **is_used_as_steering** **(** **)** +- |void| **set_use_as_steering**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_used_as_steering**\ (\ ) If ``true``, this wheel will be turned when the car steers. This value is used in conjunction with :ref:`VehicleBody3D.steering` and ignored if you are using the per-wheel :ref:`steering` value instead. @@ -260,8 +260,8 @@ If ``true``, this wheel will be turned when the car steers. This value is used i .. rst-class:: classref-property-setget -- void **set_use_as_traction** **(** :ref:`bool` value **)** -- :ref:`bool` **is_used_as_traction** **(** **)** +- |void| **set_use_as_traction**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_used_as_traction**\ (\ ) If ``true``, this wheel transfers engine force to the ground to propel the vehicle forward. This value is used in conjunction with :ref:`VehicleBody3D.engine_force` and ignored if you are using the per-wheel :ref:`engine_force` value instead. @@ -277,8 +277,8 @@ If ``true``, this wheel transfers engine force to the ground to propel the vehic .. rst-class:: classref-property-setget -- void **set_friction_slip** **(** :ref:`float` value **)** -- :ref:`float` **get_friction_slip** **(** **)** +- |void| **set_friction_slip**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_friction_slip**\ (\ ) This determines how much grip this wheel has. It is combined with the friction setting of the surface the wheel is in contact with. 0.0 means no grip, 1.0 is normal grip. For a drift car setup, try setting the grip of the rear wheels slightly lower than the front wheels, or use a lower value to simulate tire wear. @@ -296,8 +296,8 @@ It's best to set this to 1.0 when starting out. .. rst-class:: classref-property-setget -- void **set_radius** **(** :ref:`float` value **)** -- :ref:`float` **get_radius** **(** **)** +- |void| **set_radius**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_radius**\ (\ ) The radius of the wheel in meters. @@ -313,8 +313,8 @@ The radius of the wheel in meters. .. rst-class:: classref-property-setget -- void **set_suspension_rest_length** **(** :ref:`float` value **)** -- :ref:`float` **get_suspension_rest_length** **(** **)** +- |void| **set_suspension_rest_length**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_suspension_rest_length**\ (\ ) This is the distance in meters the wheel is lowered from its origin point. Don't set this to 0.0 and move the wheel into position, instead move the origin point of your wheel (the gizmo in Godot) to the position the wheel will take when bottoming out, then use the rest length to move the wheel down to the position it should be in when the car is in rest. @@ -330,8 +330,8 @@ This is the distance in meters the wheel is lowered from its origin point. Don't .. rst-class:: classref-property-setget -- void **set_roll_influence** **(** :ref:`float` value **)** -- :ref:`float` **get_roll_influence** **(** **)** +- |void| **set_roll_influence**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_roll_influence**\ (\ ) 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. @@ -348,7 +348,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Node3D` **get_contact_body** **(** **)** |const| +:ref:`Node3D` **get_contact_body**\ (\ ) |const| Returns the contacting body node if valid in the tree, as :ref:`Node3D`. At the moment, :ref:`GridMap` is not supported so the node will be always of type :ref:`PhysicsBody3D`. @@ -362,7 +362,7 @@ Returns ``null`` if the wheel is not in contact with a surface, or the contact b .. rst-class:: classref-method -:ref:`float` **get_rpm** **(** **)** |const| +:ref:`float` **get_rpm**\ (\ ) |const| Returns the rotational speed of the wheel in revolutions per minute. @@ -374,7 +374,7 @@ Returns the rotational speed of the wheel in revolutions per minute. .. rst-class:: classref-method -:ref:`float` **get_skidinfo** **(** **)** |const| +:ref:`float` **get_skidinfo**\ (\ ) |const| Returns a value between 0.0 and 1.0 that indicates whether this wheel is skidding. 0.0 is skidding (the wheel has lost grip, e.g. icy terrain), 1.0 means not skidding (the wheel has full grip, e.g. dry asphalt road). @@ -386,7 +386,7 @@ Returns a value between 0.0 and 1.0 that indicates whether this wheel is skiddin .. rst-class:: classref-method -:ref:`bool` **is_in_contact** **(** **)** |const| +:ref:`bool` **is_in_contact**\ (\ ) |const| Returns ``true`` if this wheel is in contact with a surface. @@ -397,3 +397,4 @@ Returns ``true`` if this wheel is in contact with a surface. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_vflowcontainer.rst b/classes/class_vflowcontainer.rst index 0e53a2ec43d..4651100f7c0 100644 --- a/classes/class_vflowcontainer.rst +++ b/classes/class_vflowcontainer.rst @@ -35,3 +35,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_videostream.rst b/classes/class_videostream.rst index f024deadd14..de78ae31f2e 100644 --- a/classes/class_videostream.rst +++ b/classes/class_videostream.rst @@ -52,9 +52,9 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ - | :ref:`VideoStreamPlayback` | :ref:`_instantiate_playback` **(** **)** |virtual| | - +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------+ + | :ref:`VideoStreamPlayback` | :ref:`_instantiate_playback`\ (\ ) |virtual| | + +-------------------------------------------------------+------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -73,8 +73,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_file** **(** :ref:`String` value **)** -- :ref:`String` **get_file** **(** **)** +- |void| **set_file**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_file**\ (\ ) The video file path or URI that this **VideoStream** resource handles. @@ -93,7 +93,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`VideoStreamPlayback` **_instantiate_playback** **(** **)** |virtual| +:ref:`VideoStreamPlayback` **_instantiate_playback**\ (\ ) |virtual| Called when the video starts playing, to initialize and return a subclass of :ref:`VideoStreamPlayback`. @@ -104,3 +104,4 @@ Called when the video starts playing, to initialize and return a subclass of :re .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_videostreamplayback.rst b/classes/class_videostreamplayback.rst index 4b777b2a0fd..6c418975a04 100644 --- a/classes/class_videostreamplayback.rst +++ b/classes/class_videostreamplayback.rst @@ -29,35 +29,35 @@ Methods .. table:: :widths: auto - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_channels` **(** **)** |virtual| |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_length` **(** **)** |virtual| |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_mix_rate` **(** **)** |virtual| |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`_get_playback_position` **(** **)** |virtual| |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`_get_texture` **(** **)** |virtual| |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_paused` **(** **)** |virtual| |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_playing` **(** **)** |virtual| |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_play` **(** **)** |virtual| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_seek` **(** :ref:`float` time **)** |virtual| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_audio_track` **(** :ref:`int` idx **)** |virtual| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_paused` **(** :ref:`bool` paused **)** |virtual| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_stop` **(** **)** |virtual| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_update` **(** :ref:`float` delta **)** |virtual| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`mix_audio` **(** :ref:`int` num_frames, :ref:`PackedFloat32Array` buffer=PackedFloat32Array(), :ref:`int` offset=0 **)** | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_channels`\ (\ ) |virtual| |const| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_length`\ (\ ) |virtual| |const| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_mix_rate`\ (\ ) |virtual| |const| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`_get_playback_position`\ (\ ) |virtual| |const| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`_get_texture`\ (\ ) |virtual| |const| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_paused`\ (\ ) |virtual| |const| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_playing`\ (\ ) |virtual| |const| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_play`\ (\ ) |virtual| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_seek`\ (\ time\: :ref:`float`\ ) |virtual| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_audio_track`\ (\ idx\: :ref:`int`\ ) |virtual| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_paused`\ (\ paused\: :ref:`bool`\ ) |virtual| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_stop`\ (\ ) |virtual| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_update`\ (\ delta\: :ref:`float`\ ) |virtual| | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`mix_audio`\ (\ num_frames\: :ref:`int`, buffer\: :ref:`PackedFloat32Array` = PackedFloat32Array(), offset\: :ref:`int` = 0\ ) | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -72,7 +72,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`int` **_get_channels** **(** **)** |virtual| |const| +:ref:`int` **_get_channels**\ (\ ) |virtual| |const| Returns the number of audio channels. @@ -84,7 +84,7 @@ Returns the number of audio channels. .. rst-class:: classref-method -:ref:`float` **_get_length** **(** **)** |virtual| |const| +:ref:`float` **_get_length**\ (\ ) |virtual| |const| Returns the video duration in seconds, if known, or 0 if unknown. @@ -96,7 +96,7 @@ Returns the video duration in seconds, if known, or 0 if unknown. .. rst-class:: classref-method -:ref:`int` **_get_mix_rate** **(** **)** |virtual| |const| +:ref:`int` **_get_mix_rate**\ (\ ) |virtual| |const| Returns the audio sample rate used for mixing. @@ -108,7 +108,7 @@ Returns the audio sample rate used for mixing. .. rst-class:: classref-method -:ref:`float` **_get_playback_position** **(** **)** |virtual| |const| +:ref:`float` **_get_playback_position**\ (\ ) |virtual| |const| Return the current playback timestamp. Called in response to the :ref:`VideoStreamPlayer.stream_position` getter. @@ -120,7 +120,7 @@ Return the current playback timestamp. Called in response to the :ref:`VideoStre .. rst-class:: classref-method -:ref:`Texture2D` **_get_texture** **(** **)** |virtual| |const| +:ref:`Texture2D` **_get_texture**\ (\ ) |virtual| |const| Allocates a :ref:`Texture2D` in which decoded video frames will be drawn. @@ -132,7 +132,7 @@ Allocates a :ref:`Texture2D` in which decoded video frames will .. rst-class:: classref-method -:ref:`bool` **_is_paused** **(** **)** |virtual| |const| +:ref:`bool` **_is_paused**\ (\ ) |virtual| |const| Returns the paused status, as set by :ref:`_set_paused`. @@ -144,7 +144,7 @@ Returns the paused status, as set by :ref:`_set_paused` **_is_playing** **(** **)** |virtual| |const| +:ref:`bool` **_is_playing**\ (\ ) |virtual| |const| Returns the playback state, as determined by calls to :ref:`_play` and :ref:`_stop`. @@ -156,7 +156,7 @@ Returns the playback state, as determined by calls to :ref:`_play` or :ref:`VideoStreamPlayer.play`. Note that manual playback may also invoke :ref:`_stop` multiple times before this method is called. :ref:`_is_playing` should return true once playing. @@ -168,7 +168,7 @@ Called in response to :ref:`VideoStreamPlayer.autoplay` time **)** |virtual| +|void| **_seek**\ (\ time\: :ref:`float`\ ) |virtual| Seeks to ``time`` seconds. Called in response to the :ref:`VideoStreamPlayer.stream_position` setter. @@ -180,7 +180,7 @@ Seeks to ``time`` seconds. Called in response to the :ref:`VideoStreamPlayer.str .. rst-class:: classref-method -void **_set_audio_track** **(** :ref:`int` idx **)** |virtual| +|void| **_set_audio_track**\ (\ idx\: :ref:`int`\ ) |virtual| Select the audio track ``idx``. Called when playback starts, and in response to the :ref:`VideoStreamPlayer.audio_track` setter. @@ -192,7 +192,7 @@ Select the audio track ``idx``. Called when playback starts, and in response to .. rst-class:: classref-method -void **_set_paused** **(** :ref:`bool` paused **)** |virtual| +|void| **_set_paused**\ (\ paused\: :ref:`bool`\ ) |virtual| Set the paused status of video playback. :ref:`_is_paused` must return ``paused``. Called in response to the :ref:`VideoStreamPlayer.paused` setter. @@ -204,7 +204,7 @@ Set the paused status of video playback. :ref:`_is_paused`, or in response to :ref:`VideoStreamPlayer.stop`. :ref:`_is_playing` should return false once stopped. @@ -216,7 +216,7 @@ Stops playback. May be called multiple times before :ref:`_play` delta **)** |virtual| +|void| **_update**\ (\ delta\: :ref:`float`\ ) |virtual| Ticks video playback for ``delta`` seconds. Called every frame as long as :ref:`_is_paused` and :ref:`_is_playing` return true. @@ -228,7 +228,7 @@ Ticks video playback for ``delta`` seconds. Called every frame as long as :ref:` .. rst-class:: classref-method -:ref:`int` **mix_audio** **(** :ref:`int` num_frames, :ref:`PackedFloat32Array` buffer=PackedFloat32Array(), :ref:`int` offset=0 **)** +:ref:`int` **mix_audio**\ (\ num_frames\: :ref:`int`, buffer\: :ref:`PackedFloat32Array` = PackedFloat32Array(), offset\: :ref:`int` = 0\ ) Render ``num_frames`` audio frames (of :ref:`_get_channels` floats each) from ``buffer``, starting from index ``offset`` in the array. Returns the number of audio frames rendered, or -1 on error. @@ -239,3 +239,4 @@ Render ``num_frames`` audio frames (of :ref:`_get_channels` | :ref:`get_stream_length` **(** **)** |const| | - +-----------------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_stream_name` **(** **)** |const| | - +-----------------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_video_texture` **(** **)** |const| | - +-----------------------------------+------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_playing` **(** **)** |const| | - +-----------------------------------+------------------------------------------------------------------------------------------------+ - | void | :ref:`play` **(** **)** | - +-----------------------------------+------------------------------------------------------------------------------------------------+ - | void | :ref:`stop` **(** **)** | - +-----------------------------------+------------------------------------------------------------------------------------------------+ + +-----------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_stream_length`\ (\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_stream_name`\ (\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_video_texture`\ (\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_playing`\ (\ ) |const| | + +-----------------------------------+------------------------------------------------------------------------------------------+ + | |void| | :ref:`play`\ (\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------+ + | |void| | :ref:`stop`\ (\ ) | + +-----------------------------------+------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -99,7 +99,7 @@ Signals .. rst-class:: classref-signal -**finished** **(** **)** +**finished**\ (\ ) Emitted when playback is finished. @@ -120,8 +120,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_audio_track** **(** :ref:`int` value **)** -- :ref:`int` **get_audio_track** **(** **)** +- |void| **set_audio_track**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_audio_track**\ (\ ) The embedded audio track to play. @@ -137,8 +137,8 @@ The embedded audio track to play. .. rst-class:: classref-property-setget -- void **set_autoplay** **(** :ref:`bool` value **)** -- :ref:`bool` **has_autoplay** **(** **)** +- |void| **set_autoplay**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **has_autoplay**\ (\ ) If ``true``, playback starts when the scene loads. @@ -154,8 +154,8 @@ If ``true``, playback starts when the scene loads. .. rst-class:: classref-property-setget -- void **set_buffering_msec** **(** :ref:`int` value **)** -- :ref:`int` **get_buffering_msec** **(** **)** +- |void| **set_buffering_msec**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_buffering_msec**\ (\ ) Amount of time in milliseconds to store in buffer while playing. @@ -171,8 +171,8 @@ Amount of time in milliseconds to store in buffer while playing. .. rst-class:: classref-property-setget -- void **set_bus** **(** :ref:`StringName` value **)** -- :ref:`StringName` **get_bus** **(** **)** +- |void| **set_bus**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_bus**\ (\ ) Audio bus to use for sound playback. @@ -188,8 +188,8 @@ Audio bus to use for sound playback. .. rst-class:: classref-property-setget -- void **set_expand** **(** :ref:`bool` value **)** -- :ref:`bool` **has_expand** **(** **)** +- |void| **set_expand**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **has_expand**\ (\ ) If ``true``, the video scales to the control size. Otherwise, the control minimum size will be automatically adjusted to match the video stream's dimensions. @@ -205,8 +205,8 @@ If ``true``, the video scales to the control size. Otherwise, the control minimu .. rst-class:: classref-property-setget -- void **set_loop** **(** :ref:`bool` value **)** -- :ref:`bool` **has_loop** **(** **)** +- |void| **set_loop**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **has_loop**\ (\ ) If ``true``, the video restarts when it reaches its end. @@ -222,8 +222,8 @@ If ``true``, the video restarts when it reaches its end. .. rst-class:: classref-property-setget -- void **set_paused** **(** :ref:`bool` value **)** -- :ref:`bool` **is_paused** **(** **)** +- |void| **set_paused**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_paused**\ (\ ) If ``true``, the video is paused. @@ -239,8 +239,8 @@ If ``true``, the video is paused. .. rst-class:: classref-property-setget -- void **set_stream** **(** :ref:`VideoStream` value **)** -- :ref:`VideoStream` **get_stream** **(** **)** +- |void| **set_stream**\ (\ value\: :ref:`VideoStream`\ ) +- :ref:`VideoStream` **get_stream**\ (\ ) The assigned video stream. See description for supported formats. @@ -256,8 +256,8 @@ The assigned video stream. See description for supported formats. .. rst-class:: classref-property-setget -- void **set_stream_position** **(** :ref:`float` value **)** -- :ref:`float` **get_stream_position** **(** **)** +- |void| **set_stream_position**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_stream_position**\ (\ ) The current position of the stream, in seconds. @@ -275,8 +275,8 @@ The current position of the stream, in seconds. .. rst-class:: classref-property-setget -- void **set_volume** **(** :ref:`float` value **)** -- :ref:`float` **get_volume** **(** **)** +- |void| **set_volume**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_volume**\ (\ ) Audio volume as a linear value. @@ -292,8 +292,8 @@ Audio volume as a linear value. .. rst-class:: classref-property-setget -- void **set_volume_db** **(** :ref:`float` value **)** -- :ref:`float` **get_volume_db** **(** **)** +- |void| **set_volume_db**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_volume_db**\ (\ ) Audio volume in dB. @@ -310,7 +310,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`float` **get_stream_length** **(** **)** |const| +:ref:`float` **get_stream_length**\ (\ ) |const| The length of the current stream, in seconds. @@ -324,7 +324,7 @@ The length of the current stream, in seconds. .. rst-class:: classref-method -:ref:`String` **get_stream_name** **(** **)** |const| +:ref:`String` **get_stream_name**\ (\ ) |const| Returns the video stream's name, or ``""`` if no video stream is assigned. @@ -336,7 +336,7 @@ Returns the video stream's name, or ``""`` if no video stream is assi .. rst-class:: classref-method -:ref:`Texture2D` **get_video_texture** **(** **)** |const| +:ref:`Texture2D` **get_video_texture**\ (\ ) |const| Returns the current frame as a :ref:`Texture2D`. @@ -348,7 +348,7 @@ Returns the current frame as a :ref:`Texture2D`. .. rst-class:: classref-method -:ref:`bool` **is_playing** **(** **)** |const| +:ref:`bool` **is_playing**\ (\ ) |const| Returns ``true`` if the video is playing. @@ -362,7 +362,7 @@ Returns ``true`` if the video is playing. .. rst-class:: classref-method -void **play** **(** **)** +|void| **play**\ (\ ) Starts the video playback from the beginning. If the video is paused, this will not unpause the video. @@ -374,7 +374,7 @@ Starts the video playback from the beginning. If the video is paused, this will .. rst-class:: classref-method -void **stop** **(** **)** +|void| **stop**\ (\ ) Stops the video playback and sets the stream position to 0. @@ -387,3 +387,4 @@ Stops the video playback and sets the stream position to 0. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_videostreamtheora.rst b/classes/class_videostreamtheora.rst index 75b54240914..b331e03888d 100644 --- a/classes/class_videostreamtheora.rst +++ b/classes/class_videostreamtheora.rst @@ -30,3 +30,4 @@ Description .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 2a47816917a..d0c64b47b18 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -160,65 +160,65 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`World2D` | :ref:`find_world_2d` **(** **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`World3D` | :ref:`find_world_3d` **(** **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Camera2D` | :ref:`get_camera_2d` **(** **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Camera3D` | :ref:`get_camera_3d` **(** **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_canvas_cull_mask_bit` **(** :ref:`int` layer **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Window[]` | :ref:`get_embedded_subwindows` **(** **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_final_transform` **(** **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_mouse_position` **(** **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PositionalShadowAtlasQuadrantSubdiv` | :ref:`get_positional_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_render_info` **(** :ref:`RenderInfoType` type, :ref:`RenderInfo` info **)** | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform2D` | :ref:`get_screen_transform` **(** **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ViewportTexture` | :ref:`get_texture` **(** **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_viewport_rid` **(** **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_visible_rect` **(** **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Control` | :ref:`gui_get_focus_owner` **(** **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Control` | :ref:`gui_get_hovered_control` **(** **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`gui_is_drag_successful` **(** **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`gui_is_dragging` **(** **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`gui_release_focus` **(** **)** | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_input_handled` **(** **)** |const| | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_input` **(** :ref:`InputEvent` event, :ref:`bool` in_local_coords=false **)** | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_text_input` **(** :ref:`String` text **)** | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`push_unhandled_input` **(** :ref:`InputEvent` event, :ref:`bool` in_local_coords=false **)** | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_canvas_cull_mask_bit` **(** :ref:`int` layer, :ref:`bool` enable **)** | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_input_as_handled` **(** **)** | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_positional_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant, :ref:`PositionalShadowAtlasQuadrantSubdiv` subdiv **)** | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`update_mouse_cursor_state` **(** **)** | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`warp_mouse` **(** :ref:`Vector2` position **)** | - +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`World2D` | :ref:`find_world_2d`\ (\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`World3D` | :ref:`find_world_3d`\ (\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Camera2D` | :ref:`get_camera_2d`\ (\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Camera3D` | :ref:`get_camera_3d`\ (\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_canvas_cull_mask_bit`\ (\ layer\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Window`\] | :ref:`get_embedded_subwindows`\ (\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_final_transform`\ (\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_mouse_position`\ (\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PositionalShadowAtlasQuadrantSubdiv` | :ref:`get_positional_shadow_atlas_quadrant_subdiv`\ (\ quadrant\: :ref:`int`\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_render_info`\ (\ type\: :ref:`RenderInfoType`, info\: :ref:`RenderInfo`\ ) | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`get_screen_transform`\ (\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ViewportTexture` | :ref:`get_texture`\ (\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_viewport_rid`\ (\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_visible_rect`\ (\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`gui_get_drag_data`\ (\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Control` | :ref:`gui_get_focus_owner`\ (\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Control` | :ref:`gui_get_hovered_control`\ (\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`gui_is_drag_successful`\ (\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`gui_is_dragging`\ (\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`gui_release_focus`\ (\ ) | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_input_handled`\ (\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_input`\ (\ event\: :ref:`InputEvent`, in_local_coords\: :ref:`bool` = false\ ) | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_text_input`\ (\ text\: :ref:`String`\ ) | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`push_unhandled_input`\ (\ event\: :ref:`InputEvent`, in_local_coords\: :ref:`bool` = false\ ) | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_canvas_cull_mask_bit`\ (\ layer\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_input_as_handled`\ (\ ) | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_positional_shadow_atlas_quadrant_subdiv`\ (\ quadrant\: :ref:`int`, subdiv\: :ref:`PositionalShadowAtlasQuadrantSubdiv`\ ) | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`update_mouse_cursor_state`\ (\ ) | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`warp_mouse`\ (\ position\: :ref:`Vector2`\ ) | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -233,7 +233,7 @@ Signals .. rst-class:: classref-signal -**gui_focus_changed** **(** :ref:`Control` node **)** +**gui_focus_changed**\ (\ node\: :ref:`Control`\ ) Emitted when a Control node grabs keyboard focus. @@ -245,7 +245,7 @@ Emitted when a Control node grabs keyboard focus. .. rst-class:: classref-signal -**size_changed** **(** **)** +**size_changed**\ (\ ) Emitted when the size of the viewport is changed, whether by resizing of window, or some other means. @@ -1103,8 +1103,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_as_audio_listener_2d** **(** :ref:`bool` value **)** -- :ref:`bool` **is_audio_listener_2d** **(** **)** +- |void| **set_as_audio_listener_2d**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_audio_listener_2d**\ (\ ) If ``true``, the viewport will process 2D audio streams. @@ -1120,8 +1120,8 @@ If ``true``, the viewport will process 2D audio streams. .. rst-class:: classref-property-setget -- void **set_as_audio_listener_3d** **(** :ref:`bool` value **)** -- :ref:`bool` **is_audio_listener_3d** **(** **)** +- |void| **set_as_audio_listener_3d**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_audio_listener_3d**\ (\ ) If ``true``, the viewport will process 3D audio streams. @@ -1137,8 +1137,8 @@ If ``true``, the viewport will process 3D audio streams. .. rst-class:: classref-property-setget -- void **set_canvas_cull_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_canvas_cull_mask** **(** **)** +- |void| **set_canvas_cull_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_canvas_cull_mask**\ (\ ) The rendering layers in which this **Viewport** renders :ref:`CanvasItem` nodes. @@ -1154,8 +1154,8 @@ The rendering layers in which this **Viewport** renders :ref:`CanvasItem` value **)** -- :ref:`DefaultCanvasItemTextureFilter` **get_default_canvas_item_texture_filter** **(** **)** +- |void| **set_default_canvas_item_texture_filter**\ (\ value\: :ref:`DefaultCanvasItemTextureFilter`\ ) +- :ref:`DefaultCanvasItemTextureFilter` **get_default_canvas_item_texture_filter**\ (\ ) Sets the default filter mode used by :ref:`CanvasItem`\ s in this Viewport. See :ref:`DefaultCanvasItemTextureFilter` for options. @@ -1171,8 +1171,8 @@ Sets the default filter mode used by :ref:`CanvasItem`\ s in t .. rst-class:: classref-property-setget -- void **set_default_canvas_item_texture_repeat** **(** :ref:`DefaultCanvasItemTextureRepeat` value **)** -- :ref:`DefaultCanvasItemTextureRepeat` **get_default_canvas_item_texture_repeat** **(** **)** +- |void| **set_default_canvas_item_texture_repeat**\ (\ value\: :ref:`DefaultCanvasItemTextureRepeat`\ ) +- :ref:`DefaultCanvasItemTextureRepeat` **get_default_canvas_item_texture_repeat**\ (\ ) Sets the default repeat mode used by :ref:`CanvasItem`\ s in this Viewport. See :ref:`DefaultCanvasItemTextureRepeat` for options. @@ -1188,8 +1188,8 @@ Sets the default repeat mode used by :ref:`CanvasItem`\ s in t .. rst-class:: classref-property-setget -- void **set_canvas_transform** **(** :ref:`Transform2D` value **)** -- :ref:`Transform2D` **get_canvas_transform** **(** **)** +- |void| **set_canvas_transform**\ (\ value\: :ref:`Transform2D`\ ) +- :ref:`Transform2D` **get_canvas_transform**\ (\ ) The canvas transform of the viewport, useful for changing the on-screen positions of all child :ref:`CanvasItem`\ s. This is relative to the global canvas transform of the viewport. @@ -1205,8 +1205,8 @@ The canvas transform of the viewport, useful for changing the on-screen position .. rst-class:: classref-property-setget -- void **set_debug_draw** **(** :ref:`DebugDraw` value **)** -- :ref:`DebugDraw` **get_debug_draw** **(** **)** +- |void| **set_debug_draw**\ (\ value\: :ref:`DebugDraw`\ ) +- :ref:`DebugDraw` **get_debug_draw**\ (\ ) The overlay mode for test rendered geometry in debug purposes. @@ -1222,8 +1222,8 @@ The overlay mode for test rendered geometry in debug purposes. .. rst-class:: classref-property-setget -- void **set_disable_3d** **(** :ref:`bool` value **)** -- :ref:`bool` **is_3d_disabled** **(** **)** +- |void| **set_disable_3d**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_3d_disabled**\ (\ ) Disable 3D rendering (but keep 2D rendering). @@ -1239,8 +1239,8 @@ Disable 3D rendering (but keep 2D rendering). .. rst-class:: classref-property-setget -- void **set_fsr_sharpness** **(** :ref:`float` value **)** -- :ref:`float` **get_fsr_sharpness** **(** **)** +- |void| **set_fsr_sharpness**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_fsr_sharpness**\ (\ ) Determines how sharp the upscaled image will be when using the FSR upscaling mode. Sharpness halves with every whole number. Values go from 0.0 (sharpest) to 2.0. Values above 2.0 won't make a visible difference. @@ -1258,8 +1258,8 @@ To control this property on the root viewport, set the :ref:`ProjectSettings.ren .. rst-class:: classref-property-setget -- void **set_global_canvas_transform** **(** :ref:`Transform2D` value **)** -- :ref:`Transform2D` **get_global_canvas_transform** **(** **)** +- |void| **set_global_canvas_transform**\ (\ value\: :ref:`Transform2D`\ ) +- :ref:`Transform2D` **get_global_canvas_transform**\ (\ ) The global canvas transform of the viewport. The canvas transform is relative to this. @@ -1275,8 +1275,8 @@ The global canvas transform of the viewport. The canvas transform is relative to .. rst-class:: classref-property-setget -- void **set_disable_input** **(** :ref:`bool` value **)** -- :ref:`bool` **is_input_disabled** **(** **)** +- |void| **set_disable_input**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_input_disabled**\ (\ ) If ``true``, the viewport will not receive input events. @@ -1292,8 +1292,8 @@ If ``true``, the viewport will not receive input events. .. rst-class:: classref-property-setget -- void **set_embedding_subwindows** **(** :ref:`bool` value **)** -- :ref:`bool` **is_embedding_subwindows** **(** **)** +- |void| **set_embedding_subwindows**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_embedding_subwindows**\ (\ ) If ``true``, sub-windows (popups and dialogs) will be embedded inside application window as control-like nodes. If ``false``, they will appear as separate windows handled by the operating system. @@ -1309,8 +1309,8 @@ If ``true``, sub-windows (popups and dialogs) will be embedded inside applicatio .. rst-class:: classref-property-setget -- void **set_snap_controls_to_pixels** **(** :ref:`bool` value **)** -- :ref:`bool` **is_snap_controls_to_pixels_enabled** **(** **)** +- |void| **set_snap_controls_to_pixels**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_snap_controls_to_pixels_enabled**\ (\ ) If ``true``, the GUI controls on the viewport will lay pixel perfectly. @@ -1326,8 +1326,8 @@ If ``true``, the GUI controls on the viewport will lay pixel perfectly. .. rst-class:: classref-property-setget -- void **set_handle_input_locally** **(** :ref:`bool` value **)** -- :ref:`bool` **is_handling_input_locally** **(** **)** +- |void| **set_handle_input_locally**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_handling_input_locally**\ (\ ) If ``true``, this viewport will mark incoming input events as handled by itself. If ``false``, this is instead done by the first parent viewport that is set to handle input locally. @@ -1347,8 +1347,8 @@ See also :ref:`set_input_as_handled` .. rst-class:: classref-property-setget -- void **set_mesh_lod_threshold** **(** :ref:`float` value **)** -- :ref:`float` **get_mesh_lod_threshold** **(** **)** +- |void| **set_mesh_lod_threshold**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_mesh_lod_threshold**\ (\ ) The automatic LOD bias to use for meshes rendered within the **Viewport** (this is analogous to :ref:`ReflectionProbe.mesh_lod_threshold`). Higher values will use less detailed versions of meshes that have LOD variations generated. If set to ``0.0``, automatic LOD is disabled. Increase :ref:`mesh_lod_threshold` to improve performance at the cost of geometry detail. @@ -1368,8 +1368,8 @@ To control this property on the root viewport, set the :ref:`ProjectSettings.ren .. rst-class:: classref-property-setget -- void **set_msaa_2d** **(** :ref:`MSAA` value **)** -- :ref:`MSAA` **get_msaa_2d** **(** **)** +- |void| **set_msaa_2d**\ (\ value\: :ref:`MSAA`\ ) +- :ref:`MSAA` **get_msaa_2d**\ (\ ) The multisample anti-aliasing mode for 2D/Canvas rendering. A higher number results in smoother edges at the cost of significantly worse performance. A value of 2 or 4 is best unless targeting very high-end systems. This has no effect on shader-induced aliasing or texture aliasing. @@ -1385,8 +1385,8 @@ The multisample anti-aliasing mode for 2D/Canvas rendering. A higher number resu .. rst-class:: classref-property-setget -- void **set_msaa_3d** **(** :ref:`MSAA` value **)** -- :ref:`MSAA` **get_msaa_3d** **(** **)** +- |void| **set_msaa_3d**\ (\ value\: :ref:`MSAA`\ ) +- :ref:`MSAA` **get_msaa_3d**\ (\ ) The multisample anti-aliasing mode for 3D rendering. A higher number results in smoother edges at the cost of significantly worse performance. A value of 2 or 4 is best unless targeting very high-end systems. See also bilinear scaling 3d :ref:`scaling_3d_mode` for supersampling, which provides higher quality but is much more expensive. This has no effect on shader-induced aliasing or texture aliasing. @@ -1402,8 +1402,8 @@ The multisample anti-aliasing mode for 3D rendering. A higher number results in .. rst-class:: classref-property-setget -- void **set_use_own_world_3d** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_own_world_3d** **(** **)** +- |void| **set_use_own_world_3d**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_own_world_3d**\ (\ ) If ``true``, the viewport will use a unique copy of the :ref:`World3D` defined in :ref:`world_3d`. @@ -1419,8 +1419,8 @@ If ``true``, the viewport will use a unique copy of the :ref:`World3D` value **)** -- :ref:`bool` **get_physics_object_picking** **(** **)** +- |void| **set_physics_object_picking**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_physics_object_picking**\ (\ ) If ``true``, the objects rendered by viewport become subjects of mouse picking process. @@ -1438,8 +1438,8 @@ If ``true``, the objects rendered by viewport become subjects of mouse picking p .. rst-class:: classref-property-setget -- void **set_physics_object_picking_first_only** **(** :ref:`bool` value **)** -- :ref:`bool` **get_physics_object_picking_first_only** **(** **)** +- |void| **set_physics_object_picking_first_only**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_physics_object_picking_first_only**\ (\ ) If ``true``, the input_event signal will only be sent to one physics object in the mouse picking process. If you want to get the top object only, you must also enable :ref:`physics_object_picking_sort`. @@ -1459,8 +1459,8 @@ This applies to 2D CanvasItem object picking only. .. rst-class:: classref-property-setget -- void **set_physics_object_picking_sort** **(** :ref:`bool` value **)** -- :ref:`bool` **get_physics_object_picking_sort** **(** **)** +- |void| **set_physics_object_picking_sort**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_physics_object_picking_sort**\ (\ ) If ``true``, objects receive mouse picking events sorted primarily by their :ref:`CanvasItem.z_index` and secondarily by their position in the scene tree. If ``false``, the order is undetermined. @@ -1480,8 +1480,8 @@ If ``true``, objects receive mouse picking events sorted primarily by their :ref .. rst-class:: classref-property-setget -- void **set_positional_shadow_atlas_16_bits** **(** :ref:`bool` value **)** -- :ref:`bool` **get_positional_shadow_atlas_16_bits** **(** **)** +- |void| **set_positional_shadow_atlas_16_bits**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_positional_shadow_atlas_16_bits**\ (\ ) Use 16 bits for the omni/spot shadow depth map. Enabling this results in shadows having less precision and may result in shadow acne, but can lead to performance improvements on some devices. @@ -1497,8 +1497,8 @@ Use 16 bits for the omni/spot shadow depth map. Enabling this results in shadows .. rst-class:: classref-property-setget -- void **set_positional_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant, :ref:`PositionalShadowAtlasQuadrantSubdiv` subdiv **)** -- :ref:`PositionalShadowAtlasQuadrantSubdiv` **get_positional_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant **)** |const| +- |void| **set_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int`, subdiv\: :ref:`PositionalShadowAtlasQuadrantSubdiv`\ ) +- :ref:`PositionalShadowAtlasQuadrantSubdiv` **get_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int`\ ) |const| The subdivision amount of the first quadrant on the shadow atlas. @@ -1514,8 +1514,8 @@ The subdivision amount of the first quadrant on the shadow atlas. .. rst-class:: classref-property-setget -- void **set_positional_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant, :ref:`PositionalShadowAtlasQuadrantSubdiv` subdiv **)** -- :ref:`PositionalShadowAtlasQuadrantSubdiv` **get_positional_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant **)** |const| +- |void| **set_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int`, subdiv\: :ref:`PositionalShadowAtlasQuadrantSubdiv`\ ) +- :ref:`PositionalShadowAtlasQuadrantSubdiv` **get_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int`\ ) |const| The subdivision amount of the second quadrant on the shadow atlas. @@ -1531,8 +1531,8 @@ The subdivision amount of the second quadrant on the shadow atlas. .. rst-class:: classref-property-setget -- void **set_positional_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant, :ref:`PositionalShadowAtlasQuadrantSubdiv` subdiv **)** -- :ref:`PositionalShadowAtlasQuadrantSubdiv` **get_positional_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant **)** |const| +- |void| **set_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int`, subdiv\: :ref:`PositionalShadowAtlasQuadrantSubdiv`\ ) +- :ref:`PositionalShadowAtlasQuadrantSubdiv` **get_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int`\ ) |const| The subdivision amount of the third quadrant on the shadow atlas. @@ -1548,8 +1548,8 @@ The subdivision amount of the third quadrant on the shadow atlas. .. rst-class:: classref-property-setget -- void **set_positional_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant, :ref:`PositionalShadowAtlasQuadrantSubdiv` subdiv **)** -- :ref:`PositionalShadowAtlasQuadrantSubdiv` **get_positional_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant **)** |const| +- |void| **set_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int`, subdiv\: :ref:`PositionalShadowAtlasQuadrantSubdiv`\ ) +- :ref:`PositionalShadowAtlasQuadrantSubdiv` **get_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int`\ ) |const| The subdivision amount of the fourth quadrant on the shadow atlas. @@ -1565,8 +1565,8 @@ The subdivision amount of the fourth quadrant on the shadow atlas. .. rst-class:: classref-property-setget -- void **set_positional_shadow_atlas_size** **(** :ref:`int` value **)** -- :ref:`int` **get_positional_shadow_atlas_size** **(** **)** +- |void| **set_positional_shadow_atlas_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_positional_shadow_atlas_size**\ (\ ) The shadow atlas' resolution (used for omni and spot lights). The value is rounded up to the nearest power of 2. @@ -1584,8 +1584,8 @@ The shadow atlas' resolution (used for omni and spot lights). The value is round .. rst-class:: classref-property-setget -- void **set_scaling_3d_mode** **(** :ref:`Scaling3DMode` value **)** -- :ref:`Scaling3DMode` **get_scaling_3d_mode** **(** **)** +- |void| **set_scaling_3d_mode**\ (\ value\: :ref:`Scaling3DMode`\ ) +- :ref:`Scaling3DMode` **get_scaling_3d_mode**\ (\ ) Sets scaling 3d mode. Bilinear scaling renders at different resolution to either undersample or supersample the viewport. FidelityFX Super Resolution 1.0, abbreviated to FSR, is an upscaling technology that produces high quality images at fast framerates by using a spatially aware upscaling algorithm. FSR is slightly more expensive than bilinear, but it produces significantly higher image quality. FSR should be used where possible. @@ -1603,8 +1603,8 @@ To control this property on the root viewport, set the :ref:`ProjectSettings.ren .. rst-class:: classref-property-setget -- void **set_scaling_3d_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_scaling_3d_scale** **(** **)** +- |void| **set_scaling_3d_scale**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_scaling_3d_scale**\ (\ ) Scales the 3D render buffer based on the viewport size uses an image filter specified in :ref:`ProjectSettings.rendering/scaling_3d/mode` to scale the output image to the full viewport size. Values lower than ``1.0`` can be used to speed up 3D rendering at the cost of quality (undersampling). Values greater than ``1.0`` are only valid for bilinear mode and can be used to improve 3D rendering quality at a high performance cost (supersampling). See also :ref:`ProjectSettings.rendering/anti_aliasing/quality/msaa_3d` for multi-sample antialiasing, which is significantly cheaper but only smooths the edges of polygons. @@ -1624,8 +1624,8 @@ To control this property on the root viewport, set the :ref:`ProjectSettings.ren .. rst-class:: classref-property-setget -- void **set_screen_space_aa** **(** :ref:`ScreenSpaceAA` value **)** -- :ref:`ScreenSpaceAA` **get_screen_space_aa** **(** **)** +- |void| **set_screen_space_aa**\ (\ value\: :ref:`ScreenSpaceAA`\ ) +- :ref:`ScreenSpaceAA` **get_screen_space_aa**\ (\ ) Sets the screen-space antialiasing method used. Screen-space antialiasing works by selectively blurring edges in a post-process shader. It differs from MSAA which takes multiple coverage samples while rendering objects. Screen-space AA methods are typically faster than MSAA and will smooth out specular aliasing, but tend to make scenes appear blurry. @@ -1641,8 +1641,8 @@ Sets the screen-space antialiasing method used. Screen-space antialiasing works .. rst-class:: classref-property-setget -- void **set_sdf_oversize** **(** :ref:`SDFOversize` value **)** -- :ref:`SDFOversize` **get_sdf_oversize** **(** **)** +- |void| **set_sdf_oversize**\ (\ value\: :ref:`SDFOversize`\ ) +- :ref:`SDFOversize` **get_sdf_oversize**\ (\ ) .. container:: contribute @@ -1660,8 +1660,8 @@ Sets the screen-space antialiasing method used. Screen-space antialiasing works .. rst-class:: classref-property-setget -- void **set_sdf_scale** **(** :ref:`SDFScale` value **)** -- :ref:`SDFScale` **get_sdf_scale** **(** **)** +- |void| **set_sdf_scale**\ (\ value\: :ref:`SDFScale`\ ) +- :ref:`SDFScale` **get_sdf_scale**\ (\ ) .. container:: contribute @@ -1679,8 +1679,8 @@ Sets the screen-space antialiasing method used. Screen-space antialiasing works .. rst-class:: classref-property-setget -- void **set_snap_2d_transforms_to_pixel** **(** :ref:`bool` value **)** -- :ref:`bool` **is_snap_2d_transforms_to_pixel_enabled** **(** **)** +- |void| **set_snap_2d_transforms_to_pixel**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_snap_2d_transforms_to_pixel_enabled**\ (\ ) .. container:: contribute @@ -1698,8 +1698,8 @@ Sets the screen-space antialiasing method used. Screen-space antialiasing works .. rst-class:: classref-property-setget -- void **set_snap_2d_vertices_to_pixel** **(** :ref:`bool` value **)** -- :ref:`bool` **is_snap_2d_vertices_to_pixel_enabled** **(** **)** +- |void| **set_snap_2d_vertices_to_pixel**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_snap_2d_vertices_to_pixel_enabled**\ (\ ) .. container:: contribute @@ -1717,8 +1717,8 @@ Sets the screen-space antialiasing method used. Screen-space antialiasing works .. rst-class:: classref-property-setget -- void **set_texture_mipmap_bias** **(** :ref:`float` value **)** -- :ref:`float` **get_texture_mipmap_bias** **(** **)** +- |void| **set_texture_mipmap_bias**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_texture_mipmap_bias**\ (\ ) Affects the final texture sharpness by reading from a lower or higher mipmap (also called "texture LOD bias"). Negative values make mipmapped textures sharper but grainier when viewed at a distance, while positive values make mipmapped textures blurrier (even when up close). @@ -1740,8 +1740,8 @@ To control this property on the root viewport, set the :ref:`ProjectSettings.ren .. rst-class:: classref-property-setget -- void **set_transparent_background** **(** :ref:`bool` value **)** -- :ref:`bool` **has_transparent_background** **(** **)** +- |void| **set_transparent_background**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **has_transparent_background**\ (\ ) If ``true``, the viewport should render its background as transparent. @@ -1757,8 +1757,8 @@ If ``true``, the viewport should render its background as transparent. .. rst-class:: classref-property-setget -- void **set_use_debanding** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_debanding** **(** **)** +- |void| **set_use_debanding**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_debanding**\ (\ ) If ``true``, uses a fast post-processing filter to make banding significantly less visible in 3D. 2D rendering is *not* affected by debanding unless the :ref:`Environment.background_mode` is :ref:`Environment.BG_CANVAS`. See also :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_debanding`. @@ -1776,8 +1776,8 @@ In some cases, debanding may introduce a slightly noticeable dithering pattern. .. rst-class:: classref-property-setget -- void **set_use_hdr_2d** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_hdr_2d** **(** **)** +- |void| **set_use_hdr_2d**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_hdr_2d**\ (\ ) If ``true``, 2D rendering will use an high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ renderer this will be a ``RGBA16`` framebuffer, while when using the Mobile renderer it will be a ``RGB10_A2`` framebuffer. Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen). Practically speaking, this means that the end result of the Viewport will not be clamped into the ``0-1`` range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. @@ -1795,8 +1795,8 @@ If ``true``, 2D rendering will use an high dynamic range (HDR) format framebuffe .. rst-class:: classref-property-setget -- void **set_use_occlusion_culling** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_occlusion_culling** **(** **)** +- |void| **set_use_occlusion_culling**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_occlusion_culling**\ (\ ) If ``true``, :ref:`OccluderInstance3D` nodes will be usable for occlusion culling in 3D for this viewport. For the root viewport, :ref:`ProjectSettings.rendering/occlusion_culling/use_occlusion_culling` must be set to ``true`` instead. @@ -1816,8 +1816,8 @@ If ``true``, :ref:`OccluderInstance3D` nodes will be u .. rst-class:: classref-property-setget -- void **set_use_taa** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_taa** **(** **)** +- |void| **set_use_taa**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_taa**\ (\ ) Enables Temporal Anti-Aliasing for this viewport. TAA works by jittering the camera and accumulating the images of the last rendered frames, motion vector rendering is used to account for camera and object motion. @@ -1835,8 +1835,8 @@ Enables Temporal Anti-Aliasing for this viewport. TAA works by jittering the cam .. rst-class:: classref-property-setget -- void **set_use_xr** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_xr** **(** **)** +- |void| **set_use_xr**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_xr**\ (\ ) If ``true``, the viewport will use the primary XR interface to render XR output. When applicable this can result in a stereoscopic image and the resulting render being output to a headset. @@ -1852,8 +1852,8 @@ If ``true``, the viewport will use the primary XR interface to render XR output. .. rst-class:: classref-property-setget -- void **set_vrs_mode** **(** :ref:`VRSMode` value **)** -- :ref:`VRSMode` **get_vrs_mode** **(** **)** +- |void| **set_vrs_mode**\ (\ value\: :ref:`VRSMode`\ ) +- :ref:`VRSMode` **get_vrs_mode**\ (\ ) The Variable Rate Shading (VRS) mode that is used for this viewport. Note, if hardware does not support VRS this property is ignored. @@ -1869,8 +1869,8 @@ The Variable Rate Shading (VRS) mode that is used for this viewport. Note, if ha .. rst-class:: classref-property-setget -- void **set_vrs_texture** **(** :ref:`Texture2D` value **)** -- :ref:`Texture2D` **get_vrs_texture** **(** **)** +- |void| **set_vrs_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_vrs_texture**\ (\ ) Texture to use when :ref:`vrs_mode` is set to :ref:`VRS_TEXTURE`. @@ -1901,8 +1901,8 @@ The texture *must* use a lossless compression format so that colors can be match .. rst-class:: classref-property-setget -- void **set_world_2d** **(** :ref:`World2D` value **)** -- :ref:`World2D` **get_world_2d** **(** **)** +- |void| **set_world_2d**\ (\ value\: :ref:`World2D`\ ) +- :ref:`World2D` **get_world_2d**\ (\ ) The custom :ref:`World2D` which can be used as 2D environment source. @@ -1918,8 +1918,8 @@ The custom :ref:`World2D` which can be used as 2D environment sou .. rst-class:: classref-property-setget -- void **set_world_3d** **(** :ref:`World3D` value **)** -- :ref:`World3D` **get_world_3d** **(** **)** +- |void| **set_world_3d**\ (\ value\: :ref:`World3D`\ ) +- :ref:`World3D` **get_world_3d**\ (\ ) The custom :ref:`World3D` which can be used as 3D environment source. @@ -1936,7 +1936,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`World2D` **find_world_2d** **(** **)** |const| +:ref:`World2D` **find_world_2d**\ (\ ) |const| Returns the first valid :ref:`World2D` for this viewport, searching the :ref:`world_2d` property of itself and any Viewport ancestor. @@ -1948,7 +1948,7 @@ Returns the first valid :ref:`World2D` for this viewport, searchi .. rst-class:: classref-method -:ref:`World3D` **find_world_3d** **(** **)** |const| +:ref:`World3D` **find_world_3d**\ (\ ) |const| Returns the first valid :ref:`World3D` for this viewport, searching the :ref:`world_3d` property of itself and any Viewport ancestor. @@ -1960,7 +1960,7 @@ Returns the first valid :ref:`World3D` for this viewport, searchi .. rst-class:: classref-method -:ref:`Camera2D` **get_camera_2d** **(** **)** |const| +:ref:`Camera2D` **get_camera_2d**\ (\ ) |const| Returns the currently active 2D camera. Returns null if there are no active cameras. @@ -1972,7 +1972,7 @@ Returns the currently active 2D camera. Returns null if there are no active came .. rst-class:: classref-method -:ref:`Camera3D` **get_camera_3d** **(** **)** |const| +:ref:`Camera3D` **get_camera_3d**\ (\ ) |const| Returns the currently active 3D camera. @@ -1984,7 +1984,7 @@ Returns the currently active 3D camera. .. rst-class:: classref-method -:ref:`bool` **get_canvas_cull_mask_bit** **(** :ref:`int` layer **)** |const| +:ref:`bool` **get_canvas_cull_mask_bit**\ (\ layer\: :ref:`int`\ ) |const| Returns an individual bit on the rendering layer mask. @@ -1996,7 +1996,7 @@ Returns an individual bit on the rendering layer mask. .. rst-class:: classref-method -:ref:`Window[]` **get_embedded_subwindows** **(** **)** |const| +:ref:`Array`\[:ref:`Window`\] **get_embedded_subwindows**\ (\ ) |const| Returns a list of the visible embedded :ref:`Window`\ s inside the viewport. @@ -2010,7 +2010,7 @@ Returns a list of the visible embedded :ref:`Window`\ s inside the .. rst-class:: classref-method -:ref:`Transform2D` **get_final_transform** **(** **)** |const| +:ref:`Transform2D` **get_final_transform**\ (\ ) |const| Returns the transform from the viewport's coordinate system to the embedder's coordinate system. @@ -2022,7 +2022,7 @@ Returns the transform from the viewport's coordinate system to the embedder's co .. rst-class:: classref-method -:ref:`Vector2` **get_mouse_position** **(** **)** |const| +:ref:`Vector2` **get_mouse_position**\ (\ ) |const| Returns the mouse's position in this **Viewport** using the coordinate system of this **Viewport**. @@ -2034,7 +2034,7 @@ Returns the mouse's position in this **Viewport** using the coordinate system of .. rst-class:: classref-method -:ref:`PositionalShadowAtlasQuadrantSubdiv` **get_positional_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant **)** |const| +:ref:`PositionalShadowAtlasQuadrantSubdiv` **get_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int`\ ) |const| Returns the positional shadow atlas quadrant subdivision of the specified quadrant. @@ -2046,7 +2046,7 @@ Returns the positional shadow atlas quadrant subdivision of the specified quadra .. rst-class:: classref-method -:ref:`int` **get_render_info** **(** :ref:`RenderInfoType` type, :ref:`RenderInfo` info **)** +:ref:`int` **get_render_info**\ (\ type\: :ref:`RenderInfoType`, info\: :ref:`RenderInfo`\ ) Returns rendering statistics of the given type. See :ref:`RenderInfoType` and :ref:`RenderInfo` for options. @@ -2058,7 +2058,7 @@ Returns rendering statistics of the given type. See :ref:`RenderInfoType` **get_screen_transform** **(** **)** |const| +:ref:`Transform2D` **get_screen_transform**\ (\ ) |const| Returns the transform from the Viewport's coordinates to the screen coordinates of the containing window manager window. @@ -2070,7 +2070,7 @@ Returns the transform from the Viewport's coordinates to the screen coordinates .. rst-class:: classref-method -:ref:`ViewportTexture` **get_texture** **(** **)** |const| +:ref:`ViewportTexture` **get_texture**\ (\ ) |const| Returns the viewport's texture. @@ -2090,7 +2090,7 @@ Returns the viewport's texture. .. rst-class:: classref-method -:ref:`RID` **get_viewport_rid** **(** **)** |const| +:ref:`RID` **get_viewport_rid**\ (\ ) |const| Returns the viewport's RID from the :ref:`RenderingServer`. @@ -2102,7 +2102,7 @@ Returns the viewport's RID from the :ref:`RenderingServer .. rst-class:: classref-method -:ref:`Rect2` **get_visible_rect** **(** **)** |const| +:ref:`Rect2` **get_visible_rect**\ (\ ) |const| Returns the visible rectangle in global screen coordinates. @@ -2114,7 +2114,7 @@ Returns the visible rectangle in global screen coordinates. .. rst-class:: classref-method -:ref:`Variant` **gui_get_drag_data** **(** **)** |const| +:ref:`Variant` **gui_get_drag_data**\ (\ ) |const| Returns the drag data from the GUI, that was previously returned by :ref:`Control._get_drag_data`. @@ -2126,7 +2126,7 @@ Returns the drag data from the GUI, that was previously returned by :ref:`Contro .. rst-class:: classref-method -:ref:`Control` **gui_get_focus_owner** **(** **)** |const| +:ref:`Control` **gui_get_focus_owner**\ (\ ) |const| Returns the :ref:`Control` having the focus within this viewport. If no :ref:`Control` has the focus, returns null. @@ -2138,7 +2138,7 @@ Returns the :ref:`Control` having the focus within this viewport. .. rst-class:: classref-method -:ref:`Control` **gui_get_hovered_control** **(** **)** |const| +:ref:`Control` **gui_get_hovered_control**\ (\ ) |const| Returns the :ref:`Control` that the mouse is currently hovering over in this viewport. If no :ref:`Control` has the cursor, returns null. @@ -2152,7 +2152,7 @@ Typically the leaf :ref:`Control` node or deepest level of the su .. rst-class:: classref-method -:ref:`bool` **gui_is_drag_successful** **(** **)** |const| +:ref:`bool` **gui_is_drag_successful**\ (\ ) |const| Returns ``true`` if the drag operation is successful. @@ -2164,7 +2164,7 @@ Returns ``true`` if the drag operation is successful. .. rst-class:: classref-method -:ref:`bool` **gui_is_dragging** **(** **)** |const| +:ref:`bool` **gui_is_dragging**\ (\ ) |const| Returns ``true`` if the viewport is currently performing a drag operation. @@ -2178,7 +2178,7 @@ Alternative to :ref:`Node.NOTIFICATION_DRAG_BEGIN` within this viewport. If no :ref:`Control` has the focus, does nothing. @@ -2190,7 +2190,7 @@ Removes the focus from the currently focused :ref:`Control` withi .. rst-class:: classref-method -:ref:`bool` **is_input_handled** **(** **)** |const| +:ref:`bool` **is_input_handled**\ (\ ) |const| Returns whether the current :ref:`InputEvent` has been handled. Input events are not handled until :ref:`set_input_as_handled` has been called during the lifetime of an :ref:`InputEvent`. @@ -2206,7 +2206,7 @@ If :ref:`handle_input_locally` is .. rst-class:: classref-method -void **push_input** **(** :ref:`InputEvent` event, :ref:`bool` in_local_coords=false **)** +|void| **push_input**\ (\ event\: :ref:`InputEvent`, in_local_coords\: :ref:`bool` = false\ ) Triggers the given ``event`` in this **Viewport**. This can be used to pass an :ref:`InputEvent` between viewports, or to locally apply inputs that were sent over the network or saved to a file. @@ -2238,7 +2238,7 @@ If none of the methods handle the event and :ref:`physics_object_picking` text **)** +|void| **push_text_input**\ (\ text\: :ref:`String`\ ) Helper method which calls the ``set_text()`` method on the currently focused :ref:`Control`, provided that it is defined (e.g. if the focused Control is :ref:`Button` or :ref:`LineEdit`). @@ -2250,16 +2250,14 @@ Helper method which calls the ``set_text()`` method on the currently focused :re .. rst-class:: classref-method -void **push_unhandled_input** **(** :ref:`InputEvent` event, :ref:`bool` in_local_coords=false **)** +|void| **push_unhandled_input**\ (\ event\: :ref:`InputEvent`, in_local_coords\: :ref:`bool` = false\ ) **Deprecated:** Use :ref:`push_input` instead. -Triggers the given :ref:`InputEvent` in this **Viewport**. This can be used to pass input events between viewports, or to locally apply inputs that were sent over the network or saved to a file. +Triggers the given ``event`` in this **Viewport**. This can be used to pass an :ref:`InputEvent` between viewports, or to locally apply inputs that were sent over the network or saved to a file. If ``in_local_coords`` is ``false``, the event's position is in the embedder's coordinates and will be converted to viewport coordinates. If ``in_local_coords`` is ``true``, the event's position is in viewport coordinates. -While this method serves a similar purpose as :ref:`Input.parse_input_event`, it does not remap the specified ``event`` based on project settings like :ref:`ProjectSettings.input_devices/pointing/emulate_touch_from_mouse`. - Calling this method will propagate calls to child nodes for following methods in the given order: - :ref:`Node._shortcut_input`\ @@ -2282,7 +2280,7 @@ If none of the methods handle the event and :ref:`physics_object_picking` layer, :ref:`bool` enable **)** +|void| **set_canvas_cull_mask_bit**\ (\ layer\: :ref:`int`, enable\: :ref:`bool`\ ) Set/clear individual bits on the rendering layer mask. This simplifies editing this **Viewport**'s layers. @@ -2294,7 +2292,7 @@ Set/clear individual bits on the rendering layer mask. This simplifies editing t .. rst-class:: classref-method -void **set_input_as_handled** **(** **)** +|void| **set_input_as_handled**\ (\ ) Stops the input from propagating further down the :ref:`SceneTree`. @@ -2308,7 +2306,7 @@ Stops the input from propagating further down the :ref:`SceneTree` quadrant, :ref:`PositionalShadowAtlasQuadrantSubdiv` subdiv **)** +|void| **set_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int`, subdiv\: :ref:`PositionalShadowAtlasQuadrantSubdiv`\ ) Sets the number of subdivisions to use in the specified quadrant. A higher number of subdivisions allows you to have more shadows in the scene at once, but reduces the quality of the shadows. A good practice is to have quadrants with a varying number of subdivisions and to have as few subdivisions as possible. @@ -2320,7 +2318,7 @@ Sets the number of subdivisions to use in the specified quadrant. A higher numbe .. rst-class:: classref-method -void **update_mouse_cursor_state** **(** **)** +|void| **update_mouse_cursor_state**\ (\ ) Force instantly updating the display based on the current mouse cursor position. This includes updating the mouse cursor shape and sending necessary :ref:`Control.mouse_entered`, :ref:`CollisionObject2D.mouse_entered`, :ref:`CollisionObject3D.mouse_entered` and :ref:`Window.mouse_entered` signals and their respective ``mouse_exited`` counterparts. @@ -2332,7 +2330,7 @@ Force instantly updating the display based on the current mouse cursor position. .. rst-class:: classref-method -void **warp_mouse** **(** :ref:`Vector2` position **)** +|void| **warp_mouse**\ (\ position\: :ref:`Vector2`\ ) Moves the mouse pointer to the specified position in this **Viewport** using the coordinate system of this **Viewport**. @@ -2345,3 +2343,4 @@ Moves the mouse pointer to the specified position in this **Viewport** using the .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index 1b8ac69986e..bd16350a863 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -67,8 +67,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_viewport_path_in_scene** **(** :ref:`NodePath` value **)** -- :ref:`NodePath` **get_viewport_path_in_scene** **(** **)** +- |void| **set_viewport_path_in_scene**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_viewport_path_in_scene**\ (\ ) The path to the :ref:`Viewport` node to display. This is relative to the scene root, not to the node that uses the texture. @@ -81,3 +81,4 @@ The path to the :ref:`Viewport` node to display. This is relativ .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visibleonscreenenabler2d.rst b/classes/class_visibleonscreenenabler2d.rst index 6cd6a9932e2..73deed1f778 100644 --- a/classes/class_visibleonscreenenabler2d.rst +++ b/classes/class_visibleonscreenenabler2d.rst @@ -95,8 +95,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_enable_mode** **(** :ref:`EnableMode` value **)** -- :ref:`EnableMode` **get_enable_mode** **(** **)** +- |void| **set_enable_mode**\ (\ value\: :ref:`EnableMode`\ ) +- :ref:`EnableMode` **get_enable_mode**\ (\ ) Determines how the target node is enabled. Corresponds to :ref:`ProcessMode`. When the node is disabled, it always uses :ref:`Node.PROCESS_MODE_DISABLED`. @@ -112,8 +112,8 @@ Determines how the target node is enabled. Corresponds to :ref:`ProcessMode` value **)** -- :ref:`NodePath` **get_enable_node_path** **(** **)** +- |void| **set_enable_node_path**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_enable_node_path**\ (\ ) The path to the target node, relative to the **VisibleOnScreenEnabler2D**. The target node is cached; it's only assigned when setting this property (if the **VisibleOnScreenEnabler2D** is inside the scene tree) and every time the **VisibleOnScreenEnabler2D** enters the scene tree. If the path is empty, no node will be affected. If the path is invalid, an error is also generated. @@ -124,3 +124,4 @@ The path to the target node, relative to the **VisibleOnScreenEnabler2D**. The t .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visibleonscreenenabler3d.rst b/classes/class_visibleonscreenenabler3d.rst index 1a56e64f3d9..b75dc63aac4 100644 --- a/classes/class_visibleonscreenenabler3d.rst +++ b/classes/class_visibleonscreenenabler3d.rst @@ -95,8 +95,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_enable_mode** **(** :ref:`EnableMode` value **)** -- :ref:`EnableMode` **get_enable_mode** **(** **)** +- |void| **set_enable_mode**\ (\ value\: :ref:`EnableMode`\ ) +- :ref:`EnableMode` **get_enable_mode**\ (\ ) Determines how the target node is enabled. Corresponds to :ref:`ProcessMode`. When the node is disabled, it always uses :ref:`Node.PROCESS_MODE_DISABLED`. @@ -112,8 +112,8 @@ Determines how the target node is enabled. Corresponds to :ref:`ProcessMode` value **)** -- :ref:`NodePath` **get_enable_node_path** **(** **)** +- |void| **set_enable_node_path**\ (\ value\: :ref:`NodePath`\ ) +- :ref:`NodePath` **get_enable_node_path**\ (\ ) The path to the target node, relative to the **VisibleOnScreenEnabler3D**. The target node is cached; it's only assigned when setting this property (if the **VisibleOnScreenEnabler3D** is inside the scene tree) and every time the **VisibleOnScreenEnabler3D** enters the scene tree. If the path is empty, no node will be affected. If the path is invalid, an error is also generated. @@ -124,3 +124,4 @@ The path to the target node, relative to the **VisibleOnScreenEnabler3D**. The t .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visibleonscreennotifier2d.rst b/classes/class_visibleonscreennotifier2d.rst index 70fae8f0206..831071de0d6 100644 --- a/classes/class_visibleonscreennotifier2d.rst +++ b/classes/class_visibleonscreennotifier2d.rst @@ -54,9 +54,9 @@ Methods .. table:: :widths: auto - +-------------------------+----------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_on_screen` **(** **)** |const| | - +-------------------------+----------------------------------------------------------------------------------------------+ + +-------------------------+----------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_on_screen`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -71,7 +71,7 @@ Signals .. rst-class:: classref-signal -**screen_entered** **(** **)** +**screen_entered**\ (\ ) Emitted when the VisibleOnScreenNotifier2D enters the screen. @@ -83,7 +83,7 @@ Emitted when the VisibleOnScreenNotifier2D enters the screen. .. rst-class:: classref-signal -**screen_exited** **(** **)** +**screen_exited**\ (\ ) Emitted when the VisibleOnScreenNotifier2D exits the screen. @@ -104,8 +104,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_rect** **(** :ref:`Rect2` value **)** -- :ref:`Rect2` **get_rect** **(** **)** +- |void| **set_rect**\ (\ value\: :ref:`Rect2`\ ) +- :ref:`Rect2` **get_rect**\ (\ ) The VisibleOnScreenNotifier2D's bounding rectangle. @@ -122,7 +122,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_on_screen** **(** **)** |const| +:ref:`bool` **is_on_screen**\ (\ ) |const| If ``true``, the bounding rectangle is on the screen. @@ -135,3 +135,4 @@ If ``true``, the bounding rectangle is on the screen. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visibleonscreennotifier3d.rst b/classes/class_visibleonscreennotifier3d.rst index 529fba91d90..ae3a2984d8d 100644 --- a/classes/class_visibleonscreennotifier3d.rst +++ b/classes/class_visibleonscreennotifier3d.rst @@ -47,9 +47,9 @@ Methods .. table:: :widths: auto - +-------------------------+----------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_on_screen` **(** **)** |const| | - +-------------------------+----------------------------------------------------------------------------------------------+ + +-------------------------+----------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_on_screen`\ (\ ) |const| | + +-------------------------+----------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -64,7 +64,7 @@ Signals .. rst-class:: classref-signal -**screen_entered** **(** **)** +**screen_entered**\ (\ ) Emitted when the **VisibleOnScreenNotifier3D** enters the screen. @@ -76,7 +76,7 @@ Emitted when the **VisibleOnScreenNotifier3D** enters the screen. .. rst-class:: classref-signal -**screen_exited** **(** **)** +**screen_exited**\ (\ ) Emitted when the **VisibleOnScreenNotifier3D** exits the screen. @@ -97,8 +97,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_aabb** **(** :ref:`AABB` value **)** -- :ref:`AABB` **get_aabb** **(** **)** +- |void| **set_aabb**\ (\ value\: :ref:`AABB`\ ) +- :ref:`AABB` **get_aabb**\ (\ ) The **VisibleOnScreenNotifier3D**'s bounding box. @@ -115,7 +115,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`bool` **is_on_screen** **(** **)** |const| +:ref:`bool` **is_on_screen**\ (\ ) |const| Returns ``true`` if the bounding box is on the screen. @@ -128,3 +128,4 @@ Returns ``true`` if the bounding box is on the screen. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualinstance3d.rst b/classes/class_visualinstance3d.rst index 48bf791f73d..1015a3dab94 100644 --- a/classes/class_visualinstance3d.rst +++ b/classes/class_visualinstance3d.rst @@ -47,21 +47,21 @@ Methods .. table:: :widths: auto - +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`_get_aabb` **(** **)** |virtual| |const| | - +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`get_aabb` **(** **)** |const| | - +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_base` **(** **)** |const| | - +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_instance` **(** **)** |const| | - +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_layer_mask_value` **(** :ref:`int` layer_number **)** |const| | - +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_base` **(** :ref:`RID` base **)** | - +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_layer_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | - +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`_get_aabb`\ (\ ) |virtual| |const| | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`get_aabb`\ (\ ) |const| | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_base`\ (\ ) |const| | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_instance`\ (\ ) |const| | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_layer_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_base`\ (\ base\: :ref:`RID`\ ) | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_layer_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -80,8 +80,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_layer_mask** **(** :ref:`int` value **)** -- :ref:`int` **get_layer_mask** **(** **)** +- |void| **set_layer_mask**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_layer_mask**\ (\ ) The render layer(s) this **VisualInstance3D** is drawn on. @@ -105,8 +105,8 @@ To adjust :ref:`layers` more easily usin .. rst-class:: classref-property-setget -- void **set_sorting_offset** **(** :ref:`float` value **)** -- :ref:`float` **get_sorting_offset** **(** **)** +- |void| **set_sorting_offset**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_sorting_offset**\ (\ ) The amount by which the depth of this **VisualInstance3D** will be adjusted when sorting by depth. Uses the same units as the engine (which are typically meters). Adjusting it to a higher value will make the **VisualInstance3D** reliably draw on top of other **VisualInstance3D**\ s that are otherwise positioned at the same spot. To ensure it always draws on top of other objects around it (not positioned at the same spot), set the value to be greater than the distance between this **VisualInstance3D** and the other nearby **VisualInstance3D**\ s. @@ -122,8 +122,8 @@ The amount by which the depth of this **VisualInstance3D** will be adjusted when .. rst-class:: classref-property-setget -- void **set_sorting_use_aabb_center** **(** :ref:`bool` value **)** -- :ref:`bool` **is_sorting_use_aabb_center** **(** **)** +- |void| **set_sorting_use_aabb_center**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_sorting_use_aabb_center**\ (\ ) If ``true``, the object is sorted based on the :ref:`AABB` center. The object will be sorted based on the global position otherwise. @@ -142,7 +142,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AABB` **_get_aabb** **(** **)** |virtual| |const| +:ref:`AABB` **_get_aabb**\ (\ ) |virtual| |const| .. container:: contribute @@ -156,7 +156,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`AABB` **get_aabb** **(** **)** |const| +:ref:`AABB` **get_aabb**\ (\ ) |const| Returns the :ref:`AABB` (also known as the bounding box) for this **VisualInstance3D**. @@ -168,7 +168,7 @@ Returns the :ref:`AABB` (also known as the bounding box) for this ** .. rst-class:: classref-method -:ref:`RID` **get_base** **(** **)** |const| +:ref:`RID` **get_base**\ (\ ) |const| Returns the RID of the resource associated with this **VisualInstance3D**. For example, if the Node is a :ref:`MeshInstance3D`, this will return the RID of the associated :ref:`Mesh`. @@ -180,7 +180,7 @@ Returns the RID of the resource associated with this **VisualInstance3D**. For e .. rst-class:: classref-method -:ref:`RID` **get_instance** **(** **)** |const| +:ref:`RID` **get_instance**\ (\ ) |const| Returns the RID of this instance. This RID is the same as the RID returned by :ref:`RenderingServer.instance_create`. This RID is needed if you want to call :ref:`RenderingServer` functions directly on this **VisualInstance3D**. @@ -192,7 +192,7 @@ Returns the RID of this instance. This RID is the same as the RID returned by :r .. rst-class:: classref-method -:ref:`bool` **get_layer_mask_value** **(** :ref:`int` layer_number **)** |const| +:ref:`bool` **get_layer_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| Returns whether or not the specified layer of the :ref:`layers` is enabled, given a ``layer_number`` between 1 and 20. @@ -204,7 +204,7 @@ Returns whether or not the specified layer of the :ref:`layers` base **)** +|void| **set_base**\ (\ base\: :ref:`RID`\ ) Sets the resource that is instantiated by this **VisualInstance3D**, which changes how the engine handles the **VisualInstance3D** under the hood. Equivalent to :ref:`RenderingServer.instance_set_base`. @@ -216,7 +216,7 @@ Sets the resource that is instantiated by this **VisualInstance3D**, which chang .. rst-class:: classref-method -void **set_layer_mask_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** +|void| **set_layer_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) Based on ``value``, enables or disables the specified layer in the :ref:`layers`, given a ``layer_number`` between 1 and 20. @@ -227,3 +227,4 @@ Based on ``value``, enables or disables the specified layer in the :ref:`layers< .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst index b34af625c27..16273d97aad 100644 --- a/classes/class_visualshader.rst +++ b/classes/class_visualshader.rst @@ -48,43 +48,43 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_node` **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_varying` **(** :ref:`String` name, :ref:`VaryingMode` mode, :ref:`VaryingType` type **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`can_connect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`connect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`connect_nodes_forced` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`disconnect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VisualShaderNode` | :ref:`get_node` **(** :ref:`Type` type, :ref:`int` id **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary[]` | :ref:`get_node_connections` **(** :ref:`Type` type **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_node_list` **(** :ref:`Type` type **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`Type` type, :ref:`int` id **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_valid_node_id` **(** :ref:`Type` type **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_varying` **(** :ref:`String` name **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_node_connection` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** |const| | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_node` **(** :ref:`Type` type, :ref:`int` id **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_varying` **(** :ref:`String` name **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`replace_node` **(** :ref:`Type` type, :ref:`int` id, :ref:`StringName` new_class **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_mode` **(** :ref:`Mode` mode **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_node_position` **(** :ref:`Type` type, :ref:`int` id, :ref:`Vector2` position **)** | - +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_node`\ (\ type\: :ref:`Type`, node\: :ref:`VisualShaderNode`, position\: :ref:`Vector2`, id\: :ref:`int`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_varying`\ (\ name\: :ref:`String`, mode\: :ref:`VaryingMode`, type\: :ref:`VaryingType`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`can_connect_nodes`\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`connect_nodes`\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`connect_nodes_forced`\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`disconnect_nodes`\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`VisualShaderNode` | :ref:`get_node`\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_node_connections`\ (\ type\: :ref:`Type`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_node_list`\ (\ type\: :ref:`Type`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_node_position`\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_valid_node_id`\ (\ type\: :ref:`Type`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_varying`\ (\ name\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_node_connection`\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_node`\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_varying`\ (\ name\: :ref:`String`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`replace_node`\ (\ type\: :ref:`Type`, id\: :ref:`int`, new_class\: :ref:`StringName`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_mode`\ (\ mode\: :ref:`Mode`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_node_position`\ (\ type\: :ref:`Type`, id\: :ref:`int`, position\: :ref:`Vector2`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -347,8 +347,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_graph_offset** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_graph_offset** **(** **)** +- |void| **set_graph_offset**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_graph_offset**\ (\ ) The offset vector of the whole graph. @@ -365,7 +365,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_node** **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** +|void| **add_node**\ (\ type\: :ref:`Type`, node\: :ref:`VisualShaderNode`, position\: :ref:`Vector2`, id\: :ref:`int`\ ) Adds the specified ``node`` to the shader. @@ -377,7 +377,7 @@ Adds the specified ``node`` to the shader. .. rst-class:: classref-method -void **add_varying** **(** :ref:`String` name, :ref:`VaryingMode` mode, :ref:`VaryingType` type **)** +|void| **add_varying**\ (\ name\: :ref:`String`, mode\: :ref:`VaryingMode`, type\: :ref:`VaryingType`\ ) Adds a new varying value node to the shader. @@ -389,7 +389,7 @@ Adds a new varying value node to the shader. .. rst-class:: classref-method -:ref:`bool` **can_connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** |const| +:ref:`bool` **can_connect_nodes**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) |const| Returns ``true`` if the specified nodes and ports can be connected together. @@ -401,7 +401,7 @@ Returns ``true`` if the specified nodes and ports can be connected together. .. rst-class:: classref-method -:ref:`Error` **connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** +:ref:`Error` **connect_nodes**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) Connects the specified nodes and ports. @@ -413,7 +413,7 @@ Connects the specified nodes and ports. .. rst-class:: classref-method -void **connect_nodes_forced** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** +|void| **connect_nodes_forced**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) Connects the specified nodes and ports, even if they can't be connected. Such connection is invalid and will not function properly. @@ -425,7 +425,7 @@ Connects the specified nodes and ports, even if they can't be connected. Such co .. rst-class:: classref-method -void **disconnect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** +|void| **disconnect_nodes**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) Connects the specified nodes and ports. @@ -437,7 +437,7 @@ Connects the specified nodes and ports. .. rst-class:: classref-method -:ref:`VisualShaderNode` **get_node** **(** :ref:`Type` type, :ref:`int` id **)** |const| +:ref:`VisualShaderNode` **get_node**\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) |const| Returns the shader node instance with specified ``type`` and ``id``. @@ -449,7 +449,7 @@ Returns the shader node instance with specified ``type`` and ``id``. .. rst-class:: classref-method -:ref:`Dictionary[]` **get_node_connections** **(** :ref:`Type` type **)** |const| +:ref:`Array`\[:ref:`Dictionary`\] **get_node_connections**\ (\ type\: :ref:`Type`\ ) |const| Returns the list of connected nodes with the specified type. @@ -461,7 +461,7 @@ Returns the list of connected nodes with the specified type. .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_node_list** **(** :ref:`Type` type **)** |const| +:ref:`PackedInt32Array` **get_node_list**\ (\ type\: :ref:`Type`\ ) |const| Returns the list of all nodes in the shader with the specified type. @@ -473,7 +473,7 @@ Returns the list of all nodes in the shader with the specified type. .. rst-class:: classref-method -:ref:`Vector2` **get_node_position** **(** :ref:`Type` type, :ref:`int` id **)** |const| +:ref:`Vector2` **get_node_position**\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) |const| Returns the position of the specified node within the shader graph. @@ -485,7 +485,7 @@ Returns the position of the specified node within the shader graph. .. rst-class:: classref-method -:ref:`int` **get_valid_node_id** **(** :ref:`Type` type **)** |const| +:ref:`int` **get_valid_node_id**\ (\ type\: :ref:`Type`\ ) |const| Returns next valid node ID that can be added to the shader graph. @@ -497,7 +497,7 @@ Returns next valid node ID that can be added to the shader graph. .. rst-class:: classref-method -:ref:`bool` **has_varying** **(** :ref:`String` name **)** |const| +:ref:`bool` **has_varying**\ (\ name\: :ref:`String`\ ) |const| Returns ``true`` if the shader has a varying with the given ``name``. @@ -509,7 +509,7 @@ Returns ``true`` if the shader has a varying with the given ``name``. .. rst-class:: classref-method -:ref:`bool` **is_node_connection** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** |const| +:ref:`bool` **is_node_connection**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) |const| Returns ``true`` if the specified node and port connection exist. @@ -521,7 +521,7 @@ Returns ``true`` if the specified node and port connection exist. .. rst-class:: classref-method -void **remove_node** **(** :ref:`Type` type, :ref:`int` id **)** +|void| **remove_node**\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) Removes the specified node from the shader. @@ -533,7 +533,7 @@ Removes the specified node from the shader. .. rst-class:: classref-method -void **remove_varying** **(** :ref:`String` name **)** +|void| **remove_varying**\ (\ name\: :ref:`String`\ ) Removes a varying value node with the given ``name``. Prints an error if a node with this name is not found. @@ -545,7 +545,7 @@ Removes a varying value node with the given ``name``. Prints an error if a node .. rst-class:: classref-method -void **replace_node** **(** :ref:`Type` type, :ref:`int` id, :ref:`StringName` new_class **)** +|void| **replace_node**\ (\ type\: :ref:`Type`, id\: :ref:`int`, new_class\: :ref:`StringName`\ ) Replaces the specified node with a node of new class type. @@ -557,7 +557,7 @@ Replaces the specified node with a node of new class type. .. rst-class:: classref-method -void **set_mode** **(** :ref:`Mode` mode **)** +|void| **set_mode**\ (\ mode\: :ref:`Mode`\ ) Sets the mode of this shader. @@ -569,7 +569,7 @@ Sets the mode of this shader. .. rst-class:: classref-method -void **set_node_position** **(** :ref:`Type` type, :ref:`int` id, :ref:`Vector2` position **)** +|void| **set_node_position**\ (\ type\: :ref:`Type`, id\: :ref:`int`, position\: :ref:`Vector2`\ ) Sets the position of the specified node. @@ -580,3 +580,4 @@ Sets the position of the specified node. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index deb0f83a5c0..b134c13f726 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -50,21 +50,21 @@ Methods .. table:: :widths: auto - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_default_input_values` **(** **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_default_input_port` **(** :ref:`PortType` type **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_default_input_values` **(** **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_input_port_default_value` **(** :ref:`int` port **)** |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_input_port_default_value` **(** :ref:`int` port **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_default_input_values` **(** :ref:`Array` values **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_input_port_default_value` **(** :ref:`int` port, :ref:`Variant` value, :ref:`Variant` prev_value=null **)** | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_default_input_values`\ (\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_default_input_port`\ (\ type\: :ref:`PortType`\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_default_input_values`\ (\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_input_port_default_value`\ (\ port\: :ref:`int`\ ) |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_input_port_default_value`\ (\ port\: :ref:`int`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_default_input_values`\ (\ values\: :ref:`Array`\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_input_port_default_value`\ (\ port\: :ref:`int`, value\: :ref:`Variant`, prev_value\: :ref:`Variant` = null\ ) | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -178,8 +178,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_output_port_for_preview** **(** :ref:`int` value **)** -- :ref:`int` **get_output_port_for_preview** **(** **)** +- |void| **set_output_port_for_preview**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_output_port_for_preview**\ (\ ) Sets the output port index which will be showed for preview. If set to ``-1`` no port will be open for preview. @@ -196,7 +196,7 @@ Method Descriptions .. rst-class:: classref-method -void **clear_default_input_values** **(** **)** +|void| **clear_default_input_values**\ (\ ) Clears the default input ports value. @@ -208,7 +208,7 @@ Clears the default input ports value. .. rst-class:: classref-method -:ref:`int` **get_default_input_port** **(** :ref:`PortType` type **)** |const| +:ref:`int` **get_default_input_port**\ (\ type\: :ref:`PortType`\ ) |const| Returns the input port which should be connected by default when this node is created as a result of dragging a connection from an existing node to the empty space on the graph. @@ -220,7 +220,7 @@ Returns the input port which should be connected by default when this node is cr .. rst-class:: classref-method -:ref:`Array` **get_default_input_values** **(** **)** |const| +:ref:`Array` **get_default_input_values**\ (\ ) |const| Returns an :ref:`Array` containing default values for all of the input ports of the node in the form ``[index0, value0, index1, value1, ...]``. @@ -232,7 +232,7 @@ Returns an :ref:`Array` containing default values for all of the in .. rst-class:: classref-method -:ref:`Variant` **get_input_port_default_value** **(** :ref:`int` port **)** |const| +:ref:`Variant` **get_input_port_default_value**\ (\ port\: :ref:`int`\ ) |const| Returns the default value of the input ``port``. @@ -244,7 +244,7 @@ Returns the default value of the input ``port``. .. rst-class:: classref-method -void **remove_input_port_default_value** **(** :ref:`int` port **)** +|void| **remove_input_port_default_value**\ (\ port\: :ref:`int`\ ) Removes the default value of the input ``port``. @@ -256,7 +256,7 @@ Removes the default value of the input ``port``. .. rst-class:: classref-method -void **set_default_input_values** **(** :ref:`Array` values **)** +|void| **set_default_input_values**\ (\ values\: :ref:`Array`\ ) Sets the default input ports values using an :ref:`Array` of the form ``[index0, value0, index1, value1, ...]``. For example: ``[0, Vector3(0, 0, 0), 1, Vector3(0, 0, 0)]``. @@ -268,7 +268,7 @@ Sets the default input ports values using an :ref:`Array` of the fo .. rst-class:: classref-method -void **set_input_port_default_value** **(** :ref:`int` port, :ref:`Variant` value, :ref:`Variant` prev_value=null **)** +|void| **set_input_port_default_value**\ (\ port\: :ref:`int`, value\: :ref:`Variant`, prev_value\: :ref:`Variant` = null\ ) Sets the default ``value`` for the selected input ``port``. @@ -279,3 +279,4 @@ Sets the default ``value`` for the selected input ``port``. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodebillboard.rst b/classes/class_visualshadernodebillboard.rst index 2fd9828aa99..2a269a91276 100644 --- a/classes/class_visualshadernodebillboard.rst +++ b/classes/class_visualshadernodebillboard.rst @@ -107,8 +107,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_billboard_type** **(** :ref:`BillboardType` value **)** -- :ref:`BillboardType` **get_billboard_type** **(** **)** +- |void| **set_billboard_type**\ (\ value\: :ref:`BillboardType`\ ) +- :ref:`BillboardType` **get_billboard_type**\ (\ ) Controls how the object faces the camera. See :ref:`BillboardType`. @@ -124,8 +124,8 @@ Controls how the object faces the camera. See :ref:`BillboardType` value **)** -- :ref:`bool` **is_keep_scale_enabled** **(** **)** +- |void| **set_keep_scale_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_keep_scale_enabled**\ (\ ) If ``true``, the shader will keep the scale set for the mesh. Otherwise, the scale is lost when billboarding. @@ -136,3 +136,4 @@ If ``true``, the shader will keep the scale set for the mesh. Otherwise, the sca .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodebooleanconstant.rst b/classes/class_visualshadernodebooleanconstant.rst index 32da5a46767..67911450e3a 100644 --- a/classes/class_visualshadernodebooleanconstant.rst +++ b/classes/class_visualshadernodebooleanconstant.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_constant** **(** :ref:`bool` value **)** -- :ref:`bool` **get_constant** **(** **)** +- |void| **set_constant**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_constant**\ (\ ) A boolean constant which represents a state of this node. @@ -64,3 +64,4 @@ A boolean constant which represents a state of this node. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodebooleanparameter.rst b/classes/class_visualshadernodebooleanparameter.rst index 3e9ffa31ee4..2cf5f65b851 100644 --- a/classes/class_visualshadernodebooleanparameter.rst +++ b/classes/class_visualshadernodebooleanparameter.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_default_value** **(** :ref:`bool` value **)** -- :ref:`bool` **get_default_value** **(** **)** +- |void| **set_default_value**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_default_value**\ (\ ) A default value to be assigned within the shader. @@ -69,8 +69,8 @@ A default value to be assigned within the shader. .. rst-class:: classref-property-setget -- void **set_default_value_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_default_value_enabled** **(** **)** +- |void| **set_default_value_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_default_value_enabled**\ (\ ) Enables usage of the :ref:`default_value`. @@ -81,3 +81,4 @@ Enables usage of the :ref:`default_value` value **)** -- :ref:`OpType` **get_op_type** **(** **)** +- |void| **set_op_type**\ (\ value\: :ref:`OpType`\ ) +- :ref:`OpType` **get_op_type**\ (\ ) A type of operands and returned value. @@ -133,3 +133,4 @@ A type of operands and returned value. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodecolorconstant.rst b/classes/class_visualshadernodecolorconstant.rst index e4605cfe5d7..cdebaa66d4f 100644 --- a/classes/class_visualshadernodecolorconstant.rst +++ b/classes/class_visualshadernodecolorconstant.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_constant** **(** :ref:`Color` value **)** -- :ref:`Color` **get_constant** **(** **)** +- |void| **set_constant**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_constant**\ (\ ) A :ref:`Color` constant which represents a state of this node. @@ -64,3 +64,4 @@ A :ref:`Color` constant which represents a state of this node. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodecolorfunc.rst b/classes/class_visualshadernodecolorfunc.rst index 442dbec4048..cfcc484f2e1 100644 --- a/classes/class_visualshadernodecolorfunc.rst +++ b/classes/class_visualshadernodecolorfunc.rst @@ -121,8 +121,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_function** **(** :ref:`Function` value **)** -- :ref:`Function` **get_function** **(** **)** +- |void| **set_function**\ (\ value\: :ref:`Function`\ ) +- :ref:`Function` **get_function**\ (\ ) A function to be applied to the input color. See :ref:`Function` for options. @@ -133,3 +133,4 @@ A function to be applied to the input color. See :ref:`Function` value **)** -- :ref:`Operator` **get_operator** **(** **)** +- |void| **set_operator**\ (\ value\: :ref:`Operator`\ ) +- :ref:`Operator` **get_operator**\ (\ ) An operator to be applied to the inputs. See :ref:`Operator` for options. @@ -217,3 +217,4 @@ An operator to be applied to the inputs. See :ref:`Operator` value **)** -- :ref:`Color` **get_default_value** **(** **)** +- |void| **set_default_value**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_default_value**\ (\ ) A default value to be assigned within the shader. @@ -69,8 +69,8 @@ A default value to be assigned within the shader. .. rst-class:: classref-property-setget -- void **set_default_value_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_default_value_enabled** **(** **)** +- |void| **set_default_value_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_default_value_enabled**\ (\ ) Enables usage of the :ref:`default_value`. @@ -81,3 +81,4 @@ Enables usage of the :ref:`default_value` value **)** -- :ref:`String` **get_description** **(** **)** +- |void| **set_description**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_description**\ (\ ) An additional description which placed below the title. @@ -69,8 +69,8 @@ An additional description which placed below the title. .. rst-class:: classref-property-setget -- void **set_title** **(** :ref:`String` value **)** -- :ref:`String` **get_title** **(** **)** +- |void| **set_title**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_title**\ (\ ) A title of the node. @@ -81,3 +81,4 @@ A title of the node. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodecompare.rst b/classes/class_visualshadernodecompare.rst index 2a6547e763b..025b7eccffd 100644 --- a/classes/class_visualshadernodecompare.rst +++ b/classes/class_visualshadernodecompare.rst @@ -241,8 +241,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_condition** **(** :ref:`Condition` value **)** -- :ref:`Condition` **get_condition** **(** **)** +- |void| **set_condition**\ (\ value\: :ref:`Condition`\ ) +- :ref:`Condition` **get_condition**\ (\ ) Extra condition which is applied if :ref:`type` is set to :ref:`CTYPE_VECTOR_3D`. @@ -258,8 +258,8 @@ Extra condition which is applied if :ref:`type` value **)** -- :ref:`Function` **get_function** **(** **)** +- |void| **set_function**\ (\ value\: :ref:`Function`\ ) +- :ref:`Function` **get_function**\ (\ ) A comparison function. See :ref:`Function` for options. @@ -275,8 +275,8 @@ A comparison function. See :ref:`Function .. rst-class:: classref-property-setget -- void **set_comparison_type** **(** :ref:`ComparisonType` value **)** -- :ref:`ComparisonType` **get_comparison_type** **(** **)** +- |void| **set_comparison_type**\ (\ value\: :ref:`ComparisonType`\ ) +- :ref:`ComparisonType` **get_comparison_type**\ (\ ) The type to be used in the comparison. See :ref:`ComparisonType` for options. @@ -287,3 +287,4 @@ The type to be used in the comparison. See :ref:`ComparisonType` **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: @@ -135,8 +135,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_cube_map** **(** :ref:`Cubemap` value **)** -- :ref:`Cubemap` **get_cube_map** **(** **)** +- |void| **set_cube_map**\ (\ value\: :ref:`Cubemap`\ ) +- :ref:`Cubemap` **get_cube_map**\ (\ ) The :ref:`Cubemap` texture to sample when using :ref:`SOURCE_TEXTURE` as :ref:`source`. @@ -152,8 +152,8 @@ The :ref:`Cubemap` texture to sample when using :ref:`SOURCE_TEXT .. rst-class:: classref-property-setget -- void **set_source** **(** :ref:`Source` value **)** -- :ref:`Source` **get_source** **(** **)** +- |void| **set_source**\ (\ value\: :ref:`Source`\ ) +- :ref:`Source` **get_source**\ (\ ) Defines which source should be used for the sampling. See :ref:`Source` for options. @@ -169,8 +169,8 @@ Defines which source should be used for the sampling. See :ref:`Source` value **)** -- :ref:`TextureType` **get_texture_type** **(** **)** +- |void| **set_texture_type**\ (\ value\: :ref:`TextureType`\ ) +- :ref:`TextureType` **get_texture_type**\ (\ ) Defines the type of data provided by the source texture. See :ref:`TextureType` for options. @@ -181,3 +181,4 @@ Defines the type of data provided by the source texture. See :ref:`TextureType` value **)** -- :ref:`CurveTexture` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`CurveTexture`\ ) +- :ref:`CurveTexture` **get_texture**\ (\ ) The source texture. @@ -62,3 +62,4 @@ The source texture. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodecurvexyztexture.rst b/classes/class_visualshadernodecurvexyztexture.rst index 3ad6b3c36ea..df92c3d4a00 100644 --- a/classes/class_visualshadernodecurvexyztexture.rst +++ b/classes/class_visualshadernodecurvexyztexture.rst @@ -50,8 +50,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_texture** **(** :ref:`CurveXYZTexture` value **)** -- :ref:`CurveXYZTexture` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`CurveXYZTexture`\ ) +- :ref:`CurveXYZTexture` **get_texture**\ (\ ) The source texture. @@ -62,3 +62,4 @@ The source texture. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodecustom.rst b/classes/class_visualshadernodecustom.rst index ee0398f1d29..b88fc312f0f 100644 --- a/classes/class_visualshadernodecustom.rst +++ b/classes/class_visualshadernodecustom.rst @@ -44,51 +44,51 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_category` **(** **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_code` **(** :ref:`String[]` input_vars, :ref:`String[]` output_vars, :ref:`Mode` mode, :ref:`Type` type **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_default_input_port` **(** :ref:`PortType` type **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_description` **(** **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_func_code` **(** :ref:`Mode` mode, :ref:`Type` type **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_global_code` **(** :ref:`Mode` mode **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_input_port_count` **(** **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`_get_input_port_default_value` **(** :ref:`int` port **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_input_port_name` **(** :ref:`int` port **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PortType` | :ref:`_get_input_port_type` **(** :ref:`int` port **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_name` **(** **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_output_port_count` **(** **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_output_port_name` **(** :ref:`int` port **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PortType` | :ref:`_get_output_port_type` **(** :ref:`int` port **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_property_count` **(** **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_property_default_index` **(** :ref:`int` index **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_property_name` **(** :ref:`int` index **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_property_options` **(** :ref:`int` index **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PortType` | :ref:`_get_return_icon_type` **(** **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_available` **(** :ref:`Mode` mode, :ref:`Type` type **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_highend` **(** **)** |virtual| |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_option_index` **(** :ref:`int` option **)** |const| | - +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_category`\ (\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_code`\ (\ input_vars\: :ref:`Array`\[:ref:`String`\], output_vars\: :ref:`Array`\[:ref:`String`\], mode\: :ref:`Mode`, type\: :ref:`Type`\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_default_input_port`\ (\ type\: :ref:`PortType`\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_description`\ (\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_func_code`\ (\ mode\: :ref:`Mode`, type\: :ref:`Type`\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_global_code`\ (\ mode\: :ref:`Mode`\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_input_port_count`\ (\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_get_input_port_default_value`\ (\ port\: :ref:`int`\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_input_port_name`\ (\ port\: :ref:`int`\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PortType` | :ref:`_get_input_port_type`\ (\ port\: :ref:`int`\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_name`\ (\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_output_port_count`\ (\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_output_port_name`\ (\ port\: :ref:`int`\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PortType` | :ref:`_get_output_port_type`\ (\ port\: :ref:`int`\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_property_count`\ (\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_property_default_index`\ (\ index\: :ref:`int`\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_property_name`\ (\ index\: :ref:`int`\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_property_options`\ (\ index\: :ref:`int`\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PortType` | :ref:`_get_return_icon_type`\ (\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_available`\ (\ mode\: :ref:`Mode`, type\: :ref:`Type`\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_highend`\ (\ ) |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_option_index`\ (\ option\: :ref:`int`\ ) |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -103,7 +103,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **_get_category** **(** **)** |virtual| |const| +:ref:`String` **_get_category**\ (\ ) |virtual| |const| Override this method to define the path to the associated custom node in the Visual Shader Editor's members dialog. The path may look like ``"MyGame/MyFunctions/Noise"``. @@ -117,7 +117,7 @@ Defining this method is **optional**. If not overridden, the node will be filed .. rst-class:: classref-method -:ref:`String` **_get_code** **(** :ref:`String[]` input_vars, :ref:`String[]` output_vars, :ref:`Mode` mode, :ref:`Type` type **)** |virtual| |const| +:ref:`String` **_get_code**\ (\ input_vars\: :ref:`Array`\[:ref:`String`\], output_vars\: :ref:`Array`\[:ref:`String`\], mode\: :ref:`Mode`, type\: :ref:`Type`\ ) |virtual| |const| Override this method to define the actual shader code of the associated custom node. The shader code should be returned as a string, which can have multiple lines (the ``"""`` multiline string construct can be used for convenience). @@ -137,7 +137,7 @@ Defining this method is **required**. .. rst-class:: classref-method -:ref:`int` **_get_default_input_port** **(** :ref:`PortType` type **)** |virtual| |const| +:ref:`int` **_get_default_input_port**\ (\ type\: :ref:`PortType`\ ) |virtual| |const| Override this method to define the input port which should be connected by default when this node is created as a result of dragging a connection from an existing node to the empty space on the graph. @@ -151,7 +151,7 @@ Defining this method is **optional**. If not overridden, the connection will be .. rst-class:: classref-method -:ref:`String` **_get_description** **(** **)** |virtual| |const| +:ref:`String` **_get_description**\ (\ ) |virtual| |const| Override this method to define the description of the associated custom node in the Visual Shader Editor's members dialog. @@ -165,7 +165,7 @@ Defining this method is **optional**. .. rst-class:: classref-method -:ref:`String` **_get_func_code** **(** :ref:`Mode` mode, :ref:`Type` type **)** |virtual| |const| +:ref:`String` **_get_func_code**\ (\ mode\: :ref:`Mode`, type\: :ref:`Type`\ ) |virtual| |const| Override this method to add a shader code to the beginning of each shader function (once). The shader code should be returned as a string, which can have multiple lines (the ``"""`` multiline string construct can be used for convenience). @@ -183,7 +183,7 @@ Defining this method is **optional**. .. rst-class:: classref-method -:ref:`String` **_get_global_code** **(** :ref:`Mode` mode **)** |virtual| |const| +:ref:`String` **_get_global_code**\ (\ mode\: :ref:`Mode`\ ) |virtual| |const| Override this method to add shader code on top of the global shader, to define your own standard library of reusable methods, varyings, constants, uniforms, etc. The shader code should be returned as a string, which can have multiple lines (the ``"""`` multiline string construct can be used for convenience). @@ -201,7 +201,7 @@ Defining this method is **optional**. .. rst-class:: classref-method -:ref:`int` **_get_input_port_count** **(** **)** |virtual| |const| +:ref:`int` **_get_input_port_count**\ (\ ) |virtual| |const| Override this method to define the number of input ports of the associated custom node. @@ -215,7 +215,7 @@ Defining this method is **required**. If not overridden, the node has no input p .. rst-class:: classref-method -:ref:`Variant` **_get_input_port_default_value** **(** :ref:`int` port **)** |virtual| |const| +:ref:`Variant` **_get_input_port_default_value**\ (\ port\: :ref:`int`\ ) |virtual| |const| Override this method to define the default value for the specified input port. Prefer use this over :ref:`VisualShaderNode.set_input_port_default_value`. @@ -229,7 +229,7 @@ Defining this method is **required**. If not overridden, the node has no default .. rst-class:: classref-method -:ref:`String` **_get_input_port_name** **(** :ref:`int` port **)** |virtual| |const| +:ref:`String` **_get_input_port_name**\ (\ port\: :ref:`int`\ ) |virtual| |const| Override this method to define the names of input ports of the associated custom node. The names are used both for the input slots in the editor and as identifiers in the shader code, and are passed in the ``input_vars`` array in :ref:`_get_code`. @@ -243,7 +243,7 @@ Defining this method is **optional**, but recommended. If not overridden, input .. rst-class:: classref-method -:ref:`PortType` **_get_input_port_type** **(** :ref:`int` port **)** |virtual| |const| +:ref:`PortType` **_get_input_port_type**\ (\ port\: :ref:`int`\ ) |virtual| |const| Override this method to define the returned type of each input port of the associated custom node (see :ref:`PortType` for possible types). @@ -257,7 +257,7 @@ Defining this method is **optional**, but recommended. If not overridden, input .. rst-class:: classref-method -:ref:`String` **_get_name** **(** **)** |virtual| |const| +:ref:`String` **_get_name**\ (\ ) |virtual| |const| Override this method to define the name of the associated custom node in the Visual Shader Editor's members dialog and graph. @@ -271,7 +271,7 @@ Defining this method is **optional**, but recommended. If not overridden, the no .. rst-class:: classref-method -:ref:`int` **_get_output_port_count** **(** **)** |virtual| |const| +:ref:`int` **_get_output_port_count**\ (\ ) |virtual| |const| Override this method to define the number of output ports of the associated custom node. @@ -285,7 +285,7 @@ Defining this method is **required**. If not overridden, the node has no output .. rst-class:: classref-method -:ref:`String` **_get_output_port_name** **(** :ref:`int` port **)** |virtual| |const| +:ref:`String` **_get_output_port_name**\ (\ port\: :ref:`int`\ ) |virtual| |const| Override this method to define the names of output ports of the associated custom node. The names are used both for the output slots in the editor and as identifiers in the shader code, and are passed in the ``output_vars`` array in :ref:`_get_code`. @@ -299,7 +299,7 @@ Defining this method is **optional**, but recommended. If not overridden, output .. rst-class:: classref-method -:ref:`PortType` **_get_output_port_type** **(** :ref:`int` port **)** |virtual| |const| +:ref:`PortType` **_get_output_port_type**\ (\ port\: :ref:`int`\ ) |virtual| |const| Override this method to define the returned type of each output port of the associated custom node (see :ref:`PortType` for possible types). @@ -313,7 +313,7 @@ Defining this method is **optional**, but recommended. If not overridden, output .. rst-class:: classref-method -:ref:`int` **_get_property_count** **(** **)** |virtual| |const| +:ref:`int` **_get_property_count**\ (\ ) |virtual| |const| Override this method to define the number of the properties. @@ -327,7 +327,7 @@ Defining this method is **optional**. .. rst-class:: classref-method -:ref:`int` **_get_property_default_index** **(** :ref:`int` index **)** |virtual| |const| +:ref:`int` **_get_property_default_index**\ (\ index\: :ref:`int`\ ) |virtual| |const| Override this method to define the default index of the property of the associated custom node. @@ -341,7 +341,7 @@ Defining this method is **optional**. .. rst-class:: classref-method -:ref:`String` **_get_property_name** **(** :ref:`int` index **)** |virtual| |const| +:ref:`String` **_get_property_name**\ (\ index\: :ref:`int`\ ) |virtual| |const| Override this method to define the names of the property of the associated custom node. @@ -355,7 +355,7 @@ Defining this method is **optional**. .. rst-class:: classref-method -:ref:`PackedStringArray` **_get_property_options** **(** :ref:`int` index **)** |virtual| |const| +:ref:`PackedStringArray` **_get_property_options**\ (\ index\: :ref:`int`\ ) |virtual| |const| Override this method to define the options inside the drop-down list property of the associated custom node. @@ -369,7 +369,7 @@ Defining this method is **optional**. .. rst-class:: classref-method -:ref:`PortType` **_get_return_icon_type** **(** **)** |virtual| |const| +:ref:`PortType` **_get_return_icon_type**\ (\ ) |virtual| |const| Override this method to define the return icon of the associated custom node in the Visual Shader Editor's members dialog. @@ -383,7 +383,7 @@ Defining this method is **optional**. If not overridden, no return icon is shown .. rst-class:: classref-method -:ref:`bool` **_is_available** **(** :ref:`Mode` mode, :ref:`Type` type **)** |virtual| |const| +:ref:`bool` **_is_available**\ (\ mode\: :ref:`Mode`, type\: :ref:`Type`\ ) |virtual| |const| Override this method to prevent the node to be visible in the member dialog for the certain ``mode`` (see :ref:`Mode`) and/or ``type`` (see :ref:`Type`). @@ -397,7 +397,7 @@ Defining this method is **optional**. If not overridden, it's ``true``. .. rst-class:: classref-method -:ref:`bool` **_is_highend** **(** **)** |virtual| |const| +:ref:`bool` **_is_highend**\ (\ ) |virtual| |const| Override this method to enable high-end mark in the Visual Shader Editor's members dialog. @@ -411,7 +411,7 @@ Defining this method is **optional**. If not overridden, it's ``false``. .. rst-class:: classref-method -:ref:`int` **get_option_index** **(** :ref:`int` option **)** |const| +:ref:`int` **get_option_index**\ (\ option\: :ref:`int`\ ) |const| Returns the selected index of the drop-down list option within a graph. You may use this function to define the specific behavior in the :ref:`_get_code` or :ref:`_get_global_code`. @@ -422,3 +422,4 @@ Returns the selected index of the drop-down list option within a graph. You may .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodederivativefunc.rst b/classes/class_visualshadernodederivativefunc.rst index 8a4e7ed38ea..07a98340ff5 100644 --- a/classes/class_visualshadernodederivativefunc.rst +++ b/classes/class_visualshadernodederivativefunc.rst @@ -193,8 +193,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_function** **(** :ref:`Function` value **)** -- :ref:`Function` **get_function** **(** **)** +- |void| **set_function**\ (\ value\: :ref:`Function`\ ) +- :ref:`Function` **get_function**\ (\ ) A derivative function type. See :ref:`Function` for options. @@ -210,8 +210,8 @@ A derivative function type. See :ref:`Function` value **)** -- :ref:`OpType` **get_op_type** **(** **)** +- |void| **set_op_type**\ (\ value\: :ref:`OpType`\ ) +- :ref:`OpType` **get_op_type**\ (\ ) A type of operands and returned value. See :ref:`OpType` for options. @@ -227,8 +227,8 @@ A type of operands and returned value. See :ref:`OpType` value **)** -- :ref:`Precision` **get_precision** **(** **)** +- |void| **set_precision**\ (\ value\: :ref:`Precision`\ ) +- :ref:`Precision` **get_precision**\ (\ ) Sets the level of precision to use for the derivative function. See :ref:`Precision` for options. When using the GL Compatibility renderer, this setting has no effect. @@ -239,3 +239,4 @@ Sets the level of precision to use for the derivative function. See :ref:`Precis .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodedeterminant.rst b/classes/class_visualshadernodedeterminant.rst index b85ba816cdf..082fe6534c6 100644 --- a/classes/class_visualshadernodedeterminant.rst +++ b/classes/class_visualshadernodedeterminant.rst @@ -28,3 +28,4 @@ Translates to ``determinant(x)`` in the shader language. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodedistancefade.rst b/classes/class_visualshadernodedistancefade.rst index 75abdfd09eb..bfd4e974152 100644 --- a/classes/class_visualshadernodedistancefade.rst +++ b/classes/class_visualshadernodedistancefade.rst @@ -28,3 +28,4 @@ The distance fade effect fades out each pixel based on its distance to another o .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodedotproduct.rst b/classes/class_visualshadernodedotproduct.rst index 0da9ecf2f4f..280d4ac4abf 100644 --- a/classes/class_visualshadernodedotproduct.rst +++ b/classes/class_visualshadernodedotproduct.rst @@ -28,3 +28,4 @@ Translates to ``dot(a, b)`` in the shader language. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeexpression.rst b/classes/class_visualshadernodeexpression.rst index 84fe57136e9..67d2955e1aa 100644 --- a/classes/class_visualshadernodeexpression.rst +++ b/classes/class_visualshadernodeexpression.rst @@ -54,8 +54,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_expression** **(** :ref:`String` value **)** -- :ref:`String` **get_expression** **(** **)** +- |void| **set_expression**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_expression**\ (\ ) An expression in Godot Shading Language, which will be injected at the start of the graph's matching shader function (``vertex``, ``fragment``, or ``light``), and thus cannot be used to declare functions, varyings, uniforms, or global constants. @@ -66,3 +66,4 @@ An expression in Godot Shading Language, which will be injected at the start of .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodefaceforward.rst b/classes/class_visualshadernodefaceforward.rst index cfad3a9326e..e79f980d000 100644 --- a/classes/class_visualshadernodefaceforward.rst +++ b/classes/class_visualshadernodefaceforward.rst @@ -28,3 +28,4 @@ Translates to ``faceforward(N, I, Nref)`` in the shader language. The function h .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodefloatconstant.rst b/classes/class_visualshadernodefloatconstant.rst index da21b8aaf06..b1a924bad7e 100644 --- a/classes/class_visualshadernodefloatconstant.rst +++ b/classes/class_visualshadernodefloatconstant.rst @@ -50,8 +50,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_constant** **(** :ref:`float` value **)** -- :ref:`float` **get_constant** **(** **)** +- |void| **set_constant**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_constant**\ (\ ) A floating-point constant which represents a state of this node. @@ -62,3 +62,4 @@ A floating-point constant which represents a state of this node. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodefloatfunc.rst b/classes/class_visualshadernodefloatfunc.rst index 81f2e131e45..cc7cb528aa7 100644 --- a/classes/class_visualshadernodefloatfunc.rst +++ b/classes/class_visualshadernodefloatfunc.rst @@ -329,8 +329,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_function** **(** :ref:`Function` value **)** -- :ref:`Function` **get_function** **(** **)** +- |void| **set_function**\ (\ value\: :ref:`Function`\ ) +- :ref:`Function` **get_function**\ (\ ) A function to be applied to the scalar. See :ref:`Function` for options. @@ -341,3 +341,4 @@ A function to be applied to the scalar. See :ref:`Function` value **)** -- :ref:`Operator` **get_operator** **(** **)** +- |void| **set_operator**\ (\ value\: :ref:`Operator`\ ) +- :ref:`Operator` **get_operator**\ (\ ) An operator to be applied to the inputs. See :ref:`Operator` for options. @@ -165,3 +165,4 @@ An operator to be applied to the inputs. See :ref:`Operator` value **)** -- :ref:`float` **get_default_value** **(** **)** +- |void| **set_default_value**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_default_value**\ (\ ) A default value to be assigned within the shader. @@ -124,8 +124,8 @@ A default value to be assigned within the shader. .. rst-class:: classref-property-setget -- void **set_default_value_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_default_value_enabled** **(** **)** +- |void| **set_default_value_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_default_value_enabled**\ (\ ) Enables usage of the :ref:`default_value`. @@ -141,8 +141,8 @@ Enables usage of the :ref:`default_value` value **)** -- :ref:`Hint` **get_hint** **(** **)** +- |void| **set_hint**\ (\ value\: :ref:`Hint`\ ) +- :ref:`Hint` **get_hint**\ (\ ) A hint applied to the uniform, which controls the values it can take when set through the Inspector. @@ -158,8 +158,8 @@ A hint applied to the uniform, which controls the values it can take when set th .. rst-class:: classref-property-setget -- void **set_max** **(** :ref:`float` value **)** -- :ref:`float` **get_max** **(** **)** +- |void| **set_max**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_max**\ (\ ) Minimum value for range hints. Used if :ref:`hint` is set to :ref:`HINT_RANGE` or :ref:`HINT_RANGE_STEP`. @@ -175,8 +175,8 @@ Minimum value for range hints. Used if :ref:`hint` value **)** -- :ref:`float` **get_min** **(** **)** +- |void| **set_min**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_min**\ (\ ) Maximum value for range hints. Used if :ref:`hint` is set to :ref:`HINT_RANGE` or :ref:`HINT_RANGE_STEP`. @@ -192,8 +192,8 @@ Maximum value for range hints. Used if :ref:`hint` value **)** -- :ref:`float` **get_step** **(** **)** +- |void| **set_step**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_step**\ (\ ) Step (increment) value for the range hint with step. Used if :ref:`hint` is set to :ref:`HINT_RANGE_STEP`. @@ -204,3 +204,4 @@ Step (increment) value for the range hint with step. Used if :ref:`hint` **(** :ref:`int` id, :ref:`int` type, :ref:`String` name **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_output_port` **(** :ref:`int` id, :ref:`int` type, :ref:`String` name **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_input_ports` **(** **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear_output_ports` **(** **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_free_input_port_id` **(** **)** |const| | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_free_output_port_id` **(** **)** |const| | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_input_port_count` **(** **)** |const| | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_inputs` **(** **)** |const| | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_output_port_count` **(** **)** |const| | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_outputs` **(** **)** |const| | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_input_port` **(** :ref:`int` id **)** |const| | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_output_port` **(** :ref:`int` id **)** |const| | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_valid_port_name` **(** :ref:`String` name **)** |const| | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_input_port` **(** :ref:`int` id **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_output_port` **(** :ref:`int` id **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_input_port_name` **(** :ref:`int` id, :ref:`String` name **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_input_port_type` **(** :ref:`int` id, :ref:`int` type **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_inputs` **(** :ref:`String` inputs **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_output_port_name` **(** :ref:`int` id, :ref:`String` name **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_output_port_type` **(** :ref:`int` id, :ref:`int` type **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_outputs` **(** :ref:`String` outputs **)** | - +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_input_port`\ (\ id\: :ref:`int`, type\: :ref:`int`, name\: :ref:`String`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_output_port`\ (\ id\: :ref:`int`, type\: :ref:`int`, name\: :ref:`String`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_input_ports`\ (\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_output_ports`\ (\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_free_input_port_id`\ (\ ) |const| | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_free_output_port_id`\ (\ ) |const| | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_input_port_count`\ (\ ) |const| | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_inputs`\ (\ ) |const| | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_output_port_count`\ (\ ) |const| | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_outputs`\ (\ ) |const| | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_input_port`\ (\ id\: :ref:`int`\ ) |const| | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_output_port`\ (\ id\: :ref:`int`\ ) |const| | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_valid_port_name`\ (\ name\: :ref:`String`\ ) |const| | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_input_port`\ (\ id\: :ref:`int`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_output_port`\ (\ id\: :ref:`int`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_input_port_name`\ (\ id\: :ref:`int`, name\: :ref:`String`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_input_port_type`\ (\ id\: :ref:`int`, type\: :ref:`int`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_inputs`\ (\ inputs\: :ref:`String`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_output_port_name`\ (\ id\: :ref:`int`, name\: :ref:`String`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_output_port_type`\ (\ id\: :ref:`int`, type\: :ref:`int`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_outputs`\ (\ outputs\: :ref:`String`\ ) | + +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -88,7 +88,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_input_port** **(** :ref:`int` id, :ref:`int` type, :ref:`String` name **)** +|void| **add_input_port**\ (\ id\: :ref:`int`, type\: :ref:`int`, name\: :ref:`String`\ ) Adds an input port with the specified ``type`` (see :ref:`PortType`) and ``name``. @@ -100,7 +100,7 @@ Adds an input port with the specified ``type`` (see :ref:`PortType` id, :ref:`int` type, :ref:`String` name **)** +|void| **add_output_port**\ (\ id\: :ref:`int`, type\: :ref:`int`, name\: :ref:`String`\ ) Adds an output port with the specified ``type`` (see :ref:`PortType`) and ``name``. @@ -112,7 +112,7 @@ Adds an output port with the specified ``type`` (see :ref:`PortType` **get_free_input_port_id** **(** **)** |const| +:ref:`int` **get_free_input_port_id**\ (\ ) |const| Returns a free input port ID which can be used in :ref:`add_input_port`. @@ -148,7 +148,7 @@ Returns a free input port ID which can be used in :ref:`add_input_port` **get_free_output_port_id** **(** **)** |const| +:ref:`int` **get_free_output_port_id**\ (\ ) |const| Returns a free output port ID which can be used in :ref:`add_output_port`. @@ -160,7 +160,7 @@ Returns a free output port ID which can be used in :ref:`add_output_port` **get_input_port_count** **(** **)** |const| +:ref:`int` **get_input_port_count**\ (\ ) |const| Returns the number of input ports in use. Alternative for :ref:`get_free_input_port_id`. @@ -172,7 +172,7 @@ Returns the number of input ports in use. Alternative for :ref:`get_free_input_p .. rst-class:: classref-method -:ref:`String` **get_inputs** **(** **)** |const| +:ref:`String` **get_inputs**\ (\ ) |const| Returns a :ref:`String` description of the input ports as a colon-separated list using the format ``id,type,name;`` (see :ref:`add_input_port`). @@ -184,7 +184,7 @@ Returns a :ref:`String` description of the input ports as a colon- .. rst-class:: classref-method -:ref:`int` **get_output_port_count** **(** **)** |const| +:ref:`int` **get_output_port_count**\ (\ ) |const| Returns the number of output ports in use. Alternative for :ref:`get_free_output_port_id`. @@ -196,7 +196,7 @@ Returns the number of output ports in use. Alternative for :ref:`get_free_output .. rst-class:: classref-method -:ref:`String` **get_outputs** **(** **)** |const| +:ref:`String` **get_outputs**\ (\ ) |const| Returns a :ref:`String` description of the output ports as a colon-separated list using the format ``id,type,name;`` (see :ref:`add_output_port`). @@ -208,7 +208,7 @@ Returns a :ref:`String` description of the output ports as a colon .. rst-class:: classref-method -:ref:`bool` **has_input_port** **(** :ref:`int` id **)** |const| +:ref:`bool` **has_input_port**\ (\ id\: :ref:`int`\ ) |const| Returns ``true`` if the specified input port exists. @@ -220,7 +220,7 @@ Returns ``true`` if the specified input port exists. .. rst-class:: classref-method -:ref:`bool` **has_output_port** **(** :ref:`int` id **)** |const| +:ref:`bool` **has_output_port**\ (\ id\: :ref:`int`\ ) |const| Returns ``true`` if the specified output port exists. @@ -232,7 +232,7 @@ Returns ``true`` if the specified output port exists. .. rst-class:: classref-method -:ref:`bool` **is_valid_port_name** **(** :ref:`String` name **)** |const| +:ref:`bool` **is_valid_port_name**\ (\ name\: :ref:`String`\ ) |const| Returns ``true`` if the specified port name does not override an existed port name and is valid within the shader. @@ -244,7 +244,7 @@ Returns ``true`` if the specified port name does not override an existed port na .. rst-class:: classref-method -void **remove_input_port** **(** :ref:`int` id **)** +|void| **remove_input_port**\ (\ id\: :ref:`int`\ ) Removes the specified input port. @@ -256,7 +256,7 @@ Removes the specified input port. .. rst-class:: classref-method -void **remove_output_port** **(** :ref:`int` id **)** +|void| **remove_output_port**\ (\ id\: :ref:`int`\ ) Removes the specified output port. @@ -268,7 +268,7 @@ Removes the specified output port. .. rst-class:: classref-method -void **set_input_port_name** **(** :ref:`int` id, :ref:`String` name **)** +|void| **set_input_port_name**\ (\ id\: :ref:`int`, name\: :ref:`String`\ ) Renames the specified input port. @@ -280,7 +280,7 @@ Renames the specified input port. .. rst-class:: classref-method -void **set_input_port_type** **(** :ref:`int` id, :ref:`int` type **)** +|void| **set_input_port_type**\ (\ id\: :ref:`int`, type\: :ref:`int`\ ) Sets the specified input port's type (see :ref:`PortType`). @@ -292,7 +292,7 @@ Sets the specified input port's type (see :ref:`PortType` inputs **)** +|void| **set_inputs**\ (\ inputs\: :ref:`String`\ ) Defines all input ports using a :ref:`String` formatted as a colon-separated list: ``id,type,name;`` (see :ref:`add_input_port`). @@ -304,7 +304,7 @@ Defines all input ports using a :ref:`String` formatted as a colon .. rst-class:: classref-method -void **set_output_port_name** **(** :ref:`int` id, :ref:`String` name **)** +|void| **set_output_port_name**\ (\ id\: :ref:`int`, name\: :ref:`String`\ ) Renames the specified output port. @@ -316,7 +316,7 @@ Renames the specified output port. .. rst-class:: classref-method -void **set_output_port_type** **(** :ref:`int` id, :ref:`int` type **)** +|void| **set_output_port_type**\ (\ id\: :ref:`int`, type\: :ref:`int`\ ) Sets the specified output port's type (see :ref:`PortType`). @@ -328,7 +328,7 @@ Sets the specified output port's type (see :ref:`PortType` outputs **)** +|void| **set_outputs**\ (\ outputs\: :ref:`String`\ ) Defines all output ports using a :ref:`String` formatted as a colon-separated list: ``id,type,name;`` (see :ref:`add_output_port`). @@ -339,3 +339,4 @@ Defines all output ports using a :ref:`String` formatted as a colo .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeif.rst b/classes/class_visualshadernodeif.rst index 644cff3d0e9..e807197e77d 100644 --- a/classes/class_visualshadernodeif.rst +++ b/classes/class_visualshadernodeif.rst @@ -28,3 +28,4 @@ This visual shader node has six input ports. Port 1 and 2 provide the two floati .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeinput.rst b/classes/class_visualshadernodeinput.rst index 1c26489150e..da30088329a 100644 --- a/classes/class_visualshadernodeinput.rst +++ b/classes/class_visualshadernodeinput.rst @@ -48,9 +48,9 @@ Methods .. table:: :widths: auto - +-----------------------------+--------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_input_real_name` **(** **)** |const| | - +-----------------------------+--------------------------------------------------------------------------------------------------------+ + +-----------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_input_real_name`\ (\ ) |const| | + +-----------------------------+--------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -65,7 +65,7 @@ Signals .. rst-class:: classref-signal -**input_type_changed** **(** **)** +**input_type_changed**\ (\ ) Emitted when input is changed via :ref:`input_name`. @@ -86,8 +86,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_input_name** **(** :ref:`String` value **)** -- :ref:`String` **get_input_name** **(** **)** +- |void| **set_input_name**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_input_name**\ (\ ) One of the several input constants in lower-case style like: "vertex" (``VERTEX``) or "point_size" (``POINT_SIZE``). @@ -104,7 +104,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`String` **get_input_real_name** **(** **)** |const| +:ref:`String` **get_input_real_name**\ (\ ) |const| Returns a translated name of the current constant in the Godot Shader Language. E.g. ``"ALBEDO"`` if the :ref:`input_name` equal to ``"albedo"``. @@ -115,3 +115,4 @@ Returns a translated name of the current constant in the Godot Shader Language. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeintconstant.rst b/classes/class_visualshadernodeintconstant.rst index a66a552c211..e8cfcf8b13e 100644 --- a/classes/class_visualshadernodeintconstant.rst +++ b/classes/class_visualshadernodeintconstant.rst @@ -50,8 +50,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_constant** **(** :ref:`int` value **)** -- :ref:`int` **get_constant** **(** **)** +- |void| **set_constant**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_constant**\ (\ ) An integer constant which represents a state of this node. @@ -62,3 +62,4 @@ An integer constant which represents a state of this node. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeintfunc.rst b/classes/class_visualshadernodeintfunc.rst index 9e26fff36cc..b8c58f7349e 100644 --- a/classes/class_visualshadernodeintfunc.rst +++ b/classes/class_visualshadernodeintfunc.rst @@ -105,8 +105,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_function** **(** :ref:`Function` value **)** -- :ref:`Function` **get_function** **(** **)** +- |void| **set_function**\ (\ value\: :ref:`Function`\ ) +- :ref:`Function` **get_function**\ (\ ) A function to be applied to the scalar. See :ref:`Function` for options. @@ -117,3 +117,4 @@ A function to be applied to the scalar. See :ref:`Function` value **)** -- :ref:`Operator` **get_operator** **(** **)** +- |void| **set_operator**\ (\ value\: :ref:`Operator`\ ) +- :ref:`Operator` **get_operator**\ (\ ) An operator to be applied to the inputs. See :ref:`Operator` for options. @@ -181,3 +181,4 @@ An operator to be applied to the inputs. See :ref:`Operator` value **)** -- :ref:`int` **get_default_value** **(** **)** +- |void| **set_default_value**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_default_value**\ (\ ) Default value of this parameter, which will be used if not set externally. :ref:`default_value_enabled` must be enabled; defaults to ``0`` otherwise. @@ -124,8 +124,8 @@ Default value of this parameter, which will be used if not set externally. :ref: .. rst-class:: classref-property-setget -- void **set_default_value_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_default_value_enabled** **(** **)** +- |void| **set_default_value_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_default_value_enabled**\ (\ ) If ``true``, the node will have a custom default value. @@ -141,8 +141,8 @@ If ``true``, the node will have a custom default value. .. rst-class:: classref-property-setget -- void **set_hint** **(** :ref:`Hint` value **)** -- :ref:`Hint` **get_hint** **(** **)** +- |void| **set_hint**\ (\ value\: :ref:`Hint`\ ) +- :ref:`Hint` **get_hint**\ (\ ) Range hint of this node. Use it to customize valid parameter range. @@ -158,8 +158,8 @@ Range hint of this node. Use it to customize valid parameter range. .. rst-class:: classref-property-setget -- void **set_max** **(** :ref:`int` value **)** -- :ref:`int` **get_max** **(** **)** +- |void| **set_max**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max**\ (\ ) The maximum value this parameter can take. :ref:`hint` must be either :ref:`HINT_RANGE` or :ref:`HINT_RANGE_STEP` for this to take effect. @@ -175,8 +175,8 @@ The maximum value this parameter can take. :ref:`hint` value **)** -- :ref:`int` **get_min** **(** **)** +- |void| **set_min**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_min**\ (\ ) The minimum value this parameter can take. :ref:`hint` must be either :ref:`HINT_RANGE` or :ref:`HINT_RANGE_STEP` for this to take effect. @@ -192,8 +192,8 @@ The minimum value this parameter can take. :ref:`hint` value **)** -- :ref:`int` **get_step** **(** **)** +- |void| **set_step**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_step**\ (\ ) The step between parameter's values. Forces the parameter to be a multiple of the given value. :ref:`hint` must be :ref:`HINT_RANGE_STEP` for this to take effect. @@ -204,3 +204,4 @@ The step between parameter's values. Forces the parameter to be a multiple of th .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeis.rst b/classes/class_visualshadernodeis.rst index 01732ffa967..658cd84d322 100644 --- a/classes/class_visualshadernodeis.rst +++ b/classes/class_visualshadernodeis.rst @@ -89,8 +89,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_function** **(** :ref:`Function` value **)** -- :ref:`Function` **get_function** **(** **)** +- |void| **set_function**\ (\ value\: :ref:`Function`\ ) +- :ref:`Function` **get_function**\ (\ ) The comparison function. See :ref:`Function` for options. @@ -101,3 +101,4 @@ The comparison function. See :ref:`Function` f .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodelinearscenedepth.rst b/classes/class_visualshadernodelinearscenedepth.rst index 2f1979ebbdb..a7697798b8c 100644 --- a/classes/class_visualshadernodelinearscenedepth.rst +++ b/classes/class_visualshadernodelinearscenedepth.rst @@ -28,3 +28,4 @@ This node can be used in fragment shaders. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodemix.rst b/classes/class_visualshadernodemix.rst index 6ef97977649..417868dfdbe 100644 --- a/classes/class_visualshadernodemix.rst +++ b/classes/class_visualshadernodemix.rst @@ -129,8 +129,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_op_type** **(** :ref:`OpType` value **)** -- :ref:`OpType` **get_op_type** **(** **)** +- |void| **set_op_type**\ (\ value\: :ref:`OpType`\ ) +- :ref:`OpType` **get_op_type**\ (\ ) A type of operands and returned value. @@ -141,3 +141,4 @@ A type of operands and returned value. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodemultiplyadd.rst b/classes/class_visualshadernodemultiplyadd.rst index a18fadfdf57..7b8d20ffeb6 100644 --- a/classes/class_visualshadernodemultiplyadd.rst +++ b/classes/class_visualshadernodemultiplyadd.rst @@ -105,8 +105,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_op_type** **(** :ref:`OpType` value **)** -- :ref:`OpType` **get_op_type** **(** **)** +- |void| **set_op_type**\ (\ value\: :ref:`OpType`\ ) +- :ref:`OpType` **get_op_type**\ (\ ) A type of operands and returned value. @@ -117,3 +117,4 @@ A type of operands and returned value. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeouterproduct.rst b/classes/class_visualshadernodeouterproduct.rst index 32fe7d4d7be..2fb69fbfd16 100644 --- a/classes/class_visualshadernodeouterproduct.rst +++ b/classes/class_visualshadernodeouterproduct.rst @@ -28,3 +28,4 @@ Description .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeoutput.rst b/classes/class_visualshadernodeoutput.rst index dddcc17f526..7039f579247 100644 --- a/classes/class_visualshadernodeoutput.rst +++ b/classes/class_visualshadernodeoutput.rst @@ -30,3 +30,4 @@ This visual shader node is present in all shader graphs in form of "Output" bloc .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeparameter.rst b/classes/class_visualshadernodeparameter.rst index 0750b5c0020..48ff3188759 100644 --- a/classes/class_visualshadernodeparameter.rst +++ b/classes/class_visualshadernodeparameter.rst @@ -101,8 +101,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_parameter_name** **(** :ref:`String` value **)** -- :ref:`String` **get_parameter_name** **(** **)** +- |void| **set_parameter_name**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_parameter_name**\ (\ ) Name of the parameter, by which it can be accessed through the :ref:`ShaderMaterial` properties. @@ -118,8 +118,8 @@ Name of the parameter, by which it can be accessed through the :ref:`ShaderMater .. rst-class:: classref-property-setget -- void **set_qualifier** **(** :ref:`Qualifier` value **)** -- :ref:`Qualifier` **get_qualifier** **(** **)** +- |void| **set_qualifier**\ (\ value\: :ref:`Qualifier`\ ) +- :ref:`Qualifier` **get_qualifier**\ (\ ) Defines the scope of the parameter. @@ -130,3 +130,4 @@ Defines the scope of the parameter. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeparameterref.rst b/classes/class_visualshadernodeparameterref.rst index db84f4a7b1f..41c07629e3e 100644 --- a/classes/class_visualshadernodeparameterref.rst +++ b/classes/class_visualshadernodeparameterref.rst @@ -50,8 +50,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_parameter_name** **(** :ref:`String` value **)** -- :ref:`String` **get_parameter_name** **(** **)** +- |void| **set_parameter_name**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_parameter_name**\ (\ ) The name of the parameter which this reference points to. @@ -62,3 +62,4 @@ The name of the parameter which this reference points to. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeparticleaccelerator.rst b/classes/class_visualshadernodeparticleaccelerator.rst index 52aade37abd..bf66312b4cf 100644 --- a/classes/class_visualshadernodeparticleaccelerator.rst +++ b/classes/class_visualshadernodeparticleaccelerator.rst @@ -97,8 +97,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_mode** **(** :ref:`Mode` value **)** -- :ref:`Mode` **get_mode** **(** **)** +- |void| **set_mode**\ (\ value\: :ref:`Mode`\ ) +- :ref:`Mode` **get_mode**\ (\ ) Defines in what manner the particles will be accelerated. @@ -109,3 +109,4 @@ Defines in what manner the particles will be accelerated. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeparticleboxemitter.rst b/classes/class_visualshadernodeparticleboxemitter.rst index 2e9043e5850..4485b055bb8 100644 --- a/classes/class_visualshadernodeparticleboxemitter.rst +++ b/classes/class_visualshadernodeparticleboxemitter.rst @@ -28,3 +28,4 @@ Description .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeparticleconevelocity.rst b/classes/class_visualshadernodeparticleconevelocity.rst index b0c7f8b892e..821f1f06183 100644 --- a/classes/class_visualshadernodeparticleconevelocity.rst +++ b/classes/class_visualshadernodeparticleconevelocity.rst @@ -28,3 +28,4 @@ This node can be used in "start" step of particle shader. It defines the initial .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeparticleemit.rst b/classes/class_visualshadernodeparticleemit.rst index 068f3459266..b43119d340e 100644 --- a/classes/class_visualshadernodeparticleemit.rst +++ b/classes/class_visualshadernodeparticleemit.rst @@ -105,8 +105,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_flags** **(** :ref:`EmitFlags` value **)** -- :ref:`EmitFlags` **get_flags** **(** **)** +- |void| **set_flags**\ (\ value\: :ref:`EmitFlags`\ ) +- :ref:`EmitFlags` **get_flags**\ (\ ) Flags used to override the properties defined in the sub-emitter's process material. @@ -117,3 +117,4 @@ Flags used to override the properties defined in the sub-emitter's process mater .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeparticleemitter.rst b/classes/class_visualshadernodeparticleemitter.rst index 76432277b62..6d9320036a1 100644 --- a/classes/class_visualshadernodeparticleemitter.rst +++ b/classes/class_visualshadernodeparticleemitter.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_mode_2d** **(** :ref:`bool` value **)** -- :ref:`bool` **is_mode_2d** **(** **)** +- |void| **set_mode_2d**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_mode_2d**\ (\ ) If ``true``, the result of this emitter is projected to 2D space. By default it is ``false`` and meant for use in 3D space. @@ -64,3 +64,4 @@ If ``true``, the result of this emitter is projected to 2D space. By default it .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeparticlemeshemitter.rst b/classes/class_visualshadernodeparticlemeshemitter.rst index 58a7a706ef5..fc44b4f07eb 100644 --- a/classes/class_visualshadernodeparticlemeshemitter.rst +++ b/classes/class_visualshadernodeparticlemeshemitter.rst @@ -54,8 +54,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_mesh** **(** :ref:`Mesh` value **)** -- :ref:`Mesh` **get_mesh** **(** **)** +- |void| **set_mesh**\ (\ value\: :ref:`Mesh`\ ) +- :ref:`Mesh` **get_mesh**\ (\ ) The :ref:`Mesh` that defines emission shape. @@ -71,8 +71,8 @@ The :ref:`Mesh` that defines emission shape. .. rst-class:: classref-property-setget -- void **set_surface_index** **(** :ref:`int` value **)** -- :ref:`int` **get_surface_index** **(** **)** +- |void| **set_surface_index**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_surface_index**\ (\ ) Index of the surface that emits particles. :ref:`use_all_surfaces` must be ``false`` for this to take effect. @@ -88,8 +88,8 @@ Index of the surface that emits particles. :ref:`use_all_surfaces` value **)** -- :ref:`bool` **is_use_all_surfaces** **(** **)** +- |void| **set_use_all_surfaces**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_use_all_surfaces**\ (\ ) If ``true``, the particles will emit from all surfaces of the mesh. @@ -100,3 +100,4 @@ If ``true``, the particles will emit from all surfaces of the mesh. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst b/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst index 4008f997609..f81b1a60417 100644 --- a/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst +++ b/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst @@ -50,8 +50,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_degrees_mode** **(** :ref:`bool` value **)** -- :ref:`bool` **is_degrees_mode** **(** **)** +- |void| **set_degrees_mode**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_degrees_mode**\ (\ ) If ``true``, the angle will be interpreted in degrees instead of radians. @@ -62,3 +62,4 @@ If ``true``, the angle will be interpreted in degrees instead of radians. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeparticleoutput.rst b/classes/class_visualshadernodeparticleoutput.rst index b8ba1d4477a..7649bc2744c 100644 --- a/classes/class_visualshadernodeparticleoutput.rst +++ b/classes/class_visualshadernodeparticleoutput.rst @@ -28,3 +28,4 @@ This node defines how particles are emitted. It allows to customize e.g. positio .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeparticlerandomness.rst b/classes/class_visualshadernodeparticlerandomness.rst index f2871a4462b..4532ce944e9 100644 --- a/classes/class_visualshadernodeparticlerandomness.rst +++ b/classes/class_visualshadernodeparticlerandomness.rst @@ -105,8 +105,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_op_type** **(** :ref:`OpType` value **)** -- :ref:`OpType` **get_op_type** **(** **)** +- |void| **set_op_type**\ (\ value\: :ref:`OpType`\ ) +- :ref:`OpType` **get_op_type**\ (\ ) A type of operands and returned value. @@ -117,3 +117,4 @@ A type of operands and returned value. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeparticleringemitter.rst b/classes/class_visualshadernodeparticleringemitter.rst index 0bc1bfae19e..59551a37772 100644 --- a/classes/class_visualshadernodeparticleringemitter.rst +++ b/classes/class_visualshadernodeparticleringemitter.rst @@ -28,3 +28,4 @@ Description .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeparticlesphereemitter.rst b/classes/class_visualshadernodeparticlesphereemitter.rst index 7d2003c5399..f5a4e93fd7e 100644 --- a/classes/class_visualshadernodeparticlesphereemitter.rst +++ b/classes/class_visualshadernodeparticlesphereemitter.rst @@ -28,3 +28,4 @@ Description .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeproximityfade.rst b/classes/class_visualshadernodeproximityfade.rst index f32907ea00a..c20796bcb12 100644 --- a/classes/class_visualshadernodeproximityfade.rst +++ b/classes/class_visualshadernodeproximityfade.rst @@ -28,3 +28,4 @@ The proximity fade effect fades out each pixel based on its distance to another .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernoderandomrange.rst b/classes/class_visualshadernoderandomrange.rst index 9f8af834d35..065465d3474 100644 --- a/classes/class_visualshadernoderandomrange.rst +++ b/classes/class_visualshadernoderandomrange.rst @@ -28,3 +28,4 @@ Random range node will output a pseudo-random scalar value in the specified rang .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernoderemap.rst b/classes/class_visualshadernoderemap.rst index 9d8ea928993..d1dc531405d 100644 --- a/classes/class_visualshadernoderemap.rst +++ b/classes/class_visualshadernoderemap.rst @@ -28,3 +28,4 @@ Remap will transform the input range into output range, e.g. you can change a `` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernoderesizablebase.rst b/classes/class_visualshadernoderesizablebase.rst index cbde702fa25..79742d780dd 100644 --- a/classes/class_visualshadernoderesizablebase.rst +++ b/classes/class_visualshadernoderesizablebase.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_size**\ (\ ) The size of the node in the visual shader graph. @@ -64,3 +64,4 @@ The size of the node in the visual shader graph. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernoderotationbyaxis.rst b/classes/class_visualshadernoderotationbyaxis.rst index 2910b93a7cd..f411d3a5119 100644 --- a/classes/class_visualshadernoderotationbyaxis.rst +++ b/classes/class_visualshadernoderotationbyaxis.rst @@ -28,3 +28,4 @@ RotationByAxis node will transform the vertices of a mesh with specified axis an .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodesample3d.rst b/classes/class_visualshadernodesample3d.rst index 8cf38a22515..ec39b02d7fa 100644 --- a/classes/class_visualshadernodesample3d.rst +++ b/classes/class_visualshadernodesample3d.rst @@ -91,8 +91,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_source** **(** :ref:`Source` value **)** -- :ref:`Source` **get_source** **(** **)** +- |void| **set_source**\ (\ value\: :ref:`Source`\ ) +- :ref:`Source` **get_source**\ (\ ) An input source type. @@ -103,3 +103,4 @@ An input source type. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodescreennormalworldspace.rst b/classes/class_visualshadernodescreennormalworldspace.rst index 245ff920b4e..d2942799f61 100644 --- a/classes/class_visualshadernodescreennormalworldspace.rst +++ b/classes/class_visualshadernodescreennormalworldspace.rst @@ -28,3 +28,4 @@ The ScreenNormalWorldSpace node allows to create outline effects. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodescreenuvtosdf.rst b/classes/class_visualshadernodescreenuvtosdf.rst index 4df8e804f91..be1964c865d 100644 --- a/classes/class_visualshadernodescreenuvtosdf.rst +++ b/classes/class_visualshadernodescreenuvtosdf.rst @@ -28,3 +28,4 @@ Translates to ``screen_uv_to_sdf(uv)`` in the shader language. If the UV port is .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodesdfraymarch.rst b/classes/class_visualshadernodesdfraymarch.rst index ce4b035d1b7..c45bb72ecbe 100644 --- a/classes/class_visualshadernodesdfraymarch.rst +++ b/classes/class_visualshadernodesdfraymarch.rst @@ -28,3 +28,4 @@ Casts a ray against the screen SDF (signed-distance field) and returns the dista .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodesdftoscreenuv.rst b/classes/class_visualshadernodesdftoscreenuv.rst index 6aab48f89e2..df616556993 100644 --- a/classes/class_visualshadernodesdftoscreenuv.rst +++ b/classes/class_visualshadernodesdftoscreenuv.rst @@ -28,3 +28,4 @@ Translates to ``sdf_to_screen_uv(sdf_pos)`` in the shader language. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodesmoothstep.rst b/classes/class_visualshadernodesmoothstep.rst index b8a4b7a8471..e46396e9989 100644 --- a/classes/class_visualshadernodesmoothstep.rst +++ b/classes/class_visualshadernodesmoothstep.rst @@ -131,8 +131,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_op_type** **(** :ref:`OpType` value **)** -- :ref:`OpType` **get_op_type** **(** **)** +- |void| **set_op_type**\ (\ value\: :ref:`OpType`\ ) +- :ref:`OpType` **get_op_type**\ (\ ) A type of operands and returned value. @@ -143,3 +143,4 @@ A type of operands and returned value. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodestep.rst b/classes/class_visualshadernodestep.rst index 4d37fe8e3a5..37bd020cc5b 100644 --- a/classes/class_visualshadernodestep.rst +++ b/classes/class_visualshadernodestep.rst @@ -131,8 +131,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_op_type** **(** :ref:`OpType` value **)** -- :ref:`OpType` **get_op_type** **(** **)** +- |void| **set_op_type**\ (\ value\: :ref:`OpType`\ ) +- :ref:`OpType` **get_op_type**\ (\ ) A type of operands and returned value. @@ -143,3 +143,4 @@ A type of operands and returned value. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeswitch.rst b/classes/class_visualshadernodeswitch.rst index 2cbb9b7e502..19bb6a10f7e 100644 --- a/classes/class_visualshadernodeswitch.rst +++ b/classes/class_visualshadernodeswitch.rst @@ -137,8 +137,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_op_type** **(** :ref:`OpType` value **)** -- :ref:`OpType` **get_op_type** **(** **)** +- |void| **set_op_type**\ (\ value\: :ref:`OpType`\ ) +- :ref:`OpType` **get_op_type**\ (\ ) A type of operands and returned value. @@ -149,3 +149,4 @@ A type of operands and returned value. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodetexture.rst b/classes/class_visualshadernodetexture.rst index d9c926d5f9d..6db824931e1 100644 --- a/classes/class_visualshadernodetexture.rst +++ b/classes/class_visualshadernodetexture.rst @@ -148,7 +148,7 @@ No hints are added to the uniform declaration. :ref:`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: @@ -183,8 +183,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_source** **(** :ref:`Source` value **)** -- :ref:`Source` **get_source** **(** **)** +- |void| **set_source**\ (\ value\: :ref:`Source`\ ) +- :ref:`Source` **get_source**\ (\ ) Determines the source for the lookup. See :ref:`Source` for options. @@ -200,8 +200,8 @@ Determines the source for the lookup. See :ref:`Source` value **)** -- :ref:`Texture2D` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`Texture2D`\ ) +- :ref:`Texture2D` **get_texture**\ (\ ) The source texture, if needed for the selected :ref:`source`. @@ -217,8 +217,8 @@ The source texture, if needed for the selected :ref:`source` value **)** -- :ref:`TextureType` **get_texture_type** **(** **)** +- |void| **set_texture_type**\ (\ value\: :ref:`TextureType`\ ) +- :ref:`TextureType` **get_texture_type**\ (\ ) Specifies the type of the texture if :ref:`source` is set to :ref:`SOURCE_TEXTURE`. See :ref:`TextureType` for options. @@ -229,3 +229,4 @@ Specifies the type of the texture if :ref:`source` value **)** -- :ref:`Texture2DArray` **get_texture_array** **(** **)** +- |void| **set_texture_array**\ (\ value\: :ref:`Texture2DArray`\ ) +- :ref:`Texture2DArray` **get_texture_array**\ (\ ) A source texture array. Used if :ref:`VisualShaderNodeSample3D.source` is set to :ref:`VisualShaderNodeSample3D.SOURCE_TEXTURE`. @@ -62,3 +62,4 @@ A source texture array. Used if :ref:`VisualShaderNodeSample3D.source` value **)** -- :ref:`Texture3D` **get_texture** **(** **)** +- |void| **set_texture**\ (\ value\: :ref:`Texture3D`\ ) +- :ref:`Texture3D` **get_texture**\ (\ ) A source texture. Used if :ref:`VisualShaderNodeSample3D.source` is set to :ref:`VisualShaderNodeSample3D.SOURCE_TEXTURE`. @@ -62,3 +62,4 @@ A source texture. Used if :ref:`VisualShaderNodeSample3D.source` value **)** -- :ref:`ColorDefault` **get_color_default** **(** **)** +- |void| **set_color_default**\ (\ value\: :ref:`ColorDefault`\ ) +- :ref:`ColorDefault` **get_color_default**\ (\ ) Sets the default color if no texture is assigned to the uniform. @@ -348,8 +348,8 @@ Sets the default color if no texture is assigned to the uniform. .. rst-class:: classref-property-setget -- void **set_texture_filter** **(** :ref:`TextureFilter` value **)** -- :ref:`TextureFilter` **get_texture_filter** **(** **)** +- |void| **set_texture_filter**\ (\ value\: :ref:`TextureFilter`\ ) +- :ref:`TextureFilter` **get_texture_filter**\ (\ ) Sets the texture filtering mode. See :ref:`TextureFilter` for options. @@ -365,8 +365,8 @@ Sets the texture filtering mode. See :ref:`TextureFilter` value **)** -- :ref:`TextureRepeat` **get_texture_repeat** **(** **)** +- |void| **set_texture_repeat**\ (\ value\: :ref:`TextureRepeat`\ ) +- :ref:`TextureRepeat` **get_texture_repeat**\ (\ ) Sets the texture repeating mode. See :ref:`TextureRepeat` for options. @@ -382,8 +382,8 @@ Sets the texture repeating mode. See :ref:`TextureRepeat` value **)** -- :ref:`TextureSource` **get_texture_source** **(** **)** +- |void| **set_texture_source**\ (\ value\: :ref:`TextureSource`\ ) +- :ref:`TextureSource` **get_texture_source**\ (\ ) Sets the texture source mode. Used for reading from the screen, depth, or normal_roughness texture. See :ref:`TextureSource` for options. @@ -399,8 +399,8 @@ Sets the texture source mode. Used for reading from the screen, depth, or normal .. rst-class:: classref-property-setget -- void **set_texture_type** **(** :ref:`TextureType` value **)** -- :ref:`TextureType` **get_texture_type** **(** **)** +- |void| **set_texture_type**\ (\ value\: :ref:`TextureType`\ ) +- :ref:`TextureType` **get_texture_type**\ (\ ) Defines the type of data provided by the source texture. See :ref:`TextureType` for options. @@ -411,3 +411,4 @@ Defines the type of data provided by the source texture. See :ref:`TextureType` value **)** -- :ref:`Transform3D` **get_constant** **(** **)** +- |void| **set_constant**\ (\ value\: :ref:`Transform3D`\ ) +- :ref:`Transform3D` **get_constant**\ (\ ) A :ref:`Transform3D` constant which represents the state of this node. @@ -62,3 +62,4 @@ A :ref:`Transform3D` constant which represents the state of t .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodetransformdecompose.rst b/classes/class_visualshadernodetransformdecompose.rst index 21add3494e2..478fb85583e 100644 --- a/classes/class_visualshadernodetransformdecompose.rst +++ b/classes/class_visualshadernodetransformdecompose.rst @@ -28,3 +28,4 @@ Takes a 4x4 transform matrix and decomposes it into four ``vec3`` values, one fr .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodetransformfunc.rst b/classes/class_visualshadernodetransformfunc.rst index 6329aac5f67..428671f4bd9 100644 --- a/classes/class_visualshadernodetransformfunc.rst +++ b/classes/class_visualshadernodetransformfunc.rst @@ -89,8 +89,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_function** **(** :ref:`Function` value **)** -- :ref:`Function` **get_function** **(** **)** +- |void| **set_function**\ (\ value\: :ref:`Function`\ ) +- :ref:`Function` **get_function**\ (\ ) The function to be computed. See :ref:`Function` for options. @@ -101,3 +101,4 @@ The function to be computed. See :ref:`Function` value **)** -- :ref:`Operator` **get_operator** **(** **)** +- |void| **set_operator**\ (\ value\: :ref:`Operator`\ ) +- :ref:`Operator` **get_operator**\ (\ ) The type of the operation to be performed on the transforms. See :ref:`Operator` for options. @@ -157,3 +157,4 @@ The type of the operation to be performed on the transforms. See :ref:`Operator< .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodetransformparameter.rst b/classes/class_visualshadernodetransformparameter.rst index ca5e54bfaab..b903cd3938a 100644 --- a/classes/class_visualshadernodetransformparameter.rst +++ b/classes/class_visualshadernodetransformparameter.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_default_value** **(** :ref:`Transform3D` value **)** -- :ref:`Transform3D` **get_default_value** **(** **)** +- |void| **set_default_value**\ (\ value\: :ref:`Transform3D`\ ) +- :ref:`Transform3D` **get_default_value**\ (\ ) A default value to be assigned within the shader. @@ -69,8 +69,8 @@ A default value to be assigned within the shader. .. rst-class:: classref-property-setget -- void **set_default_value_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_default_value_enabled** **(** **)** +- |void| **set_default_value_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_default_value_enabled**\ (\ ) Enables usage of the :ref:`default_value`. @@ -81,3 +81,4 @@ Enables usage of the :ref:`default_value` value **)** -- :ref:`Operator` **get_operator** **(** **)** +- |void| **set_operator**\ (\ value\: :ref:`Operator`\ ) +- :ref:`Operator` **get_operator**\ (\ ) The multiplication type to be performed. See :ref:`Operator` for options. @@ -117,3 +117,4 @@ The multiplication type to be performed. See :ref:`Operator` value **)** -- :ref:`int` **get_constant** **(** **)** +- |void| **set_constant**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_constant**\ (\ ) An unsigned integer constant which represents a state of this node. @@ -62,3 +62,4 @@ An unsigned integer constant which represents a state of this node. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeuintfunc.rst b/classes/class_visualshadernodeuintfunc.rst index f5bada1eadc..f38c9961641 100644 --- a/classes/class_visualshadernodeuintfunc.rst +++ b/classes/class_visualshadernodeuintfunc.rst @@ -89,8 +89,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_function** **(** :ref:`Function` value **)** -- :ref:`Function` **get_function** **(** **)** +- |void| **set_function**\ (\ value\: :ref:`Function`\ ) +- :ref:`Function` **get_function**\ (\ ) A function to be applied to the scalar. See :ref:`Function` for options. @@ -101,3 +101,4 @@ A function to be applied to the scalar. See :ref:`Function` value **)** -- :ref:`Operator` **get_operator** **(** **)** +- |void| **set_operator**\ (\ value\: :ref:`Operator`\ ) +- :ref:`Operator` **get_operator**\ (\ ) An operator to be applied to the inputs. See :ref:`Operator` for options. @@ -181,3 +181,4 @@ An operator to be applied to the inputs. See :ref:`Operator` value **)** -- :ref:`int` **get_default_value** **(** **)** +- |void| **set_default_value**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_default_value**\ (\ ) Default value of this parameter, which will be used if not set externally. :ref:`default_value_enabled` must be enabled; defaults to ``0`` otherwise. @@ -69,8 +69,8 @@ Default value of this parameter, which will be used if not set externally. :ref: .. rst-class:: classref-property-setget -- void **set_default_value_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_default_value_enabled** **(** **)** +- |void| **set_default_value_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_default_value_enabled**\ (\ ) If ``true``, the node will have a custom default value. @@ -81,3 +81,4 @@ If ``true``, the node will have a custom default value. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodeuvfunc.rst b/classes/class_visualshadernodeuvfunc.rst index d47b64841c5..094935829d7 100644 --- a/classes/class_visualshadernodeuvfunc.rst +++ b/classes/class_visualshadernodeuvfunc.rst @@ -89,8 +89,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_function** **(** :ref:`Function` value **)** -- :ref:`Function` **get_function** **(** **)** +- |void| **set_function**\ (\ value\: :ref:`Function`\ ) +- :ref:`Function` **get_function**\ (\ ) A function to be applied to the texture coordinates. See :ref:`Function` for options. @@ -101,3 +101,4 @@ A function to be applied to the texture coordinates. See :ref:`Function` value **)** -- :ref:`String` **get_varying_name** **(** **)** +- |void| **set_varying_name**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_varying_name**\ (\ ) Name of the variable. Must be unique. @@ -71,8 +71,8 @@ Name of the variable. Must be unique. .. rst-class:: classref-property-setget -- void **set_varying_type** **(** :ref:`VaryingType` value **)** -- :ref:`VaryingType` **get_varying_type** **(** **)** +- |void| **set_varying_type**\ (\ value\: :ref:`VaryingType`\ ) +- :ref:`VaryingType` **get_varying_type**\ (\ ) Type of the variable. Determines where the variable can be accessed. @@ -83,3 +83,4 @@ Type of the variable. Determines where the variable can be accessed. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodevaryinggetter.rst b/classes/class_visualshadernodevaryinggetter.rst index 928fe3ebf39..709cf2195f2 100644 --- a/classes/class_visualshadernodevaryinggetter.rst +++ b/classes/class_visualshadernodevaryinggetter.rst @@ -28,3 +28,4 @@ Outputs a value of a varying defined in the shader. You need to first create a v .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodevaryingsetter.rst b/classes/class_visualshadernodevaryingsetter.rst index 714ef3d8bec..bee8018aac0 100644 --- a/classes/class_visualshadernodevaryingsetter.rst +++ b/classes/class_visualshadernodevaryingsetter.rst @@ -28,3 +28,4 @@ Inputs a value to a varying defined in the shader. You need to first create a va .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodevec2constant.rst b/classes/class_visualshadernodevec2constant.rst index 6e75e7d04ff..45f5defe33e 100644 --- a/classes/class_visualshadernodevec2constant.rst +++ b/classes/class_visualshadernodevec2constant.rst @@ -50,8 +50,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_constant** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_constant** **(** **)** +- |void| **set_constant**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_constant**\ (\ ) A :ref:`Vector2` constant which represents the state of this node. @@ -62,3 +62,4 @@ A :ref:`Vector2` constant which represents the state of this node .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodevec2parameter.rst b/classes/class_visualshadernodevec2parameter.rst index 3876e2fff41..9c3f64db9d2 100644 --- a/classes/class_visualshadernodevec2parameter.rst +++ b/classes/class_visualshadernodevec2parameter.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_default_value** **(** :ref:`Vector2` value **)** -- :ref:`Vector2` **get_default_value** **(** **)** +- |void| **set_default_value**\ (\ value\: :ref:`Vector2`\ ) +- :ref:`Vector2` **get_default_value**\ (\ ) A default value to be assigned within the shader. @@ -69,8 +69,8 @@ A default value to be assigned within the shader. .. rst-class:: classref-property-setget -- void **set_default_value_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_default_value_enabled** **(** **)** +- |void| **set_default_value_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_default_value_enabled**\ (\ ) Enables usage of the :ref:`default_value`. @@ -81,3 +81,4 @@ Enables usage of the :ref:`default_value` value **)** -- :ref:`Vector3` **get_constant** **(** **)** +- |void| **set_constant**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_constant**\ (\ ) A :ref:`Vector3` constant which represents the state of this node. @@ -62,3 +62,4 @@ A :ref:`Vector3` constant which represents the state of this node .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodevec3parameter.rst b/classes/class_visualshadernodevec3parameter.rst index 06b5da1990d..ebe66761406 100644 --- a/classes/class_visualshadernodevec3parameter.rst +++ b/classes/class_visualshadernodevec3parameter.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_default_value** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_default_value** **(** **)** +- |void| **set_default_value**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_default_value**\ (\ ) A default value to be assigned within the shader. @@ -69,8 +69,8 @@ A default value to be assigned within the shader. .. rst-class:: classref-property-setget -- void **set_default_value_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_default_value_enabled** **(** **)** +- |void| **set_default_value_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_default_value_enabled**\ (\ ) Enables usage of the :ref:`default_value`. @@ -81,3 +81,4 @@ Enables usage of the :ref:`default_value` value **)** -- :ref:`Quaternion` **get_constant** **(** **)** +- |void| **set_constant**\ (\ value\: :ref:`Quaternion`\ ) +- :ref:`Quaternion` **get_constant**\ (\ ) A 4D vector (represented as a :ref:`Quaternion`) constant which represents the state of this node. @@ -62,3 +62,4 @@ A 4D vector (represented as a :ref:`Quaternion`) constant whic .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodevec4parameter.rst b/classes/class_visualshadernodevec4parameter.rst index 5f0b22e9c2a..6f42a6fe82a 100644 --- a/classes/class_visualshadernodevec4parameter.rst +++ b/classes/class_visualshadernodevec4parameter.rst @@ -52,8 +52,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_default_value** **(** :ref:`Vector4` value **)** -- :ref:`Vector4` **get_default_value** **(** **)** +- |void| **set_default_value**\ (\ value\: :ref:`Vector4`\ ) +- :ref:`Vector4` **get_default_value**\ (\ ) A default value to be assigned within the shader. @@ -69,8 +69,8 @@ A default value to be assigned within the shader. .. rst-class:: classref-property-setget -- void **set_default_value_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_default_value_enabled** **(** **)** +- |void| **set_default_value_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_default_value_enabled**\ (\ ) Enables usage of the :ref:`default_value`. @@ -81,3 +81,4 @@ Enables usage of the :ref:`default_value` value **)** -- :ref:`OpType` **get_op_type** **(** **)** +- |void| **set_op_type**\ (\ value\: :ref:`OpType`\ ) +- :ref:`OpType` **get_op_type**\ (\ ) A vector type that this operation is performed on. @@ -111,3 +111,4 @@ A vector type that this operation is performed on. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodevectorcompose.rst b/classes/class_visualshadernodevectorcompose.rst index 735d988345a..c10e062029b 100644 --- a/classes/class_visualshadernodevectorcompose.rst +++ b/classes/class_visualshadernodevectorcompose.rst @@ -28,3 +28,4 @@ Creates a ``vec2``, ``vec3`` or ``vec4`` using scalar values that can be provide .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodevectordecompose.rst b/classes/class_visualshadernodevectordecompose.rst index 5ba6a330530..4544ceb555f 100644 --- a/classes/class_visualshadernodevectordecompose.rst +++ b/classes/class_visualshadernodevectordecompose.rst @@ -28,3 +28,4 @@ Takes a ``vec2``, ``vec3`` or ``vec4`` and decomposes it into scalar values that .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodevectordistance.rst b/classes/class_visualshadernodevectordistance.rst index 147c49c4355..14bdf9f37a3 100644 --- a/classes/class_visualshadernodevectordistance.rst +++ b/classes/class_visualshadernodevectordistance.rst @@ -30,3 +30,4 @@ Translated to ``distance(p0, p1)`` in the shader language. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_visualshadernodevectorfunc.rst b/classes/class_visualshadernodevectorfunc.rst index a8507384f4f..21b2347a537 100644 --- a/classes/class_visualshadernodevectorfunc.rst +++ b/classes/class_visualshadernodevectorfunc.rst @@ -337,8 +337,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_function** **(** :ref:`Function` value **)** -- :ref:`Function` **get_function** **(** **)** +- |void| **set_function**\ (\ value\: :ref:`Function`\ ) +- :ref:`Function` **get_function**\ (\ ) The function to be performed. See :ref:`Function` for options. @@ -349,3 +349,4 @@ The function to be performed. See :ref:`Function` value **)** -- :ref:`Operator` **get_operator** **(** **)** +- |void| **set_operator**\ (\ value\: :ref:`Operator`\ ) +- :ref:`Operator` **get_operator**\ (\ ) The operator to be used. See :ref:`Operator` for options. @@ -181,3 +181,4 @@ The operator to be used. See :ref:`Operator` **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** | - +------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`debug_bake` **(** **)** | - +------+----------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bake`\ (\ from_node\: :ref:`Node` = null, create_visual_debug\: :ref:`bool` = false\ ) | + +--------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`debug_bake`\ (\ ) | + +--------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -142,8 +142,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_camera_attributes** **(** :ref:`CameraAttributes` value **)** -- :ref:`CameraAttributes` **get_camera_attributes** **(** **)** +- |void| **set_camera_attributes**\ (\ value\: :ref:`CameraAttributes`\ ) +- :ref:`CameraAttributes` **get_camera_attributes**\ (\ ) The :ref:`CameraAttributes` resource that specifies exposure levels to bake at. Auto-exposure and non exposure properties will be ignored. Exposure settings should be used to reduce the dynamic range present when baking. If exposure is too high, the **VoxelGI** will have banding artifacts or may have over-exposure artifacts. @@ -159,8 +159,8 @@ The :ref:`CameraAttributes` resource that specifies expo .. rst-class:: classref-property-setget -- void **set_probe_data** **(** :ref:`VoxelGIData` value **)** -- :ref:`VoxelGIData` **get_probe_data** **(** **)** +- |void| **set_probe_data**\ (\ value\: :ref:`VoxelGIData`\ ) +- :ref:`VoxelGIData` **get_probe_data**\ (\ ) The :ref:`VoxelGIData` resource that holds the data for this **VoxelGI**. @@ -176,8 +176,8 @@ The :ref:`VoxelGIData` resource that holds the data for this .. rst-class:: classref-property-setget -- void **set_size** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_size**\ (\ ) The size of the area covered by the **VoxelGI**. If you make the size larger without increasing the subdivisions with :ref:`subdiv`, the size of each cell will increase and result in lower detailed lighting. @@ -195,8 +195,8 @@ The size of the area covered by the **VoxelGI**. If you make the size larger wit .. rst-class:: classref-property-setget -- void **set_subdiv** **(** :ref:`Subdiv` value **)** -- :ref:`Subdiv` **get_subdiv** **(** **)** +- |void| **set_subdiv**\ (\ value\: :ref:`Subdiv`\ ) +- :ref:`Subdiv` **get_subdiv**\ (\ ) Number of times to subdivide the grid that the **VoxelGI** operates on. A higher number results in finer detail and thus higher visual quality, while lower numbers result in better performance. @@ -213,7 +213,7 @@ Method Descriptions .. rst-class:: classref-method -void **bake** **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** +|void| **bake**\ (\ from_node\: :ref:`Node` = null, create_visual_debug\: :ref:`bool` = false\ ) Bakes the effect from all :ref:`GeometryInstance3D`\ s marked with :ref:`GeometryInstance3D.GI_MODE_STATIC` and :ref:`Light3D`\ s marked with either :ref:`Light3D.BAKE_STATIC` or :ref:`Light3D.BAKE_DYNAMIC`. If ``create_visual_debug`` is ``true``, after baking the light, this will generate a :ref:`MultiMesh` that has a cube representing each solid cell with each cube colored to the cell's albedo color. This can be used to visualize the **VoxelGI**'s data and debug any issues that may be occurring. @@ -229,7 +229,7 @@ Bakes the effect from all :ref:`GeometryInstance3D`\ s .. rst-class:: classref-method -void **debug_bake** **(** **)** +|void| **debug_bake**\ (\ ) Calls :ref:`bake` with ``create_visual_debug`` enabled. @@ -240,3 +240,4 @@ Calls :ref:`bake` with ``create_visual_debug`` enable .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_voxelgidata.rst b/classes/class_voxelgidata.rst index bc14248c553..44ae597c6b7 100644 --- a/classes/class_voxelgidata.rst +++ b/classes/class_voxelgidata.rst @@ -62,21 +62,21 @@ Methods .. table:: :widths: auto - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`allocate` **(** :ref:`Transform3D` to_cell_xform, :ref:`AABB` aabb, :ref:`Vector3` octree_size, :ref:`PackedByteArray` octree_cells, :ref:`PackedByteArray` data_cells, :ref:`PackedByteArray` distance_field, :ref:`PackedInt32Array` level_counts **)** | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AABB` | :ref:`get_bounds` **(** **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`get_data_cells` **(** **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_level_counts` **(** **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`get_octree_cells` **(** **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`get_octree_size` **(** **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Transform3D` | :ref:`get_to_cell_xform` **(** **)** |const| | - +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`allocate`\ (\ to_cell_xform\: :ref:`Transform3D`, aabb\: :ref:`AABB`, octree_size\: :ref:`Vector3`, octree_cells\: :ref:`PackedByteArray`, data_cells\: :ref:`PackedByteArray`, distance_field\: :ref:`PackedByteArray`, level_counts\: :ref:`PackedInt32Array`\ ) | + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AABB` | :ref:`get_bounds`\ (\ ) |const| | + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`get_data_cells`\ (\ ) |const| | + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_level_counts`\ (\ ) |const| | + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`get_octree_cells`\ (\ ) |const| | + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`get_octree_size`\ (\ ) |const| | + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Transform3D` | :ref:`get_to_cell_xform`\ (\ ) |const| | + +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -95,8 +95,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_bias** **(** :ref:`float` value **)** -- :ref:`float` **get_bias** **(** **)** +- |void| **set_bias**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_bias**\ (\ ) The normal bias to use for indirect lighting and reflections. Higher values reduce self-reflections visible in non-rough materials, at the cost of more visible light leaking and flatter-looking indirect lighting. To prioritize hiding self-reflections over lighting quality, set :ref:`bias` to ``0.0`` and :ref:`normal_bias` to a value between ``1.0`` and ``2.0``. @@ -112,8 +112,8 @@ The normal bias to use for indirect lighting and reflections. Higher values redu .. rst-class:: classref-property-setget -- void **set_dynamic_range** **(** :ref:`float` value **)** -- :ref:`float` **get_dynamic_range** **(** **)** +- |void| **set_dynamic_range**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_dynamic_range**\ (\ ) The dynamic range to use (``1.0`` represents a low dynamic range scene brightness). Higher values can be used to provide brighter indirect lighting, at the cost of more visible color banding in dark areas (both in indirect lighting and reflections). To avoid color banding, it's recommended to use the lowest value that does not result in visible light clipping. @@ -129,8 +129,8 @@ The dynamic range to use (``1.0`` represents a low dynamic range scene brightnes .. rst-class:: classref-property-setget -- void **set_energy** **(** :ref:`float` value **)** -- :ref:`float` **get_energy** **(** **)** +- |void| **set_energy**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_energy**\ (\ ) The energy of the indirect lighting and reflections produced by the :ref:`VoxelGI` node. Higher values result in brighter indirect lighting. If indirect lighting looks too flat, try decreasing :ref:`propagation` while increasing :ref:`energy` at the same time. See also :ref:`use_two_bounces` which influences the indirect lighting's effective brightness. @@ -146,8 +146,8 @@ The energy of the indirect lighting and reflections produced by the :ref:`VoxelG .. rst-class:: classref-property-setget -- void **set_interior** **(** :ref:`bool` value **)** -- :ref:`bool` **is_interior** **(** **)** +- |void| **set_interior**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_interior**\ (\ ) If ``true``, :ref:`Environment` lighting is ignored by the :ref:`VoxelGI` node. If ``false``, :ref:`Environment` lighting is taken into account by the :ref:`VoxelGI` node. :ref:`Environment` lighting updates in real-time, which means it can be changed without having to bake the :ref:`VoxelGI` node again. @@ -163,8 +163,8 @@ If ``true``, :ref:`Environment` lighting is ignored by the :r .. rst-class:: classref-property-setget -- void **set_normal_bias** **(** :ref:`float` value **)** -- :ref:`float` **get_normal_bias** **(** **)** +- |void| **set_normal_bias**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_normal_bias**\ (\ ) The normal bias to use for indirect lighting and reflections. Higher values reduce self-reflections visible in non-rough materials, at the cost of more visible light leaking and flatter-looking indirect lighting. See also :ref:`bias`. To prioritize hiding self-reflections over lighting quality, set :ref:`bias` to ``0.0`` and :ref:`normal_bias` to a value between ``1.0`` and ``2.0``. @@ -180,8 +180,8 @@ The normal bias to use for indirect lighting and reflections. Higher values redu .. rst-class:: classref-property-setget -- void **set_propagation** **(** :ref:`float` value **)** -- :ref:`float` **get_propagation** **(** **)** +- |void| **set_propagation**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_propagation**\ (\ ) The multiplier to use when light bounces off a surface. Higher values result in brighter indirect lighting. If indirect lighting looks too flat, try decreasing :ref:`propagation` while increasing :ref:`energy` at the same time. See also :ref:`use_two_bounces` which influences the indirect lighting's effective brightness. @@ -197,8 +197,8 @@ The multiplier to use when light bounces off a surface. Higher values result in .. rst-class:: classref-property-setget -- void **set_use_two_bounces** **(** :ref:`bool` value **)** -- :ref:`bool` **is_using_two_bounces** **(** **)** +- |void| **set_use_two_bounces**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_using_two_bounces**\ (\ ) If ``true``, performs two bounces of indirect lighting instead of one. This makes indirect lighting look more natural and brighter at a small performance cost. The second bounce is also visible in reflections. If the scene appears too bright after enabling :ref:`use_two_bounces`, adjust :ref:`propagation` and :ref:`energy`. @@ -215,7 +215,7 @@ Method Descriptions .. rst-class:: classref-method -void **allocate** **(** :ref:`Transform3D` to_cell_xform, :ref:`AABB` aabb, :ref:`Vector3` octree_size, :ref:`PackedByteArray` octree_cells, :ref:`PackedByteArray` data_cells, :ref:`PackedByteArray` distance_field, :ref:`PackedInt32Array` level_counts **)** +|void| **allocate**\ (\ to_cell_xform\: :ref:`Transform3D`, aabb\: :ref:`AABB`, octree_size\: :ref:`Vector3`, octree_cells\: :ref:`PackedByteArray`, data_cells\: :ref:`PackedByteArray`, distance_field\: :ref:`PackedByteArray`, level_counts\: :ref:`PackedInt32Array`\ ) .. container:: contribute @@ -229,7 +229,7 @@ void **allocate** **(** :ref:`Transform3D` to_cell_xform, :re .. rst-class:: classref-method -:ref:`AABB` **get_bounds** **(** **)** |const| +:ref:`AABB` **get_bounds**\ (\ ) |const| Returns the bounds of the baked voxel data as an :ref:`AABB`, which should match :ref:`VoxelGI.size` after being baked (which only contains the size as a :ref:`Vector3`). @@ -243,7 +243,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. rst-class:: classref-method -:ref:`PackedByteArray` **get_data_cells** **(** **)** |const| +:ref:`PackedByteArray` **get_data_cells**\ (\ ) |const| .. container:: contribute @@ -257,7 +257,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. rst-class:: classref-method -:ref:`PackedInt32Array` **get_level_counts** **(** **)** |const| +:ref:`PackedInt32Array` **get_level_counts**\ (\ ) |const| .. container:: contribute @@ -271,7 +271,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. rst-class:: classref-method -:ref:`PackedByteArray` **get_octree_cells** **(** **)** |const| +:ref:`PackedByteArray` **get_octree_cells**\ (\ ) |const| .. container:: contribute @@ -285,7 +285,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. rst-class:: classref-method -:ref:`Vector3` **get_octree_size** **(** **)** |const| +:ref:`Vector3` **get_octree_size**\ (\ ) |const| .. container:: contribute @@ -299,7 +299,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. rst-class:: classref-method -:ref:`Transform3D` **get_to_cell_xform** **(** **)** |const| +:ref:`Transform3D` **get_to_cell_xform**\ (\ ) |const| .. container:: contribute @@ -312,3 +312,4 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_vscrollbar.rst b/classes/class_vscrollbar.rst index 1ce6a98b3b3..15397d09d00 100644 --- a/classes/class_vscrollbar.rst +++ b/classes/class_vscrollbar.rst @@ -30,9 +30,9 @@ Properties :widths: auto +--------------------------------------------------------+-----------------------+--------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`SizeFlags`\> | size_flags_horizontal | ``0`` (overrides :ref:`Control`) | + | |bitfield|\[:ref:`SizeFlags`\] | size_flags_horizontal | ``0`` (overrides :ref:`Control`) | +--------------------------------------------------------+-----------------------+--------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`SizeFlags`\> | size_flags_vertical | ``1`` (overrides :ref:`Control`) | + | |bitfield|\[:ref:`SizeFlags`\] | size_flags_vertical | ``1`` (overrides :ref:`Control`) | +--------------------------------------------------------+-----------------------+--------------------------------------------------------------------------------+ .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` @@ -42,3 +42,4 @@ Properties .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_vseparator.rst b/classes/class_vseparator.rst index ed3dd8bd61d..d82c7f210e6 100644 --- a/classes/class_vseparator.rst +++ b/classes/class_vseparator.rst @@ -28,3 +28,4 @@ A vertical separator used for separating other controls that are arranged **hori .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_vslider.rst b/classes/class_vslider.rst index 9cf0cd0fa57..4b56ae24bd3 100644 --- a/classes/class_vslider.rst +++ b/classes/class_vslider.rst @@ -30,9 +30,9 @@ Properties :widths: auto +--------------------------------------------------------+-----------------------+--------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`SizeFlags`\> | size_flags_horizontal | ``0`` (overrides :ref:`Control`) | + | |bitfield|\[:ref:`SizeFlags`\] | size_flags_horizontal | ``0`` (overrides :ref:`Control`) | +--------------------------------------------------------+-----------------------+--------------------------------------------------------------------------------+ - | |bitfield|\<:ref:`SizeFlags`\> | size_flags_vertical | ``1`` (overrides :ref:`Control`) | + | |bitfield|\[:ref:`SizeFlags`\] | size_flags_vertical | ``1`` (overrides :ref:`Control`) | +--------------------------------------------------------+-----------------------+--------------------------------------------------------------------------------+ .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` @@ -42,3 +42,4 @@ Properties .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_vsplitcontainer.rst b/classes/class_vsplitcontainer.rst index 92ce0c6ebcb..774a7c500aa 100644 --- a/classes/class_vsplitcontainer.rst +++ b/classes/class_vsplitcontainer.rst @@ -35,3 +35,4 @@ Tutorials .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_weakref.rst b/classes/class_weakref.rst index 4d59894aab7..150dff4aefb 100644 --- a/classes/class_weakref.rst +++ b/classes/class_weakref.rst @@ -29,9 +29,9 @@ Methods .. table:: :widths: auto - +-------------------------------+------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_ref` **(** **)** |const| | - +-------------------------------+------------------------------------------------------------------+ + +-------------------------------+------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_ref`\ (\ ) |const| | + +-------------------------------+------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -46,7 +46,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Variant` **get_ref** **(** **)** |const| +:ref:`Variant` **get_ref**\ (\ ) |const| Returns the :ref:`Object` this weakref is referring to. Returns ``null`` if that object no longer exists. @@ -57,3 +57,4 @@ Returns the :ref:`Object` this weakref is referring to. Returns `` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_webrtcdatachannel.rst b/classes/class_webrtcdatachannel.rst index 6486ccf5b0d..5a39b99eeed 100644 --- a/classes/class_webrtcdatachannel.rst +++ b/classes/class_webrtcdatachannel.rst @@ -38,31 +38,31 @@ Methods .. table:: :widths: auto - +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | void | :ref:`close` **(** **)** | - +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_buffered_amount` **(** **)** |const| | - +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_id` **(** **)** |const| | - +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_label` **(** **)** |const| | - +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_max_packet_life_time` **(** **)** |const| | - +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_max_retransmits` **(** **)** |const| | - +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_protocol` **(** **)** |const| | - +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`ChannelState` | :ref:`get_ready_state` **(** **)** |const| | - +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_negotiated` **(** **)** |const| | - +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_ordered` **(** **)** |const| | - +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`poll` **(** **)** | - +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`was_string_packet` **(** **)** |const| | - +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`close`\ (\ ) | + +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_buffered_amount`\ (\ ) |const| | + +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_id`\ (\ ) |const| | + +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_label`\ (\ ) |const| | + +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_max_packet_life_time`\ (\ ) |const| | + +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_max_retransmits`\ (\ ) |const| | + +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_protocol`\ (\ ) |const| | + +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ + | :ref:`ChannelState` | :ref:`get_ready_state`\ (\ ) |const| | + +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_negotiated`\ (\ ) |const| | + +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_ordered`\ (\ ) |const| | + +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`poll`\ (\ ) | + +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`was_string_packet`\ (\ ) |const| | + +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -154,8 +154,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_write_mode** **(** :ref:`WriteMode` value **)** -- :ref:`WriteMode` **get_write_mode** **(** **)** +- |void| **set_write_mode**\ (\ value\: :ref:`WriteMode`\ ) +- :ref:`WriteMode` **get_write_mode**\ (\ ) The transfer mode to use when sending outgoing packet. Either text or binary. @@ -172,7 +172,7 @@ Method Descriptions .. rst-class:: classref-method -void **close** **(** **)** +|void| **close**\ (\ ) Closes this data channel, notifying the other peer. @@ -184,7 +184,7 @@ Closes this data channel, notifying the other peer. .. rst-class:: classref-method -:ref:`int` **get_buffered_amount** **(** **)** |const| +:ref:`int` **get_buffered_amount**\ (\ ) |const| Returns the number of bytes currently queued to be sent over this channel. @@ -196,7 +196,7 @@ Returns the number of bytes currently queued to be sent over this channel. .. rst-class:: classref-method -:ref:`int` **get_id** **(** **)** |const| +:ref:`int` **get_id**\ (\ ) |const| Returns the ID assigned to this channel during creation (or auto-assigned during negotiation). @@ -210,7 +210,7 @@ If the channel is not negotiated out-of-band the ID will only be available after .. rst-class:: classref-method -:ref:`String` **get_label** **(** **)** |const| +:ref:`String` **get_label**\ (\ ) |const| Returns the label assigned to this channel during creation. @@ -222,7 +222,7 @@ Returns the label assigned to this channel during creation. .. rst-class:: classref-method -:ref:`int` **get_max_packet_life_time** **(** **)** |const| +:ref:`int` **get_max_packet_life_time**\ (\ ) |const| Returns the ``maxPacketLifeTime`` value assigned to this channel during creation. @@ -236,7 +236,7 @@ Will be ``65535`` if not specified. .. rst-class:: classref-method -:ref:`int` **get_max_retransmits** **(** **)** |const| +:ref:`int` **get_max_retransmits**\ (\ ) |const| Returns the ``maxRetransmits`` value assigned to this channel during creation. @@ -250,7 +250,7 @@ Will be ``65535`` if not specified. .. rst-class:: classref-method -:ref:`String` **get_protocol** **(** **)** |const| +:ref:`String` **get_protocol**\ (\ ) |const| Returns the sub-protocol assigned to this channel during creation. An empty string if not specified. @@ -262,7 +262,7 @@ Returns the sub-protocol assigned to this channel during creation. An empty stri .. rst-class:: classref-method -:ref:`ChannelState` **get_ready_state** **(** **)** |const| +:ref:`ChannelState` **get_ready_state**\ (\ ) |const| Returns the current state of this channel, see :ref:`ChannelState`. @@ -274,7 +274,7 @@ Returns the current state of this channel, see :ref:`ChannelState` **is_negotiated** **(** **)** |const| +:ref:`bool` **is_negotiated**\ (\ ) |const| Returns ``true`` if this channel was created with out-of-band configuration. @@ -286,7 +286,7 @@ Returns ``true`` if this channel was created with out-of-band configuration. .. rst-class:: classref-method -:ref:`bool` **is_ordered** **(** **)** |const| +:ref:`bool` **is_ordered**\ (\ ) |const| Returns ``true`` if this channel was created with ordering enabled (default). @@ -298,7 +298,7 @@ Returns ``true`` if this channel was created with ordering enabled (default). .. rst-class:: classref-method -:ref:`Error` **poll** **(** **)** +:ref:`Error` **poll**\ (\ ) Reserved, but not used for now. @@ -310,7 +310,7 @@ Reserved, but not used for now. .. rst-class:: classref-method -:ref:`bool` **was_string_packet** **(** **)** |const| +:ref:`bool` **was_string_packet**\ (\ ) |const| Returns ``true`` if the last received packet was transferred as text. See :ref:`write_mode`. @@ -321,3 +321,4 @@ Returns ``true`` if the last received packet was transferred as text. See :ref:` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_webrtcdatachannelextension.rst b/classes/class_webrtcdatachannelextension.rst index 26ad431216b..1997f13c6ab 100644 --- a/classes/class_webrtcdatachannelextension.rst +++ b/classes/class_webrtcdatachannelextension.rst @@ -24,43 +24,43 @@ Methods .. table:: :widths: auto - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_close` **(** **)** |virtual| | - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_available_packet_count` **(** **)** |virtual| |const| | - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_buffered_amount` **(** **)** |virtual| |const| | - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_id` **(** **)** |virtual| |const| | - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_label` **(** **)** |virtual| |const| | - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_max_packet_life_time` **(** **)** |virtual| |const| | - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_max_packet_size` **(** **)** |virtual| |const| | - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_max_retransmits` **(** **)** |virtual| |const| | - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_get_packet` **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| | - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_protocol` **(** **)** |virtual| |const| | - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ChannelState` | :ref:`_get_ready_state` **(** **)** |virtual| |const| | - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`WriteMode` | :ref:`_get_write_mode` **(** **)** |virtual| |const| | - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_negotiated` **(** **)** |virtual| |const| | - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_is_ordered` **(** **)** |virtual| |const| | - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_poll` **(** **)** |virtual| | - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_put_packet` **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| | - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_set_write_mode` **(** :ref:`WriteMode` p_write_mode **)** |virtual| | - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_was_string_packet` **(** **)** |virtual| |const| | - +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_close`\ (\ ) |virtual| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_available_packet_count`\ (\ ) |virtual| |const| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_buffered_amount`\ (\ ) |virtual| |const| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_id`\ (\ ) |virtual| |const| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_label`\ (\ ) |virtual| |const| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_max_packet_life_time`\ (\ ) |virtual| |const| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_max_packet_size`\ (\ ) |virtual| |const| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_max_retransmits`\ (\ ) |virtual| |const| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_get_packet`\ (\ r_buffer\: ``const uint8_t **``, r_buffer_size\: ``int32_t*``\ ) |virtual| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_protocol`\ (\ ) |virtual| |const| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ChannelState` | :ref:`_get_ready_state`\ (\ ) |virtual| |const| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`WriteMode` | :ref:`_get_write_mode`\ (\ ) |virtual| |const| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_negotiated`\ (\ ) |virtual| |const| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_is_ordered`\ (\ ) |virtual| |const| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_poll`\ (\ ) |virtual| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_put_packet`\ (\ p_buffer\: ``const uint8_t*``, p_buffer_size\: :ref:`int`\ ) |virtual| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_set_write_mode`\ (\ p_write_mode\: :ref:`WriteMode`\ ) |virtual| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_was_string_packet`\ (\ ) |virtual| |const| | + +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -75,7 +75,7 @@ Method Descriptions .. rst-class:: classref-method -void **_close** **(** **)** |virtual| +|void| **_close**\ (\ ) |virtual| .. container:: contribute @@ -89,7 +89,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_get_available_packet_count** **(** **)** |virtual| |const| +:ref:`int` **_get_available_packet_count**\ (\ ) |virtual| |const| .. container:: contribute @@ -103,7 +103,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_get_buffered_amount** **(** **)** |virtual| |const| +:ref:`int` **_get_buffered_amount**\ (\ ) |virtual| |const| .. container:: contribute @@ -117,7 +117,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_get_id** **(** **)** |virtual| |const| +:ref:`int` **_get_id**\ (\ ) |virtual| |const| .. container:: contribute @@ -131,7 +131,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`String` **_get_label** **(** **)** |virtual| |const| +:ref:`String` **_get_label**\ (\ ) |virtual| |const| .. container:: contribute @@ -145,7 +145,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_get_max_packet_life_time** **(** **)** |virtual| |const| +:ref:`int` **_get_max_packet_life_time**\ (\ ) |virtual| |const| .. container:: contribute @@ -159,7 +159,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_get_max_packet_size** **(** **)** |virtual| |const| +:ref:`int` **_get_max_packet_size**\ (\ ) |virtual| |const| .. container:: contribute @@ -173,7 +173,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`int` **_get_max_retransmits** **(** **)** |virtual| |const| +:ref:`int` **_get_max_retransmits**\ (\ ) |virtual| |const| .. container:: contribute @@ -187,7 +187,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`Error` **_get_packet** **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| +:ref:`Error` **_get_packet**\ (\ r_buffer\: ``const uint8_t **``, r_buffer_size\: ``int32_t*``\ ) |virtual| .. container:: contribute @@ -201,7 +201,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`String` **_get_protocol** **(** **)** |virtual| |const| +:ref:`String` **_get_protocol**\ (\ ) |virtual| |const| .. container:: contribute @@ -215,7 +215,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`ChannelState` **_get_ready_state** **(** **)** |virtual| |const| +:ref:`ChannelState` **_get_ready_state**\ (\ ) |virtual| |const| .. container:: contribute @@ -229,7 +229,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`WriteMode` **_get_write_mode** **(** **)** |virtual| |const| +:ref:`WriteMode` **_get_write_mode**\ (\ ) |virtual| |const| .. container:: contribute @@ -243,7 +243,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_is_negotiated** **(** **)** |virtual| |const| +:ref:`bool` **_is_negotiated**\ (\ ) |virtual| |const| .. container:: contribute @@ -257,7 +257,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`bool` **_is_ordered** **(** **)** |virtual| |const| +:ref:`bool` **_is_ordered**\ (\ ) |virtual| |const| .. container:: contribute @@ -271,7 +271,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`Error` **_poll** **(** **)** |virtual| +:ref:`Error` **_poll**\ (\ ) |virtual| .. container:: contribute @@ -285,7 +285,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`Error` **_put_packet** **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| +:ref:`Error` **_put_packet**\ (\ p_buffer\: ``const uint8_t*``, p_buffer_size\: :ref:`int`\ ) |virtual| .. container:: contribute @@ -299,7 +299,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -void **_set_write_mode** **(** :ref:`WriteMode` p_write_mode **)** |virtual| +|void| **_set_write_mode**\ (\ p_write_mode\: :ref:`WriteMode`\ ) |virtual| .. container:: contribute @@ -313,7 +313,7 @@ void **_set_write_mode** **(** :ref:`WriteMode .. rst-class:: classref-method -:ref:`bool` **_was_string_packet** **(** **)** |virtual| |const| +:ref:`bool` **_was_string_packet**\ (\ ) |virtual| |const| .. container:: contribute @@ -326,3 +326,4 @@ void **_set_write_mode** **(** :ref:`WriteMode .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_webrtcmultiplayerpeer.rst b/classes/class_webrtcmultiplayerpeer.rst index 1dc714aaf60..22d62b35724 100644 --- a/classes/class_webrtcmultiplayerpeer.rst +++ b/classes/class_webrtcmultiplayerpeer.rst @@ -35,23 +35,23 @@ Methods .. table:: :widths: auto - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`add_peer` **(** :ref:`WebRTCPeerConnection` peer, :ref:`int` peer_id, :ref:`int` unreliable_lifetime=1 **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`create_client` **(** :ref:`int` peer_id, :ref:`Array` channels_config=[] **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`create_mesh` **(** :ref:`int` peer_id, :ref:`Array` channels_config=[] **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`create_server` **(** :ref:`Array` channels_config=[] **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_peer` **(** :ref:`int` peer_id **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_peers` **(** **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_peer` **(** :ref:`int` peer_id **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_peer` **(** :ref:`int` peer_id **)** | - +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`add_peer`\ (\ peer\: :ref:`WebRTCPeerConnection`, peer_id\: :ref:`int`, unreliable_lifetime\: :ref:`int` = 1\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`create_client`\ (\ peer_id\: :ref:`int`, channels_config\: :ref:`Array` = []\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`create_mesh`\ (\ peer_id\: :ref:`int`, channels_config\: :ref:`Array` = []\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`create_server`\ (\ channels_config\: :ref:`Array` = []\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_peer`\ (\ peer_id\: :ref:`int`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_peers`\ (\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_peer`\ (\ peer_id\: :ref:`int`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_peer`\ (\ peer_id\: :ref:`int`\ ) | + +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -66,7 +66,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **add_peer** **(** :ref:`WebRTCPeerConnection` peer, :ref:`int` peer_id, :ref:`int` unreliable_lifetime=1 **)** +:ref:`Error` **add_peer**\ (\ peer\: :ref:`WebRTCPeerConnection`, peer_id\: :ref:`int`, unreliable_lifetime\: :ref:`int` = 1\ ) Add a new peer to the mesh with the given ``peer_id``. The :ref:`WebRTCPeerConnection` must be in state :ref:`WebRTCPeerConnection.STATE_NEW`. @@ -80,7 +80,7 @@ Three channels will be created for reliable, unreliable, and ordered transport. .. rst-class:: classref-method -:ref:`Error` **create_client** **(** :ref:`int` peer_id, :ref:`Array` channels_config=[] **)** +:ref:`Error` **create_client**\ (\ peer_id\: :ref:`int`, channels_config\: :ref:`Array` = []\ ) Initialize the multiplayer peer as a client with the given ``peer_id`` (must be between 2 and 2147483647). In this mode, you should only call :ref:`add_peer` once and with ``peer_id`` of ``1``. This mode enables :ref:`MultiplayerPeer.is_server_relay_supported`, allowing the upper :ref:`MultiplayerAPI` layer to perform peer exchange and packet relaying. @@ -94,7 +94,7 @@ You can optionally specify a ``channels_config`` array of :ref:`TransferMode` **create_mesh** **(** :ref:`int` peer_id, :ref:`Array` channels_config=[] **)** +:ref:`Error` **create_mesh**\ (\ peer_id\: :ref:`int`, channels_config\: :ref:`Array` = []\ ) Initialize the multiplayer peer as a mesh (i.e. all peers connect to each other) with the given ``peer_id`` (must be between 1 and 2147483647). @@ -106,7 +106,7 @@ Initialize the multiplayer peer as a mesh (i.e. all peers connect to each other) .. rst-class:: classref-method -:ref:`Error` **create_server** **(** :ref:`Array` channels_config=[] **)** +:ref:`Error` **create_server**\ (\ channels_config\: :ref:`Array` = []\ ) Initialize the multiplayer peer as a server (with unique ID of ``1``). This mode enables :ref:`MultiplayerPeer.is_server_relay_supported`, allowing the upper :ref:`MultiplayerAPI` layer to perform peer exchange and packet relaying. @@ -120,7 +120,7 @@ You can optionally specify a ``channels_config`` array of :ref:`TransferMode` **get_peer** **(** :ref:`int` peer_id **)** +:ref:`Dictionary` **get_peer**\ (\ peer_id\: :ref:`int`\ ) Returns a dictionary representation of the peer with given ``peer_id`` with three keys. ``"connection"`` containing the :ref:`WebRTCPeerConnection` to this peer, ``"channels"`` an array of three :ref:`WebRTCDataChannel`, and ``"connected"`` a boolean representing if the peer connection is currently connected (all three channels are open). @@ -132,7 +132,7 @@ Returns a dictionary representation of the peer with given ``peer_id`` with thre .. rst-class:: classref-method -:ref:`Dictionary` **get_peers** **(** **)** +:ref:`Dictionary` **get_peers**\ (\ ) Returns a dictionary which keys are the peer ids and values the peer representation as in :ref:`get_peer`. @@ -144,7 +144,7 @@ Returns a dictionary which keys are the peer ids and values the peer representat .. rst-class:: classref-method -:ref:`bool` **has_peer** **(** :ref:`int` peer_id **)** +:ref:`bool` **has_peer**\ (\ peer_id\: :ref:`int`\ ) Returns ``true`` if the given ``peer_id`` is in the peers map (it might not be connected though). @@ -156,7 +156,7 @@ Returns ``true`` if the given ``peer_id`` is in the peers map (it might not be c .. rst-class:: classref-method -void **remove_peer** **(** :ref:`int` peer_id **)** +|void| **remove_peer**\ (\ peer_id\: :ref:`int`\ ) Remove the peer with given ``peer_id`` from the mesh. If the peer was connected, and :ref:`MultiplayerPeer.peer_connected` was emitted for it, then :ref:`MultiplayerPeer.peer_disconnected` will be emitted. @@ -167,3 +167,4 @@ Remove the peer with given ``peer_id`` from the mesh. If the peer was connected, .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_webrtcpeerconnection.rst b/classes/class_webrtcpeerconnection.rst index bbde093947d..83bb5472662 100644 --- a/classes/class_webrtcpeerconnection.rst +++ b/classes/class_webrtcpeerconnection.rst @@ -41,31 +41,31 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`add_ice_candidate` **(** :ref:`String` media, :ref:`int` index, :ref:`String` name **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`close` **(** **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`WebRTCDataChannel` | :ref:`create_data_channel` **(** :ref:`String` label, :ref:`Dictionary` options={} **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`create_offer` **(** **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ConnectionState` | :ref:`get_connection_state` **(** **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GatheringState` | :ref:`get_gathering_state` **(** **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SignalingState` | :ref:`get_signaling_state` **(** **)** |const| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`initialize` **(** :ref:`Dictionary` configuration={} **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`poll` **(** **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_default_extension` **(** :ref:`StringName` extension_class **)** |static| | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`set_local_description` **(** :ref:`String` type, :ref:`String` sdp **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`set_remote_description` **(** :ref:`String` type, :ref:`String` sdp **)** | - +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`add_ice_candidate`\ (\ media\: :ref:`String`, index\: :ref:`int`, name\: :ref:`String`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`close`\ (\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`WebRTCDataChannel` | :ref:`create_data_channel`\ (\ label\: :ref:`String`, options\: :ref:`Dictionary` = {}\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`create_offer`\ (\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ConnectionState` | :ref:`get_connection_state`\ (\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GatheringState` | :ref:`get_gathering_state`\ (\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SignalingState` | :ref:`get_signaling_state`\ (\ ) |const| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`initialize`\ (\ configuration\: :ref:`Dictionary` = {}\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`poll`\ (\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_default_extension`\ (\ extension_class\: :ref:`StringName`\ ) |static| | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`set_local_description`\ (\ type\: :ref:`String`, sdp\: :ref:`String`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`set_remote_description`\ (\ type\: :ref:`String`, sdp\: :ref:`String`\ ) | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -80,7 +80,7 @@ Signals .. rst-class:: classref-signal -**data_channel_received** **(** :ref:`WebRTCDataChannel` channel **)** +**data_channel_received**\ (\ channel\: :ref:`WebRTCDataChannel`\ ) Emitted when a new in-band channel is received, i.e. when the channel was created with ``negotiated: false`` (default). @@ -94,7 +94,7 @@ The object will be an instance of :ref:`WebRTCDataChannel` media, :ref:`int` index, :ref:`String` name **)** +**ice_candidate_created**\ (\ media\: :ref:`String`, index\: :ref:`int`, name\: :ref:`String`\ ) Emitted when a new ICE candidate has been created. The three parameters are meant to be passed to the remote peer over the signaling server. @@ -106,7 +106,7 @@ Emitted when a new ICE candidate has been created. The three parameters are mean .. rst-class:: classref-signal -**session_description_created** **(** :ref:`String` type, :ref:`String` sdp **)** +**session_description_created**\ (\ type\: :ref:`String`, sdp\: :ref:`String`\ ) Emitted after a successful call to :ref:`create_offer` or :ref:`set_remote_description` (when it generates an answer). The parameters are meant to be passed to :ref:`set_local_description` on this object, and sent to the remote peer over the signaling server. @@ -278,7 +278,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **add_ice_candidate** **(** :ref:`String` media, :ref:`int` index, :ref:`String` name **)** +:ref:`Error` **add_ice_candidate**\ (\ media\: :ref:`String`, index\: :ref:`int`, name\: :ref:`String`\ ) Add an ice candidate generated by a remote peer (and received over the signaling server). See :ref:`ice_candidate_created`. @@ -290,7 +290,7 @@ Add an ice candidate generated by a remote peer (and received over the signaling .. rst-class:: classref-method -void **close** **(** **)** +|void| **close**\ (\ ) Close the peer connection and all data channels associated with it. @@ -304,7 +304,7 @@ Close the peer connection and all data channels associated with it. .. rst-class:: classref-method -:ref:`WebRTCDataChannel` **create_data_channel** **(** :ref:`String` label, :ref:`Dictionary` options={} **)** +:ref:`WebRTCDataChannel` **create_data_channel**\ (\ label\: :ref:`String`, options\: :ref:`Dictionary` = {}\ ) Returns a new :ref:`WebRTCDataChannel` (or ``null`` on failure) with given ``label`` and optionally configured via the ``options`` dictionary. This method can only be called when the connection is in state :ref:`STATE_NEW`. @@ -336,7 +336,7 @@ Valid ``options`` are: .. rst-class:: classref-method -:ref:`Error` **create_offer** **(** **)** +:ref:`Error` **create_offer**\ (\ ) Creates a new SDP offer to start a WebRTC connection with a remote peer. At least one :ref:`WebRTCDataChannel` must have been created before calling this method. @@ -350,7 +350,7 @@ If this functions returns :ref:`@GlobalScope.OK` .. rst-class:: classref-method -:ref:`ConnectionState` **get_connection_state** **(** **)** |const| +:ref:`ConnectionState` **get_connection_state**\ (\ ) |const| Returns the connection state. See :ref:`ConnectionState`. @@ -362,7 +362,7 @@ Returns the connection state. See :ref:`ConnectionState` **get_gathering_state** **(** **)** |const| +:ref:`GatheringState` **get_gathering_state**\ (\ ) |const| Returns the ICE :ref:`GatheringState` of the connection. This lets you detect, for example, when collection of ICE candidates has finished. @@ -374,7 +374,7 @@ Returns the ICE :ref:`GatheringState` .. rst-class:: classref-method -:ref:`SignalingState` **get_signaling_state** **(** **)** |const| +:ref:`SignalingState` **get_signaling_state**\ (\ ) |const| Returns the signaling state on the local end of the connection while connecting or reconnecting to another peer. @@ -386,7 +386,7 @@ Returns the signaling state on the local end of the connection while connecting .. rst-class:: classref-method -:ref:`Error` **initialize** **(** :ref:`Dictionary` configuration={} **)** +:ref:`Error` **initialize**\ (\ configuration\: :ref:`Dictionary` = {}\ ) Re-initialize this peer connection, closing any previously active connection, and going back to state :ref:`STATE_NEW`. A dictionary of ``configuration`` options can be passed to configure the peer connection. @@ -415,7 +415,7 @@ Valid ``configuration`` options are: .. rst-class:: classref-method -:ref:`Error` **poll** **(** **)** +:ref:`Error` **poll**\ (\ ) Call this method frequently (e.g. in :ref:`Node._process` or :ref:`Node._physics_process`) to properly receive signals. @@ -427,7 +427,7 @@ Call this method frequently (e.g. in :ref:`Node._process` extension_class **)** |static| +|void| **set_default_extension**\ (\ extension_class\: :ref:`StringName`\ ) |static| Sets the ``extension_class`` as the default :ref:`WebRTCPeerConnectionExtension` returned when creating a new **WebRTCPeerConnection**. @@ -439,7 +439,7 @@ Sets the ``extension_class`` as the default :ref:`WebRTCPeerConnectionExtension< .. rst-class:: classref-method -:ref:`Error` **set_local_description** **(** :ref:`String` type, :ref:`String` sdp **)** +:ref:`Error` **set_local_description**\ (\ type\: :ref:`String`, sdp\: :ref:`String`\ ) Sets the SDP description of the local peer. This should be called in response to :ref:`session_description_created`. @@ -453,7 +453,7 @@ After calling this function the peer will start emitting :ref:`ice_candidate_cre .. rst-class:: classref-method -:ref:`Error` **set_remote_description** **(** :ref:`String` type, :ref:`String` sdp **)** +:ref:`Error` **set_remote_description**\ (\ type\: :ref:`String`, sdp\: :ref:`String`\ ) Sets the SDP description of the remote peer. This should be called with the values generated by a remote peer and received over the signaling server. @@ -468,3 +468,4 @@ If ``type`` is ``"answer"`` the peer will start emitting :ref:`ice_candidate_cre .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_webrtcpeerconnectionextension.rst b/classes/class_webrtcpeerconnectionextension.rst index 7e45be5a19d..2e828667d1f 100644 --- a/classes/class_webrtcpeerconnectionextension.rst +++ b/classes/class_webrtcpeerconnectionextension.rst @@ -24,29 +24,29 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_add_ice_candidate` **(** :ref:`String` p_sdp_mid_name, :ref:`int` p_sdp_mline_index, :ref:`String` p_sdp_name **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_close` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`WebRTCDataChannel` | :ref:`_create_data_channel` **(** :ref:`String` p_label, :ref:`Dictionary` p_config **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_create_offer` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ConnectionState` | :ref:`_get_connection_state` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`GatheringState` | :ref:`_get_gathering_state` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SignalingState` | :ref:`_get_signaling_state` **(** **)** |virtual| |const| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_initialize` **(** :ref:`Dictionary` p_config **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_poll` **(** **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_set_local_description` **(** :ref:`String` p_type, :ref:`String` p_sdp **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_set_remote_description` **(** :ref:`String` p_type, :ref:`String` p_sdp **)** |virtual| | - +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_add_ice_candidate`\ (\ p_sdp_mid_name\: :ref:`String`, p_sdp_mline_index\: :ref:`int`, p_sdp_name\: :ref:`String`\ ) |virtual| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_close`\ (\ ) |virtual| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`WebRTCDataChannel` | :ref:`_create_data_channel`\ (\ p_label\: :ref:`String`, p_config\: :ref:`Dictionary`\ ) |virtual| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_create_offer`\ (\ ) |virtual| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ConnectionState` | :ref:`_get_connection_state`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`GatheringState` | :ref:`_get_gathering_state`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SignalingState` | :ref:`_get_signaling_state`\ (\ ) |virtual| |const| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_initialize`\ (\ p_config\: :ref:`Dictionary`\ ) |virtual| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_poll`\ (\ ) |virtual| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_set_local_description`\ (\ p_type\: :ref:`String`, p_sdp\: :ref:`String`\ ) |virtual| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`_set_remote_description`\ (\ p_type\: :ref:`String`, p_sdp\: :ref:`String`\ ) |virtual| | + +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -61,7 +61,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **_add_ice_candidate** **(** :ref:`String` p_sdp_mid_name, :ref:`int` p_sdp_mline_index, :ref:`String` p_sdp_name **)** |virtual| +:ref:`Error` **_add_ice_candidate**\ (\ p_sdp_mid_name\: :ref:`String`, p_sdp_mline_index\: :ref:`int`, p_sdp_name\: :ref:`String`\ ) |virtual| .. container:: contribute @@ -75,7 +75,7 @@ Method Descriptions .. rst-class:: classref-method -void **_close** **(** **)** |virtual| +|void| **_close**\ (\ ) |virtual| .. container:: contribute @@ -89,7 +89,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`WebRTCDataChannel` **_create_data_channel** **(** :ref:`String` p_label, :ref:`Dictionary` p_config **)** |virtual| +:ref:`WebRTCDataChannel` **_create_data_channel**\ (\ p_label\: :ref:`String`, p_config\: :ref:`Dictionary`\ ) |virtual| .. container:: contribute @@ -103,7 +103,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`Error` **_create_offer** **(** **)** |virtual| +:ref:`Error` **_create_offer**\ (\ ) |virtual| .. container:: contribute @@ -117,7 +117,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`ConnectionState` **_get_connection_state** **(** **)** |virtual| |const| +:ref:`ConnectionState` **_get_connection_state**\ (\ ) |virtual| |const| .. container:: contribute @@ -131,7 +131,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`GatheringState` **_get_gathering_state** **(** **)** |virtual| |const| +:ref:`GatheringState` **_get_gathering_state**\ (\ ) |virtual| |const| .. container:: contribute @@ -145,7 +145,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`SignalingState` **_get_signaling_state** **(** **)** |virtual| |const| +:ref:`SignalingState` **_get_signaling_state**\ (\ ) |virtual| |const| .. container:: contribute @@ -159,7 +159,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`Error` **_initialize** **(** :ref:`Dictionary` p_config **)** |virtual| +:ref:`Error` **_initialize**\ (\ p_config\: :ref:`Dictionary`\ ) |virtual| .. container:: contribute @@ -173,7 +173,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`Error` **_poll** **(** **)** |virtual| +:ref:`Error` **_poll**\ (\ ) |virtual| .. container:: contribute @@ -187,7 +187,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`Error` **_set_local_description** **(** :ref:`String` p_type, :ref:`String` p_sdp **)** |virtual| +:ref:`Error` **_set_local_description**\ (\ p_type\: :ref:`String`, p_sdp\: :ref:`String`\ ) |virtual| .. container:: contribute @@ -201,7 +201,7 @@ void **_close** **(** **)** |virtual| .. rst-class:: classref-method -:ref:`Error` **_set_remote_description** **(** :ref:`String` p_type, :ref:`String` p_sdp **)** |virtual| +:ref:`Error` **_set_remote_description**\ (\ p_type\: :ref:`String`, p_sdp\: :ref:`String`\ ) |virtual| .. container:: contribute @@ -214,3 +214,4 @@ void **_close** **(** **)** |virtual| .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_websocketmultiplayerpeer.rst b/classes/class_websocketmultiplayerpeer.rst index 2ec1fa173b2..d4734cc3ef0 100644 --- a/classes/class_websocketmultiplayerpeer.rst +++ b/classes/class_websocketmultiplayerpeer.rst @@ -53,17 +53,17 @@ Methods .. table:: :widths: auto - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`create_client` **(** :ref:`String` url, :ref:`TLSOptions` tls_client_options=null **)** | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`create_server` **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`TLSOptions` tls_server_options=null **)** | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`WebSocketPeer` | :ref:`get_peer` **(** :ref:`int` peer_id **)** |const| | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_peer_address` **(** :ref:`int` id **)** |const| | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_peer_port` **(** :ref:`int` id **)** |const| | - +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`create_client`\ (\ url\: :ref:`String`, tls_client_options\: :ref:`TLSOptions` = null\ ) | + +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`create_server`\ (\ port\: :ref:`int`, bind_address\: :ref:`String` = "*", tls_server_options\: :ref:`TLSOptions` = null\ ) | + +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`WebSocketPeer` | :ref:`get_peer`\ (\ peer_id\: :ref:`int`\ ) |const| | + +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_peer_address`\ (\ id\: :ref:`int`\ ) |const| | + +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_peer_port`\ (\ id\: :ref:`int`\ ) |const| | + +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -82,8 +82,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_handshake_headers** **(** :ref:`PackedStringArray` value **)** -- :ref:`PackedStringArray` **get_handshake_headers** **(** **)** +- |void| **set_handshake_headers**\ (\ value\: :ref:`PackedStringArray`\ ) +- :ref:`PackedStringArray` **get_handshake_headers**\ (\ ) The extra headers to use during handshake. See :ref:`WebSocketPeer.handshake_headers` for more details. @@ -99,8 +99,8 @@ The extra headers to use during handshake. See :ref:`WebSocketPeer.handshake_hea .. rst-class:: classref-property-setget -- void **set_handshake_timeout** **(** :ref:`float` value **)** -- :ref:`float` **get_handshake_timeout** **(** **)** +- |void| **set_handshake_timeout**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_handshake_timeout**\ (\ ) The maximum time each peer can stay in a connecting state before being dropped. @@ -116,8 +116,8 @@ The maximum time each peer can stay in a connecting state before being dropped. .. rst-class:: classref-property-setget -- void **set_inbound_buffer_size** **(** :ref:`int` value **)** -- :ref:`int` **get_inbound_buffer_size** **(** **)** +- |void| **set_inbound_buffer_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_inbound_buffer_size**\ (\ ) The inbound buffer size for connected peers. See :ref:`WebSocketPeer.inbound_buffer_size` for more details. @@ -133,8 +133,8 @@ The inbound buffer size for connected peers. See :ref:`WebSocketPeer.inbound_buf .. rst-class:: classref-property-setget -- void **set_max_queued_packets** **(** :ref:`int` value **)** -- :ref:`int` **get_max_queued_packets** **(** **)** +- |void| **set_max_queued_packets**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_queued_packets**\ (\ ) The maximum number of queued packets for connected peers. See :ref:`WebSocketPeer.max_queued_packets` for more details. @@ -150,8 +150,8 @@ The maximum number of queued packets for connected peers. See :ref:`WebSocketPee .. rst-class:: classref-property-setget -- void **set_outbound_buffer_size** **(** :ref:`int` value **)** -- :ref:`int` **get_outbound_buffer_size** **(** **)** +- |void| **set_outbound_buffer_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_outbound_buffer_size**\ (\ ) The outbound buffer size for connected peers. See :ref:`WebSocketPeer.outbound_buffer_size` for more details. @@ -167,8 +167,8 @@ The outbound buffer size for connected peers. See :ref:`WebSocketPeer.outbound_b .. rst-class:: classref-property-setget -- void **set_supported_protocols** **(** :ref:`PackedStringArray` value **)** -- :ref:`PackedStringArray` **get_supported_protocols** **(** **)** +- |void| **set_supported_protocols**\ (\ value\: :ref:`PackedStringArray`\ ) +- :ref:`PackedStringArray` **get_supported_protocols**\ (\ ) The supported WebSocket sub-protocols. See :ref:`WebSocketPeer.supported_protocols` for more details. @@ -185,7 +185,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **create_client** **(** :ref:`String` url, :ref:`TLSOptions` tls_client_options=null **)** +:ref:`Error` **create_client**\ (\ url\: :ref:`String`, tls_client_options\: :ref:`TLSOptions` = null\ ) Starts a new multiplayer client connecting to the given ``url``. TLS certificates will be verified against the hostname when connecting using the ``wss://`` protocol. You can pass the optional ``tls_client_options`` parameter to customize the trusted certification authorities, or disable the common name verification. See :ref:`TLSOptions.client` and :ref:`TLSOptions.client_unsafe`. @@ -199,7 +199,7 @@ Starts a new multiplayer client connecting to the given ``url``. TLS certificate .. rst-class:: classref-method -:ref:`Error` **create_server** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`TLSOptions` tls_server_options=null **)** +:ref:`Error` **create_server**\ (\ port\: :ref:`int`, bind_address\: :ref:`String` = "*", tls_server_options\: :ref:`TLSOptions` = null\ ) Starts a new multiplayer server listening on the given ``port``. You can optionally specify a ``bind_address``, and provide valid ``tls_server_options`` to use TLS. See :ref:`TLSOptions.server`. @@ -211,7 +211,7 @@ Starts a new multiplayer server listening on the given ``port``. You can optiona .. rst-class:: classref-method -:ref:`WebSocketPeer` **get_peer** **(** :ref:`int` peer_id **)** |const| +:ref:`WebSocketPeer` **get_peer**\ (\ peer_id\: :ref:`int`\ ) |const| Returns the :ref:`WebSocketPeer` associated to the given ``peer_id``. @@ -223,7 +223,7 @@ Returns the :ref:`WebSocketPeer` associated to the given `` .. rst-class:: classref-method -:ref:`String` **get_peer_address** **(** :ref:`int` id **)** |const| +:ref:`String` **get_peer_address**\ (\ id\: :ref:`int`\ ) |const| Returns the IP address of the given peer. @@ -235,7 +235,7 @@ Returns the IP address of the given peer. .. rst-class:: classref-method -:ref:`int` **get_peer_port** **(** :ref:`int` id **)** |const| +:ref:`int` **get_peer_port**\ (\ id\: :ref:`int`\ ) |const| Returns the remote port of the given peer. @@ -246,3 +246,4 @@ Returns the remote port of the given peer. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_websocketpeer.rst b/classes/class_websocketpeer.rst index 1cc7542a615..bbeacb47fdd 100644 --- a/classes/class_websocketpeer.rst +++ b/classes/class_websocketpeer.rst @@ -84,39 +84,39 @@ Methods .. table:: :widths: auto - +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`accept_stream` **(** :ref:`StreamPeer` stream **)** | - +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`close` **(** :ref:`int` code=1000, :ref:`String` reason="" **)** | - +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`connect_to_url` **(** :ref:`String` url, :ref:`TLSOptions` tls_client_options=null **)** | - +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_close_code` **(** **)** |const| | - +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_close_reason` **(** **)** |const| | - +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_connected_host` **(** **)** |const| | - +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_connected_port` **(** **)** |const| | - +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_current_outbound_buffered_amount` **(** **)** |const| | - +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`State` | :ref:`get_ready_state` **(** **)** |const| | - +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_requested_url` **(** **)** |const| | - +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_selected_protocol` **(** **)** |const| | - +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`poll` **(** **)** | - +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`send` **(** :ref:`PackedByteArray` message, :ref:`WriteMode` write_mode=1 **)** | - +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`send_text` **(** :ref:`String` message **)** | - +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_no_delay` **(** :ref:`bool` enabled **)** | - +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`was_string_packet` **(** **)** |const| | - +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`accept_stream`\ (\ stream\: :ref:`StreamPeer`\ ) | + +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`close`\ (\ code\: :ref:`int` = 1000, reason\: :ref:`String` = ""\ ) | + +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`connect_to_url`\ (\ url\: :ref:`String`, tls_client_options\: :ref:`TLSOptions` = null\ ) | + +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_close_code`\ (\ ) |const| | + +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_close_reason`\ (\ ) |const| | + +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_connected_host`\ (\ ) |const| | + +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_connected_port`\ (\ ) |const| | + +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_current_outbound_buffered_amount`\ (\ ) |const| | + +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`State` | :ref:`get_ready_state`\ (\ ) |const| | + +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_requested_url`\ (\ ) |const| | + +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_selected_protocol`\ (\ ) |const| | + +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`poll`\ (\ ) | + +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`send`\ (\ message\: :ref:`PackedByteArray`, write_mode\: :ref:`WriteMode` = 1\ ) | + +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`send_text`\ (\ message\: :ref:`String`\ ) | + +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_no_delay`\ (\ enabled\: :ref:`bool`\ ) | + +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`was_string_packet`\ (\ ) |const| | + +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -208,8 +208,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_handshake_headers** **(** :ref:`PackedStringArray` value **)** -- :ref:`PackedStringArray` **get_handshake_headers** **(** **)** +- |void| **set_handshake_headers**\ (\ value\: :ref:`PackedStringArray`\ ) +- :ref:`PackedStringArray` **get_handshake_headers**\ (\ ) The extra HTTP headers to be sent during the WebSocket handshake. @@ -227,8 +227,8 @@ The extra HTTP headers to be sent during the WebSocket handshake. .. rst-class:: classref-property-setget -- void **set_inbound_buffer_size** **(** :ref:`int` value **)** -- :ref:`int` **get_inbound_buffer_size** **(** **)** +- |void| **set_inbound_buffer_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_inbound_buffer_size**\ (\ ) The size of the input buffer in bytes (roughly the maximum amount of memory that will be allocated for the inbound packets). @@ -244,8 +244,8 @@ The size of the input buffer in bytes (roughly the maximum amount of memory that .. rst-class:: classref-property-setget -- void **set_max_queued_packets** **(** :ref:`int` value **)** -- :ref:`int` **get_max_queued_packets** **(** **)** +- |void| **set_max_queued_packets**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_max_queued_packets**\ (\ ) The maximum amount of packets that will be allowed in the queues (both inbound and outbound). @@ -261,8 +261,8 @@ The maximum amount of packets that will be allowed in the queues (both inbound a .. rst-class:: classref-property-setget -- void **set_outbound_buffer_size** **(** :ref:`int` value **)** -- :ref:`int` **get_outbound_buffer_size** **(** **)** +- |void| **set_outbound_buffer_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_outbound_buffer_size**\ (\ ) The size of the input buffer in bytes (roughly the maximum amount of memory that will be allocated for the outbound packets). @@ -278,8 +278,8 @@ The size of the input buffer in bytes (roughly the maximum amount of memory that .. rst-class:: classref-property-setget -- void **set_supported_protocols** **(** :ref:`PackedStringArray` value **)** -- :ref:`PackedStringArray` **get_supported_protocols** **(** **)** +- |void| **set_supported_protocols**\ (\ value\: :ref:`PackedStringArray`\ ) +- :ref:`PackedStringArray` **get_supported_protocols**\ (\ ) The WebSocket sub-protocols allowed during the WebSocket handshake. @@ -296,7 +296,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Error` **accept_stream** **(** :ref:`StreamPeer` stream **)** +:ref:`Error` **accept_stream**\ (\ stream\: :ref:`StreamPeer`\ ) Accepts a peer connection performing the HTTP handshake as a WebSocket server. The ``stream`` must be a valid TCP stream retrieved via :ref:`TCPServer.take_connection`, or a TLS stream accepted via :ref:`StreamPeerTLS.accept_stream`. @@ -310,7 +310,7 @@ Accepts a peer connection performing the HTTP handshake as a WebSocket server. T .. rst-class:: classref-method -void **close** **(** :ref:`int` code=1000, :ref:`String` reason="" **)** +|void| **close**\ (\ code\: :ref:`int` = 1000, reason\: :ref:`String` = ""\ ) Closes this WebSocket connection. ``code`` is the status code for the closure (see RFC 6455 section 7.4 for a list of valid status codes). ``reason`` is the human readable reason for closing the connection (can be any UTF-8 string that's smaller than 123 bytes). If ``code`` is negative, the connection will be closed immediately without notifying the remote peer. @@ -326,7 +326,7 @@ Closes this WebSocket connection. ``code`` is the status code for the closure (s .. rst-class:: classref-method -:ref:`Error` **connect_to_url** **(** :ref:`String` url, :ref:`TLSOptions` tls_client_options=null **)** +:ref:`Error` **connect_to_url**\ (\ url\: :ref:`String`, tls_client_options\: :ref:`TLSOptions` = null\ ) Connects to the given URL. TLS certificates will be verified against the hostname when connecting using the ``wss://`` protocol. You can pass the optional ``tls_client_options`` parameter to customize the trusted certification authorities, or disable the common name verification. See :ref:`TLSOptions.client` and :ref:`TLSOptions.client_unsafe`. @@ -340,7 +340,7 @@ Connects to the given URL. TLS certificates will be verified against the hostnam .. rst-class:: classref-method -:ref:`int` **get_close_code** **(** **)** |const| +:ref:`int` **get_close_code**\ (\ ) |const| Returns the received WebSocket close frame status code, or ``-1`` when the connection was not cleanly closed. Only call this method when :ref:`get_ready_state` returns :ref:`STATE_CLOSED`. @@ -352,7 +352,7 @@ Returns the received WebSocket close frame status code, or ``-1`` when the conne .. rst-class:: classref-method -:ref:`String` **get_close_reason** **(** **)** |const| +:ref:`String` **get_close_reason**\ (\ ) |const| Returns the received WebSocket close frame status reason string. Only call this method when :ref:`get_ready_state` returns :ref:`STATE_CLOSED`. @@ -364,7 +364,7 @@ Returns the received WebSocket close frame status reason string. Only call this .. rst-class:: classref-method -:ref:`String` **get_connected_host** **(** **)** |const| +:ref:`String` **get_connected_host**\ (\ ) |const| Returns the IP address of the connected peer. @@ -378,7 +378,7 @@ Returns the IP address of the connected peer. .. rst-class:: classref-method -:ref:`int` **get_connected_port** **(** **)** |const| +:ref:`int` **get_connected_port**\ (\ ) |const| Returns the remote port of the connected peer. @@ -392,7 +392,7 @@ Returns the remote port of the connected peer. .. rst-class:: classref-method -:ref:`int` **get_current_outbound_buffered_amount** **(** **)** |const| +:ref:`int` **get_current_outbound_buffered_amount**\ (\ ) |const| Returns the current amount of data in the outbound websocket buffer. **Note:** Web exports use WebSocket.bufferedAmount, while other platforms use an internal buffer. @@ -404,7 +404,7 @@ Returns the current amount of data in the outbound websocket buffer. **Note:** W .. rst-class:: classref-method -:ref:`State` **get_ready_state** **(** **)** |const| +:ref:`State` **get_ready_state**\ (\ ) |const| Returns the ready state of the connection. See :ref:`State`. @@ -416,7 +416,7 @@ Returns the ready state of the connection. See :ref:`State` **get_requested_url** **(** **)** |const| +:ref:`String` **get_requested_url**\ (\ ) |const| Returns the URL requested by this peer. The URL is derived from the ``url`` passed to :ref:`connect_to_url` or from the HTTP headers when acting as server (i.e. when using :ref:`accept_stream`). @@ -428,7 +428,7 @@ Returns the URL requested by this peer. The URL is derived from the ``url`` pass .. rst-class:: classref-method -:ref:`String` **get_selected_protocol** **(** **)** |const| +:ref:`String` **get_selected_protocol**\ (\ ) |const| Returns the selected WebSocket sub-protocol for this connection or an empty string if the sub-protocol has not been selected yet. @@ -440,7 +440,7 @@ Returns the selected WebSocket sub-protocol for this connection or an empty stri .. rst-class:: classref-method -void **poll** **(** **)** +|void| **poll**\ (\ ) Updates the connection state and receive incoming packets. Call this function regularly to keep it in a clean state. @@ -452,7 +452,7 @@ Updates the connection state and receive incoming packets. Call this function re .. rst-class:: classref-method -:ref:`Error` **send** **(** :ref:`PackedByteArray` message, :ref:`WriteMode` write_mode=1 **)** +:ref:`Error` **send**\ (\ message\: :ref:`PackedByteArray`, write_mode\: :ref:`WriteMode` = 1\ ) Sends the given ``message`` using the desired ``write_mode``. When sending a :ref:`String`, prefer using :ref:`send_text`. @@ -464,7 +464,7 @@ Sends the given ``message`` using the desired ``write_mode``. When sending a :re .. rst-class:: classref-method -:ref:`Error` **send_text** **(** :ref:`String` message **)** +:ref:`Error` **send_text**\ (\ message\: :ref:`String`\ ) Sends the given ``message`` using WebSocket text mode. Prefer this method over :ref:`PacketPeer.put_packet` when interacting with third-party text-based API (e.g. when using :ref:`JSON` formatted messages). @@ -476,7 +476,7 @@ Sends the given ``message`` using WebSocket text mode. Prefer this method over : .. rst-class:: classref-method -void **set_no_delay** **(** :ref:`bool` enabled **)** +|void| **set_no_delay**\ (\ enabled\: :ref:`bool`\ ) Disable Nagle's algorithm on the underling TCP socket (default). See :ref:`StreamPeerTCP.set_no_delay` for more information. @@ -490,7 +490,7 @@ Disable Nagle's algorithm on the underling TCP socket (default). See :ref:`Strea .. rst-class:: classref-method -:ref:`bool` **was_string_packet** **(** **)** |const| +:ref:`bool` **was_string_packet**\ (\ ) |const| Returns ``true`` if the last received packet was sent as a text payload. See :ref:`WriteMode`. @@ -501,3 +501,4 @@ Returns ``true`` if the last received packet was sent as a text payload. See :re .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_webxrinterface.rst b/classes/class_webxrinterface.rst index 5b26677f6d6..4a56c924055 100644 --- a/classes/class_webxrinterface.rst +++ b/classes/class_webxrinterface.rst @@ -128,6 +128,8 @@ Properties .. table:: :widths: auto + +-----------------------------+-------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`enabled_features` | +-----------------------------+-------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`optional_features` | +-----------------------------+-------------------------------------------------------------------------------------------------------+ @@ -150,21 +152,21 @@ Methods .. table:: :widths: auto - +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_available_display_refresh_rates` **(** **)** |const| | - +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_display_refresh_rate` **(** **)** |const| | - +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TargetRayMode` | :ref:`get_input_source_target_ray_mode` **(** :ref:`int` input_source_id **)** |const| | - +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`XRPositionalTracker` | :ref:`get_input_source_tracker` **(** :ref:`int` input_source_id **)** |const| | - +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_input_source_active` **(** :ref:`int` input_source_id **)** |const| | - +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`is_session_supported` **(** :ref:`String` session_mode **)** | - +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_display_refresh_rate` **(** :ref:`float` refresh_rate **)** | - +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_available_display_refresh_rates`\ (\ ) |const| | + +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_display_refresh_rate`\ (\ ) |const| | + +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TargetRayMode` | :ref:`get_input_source_target_ray_mode`\ (\ input_source_id\: :ref:`int`\ ) |const| | + +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`XRPositionalTracker` | :ref:`get_input_source_tracker`\ (\ input_source_id\: :ref:`int`\ ) |const| | + +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_input_source_active`\ (\ input_source_id\: :ref:`int`\ ) |const| | + +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`is_session_supported`\ (\ session_mode\: :ref:`String`\ ) | + +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_display_refresh_rate`\ (\ refresh_rate\: :ref:`float`\ ) | + +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -179,7 +181,7 @@ Signals .. rst-class:: classref-signal -**display_refresh_rate_changed** **(** **)** +**display_refresh_rate_changed**\ (\ ) Emitted after the display's refresh rate has changed. @@ -191,7 +193,7 @@ Emitted after the display's refresh rate has changed. .. rst-class:: classref-signal -**reference_space_reset** **(** **)** +**reference_space_reset**\ (\ ) Emitted to indicate that the reference space has been reset or reconfigured. @@ -207,7 +209,7 @@ See `WebXR's XRReferenceSpace reset event ` input_source_id **)** +**select**\ (\ input_source_id\: :ref:`int`\ ) Emitted after one of the input sources has finished its "primary action". @@ -221,7 +223,7 @@ Use :ref:`get_input_source_tracker` input_source_id **)** +**selectend**\ (\ input_source_id\: :ref:`int`\ ) Emitted when one of the input sources has finished its "primary action". @@ -235,7 +237,7 @@ Use :ref:`get_input_source_tracker` input_source_id **)** +**selectstart**\ (\ input_source_id\: :ref:`int`\ ) Emitted when one of the input source has started its "primary action". @@ -249,7 +251,7 @@ Use :ref:`get_input_source_tracker` message **)** +**session_failed**\ (\ message\: :ref:`String`\ ) Emitted by :ref:`XRInterface.initialize` if the session fails to start. @@ -277,7 +279,7 @@ Emitted by :ref:`XRInterface.initialize` if .. rst-class:: classref-signal -**session_started** **(** **)** +**session_started**\ (\ ) Emitted by :ref:`XRInterface.initialize` if the session is successfully started. @@ -291,7 +293,7 @@ At this point, it's safe to do ``get_viewport().use_xr = true`` to instruct Godo .. rst-class:: classref-signal -**session_supported** **(** :ref:`String` session_mode, :ref:`bool` supported **)** +**session_supported**\ (\ session_mode\: :ref:`String`, supported\: :ref:`bool`\ ) Emitted by :ref:`is_session_supported` to indicate if the given ``session_mode`` is supported or not. @@ -303,7 +305,7 @@ Emitted by :ref:`is_session_supported` input_source_id **)** +**squeeze**\ (\ input_source_id\: :ref:`int`\ ) Emitted after one of the input sources has finished its "primary squeeze action". @@ -317,7 +319,7 @@ Use :ref:`get_input_source_tracker` input_source_id **)** +**squeezeend**\ (\ input_source_id\: :ref:`int`\ ) Emitted when one of the input sources has finished its "primary squeeze action". @@ -331,7 +333,7 @@ Use :ref:`get_input_source_tracker` input_source_id **)** +**squeezestart**\ (\ input_source_id\: :ref:`int`\ ) Emitted when one of the input sources has started its "primary squeeze action". @@ -345,7 +347,7 @@ Use :ref:`get_input_source_tracker` has changed. @@ -405,6 +407,24 @@ Target ray from touch screen, mouse or other tactile input device. Property Descriptions --------------------- +.. _class_WebXRInterface_property_enabled_features: + +.. rst-class:: classref-property + +:ref:`String` **enabled_features** + +.. rst-class:: classref-property-setget + +- :ref:`String` **get_enabled_features**\ (\ ) + +A comma-separated list of features that were successfully enabled by :ref:`XRInterface.initialize` when setting up the WebXR session. + +This may include features requested by setting :ref:`required_features` and :ref:`optional_features`. + +.. rst-class:: classref-item-separator + +---- + .. _class_WebXRInterface_property_optional_features: .. rst-class:: classref-property @@ -413,8 +433,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_optional_features** **(** :ref:`String` value **)** -- :ref:`String` **get_optional_features** **(** **)** +- |void| **set_optional_features**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_optional_features**\ (\ ) A comma-seperated list of optional features used by :ref:`XRInterface.initialize` when setting up the WebXR session. @@ -436,7 +456,7 @@ Possible values come from `WebXR's XRReferenceSpaceType ` **get_reference_space_type** **(** **)** +- :ref:`String` **get_reference_space_type**\ (\ ) The reference space type (from the list of requested types set in the :ref:`requested_reference_space_types` property), that was ultimately used by :ref:`XRInterface.initialize` when setting up the WebXR session. @@ -454,8 +474,8 @@ Possible values come from `WebXR's XRReferenceSpaceType ` value **)** -- :ref:`String` **get_requested_reference_space_types** **(** **)** +- |void| **set_requested_reference_space_types**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_requested_reference_space_types**\ (\ ) A comma-seperated list of reference space types used by :ref:`XRInterface.initialize` when setting up the WebXR session. @@ -477,8 +497,8 @@ Possible values come from `WebXR's XRReferenceSpaceType ` value **)** -- :ref:`String` **get_required_features** **(** **)** +- |void| **set_required_features**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_required_features**\ (\ ) A comma-seperated list of required features used by :ref:`XRInterface.initialize` when setting up the WebXR session. @@ -500,8 +520,8 @@ Possible values come from `WebXR's XRReferenceSpaceType ` value **)** -- :ref:`String` **get_session_mode** **(** **)** +- |void| **set_session_mode**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_session_mode**\ (\ ) The session mode used by :ref:`XRInterface.initialize` when setting up the WebXR session. @@ -521,7 +541,7 @@ Possible values come from `WebXR's XRSessionMode ` **get_visibility_state** **(** **)** +- :ref:`String` **get_visibility_state**\ (\ ) Indicates if the WebXR session's imagery is visible to the user. @@ -540,7 +560,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Array` **get_available_display_refresh_rates** **(** **)** |const| +:ref:`Array` **get_available_display_refresh_rates**\ (\ ) |const| Returns display refresh rates supported by the current HMD. Only returned if this feature is supported by the web browser and after the interface has been initialized. @@ -552,7 +572,7 @@ Returns display refresh rates supported by the current HMD. Only returned if thi .. rst-class:: classref-method -:ref:`float` **get_display_refresh_rate** **(** **)** |const| +:ref:`float` **get_display_refresh_rate**\ (\ ) |const| Returns the display refresh rate for the current HMD. Not supported on all HMDs and browsers. It may not report an accurate value until after using :ref:`set_display_refresh_rate`. @@ -564,7 +584,7 @@ Returns the display refresh rate for the current HMD. Not supported on all HMDs .. rst-class:: classref-method -:ref:`TargetRayMode` **get_input_source_target_ray_mode** **(** :ref:`int` input_source_id **)** |const| +:ref:`TargetRayMode` **get_input_source_target_ray_mode**\ (\ input_source_id\: :ref:`int`\ ) |const| Returns the target ray mode for the given ``input_source_id``. @@ -578,7 +598,7 @@ This can help interpret the input coming from that input source. See `XRInputSou .. rst-class:: classref-method -:ref:`XRPositionalTracker` **get_input_source_tracker** **(** :ref:`int` input_source_id **)** |const| +:ref:`XRPositionalTracker` **get_input_source_tracker**\ (\ input_source_id\: :ref:`int`\ ) |const| Gets an :ref:`XRPositionalTracker` for the given ``input_source_id``. @@ -606,7 +626,7 @@ Use this method to get information about the input source that triggered one of .. rst-class:: classref-method -:ref:`bool` **is_input_source_active** **(** :ref:`int` input_source_id **)** |const| +:ref:`bool` **is_input_source_active**\ (\ input_source_id\: :ref:`int`\ ) |const| Returns ``true`` if there is an active input source with the given ``input_source_id``. @@ -618,7 +638,7 @@ Returns ``true`` if there is an active input source with the given ``input_sourc .. rst-class:: classref-method -void **is_session_supported** **(** :ref:`String` session_mode **)** +|void| **is_session_supported**\ (\ session_mode\: :ref:`String`\ ) Checks if the given ``session_mode`` is supported by the user's browser. @@ -634,7 +654,7 @@ This method returns nothing, instead it emits the :ref:`session_supported` refresh_rate **)** +|void| **set_display_refresh_rate**\ (\ refresh_rate\: :ref:`float`\ ) Sets the display refresh rate for the current HMD. Not supported on all HMDs and browsers. It won't take effect right away until after :ref:`display_refresh_rate_changed` is emitted. @@ -645,3 +665,4 @@ Sets the display refresh rate for the current HMD. Not supported on all HMDs and .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_window.rst b/classes/class_window.rst index 0073cd5be67..5328315fa45 100644 --- a/classes/class_window.rst +++ b/classes/class_window.rst @@ -105,151 +105,151 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`_get_contents_minimum_size` **(** **)** |virtual| |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_theme_color_override` **(** :ref:`StringName` name, :ref:`Color` color **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_theme_constant_override` **(** :ref:`StringName` name, :ref:`int` constant **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_theme_font_override` **(** :ref:`StringName` name, :ref:`Font` font **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_theme_font_size_override` **(** :ref:`StringName` name, :ref:`int` font_size **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_theme_icon_override` **(** :ref:`StringName` name, :ref:`Texture2D` texture **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_theme_stylebox_override` **(** :ref:`StringName` name, :ref:`StyleBox` stylebox **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`begin_bulk_theme_override` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`can_draw` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`child_controls_changed` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`end_bulk_theme_override` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_contents_minimum_size` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_flag` **(** :ref:`Flags` flag **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`LayoutDirection` | :ref:`get_layout_direction` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_position_with_decorations` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_size_with_decorations` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_theme_color` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_theme_constant` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_theme_default_base_scale` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Font` | :ref:`get_theme_default_font` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_theme_default_font_size` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Font` | :ref:`get_theme_font` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_theme_font_size` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_theme_icon` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StyleBox` | :ref:`get_theme_stylebox` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_window_id` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`grab_focus` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_focus` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_color` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_color_override` **(** :ref:`StringName` name **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_constant` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_constant_override` **(** :ref:`StringName` name **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_font` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_font_override` **(** :ref:`StringName` name **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_font_size` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_font_size_override` **(** :ref:`StringName` name **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_icon` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_icon_override` **(** :ref:`StringName` name **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_stylebox` **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_theme_stylebox_override` **(** :ref:`StringName` name **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`hide` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_embedded` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_layout_rtl` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_maximize_allowed` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_using_font_oversampling` **(** **)** |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_to_center` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`move_to_foreground` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`popup` **(** :ref:`Rect2i` rect=Rect2i(0, 0, 0, 0) **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`popup_centered` **(** :ref:`Vector2i` minsize=Vector2i(0, 0) **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`popup_centered_clamped` **(** :ref:`Vector2i` minsize=Vector2i(0, 0), :ref:`float` fallback_ratio=0.75 **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`popup_centered_ratio` **(** :ref:`float` ratio=0.8 **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`popup_exclusive` **(** :ref:`Node` from_node, :ref:`Rect2i` rect=Rect2i(0, 0, 0, 0) **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`popup_exclusive_centered` **(** :ref:`Node` from_node, :ref:`Vector2i` minsize=Vector2i(0, 0) **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`popup_exclusive_centered_clamped` **(** :ref:`Node` from_node, :ref:`Vector2i` minsize=Vector2i(0, 0), :ref:`float` fallback_ratio=0.75 **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`popup_exclusive_centered_ratio` **(** :ref:`Node` from_node, :ref:`float` ratio=0.8 **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`popup_exclusive_on_parent` **(** :ref:`Node` from_node, :ref:`Rect2i` parent_rect **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`popup_on_parent` **(** :ref:`Rect2i` parent_rect **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_theme_color_override` **(** :ref:`StringName` name **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_theme_constant_override` **(** :ref:`StringName` name **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_theme_font_override` **(** :ref:`StringName` name **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_theme_font_size_override` **(** :ref:`StringName` name **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_theme_icon_override` **(** :ref:`StringName` name **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_theme_stylebox_override` **(** :ref:`StringName` name **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`request_attention` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`reset_size` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_flag` **(** :ref:`Flags` flag, :ref:`bool` enabled **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_ime_active` **(** :ref:`bool` active **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_ime_position` **(** :ref:`Vector2i` position **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_layout_direction` **(** :ref:`LayoutDirection` direction **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_unparent_when_invisible` **(** :ref:`bool` unparent **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_use_font_oversampling` **(** :ref:`bool` enable **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`show` **(** **)** | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`_get_contents_minimum_size`\ (\ ) |virtual| |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_theme_color_override`\ (\ name\: :ref:`StringName`, color\: :ref:`Color`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_theme_constant_override`\ (\ name\: :ref:`StringName`, constant\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_theme_font_override`\ (\ name\: :ref:`StringName`, font\: :ref:`Font`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_theme_font_size_override`\ (\ name\: :ref:`StringName`, font_size\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_theme_icon_override`\ (\ name\: :ref:`StringName`, texture\: :ref:`Texture2D`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_theme_stylebox_override`\ (\ name\: :ref:`StringName`, stylebox\: :ref:`StyleBox`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`begin_bulk_theme_override`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`can_draw`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`child_controls_changed`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`end_bulk_theme_override`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_contents_minimum_size`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_flag`\ (\ flag\: :ref:`Flags`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`LayoutDirection` | :ref:`get_layout_direction`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_position_with_decorations`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_size_with_decorations`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_theme_color`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_theme_constant`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_theme_default_base_scale`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Font` | :ref:`get_theme_default_font`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_theme_default_font_size`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Font` | :ref:`get_theme_font`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_theme_font_size`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_theme_icon`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StyleBox` | :ref:`get_theme_stylebox`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_window_id`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`grab_focus`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_focus`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_color`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_color_override`\ (\ name\: :ref:`StringName`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_constant`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_constant_override`\ (\ name\: :ref:`StringName`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_font`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_font_override`\ (\ name\: :ref:`StringName`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_font_size`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_font_size_override`\ (\ name\: :ref:`StringName`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_icon`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_icon_override`\ (\ name\: :ref:`StringName`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_stylebox`\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_theme_stylebox_override`\ (\ name\: :ref:`StringName`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`hide`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_embedded`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_layout_rtl`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_maximize_allowed`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_using_font_oversampling`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_to_center`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_to_foreground`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup`\ (\ rect\: :ref:`Rect2i` = Rect2i(0, 0, 0, 0)\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_centered`\ (\ minsize\: :ref:`Vector2i` = Vector2i(0, 0)\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_centered_clamped`\ (\ minsize\: :ref:`Vector2i` = Vector2i(0, 0), fallback_ratio\: :ref:`float` = 0.75\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_centered_ratio`\ (\ ratio\: :ref:`float` = 0.8\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_exclusive`\ (\ from_node\: :ref:`Node`, rect\: :ref:`Rect2i` = Rect2i(0, 0, 0, 0)\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_exclusive_centered`\ (\ from_node\: :ref:`Node`, minsize\: :ref:`Vector2i` = Vector2i(0, 0)\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_exclusive_centered_clamped`\ (\ from_node\: :ref:`Node`, minsize\: :ref:`Vector2i` = Vector2i(0, 0), fallback_ratio\: :ref:`float` = 0.75\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_exclusive_centered_ratio`\ (\ from_node\: :ref:`Node`, ratio\: :ref:`float` = 0.8\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_exclusive_on_parent`\ (\ from_node\: :ref:`Node`, parent_rect\: :ref:`Rect2i`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`popup_on_parent`\ (\ parent_rect\: :ref:`Rect2i`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_theme_color_override`\ (\ name\: :ref:`StringName`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_theme_constant_override`\ (\ name\: :ref:`StringName`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_theme_font_override`\ (\ name\: :ref:`StringName`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_theme_font_size_override`\ (\ name\: :ref:`StringName`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_theme_icon_override`\ (\ name\: :ref:`StringName`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_theme_stylebox_override`\ (\ name\: :ref:`StringName`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`request_attention`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reset_size`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_flag`\ (\ flag\: :ref:`Flags`, enabled\: :ref:`bool`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_ime_active`\ (\ active\: :ref:`bool`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_ime_position`\ (\ position\: :ref:`Vector2i`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_layout_direction`\ (\ direction\: :ref:`LayoutDirection`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_unparent_when_invisible`\ (\ unparent\: :ref:`bool`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_use_font_oversampling`\ (\ enable\: :ref:`bool`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`show`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -300,7 +300,7 @@ Signals .. rst-class:: classref-signal -**about_to_popup** **(** **)** +**about_to_popup**\ (\ ) Emitted right after :ref:`popup` call, before the **Window** appears or does anything. @@ -312,7 +312,7 @@ Emitted right after :ref:`popup` call, before the **W .. rst-class:: classref-signal -**close_requested** **(** **)** +**close_requested**\ (\ ) Emitted when the **Window**'s close button is pressed or when :ref:`popup_window` is enabled and user clicks outside the window. @@ -326,7 +326,7 @@ This signal can be used to handle window closing, e.g. by connecting it to :ref: .. rst-class:: classref-signal -**dpi_changed** **(** **)** +**dpi_changed**\ (\ ) Emitted when the **Window**'s DPI changes as a result of OS-level changes (e.g. moving the window from a Retina display to a lower resolution one). @@ -340,7 +340,7 @@ Emitted when the **Window**'s DPI changes as a result of OS-level changes (e.g. .. rst-class:: classref-signal -**files_dropped** **(** :ref:`PackedStringArray` files **)** +**files_dropped**\ (\ files\: :ref:`PackedStringArray`\ ) Emitted when files are dragged from the OS file manager and dropped in the game window. The argument is a list of file paths. @@ -364,7 +364,7 @@ Example usage: .. rst-class:: classref-signal -**focus_entered** **(** **)** +**focus_entered**\ (\ ) Emitted when the **Window** gains focus. @@ -376,7 +376,7 @@ Emitted when the **Window** gains focus. .. rst-class:: classref-signal -**focus_exited** **(** **)** +**focus_exited**\ (\ ) Emitted when the **Window** loses its focus. @@ -388,7 +388,7 @@ Emitted when the **Window** loses its focus. .. rst-class:: classref-signal -**go_back_requested** **(** **)** +**go_back_requested**\ (\ ) Emitted when a go back request is sent (e.g. pressing the "Back" button on Android), right after :ref:`Node.NOTIFICATION_WM_GO_BACK_REQUEST`. @@ -400,7 +400,7 @@ Emitted when a go back request is sent (e.g. pressing the "Back" button on Andro .. rst-class:: classref-signal -**mouse_entered** **(** **)** +**mouse_entered**\ (\ ) Emitted when the mouse cursor enters the **Window**'s visible area, that is not occluded behind other :ref:`Control`\ s or windows, provided its :ref:`Viewport.gui_disable_input` is ``false`` and regardless if it's currently focused or not. @@ -412,7 +412,7 @@ Emitted when the mouse cursor enters the **Window**'s visible area, that is not .. rst-class:: classref-signal -**mouse_exited** **(** **)** +**mouse_exited**\ (\ ) Emitted when the mouse cursor leaves the **Window**'s visible area, that is not occluded behind other :ref:`Control`\ s or windows, provided its :ref:`Viewport.gui_disable_input` is ``false`` and regardless if it's currently focused or not. @@ -424,7 +424,7 @@ Emitted when the mouse cursor leaves the **Window**'s visible area, that is not .. rst-class:: classref-signal -**theme_changed** **(** **)** +**theme_changed**\ (\ ) Emitted when the :ref:`NOTIFICATION_THEME_CHANGED` notification is sent. @@ -436,7 +436,7 @@ Emitted when the :ref:`NOTIFICATION_THEME_CHANGED` event **)** +**window_input**\ (\ event\: :ref:`InputEvent`\ ) Emitted when the **Window** is currently focused and receives any input, passing the received event as an argument. The event's position, if present, is in the embedder's coordinate system. @@ -889,8 +889,8 @@ Property Descriptions .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, the window will be on top of all other windows. Does not work if :ref:`transient` is enabled. @@ -906,8 +906,10 @@ If ``true``, the window will be on top of all other windows. Does not work if :r .. rst-class:: classref-property-setget -- void **set_auto_translate** **(** :ref:`bool` value **)** -- :ref:`bool` **is_auto_translating** **(** **)** +- |void| **set_auto_translate**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_auto_translating**\ (\ ) + +**Deprecated:** Use :ref:`Node.auto_translate_mode` instead. Toggles if any text should automatically change to its translated version depending on the current locale. @@ -923,8 +925,8 @@ Toggles if any text should automatically change to its translated version depend .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, the window will have no borders. @@ -940,8 +942,8 @@ If ``true``, the window will have no borders. .. rst-class:: classref-property-setget -- void **set_content_scale_aspect** **(** :ref:`ContentScaleAspect` value **)** -- :ref:`ContentScaleAspect` **get_content_scale_aspect** **(** **)** +- |void| **set_content_scale_aspect**\ (\ value\: :ref:`ContentScaleAspect`\ ) +- :ref:`ContentScaleAspect` **get_content_scale_aspect**\ (\ ) Specifies how the content's aspect behaves when the **Window** is resized. The base aspect is determined by :ref:`content_scale_size`. @@ -957,8 +959,8 @@ Specifies how the content's aspect behaves when the **Window** is resized. The b .. rst-class:: classref-property-setget -- void **set_content_scale_factor** **(** :ref:`float` value **)** -- :ref:`float` **get_content_scale_factor** **(** **)** +- |void| **set_content_scale_factor**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_content_scale_factor**\ (\ ) Specifies the base scale of **Window**'s content when its :ref:`size` is equal to :ref:`content_scale_size`. @@ -974,8 +976,8 @@ Specifies the base scale of **Window**'s content when its :ref:`size` value **)** -- :ref:`ContentScaleMode` **get_content_scale_mode** **(** **)** +- |void| **set_content_scale_mode**\ (\ value\: :ref:`ContentScaleMode`\ ) +- :ref:`ContentScaleMode` **get_content_scale_mode**\ (\ ) Specifies how the content is scaled when the **Window** is resized. @@ -991,8 +993,8 @@ Specifies how the content is scaled when the **Window** is resized. .. rst-class:: classref-property-setget -- void **set_content_scale_size** **(** :ref:`Vector2i` value **)** -- :ref:`Vector2i` **get_content_scale_size** **(** **)** +- |void| **set_content_scale_size**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_content_scale_size**\ (\ ) Base size of the content (i.e. nodes that are drawn inside the window). If non-zero, **Window**'s content will be scaled when the window is resized to a different size. @@ -1008,8 +1010,8 @@ Base size of the content (i.e. nodes that are drawn inside the window). If non-z .. rst-class:: classref-property-setget -- void **set_content_scale_stretch** **(** :ref:`ContentScaleStretch` value **)** -- :ref:`ContentScaleStretch` **get_content_scale_stretch** **(** **)** +- |void| **set_content_scale_stretch**\ (\ value\: :ref:`ContentScaleStretch`\ ) +- :ref:`ContentScaleStretch` **get_content_scale_stretch**\ (\ ) The policy to use to determine the final scale factor for 2D elements. This affects how :ref:`content_scale_factor` is applied, in addition to the automatic scale factor determined by :ref:`content_scale_size`. @@ -1025,8 +1027,8 @@ The policy to use to determine the final scale factor for 2D elements. This affe .. rst-class:: classref-property-setget -- void **set_current_screen** **(** :ref:`int` value **)** -- :ref:`int` **get_current_screen** **(** **)** +- |void| **set_current_screen**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_current_screen**\ (\ ) The screen the window is currently on. @@ -1042,8 +1044,8 @@ The screen the window is currently on. .. rst-class:: classref-property-setget -- void **set_exclusive** **(** :ref:`bool` value **)** -- :ref:`bool` **is_exclusive** **(** **)** +- |void| **set_exclusive**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_exclusive**\ (\ ) If ``true``, the **Window** will be in exclusive mode. Exclusive windows are always on top of their parent and will block all input going to the parent **Window**. @@ -1061,8 +1063,8 @@ Needs :ref:`transient` enabled to work. .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, the **Window** contents is expanded to the full size of the window, window title bar is transparent. @@ -1082,8 +1084,8 @@ If ``true``, the **Window** contents is expanded to the full size of the window, .. rst-class:: classref-property-setget -- void **set_initial_position** **(** :ref:`WindowInitialPosition` value **)** -- :ref:`WindowInitialPosition` **get_initial_position** **(** **)** +- |void| **set_initial_position**\ (\ value\: :ref:`WindowInitialPosition`\ ) +- :ref:`WindowInitialPosition` **get_initial_position**\ (\ ) Specifies the initial type of position for the **Window**. See :ref:`WindowInitialPosition` constants. @@ -1099,8 +1101,8 @@ Specifies the initial type of position for the **Window**. See :ref:`WindowIniti .. rst-class:: classref-property-setget -- void **set_keep_title_visible** **(** :ref:`bool` value **)** -- :ref:`bool` **get_keep_title_visible** **(** **)** +- |void| **set_keep_title_visible**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_keep_title_visible**\ (\ ) If ``true``, the **Window** width is expanded to keep the title bar text fully visible. @@ -1116,8 +1118,8 @@ If ``true``, the **Window** width is expanded to keep the title bar text fully v .. rst-class:: classref-property-setget -- void **set_max_size** **(** :ref:`Vector2i` value **)** -- :ref:`Vector2i` **get_max_size** **(** **)** +- |void| **set_max_size**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_max_size**\ (\ ) If non-zero, the **Window** can't be resized to be bigger than this size. @@ -1135,8 +1137,8 @@ If non-zero, the **Window** can't be resized to be bigger than this size. .. rst-class:: classref-property-setget -- void **set_min_size** **(** :ref:`Vector2i` value **)** -- :ref:`Vector2i` **get_min_size** **(** **)** +- |void| **set_min_size**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_min_size**\ (\ ) If non-zero, the **Window** can't be resized to be smaller than this size. @@ -1154,8 +1156,8 @@ If non-zero, the **Window** can't be resized to be smaller than this size. .. rst-class:: classref-property-setget -- void **set_mode** **(** :ref:`Mode` value **)** -- :ref:`Mode` **get_mode** **(** **)** +- |void| **set_mode**\ (\ value\: :ref:`Mode`\ ) +- :ref:`Mode` **get_mode**\ (\ ) Set's the window's current mode. @@ -1175,8 +1177,8 @@ Set's the window's current mode. .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, all mouse events will be passed to the underlying window of the same application. See also :ref:`mouse_passthrough_polygon`. @@ -1196,8 +1198,8 @@ If ``true``, all mouse events will be passed to the underlying window of the sam .. rst-class:: classref-property-setget -- void **set_mouse_passthrough_polygon** **(** :ref:`PackedVector2Array` value **)** -- :ref:`PackedVector2Array` **get_mouse_passthrough_polygon** **(** **)** +- |void| **set_mouse_passthrough_polygon**\ (\ value\: :ref:`PackedVector2Array`\ ) +- :ref:`PackedVector2Array` **get_mouse_passthrough_polygon**\ (\ ) Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through. @@ -1248,8 +1250,8 @@ Passing an empty array will disable passthrough support (all mouse events will b .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, the **Window** will be considered a popup. Popups are sub-windows that don't show as separate windows in system's window manager's window list and will send close request when anything is clicked outside of them (unless :ref:`exclusive` is enabled). @@ -1265,8 +1267,8 @@ If ``true``, the **Window** will be considered a popup. Popups are sub-windows t .. rst-class:: classref-property-setget -- void **set_position** **(** :ref:`Vector2i` value **)** -- :ref:`Vector2i` **get_position** **(** **)** +- |void| **set_position**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_position**\ (\ ) The window's position in pixels. @@ -1286,8 +1288,8 @@ If :ref:`ProjectSettings.display/window/subwindows/embed_subwindows` value **)** -- :ref:`Vector2i` **get_size** **(** **)** +- |void| **set_size**\ (\ value\: :ref:`Vector2i`\ ) +- :ref:`Vector2i` **get_size**\ (\ ) The window's size in pixels. @@ -1303,8 +1305,8 @@ The window's size in pixels. .. rst-class:: classref-property-setget -- void **set_theme** **(** :ref:`Theme` value **)** -- :ref:`Theme` **get_theme** **(** **)** +- |void| **set_theme**\ (\ value\: :ref:`Theme`\ ) +- :ref:`Theme` **get_theme**\ (\ ) The :ref:`Theme` resource this node and all its :ref:`Control` and **Window** children use. If a child node has its own :ref:`Theme` resource set, theme items are merged with child's definitions having higher priority. @@ -1322,8 +1324,8 @@ The :ref:`Theme` resource this node and all its :ref:`Control` value **)** -- :ref:`StringName` **get_theme_type_variation** **(** **)** +- |void| **set_theme_type_variation**\ (\ value\: :ref:`StringName`\ ) +- :ref:`StringName` **get_theme_type_variation**\ (\ ) The name of a theme type variation used by this **Window** to look up its own theme items. See :ref:`Control.theme_type_variation` for more details. @@ -1339,8 +1341,8 @@ The name of a theme type variation used by this **Window** to look up its own th .. rst-class:: classref-property-setget -- void **set_title** **(** :ref:`String` value **)** -- :ref:`String` **get_title** **(** **)** +- |void| **set_title**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_title**\ (\ ) The window's title. If the **Window** is native, title styles set in :ref:`Theme` will have no effect. @@ -1356,8 +1358,8 @@ The window's title. If the **Window** is native, title styles set in :ref:`Theme .. rst-class:: classref-property-setget -- void **set_transient** **(** :ref:`bool` value **)** -- :ref:`bool` **is_transient** **(** **)** +- |void| **set_transient**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_transient**\ (\ ) If ``true``, the **Window** is transient, i.e. it's considered a child of another **Window**. The transient window will be destroyed with its transient parent and will return focus to their parent when closed. The transient window is displayed on top of a non-exclusive full-screen parent window. Transient windows can't enter full-screen mode. @@ -1375,8 +1377,8 @@ Note that behavior might be different depending on the platform. .. rst-class:: classref-property-setget -- void **set_transient_to_focused** **(** :ref:`bool` value **)** -- :ref:`bool` **is_transient_to_focused** **(** **)** +- |void| **set_transient_to_focused**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_transient_to_focused**\ (\ ) If ``true``, and the **Window** is :ref:`transient`, this window will (at the time of becoming visible) become transient to the currently focused window instead of the immediate parent window in the hierarchy. Note that the transient parent is assigned at the time this window becomes visible, so changing it afterwards has no effect until re-shown. @@ -1392,8 +1394,8 @@ If ``true``, and the **Window** is :ref:`transient` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, the **Window**'s background can be transparent. This is best used with embedded windows. @@ -1413,8 +1415,8 @@ If ``true``, the **Window**'s background can be transparent. This is best used w .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, the **Window** can't be focused nor interacted with. It can still be visible. @@ -1430,8 +1432,8 @@ If ``true``, the **Window** can't be focused nor interacted with. It can still b .. rst-class:: classref-property-setget -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enabled **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| If ``true``, the window can't be resized. Minimize and maximize buttons are disabled. @@ -1447,8 +1449,8 @@ If ``true``, the window can't be resized. Minimize and maximize buttons are disa .. rst-class:: classref-property-setget -- void **set_visible** **(** :ref:`bool` value **)** -- :ref:`bool` **is_visible** **(** **)** +- |void| **set_visible**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_visible**\ (\ ) If ``true``, the window is visible. @@ -1464,8 +1466,8 @@ If ``true``, the window is visible. .. rst-class:: classref-property-setget -- void **set_wrap_controls** **(** :ref:`bool` value **)** -- :ref:`bool` **is_wrapping_controls** **(** **)** +- |void| **set_wrap_controls**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_wrapping_controls**\ (\ ) If ``true``, the window's size will automatically update when a child node is added or removed, ignoring :ref:`min_size` if the new size is bigger. @@ -1484,7 +1486,7 @@ Method Descriptions .. rst-class:: classref-method -:ref:`Vector2` **_get_contents_minimum_size** **(** **)** |virtual| |const| +:ref:`Vector2` **_get_contents_minimum_size**\ (\ ) |virtual| |const| Virtual method to be implemented by the user. Overrides the value returned by :ref:`get_contents_minimum_size`. @@ -1496,7 +1498,7 @@ Virtual method to be implemented by the user. Overrides the value returned by :r .. rst-class:: classref-method -void **add_theme_color_override** **(** :ref:`StringName` name, :ref:`Color` color **)** +|void| **add_theme_color_override**\ (\ name\: :ref:`StringName`, color\: :ref:`Color`\ ) Creates a local override for a theme :ref:`Color` with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_color_override`. @@ -1510,7 +1512,7 @@ See also :ref:`get_theme_color` and :ref:`C .. rst-class:: classref-method -void **add_theme_constant_override** **(** :ref:`StringName` name, :ref:`int` constant **)** +|void| **add_theme_constant_override**\ (\ name\: :ref:`StringName`, constant\: :ref:`int`\ ) Creates a local override for a theme constant with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_constant_override`. @@ -1524,7 +1526,7 @@ See also :ref:`get_theme_constant`. .. rst-class:: classref-method -void **add_theme_font_override** **(** :ref:`StringName` name, :ref:`Font` font **)** +|void| **add_theme_font_override**\ (\ name\: :ref:`StringName`, font\: :ref:`Font`\ ) Creates a local override for a theme :ref:`Font` with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_font_override`. @@ -1538,7 +1540,7 @@ See also :ref:`get_theme_font`. .. rst-class:: classref-method -void **add_theme_font_size_override** **(** :ref:`StringName` name, :ref:`int` font_size **)** +|void| **add_theme_font_size_override**\ (\ name\: :ref:`StringName`, font_size\: :ref:`int`\ ) Creates a local override for a theme font size with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_font_size_override`. @@ -1552,7 +1554,7 @@ See also :ref:`get_theme_font_size`. .. rst-class:: classref-method -void **add_theme_icon_override** **(** :ref:`StringName` name, :ref:`Texture2D` texture **)** +|void| **add_theme_icon_override**\ (\ name\: :ref:`StringName`, texture\: :ref:`Texture2D`\ ) Creates a local override for a theme icon with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_icon_override`. @@ -1566,7 +1568,7 @@ See also :ref:`get_theme_icon`. .. rst-class:: classref-method -void **add_theme_stylebox_override** **(** :ref:`StringName` name, :ref:`StyleBox` stylebox **)** +|void| **add_theme_stylebox_override**\ (\ name\: :ref:`StringName`, stylebox\: :ref:`StyleBox`\ ) Creates a local override for a theme :ref:`StyleBox` with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_stylebox_override`. @@ -1580,7 +1582,7 @@ See also :ref:`get_theme_stylebox` and : .. rst-class:: classref-method -void **begin_bulk_theme_override** **(** **)** +|void| **begin_bulk_theme_override**\ (\ ) Prevents ``*_theme_*_override`` methods from emitting :ref:`NOTIFICATION_THEME_CHANGED` until :ref:`end_bulk_theme_override` is called. @@ -1592,7 +1594,7 @@ Prevents ``*_theme_*_override`` methods from emitting :ref:`NOTIFICATION_THEME_C .. rst-class:: classref-method -:ref:`bool` **can_draw** **(** **)** |const| +:ref:`bool` **can_draw**\ (\ ) |const| Returns whether the window is being drawn to the screen. @@ -1604,7 +1606,7 @@ Returns whether the window is being drawn to the screen. .. rst-class:: classref-method -void **child_controls_changed** **(** **)** +|void| **child_controls_changed**\ (\ ) Requests an update of the **Window** size to fit underlying :ref:`Control` nodes. @@ -1616,7 +1618,7 @@ Requests an update of the **Window** size to fit underlying :ref:`Control`. @@ -1628,7 +1630,7 @@ Ends a bulk theme override update. See :ref:`begin_bulk_theme_override` **get_contents_minimum_size** **(** **)** |const| +:ref:`Vector2` **get_contents_minimum_size**\ (\ ) |const| Returns the combined minimum size from the child :ref:`Control` nodes of the window. Use :ref:`child_controls_changed` to update it when children nodes have changed. @@ -1642,7 +1644,7 @@ The value returned by this method can be overridden with :ref:`_get_contents_min .. rst-class:: classref-method -:ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| +:ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| Returns ``true`` if the ``flag`` is set. @@ -1654,7 +1656,7 @@ Returns ``true`` if the ``flag`` is set. .. rst-class:: classref-method -:ref:`LayoutDirection` **get_layout_direction** **(** **)** |const| +:ref:`LayoutDirection` **get_layout_direction**\ (\ ) |const| Returns layout direction and text writing direction. @@ -1666,7 +1668,7 @@ Returns layout direction and text writing direction. .. rst-class:: classref-method -:ref:`Vector2i` **get_position_with_decorations** **(** **)** |const| +:ref:`Vector2i` **get_position_with_decorations**\ (\ ) |const| Returns the window's position including its border. @@ -1678,7 +1680,7 @@ Returns the window's position including its border. .. rst-class:: classref-method -:ref:`Vector2i` **get_size_with_decorations** **(** **)** |const| +:ref:`Vector2i` **get_size_with_decorations**\ (\ ) |const| Returns the window's size including its border. @@ -1690,7 +1692,7 @@ Returns the window's size including its border. .. rst-class:: classref-method -:ref:`Color` **get_theme_color** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`Color` **get_theme_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns a :ref:`Color` from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a color item with the specified ``name`` and ``theme_type``. @@ -1704,7 +1706,7 @@ See :ref:`Control.get_theme_color` for mor .. rst-class:: classref-method -:ref:`int` **get_theme_constant** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`int` **get_theme_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns a constant from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a constant item with the specified ``name`` and ``theme_type``. @@ -1718,7 +1720,7 @@ See :ref:`Control.get_theme_color` for mor .. rst-class:: classref-method -:ref:`float` **get_theme_default_base_scale** **(** **)** |const| +:ref:`float` **get_theme_default_base_scale**\ (\ ) |const| Returns the default base scale value from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a valid :ref:`Theme.default_base_scale` value. @@ -1732,7 +1734,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`Font` **get_theme_default_font** **(** **)** |const| +:ref:`Font` **get_theme_default_font**\ (\ ) |const| Returns the default font from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a valid :ref:`Theme.default_font` value. @@ -1746,7 +1748,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`int` **get_theme_default_font_size** **(** **)** |const| +:ref:`int` **get_theme_default_font_size**\ (\ ) |const| Returns the default font size value from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a valid :ref:`Theme.default_font_size` value. @@ -1760,7 +1762,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`Font` **get_theme_font** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`Font` **get_theme_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns a :ref:`Font` from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a font item with the specified ``name`` and ``theme_type``. @@ -1774,7 +1776,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`int` **get_theme_font_size** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`int` **get_theme_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns a font size from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a font size item with the specified ``name`` and ``theme_type``. @@ -1788,7 +1790,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`Texture2D` **get_theme_icon** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`Texture2D` **get_theme_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns an icon from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has an icon item with the specified ``name`` and ``theme_type``. @@ -1802,7 +1804,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`StyleBox` **get_theme_stylebox** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`StyleBox` **get_theme_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns a :ref:`StyleBox` from the first matching :ref:`Theme` in the tree if that :ref:`Theme` has a stylebox item with the specified ``name`` and ``theme_type``. @@ -1816,7 +1818,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`int` **get_window_id** **(** **)** |const| +:ref:`int` **get_window_id**\ (\ ) |const| Returns the ID of the window. @@ -1828,7 +1830,7 @@ Returns the ID of the window. .. rst-class:: classref-method -void **grab_focus** **(** **)** +|void| **grab_focus**\ (\ ) Causes the window to grab focus, allowing it to receive user input. @@ -1840,7 +1842,7 @@ Causes the window to grab focus, allowing it to receive user input. .. rst-class:: classref-method -:ref:`bool` **has_focus** **(** **)** |const| +:ref:`bool` **has_focus**\ (\ ) |const| Returns ``true`` if the window is focused. @@ -1852,7 +1854,7 @@ Returns ``true`` if the window is focused. .. rst-class:: classref-method -:ref:`bool` **has_theme_color** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`bool` **has_theme_color**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a color item with the specified ``name`` and ``theme_type``. @@ -1866,7 +1868,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`bool` **has_theme_color_override** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_theme_color_override**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if there is a local override for a theme :ref:`Color` with the specified ``name`` in this :ref:`Control` node. @@ -1880,7 +1882,7 @@ See :ref:`add_theme_color_override .. rst-class:: classref-method -:ref:`bool` **has_theme_constant** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`bool` **has_theme_constant**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a constant item with the specified ``name`` and ``theme_type``. @@ -1894,7 +1896,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`bool` **has_theme_constant_override** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_theme_constant_override**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if there is a local override for a theme constant with the specified ``name`` in this :ref:`Control` node. @@ -1908,7 +1910,7 @@ See :ref:`add_theme_constant_override` **has_theme_font** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`bool` **has_theme_font**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a font item with the specified ``name`` and ``theme_type``. @@ -1922,7 +1924,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`bool` **has_theme_font_override** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_theme_font_override**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if there is a local override for a theme :ref:`Font` with the specified ``name`` in this :ref:`Control` node. @@ -1936,7 +1938,7 @@ See :ref:`add_theme_font_override`. .. rst-class:: classref-method -:ref:`bool` **has_theme_font_size** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`bool` **has_theme_font_size**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a font size item with the specified ``name`` and ``theme_type``. @@ -1950,7 +1952,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`bool` **has_theme_font_size_override** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_theme_font_size_override**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if there is a local override for a theme font size with the specified ``name`` in this :ref:`Control` node. @@ -1964,7 +1966,7 @@ See :ref:`add_theme_font_size_override` **has_theme_icon** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`bool` **has_theme_icon**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns ``true`` if there is a matching :ref:`Theme` in the tree that has an icon item with the specified ``name`` and ``theme_type``. @@ -1978,7 +1980,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`bool` **has_theme_icon_override** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_theme_icon_override**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if there is a local override for a theme icon with the specified ``name`` in this :ref:`Control` node. @@ -1992,7 +1994,7 @@ See :ref:`add_theme_icon_override`. .. rst-class:: classref-method -:ref:`bool` **has_theme_stylebox** **(** :ref:`StringName` name, :ref:`StringName` theme_type="" **)** |const| +:ref:`bool` **has_theme_stylebox**\ (\ name\: :ref:`StringName`, theme_type\: :ref:`StringName` = &""\ ) |const| Returns ``true`` if there is a matching :ref:`Theme` in the tree that has a stylebox item with the specified ``name`` and ``theme_type``. @@ -2006,7 +2008,7 @@ See :ref:`Control.get_theme_color` for det .. rst-class:: classref-method -:ref:`bool` **has_theme_stylebox_override** **(** :ref:`StringName` name **)** |const| +:ref:`bool` **has_theme_stylebox_override**\ (\ name\: :ref:`StringName`\ ) |const| Returns ``true`` if there is a local override for a theme :ref:`StyleBox` with the specified ``name`` in this :ref:`Control` node. @@ -2020,7 +2022,7 @@ See :ref:`add_theme_stylebox_override